OSDN Git Service

* doc/invoke.texi (-fprofile-values): Document.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs  -fexternal-templates @gol
178 -falt-external-templates @gol
179 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
180 -fno-implicit-templates @gol
181 -fno-implicit-inline-templates @gol
182 -fno-implement-inlines  -fms-extensions @gol
183 -fno-nonansi-builtins  -fno-operator-names @gol
184 -fno-optional-diags  -fpermissive @gol
185 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
186 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
198 -Wno-protocol  -Wselector -Wundeclared-selector}
199
200 @item Language Independent Options
201 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
202 @gccoptlist{-fmessage-length=@var{n}  @gol
203 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
204
205 @item Warning Options
206 @xref{Warning Options,,Options to Request or Suppress Warnings}.
207 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
208 -w  -Wextra  -Wall  -Waggregate-return @gol
209 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
210 -Wconversion  -Wno-deprecated-declarations @gol
211 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
212 -Wfloat-equal  -Wformat  -Wformat=2 @gol
213 -Wformat-nonliteral  -Wformat-security @gol
214 -Wimplicit  -Wimplicit-int  @gol
215 -Wimplicit-function-declaration @gol
216 -Werror-implicit-function-declaration @gol
217 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
218 -Wno-invalid-offsetof @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 -feliminate-unused-debug-types @gol
247 -fmem-report -fprofile-arcs @gol
248 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
249 -ftest-coverage  -ftime-report @gol
250 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
251 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
252 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
253 -print-multi-directory  -print-multi-lib @gol
254 -print-prog-name=@var{program}  -print-search-dirs  -Q @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 -fprofile-values -fbranch-target-load-optimize @gol
262 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
263 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
264 -fdelayed-branch  -fdelete-null-pointer-checks @gol
265 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
266 -fforce-addr  -fforce-mem  -ffunction-sections @gol
267 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
268 -fif-conversion  -fif-conversion2 @gol
269 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
270 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
271 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
272 -fno-default-inline  -fno-defer-pop @gol
273 -fno-function-cse  -fno-guess-branch-probability @gol
274 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
275 -funsafe-math-optimizations  -ffinite-math-only @gol
276 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
277 -fomit-frame-pointer  -foptimize-register-move @gol
278 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
279 -freduce-all-givs  -fregmove  -frename-registers @gol
280 -freorder-blocks  -freorder-functions @gol
281 -frerun-cse-after-loop  -frerun-loop-opt @gol
282 -fschedule-insns  -fschedule-insns2 @gol
283 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
284 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
285 -fsched2-use-traces  -fsignaling-nans @gol
286 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
287 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
288 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
289 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
290 --param @var{name}=@var{value}
291 -O  -O0  -O1  -O2  -O3  -Os}
292
293 @item Preprocessor Options
294 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
295 @gccoptlist{-A@var{question}=@var{answer} @gol
296 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
297 -C  -dD  -dI  -dM  -dN @gol
298 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
299 -idirafter @var{dir} @gol
300 -include @var{file}  -imacros @var{file} @gol
301 -iprefix @var{file}  -iwithprefix @var{dir} @gol
302 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
303 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
304 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
305 -Xpreprocessor @var{option}}
306
307 @item Assembler Option
308 @xref{Assembler Options,,Passing Options to the Assembler}.
309 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
310
311 @item Linker Options
312 @xref{Link Options,,Options for Linking}.
313 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
314 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
315 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
316 -Wl,@var{option}  -Xlinker @var{option} @gol
317 -u @var{symbol}}
318
319 @item Directory Options
320 @xref{Directory Options,,Options for Directory Search}.
321 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
322
323 @item Target Options
324 @c I wrote this xref this way to avoid overfull hbox. -- rms
325 @xref{Target Options}.
326 @gccoptlist{-V @var{version}  -b @var{machine}}
327
328 @item Machine Dependent Options
329 @xref{Submodel Options,,Hardware Models and Configurations}.
330
331 @emph{M680x0 Options}
332 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
333 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
334 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
335 -malign-int  -mstrict-align}
336
337 @emph{M68hc1x Options}
338 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
339 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
340 -msoft-reg-count=@var{count}}
341
342 @emph{VAX Options}
343 @gccoptlist{-mg  -mgnu  -munix}
344
345 @emph{SPARC Options}
346 @gccoptlist{-mcpu=@var{cpu-type} @gol
347 -mtune=@var{cpu-type} @gol
348 -mcmodel=@var{code-model} @gol
349 -m32  -m64 @gol
350 -mapp-regs  -mbroken-saverestore  -mcypress @gol
351 -mfaster-structs  -mflat @gol
352 -mfpu  -mhard-float  -mhard-quad-float @gol
353 -mimpure-text  -mlive-g0  -mno-app-regs @gol
354 -mno-faster-structs  -mno-flat  -mno-fpu @gol
355 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
356 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
357 -msupersparc  -munaligned-doubles  -mv8}
358
359 @emph{ARM Options}
360 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
361 -mapcs-26  -mapcs-32 @gol
362 -mapcs-stack-check  -mno-apcs-stack-check @gol
363 -mapcs-float  -mno-apcs-float @gol
364 -mapcs-reentrant  -mno-apcs-reentrant @gol
365 -msched-prolog  -mno-sched-prolog @gol
366 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
367 -malignment-traps  -mno-alignment-traps @gol
368 -msoft-float  -mhard-float  -mfpe @gol
369 -mthumb-interwork  -mno-thumb-interwork @gol
370 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
371 -mstructure-size-boundary=@var{n} @gol
372 -mabort-on-noreturn @gol
373 -mlong-calls  -mno-long-calls @gol
374 -msingle-pic-base  -mno-single-pic-base @gol
375 -mpic-register=@var{reg} @gol
376 -mnop-fun-dllimport @gol
377 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
378 -mpoke-function-name @gol
379 -mthumb  -marm @gol
380 -mtpcs-frame  -mtpcs-leaf-frame @gol
381 -mcaller-super-interworking  -mcallee-super-interworking}
382
383 @emph{MN10200 Options}
384 @gccoptlist{-mrelax}
385
386 @emph{MN10300 Options}
387 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
388 -mam33  -mno-am33 @gol
389 -mno-crt0  -mrelax}
390
391 @emph{M32R/D Options}
392 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
393 -msdata=@var{sdata-type}  -G @var{num}}
394
395 @emph{M88K Options}
396 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
397 -mcheck-zero-division  -mhandle-large-shift @gol
398 -midentify-revision  -mno-check-zero-division @gol
399 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
400 -mno-optimize-arg-area  -mno-serialize-volatile @gol
401 -mno-underscores  -mocs-debug-info @gol
402 -mocs-frame-position  -moptimize-arg-area @gol
403 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
404 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
405 -mversion-03.00  -mwarn-passed-structs}
406
407 @emph{RS/6000 and PowerPC Options}
408 @gccoptlist{-mcpu=@var{cpu-type} @gol
409 -mtune=@var{cpu-type} @gol
410 -mpower  -mno-power  -mpower2  -mno-power2 @gol
411 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
412 -maltivec  -mno-altivec @gol
413 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
414 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
415 -mnew-mnemonics  -mold-mnemonics @gol
416 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
417 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
418 -malign-power  -malign-natural @gol
419 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
420 -mstring  -mno-string  -mupdate  -mno-update @gol
421 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
422 -mstrict-align  -mno-strict-align  -mrelocatable @gol
423 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
424 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
425 -mdynamic-no-pic @gol
426 -mcall-sysv  -mcall-netbsd @gol
427 -maix-struct-return  -msvr4-struct-return @gol
428 -mabi=altivec  -mabi=no-altivec @gol
429 -mabi=spe  -mabi=no-spe @gol
430 -misel=yes  -misel=no @gol
431 -mspe=yes  -mspe=no @gol
432 -mfloat-gprs=yes  -mfloat-gprs=no @gol
433 -mprototype  -mno-prototype @gol
434 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
435 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
436
437 @emph{Darwin Options}
438 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
439 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
440 -client_name  -compatibility_version  -current_version @gol
441 -dependency-file  -dylib_file  -dylinker_install_name @gol
442 -dynamic  -dynamiclib  -exported_symbols_list @gol
443 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
444 -force_flat_namespace  -headerpad_max_install_names @gol
445 -image_base  -init  -install_name  -keep_private_externs @gol
446 -multi_module  -multiply_defined  -multiply_defined_unused @gol
447 -noall_load  -nomultidefs  -noprebind  -noseglinkedit @gol
448 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
449 -private_bundle  -read_only_relocs  -sectalign @gol
450 -sectobjectsymbols  -whyload  -seg1addr @gol
451 -sectcreate  -sectobjectsymbols  -sectorder @gol
452 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
453 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
454 -single_module  -static  -sub_library  -sub_umbrella @gol
455 -twolevel_namespace  -umbrella  -undefined @gol
456 -unexported_symbols_list  -weak_reference_mismatches @gol
457 -whatsloaded}
458
459 @emph{RT Options}
460 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
461 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
462 -mminimum-fp-blocks  -mnohc-struct-return}
463
464 @emph{MIPS Options}
465 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
466 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
467 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
468 -mgas  -mgp32  -mgp64 @gol
469 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
470 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
471 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
472 -mmips-as  -mmips-tfile  -mno-abicalls @gol
473 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
474 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
475 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
476 -mrnames  -msoft-float @gol
477 -m4650  -msingle-float  -mmad @gol
478 -EL  -EB  -G @var{num}  -nocpp @gol
479 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
480 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
481 -mbranch-likely -mno-branch-likely}
482
483 @emph{i386 and x86-64 Options}
484 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
485 -mfpmath=@var{unit} @gol
486 -masm=@var{dialect}  -mno-fancy-math-387 @gol
487 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
488 -mno-wide-multiply  -mrtd  -malign-double @gol
489 -mpreferred-stack-boundary=@var{num} @gol
490 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
491 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
492 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
493 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
494 -mno-red-zone -mno-tls-direct-seg-refs @gol
495 -mcmodel=@var{code-model} @gol
496 -m32  -m64}
497
498 @emph{HPPA Options}
499 @gccoptlist{-march=@var{architecture-type} @gol
500 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
501 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
502 -mjump-in-delay -mlinker-opt -mlong-calls @gol
503 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
504 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
505 -mno-jump-in-delay  -mno-long-load-store @gol
506 -mno-portable-runtime  -mno-soft-float @gol
507 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
508 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
509 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
510 -nolibdld  -static  -threads}
511
512 @emph{Intel 960 Options}
513 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
514 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
515 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
516 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
517 -mno-complex-addr  -mno-leaf-procedures @gol
518 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
519 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
520 -mtail-call}
521
522 @emph{DEC Alpha Options}
523 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
524 -mieee  -mieee-with-inexact  -mieee-conformant @gol
525 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
526 -mtrap-precision=@var{mode}  -mbuild-constants @gol
527 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
528 -mbwx  -mmax  -mfix  -mcix @gol
529 -mfloat-vax  -mfloat-ieee @gol
530 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
531 -msmall-text  -mlarge-text @gol
532 -mmemory-latency=@var{time}}
533
534 @emph{DEC Alpha/VMS Options}
535 @gccoptlist{-mvms-return-codes}
536
537 @emph{H8/300 Options}
538 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
539
540 @emph{SH Options}
541 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
542 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
543 -m5-64media  -m5-64media-nofpu @gol
544 -m5-32media  -m5-32media-nofpu @gol
545 -m5-compact  -m5-compact-nofpu @gol
546 -mb  -ml  -mdalign  -mrelax @gol
547 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
548 -mieee  -misize  -mpadstruct  -mspace @gol
549 -mprefergot  -musermode}
550
551 @emph{System V Options}
552 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
553
554 @emph{ARC Options}
555 @gccoptlist{-EB  -EL @gol
556 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
557 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
558
559 @emph{TMS320C3x/C4x Options}
560 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
561 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
562 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
563 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
564
565 @emph{V850 Options}
566 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
567 -mprolog-function  -mno-prolog-function  -mspace @gol
568 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
569 -mapp-regs  -mno-app-regs @gol
570 -mdisable-callt  -mno-disable-callt @gol
571 -mv850e @gol
572 -mv850  -mbig-switch}
573
574 @emph{NS32K Options}
575 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
576 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
577 -mregparam  -mnoregparam  -msb  -mnosb @gol
578 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
579
580 @emph{AVR Options}
581 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
582 -mcall-prologues  -mno-tablejump  -mtiny-stack}
583
584 @emph{MCore Options}
585 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
586 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
587 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
588 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
589 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
590
591 @emph{MMIX Options}
592 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
593 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
594 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
595 -mno-base-addresses  -msingle-exit  -mno-single-exit}
596
597 @emph{IA-64 Options}
598 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
599 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
600 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
601 -minline-float-divide-max-throughput @gol
602 -minline-int-divide-min-latency @gol
603 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
604 -mfixed-range=@var{register-range}}
605
606 @emph{D30V Options}
607 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
608 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
609
610 @emph{S/390 and zSeries Options}
611 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
612 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
613 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
614 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
615
616 @emph{CRIS Options}
617 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
618 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
619 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
620 -mstack-align  -mdata-align  -mconst-align @gol
621 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
622 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
623
624 @emph{PDP-11 Options}
625 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
626 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
627 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
628 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
629 -mbranch-expensive  -mbranch-cheap @gol
630 -msplit  -mno-split  -munix-asm  -mdec-asm}
631
632 @emph{Xstormy16 Options}
633 @gccoptlist{-msim}
634
635 @emph{Xtensa Options}
636 @gccoptlist{-mbig-endian  -mlittle-endian @gol
637 -mdensity  -mno-density @gol
638 -mconst16 -mno-const16 @gol
639 -mabs -mno-abs @gol
640 -maddx -mno-addx @gol
641 -mmac16  -mno-mac16 @gol
642 -mmul16  -mno-mul16 @gol
643 -mmul32  -mno-mul32 @gol
644 -mnsa  -mno-nsa @gol
645 -mminmax  -mno-minmax @gol
646 -msext  -mno-sext @gol
647 -mbooleans  -mno-booleans @gol
648 -mhard-float  -msoft-float @gol
649 -mfused-madd  -mno-fused-madd @gol
650 -mtext-section-literals  -mno-text-section-literals @gol
651 -mtarget-align  -mno-target-align @gol
652 -mlongcalls  -mno-longcalls}
653
654 @emph{FRV Options}
655 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
656 -mhard-float  -msoft-float @gol
657 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
658 -mdouble  -mno-double @gol
659 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
660 -mlibrary-pic  -macc-4 -macc-8 @gol
661 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
662 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
663 -mvliw-branch  -mno-vliw-branch @gol
664 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
665 -mno-nested-cond-exec  -mtomcat-stats @gol
666 -mcpu=@var{cpu}}
667
668 @item Code Generation Options
669 @xref{Code Gen Options,,Options for Code Generation Conventions}.
670 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
671 -ffixed-@var{reg}  -fexceptions @gol
672 -fnon-call-exceptions  -funwind-tables @gol
673 -fasynchronous-unwind-tables @gol
674 -finhibit-size-directive  -finstrument-functions @gol
675 -fno-common  -fno-ident  -fno-gnu-linker @gol
676 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
677 -freg-struct-return  -fshared-data  -fshort-enums @gol
678 -fshort-double  -fshort-wchar @gol
679 -fverbose-asm  -fpack-struct  -fstack-check @gol
680 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
681 -fargument-alias  -fargument-noalias @gol
682 -fargument-noalias-global  -fleading-underscore @gol
683 -ftls-model=@var{model} @gol
684 -ftrapv  -fwrapv  -fbounds-check}
685 @end table
686
687 @menu
688 * Overall Options::     Controlling the kind of output:
689                         an executable, object files, assembler files,
690                         or preprocessed source.
691 * C Dialect Options::   Controlling the variant of C language compiled.
692 * C++ Dialect Options:: Variations on C++.
693 * Objective-C Dialect Options:: Variations on Objective-C.
694 * Language Independent Options:: Controlling how diagnostics should be
695                         formatted.
696 * Warning Options::     How picky should the compiler be?
697 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
698 * Optimize Options::    How much optimization?
699 * Preprocessor Options:: Controlling header files and macro definitions.
700                          Also, getting dependency information for Make.
701 * Assembler Options::   Passing options to the assembler.
702 * Link Options::        Specifying libraries and so on.
703 * Directory Options::   Where to find header files and libraries.
704                         Where to find the compiler executable files.
705 * Spec Files::          How to pass switches to sub-processes.
706 * Target Options::      Running a cross-compiler, or an old version of GCC.
707 @end menu
708
709 @node Overall Options
710 @section Options Controlling the Kind of Output
711
712 Compilation can involve up to four stages: preprocessing, compilation
713 proper, assembly and linking, always in that order.  The first three
714 stages apply to an individual source file, and end by producing an
715 object file; linking combines all the object files (those newly
716 compiled, and those specified as input) into an executable file.
717
718 @cindex file name suffix
719 For any given input file, the file name suffix determines what kind of
720 compilation is done:
721
722 @table @gcctabopt
723 @item @var{file}.c
724 C source code which must be preprocessed.
725
726 @item @var{file}.i
727 C source code which should not be preprocessed.
728
729 @item @var{file}.ii
730 C++ source code which should not be preprocessed.
731
732 @item @var{file}.m
733 Objective-C source code.  Note that you must link with the library
734 @file{libobjc.a} to make an Objective-C program work.
735
736 @item @var{file}.mi
737 Objective-C source code which should not be preprocessed.
738
739 @item @var{file}.h
740 C or C++ header file to be turned into a precompiled header.
741
742 @item @var{file}.cc
743 @itemx @var{file}.cp
744 @itemx @var{file}.cxx
745 @itemx @var{file}.cpp
746 @itemx @var{file}.CPP
747 @itemx @var{file}.c++
748 @itemx @var{file}.C
749 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
750 the last two letters must both be literally @samp{x}.  Likewise,
751 @samp{.C} refers to a literal capital C@.
752
753 @item @var{file}.hh
754 @itemx @var{file}.H
755 C++ header file to be turned into a precompiled header.
756
757 @item @var{file}.f
758 @itemx @var{file}.for
759 @itemx @var{file}.FOR
760 Fortran source code which should not be preprocessed.
761
762 @item @var{file}.F
763 @itemx @var{file}.fpp
764 @itemx @var{file}.FPP
765 Fortran source code which must be preprocessed (with the traditional
766 preprocessor).
767
768 @item @var{file}.r
769 Fortran source code which must be preprocessed with a RATFOR
770 preprocessor (not included with GCC)@.
771
772 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
773 Using and Porting GNU Fortran}, for more details of the handling of
774 Fortran input files.
775
776 @c FIXME: Descriptions of Java file types.
777 @c @var{file}.java
778 @c @var{file}.class
779 @c @var{file}.zip
780 @c @var{file}.jar
781
782 @item @var{file}.ads
783 Ada source code file which contains a library unit declaration (a
784 declaration of a package, subprogram, or generic, or a generic
785 instantiation), or a library unit renaming declaration (a package,
786 generic, or subprogram renaming declaration).  Such files are also
787 called @dfn{specs}.
788
789 @itemx @var{file}.adb
790 Ada source code file containing a library unit body (a subprogram or
791 package body).  Such files are also called @dfn{bodies}.
792
793 @c GCC also knows about some suffixes for languages not yet included:
794 @c Pascal:
795 @c @var{file}.p
796 @c @var{file}.pas
797
798 @item @var{file}.s
799 Assembler code.
800
801 @item @var{file}.S
802 Assembler code which must be preprocessed.
803
804 @item @var{other}
805 An object file to be fed straight into linking.
806 Any file name with no recognized suffix is treated this way.
807 @end table
808
809 @opindex x
810 You can specify the input language explicitly with the @option{-x} option:
811
812 @table @gcctabopt
813 @item -x @var{language}
814 Specify explicitly the @var{language} for the following input files
815 (rather than letting the compiler choose a default based on the file
816 name suffix).  This option applies to all following input files until
817 the next @option{-x} option.  Possible values for @var{language} are:
818 @example
819 c  c-header  cpp-output
820 c++  c++-header  c++-cpp-output
821 objective-c  objective-c-header  objc-cpp-output
822 assembler  assembler-with-cpp
823 ada
824 f77  f77-cpp-input  ratfor
825 java
826 treelang
827 @end example
828
829 @item -x none
830 Turn off any specification of a language, so that subsequent files are
831 handled according to their file name suffixes (as they are if @option{-x}
832 has not been used at all).
833
834 @item -pass-exit-codes
835 @opindex pass-exit-codes
836 Normally the @command{gcc} program will exit with the code of 1 if any
837 phase of the compiler returns a non-success return code.  If you specify
838 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
839 numerically highest error produced by any phase that returned an error
840 indication.
841 @end table
842
843 If you only want some of the stages of compilation, you can use
844 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
845 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
846 @command{gcc} is to stop.  Note that some combinations (for example,
847 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
848
849 @table @gcctabopt
850 @item -c
851 @opindex c
852 Compile or assemble the source files, but do not link.  The linking
853 stage simply is not done.  The ultimate output is in the form of an
854 object file for each source file.
855
856 By default, the object file name for a source file is made by replacing
857 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
858
859 Unrecognized input files, not requiring compilation or assembly, are
860 ignored.
861
862 @item -S
863 @opindex S
864 Stop after the stage of compilation proper; do not assemble.  The output
865 is in the form of an assembler code file for each non-assembler input
866 file specified.
867
868 By default, the assembler file name for a source file is made by
869 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
870
871 Input files that don't require compilation are ignored.
872
873 @item -E
874 @opindex E
875 Stop after the preprocessing stage; do not run the compiler proper.  The
876 output is in the form of preprocessed source code, which is sent to the
877 standard output.
878
879 Input files which don't require preprocessing are ignored.
880
881 @cindex output file option
882 @item -o @var{file}
883 @opindex o
884 Place output in file @var{file}.  This applies regardless to whatever
885 sort of output is being produced, whether it be an executable file,
886 an object file, an assembler file or preprocessed C code.
887
888 Since only one output file can be specified, it does not make sense to
889 use @option{-o} when compiling more than one input file, unless you are
890 producing an executable file as output.
891
892 If @option{-o} is not specified, the default is to put an executable file
893 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
894 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
895 all preprocessed C source on standard output.
896
897 @item -v
898 @opindex v
899 Print (on standard error output) the commands executed to run the stages
900 of compilation.  Also print the version number of the compiler driver
901 program and of the preprocessor and the compiler proper.
902
903 @item -###
904 @opindex ###
905 Like @option{-v} except the commands are not executed and all command
906 arguments are quoted.  This is useful for shell scripts to capture the
907 driver-generated command lines.
908
909 @item -pipe
910 @opindex pipe
911 Use pipes rather than temporary files for communication between the
912 various stages of compilation.  This fails to work on some systems where
913 the assembler is unable to read from a pipe; but the GNU assembler has
914 no trouble.
915
916 @item --help
917 @opindex help
918 Print (on the standard output) a description of the command line options
919 understood by @command{gcc}.  If the @option{-v} option is also specified
920 then @option{--help} will also be passed on to the various processes
921 invoked by @command{gcc}, so that they can display the command line options
922 they accept.  If the @option{-Wextra} option is also specified then command
923 line options which have no documentation associated with them will also
924 be displayed.
925
926 @item --target-help
927 @opindex target-help
928 Print (on the standard output) a description of target specific command
929 line options for each tool.
930
931 @item --version
932 @opindex version
933 Display the version number and copyrights of the invoked GCC.
934 @end table
935
936 @node Invoking G++
937 @section Compiling C++ Programs
938
939 @cindex suffixes for C++ source
940 @cindex C++ source file suffixes
941 C++ source files conventionally use one of the suffixes @samp{.C},
942 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
943 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
944 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
945 files with these names and compiles them as C++ programs even if you
946 call the compiler the same way as for compiling C programs (usually
947 with the name @command{gcc}).
948
949 @findex g++
950 @findex c++
951 However, C++ programs often require class libraries as well as a
952 compiler that understands the C++ language---and under some
953 circumstances, you might want to compile programs or header files from
954 standard input, or otherwise without a suffix that flags them as C++
955 programs.  You might also like to precompile a C header file with a
956 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
957 program that calls GCC with the default language set to C++, and
958 automatically specifies linking against the C++ library.  On many
959 systems, @command{g++} is also installed with the name @command{c++}.
960
961 @cindex invoking @command{g++}
962 When you compile C++ programs, you may specify many of the same
963 command-line options that you use for compiling programs in any
964 language; or command-line options meaningful for C and related
965 languages; or options that are meaningful only for C++ programs.
966 @xref{C Dialect Options,,Options Controlling C Dialect}, for
967 explanations of options for languages related to C@.
968 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
969 explanations of options that are meaningful only for C++ programs.
970
971 @node C Dialect Options
972 @section Options Controlling C Dialect
973 @cindex dialect options
974 @cindex language dialect options
975 @cindex options, dialect
976
977 The following options control the dialect of C (or languages derived
978 from C, such as C++ and Objective-C) that the compiler accepts:
979
980 @table @gcctabopt
981 @cindex ANSI support
982 @cindex ISO support
983 @item -ansi
984 @opindex ansi
985 In C mode, support all ISO C90 programs.  In C++ mode,
986 remove GNU extensions that conflict with ISO C++.
987
988 This turns off certain features of GCC that are incompatible with ISO
989 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
990 such as the @code{asm} and @code{typeof} keywords, and
991 predefined macros such as @code{unix} and @code{vax} that identify the
992 type of system you are using.  It also enables the undesirable and
993 rarely used ISO trigraph feature.  For the C compiler,
994 it disables recognition of C++ style @samp{//} comments as well as
995 the @code{inline} keyword.
996
997 The alternate keywords @code{__asm__}, @code{__extension__},
998 @code{__inline__} and @code{__typeof__} continue to work despite
999 @option{-ansi}.  You would not want to use them in an ISO C program, of
1000 course, but it is useful to put them in header files that might be included
1001 in compilations done with @option{-ansi}.  Alternate predefined macros
1002 such as @code{__unix__} and @code{__vax__} are also available, with or
1003 without @option{-ansi}.
1004
1005 The @option{-ansi} option does not cause non-ISO programs to be
1006 rejected gratuitously.  For that, @option{-pedantic} is required in
1007 addition to @option{-ansi}.  @xref{Warning Options}.
1008
1009 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1010 option is used.  Some header files may notice this macro and refrain
1011 from declaring certain functions or defining certain macros that the
1012 ISO standard doesn't call for; this is to avoid interfering with any
1013 programs that might use these names for other things.
1014
1015 Functions which would normally be built in but do not have semantics
1016 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1017 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1018 built-in functions provided by GCC}, for details of the functions
1019 affected.
1020
1021 @item -std=
1022 @opindex std
1023 Determine the language standard.  This option is currently only
1024 supported when compiling C or C++.  A value for this option must be
1025 provided; possible values are
1026
1027 @table @samp
1028 @item c89
1029 @itemx iso9899:1990
1030 ISO C90 (same as @option{-ansi}).
1031
1032 @item iso9899:199409
1033 ISO C90 as modified in amendment 1.
1034
1035 @item c99
1036 @itemx c9x
1037 @itemx iso9899:1999
1038 @itemx iso9899:199x
1039 ISO C99.  Note that this standard is not yet fully supported; see
1040 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1041 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1042
1043 @item gnu89
1044 Default, ISO C90 plus GNU extensions (including some C99 features).
1045
1046 @item gnu99
1047 @item gnu9x
1048 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1049 this will become the default.  The name @samp{gnu9x} is deprecated.
1050
1051 @item c++98
1052 The 1998 ISO C++ standard plus amendments.
1053
1054 @item gnu++98
1055 The same as @option{-std=c++98} plus GNU extensions.  This is the
1056 default for C++ code.
1057 @end table
1058
1059 Even when this option is not specified, you can still use some of the
1060 features of newer standards in so far as they do not conflict with
1061 previous C standards.  For example, you may use @code{__restrict__} even
1062 when @option{-std=c99} is not specified.
1063
1064 The @option{-std} options specifying some version of ISO C have the same
1065 effects as @option{-ansi}, except that features that were not in ISO C90
1066 but are in the specified version (for example, @samp{//} comments and
1067 the @code{inline} keyword in ISO C99) are not disabled.
1068
1069 @xref{Standards,,Language Standards Supported by GCC}, for details of
1070 these standard versions.
1071
1072 @item -aux-info @var{filename}
1073 @opindex aux-info
1074 Output to the given filename prototyped declarations for all functions
1075 declared and/or defined in a translation unit, including those in header
1076 files.  This option is silently ignored in any language other than C@.
1077
1078 Besides declarations, the file indicates, in comments, the origin of
1079 each declaration (source file and line), whether the declaration was
1080 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1081 @samp{O} for old, respectively, in the first character after the line
1082 number and the colon), and whether it came from a declaration or a
1083 definition (@samp{C} or @samp{F}, respectively, in the following
1084 character).  In the case of function definitions, a K&R-style list of
1085 arguments followed by their declarations is also provided, inside
1086 comments, after the declaration.
1087
1088 @item -fno-asm
1089 @opindex fno-asm
1090 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1091 keyword, so that code can use these words as identifiers.  You can use
1092 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1093 instead.  @option{-ansi} implies @option{-fno-asm}.
1094
1095 In C++, this switch only affects the @code{typeof} keyword, since
1096 @code{asm} and @code{inline} are standard keywords.  You may want to
1097 use the @option{-fno-gnu-keywords} flag instead, which has the same
1098 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1099 switch only affects the @code{asm} and @code{typeof} keywords, since
1100 @code{inline} is a standard keyword in ISO C99.
1101
1102 @item -fno-builtin
1103 @itemx -fno-builtin-@var{function}
1104 @opindex fno-builtin
1105 @cindex built-in functions
1106 Don't recognize built-in functions that do not begin with
1107 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1108 functions provided by GCC}, for details of the functions affected,
1109 including those which are not built-in functions when @option{-ansi} or
1110 @option{-std} options for strict ISO C conformance are used because they
1111 do not have an ISO standard meaning.
1112
1113 GCC normally generates special code to handle certain built-in functions
1114 more efficiently; for instance, calls to @code{alloca} may become single
1115 instructions that adjust the stack directly, and calls to @code{memcpy}
1116 may become inline copy loops.  The resulting code is often both smaller
1117 and faster, but since the function calls no longer appear as such, you
1118 cannot set a breakpoint on those calls, nor can you change the behavior
1119 of the functions by linking with a different library.
1120
1121 With the @option{-fno-builtin-@var{function}} option
1122 only the built-in function @var{function} is
1123 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1124 function is named this is not built-in in this version of GCC, this
1125 option is ignored.  There is no corresponding
1126 @option{-fbuiltin-@var{function}} option; if you wish to enable
1127 built-in functions selectively when using @option{-fno-builtin} or
1128 @option{-ffreestanding}, you may define macros such as:
1129
1130 @smallexample
1131 #define abs(n)          __builtin_abs ((n))
1132 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1133 @end smallexample
1134
1135 @item -fhosted
1136 @opindex fhosted
1137 @cindex hosted environment
1138
1139 Assert that compilation takes place in a hosted environment.  This implies
1140 @option{-fbuiltin}.  A hosted environment is one in which the
1141 entire standard library is available, and in which @code{main} has a return
1142 type of @code{int}.  Examples are nearly everything except a kernel.
1143 This is equivalent to @option{-fno-freestanding}.
1144
1145 @item -ffreestanding
1146 @opindex ffreestanding
1147 @cindex hosted environment
1148
1149 Assert that compilation takes place in a freestanding environment.  This
1150 implies @option{-fno-builtin}.  A freestanding environment
1151 is one in which the standard library may not exist, and program startup may
1152 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1153 This is equivalent to @option{-fno-hosted}.
1154
1155 @xref{Standards,,Language Standards Supported by GCC}, for details of
1156 freestanding and hosted environments.
1157
1158 @item -fms-extensions
1159 @opindex fms-extensions
1160 Accept some non-standard constructs used in Microsoft header files.
1161
1162 @item -trigraphs
1163 @opindex trigraphs
1164 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1165 options for strict ISO C conformance) implies @option{-trigraphs}.
1166
1167 @item -no-integrated-cpp
1168 @opindex no-integrated-cpp
1169 Performs a compilation in two passes: preprocessing and compiling.  This
1170 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1171 @option{-B} option. The user supplied compilation step can then add in
1172 an additional preprocessing step after normal preprocessing but before
1173 compiling. The default is to use the integrated cpp (internal cpp)
1174
1175 The semantics of this option will change if "cc1", "cc1plus", and
1176 "cc1obj" are merged.
1177
1178 @cindex traditional C language
1179 @cindex C language, traditional
1180 @item -traditional
1181 @itemx -traditional-cpp
1182 @opindex traditional-cpp
1183 @opindex traditional
1184 Formerly, these options caused GCC to attempt to emulate a pre-standard
1185 C compiler.  They are now only supported with the @option{-E} switch.
1186 The preprocessor continues to support a pre-standard mode.  See the GNU
1187 CPP manual for details.
1188
1189 @item -fcond-mismatch
1190 @opindex fcond-mismatch
1191 Allow conditional expressions with mismatched types in the second and
1192 third arguments.  The value of such an expression is void.  This option
1193 is not supported for C++.
1194
1195 @item -funsigned-char
1196 @opindex funsigned-char
1197 Let the type @code{char} be unsigned, like @code{unsigned char}.
1198
1199 Each kind of machine has a default for what @code{char} should
1200 be.  It is either like @code{unsigned char} by default or like
1201 @code{signed char} by default.
1202
1203 Ideally, a portable program should always use @code{signed char} or
1204 @code{unsigned char} when it depends on the signedness of an object.
1205 But many programs have been written to use plain @code{char} and
1206 expect it to be signed, or expect it to be unsigned, depending on the
1207 machines they were written for.  This option, and its inverse, let you
1208 make such a program work with the opposite default.
1209
1210 The type @code{char} is always a distinct type from each of
1211 @code{signed char} or @code{unsigned char}, even though its behavior
1212 is always just like one of those two.
1213
1214 @item -fsigned-char
1215 @opindex fsigned-char
1216 Let the type @code{char} be signed, like @code{signed char}.
1217
1218 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1219 the negative form of @option{-funsigned-char}.  Likewise, the option
1220 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1221
1222 @item -fsigned-bitfields
1223 @itemx -funsigned-bitfields
1224 @itemx -fno-signed-bitfields
1225 @itemx -fno-unsigned-bitfields
1226 @opindex fsigned-bitfields
1227 @opindex funsigned-bitfields
1228 @opindex fno-signed-bitfields
1229 @opindex fno-unsigned-bitfields
1230 These options control whether a bit-field is signed or unsigned, when the
1231 declaration does not use either @code{signed} or @code{unsigned}.  By
1232 default, such a bit-field is signed, because this is consistent: the
1233 basic integer types such as @code{int} are signed types.
1234
1235 @item -fwritable-strings
1236 @opindex fwritable-strings
1237 Store string constants in the writable data segment and don't uniquize
1238 them.  This is for compatibility with old programs which assume they can
1239 write into string constants.
1240
1241 Writing into string constants is a very bad idea; ``constants'' should
1242 be constant.
1243 @end table
1244
1245 @node C++ Dialect Options
1246 @section Options Controlling C++ Dialect
1247
1248 @cindex compiler options, C++
1249 @cindex C++ options, command line
1250 @cindex options, C++
1251 This section describes the command-line options that are only meaningful
1252 for C++ programs; but you can also use most of the GNU compiler options
1253 regardless of what language your program is in.  For example, you
1254 might compile a file @code{firstClass.C} like this:
1255
1256 @example
1257 g++ -g -frepo -O -c firstClass.C
1258 @end example
1259
1260 @noindent
1261 In this example, only @option{-frepo} is an option meant
1262 only for C++ programs; you can use the other options with any
1263 language supported by GCC@.
1264
1265 Here is a list of options that are @emph{only} for compiling C++ programs:
1266
1267 @table @gcctabopt
1268
1269 @item -fabi-version=@var{n}
1270 @opindex fabi-version
1271 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1272 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1273 version that conforms most closely to the C++ ABI specification.
1274 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1275 fixed.
1276
1277 The default is version 1.
1278
1279 @item -fno-access-control
1280 @opindex fno-access-control
1281 Turn off all access checking.  This switch is mainly useful for working
1282 around bugs in the access control code.
1283
1284 @item -fcheck-new
1285 @opindex fcheck-new
1286 Check that the pointer returned by @code{operator new} is non-null
1287 before attempting to modify the storage allocated.  This check is
1288 normally unnecessary because the C++ standard specifies that
1289 @code{operator new} will only return @code{0} if it is declared
1290 @samp{throw()}, in which case the compiler will always check the
1291 return value even without this option.  In all other cases, when
1292 @code{operator new} has a non-empty exception specification, memory
1293 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1294 @samp{new (nothrow)}.
1295
1296 @item -fconserve-space
1297 @opindex fconserve-space
1298 Put uninitialized or runtime-initialized global variables into the
1299 common segment, as C does.  This saves space in the executable at the
1300 cost of not diagnosing duplicate definitions.  If you compile with this
1301 flag and your program mysteriously crashes after @code{main()} has
1302 completed, you may have an object that is being destroyed twice because
1303 two definitions were merged.
1304
1305 This option is no longer useful on most targets, now that support has
1306 been added for putting variables into BSS without making them common.
1307
1308 @item -fno-const-strings
1309 @opindex fno-const-strings
1310 Give string constants type @code{char *} instead of type @code{const
1311 char *}.  By default, G++ uses type @code{const char *} as required by
1312 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1313 actually modify the value of a string constant, unless you also use
1314 @option{-fwritable-strings}.
1315
1316 This option might be removed in a future release of G++.  For maximum
1317 portability, you should structure your code so that it works with
1318 string constants that have type @code{const char *}.
1319
1320 @item -fno-elide-constructors
1321 @opindex fno-elide-constructors
1322 The C++ standard allows an implementation to omit creating a temporary
1323 which is only used to initialize another object of the same type.
1324 Specifying this option disables that optimization, and forces G++ to
1325 call the copy constructor in all cases.
1326
1327 @item -fno-enforce-eh-specs
1328 @opindex fno-enforce-eh-specs
1329 Don't check for violation of exception specifications at runtime.  This
1330 option violates the C++ standard, but may be useful for reducing code
1331 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1332 will still optimize based on the exception specifications.
1333
1334 @item -fexternal-templates
1335 @opindex fexternal-templates
1336
1337 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1338 template instantiation; template instances are emitted or not according
1339 to the location of the template definition.  @xref{Template
1340 Instantiation}, for more information.
1341
1342 This option is deprecated.
1343
1344 @item -falt-external-templates
1345 @opindex falt-external-templates
1346 Similar to @option{-fexternal-templates}, but template instances are
1347 emitted or not according to the place where they are first instantiated.
1348 @xref{Template Instantiation}, for more information.
1349
1350 This option is deprecated.
1351
1352 @item -ffor-scope
1353 @itemx -fno-for-scope
1354 @opindex ffor-scope
1355 @opindex fno-for-scope
1356 If @option{-ffor-scope} is specified, the scope of variables declared in
1357 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1358 as specified by the C++ standard.
1359 If @option{-fno-for-scope} is specified, the scope of variables declared in
1360 a @i{for-init-statement} extends to the end of the enclosing scope,
1361 as was the case in old versions of G++, and other (traditional)
1362 implementations of C++.
1363
1364 The default if neither flag is given to follow the standard,
1365 but to allow and give a warning for old-style code that would
1366 otherwise be invalid, or have different behavior.
1367
1368 @item -fno-gnu-keywords
1369 @opindex fno-gnu-keywords
1370 Do not recognize @code{typeof} as a keyword, so that code can use this
1371 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1372 @option{-ansi} implies @option{-fno-gnu-keywords}.
1373
1374 @item -fno-implicit-templates
1375 @opindex fno-implicit-templates
1376 Never emit code for non-inline templates which are instantiated
1377 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1378 @xref{Template Instantiation}, for more information.
1379
1380 @item -fno-implicit-inline-templates
1381 @opindex fno-implicit-inline-templates
1382 Don't emit code for implicit instantiations of inline templates, either.
1383 The default is to handle inlines differently so that compiles with and
1384 without optimization will need the same set of explicit instantiations.
1385
1386 @item -fno-implement-inlines
1387 @opindex fno-implement-inlines
1388 To save space, do not emit out-of-line copies of inline functions
1389 controlled by @samp{#pragma implementation}.  This will cause linker
1390 errors if these functions are not inlined everywhere they are called.
1391
1392 @item -fms-extensions
1393 @opindex fms-extensions
1394 Disable pedantic warnings about constructs used in MFC, such as implicit
1395 int and getting a pointer to member function via non-standard syntax.
1396
1397 @item -fno-nonansi-builtins
1398 @opindex fno-nonansi-builtins
1399 Disable built-in declarations of functions that are not mandated by
1400 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1401 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1402
1403 @item -fno-operator-names
1404 @opindex fno-operator-names
1405 Do not treat the operator name keywords @code{and}, @code{bitand},
1406 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1407 synonyms as keywords.
1408
1409 @item -fno-optional-diags
1410 @opindex fno-optional-diags
1411 Disable diagnostics that the standard says a compiler does not need to
1412 issue.  Currently, the only such diagnostic issued by G++ is the one for
1413 a name having multiple meanings within a class.
1414
1415 @item -fpermissive
1416 @opindex fpermissive
1417 Downgrade messages about nonconformant code from errors to warnings.  By
1418 default, G++ effectively sets @option{-pedantic-errors} without
1419 @option{-pedantic}; this option reverses that.  This behavior and this
1420 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1421
1422 @item -frepo
1423 @opindex frepo
1424 Enable automatic template instantiation at link time.  This option also
1425 implies @option{-fno-implicit-templates}.  @xref{Template
1426 Instantiation}, for more information.
1427
1428 @item -fno-rtti
1429 @opindex fno-rtti
1430 Disable generation of information about every class with virtual
1431 functions for use by the C++ runtime type identification features
1432 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1433 of the language, you can save some space by using this flag.  Note that
1434 exception handling uses the same information, but it will generate it as
1435 needed.
1436
1437 @item -fstats
1438 @opindex fstats
1439 Emit statistics about front-end processing at the end of the compilation.
1440 This information is generally only useful to the G++ development team.
1441
1442 @item -ftemplate-depth-@var{n}
1443 @opindex ftemplate-depth
1444 Set the maximum instantiation depth for template classes to @var{n}.
1445 A limit on the template instantiation depth is needed to detect
1446 endless recursions during template class instantiation.  ANSI/ISO C++
1447 conforming programs must not rely on a maximum depth greater than 17.
1448
1449 @item -fuse-cxa-atexit
1450 @opindex fuse-cxa-atexit
1451 Register destructors for objects with static storage duration with the
1452 @code{__cxa_atexit} function rather than the @code{atexit} function.
1453 This option is required for fully standards-compliant handling of static
1454 destructors, but will only work if your C library supports
1455 @code{__cxa_atexit}.
1456
1457 @item -fvtable-gc
1458 @opindex fvtable-gc
1459 Emit special relocations for vtables and virtual function references
1460 so that the linker can identify unused virtual functions and zero out
1461 vtable slots that refer to them.  This is most useful with
1462 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1463 also discard the functions themselves.
1464
1465 This optimization requires GNU as and GNU ld.  Not all systems support
1466 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1467
1468 @item -fno-weak
1469 @opindex fno-weak
1470 Do not use weak symbol support, even if it is provided by the linker.
1471 By default, G++ will use weak symbols if they are available.  This
1472 option exists only for testing, and should not be used by end-users;
1473 it will result in inferior code and has no benefits.  This option may
1474 be removed in a future release of G++.
1475
1476 @item -nostdinc++
1477 @opindex nostdinc++
1478 Do not search for header files in the standard directories specific to
1479 C++, but do still search the other standard directories.  (This option
1480 is used when building the C++ library.)
1481 @end table
1482
1483 In addition, these optimization, warning, and code generation options
1484 have meanings only for C++ programs:
1485
1486 @table @gcctabopt
1487 @item -fno-default-inline
1488 @opindex fno-default-inline
1489 Do not assume @samp{inline} for functions defined inside a class scope.
1490 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1491 functions will have linkage like inline functions; they just won't be
1492 inlined by default.
1493
1494 @item -Wabi @r{(C++ only)}
1495 @opindex Wabi
1496 Warn when G++ generates code that is probably not compatible with the
1497 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1498 all such cases, there are probably some cases that are not warned about, 
1499 even though G++ is generating incompatible code.  There may also be
1500 cases where warnings are emitted even though the code that is generated
1501 will be compatible.
1502
1503 You should rewrite your code to avoid these warnings if you are
1504 concerned about the fact that code generated by G++ may not be binary
1505 compatible with code generated by other compilers.
1506
1507 The known incompatibilities at this point include:
1508
1509 @itemize @bullet
1510
1511 @item
1512 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1513 pack data into the same byte as a base class.  For example:
1514
1515 @smallexample
1516 struct A @{ virtual void f(); int f1 : 1; @};
1517 struct B : public A @{ int f2 : 1; @};
1518 @end smallexample
1519
1520 @noindent
1521 In this case, G++ will place @code{B::f2} into the same byte
1522 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1523 by explicitly padding @code{A} so that its size is a multiple of the
1524 byte size on your platform; that will cause G++ and other compilers to
1525 layout @code{B} identically.
1526
1527 @item
1528 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1529 tail padding when laying out virtual bases.  For example:
1530
1531 @smallexample
1532 struct A @{ virtual void f(); char c1; @};
1533 struct B @{ B(); char c2; @};
1534 struct C : public A, public virtual B @{@};
1535 @end smallexample
1536
1537 @noindent
1538 In this case, G++ will not place @code{B} into the tail-padding for
1539 @code{A}; other compilers will.  You can avoid this problem by
1540 explicitly padding @code{A} so that its size is a multiple of its
1541 alignment (ignoring virtual base classes); that will cause G++ and other
1542 compilers to layout @code{C} identically.
1543
1544 @item
1545 Incorrect handling of bit-fields with declared widths greater than that
1546 of their underlying types, when the bit-fields appear in a union.  For
1547 example:
1548
1549 @smallexample
1550 union U @{ int i : 4096; @};
1551 @end smallexample
1552
1553 @noindent
1554 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1555 union too small by the number of bits in an @code{int}.
1556
1557 @item
1558 Empty classes can be placed at incorrect offsets.  For example:
1559  
1560 @smallexample
1561 struct A @{@};
1562
1563 struct B @{
1564   A a;
1565   virtual void f ();
1566 @};
1567
1568 struct C : public B, public A @{@};
1569 @end smallexample
1570
1571 @noindent
1572 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1573 it should be placed at offset zero.  G++ mistakenly believes that the
1574 @code{A} data member of @code{B} is already at offset zero.
1575
1576 @item
1577 Names of template functions whose types involve @code{typename} or
1578 template template parameters can be mangled incorrectly.
1579
1580 @smallexample
1581 template <typename Q>
1582 void f(typename Q::X) @{@}
1583
1584 template <template <typename> class Q>
1585 void f(typename Q<int>::X) @{@}
1586 @end smallexample
1587
1588 @noindent
1589 Instantiations of these templates may be mangled incorrectly.
1590
1591 @end itemize
1592
1593 @item -Wctor-dtor-privacy @r{(C++ only)}
1594 @opindex Wctor-dtor-privacy
1595 Warn when a class seems unusable, because all the constructors or
1596 destructors in a class are private and the class has no friends or
1597 public static member functions.
1598
1599 @item -Wnon-virtual-dtor @r{(C++ only)}
1600 @opindex Wnon-virtual-dtor
1601 Warn when a class declares a non-virtual destructor that should probably
1602 be virtual, because it looks like the class will be used polymorphically.
1603 This warning is enabled by @option{-Wall}.
1604
1605 @item -Wreorder @r{(C++ only)}
1606 @opindex Wreorder
1607 @cindex reordering, warning
1608 @cindex warning for reordering of member initializers
1609 Warn when the order of member initializers given in the code does not
1610 match the order in which they must be executed.  For instance:
1611
1612 @smallexample
1613 struct A @{
1614   int i;
1615   int j;
1616   A(): j (0), i (1) @{ @}
1617 @};
1618 @end smallexample
1619
1620 Here the compiler will warn that the member initializers for @samp{i}
1621 and @samp{j} will be rearranged to match the declaration order of the
1622 members.  This warning is enabled by @option{-Wall}.
1623 @end table
1624
1625 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1626
1627 @table @gcctabopt
1628 @item -Weffc++ @r{(C++ only)}
1629 @opindex Weffc++
1630 Warn about violations of the following style guidelines from Scott Meyers'
1631 @cite{Effective C++} book:
1632
1633 @itemize @bullet
1634 @item
1635 Item 11:  Define a copy constructor and an assignment operator for classes
1636 with dynamically allocated memory.
1637
1638 @item
1639 Item 12:  Prefer initialization to assignment in constructors.
1640
1641 @item
1642 Item 14:  Make destructors virtual in base classes.
1643
1644 @item
1645 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1646
1647 @item
1648 Item 23:  Don't try to return a reference when you must return an object.
1649
1650 @end itemize
1651
1652 and about violations of the following style guidelines from Scott Meyers'
1653 @cite{More Effective C++} book:
1654
1655 @itemize @bullet
1656 @item
1657 Item 6:  Distinguish between prefix and postfix forms of increment and
1658 decrement operators.
1659
1660 @item
1661 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1662
1663 @end itemize
1664
1665 If you use this option, you should be aware that the standard library
1666 headers do not obey all of these guidelines; you can use @samp{grep -v}
1667 to filter out those warnings.
1668
1669 @item -Wno-deprecated @r{(C++ only)}
1670 @opindex Wno-deprecated
1671 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1672
1673 @item -Wno-non-template-friend @r{(C++ only)}
1674 @opindex Wno-non-template-friend
1675 Disable warnings when non-templatized friend functions are declared
1676 within a template.  With the advent of explicit template specification
1677 support in G++, if the name of the friend is an unqualified-id (i.e.,
1678 @samp{friend foo(int)}), the C++ language specification demands that the
1679 friend declare or define an ordinary, nontemplate function.  (Section
1680 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1681 could be interpreted as a particular specialization of a templatized
1682 function.  Because this non-conforming behavior is no longer the default
1683 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1684 check existing code for potential trouble spots, and is on by default.
1685 This new compiler behavior can be turned off with
1686 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1687 but disables the helpful warning.
1688
1689 @item -Wold-style-cast @r{(C++ only)}
1690 @opindex Wold-style-cast
1691 Warn if an old-style (C-style) cast to a non-void type is used within
1692 a C++ program.  The new-style casts (@samp{static_cast},
1693 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1694 unintended effects, and much easier to grep for.
1695
1696 @item -Woverloaded-virtual @r{(C++ only)}
1697 @opindex Woverloaded-virtual
1698 @cindex overloaded virtual fn, warning
1699 @cindex warning for overloaded virtual fn
1700 Warn when a function declaration hides virtual functions from a
1701 base class.  For example, in:
1702
1703 @smallexample
1704 struct A @{
1705   virtual void f();
1706 @};
1707
1708 struct B: public A @{
1709   void f(int);
1710 @};
1711 @end smallexample
1712
1713 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1714 like this:
1715
1716 @smallexample
1717 B* b;
1718 b->f();
1719 @end smallexample
1720
1721 will fail to compile.
1722
1723 @item -Wno-pmf-conversions @r{(C++ only)}
1724 @opindex Wno-pmf-conversions
1725 Disable the diagnostic for converting a bound pointer to member function
1726 to a plain pointer.
1727
1728 @item -Wsign-promo @r{(C++ only)}
1729 @opindex Wsign-promo
1730 Warn when overload resolution chooses a promotion from unsigned or
1731 enumeral type to a signed type over a conversion to an unsigned type of
1732 the same size.  Previous versions of G++ would try to preserve
1733 unsignedness, but the standard mandates the current behavior.
1734
1735 @item -Wsynth @r{(C++ only)}
1736 @opindex Wsynth
1737 @cindex warning for synthesized methods
1738 @cindex synthesized methods, warning
1739 Warn when G++'s synthesis behavior does not match that of cfront.  For
1740 instance:
1741
1742 @smallexample
1743 struct A @{
1744   operator int ();
1745   A& operator = (int);
1746 @};
1747
1748 main ()
1749 @{
1750   A a,b;
1751   a = b;
1752 @}
1753 @end smallexample
1754
1755 In this example, G++ will synthesize a default @samp{A& operator =
1756 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1757 @end table
1758
1759 @node Objective-C Dialect Options
1760 @section Options Controlling Objective-C Dialect
1761
1762 @cindex compiler options, Objective-C
1763 @cindex Objective-C options, command line
1764 @cindex options, Objective-C
1765 This section describes the command-line options that are only meaningful
1766 for Objective-C programs; but you can also use most of the GNU compiler
1767 options regardless of what language your program is in.  For example,
1768 you might compile a file @code{some_class.m} like this:
1769
1770 @example
1771 gcc -g -fgnu-runtime -O -c some_class.m
1772 @end example
1773
1774 @noindent
1775 In this example, only @option{-fgnu-runtime} is an option meant only for
1776 Objective-C programs; you can use the other options with any language
1777 supported by GCC@.
1778
1779 Here is a list of options that are @emph{only} for compiling Objective-C
1780 programs:
1781
1782 @table @gcctabopt
1783 @item -fconstant-string-class=@var{class-name}
1784 @opindex fconstant-string-class
1785 Use @var{class-name} as the name of the class to instantiate for each
1786 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1787 class name is @code{NXConstantString}.
1788
1789 @item -fgnu-runtime
1790 @opindex fgnu-runtime
1791 Generate object code compatible with the standard GNU Objective-C
1792 runtime.  This is the default for most types of systems.
1793
1794 @item -fnext-runtime
1795 @opindex fnext-runtime
1796 Generate output compatible with the NeXT runtime.  This is the default
1797 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1798 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1799 used.
1800
1801 @item -gen-decls
1802 @opindex gen-decls
1803 Dump interface declarations for all classes seen in the source file to a
1804 file named @file{@var{sourcename}.decl}.
1805
1806 @item -Wno-protocol
1807 @opindex Wno-protocol
1808 If a class is declared to implement a protocol, a warning is issued for
1809 every method in the protocol that is not implemented by the class.  The
1810 default behavior is to issue a warning for every method not explicitly
1811 implemented in the class, even if a method implementation is inherited
1812 from the superclass.  If you use the @code{-Wno-protocol} option, then
1813 methods inherited from the superclass are considered to be implemented,
1814 and no warning is issued for them.
1815
1816 @item -Wselector
1817 @opindex Wselector
1818 Warn if multiple methods of different types for the same selector are
1819 found during compilation.  The check is performed on the list of methods
1820 in the final stage of compilation.  Additionally, a check is performed
1821 that for each selector appearing in a @code{@@selector(@dots{})}
1822 expression, a corresponding method with that selector has been found
1823 during compilation.  Because these checks scan the method table only at
1824 the end of compilation, these warnings are not produced if the final
1825 stage of compilation is not reached, for example because an error is
1826 found during compilation, or because the @code{-fsyntax-only} option is
1827 being used.
1828
1829 @item -Wundeclared-selector
1830 @opindex Wundeclared-selector
1831 Warn if a @code{@@selector(@dots{})} expression referring to an
1832 undeclared selector is found.  A selector is considered undeclared if no
1833 method with that name has been declared (explicitly, in an
1834 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1835 an @code{@@implementation} section) before the
1836 @code{@@selector(@dots{})} expression.  This option always performs its
1837 checks as soon as a @code{@@selector(@dots{})} expression is found
1838 (while @code{-Wselector} only performs its checks in the final stage of
1839 compilation), and so additionally enforces the coding style convention
1840 that methods and selectors must be declared before being used.
1841
1842 @c not documented because only avail via -Wp
1843 @c @item -print-objc-runtime-info
1844
1845 @end table
1846
1847 @node Language Independent Options
1848 @section Options to Control Diagnostic Messages Formatting
1849 @cindex options to control diagnostics formatting
1850 @cindex diagnostic messages
1851 @cindex message formatting
1852
1853 Traditionally, diagnostic messages have been formatted irrespective of
1854 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1855 below can be used to control the diagnostic messages formatting
1856 algorithm, e.g.@: how many characters per line, how often source location
1857 information should be reported.  Right now, only the C++ front end can
1858 honor these options.  However it is expected, in the near future, that
1859 the remaining front ends would be able to digest them correctly.
1860
1861 @table @gcctabopt
1862 @item -fmessage-length=@var{n}
1863 @opindex fmessage-length
1864 Try to format error messages so that they fit on lines of about @var{n}
1865 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1866 the front ends supported by GCC@.  If @var{n} is zero, then no
1867 line-wrapping will be done; each error message will appear on a single
1868 line.
1869
1870 @opindex fdiagnostics-show-location
1871 @item -fdiagnostics-show-location=once
1872 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1873 reporter to emit @emph{once} source location information; that is, in
1874 case the message is too long to fit on a single physical line and has to
1875 be wrapped, the source location won't be emitted (as prefix) again,
1876 over and over, in subsequent continuation lines.  This is the default
1877 behavior.
1878
1879 @item -fdiagnostics-show-location=every-line
1880 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1881 messages reporter to emit the same source location information (as
1882 prefix) for physical lines that result from the process of breaking
1883 a message which is too long to fit on a single line.
1884
1885 @end table
1886
1887 @node Warning Options
1888 @section Options to Request or Suppress Warnings
1889 @cindex options to control warnings
1890 @cindex warning messages
1891 @cindex messages, warning
1892 @cindex suppressing warnings
1893
1894 Warnings are diagnostic messages that report constructions which
1895 are not inherently erroneous but which are risky or suggest there
1896 may have been an error.
1897
1898 You can request many specific warnings with options beginning @samp{-W},
1899 for example @option{-Wimplicit} to request warnings on implicit
1900 declarations.  Each of these specific warning options also has a
1901 negative form beginning @samp{-Wno-} to turn off warnings;
1902 for example, @option{-Wno-implicit}.  This manual lists only one of the
1903 two forms, whichever is not the default.
1904
1905 The following options control the amount and kinds of warnings produced
1906 by GCC; for further, language-specific options also refer to
1907 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1908
1909 @table @gcctabopt
1910 @cindex syntax checking
1911 @item -fsyntax-only
1912 @opindex fsyntax-only
1913 Check the code for syntax errors, but don't do anything beyond that.
1914
1915 @item -pedantic
1916 @opindex pedantic
1917 Issue all the warnings demanded by strict ISO C and ISO C++;
1918 reject all programs that use forbidden extensions, and some other
1919 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1920 version of the ISO C standard specified by any @option{-std} option used.
1921
1922 Valid ISO C and ISO C++ programs should compile properly with or without
1923 this option (though a rare few will require @option{-ansi} or a
1924 @option{-std} option specifying the required version of ISO C)@.  However,
1925 without this option, certain GNU extensions and traditional C and C++
1926 features are supported as well.  With this option, they are rejected.
1927
1928 @option{-pedantic} does not cause warning messages for use of the
1929 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1930 warnings are also disabled in the expression that follows
1931 @code{__extension__}.  However, only system header files should use
1932 these escape routes; application programs should avoid them.
1933 @xref{Alternate Keywords}.
1934
1935 Some users try to use @option{-pedantic} to check programs for strict ISO
1936 C conformance.  They soon find that it does not do quite what they want:
1937 it finds some non-ISO practices, but not all---only those for which
1938 ISO C @emph{requires} a diagnostic, and some others for which
1939 diagnostics have been added.
1940
1941 A feature to report any failure to conform to ISO C might be useful in
1942 some instances, but would require considerable additional work and would
1943 be quite different from @option{-pedantic}.  We don't have plans to
1944 support such a feature in the near future.
1945
1946 Where the standard specified with @option{-std} represents a GNU
1947 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1948 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1949 extended dialect is based.  Warnings from @option{-pedantic} are given
1950 where they are required by the base standard.  (It would not make sense
1951 for such warnings to be given only for features not in the specified GNU
1952 C dialect, since by definition the GNU dialects of C include all
1953 features the compiler supports with the given option, and there would be
1954 nothing to warn about.)
1955
1956 @item -pedantic-errors
1957 @opindex pedantic-errors
1958 Like @option{-pedantic}, except that errors are produced rather than
1959 warnings.
1960
1961 @item -w
1962 @opindex w
1963 Inhibit all warning messages.
1964
1965 @item -Wno-import
1966 @opindex Wno-import
1967 Inhibit warning messages about the use of @samp{#import}.
1968
1969 @item -Wchar-subscripts
1970 @opindex Wchar-subscripts
1971 Warn if an array subscript has type @code{char}.  This is a common cause
1972 of error, as programmers often forget that this type is signed on some
1973 machines.
1974
1975 @item -Wcomment
1976 @opindex Wcomment
1977 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1978 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1979
1980 @item -Wformat
1981 @opindex Wformat
1982 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1983 the arguments supplied have types appropriate to the format string
1984 specified, and that the conversions specified in the format string make
1985 sense.  This includes standard functions, and others specified by format
1986 attributes (@pxref{Function Attributes}), in the @code{printf},
1987 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1988 not in the C standard) families.
1989
1990 The formats are checked against the format features supported by GNU
1991 libc version 2.2.  These include all ISO C90 and C99 features, as well
1992 as features from the Single Unix Specification and some BSD and GNU
1993 extensions.  Other library implementations may not support all these
1994 features; GCC does not support warning about features that go beyond a
1995 particular library's limitations.  However, if @option{-pedantic} is used
1996 with @option{-Wformat}, warnings will be given about format features not
1997 in the selected standard version (but not for @code{strfmon} formats,
1998 since those are not in any version of the C standard).  @xref{C Dialect
1999 Options,,Options Controlling C Dialect}.
2000
2001 Since @option{-Wformat} also checks for null format arguments for
2002 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2003
2004 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2005 aspects of format checking, the options @option{-Wno-format-y2k},
2006 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2007 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2008 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2009
2010 @item -Wno-format-y2k
2011 @opindex Wno-format-y2k
2012 If @option{-Wformat} is specified, do not warn about @code{strftime}
2013 formats which may yield only a two-digit year.
2014
2015 @item -Wno-format-extra-args
2016 @opindex Wno-format-extra-args
2017 If @option{-Wformat} is specified, do not warn about excess arguments to a
2018 @code{printf} or @code{scanf} format function.  The C standard specifies
2019 that such arguments are ignored.
2020
2021 Where the unused arguments lie between used arguments that are
2022 specified with @samp{$} operand number specifications, normally
2023 warnings are still given, since the implementation could not know what
2024 type to pass to @code{va_arg} to skip the unused arguments.  However,
2025 in the case of @code{scanf} formats, this option will suppress the
2026 warning if the unused arguments are all pointers, since the Single
2027 Unix Specification says that such unused arguments are allowed.
2028
2029 @item -Wno-format-zero-length
2030 @opindex Wno-format-zero-length
2031 If @option{-Wformat} is specified, do not warn about zero-length formats.
2032 The C standard specifies that zero-length formats are allowed.
2033
2034 @item -Wformat-nonliteral
2035 @opindex Wformat-nonliteral
2036 If @option{-Wformat} is specified, also warn if the format string is not a
2037 string literal and so cannot be checked, unless the format function
2038 takes its format arguments as a @code{va_list}.
2039
2040 @item -Wformat-security
2041 @opindex Wformat-security
2042 If @option{-Wformat} is specified, also warn about uses of format
2043 functions that represent possible security problems.  At present, this
2044 warns about calls to @code{printf} and @code{scanf} functions where the
2045 format string is not a string literal and there are no format arguments,
2046 as in @code{printf (foo);}.  This may be a security hole if the format
2047 string came from untrusted input and contains @samp{%n}.  (This is
2048 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2049 in future warnings may be added to @option{-Wformat-security} that are not
2050 included in @option{-Wformat-nonliteral}.)
2051
2052 @item -Wformat=2
2053 @opindex Wformat=2
2054 Enable @option{-Wformat} plus format checks not included in
2055 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2056 -Wformat-nonliteral -Wformat-security}.
2057
2058 @item -Wnonnull
2059 @opindex Wnonnull
2060 Enable warning about passing a null pointer for arguments marked as
2061 requiring a non-null value by the @code{nonnull} function attribute.
2062
2063 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2064 can be disabled with the @option{-Wno-nonnull} option.
2065
2066 @item -Wimplicit-int
2067 @opindex Wimplicit-int
2068 Warn when a declaration does not specify a type.
2069
2070 @item -Wimplicit-function-declaration
2071 @itemx -Werror-implicit-function-declaration
2072 @opindex Wimplicit-function-declaration
2073 @opindex Werror-implicit-function-declaration
2074 Give a warning (or error) whenever a function is used before being
2075 declared.
2076
2077 @item -Wimplicit
2078 @opindex Wimplicit
2079 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2080
2081 @item -Wmain
2082 @opindex Wmain
2083 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2084 function with external linkage, returning int, taking either zero
2085 arguments, two, or three arguments of appropriate types.
2086
2087 @item -Wmissing-braces
2088 @opindex Wmissing-braces
2089 Warn if an aggregate or union initializer is not fully bracketed.  In
2090 the following example, the initializer for @samp{a} is not fully
2091 bracketed, but that for @samp{b} is fully bracketed.
2092
2093 @smallexample
2094 int a[2][2] = @{ 0, 1, 2, 3 @};
2095 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2096 @end smallexample
2097
2098 @item -Wparentheses
2099 @opindex Wparentheses
2100 Warn if parentheses are omitted in certain contexts, such
2101 as when there is an assignment in a context where a truth value
2102 is expected, or when operators are nested whose precedence people
2103 often get confused about.
2104
2105 Also warn about constructions where there may be confusion to which
2106 @code{if} statement an @code{else} branch belongs.  Here is an example of
2107 such a case:
2108
2109 @smallexample
2110 @group
2111 @{
2112   if (a)
2113     if (b)
2114       foo ();
2115   else
2116     bar ();
2117 @}
2118 @end group
2119 @end smallexample
2120
2121 In C, every @code{else} branch belongs to the innermost possible @code{if}
2122 statement, which in this example is @code{if (b)}.  This is often not
2123 what the programmer expected, as illustrated in the above example by
2124 indentation the programmer chose.  When there is the potential for this
2125 confusion, GCC will issue a warning when this flag is specified.
2126 To eliminate the warning, add explicit braces around the innermost
2127 @code{if} statement so there is no way the @code{else} could belong to
2128 the enclosing @code{if}.  The resulting code would look like this:
2129
2130 @smallexample
2131 @group
2132 @{
2133   if (a)
2134     @{
2135       if (b)
2136         foo ();
2137       else
2138         bar ();
2139     @}
2140 @}
2141 @end group
2142 @end smallexample
2143
2144 @item -Wsequence-point
2145 @opindex Wsequence-point
2146 Warn about code that may have undefined semantics because of violations
2147 of sequence point rules in the C standard.
2148
2149 The C standard defines the order in which expressions in a C program are
2150 evaluated in terms of @dfn{sequence points}, which represent a partial
2151 ordering between the execution of parts of the program: those executed
2152 before the sequence point, and those executed after it.  These occur
2153 after the evaluation of a full expression (one which is not part of a
2154 larger expression), after the evaluation of the first operand of a
2155 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2156 function is called (but after the evaluation of its arguments and the
2157 expression denoting the called function), and in certain other places.
2158 Other than as expressed by the sequence point rules, the order of
2159 evaluation of subexpressions of an expression is not specified.  All
2160 these rules describe only a partial order rather than a total order,
2161 since, for example, if two functions are called within one expression
2162 with no sequence point between them, the order in which the functions
2163 are called is not specified.  However, the standards committee have
2164 ruled that function calls do not overlap.
2165
2166 It is not specified when between sequence points modifications to the
2167 values of objects take effect.  Programs whose behavior depends on this
2168 have undefined behavior; the C standard specifies that ``Between the
2169 previous and next sequence point an object shall have its stored value
2170 modified at most once by the evaluation of an expression.  Furthermore,
2171 the prior value shall be read only to determine the value to be
2172 stored.''.  If a program breaks these rules, the results on any
2173 particular implementation are entirely unpredictable.
2174
2175 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2176 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2177 diagnosed by this option, and it may give an occasional false positive
2178 result, but in general it has been found fairly effective at detecting
2179 this sort of problem in programs.
2180
2181 The present implementation of this option only works for C programs.  A
2182 future implementation may also work for C++ programs.
2183
2184 The C standard is worded confusingly, therefore there is some debate
2185 over the precise meaning of the sequence point rules in subtle cases.
2186 Links to discussions of the problem, including proposed formal
2187 definitions, may be found on our readings page, at
2188 @w{@uref{http://gcc.gnu.org/readings.html}}.
2189
2190 @item -Wreturn-type
2191 @opindex Wreturn-type
2192 Warn whenever a function is defined with a return-type that defaults to
2193 @code{int}.  Also warn about any @code{return} statement with no
2194 return-value in a function whose return-type is not @code{void}.
2195
2196 For C++, a function without return type always produces a diagnostic
2197 message, even when @option{-Wno-return-type} is specified.  The only
2198 exceptions are @samp{main} and functions defined in system headers.
2199
2200 @item -Wswitch
2201 @opindex Wswitch
2202 Warn whenever a @code{switch} statement has an index of enumeral type
2203 and lacks a @code{case} for one or more of the named codes of that
2204 enumeration.  (The presence of a @code{default} label prevents this
2205 warning.)  @code{case} labels outside the enumeration range also
2206 provoke warnings when this option is used.
2207
2208 @item -Wswitch-default
2209 @opindex Wswitch-switch
2210 Warn whenever a @code{switch} statement does not have a @code{default}
2211 case.
2212
2213 @item -Wswitch-enum
2214 @opindex Wswitch-enum
2215 Warn whenever a @code{switch} statement has an index of enumeral type
2216 and lacks a @code{case} for one or more of the named codes of that
2217 enumeration.  @code{case} labels outside the enumeration range also
2218 provoke warnings when this option is used.
2219
2220 @item -Wtrigraphs
2221 @opindex Wtrigraphs
2222 Warn if any trigraphs are encountered that might change the meaning of
2223 the program (trigraphs within comments are not warned about).
2224
2225 @item -Wunused-function
2226 @opindex Wunused-function
2227 Warn whenever a static function is declared but not defined or a
2228 non\-inline static function is unused.
2229
2230 @item -Wunused-label
2231 @opindex Wunused-label
2232 Warn whenever a label is declared but not used.
2233
2234 To suppress this warning use the @samp{unused} attribute
2235 (@pxref{Variable Attributes}).
2236
2237 @item -Wunused-parameter
2238 @opindex Wunused-parameter
2239 Warn whenever a function parameter is unused aside from its declaration.
2240
2241 To suppress this warning use the @samp{unused} attribute
2242 (@pxref{Variable Attributes}).
2243
2244 @item -Wunused-variable
2245 @opindex Wunused-variable
2246 Warn whenever a local variable or non-constant static variable is unused
2247 aside from its declaration
2248
2249 To suppress this warning use the @samp{unused} attribute
2250 (@pxref{Variable Attributes}).
2251
2252 @item -Wunused-value
2253 @opindex Wunused-value
2254 Warn whenever a statement computes a result that is explicitly not used.
2255
2256 To suppress this warning cast the expression to @samp{void}.
2257
2258 @item -Wunused
2259 @opindex Wunused
2260 All the above @option{-Wunused} options combined.
2261
2262 In order to get a warning about an unused function parameter, you must
2263 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2264 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2265
2266 @item -Wuninitialized
2267 @opindex Wuninitialized
2268 Warn if an automatic variable is used without first being initialized or
2269 if a variable may be clobbered by a @code{setjmp} call.
2270
2271 These warnings are possible only in optimizing compilation,
2272 because they require data flow information that is computed only
2273 when optimizing.  If you don't specify @option{-O}, you simply won't
2274 get these warnings.
2275
2276 These warnings occur only for variables that are candidates for
2277 register allocation.  Therefore, they do not occur for a variable that
2278 is declared @code{volatile}, or whose address is taken, or whose size
2279 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2280 structures, unions or arrays, even when they are in registers.
2281
2282 Note that there may be no warning about a variable that is used only
2283 to compute a value that itself is never used, because such
2284 computations may be deleted by data flow analysis before the warnings
2285 are printed.
2286
2287 These warnings are made optional because GCC is not smart
2288 enough to see all the reasons why the code might be correct
2289 despite appearing to have an error.  Here is one example of how
2290 this can happen:
2291
2292 @smallexample
2293 @group
2294 @{
2295   int x;
2296   switch (y)
2297     @{
2298     case 1: x = 1;
2299       break;
2300     case 2: x = 4;
2301       break;
2302     case 3: x = 5;
2303     @}
2304   foo (x);
2305 @}
2306 @end group
2307 @end smallexample
2308
2309 @noindent
2310 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2311 always initialized, but GCC doesn't know this.  Here is
2312 another common case:
2313
2314 @smallexample
2315 @{
2316   int save_y;
2317   if (change_y) save_y = y, y = new_y;
2318   @dots{}
2319   if (change_y) y = save_y;
2320 @}
2321 @end smallexample
2322
2323 @noindent
2324 This has no bug because @code{save_y} is used only if it is set.
2325
2326 @cindex @code{longjmp} warnings
2327 This option also warns when a non-volatile automatic variable might be
2328 changed by a call to @code{longjmp}.  These warnings as well are possible
2329 only in optimizing compilation.
2330
2331 The compiler sees only the calls to @code{setjmp}.  It cannot know
2332 where @code{longjmp} will be called; in fact, a signal handler could
2333 call it at any point in the code.  As a result, you may get a warning
2334 even when there is in fact no problem because @code{longjmp} cannot
2335 in fact be called at the place which would cause a problem.
2336
2337 Some spurious warnings can be avoided if you declare all the functions
2338 you use that never return as @code{noreturn}.  @xref{Function
2339 Attributes}.
2340
2341 @item -Wunknown-pragmas
2342 @opindex Wunknown-pragmas
2343 @cindex warning for unknown pragmas
2344 @cindex unknown pragmas, warning
2345 @cindex pragmas, warning of unknown
2346 Warn when a #pragma directive is encountered which is not understood by
2347 GCC@.  If this command line option is used, warnings will even be issued
2348 for unknown pragmas in system header files.  This is not the case if
2349 the warnings were only enabled by the @option{-Wall} command line option.
2350
2351 @item -Wstrict-aliasing
2352 @opindex Wstrict-aliasing
2353 This option is only active when @option{-fstrict-aliasing} is active.
2354 It warns about code which might break the strict aliasing rules that the
2355 compiler is using for optimization. The warning does not catch all
2356 cases, but does attempt to catch the more common pitfalls. It is
2357 included in @option{-Wall}.
2358
2359 @item -Wall
2360 @opindex Wall
2361 All of the above @samp{-W} options combined.  This enables all the
2362 warnings about constructions that some users consider questionable, and
2363 that are easy to avoid (or modify to prevent the warning), even in
2364 conjunction with macros.  This also enables some language-specific
2365 warnings described in @ref{C++ Dialect Options} and
2366 @ref{Objective-C Dialect Options}.
2367 @end table
2368
2369 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2370 Some of them warn about constructions that users generally do not
2371 consider questionable, but which occasionally you might wish to check
2372 for; others warn about constructions that are necessary or hard to avoid
2373 in some cases, and there is no simple way to modify the code to suppress
2374 the warning.
2375
2376 @table @gcctabopt
2377 @item -Wextra
2378 @opindex W
2379 @opindex Wextra
2380 (This option used to be called @option{-W}.  The older name is still
2381 supported, but the newer name is more descriptive.)  Print extra warning
2382 messages for these events:
2383
2384 @itemize @bullet
2385 @item
2386 A function can return either with or without a value.  (Falling
2387 off the end of the function body is considered returning without
2388 a value.)  For example, this function would evoke such a
2389 warning:
2390
2391 @smallexample
2392 @group
2393 foo (a)
2394 @{
2395   if (a > 0)
2396     return a;
2397 @}
2398 @end group
2399 @end smallexample
2400
2401 @item
2402 An expression-statement or the left-hand side of a comma expression
2403 contains no side effects.
2404 To suppress the warning, cast the unused expression to void.
2405 For example, an expression such as @samp{x[i,j]} will cause a warning,
2406 but @samp{x[(void)i,j]} will not.
2407
2408 @item
2409 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2410
2411 @item
2412 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2413 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2414 that of ordinary mathematical notation.
2415
2416 @item
2417 Storage-class specifiers like @code{static} are not the first things in
2418 a declaration.  According to the C Standard, this usage is obsolescent.
2419
2420 @item
2421 The return type of a function has a type qualifier such as @code{const}.
2422 Such a type qualifier has no effect, since the value returned by a
2423 function is not an lvalue.  (But don't warn about the GNU extension of
2424 @code{volatile void} return types.  That extension will be warned about
2425 if @option{-pedantic} is specified.)
2426
2427 @item
2428 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2429 arguments.
2430
2431 @item
2432 A comparison between signed and unsigned values could produce an
2433 incorrect result when the signed value is converted to unsigned.
2434 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2435
2436 @item
2437 An aggregate has an initializer which does not initialize all members.
2438 For example, the following code would cause such a warning, because
2439 @code{x.h} would be implicitly initialized to zero:
2440
2441 @smallexample
2442 struct s @{ int f, g, h; @};
2443 struct s x = @{ 3, 4 @};
2444 @end smallexample
2445
2446 @item
2447 A function parameter is declared without a type specifier in K&R-style
2448 functions:
2449
2450 @smallexample
2451 void foo(bar) @{ @}
2452 @end smallexample
2453
2454 @item
2455 An empty body occurs in an @samp{if} or @samp{else} statement.
2456
2457 @item
2458 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2459 @samp{>}, or @samp{>=}.
2460
2461 @item
2462 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2463
2464 @item
2465 Any of several floating-point events that often indicate errors, such as
2466 overflow, underflow, loss of precision, etc.
2467
2468 @item @r{(C++ only)}
2469 An enumerator and a non-enumerator both appear in a conditional expression.
2470
2471 @item @r{(C++ only)}
2472 A non-static reference or non-static @samp{const} member appears in a
2473 class without constructors.
2474
2475 @item @r{(C++ only)}
2476 Ambiguous virtual bases.
2477
2478 @item @r{(C++ only)}
2479 Subscripting an array which has been declared @samp{register}.
2480
2481 @item @r{(C++ only)}
2482 Taking the address of a variable which has been declared @samp{register}.
2483
2484 @item @r{(C++ only)}
2485 A base class is not initialized in a derived class' copy constructor.
2486 @end itemize
2487
2488 @item -Wno-div-by-zero
2489 @opindex Wno-div-by-zero
2490 @opindex Wdiv-by-zero
2491 Do not warn about compile-time integer division by zero.  Floating point
2492 division by zero is not warned about, as it can be a legitimate way of
2493 obtaining infinities and NaNs.
2494
2495 @item -Wsystem-headers
2496 @opindex Wsystem-headers
2497 @cindex warnings from system headers
2498 @cindex system headers, warnings from
2499 Print warning messages for constructs found in system header files.
2500 Warnings from system headers are normally suppressed, on the assumption
2501 that they usually do not indicate real problems and would only make the
2502 compiler output harder to read.  Using this command line option tells
2503 GCC to emit warnings from system headers as if they occurred in user
2504 code.  However, note that using @option{-Wall} in conjunction with this
2505 option will @emph{not} warn about unknown pragmas in system
2506 headers---for that, @option{-Wunknown-pragmas} must also be used.
2507
2508 @item -Wfloat-equal
2509 @opindex Wfloat-equal
2510 Warn if floating point values are used in equality comparisons.
2511
2512 The idea behind this is that sometimes it is convenient (for the
2513 programmer) to consider floating-point values as approximations to
2514 infinitely precise real numbers.  If you are doing this, then you need
2515 to compute (by analyzing the code, or in some other way) the maximum or
2516 likely maximum error that the computation introduces, and allow for it
2517 when performing comparisons (and when producing output, but that's a
2518 different problem).  In particular, instead of testing for equality, you
2519 would check to see whether the two values have ranges that overlap; and
2520 this is done with the relational operators, so equality comparisons are
2521 probably mistaken.
2522
2523 @item -Wtraditional @r{(C only)}
2524 @opindex Wtraditional
2525 Warn about certain constructs that behave differently in traditional and
2526 ISO C@.  Also warn about ISO C constructs that have no traditional C
2527 equivalent, and/or problematic constructs which should be avoided.
2528
2529 @itemize @bullet
2530 @item
2531 Macro parameters that appear within string literals in the macro body.
2532 In traditional C macro replacement takes place within string literals,
2533 but does not in ISO C@.
2534
2535 @item
2536 In traditional C, some preprocessor directives did not exist.
2537 Traditional preprocessors would only consider a line to be a directive
2538 if the @samp{#} appeared in column 1 on the line.  Therefore
2539 @option{-Wtraditional} warns about directives that traditional C
2540 understands but would ignore because the @samp{#} does not appear as the
2541 first character on the line.  It also suggests you hide directives like
2542 @samp{#pragma} not understood by traditional C by indenting them.  Some
2543 traditional implementations would not recognize @samp{#elif}, so it
2544 suggests avoiding it altogether.
2545
2546 @item
2547 A function-like macro that appears without arguments.
2548
2549 @item
2550 The unary plus operator.
2551
2552 @item
2553 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2554 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2555 constants.)  Note, these suffixes appear in macros defined in the system
2556 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2557 Use of these macros in user code might normally lead to spurious
2558 warnings, however gcc's integrated preprocessor has enough context to
2559 avoid warning in these cases.
2560
2561 @item
2562 A function declared external in one block and then used after the end of
2563 the block.
2564
2565 @item
2566 A @code{switch} statement has an operand of type @code{long}.
2567
2568 @item
2569 A non-@code{static} function declaration follows a @code{static} one.
2570 This construct is not accepted by some traditional C compilers.
2571
2572 @item
2573 The ISO type of an integer constant has a different width or
2574 signedness from its traditional type.  This warning is only issued if
2575 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2576 typically represent bit patterns, are not warned about.
2577
2578 @item
2579 Usage of ISO string concatenation is detected.
2580
2581 @item
2582 Initialization of automatic aggregates.
2583
2584 @item
2585 Identifier conflicts with labels.  Traditional C lacks a separate
2586 namespace for labels.
2587
2588 @item
2589 Initialization of unions.  If the initializer is zero, the warning is
2590 omitted.  This is done under the assumption that the zero initializer in
2591 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2592 initializer warnings and relies on default initialization to zero in the
2593 traditional C case.
2594
2595 @item
2596 Conversions by prototypes between fixed/floating point values and vice
2597 versa.  The absence of these prototypes when compiling with traditional
2598 C would cause serious problems.  This is a subset of the possible
2599 conversion warnings, for the full set use @option{-Wconversion}.
2600
2601 @item
2602 Use of ISO C style function definitions.  This warning intentionally is
2603 @emph{not} issued for prototype declarations or variadic functions
2604 because these ISO C features will appear in your code when using
2605 libiberty's traditional C compatibility macros, @code{PARAMS} and
2606 @code{VPARAMS}.  This warning is also bypassed for nested functions
2607 because that feature is already a gcc extension and thus not relevant to
2608 traditional C compatibility.
2609 @end itemize
2610
2611 @item -Wundef
2612 @opindex Wundef
2613 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2614
2615 @item -Wendif-labels
2616 @opindex Wendif-labels
2617 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2618
2619 @item -Wshadow
2620 @opindex Wshadow
2621 Warn whenever a local variable shadows another local variable, parameter or
2622 global variable or whenever a built-in function is shadowed.
2623
2624 @item -Wlarger-than-@var{len}
2625 @opindex Wlarger-than
2626 Warn whenever an object of larger than @var{len} bytes is defined.
2627
2628 @item -Wpointer-arith
2629 @opindex Wpointer-arith
2630 Warn about anything that depends on the ``size of'' a function type or
2631 of @code{void}.  GNU C assigns these types a size of 1, for
2632 convenience in calculations with @code{void *} pointers and pointers
2633 to functions.
2634
2635 @item -Wbad-function-cast @r{(C only)}
2636 @opindex Wbad-function-cast
2637 Warn whenever a function call is cast to a non-matching type.
2638 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2639
2640 @item -Wcast-qual
2641 @opindex Wcast-qual
2642 Warn whenever a pointer is cast so as to remove a type qualifier from
2643 the target type.  For example, warn if a @code{const char *} is cast
2644 to an ordinary @code{char *}.
2645
2646 @item -Wcast-align
2647 @opindex Wcast-align
2648 Warn whenever a pointer is cast such that the required alignment of the
2649 target is increased.  For example, warn if a @code{char *} is cast to
2650 an @code{int *} on machines where integers can only be accessed at
2651 two- or four-byte boundaries.
2652
2653 @item -Wwrite-strings
2654 @opindex Wwrite-strings
2655 When compiling C, give string constants the type @code{const
2656 char[@var{length}]} so that
2657 copying the address of one into a non-@code{const} @code{char *}
2658 pointer will get a warning; when compiling C++, warn about the
2659 deprecated conversion from string constants to @code{char *}.
2660 These warnings will help you find at
2661 compile time code that can try to write into a string constant, but
2662 only if you have been very careful about using @code{const} in
2663 declarations and prototypes.  Otherwise, it will just be a nuisance;
2664 this is why we did not make @option{-Wall} request these warnings.
2665
2666 @item -Wconversion
2667 @opindex Wconversion
2668 Warn if a prototype causes a type conversion that is different from what
2669 would happen to the same argument in the absence of a prototype.  This
2670 includes conversions of fixed point to floating and vice versa, and
2671 conversions changing the width or signedness of a fixed point argument
2672 except when the same as the default promotion.
2673
2674 Also, warn if a negative integer constant expression is implicitly
2675 converted to an unsigned type.  For example, warn about the assignment
2676 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2677 casts like @code{(unsigned) -1}.
2678
2679 @item -Wsign-compare
2680 @opindex Wsign-compare
2681 @cindex warning for comparison of signed and unsigned values
2682 @cindex comparison of signed and unsigned values, warning
2683 @cindex signed and unsigned values, comparison warning
2684 Warn when a comparison between signed and unsigned values could produce
2685 an incorrect result when the signed value is converted to unsigned.
2686 This warning is also enabled by @option{-Wextra}; to get the other warnings
2687 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2688
2689 @item -Waggregate-return
2690 @opindex Waggregate-return
2691 Warn if any functions that return structures or unions are defined or
2692 called.  (In languages where you can return an array, this also elicits
2693 a warning.)
2694
2695 @item -Wstrict-prototypes @r{(C only)}
2696 @opindex Wstrict-prototypes
2697 Warn if a function is declared or defined without specifying the
2698 argument types.  (An old-style function definition is permitted without
2699 a warning if preceded by a declaration which specifies the argument
2700 types.)
2701
2702 @item -Wmissing-prototypes @r{(C only)}
2703 @opindex Wmissing-prototypes
2704 Warn if a global function is defined without a previous prototype
2705 declaration.  This warning is issued even if the definition itself
2706 provides a prototype.  The aim is to detect global functions that fail
2707 to be declared in header files.
2708
2709 @item -Wmissing-declarations @r{(C only)}
2710 @opindex Wmissing-declarations
2711 Warn if a global function is defined without a previous declaration.
2712 Do so even if the definition itself provides a prototype.
2713 Use this option to detect global functions that are not declared in
2714 header files.
2715
2716 @item -Wmissing-noreturn
2717 @opindex Wmissing-noreturn
2718 Warn about functions which might be candidates for attribute @code{noreturn}.
2719 Note these are only possible candidates, not absolute ones.  Care should
2720 be taken to manually verify functions actually do not ever return before
2721 adding the @code{noreturn} attribute, otherwise subtle code generation
2722 bugs could be introduced.  You will not get a warning for @code{main} in
2723 hosted C environments.
2724
2725 @item -Wmissing-format-attribute
2726 @opindex Wmissing-format-attribute
2727 @opindex Wformat
2728 If @option{-Wformat} is enabled, also warn about functions which might be
2729 candidates for @code{format} attributes.  Note these are only possible
2730 candidates, not absolute ones.  GCC will guess that @code{format}
2731 attributes might be appropriate for any function that calls a function
2732 like @code{vprintf} or @code{vscanf}, but this might not always be the
2733 case, and some functions for which @code{format} attributes are
2734 appropriate may not be detected.  This option has no effect unless
2735 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2736
2737 @item -Wno-multichar
2738 @opindex Wno-multichar
2739 @opindex Wmultichar
2740 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2741 Usually they indicate a typo in the user's code, as they have
2742 implementation-defined values, and should not be used in portable code.
2743
2744 @item -Wno-deprecated-declarations
2745 @opindex Wno-deprecated-declarations
2746 Do not warn about uses of functions, variables, and types marked as
2747 deprecated by using the @code{deprecated} attribute.
2748 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2749 @pxref{Type Attributes}.)
2750
2751 @item -Wpacked
2752 @opindex Wpacked
2753 Warn if a structure is given the packed attribute, but the packed
2754 attribute has no effect on the layout or size of the structure.
2755 Such structures may be mis-aligned for little benefit.  For
2756 instance, in this code, the variable @code{f.x} in @code{struct bar}
2757 will be misaligned even though @code{struct bar} does not itself
2758 have the packed attribute:
2759
2760 @smallexample
2761 @group
2762 struct foo @{
2763   int x;
2764   char a, b, c, d;
2765 @} __attribute__((packed));
2766 struct bar @{
2767   char z;
2768   struct foo f;
2769 @};
2770 @end group
2771 @end smallexample
2772
2773 @item -Wpadded
2774 @opindex Wpadded
2775 Warn if padding is included in a structure, either to align an element
2776 of the structure or to align the whole structure.  Sometimes when this
2777 happens it is possible to rearrange the fields of the structure to
2778 reduce the padding and so make the structure smaller.
2779
2780 @item -Wredundant-decls
2781 @opindex Wredundant-decls
2782 Warn if anything is declared more than once in the same scope, even in
2783 cases where multiple declaration is valid and changes nothing.
2784
2785 @item -Wnested-externs @r{(C only)}
2786 @opindex Wnested-externs
2787 Warn if an @code{extern} declaration is encountered within a function.
2788
2789 @item -Wunreachable-code
2790 @opindex Wunreachable-code
2791 Warn if the compiler detects that code will never be executed.
2792
2793 This option is intended to warn when the compiler detects that at
2794 least a whole line of source code will never be executed, because
2795 some condition is never satisfied or because it is after a
2796 procedure that never returns.
2797
2798 It is possible for this option to produce a warning even though there
2799 are circumstances under which part of the affected line can be executed,
2800 so care should be taken when removing apparently-unreachable code.
2801
2802 For instance, when a function is inlined, a warning may mean that the
2803 line is unreachable in only one inlined copy of the function.
2804
2805 This option is not made part of @option{-Wall} because in a debugging
2806 version of a program there is often substantial code which checks
2807 correct functioning of the program and is, hopefully, unreachable
2808 because the program does work.  Another common use of unreachable
2809 code is to provide behavior which is selectable at compile-time.
2810
2811 @item -Winline
2812 @opindex Winline
2813 Warn if a function can not be inlined and it was declared as inline.
2814 Even with this option, the compiler will not warn about failures to
2815 inline functions declared in system headers.  
2816
2817 The compiler uses a variety of heuristics to determine whether or not
2818 to inline a function.  For example, the compiler takes into account
2819 the size of the function being inlined and the the amount of inlining
2820 that has already been done in the current function.  Therefore,
2821 seemingly insignificant changes in the source program can cause the
2822 warnings produced by @option{-Winline} to appear or disappear.
2823
2824 @item -Wno-invalid-offsetof @r{(C++ only)}
2825 @opindex Wno-invalid-offsetof
2826 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2827 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2828 to a non-POD type is undefined.  In existing C++ implementations,
2829 however, @samp{offsetof} typically gives meaningful results even when
2830 applied to certain kinds of non-POD types. (Such as a simple
2831 @samp{struct} that fails to be a POD type only by virtue of having a
2832 constructor.)  This flag is for users who are aware that they are
2833 writing nonportable code and who have deliberately chosen to ignore the
2834 warning about it.
2835
2836 The restrictions on @samp{offsetof} may be relaxed in a future version
2837 of the C++ standard.
2838
2839 @item -Winvalid-pch
2840 @opindex Winvalid-pch
2841 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2842 the search path but can't be used.
2843
2844 @item -Wlong-long
2845 @opindex Wlong-long
2846 @opindex Wno-long-long
2847 Warn if @samp{long long} type is used.  This is default.  To inhibit
2848 the warning messages, use @option{-Wno-long-long}.  Flags
2849 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2850 only when @option{-pedantic} flag is used.
2851
2852 @item -Wdisabled-optimization
2853 @opindex Wdisabled-optimization
2854 Warn if a requested optimization pass is disabled.  This warning does
2855 not generally indicate that there is anything wrong with your code; it
2856 merely indicates that GCC's optimizers were unable to handle the code
2857 effectively.  Often, the problem is that your code is too big or too
2858 complex; GCC will refuse to optimize programs when the optimization
2859 itself is likely to take inordinate amounts of time.
2860
2861 @item -Werror
2862 @opindex Werror
2863 Make all warnings into errors.
2864 @end table
2865
2866 @node Debugging Options
2867 @section Options for Debugging Your Program or GCC
2868 @cindex options, debugging
2869 @cindex debugging information options
2870
2871 GCC has various special options that are used for debugging
2872 either your program or GCC:
2873
2874 @table @gcctabopt
2875 @item -g
2876 @opindex g
2877 Produce debugging information in the operating system's native format
2878 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2879 information.
2880
2881 On most systems that use stabs format, @option{-g} enables use of extra
2882 debugging information that only GDB can use; this extra information
2883 makes debugging work better in GDB but will probably make other debuggers
2884 crash or
2885 refuse to read the program.  If you want to control for certain whether
2886 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2887 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2888 or @option{-gvms} (see below).
2889
2890 Unlike most other C compilers, GCC allows you to use @option{-g} with
2891 @option{-O}.  The shortcuts taken by optimized code may occasionally
2892 produce surprising results: some variables you declared may not exist
2893 at all; flow of control may briefly move where you did not expect it;
2894 some statements may not be executed because they compute constant
2895 results or their values were already at hand; some statements may
2896 execute in different places because they were moved out of loops.
2897
2898 Nevertheless it proves possible to debug optimized output.  This makes
2899 it reasonable to use the optimizer for programs that might have bugs.
2900
2901 The following options are useful when GCC is generated with the
2902 capability for more than one debugging format.
2903
2904 @item -ggdb
2905 @opindex ggdb
2906 Produce debugging information for use by GDB@.  This means to use the
2907 most expressive format available (DWARF 2, stabs, or the native format
2908 if neither of those are supported), including GDB extensions if at all
2909 possible.
2910
2911 @item -gstabs
2912 @opindex gstabs
2913 Produce debugging information in stabs format (if that is supported),
2914 without GDB extensions.  This is the format used by DBX on most BSD
2915 systems.  On MIPS, Alpha and System V Release 4 systems this option
2916 produces stabs debugging output which is not understood by DBX or SDB@.
2917 On System V Release 4 systems this option requires the GNU assembler.
2918
2919 @item -gstabs+
2920 @opindex gstabs+
2921 Produce debugging information in stabs format (if that is supported),
2922 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2923 use of these extensions is likely to make other debuggers crash or
2924 refuse to read the program.
2925
2926 @item -gcoff
2927 @opindex gcoff
2928 Produce debugging information in COFF format (if that is supported).
2929 This is the format used by SDB on most System V systems prior to
2930 System V Release 4.
2931
2932 @item -gxcoff
2933 @opindex gxcoff
2934 Produce debugging information in XCOFF format (if that is supported).
2935 This is the format used by the DBX debugger on IBM RS/6000 systems.
2936
2937 @item -gxcoff+
2938 @opindex gxcoff+
2939 Produce debugging information in XCOFF format (if that is supported),
2940 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2941 use of these extensions is likely to make other debuggers crash or
2942 refuse to read the program, and may cause assemblers other than the GNU
2943 assembler (GAS) to fail with an error.
2944
2945 @item -gdwarf
2946 @opindex gdwarf
2947 Produce debugging information in DWARF version 1 format (if that is
2948 supported).  This is the format used by SDB on most System V Release 4
2949 systems.
2950
2951 This option is deprecated.
2952
2953 @item -gdwarf+
2954 @opindex gdwarf+
2955 Produce debugging information in DWARF version 1 format (if that is
2956 supported), using GNU extensions understood only by the GNU debugger
2957 (GDB)@.  The use of these extensions is likely to make other debuggers
2958 crash or refuse to read the program.
2959
2960 This option is deprecated.
2961
2962 @item -gdwarf-2
2963 @opindex gdwarf-2
2964 Produce debugging information in DWARF version 2 format (if that is
2965 supported).  This is the format used by DBX on IRIX 6.
2966
2967 @item -gvms
2968 @opindex gvms
2969 Produce debugging information in VMS debug format (if that is
2970 supported).  This is the format used by DEBUG on VMS systems.
2971
2972 @item -g@var{level}
2973 @itemx -ggdb@var{level}
2974 @itemx -gstabs@var{level}
2975 @itemx -gcoff@var{level}
2976 @itemx -gxcoff@var{level}
2977 @itemx -gvms@var{level}
2978 Request debugging information and also use @var{level} to specify how
2979 much information.  The default level is 2.
2980
2981 Level 1 produces minimal information, enough for making backtraces in
2982 parts of the program that you don't plan to debug.  This includes
2983 descriptions of functions and external variables, but no information
2984 about local variables and no line numbers.
2985
2986 Level 3 includes extra information, such as all the macro definitions
2987 present in the program.  Some debuggers support macro expansion when
2988 you use @option{-g3}.
2989
2990 Note that in order to avoid confusion between DWARF1 debug level 2,
2991 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2992 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2993 option to change the debug level for DWARF1 or DWARF2.
2994
2995 @item -feliminate-dwarf2-dups
2996 @opindex feliminate-dwarf2-dups
2997 Compress DWARF2 debugging information by eliminating duplicated
2998 information about each symbol.  This option only makes sense when
2999 generating DWARF2 debugging information with @option{-gdwarf-2}.
3000
3001 @cindex @command{prof}
3002 @item -p
3003 @opindex p
3004 Generate extra code to write profile information suitable for the
3005 analysis program @command{prof}.  You must use this option when compiling
3006 the source files you want data about, and you must also use it when
3007 linking.
3008
3009 @cindex @command{gprof}
3010 @item -pg
3011 @opindex pg
3012 Generate extra code to write profile information suitable for the
3013 analysis program @command{gprof}.  You must use this option when compiling
3014 the source files you want data about, and you must also use it when
3015 linking.
3016
3017 @item -Q
3018 @opindex Q
3019 Makes the compiler print out each function name as it is compiled, and
3020 print some statistics about each pass when it finishes.
3021
3022 @item -ftime-report
3023 @opindex ftime-report
3024 Makes the compiler print some statistics about the time consumed by each
3025 pass when it finishes.
3026
3027 @item -fmem-report
3028 @opindex fmem-report
3029 Makes the compiler print some statistics about permanent memory
3030 allocation when it finishes.
3031
3032 @item -fprofile-arcs
3033 @opindex fprofile-arcs
3034 Add code so that program flow @dfn{arcs} are instrumented.  During
3035 execution the program records how many times each branch and call is
3036 executed and how many times it is taken or returns.  When the compiled
3037 program exits it saves this data to a file called
3038 @file{@var{auxname}.da} for each source file. The data may be used for
3039 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3040 test coverage analysis (@option{-ftest-coverage}). Each object file's
3041 @var{auxname} is generated from the name of the output file, if
3042 explicitly specified and it is not the final executable, otherwise it is
3043 the basename of the source file. In both cases any suffix is removed
3044 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3045 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3046
3047 @itemize
3048
3049 @item
3050 Compile the source files with @option{-fprofile-arcs} plus optimization
3051 and code generation options. For test coverage analysis, use the
3052 additional @option{-ftest-coverage} option. You do not need to profile
3053 every source file in a program.
3054
3055 @item
3056 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3057 (the latter implies the former).
3058
3059 @item
3060 Run the program on a representative workload to generate the arc profile
3061 information. This may be repeated any number of times. You can run
3062 concurrent instances of your program, and provided that the file system
3063 supports locking, the data files will be correctly updated. Also
3064 @code{fork} calls are detected and correctly handled (double counting
3065 will not happen).
3066
3067 @item
3068 For profile-directed optimizations, compile the source files again with
3069 the same optimization and code generation options plus
3070 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3071 Control Optimization}).
3072
3073 @item
3074 For test coverage analysis, use @command{gcov} to produce human readable
3075 information from the @file{.bbg} and @file{.da} files. Refer to the
3076 @command{gcov} documentation for further information.
3077
3078 @end itemize
3079
3080 With @option{-fprofile-arcs}, for each function of your program GCC
3081 creates a program flow graph, then finds a spanning tree for the graph.
3082 Only arcs that are not on the spanning tree have to be instrumented: the
3083 compiler adds code to count the number of times that these arcs are
3084 executed.  When an arc is the only exit or only entrance to a block, the
3085 instrumentation code can be added to the block; otherwise, a new basic
3086 block must be created to hold the instrumentation code.
3087
3088 @need 2000
3089 @item -ftest-coverage
3090 @opindex ftest-coverage
3091 Produce a graph file that the @command{gcov} code-coverage utility
3092 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3093 show program coverage. Each source file's data file is called
3094 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3095 above for a description of @var{auxname} and instructions on how to
3096 generate test coverage data. Coverage data will match the source files
3097 more closely, if you do not optimize.
3098
3099 @item -d@var{letters}
3100 @opindex d
3101 Says to make debugging dumps during compilation at times specified by
3102 @var{letters}.  This is used for debugging the compiler.  The file names
3103 for most of the dumps are made by appending a pass number and a word to
3104 the @var{dumpname}. @var{dumpname} is generated from the name of the
3105 output file, if explicitly specified and it is not an executable,
3106 otherwise it is the basename of the source file. In both cases any
3107 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3108 Here are the possible letters for use in @var{letters}, and their
3109 meanings:
3110
3111 @table @samp
3112 @item A
3113 @opindex dA
3114 Annotate the assembler output with miscellaneous debugging information.
3115 @item b
3116 @opindex db
3117 Dump after computing branch probabilities, to @file{@var{file}.15.bp}.
3118 @item B
3119 @opindex dB
3120 Dump after block reordering, to @file{@var{file}.31.bbro}.
3121 @item c
3122 @opindex dc
3123 Dump after instruction combination, to the file @file{@var{file}.21.combine}.
3124 @item C
3125 @opindex dC
3126 Dump after the first if conversion, to the file @file{@var{file}.16.ce1}.
3127 Also dump after the second if conversion, to the file @file{@var{file}.22.ce2}.
3128 @item d
3129 @opindex dd
3130 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3131 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3132 @item D
3133 @opindex dD
3134 Dump all macro definitions, at the end of preprocessing, in addition to
3135 normal output.
3136 @item e
3137 @opindex de
3138 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3139 @file{@var{file}.07.ussa}.
3140 @item E
3141 @opindex dE
3142 Dump after the second if conversion, to @file{@var{file}.32.ce3}.
3143 @item f
3144 @opindex df
3145 Dump after control and data flow analysis, to @file{@var{file}.14.cfg}.
3146 Also dump after life analysis, to @file{@var{file}.20.life}.
3147 @item F
3148 @opindex dF
3149 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3150 @item g
3151 @opindex dg
3152 Dump after global register allocation, to @file{@var{file}.26.greg}.
3153 @item G
3154 @opindex dG
3155 Dump after GCSE, to @file{@var{file}.11.gcse}.
3156 Also dump after jump bypassing and control flow optimizations, to
3157 @file{@var{file}.13.bypass}.
3158 @item h
3159 @opindex dh
3160 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3161 @item i
3162 @opindex di
3163 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3164 @item j
3165 @opindex dj
3166 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3167 @item k
3168 @opindex dk
3169 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3170 @item l
3171 @opindex dl
3172 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3173 @item L
3174 @opindex dL
3175 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3176 @file{@var{file}.18.loop2}.
3177 @item M
3178 @opindex dM
3179 Dump after performing the machine dependent reorganization pass, to
3180 @file{@var{file}.36.mach}.
3181 @item n
3182 @opindex dn
3183 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3184 @item N
3185 @opindex dN
3186 Dump after the register move pass, to @file{@var{file}.23.regmove}.
3187 @item o
3188 @opindex do
3189 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3190 @item r
3191 @opindex dr
3192 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3193 @item R
3194 @opindex dR
3195 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3196 @item s
3197 @opindex ds
3198 Dump after CSE (including the jump optimization that sometimes follows
3199 CSE), to @file{@var{file}.09.cse}.
3200 @item S
3201 @opindex dS
3202 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3203 @item t
3204 @opindex dt
3205 Dump after the second CSE pass (including the jump optimization that
3206 sometimes follows CSE), to @file{@var{file}.19.cse2}.
3207 @item T
3208 @opindex dT
3209 Dump after running tracer, to @file{@var{file}.17.tracer}.
3210 @item u
3211 @opindex du
3212 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3213 @item w
3214 @opindex dw
3215 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3216 @item W
3217 @opindex dW
3218 Dump after SSA conditional constant propagation, to
3219 @file{@var{file}.05.ssaccp}.
3220 @item X
3221 @opindex dX
3222 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3223 @item z
3224 @opindex dz
3225 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3226 @item a
3227 @opindex da
3228 Produce all the dumps listed above.
3229 @item H
3230 @opindex dH
3231 Produce a core dump whenever an error occurs.
3232 @item m
3233 @opindex dm
3234 Print statistics on memory usage, at the end of the run, to
3235 standard error.
3236 @item p
3237 @opindex dp
3238 Annotate the assembler output with a comment indicating which
3239 pattern and alternative was used.  The length of each instruction is
3240 also printed.
3241 @item P
3242 @opindex dP
3243 Dump the RTL in the assembler output as a comment before each instruction.
3244 Also turns on @option{-dp} annotation.
3245 @item v
3246 @opindex dv
3247 For each of the other indicated dump files (except for
3248 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3249 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3250 @item x
3251 @opindex dx
3252 Just generate RTL for a function instead of compiling it.  Usually used
3253 with @samp{r}.
3254 @item y
3255 @opindex dy
3256 Dump debugging information during parsing, to standard error.
3257 @end table
3258
3259 @item -fdump-unnumbered
3260 @opindex fdump-unnumbered
3261 When doing debugging dumps (see @option{-d} option above), suppress instruction
3262 numbers and line number note output.  This makes it more feasible to
3263 use diff on debugging dumps for compiler invocations with different
3264 options, in particular with and without @option{-g}.
3265
3266 @item -fdump-translation-unit @r{(C and C++ only)}
3267 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3268 @opindex fdump-translation-unit
3269 Dump a representation of the tree structure for the entire translation
3270 unit to a file.  The file name is made by appending @file{.tu} to the
3271 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3272 controls the details of the dump as described for the
3273 @option{-fdump-tree} options.
3274
3275 @item -fdump-class-hierarchy @r{(C++ only)}
3276 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3277 @opindex fdump-class-hierarchy
3278 Dump a representation of each class's hierarchy and virtual function
3279 table layout to a file.  The file name is made by appending @file{.class}
3280 to the source file name.  If the @samp{-@var{options}} form is used,
3281 @var{options} controls the details of the dump as described for the
3282 @option{-fdump-tree} options.
3283
3284 @item -fdump-tree-@var{switch} @r{(C++ only)}
3285 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3286 @opindex fdump-tree
3287 Control the dumping at various stages of processing the intermediate
3288 language tree to a file.  The file name is generated by appending a switch
3289 specific suffix to the source file name.  If the @samp{-@var{options}}
3290 form is used, @var{options} is a list of @samp{-} separated options that
3291 control the details of the dump. Not all options are applicable to all
3292 dumps, those which are not meaningful will be ignored. The following
3293 options are available
3294
3295 @table @samp
3296 @item address
3297 Print the address of each node.  Usually this is not meaningful as it
3298 changes according to the environment and source file. Its primary use
3299 is for tying up a dump file with a debug environment.
3300 @item slim
3301 Inhibit dumping of members of a scope or body of a function merely
3302 because that scope has been reached. Only dump such items when they
3303 are directly reachable by some other path.
3304 @item all
3305 Turn on all options.
3306 @end table
3307
3308 The following tree dumps are possible:
3309 @table @samp
3310 @item original
3311 Dump before any tree based optimization, to @file{@var{file}.original}.
3312 @item optimized
3313 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3314 @item inlined
3315 Dump after function inlining, to @file{@var{file}.inlined}.
3316 @end table
3317
3318 @item -frandom-seed=@var{string}
3319 @opindex frandom-string
3320 This option provides a seed that GCC uses when it would otherwise use
3321 random numbers.  At present, this is used to generate certain symbol names
3322 that have to be different in every compiled file.
3323
3324 The @var{string} should be different for every file you compile.
3325
3326 @item -fsched-verbose=@var{n}
3327 @opindex fsched-verbose
3328 On targets that use instruction scheduling, this option controls the
3329 amount of debugging output the scheduler prints.  This information is
3330 written to standard error, unless @option{-dS} or @option{-dR} is
3331 specified, in which case it is output to the usual dump
3332 listing file, @file{.sched} or @file{.sched2} respectively.  However
3333 for @var{n} greater than nine, the output is always printed to standard
3334 error.
3335
3336 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3337 same information as @option{-dRS}.  For @var{n} greater than one, it
3338 also output basic block probabilities, detailed ready list information
3339 and unit/insn info.  For @var{n} greater than two, it includes RTL
3340 at abort point, control-flow and regions info.  And for @var{n} over
3341 four, @option{-fsched-verbose} also includes dependence info.
3342
3343 @item -save-temps
3344 @opindex save-temps
3345 Store the usual ``temporary'' intermediate files permanently; place them
3346 in the current directory and name them based on the source file.  Thus,
3347 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3348 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3349 preprocessed @file{foo.i} output file even though the compiler now
3350 normally uses an integrated preprocessor.
3351
3352 @item -time
3353 @opindex time
3354 Report the CPU time taken by each subprocess in the compilation
3355 sequence.  For C source files, this is the compiler proper and assembler
3356 (plus the linker if linking is done).  The output looks like this:
3357
3358 @smallexample
3359 # cc1 0.12 0.01
3360 # as 0.00 0.01
3361 @end smallexample
3362
3363 The first number on each line is the ``user time,'' that is time spent
3364 executing the program itself.  The second number is ``system time,''
3365 time spent executing operating system routines on behalf of the program.
3366 Both numbers are in seconds.
3367
3368 @item -print-file-name=@var{library}
3369 @opindex print-file-name
3370 Print the full absolute name of the library file @var{library} that
3371 would be used when linking---and don't do anything else.  With this
3372 option, GCC does not compile or link anything; it just prints the
3373 file name.
3374
3375 @item -print-multi-directory
3376 @opindex print-multi-directory
3377 Print the directory name corresponding to the multilib selected by any
3378 other switches present in the command line.  This directory is supposed
3379 to exist in @env{GCC_EXEC_PREFIX}.
3380
3381 @item -print-multi-lib
3382 @opindex print-multi-lib
3383 Print the mapping from multilib directory names to compiler switches
3384 that enable them.  The directory name is separated from the switches by
3385 @samp{;}, and each switch starts with an @samp{@@} instead of the
3386 @samp{-}, without spaces between multiple switches.  This is supposed to
3387 ease shell-processing.
3388
3389 @item -print-prog-name=@var{program}
3390 @opindex print-prog-name
3391 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3392
3393 @item -print-libgcc-file-name
3394 @opindex print-libgcc-file-name
3395 Same as @option{-print-file-name=libgcc.a}.
3396
3397 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3398 but you do want to link with @file{libgcc.a}.  You can do
3399
3400 @example
3401 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3402 @end example
3403
3404 @item -print-search-dirs
3405 @opindex print-search-dirs
3406 Print the name of the configured installation directory and a list of
3407 program and library directories gcc will search---and don't do anything else.
3408
3409 This is useful when gcc prints the error message
3410 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3411 To resolve this you either need to put @file{cpp0} and the other compiler
3412 components where gcc expects to find them, or you can set the environment
3413 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3414 Don't forget the trailing '/'.
3415 @xref{Environment Variables}.
3416
3417 @item -dumpmachine
3418 @opindex dumpmachine
3419 Print the compiler's target machine (for example,
3420 @samp{i686-pc-linux-gnu})---and don't do anything else.
3421
3422 @item -dumpversion
3423 @opindex dumpversion
3424 Print the compiler version (for example, @samp{3.0})---and don't do
3425 anything else.
3426
3427 @item -dumpspecs
3428 @opindex dumpspecs
3429 Print the compiler's built-in specs---and don't do anything else.  (This
3430 is used when GCC itself is being built.)  @xref{Spec Files}.
3431
3432 @item -feliminate-unused-debug-types
3433 @opindex feliminate-unused-debug-types
3434 Normally, when producing DWARF2 output, GCC will emit debugging
3435 information for all types declared in a compilation
3436 unit, regardless of whether or not they are actually used
3437 in that compilation unit.  Sometimes this is useful, such as
3438 if, in the debugger, you want to cast a value to a type that is
3439 not actually used in your program (but is declared).  More often,
3440 however, this results in a significant amount of wasted space.
3441 With this option, GCC will avoid producing debug symbol output
3442 for types that are nowhere used in the source file being compiled.
3443 @end table
3444
3445 @node Optimize Options
3446 @section Options That Control Optimization
3447 @cindex optimize options
3448 @cindex options, optimization
3449
3450 These options control various sorts of optimizations.
3451
3452 Without any optimization option, the compiler's goal is to reduce the
3453 cost of compilation and to make debugging produce the expected
3454 results.  Statements are independent: if you stop the program with a
3455 breakpoint between statements, you can then assign a new value to any
3456 variable or change the program counter to any other statement in the
3457 function and get exactly the results you would expect from the source
3458 code.
3459
3460 Turning on optimization flags makes the compiler attempt to improve
3461 the performance and/or code size at the expense of compilation time
3462 and possibly the ability to debug the program.
3463
3464 Not all optimizations are controlled directly by a flag.  Only
3465 optimizations that have a flag are listed.
3466
3467 @table @gcctabopt
3468 @item -O
3469 @itemx -O1
3470 @opindex O
3471 @opindex O1
3472 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3473 more memory for a large function.
3474
3475 With @option{-O}, the compiler tries to reduce code size and execution
3476 time, without performing any optimizations that take a great deal of
3477 compilation time.
3478
3479 @option{-O} turns on the following optimization flags: 
3480 @gccoptlist{-fdefer-pop @gol
3481 -fmerge-constants @gol
3482 -fthread-jumps @gol
3483 -floop-optimize @gol
3484 -fcrossjumping @gol
3485 -fif-conversion @gol
3486 -fif-conversion2 @gol
3487 -fdelayed-branch @gol
3488 -fguess-branch-probability @gol
3489 -fcprop-registers}
3490
3491 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3492 where doing so does not interfere with debugging.
3493
3494 @item -O2
3495 @opindex O2
3496 Optimize even more.  GCC performs nearly all supported optimizations
3497 that do not involve a space-speed tradeoff.  The compiler does not
3498 perform loop unrolling or function inlining when you specify @option{-O2}.
3499 As compared to @option{-O}, this option increases both compilation time
3500 and the performance of the generated code.
3501
3502 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3503 also turns on the following optimization flags:
3504 @gccoptlist{-fforce-mem @gol
3505 -foptimize-sibling-calls @gol
3506 -fstrength-reduce @gol
3507 -fcse-follow-jumps  -fcse-skip-blocks @gol
3508 -frerun-cse-after-loop  -frerun-loop-opt @gol
3509 -fgcse   -fgcse-lm   -fgcse-sm @gol
3510 -fdelete-null-pointer-checks @gol
3511 -fexpensive-optimizations @gol
3512 -fregmove @gol
3513 -fschedule-insns  -fschedule-insns2 @gol
3514 -fsched-interblock  -fsched-spec @gol
3515 -fcaller-saves @gol
3516 -fpeephole2 @gol
3517 -freorder-blocks  -freorder-functions @gol
3518 -fstrict-aliasing @gol
3519 -falign-functions  -falign-jumps @gol
3520 -falign-loops  -falign-labels}
3521
3522 Please note the warning under @option{-fgcse} about
3523 invoking @option{-O2} on programs that use computed gotos.
3524
3525 @item -O3
3526 @opindex O3
3527 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3528 @option{-O2} and also turns on the @option{-finline-functions},
3529 @option{-funit-at-a-time} and @option{-frename-registers} options.
3530
3531 @item -O0
3532 @opindex O0
3533 Do not optimize.  This is the default.
3534
3535 @item -Os
3536 @opindex Os
3537 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3538 do not typically increase code size.  It also performs further
3539 optimizations designed to reduce code size.
3540
3541 @option{-Os} disables the following optimization flags:
3542 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3543 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3544
3545 If you use multiple @option{-O} options, with or without level numbers,
3546 the last such option is the one that is effective.
3547 @end table
3548
3549 Options of the form @option{-f@var{flag}} specify machine-independent
3550 flags.  Most flags have both positive and negative forms; the negative
3551 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3552 below, only one of the forms is listed---the one you typically will
3553 use.  You can figure out the other form by either removing @samp{no-}
3554 or adding it.
3555
3556 The following options control specific optimizations.  They are either
3557 activated by @option{-O} options or are related to ones that are.  You
3558 can use the following flags in the rare cases when ``fine-tuning'' of
3559 optimizations to be performed is desired.
3560
3561 @table @gcctabopt
3562 @item -fno-default-inline
3563 @opindex fno-default-inline
3564 Do not make member functions inline by default merely because they are
3565 defined inside the class scope (C++ only).  Otherwise, when you specify
3566 @w{@option{-O}}, member functions defined inside class scope are compiled
3567 inline by default; i.e., you don't need to add @samp{inline} in front of
3568 the member function name.
3569
3570 @item -fno-defer-pop
3571 @opindex fno-defer-pop
3572 Always pop the arguments to each function call as soon as that function
3573 returns.  For machines which must pop arguments after a function call,
3574 the compiler normally lets arguments accumulate on the stack for several
3575 function calls and pops them all at once.
3576
3577 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3578
3579 @item -fforce-mem
3580 @opindex fforce-mem
3581 Force memory operands to be copied into registers before doing
3582 arithmetic on them.  This produces better code by making all memory
3583 references potential common subexpressions.  When they are not common
3584 subexpressions, instruction combination should eliminate the separate
3585 register-load.
3586
3587 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3588
3589 @item -fforce-addr
3590 @opindex fforce-addr
3591 Force memory address constants to be copied into registers before
3592 doing arithmetic on them.  This may produce better code just as
3593 @option{-fforce-mem} may.
3594
3595 @item -fomit-frame-pointer
3596 @opindex fomit-frame-pointer
3597 Don't keep the frame pointer in a register for functions that
3598 don't need one.  This avoids the instructions to save, set up and
3599 restore frame pointers; it also makes an extra register available
3600 in many functions.  @strong{It also makes debugging impossible on
3601 some machines.}
3602
3603 On some machines, such as the VAX, this flag has no effect, because
3604 the standard calling sequence automatically handles the frame pointer
3605 and nothing is saved by pretending it doesn't exist.  The
3606 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3607 whether a target machine supports this flag.  @xref{Registers,,Register
3608 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3609
3610 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3611
3612 @item -foptimize-sibling-calls
3613 @opindex foptimize-sibling-calls
3614 Optimize sibling and tail recursive calls.
3615
3616 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3617
3618 @item -fno-inline
3619 @opindex fno-inline
3620 Don't pay attention to the @code{inline} keyword.  Normally this option
3621 is used to keep the compiler from expanding any functions inline.
3622 Note that if you are not optimizing, no functions can be expanded inline.
3623
3624 @item -finline-functions
3625 @opindex finline-functions
3626 Integrate all simple functions into their callers.  The compiler
3627 heuristically decides which functions are simple enough to be worth
3628 integrating in this way.
3629
3630 If all calls to a given function are integrated, and the function is
3631 declared @code{static}, then the function is normally not output as
3632 assembler code in its own right.
3633
3634 Enabled at level @option{-O3}.
3635
3636 @item -finline-limit=@var{n}
3637 @opindex finline-limit
3638 By default, gcc limits the size of functions that can be inlined.  This flag
3639 allows the control of this limit for functions that are explicitly marked as
3640 inline (i.e., marked with the inline keyword or defined within the class
3641 definition in c++).  @var{n} is the size of functions that can be inlined in
3642 number of pseudo instructions (not counting parameter handling).  The default
3643 value of @var{n} is 600.
3644 Increasing this value can result in more inlined code at
3645 the cost of compilation time and memory consumption.  Decreasing usually makes
3646 the compilation faster and less code will be inlined (which presumably
3647 means slower programs).  This option is particularly useful for programs that
3648 use inlining heavily such as those based on recursive templates with C++.
3649
3650 Inlining is actually controlled by a number of parameters, which may be
3651 specified individually by using @option{--param @var{name}=@var{value}}.
3652 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3653 as follows:
3654
3655 @table @gcctabopt
3656  @item max-inline-insns
3657   is set to @var{n}.
3658  @item max-inline-insns-single
3659   is set to @var{n}/2.
3660  @item max-inline-insns-auto
3661   is set to @var{n}/2.
3662  @item min-inline-insns
3663   is set to 130 or @var{n}/4, whichever is smaller.
3664  @item max-inline-insns-rtl
3665   is set to @var{n}.
3666 @end table
3667
3668 Using @option{-finline-limit=600} thus results in the default settings
3669 for these parameters.  See below for a documentation of the individual
3670 parameters controlling inlining.
3671
3672 @emph{Note:} pseudo instruction represents, in this particular context, an
3673 abstract measurement of function's size.  In no way, it represents a count
3674 of assembly instructions and as such its exact meaning might change from one
3675 release to an another.
3676
3677 @item -fkeep-inline-functions
3678 @opindex fkeep-inline-functions
3679 Even if all calls to a given function are integrated, and the function
3680 is declared @code{static}, nevertheless output a separate run-time
3681 callable version of the function.  This switch does not affect
3682 @code{extern inline} functions.
3683
3684 @item -fkeep-static-consts
3685 @opindex fkeep-static-consts
3686 Emit variables declared @code{static const} when optimization isn't turned
3687 on, even if the variables aren't referenced.
3688
3689 GCC enables this option by default.  If you want to force the compiler to
3690 check if the variable was referenced, regardless of whether or not
3691 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3692
3693 @item -fmerge-constants
3694 Attempt to merge identical constants (string constants and floating point
3695 constants) across compilation units.
3696
3697 This option is the default for optimized compilation if the assembler and
3698 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3699 behavior.
3700
3701 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3702
3703 @item -fmerge-all-constants
3704 Attempt to merge identical constants and identical variables.
3705
3706 This option implies @option{-fmerge-constants}.  In addition to
3707 @option{-fmerge-constants} this considers e.g. even constant initialized
3708 arrays or initialized constant variables with integral or floating point
3709 types.  Languages like C or C++ require each non-automatic variable to
3710 have distinct location, so using this option will result in non-conforming
3711 behavior.
3712
3713 @item -fnew-ra
3714 @opindex fnew-ra
3715 Use a graph coloring register allocator.  Currently this option is meant
3716 for testing, so we are interested to hear about miscompilations with
3717 @option{-fnew-ra}.
3718
3719 @item -fno-branch-count-reg
3720 @opindex fno-branch-count-reg
3721 Do not use ``decrement and branch'' instructions on a count register,
3722 but instead generate a sequence of instructions that decrement a
3723 register, compare it against zero, then branch based upon the result.
3724 This option is only meaningful on architectures that support such
3725 instructions, which include x86, PowerPC, IA-64 and S/390.
3726
3727 The default is @option{-fbranch-count-reg}, enabled when
3728 @option{-fstrength-reduce} is enabled.
3729
3730 @item -fno-function-cse
3731 @opindex fno-function-cse
3732 Do not put function addresses in registers; make each instruction that
3733 calls a constant function contain the function's address explicitly.
3734
3735 This option results in less efficient code, but some strange hacks
3736 that alter the assembler output may be confused by the optimizations
3737 performed when this option is not used.
3738
3739 The default is @option{-ffunction-cse}
3740
3741 @item -fno-zero-initialized-in-bss
3742 @opindex fno-zero-initialized-in-bss
3743 If the target supports a BSS section, GCC by default puts variables that
3744 are initialized to zero into BSS@.  This can save space in the resulting
3745 code.
3746
3747 This option turns off this behavior because some programs explicitly
3748 rely on variables going to the data section.  E.g., so that the
3749 resulting executable can find the beginning of that section and/or make
3750 assumptions based on that.
3751
3752 The default is @option{-fzero-initialized-in-bss}.
3753
3754 @item -fstrength-reduce
3755 @opindex fstrength-reduce
3756 Perform the optimizations of loop strength reduction and
3757 elimination of iteration variables.
3758
3759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3760
3761 @item -fthread-jumps
3762 @opindex fthread-jumps
3763 Perform optimizations where we check to see if a jump branches to a
3764 location where another comparison subsumed by the first is found.  If
3765 so, the first branch is redirected to either the destination of the
3766 second branch or a point immediately following it, depending on whether
3767 the condition is known to be true or false.
3768
3769 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3770
3771 @item -fcse-follow-jumps
3772 @opindex fcse-follow-jumps
3773 In common subexpression elimination, scan through jump instructions
3774 when the target of the jump is not reached by any other path.  For
3775 example, when CSE encounters an @code{if} statement with an
3776 @code{else} clause, CSE will follow the jump when the condition
3777 tested is false.
3778
3779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3780
3781 @item -fcse-skip-blocks
3782 @opindex fcse-skip-blocks
3783 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3784 follow jumps which conditionally skip over blocks.  When CSE
3785 encounters a simple @code{if} statement with no else clause,
3786 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3787 body of the @code{if}.
3788
3789 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3790
3791 @item -frerun-cse-after-loop
3792 @opindex frerun-cse-after-loop
3793 Re-run common subexpression elimination after loop optimizations has been
3794 performed.
3795
3796 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3797
3798 @item -frerun-loop-opt
3799 @opindex frerun-loop-opt
3800 Run the loop optimizer twice.
3801
3802 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3803
3804 @item -fgcse
3805 @opindex fgcse
3806 Perform a global common subexpression elimination pass.
3807 This pass also performs global constant and copy propagation.
3808
3809 @emph{Note:} When compiling a program using computed gotos, a GCC
3810 extension, you may get better runtime performance if you disable
3811 the global common subexpression elimination pass by adding
3812 @option{-fno-gcse} to the command line.
3813
3814 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3815
3816 @item -fgcse-lm
3817 @opindex fgcse-lm
3818 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3819 attempt to move loads which are only killed by stores into themselves.  This
3820 allows a loop containing a load/store sequence to be changed to a load outside
3821 the loop, and a copy/store within the loop.
3822
3823 Enabled by default when gcse is enabled.
3824
3825 @item -fgcse-sm
3826 @opindex fgcse-sm
3827 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3828 subexpression elimination.  This pass will attempt to move stores out of loops.
3829 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3830 can be changed to a load before the loop and a store after the loop.
3831
3832 Enabled by default when gcse is enabled.
3833
3834 @item -floop-optimize
3835 @opindex floop-optimize
3836 Perform loop optimizations: move constant expressions out of loops, simplify
3837 exit test conditions and optionally do strength-reduction and loop unrolling as
3838 well.
3839
3840 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3841
3842 @item -fcrossjumping
3843 @opindex crossjumping
3844 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3845 resulting code may or may not perform better than without cross-jumping.
3846
3847 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3848
3849 @item -fif-conversion
3850 @opindex if-conversion
3851 Attempt to transform conditional jumps into branch-less equivalents.  This
3852 include use of conditional moves, min, max, set flags and abs instructions, and
3853 some tricks doable by standard arithmetics.  The use of conditional execution
3854 on chips where it is available is controlled by @code{if-conversion2}.
3855
3856 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3857
3858 @item -fif-conversion2
3859 @opindex if-conversion2
3860 Use conditional execution (where available) to transform conditional jumps into
3861 branch-less equivalents.
3862
3863 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3864
3865 @item -fdelete-null-pointer-checks
3866 @opindex fdelete-null-pointer-checks
3867 Use global dataflow analysis to identify and eliminate useless checks
3868 for null pointers.  The compiler assumes that dereferencing a null
3869 pointer would have halted the program.  If a pointer is checked after
3870 it has already been dereferenced, it cannot be null.
3871
3872 In some environments, this assumption is not true, and programs can
3873 safely dereference null pointers.  Use
3874 @option{-fno-delete-null-pointer-checks} to disable this optimization
3875 for programs which depend on that behavior.
3876
3877 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3878
3879 @item -fexpensive-optimizations
3880 @opindex fexpensive-optimizations
3881 Perform a number of minor optimizations that are relatively expensive.
3882
3883 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3884
3885 @item -foptimize-register-move
3886 @itemx -fregmove
3887 @opindex foptimize-register-move
3888 @opindex fregmove
3889 Attempt to reassign register numbers in move instructions and as
3890 operands of other simple instructions in order to maximize the amount of
3891 register tying.  This is especially helpful on machines with two-operand
3892 instructions.
3893
3894 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3895 optimization.
3896
3897 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3898
3899 @item -fdelayed-branch
3900 @opindex fdelayed-branch
3901 If supported for the target machine, attempt to reorder instructions
3902 to exploit instruction slots available after delayed branch
3903 instructions.
3904
3905 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3906
3907 @item -fschedule-insns
3908 @opindex fschedule-insns
3909 If supported for the target machine, attempt to reorder instructions to
3910 eliminate execution stalls due to required data being unavailable.  This
3911 helps machines that have slow floating point or memory load instructions
3912 by allowing other instructions to be issued until the result of the load
3913 or floating point instruction is required.
3914
3915 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3916
3917 @item -fschedule-insns2
3918 @opindex fschedule-insns2
3919 Similar to @option{-fschedule-insns}, but requests an additional pass of
3920 instruction scheduling after register allocation has been done.  This is
3921 especially useful on machines with a relatively small number of
3922 registers and where memory load instructions take more than one cycle.
3923
3924 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3925
3926 @item -fno-sched-interblock
3927 @opindex fno-sched-interblock
3928 Don't schedule instructions across basic blocks.  This is normally
3929 enabled by default when scheduling before register allocation, i.e.@:
3930 with @option{-fschedule-insns} or at @option{-O2} or higher.
3931
3932 @item -fno-sched-spec
3933 @opindex fno-sched-spec
3934 Don't allow speculative motion of non-load instructions.  This is normally
3935 enabled by default when scheduling before register allocation, i.e.@:
3936 with @option{-fschedule-insns} or at @option{-O2} or higher.
3937
3938 @item -fsched-spec-load
3939 @opindex fsched-spec-load
3940 Allow speculative motion of some load instructions.  This only makes
3941 sense when scheduling before register allocation, i.e.@: with
3942 @option{-fschedule-insns} or at @option{-O2} or higher.
3943
3944 @item -fsched-spec-load-dangerous
3945 @opindex fsched-spec-load-dangerous
3946 Allow speculative motion of more load instructions.  This only makes
3947 sense when scheduling before register allocation, i.e.@: with
3948 @option{-fschedule-insns} or at @option{-O2} or higher.
3949
3950 @item -fsched2-use-superblocks
3951 @opindex fsched2-use-superblocks
3952 When schedulilng after register allocation, do use superblock scheduling
3953 algorithm.  Superblock scheduling allows motion across basic block boundaries
3954 resulting on faster schedules.  This option is experimental, as not all machine
3955 descriptions used by GCC model the CPU closely enough to avoid unreliable
3956 results from the algorithm. 
3957
3958 This only makes sense when scheduling after register allocation, i.e.@: with
3959 @option{-fschedule-insns2} or at @option{-O2} or higher.
3960
3961 @item -fsched2-use-traces
3962 @opindex fsched2-use-traces
3963 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3964 allocation and additionally perform code duplication in order to increase the
3965 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3966 trace formation.
3967
3968 This mode should produce faster but significantly longer programs.  Also
3969 without @code{-fbranch-probabilities} the traces constructed may not match the
3970 reality and hurt the performance.  This only makes
3971 sense when scheduling after register allocation, i.e.@: with
3972 @option{-fschedule-insns2} or at @option{-O2} or higher.
3973
3974 @item -fcaller-saves
3975 @opindex fcaller-saves
3976 Enable values to be allocated in registers that will be clobbered by
3977 function calls, by emitting extra instructions to save and restore the
3978 registers around such calls.  Such allocation is done only when it
3979 seems to result in better code than would otherwise be produced.
3980
3981 This option is always enabled by default on certain machines, usually
3982 those which have no call-preserved registers to use instead.
3983
3984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3985
3986 @item -fmove-all-movables
3987 @opindex fmove-all-movables
3988 Forces all invariant computations in loops to be moved
3989 outside the loop.
3990
3991 @item -freduce-all-givs
3992 @opindex freduce-all-givs
3993 Forces all general-induction variables in loops to be
3994 strength-reduced.
3995
3996 @emph{Note:} When compiling programs written in Fortran,
3997 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3998 by default when you use the optimizer.
3999
4000 These options may generate better or worse code; results are highly
4001 dependent on the structure of loops within the source code.
4002
4003 These two options are intended to be removed someday, once
4004 they have helped determine the efficacy of various
4005 approaches to improving loop optimizations.
4006
4007 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4008 know how use of these options affects
4009 the performance of your production code.
4010 We're very interested in code that runs @emph{slower}
4011 when these options are @emph{enabled}.
4012
4013 @item -fno-peephole
4014 @itemx -fno-peephole2
4015 @opindex fno-peephole
4016 @opindex fno-peephole2
4017 Disable any machine-specific peephole optimizations.  The difference
4018 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4019 are implemented in the compiler; some targets use one, some use the
4020 other, a few use both.
4021
4022 @option{-fpeephole} is enabled by default.
4023 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4024
4025 @item -fno-guess-branch-probability
4026 @opindex fno-guess-branch-probability
4027 Do not guess branch probabilities using a randomized model.
4028
4029 Sometimes gcc will opt to use a randomized model to guess branch
4030 probabilities, when none are available from either profiling feedback
4031 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4032 different runs of the compiler on the same program may produce different
4033 object code.
4034
4035 In a hard real-time system, people don't want different runs of the
4036 compiler to produce code that has different behavior; minimizing
4037 non-determinism is of paramount import.  This switch allows users to
4038 reduce non-determinism, possibly at the expense of inferior
4039 optimization.
4040
4041 The default is @option{-fguess-branch-probability} at levels
4042 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4043
4044 @item -freorder-blocks
4045 @opindex freorder-blocks
4046 Reorder basic blocks in the compiled function in order to reduce number of
4047 taken branches and improve code locality.
4048
4049 Enabled at levels @option{-O2}, @option{-O3}.
4050
4051 @item -freorder-functions
4052 @opindex freorder-functions
4053 Reorder basic blocks in the compiled function in order to reduce number of
4054 taken branches and improve code locality. This is implemented by using special
4055 subsections @code{text.hot} for most frequently executed functions and
4056 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4057 the linker so object file format must support named sections and linker must
4058 place them in a reasonable way.
4059
4060 Also profile feedback must be available in to make this option effective.  See
4061 @option{-fprofile-arcs} for details.
4062
4063 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4064
4065 @item -fstrict-aliasing
4066 @opindex fstrict-aliasing
4067 Allows the compiler to assume the strictest aliasing rules applicable to
4068 the language being compiled.  For C (and C++), this activates
4069 optimizations based on the type of expressions.  In particular, an
4070 object of one type is assumed never to reside at the same address as an
4071 object of a different type, unless the types are almost the same.  For
4072 example, an @code{unsigned int} can alias an @code{int}, but not a
4073 @code{void*} or a @code{double}.  A character type may alias any other
4074 type.
4075
4076 Pay special attention to code like this:
4077 @example
4078 union a_union @{
4079   int i;
4080   double d;
4081 @};
4082
4083 int f() @{
4084   a_union t;
4085   t.d = 3.0;
4086   return t.i;
4087 @}
4088 @end example
4089 The practice of reading from a different union member than the one most
4090 recently written to (called ``type-punning'') is common.  Even with
4091 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4092 is accessed through the union type.  So, the code above will work as
4093 expected.  However, this code might not:
4094 @example
4095 int f() @{
4096   a_union t;
4097   int* ip;
4098   t.d = 3.0;
4099   ip = &t.i;
4100   return *ip;
4101 @}
4102 @end example
4103
4104 Every language that wishes to perform language-specific alias analysis
4105 should define a function that computes, given an @code{tree}
4106 node, an alias set for the node.  Nodes in different alias sets are not
4107 allowed to alias.  For an example, see the C front-end function
4108 @code{c_get_alias_set}.
4109
4110 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4111
4112 @item -falign-functions
4113 @itemx -falign-functions=@var{n}
4114 @opindex falign-functions
4115 Align the start of functions to the next power-of-two greater than
4116 @var{n}, skipping up to @var{n} bytes.  For instance,
4117 @option{-falign-functions=32} aligns functions to the next 32-byte
4118 boundary, but @option{-falign-functions=24} would align to the next
4119 32-byte boundary only if this can be done by skipping 23 bytes or less.
4120
4121 @option{-fno-align-functions} and @option{-falign-functions=1} are
4122 equivalent and mean that functions will not be aligned.
4123
4124 Some assemblers only support this flag when @var{n} is a power of two;
4125 in that case, it is rounded up.
4126
4127 If @var{n} is not specified, use a machine-dependent default.
4128
4129 Enabled at levels @option{-O2}, @option{-O3}.
4130
4131 @item -falign-labels
4132 @itemx -falign-labels=@var{n}
4133 @opindex falign-labels
4134 Align all branch targets to a power-of-two boundary, skipping up to
4135 @var{n} bytes like @option{-falign-functions}.  This option can easily
4136 make code slower, because it must insert dummy operations for when the
4137 branch target is reached in the usual flow of the code.
4138
4139 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4140 are greater than this value, then their values are used instead.
4141
4142 If @var{n} is not specified, use a machine-dependent default which is
4143 very likely to be @samp{1}, meaning no alignment.
4144
4145 Enabled at levels @option{-O2}, @option{-O3}.
4146
4147 @item -falign-loops
4148 @itemx -falign-loops=@var{n}
4149 @opindex falign-loops
4150 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4151 like @option{-falign-functions}.  The hope is that the loop will be
4152 executed many times, which will make up for any execution of the dummy
4153 operations.
4154
4155 If @var{n} is not specified, use a machine-dependent default.
4156
4157 Enabled at levels @option{-O2}, @option{-O3}.
4158
4159 @item -falign-jumps
4160 @itemx -falign-jumps=@var{n}
4161 @opindex falign-jumps
4162 Align branch targets to a power-of-two boundary, for branch targets
4163 where the targets can only be reached by jumping, skipping up to @var{n}
4164 bytes like @option{-falign-functions}.  In this case, no dummy operations
4165 need be executed.
4166
4167 If @var{n} is not specified, use a machine-dependent default.
4168
4169 Enabled at levels @option{-O2}, @option{-O3}.
4170
4171 @item -frename-registers
4172 @opindex frename-registers
4173 Attempt to avoid false dependencies in scheduled code by making use
4174 of registers left over after register allocation.  This optimization
4175 will most benefit processors with lots of registers.  It can, however,
4176 make debugging impossible, since variables will no longer stay in
4177 a ``home register''.
4178
4179 Enabled at levels @option{-O3}.
4180
4181 @item -fno-cprop-registers
4182 @opindex fno-cprop-registers
4183 After register allocation and post-register allocation instruction splitting,
4184 we perform a copy-propagation pass to try to reduce scheduling dependencies
4185 and occasionally eliminate the copy.
4186
4187 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4188
4189 @end table
4190
4191 The following options control compiler behavior regarding floating
4192 point arithmetic.  These options trade off between speed and
4193 correctness.  All must be specifically enabled.
4194
4195 @table @gcctabopt
4196 @item -ffloat-store
4197 @opindex ffloat-store
4198 Do not store floating point variables in registers, and inhibit other
4199 options that might change whether a floating point value is taken from a
4200 register or memory.
4201
4202 @cindex floating point precision
4203 This option prevents undesirable excess precision on machines such as
4204 the 68000 where the floating registers (of the 68881) keep more
4205 precision than a @code{double} is supposed to have.  Similarly for the
4206 x86 architecture.  For most programs, the excess precision does only
4207 good, but a few programs rely on the precise definition of IEEE floating
4208 point.  Use @option{-ffloat-store} for such programs, after modifying
4209 them to store all pertinent intermediate computations into variables.
4210
4211 @item -ffast-math
4212 @opindex ffast-math
4213 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4214 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4215 @option{-fno-signaling-nans}.
4216
4217 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4218
4219 This option should never be turned on by any @option{-O} option since
4220 it can result in incorrect output for programs which depend on
4221 an exact implementation of IEEE or ISO rules/specifications for
4222 math functions.
4223
4224 @item -fno-math-errno
4225 @opindex fno-math-errno
4226 Do not set ERRNO after calling math functions that are executed
4227 with a single instruction, e.g., sqrt.  A program that relies on
4228 IEEE exceptions for math error handling may want to use this flag
4229 for speed while maintaining IEEE arithmetic compatibility.
4230
4231 This option should never be turned on by any @option{-O} option since
4232 it can result in incorrect output for programs which depend on
4233 an exact implementation of IEEE or ISO rules/specifications for
4234 math functions.
4235
4236 The default is @option{-fmath-errno}.
4237
4238 @item -funsafe-math-optimizations
4239 @opindex funsafe-math-optimizations
4240 Allow optimizations for floating-point arithmetic that (a) assume
4241 that arguments and results are valid and (b) may violate IEEE or
4242 ANSI standards.  When used at link-time, it may include libraries
4243 or startup files that change the default FPU control word or other
4244 similar optimizations.
4245
4246 This option should never be turned on by any @option{-O} option since
4247 it can result in incorrect output for programs which depend on
4248 an exact implementation of IEEE or ISO rules/specifications for
4249 math functions.
4250
4251 The default is @option{-fno-unsafe-math-optimizations}.
4252
4253 @item -ffinite-math-only
4254 @opindex ffinite-math-only
4255 Allow optimizations for floating-point arithmetic that assume
4256 that arguments and results are not NaNs or +-Infs.
4257
4258 This option should never be turned on by any @option{-O} option since
4259 it can result in incorrect output for programs which depend on
4260 an exact implementation of IEEE or ISO rules/specifications.
4261
4262 The default is @option{-fno-finite-math-only}.
4263
4264 @item -fno-trapping-math
4265 @opindex fno-trapping-math
4266 Compile code assuming that floating-point operations cannot generate
4267 user-visible traps.  These traps include division by zero, overflow,
4268 underflow, inexact result and invalid operation.  This option implies
4269 @option{-fno-signaling-nans}.  Setting this option may allow faster
4270 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4271
4272 This option should never be turned on by any @option{-O} option since
4273 it can result in incorrect output for programs which depend on
4274 an exact implementation of IEEE or ISO rules/specifications for
4275 math functions.
4276
4277 The default is @option{-ftrapping-math}.
4278
4279 @item -fsignaling-nans
4280 @opindex fsignaling-nans
4281 Compile code assuming that IEEE signaling NaNs may generate user-visible
4282 traps during floating-point operations.  Setting this option disables
4283 optimizations that may change the number of exceptions visible with
4284 signaling NaNs.  This option implies @option{-ftrapping-math}.
4285
4286 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4287 be defined.
4288
4289 The default is @option{-fno-signaling-nans}.
4290
4291 This option is experimental and does not currently guarantee to
4292 disable all GCC optimizations that affect signaling NaN behavior.
4293
4294 @item -fsingle-precision-constant
4295 @opindex fsingle-precision-constant
4296 Treat floating point constant as single precision constant instead of
4297 implicitly converting it to double precision constant.
4298
4299
4300 @end table
4301
4302 The following options control optimizations that may improve
4303 performance, but are not enabled by any @option{-O} options.  This
4304 section includes experimental options that may produce broken code.
4305
4306 @table @gcctabopt
4307 @item -fbranch-probabilities
4308 @opindex fbranch-probabilities
4309 After running a program compiled with @option{-fprofile-arcs}
4310 (@pxref{Debugging Options,, Options for Debugging Your Program or
4311 @command{gcc}}), you can compile it a second time using
4312 @option{-fbranch-probabilities}, to improve optimizations based on
4313 the number of times each branch was taken.  When the program
4314 compiled with @option{-fprofile-arcs} exits it saves arc execution
4315 counts to a file called @file{@var{sourcename}.da} for each source
4316 file  The information in this data file is very dependent on the
4317 structure of the generated code, so you must use the same source code
4318 and the same optimization options for both compilations.
4319
4320 With @option{-fbranch-probabilities}, GCC puts a 
4321 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4322 These can be used to improve optimization.  Currently, they are only
4323 used in one place: in @file{reorg.c}, instead of guessing which path a
4324 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4325 exactly determine which path is taken more often.
4326
4327 @item -fprofile-values
4328 @opindex fprofile-values
4329 If combined with @option{-fprofile-arcs}, it adds code so that some
4330 data about values of expressions in the program is gathered.
4331
4332 @item -fnew-ra
4333 @opindex fnew-ra
4334 Use a graph coloring register allocator.  Currently this option is meant
4335 for testing, so we are interested to hear about miscompilations with
4336 @option{-fnew-ra}.
4337
4338 @item -ftracer
4339 @opindex ftracer
4340 Perform tail duplication to enlarge superblock size. This transformation
4341 simplifies the control flow of the function allowing other optimizations to do
4342 better job.
4343
4344 @item -funit-at-a-time
4345 @opindex funit-at-a-time
4346 Parse the whole compilation unit before starting to produce code.  This allows some
4347 extra optimizations to take place but consumes more memory.
4348
4349 @item -funroll-loops
4350 @opindex funroll-loops
4351 Unroll loops whose number of iterations can be determined at compile time or
4352 upon entry to the loop.  @option{-funroll-loops} implies
4353 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4354 (i.e. complete removal of loops with small constant number of iterations).
4355 This option makes code larger, and may or may not make it run faster.
4356
4357 @item -funroll-all-loops
4358 @opindex funroll-all-loops
4359 Unroll all loops, even if their number of iterations is uncertain when
4360 the loop is entered.  This usually makes programs run more slowly.
4361 @option{-funroll-all-loops} implies the same options as
4362 @option{-funroll-loops}.
4363
4364 @item -fpeel-loops
4365 @opindex fpeel-loops
4366 Peels the loops for that there is enough information that they do not
4367 roll much (from profile feedback).  It also turns on complete loop peeling
4368 (i.e. complete removal of loops with small constant number of iterations).
4369
4370 @item -funswitch-loops
4371 @opindex funswitch-loops
4372 Move branches with loop invariant conditions out of the loop, with duplicates
4373 of the loop on both branches (modified according to result of the condition).
4374
4375 @item -fold-unroll-loops
4376 @opindex fold-unroll-loops
4377 Unroll loops whose number of iterations can be determined at compile
4378 time or upon entry to the loop, using the old loop unroller whose loop
4379 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4380 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4381 option makes code larger, and may or may not make it run faster.
4382
4383 @item -fold-unroll-all-loops
4384 @opindex fold-unroll-all-loops
4385 Unroll all loops, even if their number of iterations is uncertain when
4386 the loop is entered. This is done using the old loop unroller whose loop
4387 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4388 @option{-fold-unroll-all-loops} implies the same options as
4389 @option{-fold-unroll-loops}.
4390  
4391 @item -funswitch-loops
4392 @opindex funswitch-loops
4393 Move branches with loop invariant conditions out of the loop, with duplicates
4394 of the loop on both branches (modified according to result of the condition).
4395
4396 @item -funswitch-loops
4397 @opindex funswitch-loops
4398 Move branches with loop invariant conditions out of the loop, with duplicates
4399 of the loop on both branches (modified according to result of the condition).
4400
4401 @item -fprefetch-loop-arrays
4402 @opindex fprefetch-loop-arrays
4403 If supported by the target machine, generate instructions to prefetch
4404 memory to improve the performance of loops that access large arrays.
4405
4406 Disabled at level @option{-Os}.
4407
4408 @item -ffunction-sections
4409 @itemx -fdata-sections
4410 @opindex ffunction-sections
4411 @opindex fdata-sections
4412 Place each function or data item into its own section in the output
4413 file if the target supports arbitrary sections.  The name of the
4414 function or the name of the data item determines the section's name
4415 in the output file.
4416
4417 Use these options on systems where the linker can perform optimizations
4418 to improve locality of reference in the instruction space.  Most systems
4419 using the ELF object format and SPARC processors running Solaris 2 have
4420 linkers with such optimizations.  AIX may have these optimizations in
4421 the future.
4422
4423 Only use these options when there are significant benefits from doing
4424 so.  When you specify these options, the assembler and linker will
4425 create larger object and executable files and will also be slower.
4426 You will not be able to use @code{gprof} on all systems if you
4427 specify this option and you may have problems with debugging if
4428 you specify both this option and @option{-g}.
4429
4430 @item -fssa
4431 @opindex fssa
4432 Perform optimizations in static single assignment form.  Each function's
4433 flow graph is translated into SSA form, optimizations are performed, and
4434 the flow graph is translated back from SSA form.  Users should not
4435 specify this option, since it is not yet ready for production use.
4436
4437 @item -fssa-ccp
4438 @opindex fssa-ccp
4439 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4440 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4441
4442 @item -fssa-dce
4443 @opindex fssa-dce
4444 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4445 Like @option{-fssa}, this is an experimental feature.
4446
4447 @item -fbranch-target-load-optimize
4448 @opindex fbranch-target-load-optimize
4449 Perform branch target register load optimization before prologue / epilogue
4450 threading.
4451 The use of target registers can typically be exposed only during reload,
4452 thus hoisting loads out of loops and doing inter-block scheduling needs
4453 a separate optimization pass.
4454
4455 @item -fbranch-target-load-optimize2
4456 @opindex fbranch-target-load-optimize2
4457 Perform branch target register load optimization after prologue / epilogue
4458 threading.
4459
4460
4461
4462
4463 @item --param @var{name}=@var{value}
4464 @opindex param
4465 In some places, GCC uses various constants to control the amount of
4466 optimization that is done.  For example, GCC will not inline functions
4467 that contain more that a certain number of instructions.  You can
4468 control some of these constants on the command-line using the
4469 @option{--param} option.
4470
4471 In each case, the @var{value} is an integer.  The allowable choices for
4472 @var{name} are given in the following table:
4473
4474 @table @gcctabopt
4475 @item max-crossjump-edges
4476 The maximum number of incoming edges to consider for crossjumping.
4477 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4478 the number of edges incoming to each block.  Increasing values mean
4479 more aggressive optimization, making the compile time increase with
4480 probably small improvement in executable size.
4481
4482 @item max-delay-slot-insn-search
4483 The maximum number of instructions to consider when looking for an
4484 instruction to fill a delay slot.  If more than this arbitrary number of
4485 instructions is searched, the time savings from filling the delay slot
4486 will be minimal so stop searching.  Increasing values mean more
4487 aggressive optimization, making the compile time increase with probably
4488 small improvement in executable run time.
4489
4490 @item max-delay-slot-live-search
4491 When trying to fill delay slots, the maximum number of instructions to
4492 consider when searching for a block with valid live register
4493 information.  Increasing this arbitrarily chosen value means more
4494 aggressive optimization, increasing the compile time.  This parameter
4495 should be removed when the delay slot code is rewritten to maintain the
4496 control-flow graph.
4497
4498 @item max-gcse-memory
4499 The approximate maximum amount of memory that will be allocated in
4500 order to perform the global common subexpression elimination
4501 optimization.  If more memory than specified is required, the
4502 optimization will not be done.
4503
4504 @item max-gcse-passes
4505 The maximum number of passes of GCSE to run.
4506
4507 @item max-pending-list-length
4508 The maximum number of pending dependencies scheduling will allow
4509 before flushing the current state and starting over.  Large functions
4510 with few branches or calls can create excessively large lists which
4511 needlessly consume memory and resources.
4512
4513 @item max-inline-insns-single
4514 Several parameters control the tree inliner used in gcc.
4515 This number sets the maximum number of instructions (counted in gcc's
4516 internal representation) in a single function that the tree inliner 
4517 will consider for inlining.  This only affects functions declared
4518 inline and methods implemented in a class declaration (C++).
4519 The default value is 300.
4520
4521 @item max-inline-insns-auto
4522 When you use @option{-finline-functions} (included in @option{-O3}),
4523 a lot of functions that would otherwise not be considered for inlining
4524 by the compiler will be investigated.  To those functions, a different
4525 (more restrictive) limit compared to functions declared inline can
4526 be applied.
4527 The default value is 300.
4528
4529 @item max-inline-insns
4530 The tree inliner does decrease the allowable size for single functions 
4531 to be inlined after we already inlined the number of instructions
4532 given here by repeated inlining.  This number should be a factor of 
4533 two or more larger than the single function limit.
4534 Higher numbers result in better runtime performance, but incur higher
4535 compile-time resource (CPU time, memory) requirements and result in
4536 larger binaries.  Very high values are not advisable, as too large
4537 binaries may adversely affect runtime performance.
4538 The default value is 600.
4539
4540 @item max-inline-slope
4541 After exceeding the maximum number of inlined instructions by repeated
4542 inlining, a linear function is used to decrease the allowable size
4543 for single functions.  The slope of that function is the negative
4544 reciprocal of the number specified here.
4545 The default value is 32.
4546
4547 @item min-inline-insns
4548 The repeated inlining is throttled more and more by the linear function
4549 after exceeding the limit.  To avoid too much throttling, a minimum for
4550 this function is specified here to allow repeated inlining for very small
4551 functions even when a lot of repeated inlining already has been done.
4552 The default value is 130.
4553
4554 @item max-inline-insns-rtl
4555 For languages that use the RTL inliner (this happens at a later stage
4556 than tree inlining), you can set the maximum allowable size (counted 
4557 in RTL instructions) for the RTL inliner with this parameter.
4558 The default value is 600.
4559
4560
4561 @item max-unrolled-insns
4562 The maximum number of instructions that a loop should have if that loop
4563 is unrolled, and if the loop is unrolled, it determines how many times
4564 the loop code is unrolled.
4565
4566 @item max-average-unrolled-insns
4567 The maximum number of instructions biased by probabilities of their execution
4568 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4569 it determines how many times the loop code is unrolled.
4570
4571 @item max-unroll-times
4572 The maximum number of unrollings of a single loop.
4573
4574 @item max-peeled-insns
4575 The maximum number of instructions that a loop should have if that loop
4576 is peeled, and if the loop is peeled, it determines how many times
4577 the loop code is peeled.
4578
4579 @item max-peel-times
4580 The maximum number of peelings of a single loop.
4581
4582 @item max-completely-peeled-insns
4583 The maximum number of insns of a completely peeled loop.
4584
4585 @item max-completely-peel-times
4586 The maximum number of iterations of a loop to be suitable for complete peeling.
4587
4588 @item max-unswitch-insns
4589 The maximum number of insns of an unswitched loop.
4590
4591 @item max-unswitch-level
4592 The maximum number of branches unswitched in a single loop.
4593
4594 @item hot-bb-count-fraction
4595 Select fraction of the maximal count of repetitions of basic block in program
4596 given basic block needs to have to be considered hot.
4597
4598 @item hot-bb-frequency-fraction
4599 Select fraction of the maximal frequency of executions of basic block in
4600 function given basic block needs to have to be considered hot
4601
4602 @item tracer-dynamic-coverage
4603 @itemx tracer-dynamic-coverage-feedback
4604
4605 This value is used to limit superblock formation once the given percentage of
4606 executed instructions is covered.  This limits unnecessary code size
4607 expansion.
4608
4609 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4610 feedback is available.  The real profiles (as opposed to statically estimated
4611 ones) are much less balanced allowing the threshold to be larger value.
4612
4613 @item tracer-max-code-growth
4614 Stop tail duplication once code growth has reached given percentage.  This is
4615 rather hokey argument, as most of the duplicates will be eliminated later in
4616 cross jumping, so it may be set to much higher values than is the desired code
4617 growth.
4618
4619 @item tracer-min-branch-ratio
4620
4621 Stop reverse growth when the reverse probability of best edge is less than this
4622 threshold (in percent).
4623
4624 @item tracer-min-branch-ratio
4625 @itemx tracer-min-branch-ratio-feedback
4626
4627 Stop forward growth if the best edge do have probability lower than this
4628 threshold.
4629
4630 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4631 compilation for profile feedback and one for compilation without.  The value
4632 for compilation with profile feedback needs to be more conservative (higher) in
4633 order to make tracer effective.
4634
4635 @item max-cse-path-length
4636
4637 Maximum number of basic blocks on path that cse considers.
4638
4639 @item ggc-min-expand
4640
4641 GCC uses a garbage collector to manage its own memory allocation.  This
4642 parameter specifies the minimum percentage by which the garbage
4643 collector's heap should be allowed to expand between collections.
4644 Tuning this may improve compilation speed; it has no effect on code
4645 generation.
4646
4647 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4648 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4649 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4650 GCC is not able to calculate RAM on a particular platform, the lower
4651 bound of 30% is used.  Setting this parameter and
4652 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4653 every opportunity.  This is extremely slow, but can be useful for
4654 debugging.
4655
4656 @item ggc-min-heapsize
4657
4658 Minimum size of the garbage collector's heap before it begins bothering
4659 to collect garbage.  The first collection occurs after the heap expands
4660 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4661 tuning this may improve compilation speed, and has no effect on code
4662 generation.
4663
4664 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4665 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4666 available, the notion of "RAM" is the smallest of actual RAM,
4667 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4668 RAM on a particular platform, the lower bound is used.  Setting this
4669 parameter very large effectively disables garbage collection.  Setting
4670 this parameter and @option{ggc-min-expand} to zero causes a full
4671 collection to occur at every opportunity.
4672
4673 @item reorder-blocks-duplicate
4674 @itemx reorder-blocks-duplicate-feedback
4675
4676 Used by basic block reordering pass to decide whether to use unconditional
4677 branch or duplicate the code on it's destination.  Code is duplicated when it's
4678 estimated size is smaller than this value multiplied by the estimated size of
4679 unconditional jump in the hot spots of the program.
4680
4681 The @option{reorder-block-duplicate-feedback} is used only when profile
4682 feedback is available and may be set to higher values than
4683 @option{reorder-block-duplicate} since information about the hot spots is more
4684 accurate.
4685 @end table
4686 @end table
4687
4688 @node Preprocessor Options
4689 @section Options Controlling the Preprocessor
4690 @cindex preprocessor options
4691 @cindex options, preprocessor
4692
4693 These options control the C preprocessor, which is run on each C source
4694 file before actual compilation.
4695
4696 If you use the @option{-E} option, nothing is done except preprocessing.
4697 Some of these options make sense only together with @option{-E} because
4698 they cause the preprocessor output to be unsuitable for actual
4699 compilation.
4700
4701 @table @gcctabopt
4702 @opindex Wp
4703 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4704 and pass @var{option} directly through to the preprocessor.  If
4705 @var{option} contains commas, it is split into multiple options at the
4706 commas.  However, many options are modified, translated or interpreted
4707 by the compiler driver before being passed to the preprocessor, and
4708 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4709 interface is undocumented and subject to change, so whenever possible
4710 you should avoid using @option{-Wp} and let the driver handle the
4711 options instead.
4712
4713 @item -Xpreprocessor @var{option}
4714 @opindex preprocessor
4715 Pass @var{option} as an option to the preprocessor.  You can use this to
4716 supply system-specific preprocessor options which GCC does not know how to
4717 recognize.
4718
4719 If you want to pass an option that takes an argument, you must use
4720 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4721 @end table
4722
4723 @include cppopts.texi
4724
4725 @node Assembler Options
4726 @section Passing Options to the Assembler
4727
4728 @c prevent bad page break with this line
4729 You can pass options to the assembler.
4730
4731 @table @gcctabopt
4732 @item -Wa,@var{option}
4733 @opindex Wa
4734 Pass @var{option} as an option to the assembler.  If @var{option}
4735 contains commas, it is split into multiple options at the commas.
4736
4737 @item -Xassembler @var{option}
4738 @opindex Xassembler
4739 Pass @var{option} as an option to the assembler.  You can use this to
4740 supply system-specific assembler options which GCC does not know how to
4741 recognize.
4742
4743 If you want to pass an option that takes an argument, you must use
4744 @option{-Xassembler} twice, once for the option and once for the argument.
4745
4746 @end table
4747
4748 @node Link Options
4749 @section Options for Linking
4750 @cindex link options
4751 @cindex options, linking
4752
4753 These options come into play when the compiler links object files into
4754 an executable output file.  They are meaningless if the compiler is
4755 not doing a link step.
4756
4757 @table @gcctabopt
4758 @cindex file names
4759 @item @var{object-file-name}
4760 A file name that does not end in a special recognized suffix is
4761 considered to name an object file or library.  (Object files are
4762 distinguished from libraries by the linker according to the file
4763 contents.)  If linking is done, these object files are used as input
4764 to the linker.
4765
4766 @item -c
4767 @itemx -S
4768 @itemx -E
4769 @opindex c
4770 @opindex S
4771 @opindex E
4772 If any of these options is used, then the linker is not run, and
4773 object file names should not be used as arguments.  @xref{Overall
4774 Options}.
4775
4776 @cindex Libraries
4777 @item -l@var{library}
4778 @itemx -l @var{library}
4779 @opindex l
4780 Search the library named @var{library} when linking.  (The second
4781 alternative with the library as a separate argument is only for
4782 POSIX compliance and is not recommended.)
4783
4784 It makes a difference where in the command you write this option; the
4785 linker searches and processes libraries and object files in the order they
4786 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4787 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4788 to functions in @samp{z}, those functions may not be loaded.
4789
4790 The linker searches a standard list of directories for the library,
4791 which is actually a file named @file{lib@var{library}.a}.  The linker
4792 then uses this file as if it had been specified precisely by name.
4793
4794 The directories searched include several standard system directories
4795 plus any that you specify with @option{-L}.
4796
4797 Normally the files found this way are library files---archive files
4798 whose members are object files.  The linker handles an archive file by
4799 scanning through it for members which define symbols that have so far
4800 been referenced but not defined.  But if the file that is found is an
4801 ordinary object file, it is linked in the usual fashion.  The only
4802 difference between using an @option{-l} option and specifying a file name
4803 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4804 and searches several directories.
4805
4806 @item -lobjc
4807 @opindex lobjc
4808 You need this special case of the @option{-l} option in order to
4809 link an Objective-C program.
4810
4811 @item -nostartfiles
4812 @opindex nostartfiles
4813 Do not use the standard system startup files when linking.
4814 The standard system libraries are used normally, unless @option{-nostdlib}
4815 or @option{-nodefaultlibs} is used.
4816
4817 @item -nodefaultlibs
4818 @opindex nodefaultlibs
4819 Do not use the standard system libraries when linking.
4820 Only the libraries you specify will be passed to the linker.
4821 The standard startup files are used normally, unless @option{-nostartfiles}
4822 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4823 for System V (and ISO C) environments or to bcopy and bzero for
4824 BSD environments.  These entries are usually resolved by entries in
4825 libc.  These entry points should be supplied through some other
4826 mechanism when this option is specified.
4827
4828 @item -nostdlib
4829 @opindex nostdlib
4830 Do not use the standard system startup files or libraries when linking.
4831 No startup files and only the libraries you specify will be passed to
4832 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4833 for System V (and ISO C) environments or to bcopy and bzero for
4834 BSD environments.  These entries are usually resolved by entries in
4835 libc.  These entry points should be supplied through some other
4836 mechanism when this option is specified.
4837
4838 @cindex @option{-lgcc}, use with @option{-nostdlib}
4839 @cindex @option{-nostdlib} and unresolved references
4840 @cindex unresolved references and @option{-nostdlib}
4841 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4842 @cindex @option{-nodefaultlibs} and unresolved references
4843 @cindex unresolved references and @option{-nodefaultlibs}
4844 One of the standard libraries bypassed by @option{-nostdlib} and
4845 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4846 that GCC uses to overcome shortcomings of particular machines, or special
4847 needs for some languages.
4848 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4849 Collection (GCC) Internals},
4850 for more discussion of @file{libgcc.a}.)
4851 In most cases, you need @file{libgcc.a} even when you want to avoid
4852 other standard libraries.  In other words, when you specify @option{-nostdlib}
4853 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4854 This ensures that you have no unresolved references to internal GCC
4855 library subroutines.  (For example, @samp{__main}, used to ensure C++
4856 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4857 GNU Compiler Collection (GCC) Internals}.)
4858
4859 @item -pie
4860 @opindex pie
4861 Produce a position independent executable on targets which support it.
4862 For predictable results, you must also specify the same set of options
4863 that were used to generate code (@option{-fpie}, @option{-fPIE},
4864 or model suboptions) when you specify this option.
4865
4866 @item -s
4867 @opindex s
4868 Remove all symbol table and relocation information from the executable.
4869
4870 @item -static
4871 @opindex static
4872 On systems that support dynamic linking, this prevents linking with the shared
4873 libraries.  On other systems, this option has no effect.
4874
4875 @item -shared
4876 @opindex shared
4877 Produce a shared object which can then be linked with other objects to
4878 form an executable.  Not all systems support this option.  For predictable
4879 results, you must also specify the same set of options that were used to
4880 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4881 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4882 needs to build supplementary stub code for constructors to work.  On
4883 multi-libbed systems, @samp{gcc -shared} must select the correct support
4884 libraries to link against.  Failing to supply the correct flags may lead
4885 to subtle defects.  Supplying them in cases where they are not necessary
4886 is innocuous.}
4887
4888 @item -shared-libgcc
4889 @itemx -static-libgcc
4890 @opindex shared-libgcc
4891 @opindex static-libgcc
4892 On systems that provide @file{libgcc} as a shared library, these options
4893 force the use of either the shared or static version respectively.
4894 If no shared version of @file{libgcc} was built when the compiler was
4895 configured, these options have no effect.
4896
4897 There are several situations in which an application should use the
4898 shared @file{libgcc} instead of the static version.  The most common
4899 of these is when the application wishes to throw and catch exceptions
4900 across different shared libraries.  In that case, each of the libraries
4901 as well as the application itself should use the shared @file{libgcc}.
4902
4903 Therefore, the G++ and GCJ drivers automatically add
4904 @option{-shared-libgcc} whenever you build a shared library or a main
4905 executable, because C++ and Java programs typically use exceptions, so
4906 this is the right thing to do.
4907
4908 If, instead, you use the GCC driver to create shared libraries, you may
4909 find that they will not always be linked with the shared @file{libgcc}.
4910 If GCC finds, at its configuration time, that you have a GNU linker that
4911 does not support option @option{--eh-frame-hdr}, it will link the shared
4912 version of @file{libgcc} into shared libraries by default.  Otherwise,
4913 it will take advantage of the linker and optimize away the linking with
4914 the shared version of @file{libgcc}, linking with the static version of
4915 libgcc by default.  This allows exceptions to propagate through such
4916 shared libraries, without incurring relocation costs at library load
4917 time.
4918
4919 However, if a library or main executable is supposed to throw or catch
4920 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4921 for the languages used in the program, or using the option
4922 @option{-shared-libgcc}, such that it is linked with the shared
4923 @file{libgcc}.
4924
4925 @item -symbolic
4926 @opindex symbolic
4927 Bind references to global symbols when building a shared object.  Warn
4928 about any unresolved references (unless overridden by the link editor
4929 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4930 this option.
4931
4932 @item -Xlinker @var{option}
4933 @opindex Xlinker
4934 Pass @var{option} as an option to the linker.  You can use this to
4935 supply system-specific linker options which GCC does not know how to
4936 recognize.
4937
4938 If you want to pass an option that takes an argument, you must use
4939 @option{-Xlinker} twice, once for the option and once for the argument.
4940 For example, to pass @option{-assert definitions}, you must write
4941 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4942 @option{-Xlinker "-assert definitions"}, because this passes the entire
4943 string as a single argument, which is not what the linker expects.
4944
4945 @item -Wl,@var{option}
4946 @opindex Wl
4947 Pass @var{option} as an option to the linker.  If @var{option} contains
4948 commas, it is split into multiple options at the commas.
4949
4950 @item -u @var{symbol}
4951 @opindex u
4952 Pretend the symbol @var{symbol} is undefined, to force linking of
4953 library modules to define it.  You can use @option{-u} multiple times with
4954 different symbols to force loading of additional library modules.
4955 @end table
4956
4957 @node Directory Options
4958 @section Options for Directory Search
4959 @cindex directory options
4960 @cindex options, directory search
4961 @cindex search path
4962
4963 These options specify directories to search for header files, for
4964 libraries and for parts of the compiler:
4965
4966 @table @gcctabopt
4967 @item -I@var{dir}
4968 @opindex I
4969 Add the directory @var{dir} to the head of the list of directories to be
4970 searched for header files.  This can be used to override a system header
4971 file, substituting your own version, since these directories are
4972 searched before the system header file directories.  However, you should
4973 not use this option to add directories that contain vendor-supplied
4974 system header files (use @option{-isystem} for that).  If you use more than
4975 one @option{-I} option, the directories are scanned in left-to-right
4976 order; the standard system directories come after.
4977
4978 If a standard system include directory, or a directory specified with
4979 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4980 option will be ignored.  The directory will still be searched but as a
4981 system directory at its normal position in the system include chain.
4982 This is to ensure that GCC's procedure to fix buggy system headers and
4983 the ordering for the include_next directive are not inadvertently changed.
4984 If you really need to change the search order for system directories,
4985 use the @option{-nostdinc} and/or @option{-isystem} options.
4986
4987 @item -I-
4988 @opindex I-
4989 Any directories you specify with @option{-I} options before the @option{-I-}
4990 option are searched only for the case of @samp{#include "@var{file}"};
4991 they are not searched for @samp{#include <@var{file}>}.
4992
4993 If additional directories are specified with @option{-I} options after
4994 the @option{-I-}, these directories are searched for all @samp{#include}
4995 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4996 this way.)
4997
4998 In addition, the @option{-I-} option inhibits the use of the current
4999 directory (where the current input file came from) as the first search
5000 directory for @samp{#include "@var{file}"}.  There is no way to
5001 override this effect of @option{-I-}.  With @option{-I.} you can specify
5002 searching the directory which was current when the compiler was
5003 invoked.  That is not exactly the same as what the preprocessor does
5004 by default, but it is often satisfactory.
5005
5006 @option{-I-} does not inhibit the use of the standard system directories
5007 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5008 independent.
5009
5010 @item -L@var{dir}
5011 @opindex L
5012 Add directory @var{dir} to the list of directories to be searched
5013 for @option{-l}.
5014
5015 @item -B@var{prefix}
5016 @opindex B
5017 This option specifies where to find the executables, libraries,
5018 include files, and data files of the compiler itself.
5019
5020 The compiler driver program runs one or more of the subprograms
5021 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5022 @var{prefix} as a prefix for each program it tries to run, both with and
5023 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5024
5025 For each subprogram to be run, the compiler driver first tries the
5026 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5027 was not specified, the driver tries two standard prefixes, which are
5028 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
5029 those results in a file name that is found, the unmodified program
5030 name is searched for using the directories specified in your
5031 @env{PATH} environment variable.
5032
5033 The compiler will check to see if the path provided by the @option{-B}
5034 refers to a directory, and if necessary it will add a directory
5035 separator character at the end of the path.
5036
5037 @option{-B} prefixes that effectively specify directory names also apply
5038 to libraries in the linker, because the compiler translates these
5039 options into @option{-L} options for the linker.  They also apply to
5040 includes files in the preprocessor, because the compiler translates these
5041 options into @option{-isystem} options for the preprocessor.  In this case,
5042 the compiler appends @samp{include} to the prefix.
5043
5044 The run-time support file @file{libgcc.a} can also be searched for using
5045 the @option{-B} prefix, if needed.  If it is not found there, the two
5046 standard prefixes above are tried, and that is all.  The file is left
5047 out of the link if it is not found by those means.
5048
5049 Another way to specify a prefix much like the @option{-B} prefix is to use
5050 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5051 Variables}.
5052
5053 As a special kludge, if the path provided by @option{-B} is
5054 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5055 9, then it will be replaced by @file{[dir/]include}.  This is to help
5056 with boot-strapping the compiler.
5057
5058 @item -specs=@var{file}
5059 @opindex specs
5060 Process @var{file} after the compiler reads in the standard @file{specs}
5061 file, in order to override the defaults that the @file{gcc} driver
5062 program uses when determining what switches to pass to @file{cc1},
5063 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5064 @option{-specs=@var{file}} can be specified on the command line, and they
5065 are processed in order, from left to right.
5066 @end table
5067
5068 @c man end
5069
5070 @node Spec Files
5071 @section Specifying subprocesses and the switches to pass to them
5072 @cindex Spec Files
5073
5074 @command{gcc} is a driver program.  It performs its job by invoking a
5075 sequence of other programs to do the work of compiling, assembling and
5076 linking.  GCC interprets its command-line parameters and uses these to
5077 deduce which programs it should invoke, and which command-line options
5078 it ought to place on their command lines.  This behavior is controlled
5079 by @dfn{spec strings}.  In most cases there is one spec string for each
5080 program that GCC can invoke, but a few programs have multiple spec
5081 strings to control their behavior.  The spec strings built into GCC can
5082 be overridden by using the @option{-specs=} command-line switch to specify
5083 a spec file.
5084
5085 @dfn{Spec files} are plaintext files that are used to construct spec
5086 strings.  They consist of a sequence of directives separated by blank
5087 lines.  The type of directive is determined by the first non-whitespace
5088 character on the line and it can be one of the following:
5089
5090 @table @code
5091 @item %@var{command}
5092 Issues a @var{command} to the spec file processor.  The commands that can
5093 appear here are:
5094
5095 @table @code
5096 @item %include <@var{file}>
5097 @cindex %include
5098 Search for @var{file} and insert its text at the current point in the
5099 specs file.
5100
5101 @item %include_noerr <@var{file}>
5102 @cindex %include_noerr
5103 Just like @samp{%include}, but do not generate an error message if the include
5104 file cannot be found.
5105
5106 @item %rename @var{old_name} @var{new_name}
5107 @cindex %rename
5108 Rename the spec string @var{old_name} to @var{new_name}.
5109
5110 @end table
5111
5112 @item *[@var{spec_name}]:
5113 This tells the compiler to create, override or delete the named spec
5114 string.  All lines after this directive up to the next directive or
5115 blank line are considered to be the text for the spec string.  If this
5116 results in an empty string then the spec will be deleted.  (Or, if the
5117 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5118 does not currently exist a new spec will be created.  If the spec does
5119 exist then its contents will be overridden by the text of this
5120 directive, unless the first character of that text is the @samp{+}
5121 character, in which case the text will be appended to the spec.
5122
5123 @item [@var{suffix}]:
5124 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5125 and up to the next directive or blank line are considered to make up the
5126 spec string for the indicated suffix.  When the compiler encounters an
5127 input file with the named suffix, it will processes the spec string in
5128 order to work out how to compile that file.  For example:
5129
5130 @smallexample
5131 .ZZ:
5132 z-compile -input %i
5133 @end smallexample
5134
5135 This says that any input file whose name ends in @samp{.ZZ} should be
5136 passed to the program @samp{z-compile}, which should be invoked with the
5137 command-line switch @option{-input} and with the result of performing the
5138 @samp{%i} substitution.  (See below.)
5139
5140 As an alternative to providing a spec string, the text that follows a
5141 suffix directive can be one of the following:
5142
5143 @table @code
5144 @item @@@var{language}
5145 This says that the suffix is an alias for a known @var{language}.  This is
5146 similar to using the @option{-x} command-line switch to GCC to specify a
5147 language explicitly.  For example:
5148
5149 @smallexample
5150 .ZZ:
5151 @@c++
5152 @end smallexample
5153
5154 Says that .ZZ files are, in fact, C++ source files.
5155
5156 @item #@var{name}
5157 This causes an error messages saying:
5158
5159 @smallexample
5160 @var{name} compiler not installed on this system.
5161 @end smallexample
5162 @end table
5163
5164 GCC already has an extensive list of suffixes built into it.
5165 This directive will add an entry to the end of the list of suffixes, but
5166 since the list is searched from the end backwards, it is effectively
5167 possible to override earlier entries using this technique.
5168
5169 @end table
5170
5171 GCC has the following spec strings built into it.  Spec files can
5172 override these strings or create their own.  Note that individual
5173 targets can also add their own spec strings to this list.
5174
5175 @smallexample
5176 asm          Options to pass to the assembler
5177 asm_final    Options to pass to the assembler post-processor
5178 cpp          Options to pass to the C preprocessor
5179 cc1          Options to pass to the C compiler
5180 cc1plus      Options to pass to the C++ compiler
5181 endfile      Object files to include at the end of the link
5182 link         Options to pass to the linker
5183 lib          Libraries to include on the command line to the linker
5184 libgcc       Decides which GCC support library to pass to the linker
5185 linker       Sets the name of the linker
5186 predefines   Defines to be passed to the C preprocessor
5187 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5188              by default
5189 startfile    Object files to include at the start of the link
5190 @end smallexample
5191
5192 Here is a small example of a spec file:
5193
5194 @smallexample
5195 %rename lib                 old_lib
5196
5197 *lib:
5198 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5199 @end smallexample
5200
5201 This example renames the spec called @samp{lib} to @samp{old_lib} and
5202 then overrides the previous definition of @samp{lib} with a new one.
5203 The new definition adds in some extra command-line options before
5204 including the text of the old definition.
5205
5206 @dfn{Spec strings} are a list of command-line options to be passed to their
5207 corresponding program.  In addition, the spec strings can contain
5208 @samp{%}-prefixed sequences to substitute variable text or to
5209 conditionally insert text into the command line.  Using these constructs
5210 it is possible to generate quite complex command lines.
5211
5212 Here is a table of all defined @samp{%}-sequences for spec
5213 strings.  Note that spaces are not generated automatically around the
5214 results of expanding these sequences.  Therefore you can concatenate them
5215 together or combine them with constant text in a single argument.
5216
5217 @table @code
5218 @item %%
5219 Substitute one @samp{%} into the program name or argument.
5220
5221 @item %i
5222 Substitute the name of the input file being processed.
5223
5224 @item %b
5225 Substitute the basename of the input file being processed.
5226 This is the substring up to (and not including) the last period
5227 and not including the directory.
5228
5229 @item %B
5230 This is the same as @samp{%b}, but include the file suffix (text after
5231 the last period).
5232
5233 @item %d
5234 Marks the argument containing or following the @samp{%d} as a
5235 temporary file name, so that that file will be deleted if GCC exits
5236 successfully.  Unlike @samp{%g}, this contributes no text to the
5237 argument.
5238
5239 @item %g@var{suffix}
5240 Substitute a file name that has suffix @var{suffix} and is chosen
5241 once per compilation, and mark the argument in the same way as
5242 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5243 name is now chosen in a way that is hard to predict even when previously
5244 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5245 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5246 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5247 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5248 was simply substituted with a file name chosen once per compilation,
5249 without regard to any appended suffix (which was therefore treated
5250 just like ordinary text), making such attacks more likely to succeed.
5251
5252 @item %u@var{suffix}
5253 Like @samp{%g}, but generates a new temporary file name even if
5254 @samp{%u@var{suffix}} was already seen.
5255
5256 @item %U@var{suffix}
5257 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5258 new one if there is no such last file name.  In the absence of any
5259 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5260 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5261 would involve the generation of two distinct file names, one
5262 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5263 simply substituted with a file name chosen for the previous @samp{%u},
5264 without regard to any appended suffix.
5265
5266 @item %j@var{suffix}
5267 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5268 writable, and if save-temps is off; otherwise, substitute the name
5269 of a temporary file, just like @samp{%u}.  This temporary file is not
5270 meant for communication between processes, but rather as a junk
5271 disposal mechanism.
5272
5273 @item %|@var{suffix}
5274 @itemx %m@var{suffix}
5275 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5276 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5277 all.  These are the two most common ways to instruct a program that it
5278 should read from standard input or write to standard output.  If you
5279 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5280 construct: see for example @file{f/lang-specs.h}.
5281
5282 @item %.@var{SUFFIX}
5283 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5284 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5285 terminated by the next space or %.
5286
5287 @item %w
5288 Marks the argument containing or following the @samp{%w} as the
5289 designated output file of this compilation.  This puts the argument
5290 into the sequence of arguments that @samp{%o} will substitute later.
5291
5292 @item %o
5293 Substitutes the names of all the output files, with spaces
5294 automatically placed around them.  You should write spaces
5295 around the @samp{%o} as well or the results are undefined.
5296 @samp{%o} is for use in the specs for running the linker.
5297 Input files whose names have no recognized suffix are not compiled
5298 at all, but they are included among the output files, so they will
5299 be linked.
5300
5301 @item %O
5302 Substitutes the suffix for object files.  Note that this is
5303 handled specially when it immediately follows @samp{%g, %u, or %U},
5304 because of the need for those to form complete file names.  The
5305 handling is such that @samp{%O} is treated exactly as if it had already
5306 been substituted, except that @samp{%g, %u, and %U} do not currently
5307 support additional @var{suffix} characters following @samp{%O} as they would
5308 following, for example, @samp{.o}.
5309
5310 @item %p
5311 Substitutes the standard macro predefinitions for the
5312 current target machine.  Use this when running @code{cpp}.
5313
5314 @item %P
5315 Like @samp{%p}, but puts @samp{__} before and after the name of each
5316 predefined macro, except for macros that start with @samp{__} or with
5317 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5318 C@.
5319
5320 @item %I
5321 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5322 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5323 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5324 as necessary.
5325
5326 @item %s
5327 Current argument is the name of a library or startup file of some sort.
5328 Search for that file in a standard list of directories and substitute
5329 the full name found.
5330
5331 @item %e@var{str}
5332 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5333 Use this when inconsistent options are detected.
5334
5335 @item %(@var{name})
5336 Substitute the contents of spec string @var{name} at this point.
5337
5338 @item %[@var{name}]
5339 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5340
5341 @item %x@{@var{option}@}
5342 Accumulate an option for @samp{%X}.
5343
5344 @item %X
5345 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5346 spec string.
5347
5348 @item %Y
5349 Output the accumulated assembler options specified by @option{-Wa}.
5350
5351 @item %Z
5352 Output the accumulated preprocessor options specified by @option{-Wp}.
5353
5354 @item %a
5355 Process the @code{asm} spec.  This is used to compute the
5356 switches to be passed to the assembler.
5357
5358 @item %A
5359 Process the @code{asm_final} spec.  This is a spec string for
5360 passing switches to an assembler post-processor, if such a program is
5361 needed.
5362
5363 @item %l
5364 Process the @code{link} spec.  This is the spec for computing the
5365 command line passed to the linker.  Typically it will make use of the
5366 @samp{%L %G %S %D and %E} sequences.
5367
5368 @item %D
5369 Dump out a @option{-L} option for each directory that GCC believes might
5370 contain startup files.  If the target supports multilibs then the
5371 current multilib directory will be prepended to each of these paths.
5372
5373 @item %M
5374 Output the multilib directory with directory separators replaced with
5375 @samp{_}.  If multilib directories are not set, or the multilib directory is
5376 @file{.} then this option emits nothing.
5377
5378 @item %L
5379 Process the @code{lib} spec.  This is a spec string for deciding which
5380 libraries should be included on the command line to the linker.
5381
5382 @item %G
5383 Process the @code{libgcc} spec.  This is a spec string for deciding
5384 which GCC support library should be included on the command line to the linker.
5385
5386 @item %S
5387 Process the @code{startfile} spec.  This is a spec for deciding which
5388 object files should be the first ones passed to the linker.  Typically
5389 this might be a file named @file{crt0.o}.
5390
5391 @item %E
5392 Process the @code{endfile} spec.  This is a spec string that specifies
5393 the last object files that will be passed to the linker.
5394
5395 @item %C
5396 Process the @code{cpp} spec.  This is used to construct the arguments
5397 to be passed to the C preprocessor.
5398
5399 @item %c
5400 Process the @code{signed_char} spec.  This is intended to be used
5401 to tell cpp whether a char is signed.  It typically has the definition:
5402 @smallexample
5403 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5404 @end smallexample
5405
5406 @item %1
5407 Process the @code{cc1} spec.  This is used to construct the options to be
5408 passed to the actual C compiler (@samp{cc1}).
5409
5410 @item %2
5411 Process the @code{cc1plus} spec.  This is used to construct the options to be
5412 passed to the actual C++ compiler (@samp{cc1plus}).
5413
5414 @item %*
5415 Substitute the variable part of a matched option.  See below.
5416 Note that each comma in the substituted string is replaced by
5417 a single space.
5418
5419 @item %<@code{S}
5420 Remove all occurrences of @code{-S} from the command line.  Note---this
5421 command is position dependent.  @samp{%} commands in the spec string
5422 before this one will see @code{-S}, @samp{%} commands in the spec string
5423 after this one will not.
5424
5425 @item %:@var{function}(@var{args})
5426 Call the named function @var{function}, passing it @var{args}.
5427 @var{args} is first processed as a nested spec string, then split
5428 into an argument vector in the usual fashion.  The function returns
5429 a string which is processed as if it had appeared literally as part
5430 of the current spec.
5431
5432 The following built-in spec functions are provided:
5433
5434 @table @code
5435 @item @code{if-exists}
5436 The @code{if-exists} spec function takes one argument, an absolute
5437 pathname to a file.  If the file exists, @code{if-exists} returns the
5438 pathname.  Here is a small example of its usage:
5439
5440 @smallexample
5441 *startfile:
5442 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5443 @end smallexample
5444
5445 @item @code{if-exists-else}
5446 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5447 spec function, except that it takes two arguments.  The first argument is
5448 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5449 returns the pathname.  If it does not exist, it returns the second argument.
5450 This way, @code{if-exists-else} can be used to select one file or another,
5451 based on the existence of the first.  Here is a small example of its usage:
5452
5453 @smallexample 
5454 *startfile:
5455 crt0%O%s %:if-exists(crti%O%s) \
5456 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5457 @end smallexample
5458 @end table 
5459
5460 @item %@{@code{S}@}
5461 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5462 If that switch was not specified, this substitutes nothing.  Note that
5463 the leading dash is omitted when specifying this option, and it is
5464 automatically inserted if the substitution is performed.  Thus the spec
5465 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5466 and would output the command line option @option{-foo}.
5467
5468 @item %W@{@code{S}@}
5469 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5470 deleted on failure.
5471
5472 @item %@{@code{S}*@}
5473 Substitutes all the switches specified to GCC whose names start
5474 with @code{-S}, but which also take an argument.  This is used for
5475 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5476 GCC considers @option{-o foo} as being
5477 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5478 text, including the space.  Thus two arguments would be generated.
5479
5480 @item %@{@code{S}*&@code{T}*@}
5481 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5482 (the order of @code{S} and @code{T} in the spec is not significant).
5483 There can be any number of ampersand-separated variables; for each the
5484 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5485
5486 @item %@{@code{S}:@code{X}@}
5487 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5488
5489 @item %@{!@code{S}:@code{X}@}
5490 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5491
5492 @item %@{@code{S}*:@code{X}@}
5493 Substitutes @code{X} if one or more switches whose names start with
5494 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5495 once, no matter how many such switches appeared.  However, if @code{%*}
5496 appears somewhere in @code{X}, then @code{X} will be substituted once
5497 for each matching switch, with the @code{%*} replaced by the part of
5498 that switch that matched the @code{*}.
5499
5500 @item %@{.@code{S}:@code{X}@}
5501 Substitutes @code{X}, if processing a file with suffix @code{S}.
5502
5503 @item %@{!.@code{S}:@code{X}@}
5504 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5505
5506 @item %@{@code{S}|@code{P}:@code{X}@}
5507 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5508 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5509 although they have a stronger binding than the @samp{|}.  If @code{%*}
5510 appears in @code{X}, all of the alternatives must be starred, and only
5511 the first matching alternative is substituted.
5512
5513 For example, a spec string like this:
5514
5515 @smallexample
5516 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5517 @end smallexample
5518
5519 will output the following command-line options from the following input
5520 command-line options:
5521
5522 @smallexample
5523 fred.c        -foo -baz
5524 jim.d         -bar -boggle
5525 -d fred.c     -foo -baz -boggle
5526 -d jim.d      -bar -baz -boggle
5527 @end smallexample
5528
5529 @item %@{S:X; T:Y; :D@}
5530
5531 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5532 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5533 be as many clauses as you need.  This may be combined with @code{.}, 
5534 @code{!}, @code{|}, and @code{*} as needed.
5535
5536
5537 @end table
5538
5539 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5540 construct may contain other nested @samp{%} constructs or spaces, or
5541 even newlines.  They are processed as usual, as described above.
5542 Trailing white space in @code{X} is ignored.  White space may also
5543 appear anywhere on the left side of the colon in these constructs,
5544 except between @code{.} or @code{*} and the corresponding word.
5545
5546 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5547 handled specifically in these constructs.  If another value of
5548 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5549 @option{-W} switch is found later in the command line, the earlier
5550 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5551 just one letter, which passes all matching options.
5552
5553 The character @samp{|} at the beginning of the predicate text is used to
5554 indicate that a command should be piped to the following command, but
5555 only if @option{-pipe} is specified.
5556
5557 It is built into GCC which switches take arguments and which do not.
5558 (You might think it would be useful to generalize this to allow each
5559 compiler's spec to say which switches take arguments.  But this cannot
5560 be done in a consistent fashion.  GCC cannot even decide which input
5561 files have been specified without knowing which switches take arguments,
5562 and it must know which input files to compile in order to tell which
5563 compilers to run).
5564
5565 GCC also knows implicitly that arguments starting in @option{-l} are to be
5566 treated as compiler output files, and passed to the linker in their
5567 proper position among the other output files.
5568
5569 @c man begin OPTIONS
5570
5571 @node Target Options
5572 @section Specifying Target Machine and Compiler Version
5573 @cindex target options
5574 @cindex cross compiling
5575 @cindex specifying machine version
5576 @cindex specifying compiler version and target machine
5577 @cindex compiler version, specifying
5578 @cindex target machine, specifying
5579
5580 The usual way to run GCC is to run the executable called @file{gcc}, or
5581 @file{<machine>-gcc} when cross-compiling, or
5582 @file{<machine>-gcc-<version>} to run a version other than the one that
5583 was installed last.  Sometimes this is inconvenient, so GCC provides
5584 options that will switch to another cross-compiler or version.
5585
5586 @table @gcctabopt
5587 @item -b @var{machine}
5588 @opindex b
5589 The argument @var{machine} specifies the target machine for compilation.
5590
5591 The value to use for @var{machine} is the same as was specified as the
5592 machine type when configuring GCC as a cross-compiler.  For
5593 example, if a cross-compiler was configured with @samp{configure
5594 i386v}, meaning to compile for an 80386 running System V, then you
5595 would specify @option{-b i386v} to run that cross compiler.
5596
5597 @item -V @var{version}
5598 @opindex V
5599 The argument @var{version} specifies which version of GCC to run.
5600 This is useful when multiple versions are installed.  For example,
5601 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5602 @end table
5603
5604 The @option{-V} and @option{-b} options work by running the
5605 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5606 use them if you can just run that directly.
5607
5608 @node Submodel Options
5609 @section Hardware Models and Configurations
5610 @cindex submodel options
5611 @cindex specifying hardware config
5612 @cindex hardware models and configurations, specifying
5613 @cindex machine dependent options
5614
5615 Earlier we discussed the standard option @option{-b} which chooses among
5616 different installed compilers for completely different target
5617 machines, such as VAX vs.@: 68000 vs.@: 80386.
5618
5619 In addition, each of these target machine types can have its own
5620 special options, starting with @samp{-m}, to choose among various
5621 hardware models or configurations---for example, 68010 vs 68020,
5622 floating coprocessor or none.  A single installed version of the
5623 compiler can compile for any model or configuration, according to the
5624 options specified.
5625
5626 Some configurations of the compiler also support additional special
5627 options, usually for compatibility with other compilers on the same
5628 platform.
5629
5630 These options are defined by the macro @code{TARGET_SWITCHES} in the
5631 machine description.  The default for the options is also defined by
5632 that macro, which enables you to change the defaults.
5633
5634 @menu
5635 * M680x0 Options::
5636 * M68hc1x Options::
5637 * VAX Options::
5638 * SPARC Options::
5639 * ARM Options::
5640 * MN10200 Options::
5641 * MN10300 Options::
5642 * M32R/D Options::
5643 * M88K Options::
5644 * RS/6000 and PowerPC Options::
5645 * Darwin Options::
5646 * RT Options::
5647 * MIPS Options::
5648 * i386 and x86-64 Options::
5649 * HPPA Options::
5650 * Intel 960 Options::
5651 * DEC Alpha Options::
5652 * DEC Alpha/VMS Options::
5653 * H8/300 Options::
5654 * SH Options::
5655 * System V Options::
5656 * TMS320C3x/C4x Options::
5657 * V850 Options::
5658 * ARC Options::
5659 * NS32K Options::
5660 * AVR Options::
5661 * MCore Options::
5662 * IA-64 Options::
5663 * D30V Options::
5664 * S/390 and zSeries Options::
5665 * CRIS Options::
5666 * MMIX Options::
5667 * PDP-11 Options::
5668 * Xstormy16 Options::
5669 * Xtensa Options::
5670 * FRV Options::
5671 @end menu
5672
5673 @node M680x0 Options
5674 @subsection M680x0 Options
5675 @cindex M680x0 options
5676
5677 These are the @samp{-m} options defined for the 68000 series.  The default
5678 values for these options depends on which style of 68000 was selected when
5679 the compiler was configured; the defaults for the most common choices are
5680 given below.
5681
5682 @table @gcctabopt
5683 @item -m68000
5684 @itemx -mc68000
5685 @opindex m68000
5686 @opindex mc68000
5687 Generate output for a 68000.  This is the default
5688 when the compiler is configured for 68000-based systems.
5689
5690 Use this option for microcontrollers with a 68000 or EC000 core,
5691 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5692
5693 @item -m68020
5694 @itemx -mc68020
5695 @opindex m68020
5696 @opindex mc68020
5697 Generate output for a 68020.  This is the default
5698 when the compiler is configured for 68020-based systems.
5699
5700 @item -m68881
5701 @opindex m68881
5702 Generate output containing 68881 instructions for floating point.
5703 This is the default for most 68020 systems unless @option{--nfp} was
5704 specified when the compiler was configured.
5705
5706 @item -m68030
5707 @opindex m68030
5708 Generate output for a 68030.  This is the default when the compiler is
5709 configured for 68030-based systems.
5710
5711 @item -m68040
5712 @opindex m68040
5713 Generate output for a 68040.  This is the default when the compiler is
5714 configured for 68040-based systems.
5715
5716 This option inhibits the use of 68881/68882 instructions that have to be
5717 emulated by software on the 68040.  Use this option if your 68040 does not
5718 have code to emulate those instructions.
5719
5720 @item -m68060
5721 @opindex m68060
5722 Generate output for a 68060.  This is the default when the compiler is
5723 configured for 68060-based systems.
5724
5725 This option inhibits the use of 68020 and 68881/68882 instructions that
5726 have to be emulated by software on the 68060.  Use this option if your 68060
5727 does not have code to emulate those instructions.
5728
5729 @item -mcpu32
5730 @opindex mcpu32
5731 Generate output for a CPU32.  This is the default
5732 when the compiler is configured for CPU32-based systems.
5733
5734 Use this option for microcontrollers with a
5735 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5736 68336, 68340, 68341, 68349 and 68360.
5737
5738 @item -m5200
5739 @opindex m5200
5740 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5741 when the compiler is configured for 520X-based systems.
5742
5743 Use this option for microcontroller with a 5200 core, including
5744 the MCF5202, MCF5203, MCF5204 and MCF5202.
5745
5746
5747 @item -m68020-40
5748 @opindex m68020-40
5749 Generate output for a 68040, without using any of the new instructions.
5750 This results in code which can run relatively efficiently on either a
5751 68020/68881 or a 68030 or a 68040.  The generated code does use the
5752 68881 instructions that are emulated on the 68040.
5753
5754 @item -m68020-60
5755 @opindex m68020-60
5756 Generate output for a 68060, without using any of the new instructions.
5757 This results in code which can run relatively efficiently on either a
5758 68020/68881 or a 68030 or a 68040.  The generated code does use the
5759 68881 instructions that are emulated on the 68060.
5760
5761 @item -msoft-float
5762 @opindex msoft-float
5763 Generate output containing library calls for floating point.
5764 @strong{Warning:} the requisite libraries are not available for all m68k
5765 targets.  Normally the facilities of the machine's usual C compiler are
5766 used, but this can't be done directly in cross-compilation.  You must
5767 make your own arrangements to provide suitable library functions for
5768 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5769 @samp{m68k-*-coff} do provide software floating point support.
5770
5771 @item -mshort
5772 @opindex mshort
5773 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5774
5775 @item -mnobitfield
5776 @opindex mnobitfield
5777 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5778 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5779
5780 @item -mbitfield
5781 @opindex mbitfield
5782 Do use the bit-field instructions.  The @option{-m68020} option implies
5783 @option{-mbitfield}.  This is the default if you use a configuration
5784 designed for a 68020.
5785
5786 @item -mrtd
5787 @opindex mrtd
5788 Use a different function-calling convention, in which functions
5789 that take a fixed number of arguments return with the @code{rtd}
5790 instruction, which pops their arguments while returning.  This
5791 saves one instruction in the caller since there is no need to pop
5792 the arguments there.
5793
5794 This calling convention is incompatible with the one normally
5795 used on Unix, so you cannot use it if you need to call libraries
5796 compiled with the Unix compiler.
5797
5798 Also, you must provide function prototypes for all functions that
5799 take variable numbers of arguments (including @code{printf});
5800 otherwise incorrect code will be generated for calls to those
5801 functions.
5802
5803 In addition, seriously incorrect code will result if you call a
5804 function with too many arguments.  (Normally, extra arguments are
5805 harmlessly ignored.)
5806
5807 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5808 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5809
5810 @item -malign-int
5811 @itemx -mno-align-int
5812 @opindex malign-int
5813 @opindex mno-align-int
5814 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5815 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5816 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5817 Aligning variables on 32-bit boundaries produces code that runs somewhat
5818 faster on processors with 32-bit busses at the expense of more memory.
5819
5820 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5821 align structures containing the above types  differently than
5822 most published application binary interface specifications for the m68k.
5823
5824 @item -mpcrel
5825 @opindex mpcrel
5826 Use the pc-relative addressing mode of the 68000 directly, instead of
5827 using a global offset table.  At present, this option implies @option{-fpic},
5828 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5829 not presently supported with @option{-mpcrel}, though this could be supported for
5830 68020 and higher processors.
5831
5832 @item -mno-strict-align
5833 @itemx -mstrict-align
5834 @opindex mno-strict-align
5835 @opindex mstrict-align
5836 Do not (do) assume that unaligned memory references will be handled by
5837 the system.
5838
5839 @end table
5840
5841 @node M68hc1x Options
5842 @subsection M68hc1x Options
5843 @cindex M68hc1x options
5844
5845 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5846 microcontrollers.  The default values for these options depends on
5847 which style of microcontroller was selected when the compiler was configured;
5848 the defaults for the most common choices are given below.
5849
5850 @table @gcctabopt
5851 @item -m6811
5852 @itemx -m68hc11
5853 @opindex m6811
5854 @opindex m68hc11
5855 Generate output for a 68HC11.  This is the default
5856 when the compiler is configured for 68HC11-based systems.
5857
5858 @item -m6812
5859 @itemx -m68hc12
5860 @opindex m6812
5861 @opindex m68hc12
5862 Generate output for a 68HC12.  This is the default
5863 when the compiler is configured for 68HC12-based systems.
5864
5865 @item -m68S12
5866 @itemx -m68hcs12
5867 @opindex m68S12
5868 @opindex m68hcs12
5869 Generate output for a 68HCS12.  
5870
5871 @item -mauto-incdec
5872 @opindex mauto-incdec
5873 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5874 addressing modes.
5875
5876 @item -minmax
5877 @itemx -nominmax
5878 @opindex minmax
5879 @opindex mnominmax
5880 Enable the use of 68HC12 min and max instructions.
5881
5882 @item -mlong-calls
5883 @itemx -mno-long-calls
5884 @opindex mlong-calls
5885 @opindex mno-long-calls
5886 Treat all calls as being far away (near).  If calls are assumed to be
5887 far away, the compiler will use the @code{call} instruction to
5888 call a function and the @code{rtc} instruction for returning.
5889
5890 @item -mshort
5891 @opindex mshort
5892 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5893
5894 @item -msoft-reg-count=@var{count}
5895 @opindex msoft-reg-count
5896 Specify the number of pseudo-soft registers which are used for the
5897 code generation.  The maximum number is 32.  Using more pseudo-soft
5898 register may or may not result in better code depending on the program.
5899 The default is 4 for 68HC11 and 2 for 68HC12.
5900
5901 @end table
5902
5903 @node VAX Options
5904 @subsection VAX Options
5905 @cindex VAX options
5906
5907 These @samp{-m} options are defined for the VAX:
5908
5909 @table @gcctabopt
5910 @item -munix
5911 @opindex munix
5912 Do not output certain jump instructions (@code{aobleq} and so on)
5913 that the Unix assembler for the VAX cannot handle across long
5914 ranges.
5915
5916 @item -mgnu
5917 @opindex mgnu
5918 Do output those jump instructions, on the assumption that you
5919 will assemble with the GNU assembler.
5920
5921 @item -mg
5922 @opindex mg
5923 Output code for g-format floating point numbers instead of d-format.
5924 @end table
5925
5926 @node SPARC Options
5927 @subsection SPARC Options
5928 @cindex SPARC options
5929
5930 These @samp{-m} switches are supported on the SPARC:
5931
5932 @table @gcctabopt
5933 @item -mno-app-regs
5934 @itemx -mapp-regs
5935 @opindex mno-app-regs
5936 @opindex mapp-regs
5937 Specify @option{-mapp-regs} to generate output using the global registers
5938 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5939 is the default.
5940
5941 To be fully SVR4 ABI compliant at the cost of some performance loss,
5942 specify @option{-mno-app-regs}.  You should compile libraries and system
5943 software with this option.
5944
5945 @item -mfpu
5946 @itemx -mhard-float
5947 @opindex mfpu
5948 @opindex mhard-float
5949 Generate output containing floating point instructions.  This is the
5950 default.
5951
5952 @item -mno-fpu
5953 @itemx -msoft-float
5954 @opindex mno-fpu
5955 @opindex msoft-float
5956 Generate output containing library calls for floating point.
5957 @strong{Warning:} the requisite libraries are not available for all SPARC
5958 targets.  Normally the facilities of the machine's usual C compiler are
5959 used, but this cannot be done directly in cross-compilation.  You must make
5960 your own arrangements to provide suitable library functions for
5961 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5962 @samp{sparclite-*-*} do provide software floating point support.
5963
5964 @option{-msoft-float} changes the calling convention in the output file;
5965 therefore, it is only useful if you compile @emph{all} of a program with
5966 this option.  In particular, you need to compile @file{libgcc.a}, the
5967 library that comes with GCC, with @option{-msoft-float} in order for
5968 this to work.
5969
5970 @item -mhard-quad-float
5971 @opindex mhard-quad-float
5972 Generate output containing quad-word (long double) floating point
5973 instructions.
5974
5975 @item -mimpure-text
5976 @opindex mimpure-text
5977 @option{-mimpure-text}, used in addition to @option{-shared}, tells
5978 the compiler to not pass @option{-z text} to the linker when linking a
5979 shared object.  Using this option, you can link position-dependent
5980 code into a shared object.  
5981
5982 @option{-mimpure-text} suppresses the ``relocations remain against
5983 allocatable but non-writable sections'' linker error message.
5984 However, the necessary relocations will trigger copy-on-write, and the
5985 shared object is not actually shared across processes.  Instead of
5986 using @option{-mimpure-text}, you should compile all source code with
5987 @option{-fpic} or @option{-fPIC}.
5988
5989 This option is only available on SunOS and Solaris.
5990
5991 @item -msoft-quad-float
5992 @opindex msoft-quad-float
5993 Generate output containing library calls for quad-word (long double)
5994 floating point instructions.  The functions called are those specified
5995 in the SPARC ABI@.  This is the default.
5996
5997 As of this writing, there are no sparc implementations that have hardware
5998 support for the quad-word floating point instructions.  They all invoke
5999 a trap handler for one of these instructions, and then the trap handler
6000 emulates the effect of the instruction.  Because of the trap handler overhead,
6001 this is much slower than calling the ABI library routines.  Thus the
6002 @option{-msoft-quad-float} option is the default.
6003
6004 @item -mno-flat
6005 @itemx -mflat
6006 @opindex mno-flat
6007 @opindex mflat
6008 With @option{-mflat}, the compiler does not generate save/restore instructions
6009 and will use a ``flat'' or single register window calling convention.
6010 This model uses %i7 as the frame pointer and is compatible with the normal
6011 register window model.  Code from either may be intermixed.
6012 The local registers and the input registers (0--5) are still treated as
6013 ``call saved'' registers and will be saved on the stack as necessary.
6014
6015 With @option{-mno-flat} (the default), the compiler emits save/restore
6016 instructions (except for leaf functions) and is the normal mode of operation.
6017
6018 @item -mno-unaligned-doubles
6019 @itemx -munaligned-doubles
6020 @opindex mno-unaligned-doubles
6021 @opindex munaligned-doubles
6022 Assume that doubles have 8 byte alignment.  This is the default.
6023
6024 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6025 alignment only if they are contained in another type, or if they have an
6026 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6027 Specifying this option avoids some rare compatibility problems with code
6028 generated by other compilers.  It is not the default because it results
6029 in a performance loss, especially for floating point code.
6030
6031 @item -mno-faster-structs
6032 @itemx -mfaster-structs
6033 @opindex mno-faster-structs
6034 @opindex mfaster-structs
6035 With @option{-mfaster-structs}, the compiler assumes that structures
6036 should have 8 byte alignment.  This enables the use of pairs of
6037 @code{ldd} and @code{std} instructions for copies in structure
6038 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6039 However, the use of this changed alignment directly violates the SPARC
6040 ABI@.  Thus, it's intended only for use on targets where the developer
6041 acknowledges that their resulting code will not be directly in line with
6042 the rules of the ABI@.
6043
6044 @item -mv8
6045 @itemx -msparclite
6046 @opindex mv8
6047 @opindex msparclite
6048 These two options select variations on the SPARC architecture.
6049
6050 By default (unless specifically configured for the Fujitsu SPARClite),
6051 GCC generates code for the v7 variant of the SPARC architecture.
6052
6053 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6054 code is that the compiler emits the integer multiply and integer
6055 divide instructions which exist in SPARC v8 but not in SPARC v7.
6056
6057 @option{-msparclite} will give you SPARClite code.  This adds the integer
6058 multiply, integer divide step and scan (@code{ffs}) instructions which
6059 exist in SPARClite but not in SPARC v7.
6060
6061 These options are deprecated and will be deleted in a future GCC release.
6062 They have been replaced with @option{-mcpu=xxx}.
6063
6064 @item -mcypress
6065 @itemx -msupersparc
6066 @opindex mcypress
6067 @opindex msupersparc
6068 These two options select the processor for which the code is optimized.
6069
6070 With @option{-mcypress} (the default), the compiler optimizes code for the
6071 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6072 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6073
6074 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6075 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6076 of the full SPARC v8 instruction set.
6077
6078 These options are deprecated and will be deleted in a future GCC release.
6079 They have been replaced with @option{-mcpu=xxx}.
6080
6081 @item -mcpu=@var{cpu_type}
6082 @opindex mcpu
6083 Set the instruction set, register set, and instruction scheduling parameters
6084 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6085 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6086 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6087 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6088 @samp{ultrasparc3}.
6089
6090 Default instruction scheduling parameters are used for values that select
6091 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6092 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6093
6094 Here is a list of each supported architecture and their supported
6095 implementations.
6096
6097 @smallexample
6098     v7:             cypress
6099     v8:             supersparc, hypersparc
6100     sparclite:      f930, f934, sparclite86x
6101     sparclet:       tsc701
6102     v9:             ultrasparc, ultrasparc3
6103 @end smallexample
6104
6105 @item -mtune=@var{cpu_type}
6106 @opindex mtune
6107 Set the instruction scheduling parameters for machine type
6108 @var{cpu_type}, but do not set the instruction set or register set that the
6109 option @option{-mcpu=@var{cpu_type}} would.
6110
6111 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6112 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6113 that select a particular cpu implementation.  Those are @samp{cypress},
6114 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6115 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6116 @samp{ultrasparc3}.
6117
6118 @end table
6119
6120 These @samp{-m} switches are supported in addition to the above
6121 on the SPARCLET processor.
6122
6123 @table @gcctabopt
6124 @item -mlittle-endian
6125 @opindex mlittle-endian
6126 Generate code for a processor running in little-endian mode.
6127
6128 @item -mlive-g0
6129 @opindex mlive-g0
6130 Treat register @code{%g0} as a normal register.
6131 GCC will continue to clobber it as necessary but will not assume
6132 it always reads as 0.
6133
6134 @item -mbroken-saverestore
6135 @opindex mbroken-saverestore
6136 Generate code that does not use non-trivial forms of the @code{save} and
6137 @code{restore} instructions.  Early versions of the SPARCLET processor do
6138 not correctly handle @code{save} and @code{restore} instructions used with
6139 arguments.  They correctly handle them used without arguments.  A @code{save}
6140 instruction used without arguments increments the current window pointer
6141 but does not allocate a new stack frame.  It is assumed that the window
6142 overflow trap handler will properly handle this case as will interrupt
6143 handlers.
6144 @end table
6145
6146 These @samp{-m} switches are supported in addition to the above
6147 on SPARC V9 processors in 64-bit environments.
6148
6149 @table @gcctabopt
6150 @item -mlittle-endian
6151 @opindex mlittle-endian
6152 Generate code for a processor running in little-endian mode.
6153
6154 @item -m32
6155 @itemx -m64
6156 @opindex m32
6157 @opindex m64
6158 Generate code for a 32-bit or 64-bit environment.
6159 The 32-bit environment sets int, long and pointer to 32 bits.
6160 The 64-bit environment sets int to 32 bits and long and pointer
6161 to 64 bits.
6162
6163 @item -mcmodel=medlow
6164 @opindex mcmodel=medlow
6165 Generate code for the Medium/Low code model: the program must be linked
6166 in the low 32 bits of the address space.  Pointers are 64 bits.
6167 Programs can be statically or dynamically linked.
6168
6169 @item -mcmodel=medmid
6170 @opindex mcmodel=medmid
6171 Generate code for the Medium/Middle code model: the program must be linked
6172 in the low 44 bits of the address space, the text segment must be less than
6173 2G bytes, and data segment must be within 2G of the text segment.
6174 Pointers are 64 bits.
6175
6176 @item -mcmodel=medany
6177 @opindex mcmodel=medany
6178 Generate code for the Medium/Anywhere code model: the program may be linked
6179 anywhere in the address space, the text segment must be less than
6180 2G bytes, and data segment must be within 2G of the text segment.
6181 Pointers are 64 bits.
6182
6183 @item -mcmodel=embmedany
6184 @opindex mcmodel=embmedany
6185 Generate code for the Medium/Anywhere code model for embedded systems:
6186 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6187 (determined at link time).  Register %g4 points to the base of the
6188 data segment.  Pointers are still 64 bits.
6189 Programs are statically linked, PIC is not supported.
6190
6191 @item -mstack-bias
6192 @itemx -mno-stack-bias
6193 @opindex mstack-bias
6194 @opindex mno-stack-bias
6195 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6196 frame pointer if present, are offset by @minus{}2047 which must be added back
6197 when making stack frame references.
6198 Otherwise, assume no such offset is present.
6199 @end table
6200
6201 @node ARM Options
6202 @subsection ARM Options
6203 @cindex ARM options
6204
6205 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6206 architectures:
6207
6208 @table @gcctabopt
6209 @item -mapcs-frame
6210 @opindex mapcs-frame
6211 Generate a stack frame that is compliant with the ARM Procedure Call
6212 Standard for all functions, even if this is not strictly necessary for
6213 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6214 with this option will cause the stack frames not to be generated for
6215 leaf functions.  The default is @option{-mno-apcs-frame}.
6216
6217 @item -mapcs
6218 @opindex mapcs
6219 This is a synonym for @option{-mapcs-frame}.
6220
6221 @item -mapcs-26
6222 @opindex mapcs-26
6223 Generate code for a processor running with a 26-bit program counter,
6224 and conforming to the function calling standards for the APCS 26-bit
6225 option.  This option replaces the @option{-m2} and @option{-m3} options
6226 of previous releases of the compiler.
6227
6228 @item -mapcs-32
6229 @opindex mapcs-32
6230 Generate code for a processor running with a 32-bit program counter,
6231 and conforming to the function calling standards for the APCS 32-bit
6232 option.  This option replaces the @option{-m6} option of previous releases
6233 of the compiler.
6234
6235 @ignore
6236 @c not currently implemented
6237 @item -mapcs-stack-check
6238 @opindex mapcs-stack-check
6239 Generate code to check the amount of stack space available upon entry to
6240 every function (that actually uses some stack space).  If there is
6241 insufficient space available then either the function
6242 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6243 called, depending upon the amount of stack space required.  The run time
6244 system is required to provide these functions.  The default is
6245 @option{-mno-apcs-stack-check}, since this produces smaller code.
6246
6247 @c not currently implemented
6248 @item -mapcs-float
6249 @opindex mapcs-float
6250 Pass floating point arguments using the float point registers.  This is
6251 one of the variants of the APCS@.  This option is recommended if the
6252 target hardware has a floating point unit or if a lot of floating point
6253 arithmetic is going to be performed by the code.  The default is
6254 @option{-mno-apcs-float}, since integer only code is slightly increased in
6255 size if @option{-mapcs-float} is used.
6256
6257 @c not currently implemented
6258 @item -mapcs-reentrant
6259 @opindex mapcs-reentrant
6260 Generate reentrant, position independent code.  The default is
6261 @option{-mno-apcs-reentrant}.
6262 @end ignore
6263
6264 @item -mthumb-interwork
6265 @opindex mthumb-interwork
6266 Generate code which supports calling between the ARM and Thumb
6267 instruction sets.  Without this option the two instruction sets cannot
6268 be reliably used inside one program.  The default is
6269 @option{-mno-thumb-interwork}, since slightly larger code is generated
6270 when @option{-mthumb-interwork} is specified.
6271
6272 @item -mno-sched-prolog
6273 @opindex mno-sched-prolog
6274 Prevent the reordering of instructions in the function prolog, or the
6275 merging of those instruction with the instructions in the function's
6276 body.  This means that all functions will start with a recognizable set
6277 of instructions (or in fact one of a choice from a small set of
6278 different function prologues), and this information can be used to
6279 locate the start if functions inside an executable piece of code.  The
6280 default is @option{-msched-prolog}.
6281
6282 @item -mhard-float
6283 @opindex mhard-float
6284 Generate output containing floating point instructions.  This is the
6285 default.
6286
6287 @item -msoft-float
6288 @opindex msoft-float
6289 Generate output containing library calls for floating point.
6290 @strong{Warning:} the requisite libraries are not available for all ARM
6291 targets.  Normally the facilities of the machine's usual C compiler are
6292 used, but this cannot be done directly in cross-compilation.  You must make
6293 your own arrangements to provide suitable library functions for
6294 cross-compilation.
6295
6296 @option{-msoft-float} changes the calling convention in the output file;
6297 therefore, it is only useful if you compile @emph{all} of a program with
6298 this option.  In particular, you need to compile @file{libgcc.a}, the
6299 library that comes with GCC, with @option{-msoft-float} in order for
6300 this to work.
6301
6302 @item -mlittle-endian
6303 @opindex mlittle-endian
6304 Generate code for a processor running in little-endian mode.  This is
6305 the default for all standard configurations.
6306
6307 @item -mbig-endian
6308 @opindex mbig-endian
6309 Generate code for a processor running in big-endian mode; the default is
6310 to compile code for a little-endian processor.
6311
6312 @item -mwords-little-endian
6313 @opindex mwords-little-endian
6314 This option only applies when generating code for big-endian processors.
6315 Generate code for a little-endian word order but a big-endian byte
6316 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6317 option should only be used if you require compatibility with code for
6318 big-endian ARM processors generated by versions of the compiler prior to
6319 2.8.
6320
6321 @item -malignment-traps
6322 @opindex malignment-traps
6323 Generate code that will not trap if the MMU has alignment traps enabled.
6324 On ARM architectures prior to ARMv4, there were no instructions to
6325 access half-word objects stored in memory.  However, when reading from
6326 memory a feature of the ARM architecture allows a word load to be used,
6327 even if the address is unaligned, and the processor core will rotate the
6328 data as it is being loaded.  This option tells the compiler that such
6329 misaligned accesses will cause a MMU trap and that it should instead
6330 synthesize the access as a series of byte accesses.  The compiler can
6331 still use word accesses to load half-word data if it knows that the
6332 address is aligned to a word boundary.
6333
6334 This option is ignored when compiling for ARM architecture 4 or later,
6335 since these processors have instructions to directly access half-word
6336 objects in memory.
6337
6338 @item -mno-alignment-traps
6339 @opindex mno-alignment-traps
6340 Generate code that assumes that the MMU will not trap unaligned
6341 accesses.  This produces better code when the target instruction set
6342 does not have half-word memory operations (i.e.@: implementations prior to
6343 ARMv4).
6344
6345 Note that you cannot use this option to access unaligned word objects,
6346 since the processor will only fetch one 32-bit aligned object from
6347 memory.
6348
6349 The default setting for most targets is @option{-mno-alignment-traps}, since
6350 this produces better code when there are no half-word memory
6351 instructions available.
6352
6353 @item -mshort-load-bytes
6354 @itemx -mno-short-load-words
6355 @opindex mshort-load-bytes
6356 @opindex mno-short-load-words
6357 These are deprecated aliases for @option{-malignment-traps}.
6358
6359 @item -mno-short-load-bytes
6360 @itemx -mshort-load-words
6361 @opindex mno-short-load-bytes
6362 @opindex mshort-load-words
6363 This are deprecated aliases for @option{-mno-alignment-traps}.
6364
6365 @item -mcpu=@var{name}
6366 @opindex mcpu
6367 This specifies the name of the target ARM processor.  GCC uses this name
6368 to determine what kind of instructions it can emit when generating
6369 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6370 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6371 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6372 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6373 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6374 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6375 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6376 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6377 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6378 @samp{arm1020t}, @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
6379
6380 @itemx -mtune=@var{name}
6381 @opindex mtune
6382 This option is very similar to the @option{-mcpu=} option, except that
6383 instead of specifying the actual target processor type, and hence
6384 restricting which instructions can be used, it specifies that GCC should
6385 tune the performance of the code as if the target were of the type
6386 specified in this option, but still choosing the instructions that it
6387 will generate based on the cpu specified by a @option{-mcpu=} option.
6388 For some ARM implementations better performance can be obtained by using
6389 this option.
6390
6391 @item -march=@var{name}
6392 @opindex march
6393 This specifies the name of the target ARM architecture.  GCC uses this
6394 name to determine what kind of instructions it can emit when generating
6395 assembly code.  This option can be used in conjunction with or instead
6396 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6397 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6398 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{iwmmxt}, @samp{ep9312}.
6399
6400 @item -mfpe=@var{number}
6401 @itemx -mfp=@var{number}
6402 @opindex mfpe
6403 @opindex mfp
6404 This specifies the version of the floating point emulation available on
6405 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6406 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6407
6408 @item -mstructure-size-boundary=@var{n}
6409 @opindex mstructure-size-boundary
6410 The size of all structures and unions will be rounded up to a multiple
6411 of the number of bits set by this option.  Permissible values are 8 and
6412 32.  The default value varies for different toolchains.  For the COFF
6413 targeted toolchain the default value is 8.  Specifying the larger number
6414 can produce faster, more efficient code, but can also increase the size
6415 of the program.  The two values are potentially incompatible.  Code
6416 compiled with one value cannot necessarily expect to work with code or
6417 libraries compiled with the other value, if they exchange information
6418 using structures or unions.
6419
6420 @item -mabort-on-noreturn
6421 @opindex mabort-on-noreturn
6422 Generate a call to the function @code{abort} at the end of a
6423 @code{noreturn} function.  It will be executed if the function tries to
6424 return.
6425
6426 @item -mlong-calls
6427 @itemx -mno-long-calls
6428 @opindex mlong-calls
6429 @opindex mno-long-calls
6430 Tells the compiler to perform function calls by first loading the
6431 address of the function into a register and then performing a subroutine
6432 call on this register.  This switch is needed if the target function
6433 will lie outside of the 64 megabyte addressing range of the offset based
6434 version of subroutine call instruction.
6435
6436 Even if this switch is enabled, not all function calls will be turned
6437 into long calls.  The heuristic is that static functions, functions
6438 which have the @samp{short-call} attribute, functions that are inside
6439 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6440 definitions have already been compiled within the current compilation
6441 unit, will not be turned into long calls.  The exception to this rule is
6442 that weak function definitions, functions with the @samp{long-call}
6443 attribute or the @samp{section} attribute, and functions that are within
6444 the scope of a @samp{#pragma long_calls} directive, will always be
6445 turned into long calls.
6446
6447 This feature is not enabled by default.  Specifying
6448 @option{-mno-long-calls} will restore the default behavior, as will
6449 placing the function calls within the scope of a @samp{#pragma
6450 long_calls_off} directive.  Note these switches have no effect on how
6451 the compiler generates code to handle function calls via function
6452 pointers.
6453
6454 @item -mnop-fun-dllimport
6455 @opindex mnop-fun-dllimport
6456 Disable support for the @code{dllimport} attribute.
6457
6458 @item -msingle-pic-base
6459 @opindex msingle-pic-base
6460 Treat the register used for PIC addressing as read-only, rather than
6461 loading it in the prologue for each function.  The run-time system is
6462 responsible for initializing this register with an appropriate value
6463 before execution begins.
6464
6465 @item -mpic-register=@var{reg}
6466 @opindex mpic-register
6467 Specify the register to be used for PIC addressing.  The default is R10
6468 unless stack-checking is enabled, when R9 is used.
6469
6470 @item -mcirrus-fix-invalid-insns
6471 @opindex mcirrus-fix-invalid-insns
6472 @opindex mno-cirrus-fix-invalid-insns
6473 Insert NOPs into the instruction stream to in order to work around
6474 problems with invalid Maverick instruction combinations.  This option
6475 is only valid if the @option{-mcpu=ep9312} option has been used to
6476 enable generation of instructions for the Cirrus Maverick floating
6477 point co-processor.  This option is not enabled by default, since the
6478 problem is only present in older Maverick implementations.  The default
6479 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6480 switch.
6481
6482 @item -mpoke-function-name
6483 @opindex mpoke-function-name
6484 Write the name of each function into the text section, directly
6485 preceding the function prologue.  The generated code is similar to this:
6486
6487 @smallexample
6488      t0
6489          .ascii "arm_poke_function_name", 0
6490          .align
6491      t1
6492          .word 0xff000000 + (t1 - t0)
6493      arm_poke_function_name
6494          mov     ip, sp
6495          stmfd   sp!, @{fp, ip, lr, pc@}
6496          sub     fp, ip, #4
6497 @end smallexample
6498
6499 When performing a stack backtrace, code can inspect the value of
6500 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6501 location @code{pc - 12} and the top 8 bits are set, then we know that
6502 there is a function name embedded immediately preceding this location
6503 and has length @code{((pc[-3]) & 0xff000000)}.
6504
6505 @item -mthumb
6506 @opindex mthumb
6507 Generate code for the 16-bit Thumb instruction set.  The default is to
6508 use the 32-bit ARM instruction set.
6509
6510 @item -mtpcs-frame
6511 @opindex mtpcs-frame
6512 Generate a stack frame that is compliant with the Thumb Procedure Call
6513 Standard for all non-leaf functions.  (A leaf function is one that does
6514 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6515
6516 @item -mtpcs-leaf-frame
6517 @opindex mtpcs-leaf-frame
6518 Generate a stack frame that is compliant with the Thumb Procedure Call
6519 Standard for all leaf functions.  (A leaf function is one that does
6520 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6521
6522 @item -mcallee-super-interworking
6523 @opindex mcallee-super-interworking
6524 Gives all externally visible functions in the file being compiled an ARM
6525 instruction set header which switches to Thumb mode before executing the
6526 rest of the function.  This allows these functions to be called from
6527 non-interworking code.
6528
6529 @item -mcaller-super-interworking
6530 @opindex mcaller-super-interworking
6531 Allows calls via function pointers (including virtual functions) to
6532 execute correctly regardless of whether the target code has been
6533 compiled for interworking or not.  There is a small overhead in the cost
6534 of executing a function pointer if this option is enabled.
6535
6536 @end table
6537
6538 @node MN10200 Options
6539 @subsection MN10200 Options
6540 @cindex MN10200 options
6541
6542 These @option{-m} options are defined for Matsushita MN10200 architectures:
6543 @table @gcctabopt
6544
6545 @item -mrelax
6546 @opindex mrelax
6547 Indicate to the linker that it should perform a relaxation optimization pass
6548 to shorten branches, calls and absolute memory addresses.  This option only
6549 has an effect when used on the command line for the final link step.
6550
6551 This option makes symbolic debugging impossible.
6552 @end table
6553
6554 @node MN10300 Options
6555 @subsection MN10300 Options
6556 @cindex MN10300 options
6557
6558 These @option{-m} options are defined for Matsushita MN10300 architectures:
6559
6560 @table @gcctabopt
6561 @item -mmult-bug
6562 @opindex mmult-bug
6563 Generate code to avoid bugs in the multiply instructions for the MN10300
6564 processors.  This is the default.
6565
6566 @item -mno-mult-bug
6567 @opindex mno-mult-bug
6568 Do not generate code to avoid bugs in the multiply instructions for the
6569 MN10300 processors.
6570
6571 @item -mam33
6572 @opindex mam33
6573 Generate code which uses features specific to the AM33 processor.
6574
6575 @item -mno-am33
6576 @opindex mno-am33
6577 Do not generate code which uses features specific to the AM33 processor.  This
6578 is the default.
6579
6580 @item -mno-crt0
6581 @opindex mno-crt0
6582 Do not link in the C run-time initialization object file.
6583
6584 @item -mrelax
6585 @opindex mrelax
6586 Indicate to the linker that it should perform a relaxation optimization pass
6587 to shorten branches, calls and absolute memory addresses.  This option only
6588 has an effect when used on the command line for the final link step.
6589
6590 This option makes symbolic debugging impossible.
6591 @end table
6592
6593
6594 @node M32R/D Options
6595 @subsection M32R/D Options
6596 @cindex M32R/D options
6597
6598 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6599
6600 @table @gcctabopt
6601 @item -m32rx
6602 @opindex m32rx
6603 Generate code for the M32R/X@.
6604
6605 @item -m32r
6606 @opindex m32r
6607 Generate code for the M32R@.  This is the default.
6608
6609 @item -mcode-model=small
6610 @opindex mcode-model=small
6611 Assume all objects live in the lower 16MB of memory (so that their addresses
6612 can be loaded with the @code{ld24} instruction), and assume all subroutines
6613 are reachable with the @code{bl} instruction.
6614 This is the default.
6615
6616 The addressability of a particular object can be set with the
6617 @code{model} attribute.
6618
6619 @item -mcode-model=medium
6620 @opindex mcode-model=medium
6621 Assume objects may be anywhere in the 32-bit address space (the compiler
6622 will generate @code{seth/add3} instructions to load their addresses), and
6623 assume all subroutines are reachable with the @code{bl} instruction.
6624
6625 @item -mcode-model=large
6626 @opindex mcode-model=large
6627 Assume objects may be anywhere in the 32-bit address space (the compiler
6628 will generate @code{seth/add3} instructions to load their addresses), and
6629 assume subroutines may not be reachable with the @code{bl} instruction
6630 (the compiler will generate the much slower @code{seth/add3/jl}
6631 instruction sequence).
6632
6633 @item -msdata=none
6634 @opindex msdata=none
6635 Disable use of the small data area.  Variables will be put into
6636 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6637 @code{section} attribute has been specified).
6638 This is the default.
6639
6640 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6641 Objects may be explicitly put in the small data area with the
6642 @code{section} attribute using one of these sections.
6643
6644 @item -msdata=sdata
6645 @opindex msdata=sdata
6646 Put small global and static data in the small data area, but do not
6647 generate special code to reference them.
6648
6649 @item -msdata=use
6650 @opindex msdata=use
6651 Put small global and static data in the small data area, and generate
6652 special instructions to reference them.
6653
6654 @item -G @var{num}
6655 @opindex G
6656 @cindex smaller data references
6657 Put global and static objects less than or equal to @var{num} bytes
6658 into the small data or bss sections instead of the normal data or bss
6659 sections.  The default value of @var{num} is 8.
6660 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6661 for this option to have any effect.
6662
6663 All modules should be compiled with the same @option{-G @var{num}} value.
6664 Compiling with different values of @var{num} may or may not work; if it
6665 doesn't the linker will give an error message---incorrect code will not be
6666 generated.
6667
6668 @end table
6669
6670 @node M88K Options
6671 @subsection M88K Options
6672 @cindex M88k options
6673
6674 These @samp{-m} options are defined for Motorola 88k architectures:
6675
6676 @table @gcctabopt
6677 @item -m88000
6678 @opindex m88000
6679 Generate code that works well on both the m88100 and the
6680 m88110.
6681
6682 @item -m88100
6683 @opindex m88100
6684 Generate code that works best for the m88100, but that also
6685 runs on the m88110.
6686
6687 @item -m88110
6688 @opindex m88110
6689 Generate code that works best for the m88110, and may not run
6690 on the m88100.
6691
6692 @item -mbig-pic
6693 @opindex mbig-pic
6694 Obsolete option to be removed from the next revision.
6695 Use @option{-fPIC}.
6696
6697 @item -midentify-revision
6698 @opindex midentify-revision
6699 @cindex identifying source, compiler (88k)
6700 Include an @code{ident} directive in the assembler output recording the
6701 source file name, compiler name and version, timestamp, and compilation
6702 flags used.
6703
6704 @item -mno-underscores
6705 @opindex mno-underscores
6706 @cindex underscores, avoiding (88k)
6707 In assembler output, emit symbol names without adding an underscore
6708 character at the beginning of each name.  The default is to use an
6709 underscore as prefix on each name.
6710
6711 @item -mocs-debug-info
6712 @itemx -mno-ocs-debug-info
6713 @opindex mocs-debug-info
6714 @opindex mno-ocs-debug-info
6715 @cindex OCS (88k)
6716 @cindex debugging, 88k OCS
6717 Include (or omit) additional debugging information (about registers used
6718 in each stack frame) as specified in the 88open Object Compatibility
6719 Standard, ``OCS''@.  This extra information allows debugging of code that
6720 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6721 SVr3.2 is to include this information; other 88k configurations omit this
6722 information by default.
6723
6724 @item -mocs-frame-position
6725 @opindex mocs-frame-position
6726 @cindex register positions in frame (88k)
6727 When emitting COFF debugging information for automatic variables and
6728 parameters stored on the stack, use the offset from the canonical frame
6729 address, which is the stack pointer (register 31) on entry to the
6730 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6731 @option{-mocs-frame-position}; other 88k configurations have the default
6732 @option{-mno-ocs-frame-position}.
6733
6734 @item -mno-ocs-frame-position
6735 @opindex mno-ocs-frame-position
6736 @cindex register positions in frame (88k)
6737 When emitting COFF debugging information for automatic variables and
6738 parameters stored on the stack, use the offset from the frame pointer
6739 register (register 30).  When this option is in effect, the frame
6740 pointer is not eliminated when debugging information is selected by the
6741 -g switch.
6742
6743 @item -moptimize-arg-area
6744 @opindex moptimize-arg-area
6745 @cindex arguments in frame (88k)
6746 Save space by reorganizing the stack frame.  This option generates code
6747 that does not agree with the 88open specifications, but uses less
6748 memory.
6749
6750 @itemx -mno-optimize-arg-area
6751 @opindex mno-optimize-arg-area
6752 Do not reorganize the stack frame to save space.  This is the default.
6753 The generated conforms to the specification, but uses more memory.
6754
6755 @item -mshort-data-@var{num}
6756 @opindex mshort-data
6757 @cindex smaller data references (88k)
6758 @cindex r0-relative references (88k)
6759 Generate smaller data references by making them relative to @code{r0},
6760 which allows loading a value using a single instruction (rather than the
6761 usual two).  You control which data references are affected by
6762 specifying @var{num} with this option.  For example, if you specify
6763 @option{-mshort-data-512}, then the data references affected are those
6764 involving displacements of less than 512 bytes.
6765 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6766 than 64k.
6767
6768 @item -mserialize-volatile
6769 @opindex mserialize-volatile
6770 @itemx -mno-serialize-volatile
6771 @opindex mno-serialize-volatile
6772 @cindex sequential consistency on 88k
6773 Do, or don't, generate code to guarantee sequential consistency
6774 of volatile memory references.  By default, consistency is
6775 guaranteed.
6776
6777 The order of memory references made by the MC88110 processor does
6778 not always match the order of the instructions requesting those
6779 references.  In particular, a load instruction may execute before
6780 a preceding store instruction.  Such reordering violates
6781 sequential consistency of volatile memory references, when there
6782 are multiple processors.   When consistency must be guaranteed,
6783 GCC generates special instructions, as needed, to force
6784 execution in the proper order.
6785
6786 The MC88100 processor does not reorder memory references and so
6787 always provides sequential consistency.  However, by default, GCC
6788 generates the special instructions to guarantee consistency
6789 even when you use @option{-m88100}, so that the code may be run on an
6790 MC88110 processor.  If you intend to run your code only on the
6791 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6792
6793 The extra code generated to guarantee consistency may affect the
6794 performance of your application.  If you know that you can safely
6795 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6796
6797 @item -msvr4
6798 @itemx -msvr3
6799 @opindex msvr4
6800 @opindex msvr3
6801 @cindex assembler syntax, 88k
6802 @cindex SVr4
6803 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6804 related to System V release 4 (SVr4).  This controls the following:
6805
6806 @enumerate
6807 @item
6808 Which variant of the assembler syntax to emit.
6809 @item
6810 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6811 that is used on System V release 4.
6812 @item
6813 @option{-msvr4} makes GCC issue additional declaration directives used in
6814 SVr4.
6815 @end enumerate
6816
6817 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6818 @option{-msvr3} is the default for all other m88k configurations.
6819
6820 @item -mversion-03.00
6821 @opindex mversion-03.00
6822 This option is obsolete, and is ignored.
6823 @c ??? which asm syntax better for GAS?  option there too?
6824
6825 @item -mno-check-zero-division
6826 @itemx -mcheck-zero-division
6827 @opindex mno-check-zero-division
6828 @opindex mcheck-zero-division
6829 @cindex zero division on 88k
6830 Do, or don't, generate code to guarantee that integer division by
6831 zero will be detected.  By default, detection is guaranteed.
6832
6833 Some models of the MC88100 processor fail to trap upon integer
6834 division by zero under certain conditions.  By default, when
6835 compiling code that might be run on such a processor, GCC
6836 generates code that explicitly checks for zero-valued divisors
6837 and traps with exception number 503 when one is detected.  Use of
6838 @option{-mno-check-zero-division} suppresses such checking for code
6839 generated to run on an MC88100 processor.
6840
6841 GCC assumes that the MC88110 processor correctly detects all instances
6842 of integer division by zero.  When @option{-m88110} is specified, no
6843 explicit checks for zero-valued divisors are generated, and both
6844 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6845 ignored.
6846
6847 @item -muse-div-instruction
6848 @opindex muse-div-instruction
6849 @cindex divide instruction, 88k
6850 Use the div instruction for signed integer division on the
6851 MC88100 processor.  By default, the div instruction is not used.
6852
6853 On the MC88100 processor the signed integer division instruction
6854 div) traps to the operating system on a negative operand.  The
6855 operating system transparently completes the operation, but at a
6856 large cost in execution time.  By default, when compiling code
6857 that might be run on an MC88100 processor, GCC emulates signed
6858 integer division using the unsigned integer division instruction
6859 divu), thereby avoiding the large penalty of a trap to the
6860 operating system.  Such emulation has its own, smaller, execution
6861 cost in both time and space.  To the extent that your code's
6862 important signed integer division operations are performed on two
6863 nonnegative operands, it may be desirable to use the div
6864 instruction directly.
6865
6866 On the MC88110 processor the div instruction (also known as the
6867 divs instruction) processes negative operands without trapping to
6868 the operating system.  When @option{-m88110} is specified,
6869 @option{-muse-div-instruction} is ignored, and the div instruction is used
6870 for signed integer division.
6871
6872 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6873 particular, the behavior of such a division with and without
6874 @option{-muse-div-instruction} may differ.
6875
6876 @item -mtrap-large-shift
6877 @itemx -mhandle-large-shift
6878 @opindex mtrap-large-shift
6879 @opindex mhandle-large-shift
6880 @cindex bit shift overflow (88k)
6881 @cindex large bit shifts (88k)
6882 Include code to detect bit-shifts of more than 31 bits; respectively,
6883 trap such shifts or emit code to handle them properly.  By default GCC
6884 makes no special provision for large bit shifts.
6885
6886 @item -mwarn-passed-structs
6887 @opindex mwarn-passed-structs
6888 @cindex structure passing (88k)
6889 Warn when a function passes a struct as an argument or result.
6890 Structure-passing conventions have changed during the evolution of the C
6891 language, and are often the source of portability problems.  By default,
6892 GCC issues no such warning.
6893 @end table
6894
6895 @c break page here to avoid unsightly interparagraph stretch.
6896 @c -zw, 2001-8-17
6897 @page
6898
6899 @node RS/6000 and PowerPC Options
6900 @subsection IBM RS/6000 and PowerPC Options
6901 @cindex RS/6000 and PowerPC Options
6902 @cindex IBM RS/6000 and PowerPC Options
6903
6904 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6905 @table @gcctabopt
6906 @item -mpower
6907 @itemx -mno-power
6908 @itemx -mpower2
6909 @itemx -mno-power2
6910 @itemx -mpowerpc
6911 @itemx -mno-powerpc
6912 @itemx -mpowerpc-gpopt
6913 @itemx -mno-powerpc-gpopt
6914 @itemx -mpowerpc-gfxopt
6915 @itemx -mno-powerpc-gfxopt
6916 @itemx -mpowerpc64
6917 @itemx -mno-powerpc64
6918 @opindex mpower
6919 @opindex mno-power
6920 @opindex mpower2
6921 @opindex mno-power2
6922 @opindex mpowerpc
6923 @opindex mno-powerpc
6924 @opindex mpowerpc-gpopt
6925 @opindex mno-powerpc-gpopt
6926 @opindex mpowerpc-gfxopt
6927 @opindex mno-powerpc-gfxopt
6928 @opindex mpowerpc64
6929 @opindex mno-powerpc64
6930 GCC supports two related instruction set architectures for the
6931 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6932 instructions supported by the @samp{rios} chip set used in the original
6933 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6934 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6935 the IBM 4xx microprocessors.
6936
6937 Neither architecture is a subset of the other.  However there is a
6938 large common subset of instructions supported by both.  An MQ
6939 register is included in processors supporting the POWER architecture.
6940
6941 You use these options to specify which instructions are available on the
6942 processor you are using.  The default value of these options is
6943 determined when configuring GCC@.  Specifying the
6944 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6945 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6946 rather than the options listed above.
6947
6948 The @option{-mpower} option allows GCC to generate instructions that
6949 are found only in the POWER architecture and to use the MQ register.
6950 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6951 to generate instructions that are present in the POWER2 architecture but
6952 not the original POWER architecture.
6953
6954 The @option{-mpowerpc} option allows GCC to generate instructions that
6955 are found only in the 32-bit subset of the PowerPC architecture.
6956 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6957 GCC to use the optional PowerPC architecture instructions in the
6958 General Purpose group, including floating-point square root.  Specifying
6959 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6960 use the optional PowerPC architecture instructions in the Graphics
6961 group, including floating-point select.
6962
6963 The @option{-mpowerpc64} option allows GCC to generate the additional
6964 64-bit instructions that are found in the full PowerPC64 architecture
6965 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6966 @option{-mno-powerpc64}.
6967
6968 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6969 will use only the instructions in the common subset of both
6970 architectures plus some special AIX common-mode calls, and will not use
6971 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6972 permits GCC to use any instruction from either architecture and to
6973 allow use of the MQ register; specify this for the Motorola MPC601.
6974
6975 @item -mnew-mnemonics
6976 @itemx -mold-mnemonics
6977 @opindex mnew-mnemonics
6978 @opindex mold-mnemonics
6979 Select which mnemonics to use in the generated assembler code.  With
6980 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6981 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6982 assembler mnemonics defined for the POWER architecture.  Instructions
6983 defined in only one architecture have only one mnemonic; GCC uses that
6984 mnemonic irrespective of which of these options is specified.
6985
6986 GCC defaults to the mnemonics appropriate for the architecture in
6987 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6988 value of these option.  Unless you are building a cross-compiler, you
6989 should normally not specify either @option{-mnew-mnemonics} or
6990 @option{-mold-mnemonics}, but should instead accept the default.
6991
6992 @item -mcpu=@var{cpu_type}
6993 @opindex mcpu
6994 Set architecture type, register usage, choice of mnemonics, and
6995 instruction scheduling parameters for machine type @var{cpu_type}.
6996 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6997 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6998 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6999 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
7000 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
7001 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
7002
7003 @option{-mcpu=common} selects a completely generic processor.  Code
7004 generated under this option will run on any POWER or PowerPC processor.
7005 GCC will use only the instructions in the common subset of both
7006 architectures, and will not use the MQ register.  GCC assumes a generic
7007 processor model for scheduling purposes.
7008
7009 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7010 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7011 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7012 types, with an appropriate, generic processor model assumed for
7013 scheduling purposes.
7014
7015 The other options specify a specific processor.  Code generated under
7016 those options will run best on that processor, and may not run at all on
7017 others.
7018
7019 The @option{-mcpu} options automatically enable or disable other
7020 @option{-m} options as follows:
7021
7022 @table @samp
7023 @item common
7024 @option{-mno-power}, @option{-mno-powerpc}
7025
7026 @item power
7027 @itemx power2
7028 @itemx rios1
7029 @itemx rios2
7030 @itemx rsc
7031 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7032
7033 @item powerpc
7034 @itemx rs64a
7035 @itemx 602
7036 @itemx 603
7037 @itemx 603e
7038 @itemx 604
7039 @itemx 620
7040 @itemx 630
7041 @itemx 740
7042 @itemx 7400
7043 @itemx 7450
7044 @itemx 750
7045 @itemx 505
7046 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7047
7048 @item 601
7049 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7050
7051 @item 403
7052 @itemx 821
7053 @itemx 860
7054 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7055 @end table
7056
7057 @item -mtune=@var{cpu_type}
7058 @opindex mtune
7059 Set the instruction scheduling parameters for machine type
7060 @var{cpu_type}, but do not set the architecture type, register usage, or
7061 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7062 values for @var{cpu_type} are used for @option{-mtune} as for
7063 @option{-mcpu}.  If both are specified, the code generated will use the
7064 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7065 scheduling parameters set by @option{-mtune}.
7066
7067 @item -maltivec
7068 @itemx -mno-altivec
7069 @opindex maltivec
7070 @opindex mno-altivec
7071 These switches enable or disable the use of built-in functions that
7072 allow access to the AltiVec instruction set.  You may also need to set
7073 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7074 enhancements.
7075
7076 @item -mabi=spe
7077 @opindex mabi=spe
7078 Extend the current ABI with SPE ABI extensions.  This does not change
7079 the default ABI, instead it adds the SPE ABI extensions to the current
7080 ABI@.
7081
7082 @item -mabi=no-spe
7083 @opindex mabi=no-spe
7084 Disable Booke SPE ABI extensions for the current ABI.
7085
7086 @item -misel=@var{yes/no}
7087 @itemx -misel
7088 @opindex misel
7089 This switch enables or disables the generation of ISEL instructions.
7090
7091 @item -mspe=@var{yes/no}
7092 @itemx -mspe
7093 @opindex mspe
7094 This switch enables or disables the generation of SPE simd
7095 instructions.
7096
7097 @item -mfloat-gprs=@var{yes/no}
7098 @itemx -mfloat-gprs
7099 @opindex mfloat-gprs
7100 This switch enables or disables the generation of floating point
7101 operations on the general purpose registers for architectures that
7102 support it.  This option is currently only available on the MPC8540.
7103
7104 @item -mfull-toc
7105 @itemx -mno-fp-in-toc
7106 @itemx -mno-sum-in-toc
7107 @itemx -mminimal-toc
7108 @opindex mfull-toc
7109 @opindex mno-fp-in-toc
7110 @opindex mno-sum-in-toc
7111 @opindex mminimal-toc
7112 Modify generation of the TOC (Table Of Contents), which is created for
7113 every executable file.  The @option{-mfull-toc} option is selected by
7114 default.  In that case, GCC will allocate at least one TOC entry for
7115 each unique non-automatic variable reference in your program.  GCC
7116 will also place floating-point constants in the TOC@.  However, only
7117 16,384 entries are available in the TOC@.
7118
7119 If you receive a linker error message that saying you have overflowed
7120 the available TOC space, you can reduce the amount of TOC space used
7121 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7122 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7123 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7124 generate code to calculate the sum of an address and a constant at
7125 run-time instead of putting that sum into the TOC@.  You may specify one
7126 or both of these options.  Each causes GCC to produce very slightly
7127 slower and larger code at the expense of conserving TOC space.
7128
7129 If you still run out of space in the TOC even when you specify both of
7130 these options, specify @option{-mminimal-toc} instead.  This option causes
7131 GCC to make only one TOC entry for every file.  When you specify this
7132 option, GCC will produce code that is slower and larger but which
7133 uses extremely little TOC space.  You may wish to use this option
7134 only on files that contain less frequently executed code.
7135
7136 @item -maix64
7137 @itemx -maix32
7138 @opindex maix64
7139 @opindex maix32
7140 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7141 @code{long} type, and the infrastructure needed to support them.
7142 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7143 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7144 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7145
7146 @item -mxl-call
7147 @itemx -mno-xl-call
7148 @opindex mxl-call
7149 @opindex mno-xl-call
7150 On AIX, pass floating-point arguments to prototyped functions beyond the
7151 register save area (RSA) on the stack in addition to argument FPRs.  The
7152 AIX calling convention was extended but not initially documented to
7153 handle an obscure K&R C case of calling a function that takes the
7154 address of its arguments with fewer arguments than declared.  AIX XL
7155 compilers access floating point arguments which do not fit in the
7156 RSA from the stack when a subroutine is compiled without
7157 optimization.  Because always storing floating-point arguments on the
7158 stack is inefficient and rarely needed, this option is not enabled by
7159 default and only is necessary when calling subroutines compiled by AIX
7160 XL compilers without optimization.
7161
7162 @item -mpe
7163 @opindex mpe
7164 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7165 application written to use message passing with special startup code to
7166 enable the application to run.  The system must have PE installed in the
7167 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7168 must be overridden with the @option{-specs=} option to specify the
7169 appropriate directory location.  The Parallel Environment does not
7170 support threads, so the @option{-mpe} option and the @option{-pthread}
7171 option are incompatible.
7172
7173 @item -malign-natural
7174 @itemx -malign-power
7175 @opindex malign-natural
7176 @opindex malign-power
7177 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7178 @option{-malign-natural} overrides the ABI-defined alignment of larger
7179 types, such as floating-point doubles, on their natural size-based boundary.
7180 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7181 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7182
7183 @item -msoft-float
7184 @itemx -mhard-float
7185 @opindex msoft-float
7186 @opindex mhard-float
7187 Generate code that does not use (uses) the floating-point register set.
7188 Software floating point emulation is provided if you use the
7189 @option{-msoft-float} option, and pass the option to GCC when linking.
7190
7191 @item -mmultiple
7192 @itemx -mno-multiple
7193 @opindex mmultiple
7194 @opindex mno-multiple
7195 Generate code that uses (does not use) the load multiple word
7196 instructions and the store multiple word instructions.  These
7197 instructions are generated by default on POWER systems, and not
7198 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7199 endian PowerPC systems, since those instructions do not work when the
7200 processor is in little endian mode.  The exceptions are PPC740 and
7201 PPC750 which permit the instructions usage in little endian mode.
7202
7203 @item -mstring
7204 @itemx -mno-string
7205 @opindex mstring
7206 @opindex mno-string
7207 Generate code that uses (does not use) the load string instructions
7208 and the store string word instructions to save multiple registers and
7209 do small block moves.  These instructions are generated by default on
7210 POWER systems, and not generated on PowerPC systems.  Do not use
7211 @option{-mstring} on little endian PowerPC systems, since those
7212 instructions do not work when the processor is in little endian mode.
7213 The exceptions are PPC740 and PPC750 which permit the instructions
7214 usage in little endian mode.
7215
7216 @item -mupdate
7217 @itemx -mno-update
7218 @opindex mupdate
7219 @opindex mno-update
7220 Generate code that uses (does not use) the load or store instructions
7221 that update the base register to the address of the calculated memory
7222 location.  These instructions are generated by default.  If you use
7223 @option{-mno-update}, there is a small window between the time that the
7224 stack pointer is updated and the address of the previous frame is
7225 stored, which means code that walks the stack frame across interrupts or
7226 signals may get corrupted data.
7227
7228 @item -mfused-madd
7229 @itemx -mno-fused-madd
7230 @opindex mfused-madd
7231 @opindex mno-fused-madd
7232 Generate code that uses (does not use) the floating point multiply and
7233 accumulate instructions.  These instructions are generated by default if
7234 hardware floating is used.
7235
7236 @item -mno-bit-align
7237 @itemx -mbit-align
7238 @opindex mno-bit-align
7239 @opindex mbit-align
7240 On System V.4 and embedded PowerPC systems do not (do) force structures
7241 and unions that contain bit-fields to be aligned to the base type of the
7242 bit-field.
7243
7244 For example, by default a structure containing nothing but 8
7245 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7246 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7247 the structure would be aligned to a 1 byte boundary and be one byte in
7248 size.
7249
7250 @item -mno-strict-align
7251 @itemx -mstrict-align
7252 @opindex mno-strict-align
7253 @opindex mstrict-align
7254 On System V.4 and embedded PowerPC systems do not (do) assume that
7255 unaligned memory references will be handled by the system.
7256
7257 @item -mrelocatable
7258 @itemx -mno-relocatable
7259 @opindex mrelocatable
7260 @opindex mno-relocatable
7261 On embedded PowerPC systems generate code that allows (does not allow)
7262 the program to be relocated to a different address at runtime.  If you
7263 use @option{-mrelocatable} on any module, all objects linked together must
7264 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7265
7266 @item -mrelocatable-lib
7267 @itemx -mno-relocatable-lib
7268 @opindex mrelocatable-lib
7269 @opindex mno-relocatable-lib
7270 On embedded PowerPC systems generate code that allows (does not allow)
7271 the program to be relocated to a different address at runtime.  Modules
7272 compiled with @option{-mrelocatable-lib} can be linked with either modules
7273 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7274 with modules compiled with the @option{-mrelocatable} options.
7275
7276 @item -mno-toc
7277 @itemx -mtoc
7278 @opindex mno-toc
7279 @opindex mtoc
7280 On System V.4 and embedded PowerPC systems do not (do) assume that
7281 register 2 contains a pointer to a global area pointing to the addresses
7282 used in the program.
7283
7284 @item -mlittle
7285 @itemx -mlittle-endian
7286 @opindex mlittle
7287 @opindex mlittle-endian
7288 On System V.4 and embedded PowerPC systems compile code for the
7289 processor in little endian mode.  The @option{-mlittle-endian} option is
7290 the same as @option{-mlittle}.
7291
7292 @item -mbig
7293 @itemx -mbig-endian
7294 @opindex mbig
7295 @opindex mbig-endian
7296 On System V.4 and embedded PowerPC systems compile code for the
7297 processor in big endian mode.  The @option{-mbig-endian} option is
7298 the same as @option{-mbig}.
7299
7300 @item -mdynamic-no-pic
7301 @opindex mdynamic-no-pic
7302 On Darwin and Mac OS X systems, compile code so that it is not
7303 relocatable, but that its external references are relocatable.  The
7304 resulting code is suitable for applications, but not shared
7305 libraries.
7306
7307 @item -mcall-sysv
7308 @opindex mcall-sysv
7309 On System V.4 and embedded PowerPC systems compile code using calling
7310 conventions that adheres to the March 1995 draft of the System V
7311 Application Binary Interface, PowerPC processor supplement.  This is the
7312 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7313
7314 @item -mcall-sysv-eabi
7315 @opindex mcall-sysv-eabi
7316 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7317
7318 @item -mcall-sysv-noeabi
7319 @opindex mcall-sysv-noeabi
7320 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7321
7322 @item -mcall-solaris
7323 @opindex mcall-solaris
7324 On System V.4 and embedded PowerPC systems compile code for the Solaris
7325 operating system.
7326
7327 @item -mcall-linux
7328 @opindex mcall-linux
7329 On System V.4 and embedded PowerPC systems compile code for the
7330 Linux-based GNU system.
7331
7332 @item -mcall-gnu
7333 @opindex mcall-gnu
7334 On System V.4 and embedded PowerPC systems compile code for the
7335 Hurd-based GNU system.
7336
7337 @item -mcall-netbsd
7338 @opindex mcall-netbsd
7339 On System V.4 and embedded PowerPC systems compile code for the
7340 NetBSD operating system.
7341
7342 @item -maix-struct-return
7343 @opindex maix-struct-return
7344 Return all structures in memory (as specified by the AIX ABI)@.
7345
7346 @item -msvr4-struct-return
7347 @opindex msvr4-struct-return
7348 Return structures smaller than 8 bytes in registers (as specified by the
7349 SVR4 ABI)@.
7350
7351 @item -mabi=altivec
7352 @opindex mabi=altivec
7353 Extend the current ABI with AltiVec ABI extensions.  This does not
7354 change the default ABI, instead it adds the AltiVec ABI extensions to
7355 the current ABI@.
7356
7357 @item -mabi=no-altivec
7358 @opindex mabi=no-altivec
7359 Disable AltiVec ABI extensions for the current ABI.
7360
7361 @item -mprototype
7362 @itemx -mno-prototype
7363 @opindex mprototype
7364 @opindex mno-prototype
7365 On System V.4 and embedded PowerPC systems assume that all calls to
7366 variable argument functions are properly prototyped.  Otherwise, the
7367 compiler must insert an instruction before every non prototyped call to
7368 set or clear bit 6 of the condition code register (@var{CR}) to
7369 indicate whether floating point values were passed in the floating point
7370 registers in case the function takes a variable arguments.  With
7371 @option{-mprototype}, only calls to prototyped variable argument functions
7372 will set or clear the bit.
7373
7374 @item -msim
7375 @opindex msim
7376 On embedded PowerPC systems, assume that the startup module is called
7377 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7378 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7379 configurations.
7380
7381 @item -mmvme
7382 @opindex mmvme
7383 On embedded PowerPC systems, assume that the startup module is called
7384 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7385 @file{libc.a}.
7386
7387 @item -mads
7388 @opindex mads
7389 On embedded PowerPC systems, assume that the startup module is called
7390 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7391 @file{libc.a}.
7392
7393 @item -myellowknife
7394 @opindex myellowknife
7395 On embedded PowerPC systems, assume that the startup module is called
7396 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7397 @file{libc.a}.
7398
7399 @item -mvxworks
7400 @opindex mvxworks
7401 On System V.4 and embedded PowerPC systems, specify that you are
7402 compiling for a VxWorks system.
7403
7404 @item -mwindiss
7405 @opindex mwindiss
7406 Specify that you are compiling for the WindISS simulation environment.
7407
7408 @item -memb
7409 @opindex memb
7410 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7411 header to indicate that @samp{eabi} extended relocations are used.
7412
7413 @item -meabi
7414 @itemx -mno-eabi
7415 @opindex meabi
7416 @opindex mno-eabi
7417 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7418 Embedded Applications Binary Interface (eabi) which is a set of
7419 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7420 means that the stack is aligned to an 8 byte boundary, a function
7421 @code{__eabi} is called to from @code{main} to set up the eabi
7422 environment, and the @option{-msdata} option can use both @code{r2} and
7423 @code{r13} to point to two separate small data areas.  Selecting
7424 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7425 do not call an initialization function from @code{main}, and the
7426 @option{-msdata} option will only use @code{r13} to point to a single
7427 small data area.  The @option{-meabi} option is on by default if you
7428 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7429
7430 @item -msdata=eabi
7431 @opindex msdata=eabi
7432 On System V.4 and embedded PowerPC systems, put small initialized
7433 @code{const} global and static data in the @samp{.sdata2} section, which
7434 is pointed to by register @code{r2}.  Put small initialized
7435 non-@code{const} global and static data in the @samp{.sdata} section,
7436 which is pointed to by register @code{r13}.  Put small uninitialized
7437 global and static data in the @samp{.sbss} section, which is adjacent to
7438 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7439 incompatible with the @option{-mrelocatable} option.  The
7440 @option{-msdata=eabi} option also sets the @option{-memb} option.
7441
7442 @item -msdata=sysv
7443 @opindex msdata=sysv
7444 On System V.4 and embedded PowerPC systems, put small global and static
7445 data in the @samp{.sdata} section, which is pointed to by register
7446 @code{r13}.  Put small uninitialized global and static data in the
7447 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7448 The @option{-msdata=sysv} option is incompatible with the
7449 @option{-mrelocatable} option.
7450
7451 @item -msdata=default
7452 @itemx -msdata
7453 @opindex msdata=default
7454 @opindex msdata
7455 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7456 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7457 same as @option{-msdata=sysv}.
7458
7459 @item -msdata-data
7460 @opindex msdata-data
7461 On System V.4 and embedded PowerPC systems, put small global and static
7462 data in the @samp{.sdata} section.  Put small uninitialized global and
7463 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7464 to address small data however.  This is the default behavior unless
7465 other @option{-msdata} options are used.
7466
7467 @item -msdata=none
7468 @itemx -mno-sdata
7469 @opindex msdata=none
7470 @opindex mno-sdata
7471 On embedded PowerPC systems, put all initialized global and static data
7472 in the @samp{.data} section, and all uninitialized data in the
7473 @samp{.bss} section.
7474
7475 @item -G @var{num}
7476 @opindex G
7477 @cindex smaller data references (PowerPC)
7478 @cindex .sdata/.sdata2 references (PowerPC)
7479 On embedded PowerPC systems, put global and static items less than or
7480 equal to @var{num} bytes into the small data or bss sections instead of
7481 the normal data or bss section.  By default, @var{num} is 8.  The
7482 @option{-G @var{num}} switch is also passed to the linker.
7483 All modules should be compiled with the same @option{-G @var{num}} value.
7484
7485 @item -mregnames
7486 @itemx -mno-regnames
7487 @opindex mregnames
7488 @opindex mno-regnames
7489 On System V.4 and embedded PowerPC systems do (do not) emit register
7490 names in the assembly language output using symbolic forms.
7491
7492 @item -mlongcall
7493 @itemx -mno-longcall
7494 @opindex mlongcall
7495 @opindex mno-longcall
7496 Default to making all function calls via pointers, so that functions
7497 which reside further than 64 megabytes (67,108,864 bytes) from the
7498 current location can be called.  This setting can be overridden by the
7499 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7500
7501 Some linkers are capable of detecting out-of-range calls and generating
7502 glue code on the fly.  On these systems, long calls are unnecessary and
7503 generate slower code.  As of this writing, the AIX linker can do this,
7504 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7505 to the GNU linker for 32-bit PowerPC systems as well.
7506
7507 In the future, we may cause GCC to ignore all longcall specifications
7508 when the linker is known to generate glue.
7509
7510 @item -pthread
7511 @opindex pthread
7512 Adds support for multithreading with the @dfn{pthreads} library.
7513 This option sets flags for both the preprocessor and linker.
7514
7515 @end table
7516
7517 @node Darwin Options
7518 @subsection Darwin Options
7519 @cindex Darwin options
7520
7521 These options are defined for all architectures running the Darwin operating
7522 system.  They are useful for compatibility with other Mac OS compilers.
7523
7524 @table @gcctabopt
7525 @item -all_load    
7526 @opindex all_load   
7527 Loads all members of static archive libraries.
7528 See man ld(1) for more information.
7529
7530 @item -arch_errors_fatal
7531 @opindex arch_errors_fatal
7532 Cause the errors having to do with files that have the wrong architecture
7533 to be fatal.
7534
7535 @item -bind_at_load
7536 @opindex bind_at_load
7537 Causes the output file to be marked such that the dynamic linker will
7538 bind all undefined references when the file is loaded or launched.
7539
7540 @item -bundle     
7541 @opindex bundle
7542 Produce a Mach-o bundle format file.
7543 See man ld(1) for more information.
7544
7545 @item -bundle_loader @var{executable}
7546 @opindex bundle_loader
7547 This specifies the @var{executable} that will be loading the build
7548 output file being linked. See man ld(1) for more information.
7549
7550 @item -allowable_client  @var{client_name}
7551 @item -arch_only
7552
7553 @item -client_name       
7554 @item -compatibility_version
7555 @item -current_version    
7556 @item -dependency-file
7557 @item -dylib_file    
7558 @item -dylinker_install_name
7559 @item -dynamic
7560 @item -dynamiclib   
7561 @item -exported_symbols_list  
7562 @item -filelist
7563 @item -flat_namespace   
7564 @item -force_cpusubtype_ALL
7565 @item -force_flat_namespace   
7566 @item -headerpad_max_install_names
7567 @item -image_base  
7568 @item -init
7569 @item -install_name
7570 @item -keep_private_externs
7571 @item -multi_module
7572 @item -multiply_defined      
7573 @item -multiply_defined_unused      
7574 @item -noall_load  
7575 @item -nomultidefs
7576 @item -noprebind     
7577 @item -noseglinkedit
7578 @item -pagezero_size    
7579 @item -prebind
7580 @item -prebind_all_twolevel_modules
7581 @item -private_bundle
7582 @item -read_only_relocs
7583 @item -sectalign  
7584 @item -sectobjectsymbols    
7585 @item -whyload
7586 @item -seg1addr 
7587 @item -sectcreate
7588 @item -sectobjectsymbols
7589 @item -sectorder
7590 @item -seg_addr_table
7591 @item -seg_addr_table_filename
7592 @item -seglinkedit
7593 @item -segprot   
7594 @item -segs_read_only_addr
7595 @item -segs_read_write_addr
7596 @item -single_module   
7597 @item -static
7598 @item -sub_library
7599 @item -sub_umbrella 
7600 @item -twolevel_namespace
7601 @item -umbrella
7602 @item -undefined
7603 @item -unexported_symbols_list
7604 @item -weak_reference_mismatches
7605 @item -whatsloaded  
7606
7607 @opindex allowable_client
7608 @opindex arch_only    
7609 @opindex client_name
7610 @opindex compatibility_version
7611 @opindex current_version
7612 @opindex dependency-file
7613 @opindex dylib_file
7614 @opindex dylinker_install_name
7615 @opindex dynamic
7616 @opindex dynamiclib
7617 @opindex exported_symbols_list
7618 @opindex filelist  
7619 @opindex flat_namespace    
7620 @opindex force_cpusubtype_ALL
7621 @opindex force_flat_namespace
7622 @opindex headerpad_max_install_names
7623 @opindex image_base
7624 @opindex init     
7625 @opindex install_name
7626 @opindex keep_private_externs
7627 @opindex multi_module   
7628 @opindex multiply_defined
7629 @opindex multiply_defined_unused   
7630 @opindex noall_load  
7631 @opindex nomultidefs   
7632 @opindex noprebind
7633 @opindex noseglinkedit      
7634 @opindex pagezero_size
7635 @opindex prebind
7636 @opindex prebind_all_twolevel_modules
7637 @opindex private_bundle 
7638 @opindex read_only_relocs
7639 @opindex sectalign   
7640 @opindex sectobjectsymbols    
7641 @opindex whyload  
7642 @opindex seg1addr
7643 @opindex sectcreate       
7644 @opindex sectobjectsymbols 
7645 @opindex sectorder     
7646 @opindex seg_addr_table
7647 @opindex seg_addr_table_filename
7648 @opindex seglinkedit
7649 @opindex segprot
7650 @opindex segs_read_only_addr
7651 @opindex segs_read_write_addr
7652 @opindex single_module
7653 @opindex static
7654 @opindex sub_library
7655 @opindex sub_umbrella
7656 @opindex twolevel_namespace
7657 @opindex umbrella
7658 @opindex undefined
7659 @opindex unexported_symbols_list
7660 @opindex weak_reference_mismatches
7661 @opindex whatsloaded
7662
7663 This options are available for Darwin linker. Darwin linker man page
7664 describes them in detail.
7665 @end table
7666
7667
7668 @node RT Options
7669 @subsection IBM RT Options
7670 @cindex RT options
7671 @cindex IBM RT options
7672
7673 These @samp{-m} options are defined for the IBM RT PC:
7674
7675 @table @gcctabopt
7676 @item -min-line-mul
7677 @opindex min-line-mul
7678 Use an in-line code sequence for integer multiplies.  This is the
7679 default.
7680
7681 @item -mcall-lib-mul
7682 @opindex mcall-lib-mul
7683 Call @code{lmul$$} for integer multiples.
7684
7685 @item -mfull-fp-blocks
7686 @opindex mfull-fp-blocks
7687 Generate full-size floating point data blocks, including the minimum
7688 amount of scratch space recommended by IBM@.  This is the default.
7689
7690 @item -mminimum-fp-blocks
7691 @opindex mminimum-fp-blocks
7692 Do not include extra scratch space in floating point data blocks.  This
7693 results in smaller code, but slower execution, since scratch space must
7694 be allocated dynamically.
7695
7696 @cindex @file{stdarg.h} and RT PC
7697 @item -mfp-arg-in-fpregs
7698 @opindex mfp-arg-in-fpregs
7699 Use a calling sequence incompatible with the IBM calling convention in
7700 which floating point arguments are passed in floating point registers.
7701 Note that @code{stdarg.h} will not work with floating point operands
7702 if this option is specified.
7703
7704 @item -mfp-arg-in-gregs
7705 @opindex mfp-arg-in-gregs
7706 Use the normal calling convention for floating point arguments.  This is
7707 the default.
7708
7709 @item -mhc-struct-return
7710 @opindex mhc-struct-return
7711 Return structures of more than one word in memory, rather than in a
7712 register.  This provides compatibility with the MetaWare HighC (hc)
7713 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7714 with the Portable C Compiler (pcc).
7715
7716 @item -mnohc-struct-return
7717 @opindex mnohc-struct-return
7718 Return some structures of more than one word in registers, when
7719 convenient.  This is the default.  For compatibility with the
7720 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7721 option @option{-mhc-struct-return}.
7722 @end table
7723
7724 @node MIPS Options
7725 @subsection MIPS Options
7726 @cindex MIPS options
7727
7728 These @samp{-m} options are defined for the MIPS family of computers:
7729
7730 @table @gcctabopt
7731
7732 @item -march=@var{arch}
7733 @opindex march
7734 Generate code that will run on @var{arch}, which can be the name of a
7735 generic MIPS ISA, or the name of a particular processor.
7736 The ISA names are:
7737 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7738 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7739 The processor names are:
7740 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7741 @samp{m4k},
7742 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7743 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7744 @samp{orion},
7745 @samp{sb1},
7746 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7747 The special value @samp{from-abi} selects the
7748 most compatible architecture for the selected ABI (that is,
7749 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7750
7751 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7752 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7753 @samp{vr} may be written @samp{r}.
7754
7755 GCC defines two macros based on the value of this option.  The first
7756 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7757 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7758 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7759 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7760 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7761
7762 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7763 above.  In other words, it will have the full prefix and will not
7764 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7765 the macro names the resolved architecture (either @samp{"mips1"} or
7766 @samp{"mips3"}).  It names the default architecture when no
7767 @option{-march} option is given.
7768
7769 @item -mtune=@var{arch}
7770 @opindex mtune
7771 Optimize for @var{arch}.  Among other things, this option controls
7772 the way instructions are scheduled, and the perceived cost of arithmetic
7773 operations.  The list of @var{arch} values is the same as for
7774 @option{-march}.
7775
7776 When this option is not used, GCC will optimize for the processor
7777 specified by @option{-march}.  By using @option{-march} and
7778 @option{-mtune} together, it is possible to generate code that will
7779 run on a family of processors, but optimize the code for one
7780 particular member of that family.
7781
7782 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7783 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7784 @samp{-march} ones described above.
7785
7786 @item -mips1
7787 @opindex mips1
7788 Equivalent to @samp{-march=mips1}.
7789
7790 @item -mips2
7791 @opindex mips2
7792 Equivalent to @samp{-march=mips2}.
7793
7794 @item -mips3
7795 @opindex mips3
7796 Equivalent to @samp{-march=mips3}.
7797
7798 @item -mips4
7799 @opindex mips4
7800 Equivalent to @samp{-march=mips4}.
7801
7802 @item -mips32
7803 @opindex mips32
7804 Equivalent to @samp{-march=mips32}.
7805
7806 @item -mips32r2
7807 @opindex mips32r2
7808 Equivalent to @samp{-march=mips32r2}.
7809
7810 @item -mips64
7811 @opindex mips64
7812 Equivalent to @samp{-march=mips64}.
7813
7814 @item -mfused-madd
7815 @itemx -mno-fused-madd
7816 @opindex mfused-madd
7817 @opindex mno-fused-madd
7818 Generate code that uses (does not use) the floating point multiply and
7819 accumulate instructions, when they are available.  These instructions
7820 are generated by default if they are available, but this may be
7821 undesirable if the extra precision causes problems or on certain chips
7822 in the mode where denormals are rounded to zero where denormals
7823 generated by multiply and accumulate instructions cause exceptions
7824 anyway.
7825
7826 @item -mfp32
7827 @opindex mfp32
7828 Assume that floating point registers are 32 bits wide.
7829
7830 @item -mfp64
7831 @opindex mfp64
7832 Assume that floating point registers are 64 bits wide.
7833
7834 @item -mgp32
7835 @opindex mgp32
7836 Assume that general purpose registers are 32 bits wide.
7837
7838 @item -mgp64
7839 @opindex mgp64
7840 Assume that general purpose registers are 64 bits wide.
7841
7842 @item -mint64
7843 @opindex mint64
7844 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7845 explanation of the default, and the width of pointers.
7846
7847 @item -mlong64
7848 @opindex mlong64
7849 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7850 explanation of the default, and the width of pointers.
7851
7852 @item -mlong32
7853 @opindex mlong32
7854 Force long, int, and pointer types to be 32 bits wide.
7855
7856 The default size of ints, longs and pointers depends on the ABI@.  All
7857 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7858 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7859 are the same size as longs, or the same size as integer registers,
7860 whichever is smaller.
7861
7862 @item -mabi=32
7863 @itemx -mabi=o64
7864 @itemx -mabi=n32
7865 @itemx -mabi=64
7866 @itemx -mabi=eabi
7867 @itemx -mabi=meabi
7868 @opindex mabi=32
7869 @opindex mabi=o64
7870 @opindex mabi=n32
7871 @opindex mabi=64
7872 @opindex mabi=eabi
7873 @opindex mabi=meabi
7874 Generate code for the given ABI@.
7875
7876 Note that there are two embedded ABIs: @option{-mabi=eabi}
7877 selects the one defined by Cygnus while @option{-meabi=meabi}
7878 selects the one defined by MIPS@.  Both these ABIs have
7879 32-bit and 64-bit variants.  Normally, GCC will generate
7880 64-bit code when you select a 64-bit architecture, but you
7881 can use @option{-mgp32} to get 32-bit code instead.
7882
7883 @item -mabi-fake-default
7884 @opindex mabi-fake-default
7885 You don't want to know what this option does.  No, really.  I mean
7886 it.  Move on to the next option.
7887
7888 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7889 wants the default set of options to get the root of the multilib tree,
7890 and the shared library SONAMEs without any multilib-indicating
7891 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7892 we want to default to the N32 ABI, while still being binary-compatible
7893 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7894 binary-compatible means shared libraries should have the same SONAMEs,
7895 and libraries should live in the same location.  Having O32 libraries
7896 in a sub-directory named say @file{o32} is not acceptable.
7897
7898 So we trick GCC into believing that O32 is the default ABI, except
7899 that we override the default with some internal command-line
7900 processing magic.  Problem is, if we stopped at that, and you then
7901 created a multilib-aware package that used the output of @command{gcc
7902 -print-multi-lib} to decide which multilibs to build, and how, and
7903 you'd find yourself in an awkward situation when you found out that
7904 some of the options listed ended up mapping to the same multilib, and
7905 none of your libraries was actually built for the multilib that
7906 @option{-print-multi-lib} claims to be the default.  So we added this
7907 option that disables the default switcher, falling back to GCC's
7908 original notion of the default library.  Confused yet?
7909
7910 For short: don't ever use this option, unless you find it in the list
7911 of additional options to be used when building for multilibs, in the
7912 output of @option{gcc -print-multi-lib}.
7913
7914 @item -mmips-as
7915 @opindex mmips-as
7916 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7917 add normal debug information.  This is the default for all
7918 platforms except for the OSF/1 reference platform, using the OSF/rose
7919 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7920 switches are used, the @file{mips-tfile} program will encapsulate the
7921 stabs within MIPS ECOFF@.
7922
7923 @item -mgas
7924 @opindex mgas
7925 Generate code for the GNU assembler.  This is the default on the OSF/1
7926 reference platform, using the OSF/rose object format.  Also, this is
7927 the default if the configure option @option{--with-gnu-as} is used.
7928
7929 @item -msplit-addresses
7930 @itemx -mno-split-addresses
7931 @opindex msplit-addresses
7932 @opindex mno-split-addresses
7933 Generate code to load the high and low parts of address constants separately.
7934 This allows GCC to optimize away redundant loads of the high order
7935 bits of addresses.  This optimization requires GNU as and GNU ld.
7936 This optimization is enabled by default for some embedded targets where
7937 GNU as and GNU ld are standard.
7938
7939 @item -mrnames
7940 @itemx -mno-rnames
7941 @opindex mrnames
7942 @opindex mno-rnames
7943 The @option{-mrnames} switch says to output code using the MIPS software
7944 names for the registers, instead of the hardware names (ie, @var{a0}
7945 instead of @var{$4}).  The only known assembler that supports this option
7946 is the Algorithmics assembler.
7947
7948 @item -mgpopt
7949 @itemx -mno-gpopt
7950 @opindex mgpopt
7951 @opindex mno-gpopt
7952 The @option{-mgpopt} switch says to write all of the data declarations
7953 before the instructions in the text section, this allows the MIPS
7954 assembler to generate one word memory references instead of using two
7955 words for short global or static data items.  This is on by default if
7956 optimization is selected.
7957
7958 @item -mmemcpy
7959 @itemx -mno-memcpy
7960 @opindex mmemcpy
7961 @opindex mno-memcpy
7962 The @option{-mmemcpy} switch makes all block moves call the appropriate
7963 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7964 generating inline code.
7965
7966 @item -mmips-tfile
7967 @itemx -mno-mips-tfile
7968 @opindex mmips-tfile
7969 @opindex mno-mips-tfile
7970 The @option{-mno-mips-tfile} switch causes the compiler not
7971 postprocess the object file with the @file{mips-tfile} program,
7972 after the MIPS assembler has generated it to add debug support.  If
7973 @file{mips-tfile} is not run, then no local variables will be
7974 available to the debugger.  In addition, @file{stage2} and
7975 @file{stage3} objects will have the temporary file names passed to the
7976 assembler embedded in the object file, which means the objects will
7977 not compare the same.  The @option{-mno-mips-tfile} switch should only
7978 be used when there are bugs in the @file{mips-tfile} program that
7979 prevents compilation.
7980
7981 @item -msoft-float
7982 @opindex msoft-float
7983 Generate output containing library calls for floating point.
7984 @strong{Warning:} the requisite libraries are not part of GCC@.
7985 Normally the facilities of the machine's usual C compiler are used, but
7986 this can't be done directly in cross-compilation.  You must make your
7987 own arrangements to provide suitable library functions for
7988 cross-compilation.
7989
7990 @item -mhard-float
7991 @opindex mhard-float
7992 Generate output containing floating point instructions.  This is the
7993 default if you use the unmodified sources.
7994
7995 @item -mabicalls
7996 @itemx -mno-abicalls
7997 @opindex mabicalls
7998 @opindex mno-abicalls
7999 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8000 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8001 position independent code.
8002
8003 @item -mlong-calls
8004 @itemx -mno-long-calls
8005 @opindex mlong-calls
8006 @opindex mno-long-calls
8007 Do all calls with the @samp{JALR} instruction, which requires
8008 loading up a function's address into a register before the call.
8009 You need to use this switch, if you call outside of the current
8010 512 megabyte segment to functions that are not through pointers.
8011
8012 @item -mhalf-pic
8013 @itemx -mno-half-pic
8014 @opindex mhalf-pic
8015 @opindex mno-half-pic
8016 Put pointers to extern references into the data section and load them
8017 up, rather than put the references in the text section.
8018
8019 @item -membedded-pic
8020 @itemx -mno-embedded-pic
8021 @opindex membedded-pic
8022 @opindex mno-embedded-pic
8023 Generate PIC code suitable for some embedded systems.  All calls are
8024 made using PC relative address, and all data is addressed using the $gp
8025 register.  No more than 65536 bytes of global data may be used.  This
8026 requires GNU as and GNU ld which do most of the work.  This currently
8027 only works on targets which use ECOFF; it does not work with ELF@.
8028
8029 @item -membedded-data
8030 @itemx -mno-embedded-data
8031 @opindex membedded-data
8032 @opindex mno-embedded-data
8033 Allocate variables to the read-only data section first if possible, then
8034 next in the small data section if possible, otherwise in data.  This gives
8035 slightly slower code than the default, but reduces the amount of RAM required
8036 when executing, and thus may be preferred for some embedded systems.
8037
8038 @item -muninit-const-in-rodata
8039 @itemx -mno-uninit-const-in-rodata
8040 @opindex muninit-const-in-rodata
8041 @opindex mno-uninit-const-in-rodata
8042 When used together with @option{-membedded-data}, it will always store uninitialized
8043 const variables in the read-only data section.
8044
8045 @item -msingle-float
8046 @itemx -mdouble-float
8047 @opindex msingle-float
8048 @opindex mdouble-float
8049 The @option{-msingle-float} switch tells gcc to assume that the floating
8050 point coprocessor only supports single precision operations, as on the
8051 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8052 double precision operations.  This is the default.
8053
8054 @item -mmad
8055 @itemx -mno-mad
8056 @opindex mmad
8057 @opindex mno-mad
8058 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8059 as on the @samp{r4650} chip.
8060
8061 @item -m4650
8062 @opindex m4650
8063 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8064 @option{-mcpu=r4650}.
8065
8066 @item -mips16
8067 @itemx -mno-mips16
8068 @opindex mips16
8069 @opindex mno-mips16
8070 Enable 16-bit instructions.
8071
8072 @item -mentry
8073 @opindex mentry
8074 Use the entry and exit pseudo ops.  This option can only be used with
8075 @option{-mips16}.
8076
8077 @item -EL
8078 @opindex EL
8079 Compile code for the processor in little endian mode.
8080 The requisite libraries are assumed to exist.
8081
8082 @item -EB
8083 @opindex EB
8084 Compile code for the processor in big endian mode.
8085 The requisite libraries are assumed to exist.
8086
8087 @item -G @var{num}
8088 @opindex G
8089 @cindex smaller data references (MIPS)
8090 @cindex gp-relative references (MIPS)
8091 Put global and static items less than or equal to @var{num} bytes into
8092 the small data or bss sections instead of the normal data or bss
8093 section.  This allows the assembler to emit one word memory reference
8094 instructions based on the global pointer (@var{gp} or @var{$28}),
8095 instead of the normal two words used.  By default, @var{num} is 8 when
8096 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8097 @option{-G @var{num}} switch is also passed to the assembler and linker.
8098 All modules should be compiled with the same @option{-G @var{num}}
8099 value.
8100
8101 @item -nocpp
8102 @opindex nocpp
8103 Tell the MIPS assembler to not run its preprocessor over user
8104 assembler files (with a @samp{.s} suffix) when assembling them.
8105
8106 @item -mfix7000
8107 @opindex mfix7000
8108 Pass an option to gas which will cause nops to be inserted if
8109 the read of the destination register of an mfhi or mflo instruction
8110 occurs in the following two instructions.
8111
8112 @item -no-crt0
8113 @opindex no-crt0
8114 Do not include the default crt0.
8115
8116 @item -mflush-func=@var{func}
8117 @itemx -mno-flush-func
8118 @opindex mflush-func
8119 Specifies the function to call to flush the I and D caches, or to not
8120 call any such function.  If called, the function must take the same
8121 arguments as the common @code{_flush_func()}, that is, the address of the
8122 memory range for which the cache is being flushed, the size of the
8123 memory range, and the number 3 (to flush both caches).  The default
8124 depends on the target gcc was configured for, but commonly is either
8125 @samp{_flush_func} or @samp{__cpu_flush}.
8126
8127 @item -mbranch-likely
8128 @itemx -mno-branch-likely
8129 @opindex mbranch-likely
8130 @opindex mno-branch-likely
8131 Enable or disable use of Branch Likely instructions, regardless of the
8132 default for the selected architecture.  By default, Branch Likely
8133 instructions may be generated if they are supported by the selected
8134 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8135 and processors which implement those architectures; for those, Branch
8136 Likely instructions will not be generated by default because the MIPS32
8137 and MIPS64 architectures specifically deprecate their use.
8138 @end table
8139
8140 @node i386 and x86-64 Options
8141 @subsection Intel 386 and AMD x86-64 Options
8142 @cindex i386 Options
8143 @cindex x86-64 Options
8144 @cindex Intel 386 Options
8145 @cindex AMD x86-64 Options
8146
8147 These @samp{-m} options are defined for the i386 and x86-64 family of
8148 computers:
8149
8150 @table @gcctabopt
8151 @item -mtune=@var{cpu-type}
8152 @opindex mtune
8153 Tune to @var{cpu-type} everything applicable about the generated code, except
8154 for the ABI and the set of available instructions.  The choices for
8155 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8156 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8157 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8158 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8159 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8160 and @samp{c3-2}.
8161
8162 While picking a specific @var{cpu-type} will schedule things appropriately
8163 for that particular chip, the compiler will not generate any code that
8164 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8165 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8166 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8167 AMD chips as opposed to the Intel ones.
8168
8169 @item -march=@var{cpu-type}
8170 @opindex march
8171 Generate instructions for the machine type @var{cpu-type}.  The choices
8172 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8173 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8174
8175 @item -mcpu=@var{cpu-type}
8176 @opindex mcpu
8177 A deprecated synonym for @option{-mtune}.
8178
8179 @item -m386
8180 @itemx -m486
8181 @itemx -mpentium
8182 @itemx -mpentiumpro
8183 @opindex m386
8184 @opindex m486
8185 @opindex mpentium
8186 @opindex mpentiumpro
8187 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8188 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8189 These synonyms are deprecated.
8190
8191 @item -mfpmath=@var{unit}
8192 @opindex march
8193 generate floating point arithmetics for selected unit @var{unit}.  the choices
8194 for @var{unit} are:
8195
8196 @table @samp
8197 @item 387
8198 Use the standard 387 floating point coprocessor present majority of chips and
8199 emulated otherwise.  Code compiled with this option will run almost everywhere.
8200 The temporary results are computed in 80bit precision instead of precision
8201 specified by the type resulting in slightly different results compared to most
8202 of other chips. See @option{-ffloat-store} for more detailed description.
8203
8204 This is the default choice for i386 compiler.
8205
8206 @item sse
8207 Use scalar floating point instructions present in the SSE instruction set.
8208 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8209 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8210 instruction set supports only single precision arithmetics, thus the double and
8211 extended precision arithmetics is still done using 387.  Later version, present
8212 only in Pentium4 and the future AMD x86-64 chips supports double precision
8213 arithmetics too.
8214
8215 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8216 @option{-msse2} switches to enable SSE extensions and make this option
8217 effective.  For x86-64 compiler, these extensions are enabled by default.
8218
8219 The resulting code should be considerably faster in majority of cases and avoid
8220 the numerical instability problems of 387 code, but may break some existing
8221 code that expects temporaries to be 80bit.
8222
8223 This is the default choice for x86-64 compiler.
8224
8225 @item pni
8226 Use all SSE extensions enabled by @option{-msse2} as well as the new
8227 SSE extensions in Prescott New Intrunctions. @option{-mpni} also
8228 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8229 @code{__builtin_ia32_mwait}, for new intrunctions @code{monitor} and
8230 @code{mwait}. 
8231
8232 @item sse,387
8233 Attempt to utilize both instruction sets at once.  This effectively double the
8234 amount of available registers and on chips with separate execution units for
8235 387 and SSE the execution resources too.  Use this option with care, as it is
8236 still experimental, because gcc register allocator does not model separate
8237 functional units well resulting in instable performance.
8238 @end table
8239
8240 @item -masm=@var{dialect}
8241 @opindex masm=@var{dialect}
8242 Output asm instructions using selected @var{dialect}. Supported choices are
8243 @samp{intel} or @samp{att} (the default one).
8244
8245 @item -mieee-fp
8246 @itemx -mno-ieee-fp
8247 @opindex mieee-fp
8248 @opindex mno-ieee-fp
8249 Control whether or not the compiler uses IEEE floating point
8250 comparisons.  These handle correctly the case where the result of a
8251 comparison is unordered.
8252
8253 @item -msoft-float
8254 @opindex msoft-float
8255 Generate output containing library calls for floating point.
8256 @strong{Warning:} the requisite libraries are not part of GCC@.
8257 Normally the facilities of the machine's usual C compiler are used, but
8258 this can't be done directly in cross-compilation.  You must make your
8259 own arrangements to provide suitable library functions for
8260 cross-compilation.
8261
8262 On machines where a function returns floating point results in the 80387
8263 register stack, some floating point opcodes may be emitted even if
8264 @option{-msoft-float} is used.
8265
8266 @item -mno-fp-ret-in-387
8267 @opindex mno-fp-ret-in-387
8268 Do not use the FPU registers for return values of functions.
8269
8270 The usual calling convention has functions return values of types
8271 @code{float} and @code{double} in an FPU register, even if there
8272 is no FPU@.  The idea is that the operating system should emulate
8273 an FPU@.
8274
8275 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8276 in ordinary CPU registers instead.
8277
8278 @item -mno-fancy-math-387
8279 @opindex mno-fancy-math-387
8280 Some 387 emulators do not support the @code{sin}, @code{cos} and
8281 @code{sqrt} instructions for the 387.  Specify this option to avoid
8282 generating those instructions.  This option is the default on FreeBSD,
8283 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8284 indicates that the target cpu will always have an FPU and so the
8285 instruction will not need emulation.  As of revision 2.6.1, these
8286 instructions are not generated unless you also use the
8287 @option{-funsafe-math-optimizations} switch.
8288
8289 @item -malign-double
8290 @itemx -mno-align-double
8291 @opindex malign-double
8292 @opindex mno-align-double
8293 Control whether GCC aligns @code{double}, @code{long double}, and
8294 @code{long long} variables on a two word boundary or a one word
8295 boundary.  Aligning @code{double} variables on a two word boundary will
8296 produce code that runs somewhat faster on a @samp{Pentium} at the
8297 expense of more memory.
8298
8299 @strong{Warning:} if you use the @option{-malign-double} switch,
8300 structures containing the above types will be aligned differently than
8301 the published application binary interface specifications for the 386
8302 and will not be binary compatible with structures in code compiled
8303 without that switch.
8304
8305 @item -m96bit-long-double
8306 @item -m128bit-long-double
8307 @opindex m96bit-long-double
8308 @opindex m128bit-long-double
8309 These switches control the size of @code{long double} type. The i386 
8310 application binary interface specifies the size to be 96 bits, 
8311 so @option{-m96bit-long-double} is the default in 32 bit mode.
8312
8313 Modern architectures (Pentium and newer) would prefer @code{long double}
8314 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8315 conforming to the ABI, this would not be possible.  So specifying a 
8316 @option{-m128bit-long-double} will align @code{long double}
8317 to a 16 byte boundary by padding the @code{long double} with an additional
8318 32 bit zero. 
8319
8320 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8321 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8322  
8323 Notice that neither of these options enable any extra precision over the x87
8324 standard of 80 bits for a @code{long double}. 
8325
8326 @strong{Warning:} if you override the default value for your target ABI, the
8327 structures and arrays containing @code{long double} will change their size as
8328 well as function calling convention for function taking @code{long double}
8329 will be modified.  Hence they will not be binary compatible with arrays or
8330 structures in code compiled without that switch.
8331
8332
8333 @item -msvr3-shlib
8334 @itemx -mno-svr3-shlib
8335 @opindex msvr3-shlib
8336 @opindex mno-svr3-shlib
8337 Control whether GCC places uninitialized local variables into the
8338 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8339 into @code{bss}.  These options are meaningful only on System V Release 3.
8340
8341 @item -mrtd
8342 @opindex mrtd
8343 Use a different function-calling convention, in which functions that
8344 take a fixed number of arguments return with the @code{ret} @var{num}
8345 instruction, which pops their arguments while returning.  This saves one
8346 instruction in the caller since there is no need to pop the arguments
8347 there.
8348
8349 You can specify that an individual function is called with this calling
8350 sequence with the function attribute @samp{stdcall}.  You can also
8351 override the @option{-mrtd} option by using the function attribute
8352 @samp{cdecl}.  @xref{Function Attributes}.
8353
8354 @strong{Warning:} this calling convention is incompatible with the one
8355 normally used on Unix, so you cannot use it if you need to call
8356 libraries compiled with the Unix compiler.
8357
8358 Also, you must provide function prototypes for all functions that
8359 take variable numbers of arguments (including @code{printf});
8360 otherwise incorrect code will be generated for calls to those
8361 functions.
8362
8363 In addition, seriously incorrect code will result if you call a
8364 function with too many arguments.  (Normally, extra arguments are
8365 harmlessly ignored.)
8366
8367 @item -mregparm=@var{num}
8368 @opindex mregparm
8369 Control how many registers are used to pass integer arguments.  By
8370 default, no registers are used to pass arguments, and at most 3
8371 registers can be used.  You can control this behavior for a specific
8372 function by using the function attribute @samp{regparm}.
8373 @xref{Function Attributes}.
8374
8375 @strong{Warning:} if you use this switch, and
8376 @var{num} is nonzero, then you must build all modules with the same
8377 value, including any libraries.  This includes the system libraries and
8378 startup modules.
8379
8380 @item -mpreferred-stack-boundary=@var{num}
8381 @opindex mpreferred-stack-boundary
8382 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8383 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8384 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8385 size (@option{-Os}), in which case the default is the minimum correct
8386 alignment (4 bytes for x86, and 8 bytes for x86-64).
8387
8388 On Pentium and PentiumPro, @code{double} and @code{long double} values
8389 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8390 suffer significant run time performance penalties.  On Pentium III, the
8391 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8392 penalties if it is not 16 byte aligned.
8393
8394 To ensure proper alignment of this values on the stack, the stack boundary
8395 must be as aligned as that required by any value stored on the stack.
8396 Further, every function must be generated such that it keeps the stack
8397 aligned.  Thus calling a function compiled with a higher preferred
8398 stack boundary from a function compiled with a lower preferred stack
8399 boundary will most likely misalign the stack.  It is recommended that
8400 libraries that use callbacks always use the default setting.
8401
8402 This extra alignment does consume extra stack space, and generally
8403 increases code size.  Code that is sensitive to stack space usage, such
8404 as embedded systems and operating system kernels, may want to reduce the
8405 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8406
8407 @item -mmmx
8408 @itemx -mno-mmx
8409 @item -msse
8410 @itemx -mno-sse
8411 @item -msse2
8412 @itemx -mno-sse2
8413 @item -mpni
8414 @itemx -mno-pni
8415 @item -m3dnow
8416 @itemx -mno-3dnow
8417 @opindex mmmx
8418 @opindex mno-mmx
8419 @opindex msse
8420 @opindex mno-sse
8421 @opindex m3dnow
8422 @opindex mno-3dnow
8423 These switches enable or disable the use of built-in functions that allow
8424 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8425
8426 @xref{X86 Built-in Functions}, for details of the functions enabled
8427 and disabled by these switches.
8428
8429 To have SSE/SSE2 instructions generated automatically from floating-point
8430 code, see @option{-mfpmath=sse}.
8431
8432 @item -mpush-args
8433 @itemx -mno-push-args
8434 @opindex mpush-args
8435 @opindex mno-push-args
8436 Use PUSH operations to store outgoing parameters.  This method is shorter
8437 and usually equally fast as method using SUB/MOV operations and is enabled
8438 by default.  In some cases disabling it may improve performance because of
8439 improved scheduling and reduced dependencies.
8440
8441 @item -maccumulate-outgoing-args
8442 @opindex maccumulate-outgoing-args
8443 If enabled, the maximum amount of space required for outgoing arguments will be
8444 computed in the function prologue.  This is faster on most modern CPUs
8445 because of reduced dependencies, improved scheduling and reduced stack usage
8446 when preferred stack boundary is not equal to 2.  The drawback is a notable
8447 increase in code size.  This switch implies @option{-mno-push-args}.
8448
8449 @item -mthreads
8450 @opindex mthreads
8451 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8452 on thread-safe exception handling must compile and link all code with the
8453 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8454 @option{-D_MT}; when linking, it links in a special thread helper library
8455 @option{-lmingwthrd} which cleans up per thread exception handling data.
8456
8457 @item -mno-align-stringops
8458 @opindex mno-align-stringops
8459 Do not align destination of inlined string operations.  This switch reduces
8460 code size and improves performance in case the destination is already aligned,
8461 but gcc don't know about it.
8462
8463 @item -minline-all-stringops
8464 @opindex minline-all-stringops
8465 By default GCC inlines string operations only when destination is known to be
8466 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8467 size, but may improve performance of code that depends on fast memcpy, strlen
8468 and memset for short lengths.
8469
8470 @item -momit-leaf-frame-pointer
8471 @opindex momit-leaf-frame-pointer
8472 Don't keep the frame pointer in a register for leaf functions.  This
8473 avoids the instructions to save, set up and restore frame pointers and
8474 makes an extra register available in leaf functions.  The option
8475 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8476 which might make debugging harder.
8477
8478 @item -mtls-direct-seg-refs
8479 @itemx -mno-tls-direct-seg-refs
8480 @opindex mtls-direct-seg-refs
8481 Controls whether TLS variables may be accessed with offsets from the
8482 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8483 or whether the thread base pointer must be added.  Whether or not this
8484 is legal depends on the operating system, and whether it maps the
8485 segment to cover the entire TLS area.
8486
8487 For systems that use GNU libc, the default is on.
8488 @end table
8489
8490 These @samp{-m} switches are supported in addition to the above
8491 on AMD x86-64 processors in 64-bit environments.
8492
8493 @table @gcctabopt
8494 @item -m32
8495 @itemx -m64
8496 @opindex m32
8497 @opindex m64
8498 Generate code for a 32-bit or 64-bit environment.
8499 The 32-bit environment sets int, long and pointer to 32 bits and
8500 generates code that runs on any i386 system.
8501 The 64-bit environment sets int to 32 bits and long and pointer
8502 to 64 bits and generates code for AMD's x86-64 architecture.
8503
8504 @item -mno-red-zone
8505 @opindex no-red-zone
8506 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8507 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8508 stack pointer that will not be modified by signal or interrupt handlers
8509 and therefore can be used for temporary data without adjusting the stack
8510 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8511
8512 @item -mcmodel=small
8513 @opindex mcmodel=small
8514 Generate code for the small code model: the program and its symbols must
8515 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8516 Programs can be statically or dynamically linked.  This is the default
8517 code model.
8518
8519 @item -mcmodel=kernel
8520 @opindex mcmodel=kernel
8521 Generate code for the kernel code model.  The kernel runs in the
8522 negative 2 GB of the address space.
8523 This model has to be used for Linux kernel code.
8524
8525 @item -mcmodel=medium
8526 @opindex mcmodel=medium
8527 Generate code for the medium model: The program is linked in the lower 2
8528 GB of the address space but symbols can be located anywhere in the
8529 address space.  Programs can be statically or dynamically linked, but
8530 building of shared libraries are not supported with the medium model.
8531
8532 @item -mcmodel=large
8533 @opindex mcmodel=large
8534 Generate code for the large model: This model makes no assumptions
8535 about addresses and sizes of sections.  Currently GCC does not implement
8536 this model.
8537 @end table
8538
8539 @node HPPA Options
8540 @subsection HPPA Options
8541 @cindex HPPA Options
8542
8543 These @samp{-m} options are defined for the HPPA family of computers:
8544
8545 @table @gcctabopt
8546 @item -march=@var{architecture-type}
8547 @opindex march
8548 Generate code for the specified architecture.  The choices for
8549 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8550 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8551 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8552 architecture option for your machine.  Code compiled for lower numbered
8553 architectures will run on higher numbered architectures, but not the
8554 other way around.
8555
8556 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8557 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8558 support.
8559
8560 @item -mpa-risc-1-0
8561 @itemx -mpa-risc-1-1
8562 @itemx -mpa-risc-2-0
8563 @opindex mpa-risc-1-0
8564 @opindex mpa-risc-1-1
8565 @opindex mpa-risc-2-0
8566 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8567
8568 @item -mbig-switch
8569 @opindex mbig-switch
8570 Generate code suitable for big switch tables.  Use this option only if
8571 the assembler/linker complain about out of range branches within a switch
8572 table.
8573
8574 @item -mjump-in-delay
8575 @opindex mjump-in-delay
8576 Fill delay slots of function calls with unconditional jump instructions
8577 by modifying the return pointer for the function call to be the target
8578 of the conditional jump.
8579
8580 @item -mdisable-fpregs
8581 @opindex mdisable-fpregs
8582 Prevent floating point registers from being used in any manner.  This is
8583 necessary for compiling kernels which perform lazy context switching of
8584 floating point registers.  If you use this option and attempt to perform
8585 floating point operations, the compiler will abort.
8586
8587 @item -mdisable-indexing
8588 @opindex mdisable-indexing
8589 Prevent the compiler from using indexing address modes.  This avoids some
8590 rather obscure problems when compiling MIG generated code under MACH@.
8591
8592 @item -mno-space-regs
8593 @opindex mno-space-regs
8594 Generate code that assumes the target has no space registers.  This allows
8595 GCC to generate faster indirect calls and use unscaled index address modes.
8596
8597 Such code is suitable for level 0 PA systems and kernels.
8598
8599 @item -mfast-indirect-calls
8600 @opindex mfast-indirect-calls
8601 Generate code that assumes calls never cross space boundaries.  This
8602 allows GCC to emit code which performs faster indirect calls.
8603
8604 This option will not work in the presence of shared libraries or nested
8605 functions.
8606
8607 @item -mlong-load-store
8608 @opindex mlong-load-store
8609 Generate 3-instruction load and store sequences as sometimes required by
8610 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8611 the HP compilers.
8612
8613 @item -mportable-runtime
8614 @opindex mportable-runtime
8615 Use the portable calling conventions proposed by HP for ELF systems.
8616
8617 @item -mgas
8618 @opindex mgas
8619 Enable the use of assembler directives only GAS understands.
8620
8621 @item -mschedule=@var{cpu-type}
8622 @opindex mschedule
8623 Schedule code according to the constraints for the machine type
8624 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8625 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8626 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8627 proper scheduling option for your machine.  The default scheduling is
8628 @samp{8000}.
8629
8630 @item -mlinker-opt
8631 @opindex mlinker-opt
8632 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8633 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8634 linkers in which they give bogus error messages when linking some programs.
8635
8636 @item -msoft-float
8637 @opindex msoft-float
8638 Generate output containing library calls for floating point.
8639 @strong{Warning:} the requisite libraries are not available for all HPPA
8640 targets.  Normally the facilities of the machine's usual C compiler are
8641 used, but this cannot be done directly in cross-compilation.  You must make
8642 your own arrangements to provide suitable library functions for
8643 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8644 does provide software floating point support.
8645
8646 @option{-msoft-float} changes the calling convention in the output file;
8647 therefore, it is only useful if you compile @emph{all} of a program with
8648 this option.  In particular, you need to compile @file{libgcc.a}, the
8649 library that comes with GCC, with @option{-msoft-float} in order for
8650 this to work.
8651
8652 @item -msio
8653 @opindex msio
8654 Generate the predefine, @code{_SIO}, for server IO.  The default is
8655 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8656 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8657 options are available under HP-UX and HI-UX.
8658
8659 @item -mgnu-ld
8660 @opindex gnu-ld
8661 Use GNU ld specific options.  This passes @option{-shared} to ld when
8662 building a shared library.  It is the default when GCC is configured,
8663 explicitly or implicitly, with the GNU linker.  This option does not
8664 have any affect on which ld is called, it only changes what parameters
8665 are passed to that ld.  The ld that is called is determined by the
8666 @option{--with-ld} configure option, gcc's program search path, and
8667 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8668 using @samp{which `gcc -print-prog-name=ld`}.
8669
8670 @item -mhp-ld
8671 @opindex hp-ld
8672 Use HP ld specific options.  This passes @option{-b} to ld when building
8673 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8674 links.  It is the default when GCC is configured, explicitly or
8675 implicitly, with the HP linker.  This option does not have any affect on
8676 which ld is called, it only changes what parameters are passed to that
8677 ld.  The ld that is called is determined by the @option{--with-ld}
8678 configure option, gcc's program search path, and finally by the user's
8679 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8680 `gcc -print-prog-name=ld`}.
8681
8682 @item -mlong-calls
8683 @opindex mno-long-calls
8684 Generate code that uses long call sequences.  This ensures that a call
8685 is always able to reach linker generated stubs.  The default is to generate
8686 long calls only when the distance from the call site to the beginning
8687 of the function or translation unit, as the case may be, exceeds a
8688 predefined limit set by the branch type being used.  The limits for
8689 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8690 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8691 240,000 bytes.
8692
8693 Distances are measured from the beginning of functions when using the
8694 @option{-ffunction-sections} option, or when using the @option{-mgas}
8695 and @option{-mno-portable-runtime} options together under HP-UX with
8696 the SOM linker.
8697
8698 It is normally not desirable to use this option as it will degrade
8699 performance.  However, it may be useful in large applications,
8700 particularly when partial linking is used to build the application.
8701
8702 The types of long calls used depends on the capabilities of the
8703 assembler and linker, and the type of code being generated.  The
8704 impact on systems that support long absolute calls, and long pic
8705 symbol-difference or pc-relative calls should be relatively small.
8706 However, an indirect call is used on 32-bit ELF systems in pic code
8707 and it is quite long.
8708
8709 @item -nolibdld
8710 @opindex nolibdld
8711 Suppress the generation of link options to search libdld.sl when the
8712 @option{-static} option is specified on HP-UX 10 and later.
8713
8714 @item -static
8715 @opindex static
8716 The HP-UX implementation of setlocale in libc has a dependency on
8717 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8718 when the @option{-static} option is specified, special link options
8719 are needed to resolve this dependency.
8720
8721 On HP-UX 10 and later, the GCC driver adds the necessary options to
8722 link with libdld.sl when the @option{-static} option is specified.
8723 This causes the resulting binary to be dynamic.  On the 64-bit port,
8724 the linkers generate dynamic binaries by default in any case.  The
8725 @option{-nolibdld} option can be used to prevent the GCC driver from
8726 adding these link options.
8727
8728 @item -threads
8729 @opindex threads
8730 Add support for multithreading with the @dfn{dce thread} library
8731 under HP-UX.  This option sets flags for both the preprocessor and
8732 linker.
8733 @end table
8734
8735 @node Intel 960 Options
8736 @subsection Intel 960 Options
8737
8738 These @samp{-m} options are defined for the Intel 960 implementations:
8739
8740 @table @gcctabopt
8741 @item -m@var{cpu-type}
8742 @opindex mka
8743 @opindex mkb
8744 @opindex mmc
8745 @opindex mca
8746 @opindex mcf
8747 @opindex msa
8748 @opindex msb
8749 Assume the defaults for the machine type @var{cpu-type} for some of
8750 the other options, including instruction scheduling, floating point
8751 support, and addressing modes.  The choices for @var{cpu-type} are
8752 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8753 @samp{sa}, and @samp{sb}.
8754 The default is
8755 @samp{kb}.
8756
8757 @item -mnumerics
8758 @itemx -msoft-float
8759 @opindex mnumerics
8760 @opindex msoft-float
8761 The @option{-mnumerics} option indicates that the processor does support
8762 floating-point instructions.  The @option{-msoft-float} option indicates
8763 that floating-point support should not be assumed.
8764
8765 @item -mleaf-procedures
8766 @itemx -mno-leaf-procedures
8767 @opindex mleaf-procedures
8768 @opindex mno-leaf-procedures
8769 Do (or do not) attempt to alter leaf procedures to be callable with the
8770 @code{bal} instruction as well as @code{call}.  This will result in more
8771 efficient code for explicit calls when the @code{bal} instruction can be
8772 substituted by the assembler or linker, but less efficient code in other
8773 cases, such as calls via function pointers, or using a linker that doesn't
8774 support this optimization.
8775
8776 @item -mtail-call
8777 @itemx -mno-tail-call
8778 @opindex mtail-call
8779 @opindex mno-tail-call
8780 Do (or do not) make additional attempts (beyond those of the
8781 machine-independent portions of the compiler) to optimize tail-recursive
8782 calls into branches.  You may not want to do this because the detection of
8783 cases where this is not valid is not totally complete.  The default is
8784 @option{-mno-tail-call}.
8785
8786 @item -mcomplex-addr
8787 @itemx -mno-complex-addr
8788 @opindex mcomplex-addr
8789 @opindex mno-complex-addr
8790 Assume (or do not assume) that the use of a complex addressing mode is a
8791 win on this implementation of the i960.  Complex addressing modes may not
8792 be worthwhile on the K-series, but they definitely are on the C-series.
8793 The default is currently @option{-mcomplex-addr} for all processors except
8794 the CB and CC@.
8795
8796 @item -mcode-align
8797 @itemx -mno-code-align
8798 @opindex mcode-align
8799 @opindex mno-code-align
8800 Align code to 8-byte boundaries for faster fetching (or don't bother).
8801 Currently turned on by default for C-series implementations only.
8802
8803 @ignore
8804 @item -mclean-linkage
8805 @itemx -mno-clean-linkage
8806 @opindex mclean-linkage
8807 @opindex mno-clean-linkage
8808 These options are not fully implemented.
8809 @end ignore
8810
8811 @item -mic-compat
8812 @itemx -mic2.0-compat
8813 @itemx -mic3.0-compat
8814 @opindex mic-compat
8815 @opindex mic2.0-compat
8816 @opindex mic3.0-compat
8817 Enable compatibility with iC960 v2.0 or v3.0.
8818
8819 @item -masm-compat
8820 @itemx -mintel-asm
8821 @opindex masm-compat
8822 @opindex mintel-asm
8823 Enable compatibility with the iC960 assembler.
8824
8825 @item -mstrict-align
8826 @itemx -mno-strict-align
8827 @opindex mstrict-align
8828 @opindex mno-strict-align
8829 Do not permit (do permit) unaligned accesses.
8830
8831 @item -mold-align
8832 @opindex mold-align
8833 Enable structure-alignment compatibility with Intel's gcc release version
8834 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8835
8836 @item -mlong-double-64
8837 @opindex mlong-double-64
8838 Implement type @samp{long double} as 64-bit floating point numbers.
8839 Without the option @samp{long double} is implemented by 80-bit
8840 floating point numbers.  The only reason we have it because there is
8841 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8842 is only useful for people using soft-float targets.  Otherwise, we
8843 should recommend against use of it.
8844
8845 @end table
8846
8847 @node DEC Alpha Options
8848 @subsection DEC Alpha Options
8849
8850 These @samp{-m} options are defined for the DEC Alpha implementations:
8851
8852 @table @gcctabopt
8853 @item -mno-soft-float
8854 @itemx -msoft-float
8855 @opindex mno-soft-float
8856 @opindex msoft-float
8857 Use (do not use) the hardware floating-point instructions for
8858 floating-point operations.  When @option{-msoft-float} is specified,
8859 functions in @file{libgcc.a} will be used to perform floating-point
8860 operations.  Unless they are replaced by routines that emulate the
8861 floating-point operations, or compiled in such a way as to call such
8862 emulations routines, these routines will issue floating-point
8863 operations.   If you are compiling for an Alpha without floating-point
8864 operations, you must ensure that the library is built so as not to call
8865 them.
8866
8867 Note that Alpha implementations without floating-point operations are
8868 required to have floating-point registers.
8869
8870 @item -mfp-reg
8871 @itemx -mno-fp-regs
8872 @opindex mfp-reg
8873 @opindex mno-fp-regs
8874 Generate code that uses (does not use) the floating-point register set.
8875 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8876 register set is not used, floating point operands are passed in integer
8877 registers as if they were integers and floating-point results are passed
8878 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8879 so any function with a floating-point argument or return value called by code
8880 compiled with @option{-mno-fp-regs} must also be compiled with that
8881 option.
8882
8883 A typical use of this option is building a kernel that does not use,
8884 and hence need not save and restore, any floating-point registers.
8885
8886 @item -mieee
8887 @opindex mieee
8888 The Alpha architecture implements floating-point hardware optimized for
8889 maximum performance.  It is mostly compliant with the IEEE floating
8890 point standard.  However, for full compliance, software assistance is
8891 required.  This option generates code fully IEEE compliant code
8892 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8893 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8894 defined during compilation.  The resulting code is less efficient but is
8895 able to correctly support denormalized numbers and exceptional IEEE
8896 values such as not-a-number and plus/minus infinity.  Other Alpha
8897 compilers call this option @option{-ieee_with_no_inexact}.
8898
8899 @item -mieee-with-inexact
8900 @opindex mieee-with-inexact
8901 This is like @option{-mieee} except the generated code also maintains
8902 the IEEE @var{inexact-flag}.  Turning on this option causes the
8903 generated code to implement fully-compliant IEEE math.  In addition to
8904 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8905 macro.  On some Alpha implementations the resulting code may execute
8906 significantly slower than the code generated by default.  Since there is
8907 very little code that depends on the @var{inexact-flag}, you should
8908 normally not specify this option.  Other Alpha compilers call this
8909 option @option{-ieee_with_inexact}.
8910
8911 @item -mfp-trap-mode=@var{trap-mode}
8912 @opindex mfp-trap-mode
8913 This option controls what floating-point related traps are enabled.
8914 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8915 The trap mode can be set to one of four values:
8916
8917 @table @samp
8918 @item n
8919 This is the default (normal) setting.  The only traps that are enabled
8920 are the ones that cannot be disabled in software (e.g., division by zero
8921 trap).
8922
8923 @item u
8924 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8925 as well.
8926
8927 @item su
8928 Like @samp{su}, but the instructions are marked to be safe for software
8929 completion (see Alpha architecture manual for details).
8930
8931 @item sui
8932 Like @samp{su}, but inexact traps are enabled as well.
8933 @end table
8934
8935 @item -mfp-rounding-mode=@var{rounding-mode}
8936 @opindex mfp-rounding-mode
8937 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8938 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8939 of:
8940
8941 @table @samp
8942 @item n
8943 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8944 the nearest machine number or towards the even machine number in case
8945 of a tie.
8946
8947 @item m
8948 Round towards minus infinity.
8949
8950 @item c
8951 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8952
8953 @item d
8954 Dynamic rounding mode.  A field in the floating point control register
8955 (@var{fpcr}, see Alpha architecture reference manual) controls the
8956 rounding mode in effect.  The C library initializes this register for
8957 rounding towards plus infinity.  Thus, unless your program modifies the
8958 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8959 @end table
8960
8961 @item -mtrap-precision=@var{trap-precision}
8962 @opindex mtrap-precision
8963 In the Alpha architecture, floating point traps are imprecise.  This
8964 means without software assistance it is impossible to recover from a
8965 floating trap and program execution normally needs to be terminated.
8966 GCC can generate code that can assist operating system trap handlers
8967 in determining the exact location that caused a floating point trap.
8968 Depending on the requirements of an application, different levels of
8969 precisions can be selected:
8970
8971 @table @samp
8972 @item p
8973 Program precision.  This option is the default and means a trap handler
8974 can only identify which program caused a floating point exception.
8975
8976 @item f
8977 Function precision.  The trap handler can determine the function that
8978 caused a floating point exception.
8979
8980 @item i
8981 Instruction precision.  The trap handler can determine the exact
8982 instruction that caused a floating point exception.
8983 @end table
8984
8985 Other Alpha compilers provide the equivalent options called
8986 @option{-scope_safe} and @option{-resumption_safe}.
8987
8988 @item -mieee-conformant
8989 @opindex mieee-conformant
8990 This option marks the generated code as IEEE conformant.  You must not
8991 use this option unless you also specify @option{-mtrap-precision=i} and either
8992 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8993 is to emit the line @samp{.eflag 48} in the function prologue of the
8994 generated assembly file.  Under DEC Unix, this has the effect that
8995 IEEE-conformant math library routines will be linked in.
8996
8997 @item -mbuild-constants
8998 @opindex mbuild-constants
8999 Normally GCC examines a 32- or 64-bit integer constant to
9000 see if it can construct it from smaller constants in two or three
9001 instructions.  If it cannot, it will output the constant as a literal and
9002 generate code to load it from the data segment at runtime.
9003
9004 Use this option to require GCC to construct @emph{all} integer constants
9005 using code, even if it takes more instructions (the maximum is six).
9006
9007 You would typically use this option to build a shared library dynamic
9008 loader.  Itself a shared library, it must relocate itself in memory
9009 before it can find the variables and constants in its own data segment.
9010
9011 @item -malpha-as
9012 @itemx -mgas
9013 @opindex malpha-as
9014 @opindex mgas
9015 Select whether to generate code to be assembled by the vendor-supplied
9016 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9017
9018 @item -mbwx
9019 @itemx -mno-bwx
9020 @itemx -mcix
9021 @itemx -mno-cix
9022 @itemx -mfix
9023 @itemx -mno-fix
9024 @itemx -mmax
9025 @itemx -mno-max
9026 @opindex mbwx
9027 @opindex mno-bwx
9028 @opindex mcix
9029 @opindex mno-cix
9030 @opindex mfix
9031 @opindex mno-fix
9032 @opindex mmax
9033 @opindex mno-max
9034 Indicate whether GCC should generate code to use the optional BWX,
9035 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9036 sets supported by the CPU type specified via @option{-mcpu=} option or that
9037 of the CPU on which GCC was built if none was specified.
9038
9039 @item -mfloat-vax
9040 @itemx -mfloat-ieee
9041 @opindex mfloat-vax
9042 @opindex mfloat-ieee
9043 Generate code that uses (does not use) VAX F and G floating point
9044 arithmetic instead of IEEE single and double precision.
9045
9046 @item -mexplicit-relocs
9047 @itemx -mno-explicit-relocs
9048 @opindex mexplicit-relocs
9049 @opindex mno-explicit-relocs
9050 Older Alpha assemblers provided no way to generate symbol relocations
9051 except via assembler macros.  Use of these macros does not allow
9052 optimal instruction scheduling.  GNU binutils as of version 2.12
9053 supports a new syntax that allows the compiler to explicitly mark
9054 which relocations should apply to which instructions.  This option
9055 is mostly useful for debugging, as GCC detects the capabilities of
9056 the assembler when it is built and sets the default accordingly.
9057
9058 @item -msmall-data
9059 @itemx -mlarge-data
9060 @opindex msmall-data
9061 @opindex mlarge-data
9062 When @option{-mexplicit-relocs} is in effect, static data is
9063 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9064 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9065 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9066 16-bit relocations off of the @code{$gp} register.  This limits the
9067 size of the small data area to 64KB, but allows the variables to be
9068 directly accessed via a single instruction.
9069
9070 The default is @option{-mlarge-data}.  With this option the data area
9071 is limited to just below 2GB.  Programs that require more than 2GB of
9072 data must use @code{malloc} or @code{mmap} to allocate the data in the
9073 heap instead of in the program's data segment.
9074
9075 When generating code for shared libraries, @option{-fpic} implies
9076 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9077
9078 @item -msmall-text
9079 @itemx -mlarge-text
9080 @opindex msmall-text
9081 @opindex mlarge-text
9082 When @option{-msmall-text} is used, the compiler assumes that the
9083 code of the entire program (or shared library) fits in 4MB, and is
9084 thus reachable with a branch instruction.  When @option{-msmall-data}
9085 is used, the compiler can assume that all local symbols share the
9086 same @code{$gp} value, and thus reduce the number of instructions
9087 required for a function call from 4 to 1.
9088
9089 The default is @option{-mlarge-text}.
9090
9091 @item -mcpu=@var{cpu_type}
9092 @opindex mcpu
9093 Set the instruction set and instruction scheduling parameters for
9094 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9095 style name or the corresponding chip number.  GCC supports scheduling
9096 parameters for the EV4, EV5 and EV6 family of processors and will
9097 choose the default values for the instruction set from the processor
9098 you specify.  If you do not specify a processor type, GCC will default
9099 to the processor on which the compiler was built.
9100
9101 Supported values for @var{cpu_type} are
9102
9103 @table @samp
9104 @item ev4
9105 @item ev45
9106 @itemx 21064
9107 Schedules as an EV4 and has no instruction set extensions.
9108
9109 @item ev5
9110 @itemx 21164
9111 Schedules as an EV5 and has no instruction set extensions.
9112
9113 @item ev56
9114 @itemx 21164a
9115 Schedules as an EV5 and supports the BWX extension.
9116
9117 @item pca56
9118 @itemx 21164pc
9119 @itemx 21164PC
9120 Schedules as an EV5 and supports the BWX and MAX extensions.
9121
9122 @item ev6
9123 @itemx 21264
9124 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9125
9126 @item ev67
9127 @item 21264a
9128 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9129 @end table
9130
9131 @item -mtune=@var{cpu_type}
9132 @opindex mtune
9133 Set only the instruction scheduling parameters for machine type
9134 @var{cpu_type}.  The instruction set is not changed.
9135
9136 @item -mmemory-latency=@var{time}
9137 @opindex mmemory-latency
9138 Sets the latency the scheduler should assume for typical memory
9139 references as seen by the application.  This number is highly
9140 dependent on the memory access patterns used by the application
9141 and the size of the external cache on the machine.
9142
9143 Valid options for @var{time} are
9144
9145 @table @samp
9146 @item @var{number}
9147 A decimal number representing clock cycles.
9148
9149 @item L1
9150 @itemx L2
9151 @itemx L3
9152 @itemx main
9153 The compiler contains estimates of the number of clock cycles for
9154 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9155 (also called Dcache, Scache, and Bcache), as well as to main memory.
9156 Note that L3 is only valid for EV5.
9157
9158 @end table
9159 @end table
9160
9161 @node DEC Alpha/VMS Options
9162 @subsection DEC Alpha/VMS Options
9163
9164 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9165
9166 @table @gcctabopt
9167 @item -mvms-return-codes
9168 @opindex mvms-return-codes
9169 Return VMS condition codes from main.  The default is to return POSIX
9170 style condition (e.g.@ error) codes.
9171 @end table
9172
9173 @node H8/300 Options
9174 @subsection H8/300 Options
9175
9176 These @samp{-m} options are defined for the H8/300 implementations:
9177
9178 @table @gcctabopt
9179 @item -mrelax
9180 @opindex mrelax
9181 Shorten some address references at link time, when possible; uses the
9182 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9183 ld.info, Using ld}, for a fuller description.
9184
9185 @item -mh
9186 @opindex mh
9187 Generate code for the H8/300H@.
9188
9189 @item -ms
9190 @opindex ms
9191 Generate code for the H8S@.
9192
9193 @item -mn
9194 @opindex mn
9195 Generate code for the H8S and H8/300H in the normal mode.  This switch
9196 must be used either with -mh or -ms.
9197
9198 @item -ms2600
9199 @opindex ms2600
9200 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9201
9202 @item -mint32
9203 @opindex mint32
9204 Make @code{int} data 32 bits by default.
9205
9206 @item -malign-300
9207 @opindex malign-300
9208 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9209 The default for the H8/300H and H8S is to align longs and floats on 4
9210 byte boundaries.
9211 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9212 This option has no effect on the H8/300.
9213 @end table
9214
9215 @node SH Options
9216 @subsection SH Options
9217
9218 These @samp{-m} options are defined for the SH implementations:
9219
9220 @table @gcctabopt
9221 @item -m1
9222 @opindex m1
9223 Generate code for the SH1.
9224
9225 @item -m2
9226 @opindex m2
9227 Generate code for the SH2.
9228
9229 @item -m2e
9230 Generate code for the SH2e.
9231
9232 @item -m3
9233 @opindex m3
9234 Generate code for the SH3.
9235
9236 @item -m3e
9237 @opindex m3e
9238 Generate code for the SH3e.
9239
9240 @item -m4-nofpu
9241 @opindex m4-nofpu
9242 Generate code for the SH4 without a floating-point unit.
9243
9244 @item -m4-single-only
9245 @opindex m4-single-only
9246 Generate code for the SH4 with a floating-point unit that only
9247 supports single-precision arithmetic.
9248
9249 @item -m4-single
9250 @opindex m4-single
9251 Generate code for the SH4 assuming the floating-point unit is in
9252 single-precision mode by default.
9253
9254 @item -m4
9255 @opindex m4
9256 Generate code for the SH4.
9257
9258 @item -mb
9259 @opindex mb
9260 Compile code for the processor in big endian mode.
9261
9262 @item -ml
9263 @opindex ml
9264 Compile code for the processor in little endian mode.
9265
9266 @item -mdalign
9267 @opindex mdalign
9268 Align doubles at 64-bit boundaries.  Note that this changes the calling
9269 conventions, and thus some functions from the standard C library will
9270 not work unless you recompile it first with @option{-mdalign}.
9271
9272 @item -mrelax
9273 @opindex mrelax
9274 Shorten some address references at link time, when possible; uses the
9275 linker option @option{-relax}.
9276
9277 @item -mbigtable
9278 @opindex mbigtable
9279 Use 32-bit offsets in @code{switch} tables.  The default is to use
9280 16-bit offsets.
9281
9282 @item -mfmovd
9283 @opindex mfmovd
9284 Enable the use of the instruction @code{fmovd}.
9285
9286 @item -mhitachi
9287 @opindex mhitachi
9288 Comply with the calling conventions defined by Renesas.
9289
9290 @item -mnomacsave
9291 @opindex mnomacsave
9292 Mark the @code{MAC} register as call-clobbered, even if
9293 @option{-mhitachi} is given.
9294
9295 @item -mieee
9296 @opindex mieee
9297 Increase IEEE-compliance of floating-point code.
9298
9299 @item -misize
9300 @opindex misize
9301 Dump instruction size and location in the assembly code.
9302
9303 @item -mpadstruct
9304 @opindex mpadstruct
9305 This option is deprecated.  It pads structures to multiple of 4 bytes,
9306 which is incompatible with the SH ABI@.
9307
9308 @item -mspace
9309 @opindex mspace
9310 Optimize for space instead of speed.  Implied by @option{-Os}.
9311
9312 @item -mprefergot
9313 @opindex mprefergot
9314 When generating position-independent code, emit function calls using
9315 the Global Offset Table instead of the Procedure Linkage Table.
9316
9317 @item -musermode
9318 @opindex musermode
9319 Generate a library function call to invalidate instruction cache
9320 entries, after fixing up a trampoline.  This library function call
9321 doesn't assume it can write to the whole memory address space.  This
9322 is the default when the target is @code{sh-*-linux*}.
9323 @end table
9324
9325 @node System V Options
9326 @subsection Options for System V
9327
9328 These additional options are available on System V Release 4 for
9329 compatibility with other compilers on those systems:
9330
9331 @table @gcctabopt
9332 @item -G
9333 @opindex G
9334 Create a shared object.
9335 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9336
9337 @item -Qy
9338 @opindex Qy
9339 Identify the versions of each tool used by the compiler, in a
9340 @code{.ident} assembler directive in the output.
9341
9342 @item -Qn
9343 @opindex Qn
9344 Refrain from adding @code{.ident} directives to the output file (this is
9345 the default).
9346
9347 @item -YP,@var{dirs}
9348 @opindex YP
9349 Search the directories @var{dirs}, and no others, for libraries
9350 specified with @option{-l}.
9351
9352 @item -Ym,@var{dir}
9353 @opindex Ym
9354 Look in the directory @var{dir} to find the M4 preprocessor.
9355 The assembler uses this option.
9356 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9357 @c the generic assembler that comes with Solaris takes just -Ym.
9358 @end table
9359
9360 @node TMS320C3x/C4x Options
9361 @subsection TMS320C3x/C4x Options
9362 @cindex TMS320C3x/C4x Options
9363
9364 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9365
9366 @table @gcctabopt
9367
9368 @item -mcpu=@var{cpu_type}
9369 @opindex mcpu
9370 Set the instruction set, register set, and instruction scheduling
9371 parameters for machine type @var{cpu_type}.  Supported values for
9372 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9373 @samp{c44}.  The default is @samp{c40} to generate code for the
9374 TMS320C40.
9375
9376 @item -mbig-memory
9377 @item -mbig
9378 @itemx -msmall-memory
9379 @itemx -msmall
9380 @opindex mbig-memory
9381 @opindex mbig
9382 @opindex msmall-memory
9383 @opindex msmall
9384 Generates code for the big or small memory model.  The small memory
9385 model assumed that all data fits into one 64K word page.  At run-time
9386 the data page (DP) register must be set to point to the 64K page
9387 containing the .bss and .data program sections.  The big memory model is
9388 the default and requires reloading of the DP register for every direct
9389 memory access.
9390
9391 @item -mbk
9392 @itemx -mno-bk
9393 @opindex mbk
9394 @opindex mno-bk
9395 Allow (disallow) allocation of general integer operands into the block
9396 count register BK@.
9397
9398 @item -mdb
9399 @itemx -mno-db
9400 @opindex mdb
9401 @opindex mno-db
9402 Enable (disable) generation of code using decrement and branch,
9403 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9404 on the safe side, this is disabled for the C3x, since the maximum
9405 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9406 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9407 that it can utilize the decrement and branch instruction, but will give
9408 up if there is more than one memory reference in the loop.  Thus a loop
9409 where the loop counter is decremented can generate slightly more
9410 efficient code, in cases where the RPTB instruction cannot be utilized.
9411
9412 @item -mdp-isr-reload
9413 @itemx -mparanoid
9414 @opindex mdp-isr-reload
9415 @opindex mparanoid
9416 Force the DP register to be saved on entry to an interrupt service
9417 routine (ISR), reloaded to point to the data section, and restored on
9418 exit from the ISR@.  This should not be required unless someone has
9419 violated the small memory model by modifying the DP register, say within
9420 an object library.
9421
9422 @item -mmpyi
9423 @itemx -mno-mpyi
9424 @opindex mmpyi
9425 @opindex mno-mpyi
9426 For the C3x use the 24-bit MPYI instruction for integer multiplies
9427 instead of a library call to guarantee 32-bit results.  Note that if one
9428 of the operands is a constant, then the multiplication will be performed
9429 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9430 then squaring operations are performed inline instead of a library call.
9431
9432 @item -mfast-fix
9433 @itemx -mno-fast-fix
9434 @opindex mfast-fix
9435 @opindex mno-fast-fix
9436 The C3x/C4x FIX instruction to convert a floating point value to an
9437 integer value chooses the nearest integer less than or equal to the
9438 floating point value rather than to the nearest integer.  Thus if the
9439 floating point number is negative, the result will be incorrectly
9440 truncated an additional code is necessary to detect and correct this
9441 case.  This option can be used to disable generation of the additional
9442 code required to correct the result.
9443
9444 @item -mrptb
9445 @itemx -mno-rptb
9446 @opindex mrptb
9447 @opindex mno-rptb
9448 Enable (disable) generation of repeat block sequences using the RPTB
9449 instruction for zero overhead looping.  The RPTB construct is only used
9450 for innermost loops that do not call functions or jump across the loop
9451 boundaries.  There is no advantage having nested RPTB loops due to the
9452 overhead required to save and restore the RC, RS, and RE registers.
9453 This is enabled by default with @option{-O2}.
9454
9455 @item -mrpts=@var{count}
9456 @itemx -mno-rpts
9457 @opindex mrpts
9458 @opindex mno-rpts
9459 Enable (disable) the use of the single instruction repeat instruction
9460 RPTS@.  If a repeat block contains a single instruction, and the loop
9461 count can be guaranteed to be less than the value @var{count}, GCC will
9462 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9463 then a RPTS will be emitted even if the loop count cannot be determined
9464 at compile time.  Note that the repeated instruction following RPTS does
9465 not have to be reloaded from memory each iteration, thus freeing up the
9466 CPU buses for operands.  However, since interrupts are blocked by this
9467 instruction, it is disabled by default.
9468
9469 @item -mloop-unsigned
9470 @itemx -mno-loop-unsigned
9471 @opindex mloop-unsigned
9472 @opindex mno-loop-unsigned
9473 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9474 is @math{2^{31} + 1} since these instructions test if the iteration count is
9475 negative to terminate the loop.  If the iteration count is unsigned
9476 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9477 exceeded.  This switch allows an unsigned iteration count.
9478
9479 @item -mti
9480 @opindex mti
9481 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9482 with.  This also enforces compatibility with the API employed by the TI
9483 C3x C compiler.  For example, long doubles are passed as structures
9484 rather than in floating point registers.
9485
9486 @item -mregparm
9487 @itemx -mmemparm
9488 @opindex mregparm
9489 @opindex mmemparm
9490 Generate code that uses registers (stack) for passing arguments to functions.
9491 By default, arguments are passed in registers where possible rather
9492 than by pushing arguments on to the stack.
9493
9494 @item -mparallel-insns
9495 @itemx -mno-parallel-insns
9496 @opindex mparallel-insns
9497 @opindex mno-parallel-insns
9498 Allow the generation of parallel instructions.  This is enabled by
9499 default with @option{-O2}.
9500
9501 @item -mparallel-mpy
9502 @itemx -mno-parallel-mpy
9503 @opindex mparallel-mpy
9504 @opindex mno-parallel-mpy
9505 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9506 provided @option{-mparallel-insns} is also specified.  These instructions have
9507 tight register constraints which can pessimize the code generation
9508 of large functions.
9509
9510 @end table
9511
9512 @node V850 Options
9513 @subsection V850 Options
9514 @cindex V850 Options
9515
9516 These @samp{-m} options are defined for V850 implementations:
9517
9518 @table @gcctabopt
9519 @item -mlong-calls
9520 @itemx -mno-long-calls
9521 @opindex mlong-calls
9522 @opindex mno-long-calls
9523 Treat all calls as being far away (near).  If calls are assumed to be
9524 far away, the compiler will always load the functions address up into a
9525 register, and call indirect through the pointer.
9526
9527 @item -mno-ep
9528 @itemx -mep
9529 @opindex mno-ep
9530 @opindex mep
9531 Do not optimize (do optimize) basic blocks that use the same index
9532 pointer 4 or more times to copy pointer into the @code{ep} register, and
9533 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9534 option is on by default if you optimize.
9535
9536 @item -mno-prolog-function
9537 @itemx -mprolog-function
9538 @opindex mno-prolog-function
9539 @opindex mprolog-function
9540 Do not use (do use) external functions to save and restore registers at
9541 the prolog and epilog of a function.  The external functions are slower,
9542 but use less code space if more than one function saves the same number
9543 of registers.  The @option{-mprolog-function} option is on by default if
9544 you optimize.
9545
9546 @item -mspace
9547 @opindex mspace
9548 Try to make the code as small as possible.  At present, this just turns
9549 on the @option{-mep} and @option{-mprolog-function} options.
9550
9551 @item -mtda=@var{n}
9552 @opindex mtda
9553 Put static or global variables whose size is @var{n} bytes or less into
9554 the tiny data area that register @code{ep} points to.  The tiny data
9555 area can hold up to 256 bytes in total (128 bytes for byte references).
9556
9557 @item -msda=@var{n}
9558 @opindex msda
9559 Put static or global variables whose size is @var{n} bytes or less into
9560 the small data area that register @code{gp} points to.  The small data
9561 area can hold up to 64 kilobytes.
9562
9563 @item -mzda=@var{n}
9564 @opindex mzda
9565 Put static or global variables whose size is @var{n} bytes or less into
9566 the first 32 kilobytes of memory.
9567
9568 @item -mv850
9569 @opindex mv850
9570 Specify that the target processor is the V850.
9571
9572 @item -mbig-switch
9573 @opindex mbig-switch
9574 Generate code suitable for big switch tables.  Use this option only if
9575 the assembler/linker complain about out of range branches within a switch
9576 table.
9577
9578 @item -mapp-regs
9579 @opindex mapp-regs
9580 This option will cause r2 and r5 to be used in the code generated by
9581 the compiler.  This setting is the default.
9582
9583 @item -mno-app-regs
9584 @opindex mno-app-regs
9585 This option will cause r2 and r5 to be treated as fixed registers.
9586   
9587 @item -mv850e
9588 @opindex mv850e
9589 Specify that the target processor is the V850E.  The preprocessor
9590 constant @samp{__v850e__} will be defined if this option is used.
9591
9592 If neither @option{-mv850} nor @option{-mv850e} are defined
9593 then a default target processor will be chosen and the relevant
9594 @samp{__v850*__} preprocessor constant will be defined.
9595
9596 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9597 defined, regardless of which processor variant is the target.
9598
9599 @item -mdisable-callt
9600 @opindex mdisable-callt
9601 This option will suppress generation of the CALLT instruction for the
9602 v850e flavors of the v850 architecture.  The default is
9603 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9604
9605 @end table
9606
9607 @node ARC Options
9608 @subsection ARC Options
9609 @cindex ARC Options
9610
9611 These options are defined for ARC implementations:
9612
9613 @table @gcctabopt
9614 @item -EL
9615 @opindex EL
9616 Compile code for little endian mode.  This is the default.
9617
9618 @item -EB
9619 @opindex EB
9620 Compile code for big endian mode.
9621
9622 @item -mmangle-cpu
9623 @opindex mmangle-cpu
9624 Prepend the name of the cpu to all public symbol names.
9625 In multiple-processor systems, there are many ARC variants with different
9626 instruction and register set characteristics.  This flag prevents code
9627 compiled for one cpu to be linked with code compiled for another.
9628 No facility exists for handling variants that are ``almost identical''.
9629 This is an all or nothing option.
9630
9631 @item -mcpu=@var{cpu}
9632 @opindex mcpu
9633 Compile code for ARC variant @var{cpu}.
9634 Which variants are supported depend on the configuration.
9635 All variants support @option{-mcpu=base}, this is the default.
9636
9637 @item -mtext=@var{text-section}
9638 @itemx -mdata=@var{data-section}
9639 @itemx -mrodata=@var{readonly-data-section}
9640 @opindex mtext
9641 @opindex mdata
9642 @opindex mrodata
9643 Put functions, data, and readonly data in @var{text-section},
9644 @var{data-section}, and @var{readonly-data-section} respectively
9645 by default.  This can be overridden with the @code{section} attribute.
9646 @xref{Variable Attributes}.
9647
9648 @end table
9649
9650 @node NS32K Options
9651 @subsection NS32K Options
9652 @cindex NS32K options
9653
9654 These are the @samp{-m} options defined for the 32000 series.  The default
9655 values for these options depends on which style of 32000 was selected when
9656 the compiler was configured; the defaults for the most common choices are
9657 given below.
9658
9659 @table @gcctabopt
9660 @item -m32032
9661 @itemx -m32032
9662 @opindex m32032
9663 @opindex m32032
9664 Generate output for a 32032.  This is the default
9665 when the compiler is configured for 32032 and 32016 based systems.
9666
9667 @item -m32332
9668 @itemx -m32332
9669 @opindex m32332
9670 @opindex m32332
9671 Generate output for a 32332.  This is the default
9672 when the compiler is configured for 32332-based systems.
9673
9674 @item -m32532
9675 @itemx -m32532
9676 @opindex m32532
9677 @opindex m32532
9678 Generate output for a 32532.  This is the default
9679 when the compiler is configured for 32532-based systems.
9680
9681 @item -m32081
9682 @opindex m32081
9683 Generate output containing 32081 instructions for floating point.
9684 This is the default for all systems.
9685
9686 @item -m32381
9687 @opindex m32381
9688 Generate output containing 32381 instructions for floating point.  This
9689 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9690 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9691
9692 @item -mmulti-add
9693 @opindex mmulti-add
9694 Try and generate multiply-add floating point instructions @code{polyF}
9695 and @code{dotF}.  This option is only available if the @option{-m32381}
9696 option is in effect.  Using these instructions requires changes to
9697 register allocation which generally has a negative impact on
9698 performance.  This option should only be enabled when compiling code
9699 particularly likely to make heavy use of multiply-add instructions.
9700
9701 @item -mnomulti-add
9702 @opindex mnomulti-add
9703 Do not try and generate multiply-add floating point instructions
9704 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9705
9706 @item -msoft-float
9707 @opindex msoft-float
9708 Generate output containing library calls for floating point.
9709 @strong{Warning:} the requisite libraries may not be available.
9710
9711 @item -mieee-compare
9712 @itemx -mno-ieee-compare
9713 @opindex mieee-compare
9714 @opindex mno-ieee-compare
9715 Control whether or not the compiler uses IEEE floating point
9716 comparisons.  These handle correctly the case where the result of a
9717 comparison is unordered.
9718 @strong{Warning:} the requisite kernel support may not be available.
9719
9720 @item -mnobitfield
9721 @opindex mnobitfield
9722 Do not use the bit-field instructions.  On some machines it is faster to
9723 use shifting and masking operations.  This is the default for the pc532.
9724
9725 @item -mbitfield
9726 @opindex mbitfield
9727 Do use the bit-field instructions.  This is the default for all platforms
9728 except the pc532.
9729
9730 @item -mrtd
9731 @opindex mrtd
9732 Use a different function-calling convention, in which functions
9733 that take a fixed number of arguments return pop their
9734 arguments on return with the @code{ret} instruction.
9735
9736 This calling convention is incompatible with the one normally
9737 used on Unix, so you cannot use it if you need to call libraries
9738 compiled with the Unix compiler.
9739
9740 Also, you must provide function prototypes for all functions that
9741 take variable numbers of arguments (including @code{printf});
9742 otherwise incorrect code will be generated for calls to those
9743 functions.
9744
9745 In addition, seriously incorrect code will result if you call a
9746 function with too many arguments.  (Normally, extra arguments are
9747 harmlessly ignored.)
9748
9749 This option takes its name from the 680x0 @code{rtd} instruction.
9750
9751
9752 @item -mregparam
9753 @opindex mregparam
9754 Use a different function-calling convention where the first two arguments
9755 are passed in registers.
9756
9757 This calling convention is incompatible with the one normally
9758 used on Unix, so you cannot use it if you need to call libraries
9759 compiled with the Unix compiler.
9760
9761 @item -mnoregparam
9762 @opindex mnoregparam
9763 Do not pass any arguments in registers.  This is the default for all
9764 targets.
9765
9766 @item -msb
9767 @opindex msb
9768 It is OK to use the sb as an index register which is always loaded with
9769 zero.  This is the default for the pc532-netbsd target.
9770
9771 @item -mnosb
9772 @opindex mnosb
9773 The sb register is not available for use or has not been initialized to
9774 zero by the run time system.  This is the default for all targets except
9775 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9776 @option{-fpic} is set.
9777
9778 @item -mhimem
9779 @opindex mhimem
9780 Many ns32000 series addressing modes use displacements of up to 512MB@.
9781 If an address is above 512MB then displacements from zero can not be used.
9782 This option causes code to be generated which can be loaded above 512MB@.
9783 This may be useful for operating systems or ROM code.
9784
9785 @item -mnohimem
9786 @opindex mnohimem
9787 Assume code will be loaded in the first 512MB of virtual address space.
9788 This is the default for all platforms.
9789
9790
9791 @end table
9792
9793 @node AVR Options
9794 @subsection AVR Options
9795 @cindex AVR Options
9796
9797 These options are defined for AVR implementations:
9798
9799 @table @gcctabopt
9800 @item -mmcu=@var{mcu}
9801 @opindex mmcu
9802 Specify ATMEL AVR instruction set or MCU type.
9803
9804 Instruction set avr1 is for the minimal AVR core, not supported by the C
9805 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9806 attiny11, attiny12, attiny15, attiny28).
9807
9808 Instruction set avr2 (default) is for the classic AVR core with up to
9809 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9810 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9811 at90c8534, at90s8535).
9812
9813 Instruction set avr3 is for the classic AVR core with up to 128K program
9814 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9815
9816 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9817 memory space (MCU types: atmega8, atmega83, atmega85).
9818
9819 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9820 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9821 atmega64, atmega128, at43usb355, at94k).
9822
9823 @item -msize
9824 @opindex msize
9825 Output instruction sizes to the asm file.
9826
9827 @item -minit-stack=@var{N}
9828 @opindex minit-stack
9829 Specify the initial stack address, which may be a symbol or numeric value,
9830 @samp{__stack} is the default.
9831
9832 @item -mno-interrupts
9833 @opindex mno-interrupts
9834 Generated code is not compatible with hardware interrupts.
9835 Code size will be smaller.
9836
9837 @item -mcall-prologues
9838 @opindex mcall-prologues
9839 Functions prologues/epilogues expanded as call to appropriate
9840 subroutines.  Code size will be smaller.
9841
9842 @item -mno-tablejump
9843 @opindex mno-tablejump
9844 Do not generate tablejump insns which sometimes increase code size.
9845
9846 @item -mtiny-stack
9847 @opindex mtiny-stack
9848 Change only the low 8 bits of the stack pointer.
9849 @end table
9850
9851 @node MCore Options
9852 @subsection MCore Options
9853 @cindex MCore options
9854
9855 These are the @samp{-m} options defined for the Motorola M*Core
9856 processors.
9857
9858 @table @gcctabopt
9859
9860 @item -mhardlit
9861 @itemx -mno-hardlit
9862 @opindex mhardlit
9863 @opindex mno-hardlit
9864 Inline constants into the code stream if it can be done in two
9865 instructions or less.
9866
9867 @item -mdiv
9868 @itemx -mno-div
9869 @opindex mdiv
9870 @opindex mno-div
9871 Use the divide instruction.  (Enabled by default).
9872
9873 @item -mrelax-immediate
9874 @itemx -mno-relax-immediate
9875 @opindex mrelax-immediate
9876 @opindex mno-relax-immediate
9877 Allow arbitrary sized immediates in bit operations.
9878
9879 @item -mwide-bitfields
9880 @itemx -mno-wide-bitfields
9881 @opindex mwide-bitfields
9882 @opindex mno-wide-bitfields
9883 Always treat bit-fields as int-sized.
9884
9885 @item -m4byte-functions
9886 @itemx -mno-4byte-functions
9887 @opindex m4byte-functions
9888 @opindex mno-4byte-functions
9889 Force all functions to be aligned to a four byte boundary.
9890
9891 @item -mcallgraph-data
9892 @itemx -mno-callgraph-data
9893 @opindex mcallgraph-data
9894 @opindex mno-callgraph-data
9895 Emit callgraph information.
9896
9897 @item -mslow-bytes
9898 @itemx -mno-slow-bytes
9899 @opindex mslow-bytes
9900 @opindex mno-slow-bytes
9901 Prefer word access when reading byte quantities.
9902
9903 @item -mlittle-endian
9904 @itemx -mbig-endian
9905 @opindex mlittle-endian
9906 @opindex mbig-endian
9907 Generate code for a little endian target.
9908
9909 @item -m210
9910 @itemx -m340
9911 @opindex m210
9912 @opindex m340
9913 Generate code for the 210 processor.
9914 @end table
9915
9916 @node IA-64 Options
9917 @subsection IA-64 Options
9918 @cindex IA-64 Options
9919
9920 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9921
9922 @table @gcctabopt
9923 @item -mbig-endian
9924 @opindex mbig-endian
9925 Generate code for a big endian target.  This is the default for HP-UX@.
9926
9927 @item -mlittle-endian
9928 @opindex mlittle-endian
9929 Generate code for a little endian target.  This is the default for AIX5
9930 and Linux.
9931
9932 @item -mgnu-as
9933 @itemx -mno-gnu-as
9934 @opindex mgnu-as
9935 @opindex mno-gnu-as
9936 Generate (or don't) code for the GNU assembler.  This is the default.
9937 @c Also, this is the default if the configure option @option{--with-gnu-as}
9938 @c is used.
9939
9940 @item -mgnu-ld
9941 @itemx -mno-gnu-ld
9942 @opindex mgnu-ld
9943 @opindex mno-gnu-ld
9944 Generate (or don't) code for the GNU linker.  This is the default.
9945 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9946 @c is used.
9947
9948 @item -mno-pic
9949 @opindex mno-pic
9950 Generate code that does not use a global pointer register.  The result
9951 is not position independent code, and violates the IA-64 ABI@.
9952
9953 @item -mvolatile-asm-stop
9954 @itemx -mno-volatile-asm-stop
9955 @opindex mvolatile-asm-stop
9956 @opindex mno-volatile-asm-stop
9957 Generate (or don't) a stop bit immediately before and after volatile asm
9958 statements.
9959
9960 @item -mb-step
9961 @opindex mb-step
9962 Generate code that works around Itanium B step errata.
9963
9964 @item -mregister-names
9965 @itemx -mno-register-names
9966 @opindex mregister-names
9967 @opindex mno-register-names
9968 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9969 the stacked registers.  This may make assembler output more readable.
9970
9971 @item -mno-sdata
9972 @itemx -msdata
9973 @opindex mno-sdata
9974 @opindex msdata
9975 Disable (or enable) optimizations that use the small data section.  This may
9976 be useful for working around optimizer bugs.
9977
9978 @item -mconstant-gp
9979 @opindex mconstant-gp
9980 Generate code that uses a single constant global pointer value.  This is
9981 useful when compiling kernel code.
9982
9983 @item -mauto-pic
9984 @opindex mauto-pic
9985 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9986 This is useful when compiling firmware code.
9987
9988 @item -minline-float-divide-min-latency
9989 @opindex minline-float-divide-min-latency
9990 Generate code for inline divides of floating point values
9991 using the minimum latency algorithm.
9992
9993 @item -minline-float-divide-max-throughput
9994 @opindex minline-float-divide-max-throughput
9995 Generate code for inline divides of floating point values
9996 using the maximum throughput algorithm.
9997
9998 @item -minline-int-divide-min-latency
9999 @opindex minline-int-divide-min-latency
10000 Generate code for inline divides of integer values
10001 using the minimum latency algorithm.
10002
10003 @item -minline-int-divide-max-throughput
10004 @opindex minline-int-divide-max-throughput
10005 Generate code for inline divides of integer values
10006 using the maximum throughput algorithm.
10007
10008 @item -mno-dwarf2-asm
10009 @itemx -mdwarf2-asm
10010 @opindex mno-dwarf2-asm
10011 @opindex mdwarf2-asm
10012 Don't (or do) generate assembler code for the DWARF2 line number debugging
10013 info.  This may be useful when not using the GNU assembler.
10014
10015 @item -mfixed-range=@var{register-range}
10016 @opindex mfixed-range
10017 Generate code treating the given register range as fixed registers.
10018 A fixed register is one that the register allocator can not use.  This is
10019 useful when compiling kernel code.  A register range is specified as
10020 two registers separated by a dash.  Multiple register ranges can be
10021 specified separated by a comma.
10022
10023 @item -mearly-stop-bits
10024 @itemx -mno-early-stop-bits
10025 @opindex mearly-stop-bits
10026 @opindex mno-early-stop-bits
10027 Allow stop bits to be placed earlier than immediately preceding the
10028 instruction that triggered the stop bit.  This can improve instruction
10029 scheduling, but does not always do so.
10030 @end table
10031
10032 @node D30V Options
10033 @subsection D30V Options
10034 @cindex D30V Options
10035
10036 These @samp{-m} options are defined for D30V implementations:
10037
10038 @table @gcctabopt
10039 @item -mextmem
10040 @opindex mextmem
10041 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10042 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10043 memory, which starts at location @code{0x80000000}.
10044
10045 @item -mextmemory
10046 @opindex mextmemory
10047 Same as the @option{-mextmem} switch.
10048
10049 @item -monchip
10050 @opindex monchip
10051 Link the @samp{.text} section into onchip text memory, which starts at
10052 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10053 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10054 into onchip data memory, which starts at location @code{0x20000000}.
10055
10056 @item -mno-asm-optimize
10057 @itemx -masm-optimize
10058 @opindex mno-asm-optimize
10059 @opindex masm-optimize
10060 Disable (enable) passing @option{-O} to the assembler when optimizing.
10061 The assembler uses the @option{-O} option to automatically parallelize
10062 adjacent short instructions where possible.
10063
10064 @item -mbranch-cost=@var{n}
10065 @opindex mbranch-cost
10066 Increase the internal costs of branches to @var{n}.  Higher costs means
10067 that the compiler will issue more instructions to avoid doing a branch.
10068 The default is 2.
10069
10070 @item -mcond-exec=@var{n}
10071 @opindex mcond-exec
10072 Specify the maximum number of conditionally executed instructions that
10073 replace a branch.  The default is 4.
10074 @end table
10075
10076 @node S/390 and zSeries Options
10077 @subsection S/390 and zSeries Options
10078 @cindex S/390 and zSeries Options
10079
10080 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10081
10082 @table @gcctabopt
10083 @item -mhard-float
10084 @itemx -msoft-float
10085 @opindex mhard-float
10086 @opindex msoft-float
10087 Use (do not use) the hardware floating-point instructions and registers
10088 for floating-point operations.  When @option{-msoft-float} is specified,
10089 functions in @file{libgcc.a} will be used to perform floating-point
10090 operations.  When @option{-mhard-float} is specified, the compiler
10091 generates IEEE floating-point instructions.  This is the default.
10092
10093 @item -mbackchain
10094 @itemx -mno-backchain
10095 @opindex mbackchain
10096 @opindex mno-backchain
10097 Generate (or do not generate) code which maintains an explicit
10098 backchain within the stack frame that points to the caller's frame.
10099 This is currently needed to allow debugging.  The default is to
10100 generate the backchain.
10101
10102 @item -msmall-exec
10103 @itemx -mno-small-exec
10104 @opindex msmall-exec
10105 @opindex mno-small-exec
10106 Generate (or do not generate) code using the @code{bras} instruction
10107 to do subroutine calls.
10108 This only works reliably if the total executable size does not
10109 exceed 64k.  The default is to use the @code{basr} instruction instead,
10110 which does not have this limitation.
10111
10112 @item -m64
10113 @itemx -m31
10114 @opindex m64
10115 @opindex m31
10116 When @option{-m31} is specified, generate code compliant to the
10117 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10118 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10119 particular to generate 64-bit instructions.  For the @samp{s390}
10120 targets, the default is @option{-m31}, while the @samp{s390x}
10121 targets default to @option{-m64}.
10122
10123 @item -mzarch
10124 @itemx -mesa
10125 @opindex mzarch
10126 @opindex mesa
10127 When @option{-mzarch} is specified, generate code using the 
10128 instructions available on z/Architecture. 
10129 When @option{-mesa} is specified, generate code using the 
10130 instructions available on ESA/390. Note that @option{-mesa} is
10131 not possible with @option{-m64}.
10132 For the @samp{s390} targets, the default is @option{-mesa}, 
10133 while the @samp{s390x} targets default to @option{-mzarch}.
10134
10135 @item -mmvcle
10136 @itemx -mno-mvcle
10137 @opindex mmvcle
10138 @opindex mno-mvcle
10139 Generate (or do not generate) code using the @code{mvcle} instruction
10140 to perform block moves.  When @option{-mno-mvcle} is specified,
10141 use a @code{mvc} loop instead.  This is the default.
10142
10143 @item -mdebug
10144 @itemx -mno-debug
10145 @opindex mdebug
10146 @opindex mno-debug
10147 Print (or do not print) additional debug information when compiling.
10148 The default is to not print debug information.
10149
10150 @item -march=@var{arch}
10151 @opindex march
10152 Generate code that will run on @var{arch}, which is the name of system
10153 representing a certain processor type. Possible values for
10154 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
10155
10156 @item -mtune=@var{arch}
10157 @opindex mtune
10158 Tune to @var{cpu-type} everything applicable about the generated code,
10159  except for the ABI and the set of available instructions. 
10160 The list of @var{arch} values is the same as for @option{-march}.
10161
10162 @end table
10163
10164 @node CRIS Options
10165 @subsection CRIS Options
10166 @cindex CRIS Options
10167
10168 These options are defined specifically for the CRIS ports.
10169
10170 @table @gcctabopt
10171 @item -march=@var{architecture-type}
10172 @itemx -mcpu=@var{architecture-type}
10173 @opindex march
10174 @opindex mcpu
10175 Generate code for the specified architecture.  The choices for
10176 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10177 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10178 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10179 @samp{v10}.
10180
10181 @item -mtune=@var{architecture-type}
10182 @opindex mtune
10183 Tune to @var{architecture-type} everything applicable about the generated
10184 code, except for the ABI and the set of available instructions.  The
10185 choices for @var{architecture-type} are the same as for
10186 @option{-march=@var{architecture-type}}.
10187
10188 @item -mmax-stack-frame=@var{n}
10189 @opindex mmax-stack-frame
10190 Warn when the stack frame of a function exceeds @var{n} bytes.
10191
10192 @item -melinux-stacksize=@var{n}
10193 @opindex melinux-stacksize
10194 Only available with the @samp{cris-axis-aout} target.  Arranges for
10195 indications in the program to the kernel loader that the stack of the
10196 program should be set to @var{n} bytes.
10197
10198 @item -metrax4
10199 @itemx -metrax100
10200 @opindex metrax4
10201 @opindex metrax100
10202 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10203 @option{-march=v3} and @option{-march=v8} respectively.
10204
10205 @item -mpdebug
10206 @opindex mpdebug
10207 Enable CRIS-specific verbose debug-related information in the assembly
10208 code.  This option also has the effect to turn off the @samp{#NO_APP}
10209 formatted-code indicator to the assembler at the beginning of the
10210 assembly file.
10211
10212 @item -mcc-init
10213 @opindex mcc-init
10214 Do not use condition-code results from previous instruction; always emit
10215 compare and test instructions before use of condition codes.
10216
10217 @item -mno-side-effects
10218 @opindex mno-side-effects
10219 Do not emit instructions with side-effects in addressing modes other than
10220 post-increment.
10221
10222 @item -mstack-align
10223 @itemx -mno-stack-align
10224 @itemx -mdata-align
10225 @itemx -mno-data-align
10226 @itemx -mconst-align
10227 @itemx -mno-const-align
10228 @opindex mstack-align
10229 @opindex mno-stack-align
10230 @opindex mdata-align
10231 @opindex mno-data-align
10232 @opindex mconst-align
10233 @opindex mno-const-align
10234 These options (no-options) arranges (eliminate arrangements) for the
10235 stack-frame, individual data and constants to be aligned for the maximum
10236 single data access size for the chosen CPU model.  The default is to
10237 arrange for 32-bit alignment.  ABI details such as structure layout are
10238 not affected by these options.
10239
10240 @item -m32-bit
10241 @itemx -m16-bit
10242 @itemx -m8-bit
10243 @opindex m32-bit
10244 @opindex m16-bit
10245 @opindex m8-bit
10246 Similar to the stack- data- and const-align options above, these options
10247 arrange for stack-frame, writable data and constants to all be 32-bit,
10248 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10249
10250 @item -mno-prologue-epilogue
10251 @itemx -mprologue-epilogue
10252 @opindex mno-prologue-epilogue
10253 @opindex mprologue-epilogue
10254 With @option{-mno-prologue-epilogue}, the normal function prologue and
10255 epilogue that sets up the stack-frame are omitted and no return
10256 instructions or return sequences are generated in the code.  Use this
10257 option only together with visual inspection of the compiled code: no
10258 warnings or errors are generated when call-saved registers must be saved,
10259 or storage for local variable needs to be allocated.
10260
10261 @item -mno-gotplt
10262 @itemx -mgotplt
10263 @opindex mno-gotplt
10264 @opindex mgotplt
10265 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10266 instruction sequences that load addresses for functions from the PLT part
10267 of the GOT rather than (traditional on other architectures) calls to the
10268 PLT.  The default is @option{-mgotplt}.
10269
10270 @item -maout
10271 @opindex maout
10272 Legacy no-op option only recognized with the cris-axis-aout target.
10273
10274 @item -melf
10275 @opindex melf
10276 Legacy no-op option only recognized with the cris-axis-elf and
10277 cris-axis-linux-gnu targets.
10278
10279 @item -melinux
10280 @opindex melinux
10281 Only recognized with the cris-axis-aout target, where it selects a
10282 GNU/linux-like multilib, include files and instruction set for
10283 @option{-march=v8}.
10284
10285 @item -mlinux
10286 @opindex mlinux
10287 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10288
10289 @item -sim
10290 @opindex sim
10291 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10292 to link with input-output functions from a simulator library.  Code,
10293 initialized data and zero-initialized data are allocated consecutively.
10294
10295 @item -sim2
10296 @opindex sim2
10297 Like @option{-sim}, but pass linker options to locate initialized data at
10298 0x40000000 and zero-initialized data at 0x80000000.
10299 @end table
10300
10301 @node MMIX Options
10302 @subsection MMIX Options
10303 @cindex MMIX Options
10304
10305 These options are defined for the MMIX:
10306
10307 @table @gcctabopt
10308 @item -mlibfuncs
10309 @itemx -mno-libfuncs
10310 @opindex mlibfuncs
10311 @opindex mno-libfuncs
10312 Specify that intrinsic library functions are being compiled, passing all
10313 values in registers, no matter the size.
10314
10315 @item -mepsilon
10316 @itemx -mno-epsilon
10317 @opindex mepsilon
10318 @opindex mno-epsilon
10319 Generate floating-point comparison instructions that compare with respect
10320 to the @code{rE} epsilon register.
10321
10322 @item -mabi=mmixware
10323 @itemx -mabi=gnu
10324 @opindex mabi-mmixware
10325 @opindex mabi=gnu
10326 Generate code that passes function parameters and return values that (in
10327 the called function) are seen as registers @code{$0} and up, as opposed to
10328 the GNU ABI which uses global registers @code{$231} and up.
10329
10330 @item -mzero-extend
10331 @itemx -mno-zero-extend
10332 @opindex mzero-extend
10333 @opindex mno-zero-extend
10334 When reading data from memory in sizes shorter than 64 bits, use (do not
10335 use) zero-extending load instructions by default, rather than
10336 sign-extending ones.
10337
10338 @item -mknuthdiv
10339 @itemx -mno-knuthdiv
10340 @opindex mknuthdiv
10341 @opindex mno-knuthdiv
10342 Make the result of a division yielding a remainder have the same sign as
10343 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10344 remainder follows the sign of the dividend.  Both methods are
10345 arithmetically valid, the latter being almost exclusively used.
10346
10347 @item -mtoplevel-symbols
10348 @itemx -mno-toplevel-symbols
10349 @opindex mtoplevel-symbols
10350 @opindex mno-toplevel-symbols
10351 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10352 code can be used with the @code{PREFIX} assembly directive.
10353
10354 @item -melf
10355 @opindex melf
10356 Generate an executable in the ELF format, rather than the default
10357 @samp{mmo} format used by the @command{mmix} simulator.
10358
10359 @item -mbranch-predict
10360 @itemx -mno-branch-predict
10361 @opindex mbranch-predict
10362 @opindex mno-branch-predict
10363 Use (do not use) the probable-branch instructions, when static branch
10364 prediction indicates a probable branch.
10365
10366 @item -mbase-addresses
10367 @itemx -mno-base-addresses
10368 @opindex mbase-addresses
10369 @opindex mno-base-addresses
10370 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10371 base address automatically generates a request (handled by the assembler
10372 and the linker) for a constant to be set up in a global register.  The
10373 register is used for one or more base address requests within the range 0
10374 to 255 from the value held in the register.  The generally leads to short
10375 and fast code, but the number of different data items that can be
10376 addressed is limited.  This means that a program that uses lots of static
10377 data may require @option{-mno-base-addresses}.
10378
10379 @item -msingle-exit
10380 @itemx -mno-single-exit
10381 @opindex msingle-exit
10382 @opindex mno-single-exit
10383 Force (do not force) generated code to have a single exit point in each
10384 function.
10385 @end table
10386
10387 @node PDP-11 Options
10388 @subsection PDP-11 Options
10389 @cindex PDP-11 Options
10390
10391 These options are defined for the PDP-11:
10392
10393 @table @gcctabopt
10394 @item -mfpu
10395 @opindex mfpu
10396 Use hardware FPP floating point.  This is the default.  (FIS floating
10397 point on the PDP-11/40 is not supported.)
10398
10399 @item -msoft-float
10400 @opindex msoft-float
10401 Do not use hardware floating point.
10402
10403 @item -mac0
10404 @opindex mac0
10405 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10406
10407 @item -mno-ac0
10408 @opindex mno-ac0
10409 Return floating-point results in memory.  This is the default.
10410
10411 @item -m40
10412 @opindex m40
10413 Generate code for a PDP-11/40.
10414
10415 @item -m45
10416 @opindex m45
10417 Generate code for a PDP-11/45.  This is the default.
10418
10419 @item -m10
10420 @opindex m10
10421 Generate code for a PDP-11/10.
10422
10423 @item -mbcopy-builtin
10424 @opindex bcopy-builtin
10425 Use inline @code{movstrhi} patterns for copying memory.  This is the
10426 default.
10427
10428 @item -mbcopy
10429 @opindex mbcopy
10430 Do not use inline @code{movstrhi} patterns for copying memory.
10431
10432 @item -mint16
10433 @itemx -mno-int32
10434 @opindex mint16
10435 @opindex mno-int32
10436 Use 16-bit @code{int}.  This is the default.
10437
10438 @item -mint32
10439 @itemx -mno-int16
10440 @opindex mint32
10441 @opindex mno-int16
10442 Use 32-bit @code{int}.
10443
10444 @item -mfloat64
10445 @itemx -mno-float32
10446 @opindex mfloat64
10447 @opindex mno-float32
10448 Use 64-bit @code{float}.  This is the default.
10449
10450 @item -mfloat32
10451 @item -mno-float64
10452 @opindex mfloat32
10453 @opindex mno-float64
10454 Use 32-bit @code{float}.
10455
10456 @item -mabshi
10457 @opindex mabshi
10458 Use @code{abshi2} pattern.  This is the default.
10459
10460 @item -mno-abshi
10461 @opindex mno-abshi
10462 Do not use @code{abshi2} pattern.
10463
10464 @item -mbranch-expensive
10465 @opindex mbranch-expensive
10466 Pretend that branches are expensive.  This is for experimenting with
10467 code generation only.
10468
10469 @item -mbranch-cheap
10470 @opindex mbranch-cheap
10471 Do not pretend that branches are expensive.  This is the default.
10472
10473 @item -msplit
10474 @opindex msplit
10475 Generate code for a system with split I&D.
10476
10477 @item -mno-split
10478 @opindex mno-split
10479 Generate code for a system without split I&D.  This is the default.
10480
10481 @item -munix-asm
10482 @opindex munix-asm
10483 Use Unix assembler syntax.  This is the default when configured for
10484 @samp{pdp11-*-bsd}.
10485
10486 @item -mdec-asm
10487 @opindex mdec-asm
10488 Use DEC assembler syntax.  This is the default when configured for any
10489 PDP-11 target other than @samp{pdp11-*-bsd}.
10490 @end table
10491
10492 @node Xstormy16 Options
10493 @subsection Xstormy16 Options
10494 @cindex Xstormy16 Options
10495
10496 These options are defined for Xstormy16:
10497
10498 @table @gcctabopt
10499 @item -msim
10500 @opindex msim
10501 Choose startup files and linker script suitable for the simulator.
10502 @end table
10503
10504 @node FRV Options
10505 @subsection FRV Options
10506 @cindex FRV Options
10507
10508 @table @gcctabopt
10509 @item -mgpr-32
10510 @opindex mgpr-32
10511
10512 Only use the first 32 general purpose registers.
10513
10514 @item -mgpr-64
10515 @opindex mgpr-64
10516
10517 Use all 64 general purpose registers.
10518
10519 @item -mfpr-32
10520 @opindex mfpr-32
10521
10522 Use only the first 32 floating point registers.
10523
10524 @item -mfpr-64
10525 @opindex mfpr-64
10526
10527 Use all 64 floating point registers
10528
10529 @item -mhard-float
10530 @opindex mhard-float
10531
10532 Use hardware instructions for floating point operations.
10533
10534 @item -msoft-float
10535 @opindex msoft-float
10536
10537 Use library routines for floating point operations.
10538
10539 @item -malloc-cc
10540 @opindex malloc-cc
10541
10542 Dynamically allocate condition code registers.
10543
10544 @item -mfixed-cc
10545 @opindex mfixed-cc
10546
10547 Do not try to dynamically allocate condition code registers, only
10548 use @code{icc0} and @code{fcc0}.
10549
10550 @item -mdword
10551 @opindex mdword
10552
10553 Change ABI to use double word insns.
10554
10555 @item -mno-dword
10556 @opindex mno-dword
10557
10558 Do not use double word instructions.
10559
10560 @item -mdouble
10561 @opindex mdouble
10562
10563 Use floating point double instructions.
10564
10565 @item -mno-double
10566 @opindex mno-double
10567
10568 Do not use floating point double instructions.
10569
10570 @item -mmedia
10571 @opindex mmedia
10572
10573 Use media instructions.
10574
10575 @item -mno-media
10576 @opindex mno-media
10577
10578 Do not use media instructions.
10579
10580 @item -mmuladd
10581 @opindex mmuladd
10582
10583 Use multiply and add/subtract instructions.
10584
10585 @item -mno-muladd
10586 @opindex mno-muladd
10587
10588 Do not use multiply and add/subtract instructions.
10589
10590 @item -mlibrary-pic
10591 @opindex mlibrary-pic
10592
10593 Enable PIC support for building libraries
10594
10595 @item -macc-4
10596 @opindex macc-4
10597
10598 Use only the first four media accumulator registers.
10599
10600 @item -macc-8
10601 @opindex macc-8
10602
10603 Use all eight media accumulator registers.
10604
10605 @item -mpack
10606 @opindex mpack
10607
10608 Pack VLIW instructions.
10609
10610 @item -mno-pack
10611 @opindex mno-pack
10612
10613 Do not pack VLIW instructions.
10614
10615 @item -mno-eflags
10616 @opindex mno-eflags
10617
10618 Do not mark ABI switches in e_flags.
10619
10620 @item -mcond-move
10621 @opindex mcond-move
10622
10623 Enable the use of conditional-move instructions (default).
10624
10625 This switch is mainly for debugging the compiler and will likely be removed
10626 in a future version.
10627
10628 @item -mno-cond-move
10629 @opindex mno-cond-move
10630
10631 Disable the use of conditional-move instructions.
10632
10633 This switch is mainly for debugging the compiler and will likely be removed
10634 in a future version.
10635
10636 @item -mscc
10637 @opindex mscc
10638
10639 Enable the use of conditional set instructions (default).
10640
10641 This switch is mainly for debugging the compiler and will likely be removed
10642 in a future version.
10643
10644 @item -mno-scc
10645 @opindex mno-scc
10646
10647 Disable the use of conditional set instructions.
10648
10649 This switch is mainly for debugging the compiler and will likely be removed
10650 in a future version.
10651
10652 @item -mcond-exec
10653 @opindex mcond-exec
10654
10655 Enable the use of conditional execution (default).
10656
10657 This switch is mainly for debugging the compiler and will likely be removed
10658 in a future version.
10659
10660 @item -mno-cond-exec
10661 @opindex mno-cond-exec
10662
10663 Disable the use of conditional execution.
10664
10665 This switch is mainly for debugging the compiler and will likely be removed
10666 in a future version.
10667
10668 @item -mvliw-branch
10669 @opindex mvliw-branch
10670
10671 Run a pass to pack branches into VLIW instructions (default).
10672
10673 This switch is mainly for debugging the compiler and will likely be removed
10674 in a future version.
10675
10676 @item -mno-vliw-branch
10677 @opindex mno-vliw-branch
10678
10679 Do not run a pass to pack branches into VLIW instructions.
10680
10681 This switch is mainly for debugging the compiler and will likely be removed
10682 in a future version.
10683
10684 @item -mmulti-cond-exec
10685 @opindex mmulti-cond-exec
10686
10687 Enable optimization of @code{&&} and @code{||} in conditional execution
10688 (default).
10689
10690 This switch is mainly for debugging the compiler and will likely be removed
10691 in a future version.
10692
10693 @item -mno-multi-cond-exec
10694 @opindex mno-multi-cond-exec
10695
10696 Disable optimization of @code{&&} and @code{||} in conditional execution.
10697
10698 This switch is mainly for debugging the compiler and will likely be removed
10699 in a future version.
10700
10701 @item -mnested-cond-exec
10702 @opindex mnested-cond-exec
10703
10704 Enable nested conditional execution optimizations (default).
10705
10706 This switch is mainly for debugging the compiler and will likely be removed
10707 in a future version.
10708
10709 @item -mno-nested-cond-exec
10710 @opindex mno-nested-cond-exec
10711
10712 Disable nested conditional execution optimizations.
10713
10714 This switch is mainly for debugging the compiler and will likely be removed
10715 in a future version.
10716
10717 @item -mtomcat-stats
10718 @opindex mtomcat-stats
10719
10720 Cause gas to print out tomcat statistics.
10721
10722 @item -mcpu=@var{cpu}
10723 @opindex mcpu
10724
10725 Select the processor type for which to generate code.  Possible values are
10726 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10727 @samp{frv}.
10728
10729 @end table
10730
10731 @node Xtensa Options
10732 @subsection Xtensa Options
10733 @cindex Xtensa Options
10734
10735 The Xtensa architecture is designed to support many different
10736 configurations.  The compiler's default options can be set to match a
10737 particular Xtensa configuration by copying a configuration file into the
10738 GCC sources when building GCC@.  The options below may be used to
10739 override the default options.
10740
10741 @table @gcctabopt
10742 @item -mbig-endian
10743 @itemx -mlittle-endian
10744 @opindex mbig-endian
10745 @opindex mlittle-endian
10746 Specify big-endian or little-endian byte ordering for the target Xtensa
10747 processor.
10748
10749 @item -mdensity
10750 @itemx -mno-density
10751 @opindex mdensity
10752 @opindex mno-density
10753 Enable or disable use of the optional Xtensa code density instructions.
10754
10755 @item -mconst16
10756 @itemx -mno-const16
10757 @opindex mconst16
10758 @opindex mno-const16
10759 Enable or disable use of @code{CONST16} instructions for loading
10760 constant values.  The @code{CONST16} instruction is currently not a
10761 standard option from Tensilica.  When enabled, @code{CONST16}
10762 instructions are always used in place of the standard @code{L32R}
10763 instructions.  The use of @code{CONST16} is enabled by default only if
10764 the @code{L32R} instruction is not available.
10765
10766 @item -mabs
10767 @itemx -mno-abs
10768 @opindex mabs
10769 @opindex mno-abs
10770 Enable or disable use of the Xtensa @code{ABS} instruction for absolute
10771 value operations.
10772
10773 @item -maddx
10774 @itemx -mno-addx
10775 @opindex maddx
10776 @opindex mno-addx
10777 Enable or disable use of the Xtensa @code{ADDX} and @code{SUBX}
10778 instructions.
10779
10780 @item -mmac16
10781 @itemx -mno-mac16
10782 @opindex mmac16
10783 @opindex mno-mac16
10784 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10785 will generate MAC16 instructions from standard C code, with the
10786 limitation that it will use neither the MR register file nor any
10787 instruction that operates on the MR registers.  When this option is
10788 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10789 combination of core instructions and library calls, depending on whether
10790 any other multiplier options are enabled.
10791
10792 @item -mmul16
10793 @itemx -mno-mul16
10794 @opindex mmul16
10795 @opindex mno-mul16
10796 Enable or disable use of the 16-bit integer multiplier option.  When
10797 enabled, the compiler will generate 16-bit multiply instructions for
10798 multiplications of 16 bits or smaller in standard C code.  When this
10799 option is disabled, the compiler will either use 32-bit multiply or
10800 MAC16 instructions if they are available or generate library calls to
10801 perform the multiply operations using shifts and adds.
10802
10803 @item -mmul32
10804 @itemx -mno-mul32
10805 @opindex mmul32
10806 @opindex mno-mul32
10807 Enable or disable use of the 32-bit integer multiplier option.  When
10808 enabled, the compiler will generate 32-bit multiply instructions for
10809 multiplications of 32 bits or smaller in standard C code.  When this
10810 option is disabled, the compiler will generate library calls to perform
10811 the multiply operations using either shifts and adds or 16-bit multiply
10812 instructions if they are available.
10813
10814 @item -mnsa
10815 @itemx -mno-nsa
10816 @opindex mnsa
10817 @opindex mno-nsa
10818 Enable or disable use of the optional normalization shift amount
10819 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10820
10821 @item -mminmax
10822 @itemx -mno-minmax
10823 @opindex mminmax
10824 @opindex mno-minmax
10825 Enable or disable use of the optional minimum and maximum value
10826 instructions.
10827
10828 @item -msext
10829 @itemx -mno-sext
10830 @opindex msext
10831 @opindex mno-sext
10832 Enable or disable use of the optional sign extend (@code{SEXT})
10833 instruction.
10834
10835 @item -mbooleans
10836 @itemx -mno-booleans
10837 @opindex mbooleans
10838 @opindex mno-booleans
10839 Enable or disable support for the boolean register file used by Xtensa
10840 coprocessors.  This is not typically useful by itself but may be
10841 required for other options that make use of the boolean registers (e.g.,
10842 the floating-point option).
10843
10844 @item -mhard-float
10845 @itemx -msoft-float
10846 @opindex mhard-float
10847 @opindex msoft-float
10848 Enable or disable use of the floating-point option.  When enabled, GCC
10849 generates floating-point instructions for 32-bit @code{float}
10850 operations.  When this option is disabled, GCC generates library calls
10851 to emulate 32-bit floating-point operations using integer instructions.
10852 Regardless of this option, 64-bit @code{double} operations are always
10853 emulated with calls to library functions.
10854
10855 @item -mfused-madd
10856 @itemx -mno-fused-madd
10857 @opindex mfused-madd
10858 @opindex mno-fused-madd
10859 Enable or disable use of fused multiply/add and multiply/subtract
10860 instructions in the floating-point option.  This has no effect if the
10861 floating-point option is not also enabled.  Disabling fused multiply/add
10862 and multiply/subtract instructions forces the compiler to use separate
10863 instructions for the multiply and add/subtract operations.  This may be
10864 desirable in some cases where strict IEEE 754-compliant results are
10865 required: the fused multiply add/subtract instructions do not round the
10866 intermediate result, thereby producing results with @emph{more} bits of
10867 precision than specified by the IEEE standard.  Disabling fused multiply
10868 add/subtract instructions also ensures that the program output is not
10869 sensitive to the compiler's ability to combine multiply and add/subtract
10870 operations.
10871
10872 @item -mtext-section-literals
10873 @itemx -mno-text-section-literals
10874 @opindex mtext-section-literals
10875 @opindex mno-text-section-literals
10876 Control the treatment of literal pools.  The default is
10877 @option{-mno-text-section-literals}, which places literals in a separate
10878 section in the output file.  This allows the literal pool to be placed
10879 in a data RAM/ROM, and it also allows the linker to combine literal
10880 pools from separate object files to remove redundant literals and
10881 improve code size.  With @option{-mtext-section-literals}, the literals
10882 are interspersed in the text section in order to keep them as close as
10883 possible to their references.  This may be necessary for large assembly
10884 files.
10885
10886 @item -mtarget-align
10887 @itemx -mno-target-align
10888 @opindex mtarget-align
10889 @opindex mno-target-align
10890 When this option is enabled, GCC instructs the assembler to
10891 automatically align instructions to reduce branch penalties at the
10892 expense of some code density.  The assembler attempts to widen density
10893 instructions to align branch targets and the instructions following call
10894 instructions.  If there are not enough preceding safe density
10895 instructions to align a target, no widening will be performed.  The
10896 default is @option{-mtarget-align}.  These options do not affect the
10897 treatment of auto-aligned instructions like @code{LOOP}, which the
10898 assembler will always align, either by widening density instructions or
10899 by inserting no-op instructions.
10900
10901 @item -mlongcalls
10902 @itemx -mno-longcalls
10903 @opindex mlongcalls
10904 @opindex mno-longcalls
10905 When this option is enabled, GCC instructs the assembler to translate
10906 direct calls to indirect calls unless it can determine that the target
10907 of a direct call is in the range allowed by the call instruction.  This
10908 translation typically occurs for calls to functions in other source
10909 files.  Specifically, the assembler translates a direct @code{CALL}
10910 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10911 The default is @option{-mno-longcalls}.  This option should be used in
10912 programs where the call target can potentially be out of range.  This
10913 option is implemented in the assembler, not the compiler, so the
10914 assembly code generated by GCC will still show direct call
10915 instructions---look at the disassembled object code to see the actual
10916 instructions.  Note that the assembler will use an indirect call for
10917 every cross-file call, not just those that really will be out of range.
10918 @end table
10919
10920 @node Code Gen Options
10921 @section Options for Code Generation Conventions
10922 @cindex code generation conventions
10923 @cindex options, code generation
10924 @cindex run-time options
10925
10926 These machine-independent options control the interface conventions
10927 used in code generation.
10928
10929 Most of them have both positive and negative forms; the negative form
10930 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10931 one of the forms is listed---the one which is not the default.  You
10932 can figure out the other form by either removing @samp{no-} or adding
10933 it.
10934
10935 @table @gcctabopt
10936 @item -fbounds-check
10937 @opindex fbounds-check
10938 For front-ends that support it, generate additional code to check that
10939 indices used to access arrays are within the declared range.  This is
10940 currently only supported by the Java and Fortran 77 front-ends, where
10941 this option defaults to true and false respectively.
10942
10943 @item -ftrapv
10944 @opindex ftrapv
10945 This option generates traps for signed overflow on addition, subtraction,
10946 multiplication operations.
10947
10948 @item -fwrapv
10949 @opindex fwrapv
10950 This option instructs the compiler to assume that signed arithmetic
10951 overflow of addition, subtraction and multiplication wraps around
10952 using twos-complement representation.  This flag enables some optimzations
10953 and disables other.  This option is enabled by default for the Java
10954 front-end, as required by the Java language specification.
10955
10956 @item -fexceptions
10957 @opindex fexceptions
10958 Enable exception handling.  Generates extra code needed to propagate
10959 exceptions.  For some targets, this implies GCC will generate frame
10960 unwind information for all functions, which can produce significant data
10961 size overhead, although it does not affect execution.  If you do not
10962 specify this option, GCC will enable it by default for languages like
10963 C++ which normally require exception handling, and disable it for
10964 languages like C that do not normally require it.  However, you may need
10965 to enable this option when compiling C code that needs to interoperate
10966 properly with exception handlers written in C++.  You may also wish to
10967 disable this option if you are compiling older C++ programs that don't
10968 use exception handling.
10969
10970 @item -fnon-call-exceptions
10971 @opindex fnon-call-exceptions
10972 Generate code that allows trapping instructions to throw exceptions.
10973 Note that this requires platform-specific runtime support that does
10974 not exist everywhere.  Moreover, it only allows @emph{trapping}
10975 instructions to throw exceptions, i.e.@: memory references or floating
10976 point instructions.  It does not allow exceptions to be thrown from
10977 arbitrary signal handlers such as @code{SIGALRM}.
10978
10979 @item -funwind-tables
10980 @opindex funwind-tables
10981 Similar to @option{-fexceptions}, except that it will just generate any needed
10982 static data, but will not affect the generated code in any other way.
10983 You will normally not enable this option; instead, a language processor
10984 that needs this handling would enable it on your behalf.
10985
10986 @item -fasynchronous-unwind-tables
10987 @opindex funwind-tables
10988 Generate unwind table in dwarf2 format, if supported by target machine.  The
10989 table is exact at each instruction boundary, so it can be used for stack
10990 unwinding from asynchronous events (such as debugger or garbage collector).
10991
10992 @item -fpcc-struct-return
10993 @opindex fpcc-struct-return
10994 Return ``short'' @code{struct} and @code{union} values in memory like
10995 longer ones, rather than in registers.  This convention is less
10996 efficient, but it has the advantage of allowing intercallability between
10997 GCC-compiled files and files compiled with other compilers, particularly
10998 the Portable C Compiler (pcc).
10999
11000 The precise convention for returning structures in memory depends
11001 on the target configuration macros.
11002
11003 Short structures and unions are those whose size and alignment match
11004 that of some integer type.
11005
11006 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11007 switch is not binary compatible with code compiled with the
11008 @option{-freg-struct-return} switch.
11009 Use it to conform to a non-default application binary interface.
11010
11011 @item -freg-struct-return
11012 @opindex freg-struct-return
11013 Return @code{struct} and @code{union} values in registers when possible.
11014 This is more efficient for small structures than
11015 @option{-fpcc-struct-return}.
11016
11017 If you specify neither @option{-fpcc-struct-return} nor
11018 @option{-freg-struct-return}, GCC defaults to whichever convention is
11019 standard for the target.  If there is no standard convention, GCC
11020 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11021 the principal compiler.  In those cases, we can choose the standard, and
11022 we chose the more efficient register return alternative.
11023
11024 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11025 switch is not binary compatible with code compiled with the
11026 @option{-fpcc-struct-return} switch.
11027 Use it to conform to a non-default application binary interface.
11028
11029 @item -fshort-enums
11030 @opindex fshort-enums
11031 Allocate to an @code{enum} type only as many bytes as it needs for the
11032 declared range of possible values.  Specifically, the @code{enum} type
11033 will be equivalent to the smallest integer type which has enough room.
11034
11035 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11036 code that is not binary compatible with code generated without that switch.
11037 Use it to conform to a non-default application binary interface.
11038
11039 @item -fshort-double
11040 @opindex fshort-double
11041 Use the same size for @code{double} as for @code{float}.
11042
11043 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11044 code that is not binary compatible with code generated without that switch.
11045 Use it to conform to a non-default application binary interface.
11046
11047 @item -fshort-wchar
11048 @opindex fshort-wchar
11049 Override the underlying type for @samp{wchar_t} to be @samp{short
11050 unsigned int} instead of the default for the target.  This option is
11051 useful for building programs to run under WINE@.
11052
11053 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11054 code that is not binary compatible with code generated without that switch.
11055 Use it to conform to a non-default application binary interface.
11056
11057 @item -fshared-data
11058 @opindex fshared-data
11059 Requests that the data and non-@code{const} variables of this
11060 compilation be shared data rather than private data.  The distinction
11061 makes sense only on certain operating systems, where shared data is
11062 shared between processes running the same program, while private data
11063 exists in one copy per process.
11064
11065 @item -fno-common
11066 @opindex fno-common
11067 In C, allocate even uninitialized global variables in the data section of the
11068 object file, rather than generating them as common blocks.  This has the
11069 effect that if the same variable is declared (without @code{extern}) in
11070 two different compilations, you will get an error when you link them.
11071 The only reason this might be useful is if you wish to verify that the
11072 program will work on other systems which always work this way.
11073
11074 @item -fno-ident
11075 @opindex fno-ident
11076 Ignore the @samp{#ident} directive.
11077
11078 @item -fno-gnu-linker
11079 @opindex fno-gnu-linker
11080 Do not output global initializations (such as C++ constructors and
11081 destructors) in the form used by the GNU linker (on systems where the GNU
11082 linker is the standard method of handling them).  Use this option when
11083 you want to use a non-GNU linker, which also requires using the
11084 @command{collect2} program to make sure the system linker includes
11085 constructors and destructors.  (@command{collect2} is included in the GCC
11086 distribution.)  For systems which @emph{must} use @command{collect2}, the
11087 compiler driver @command{gcc} is configured to do this automatically.
11088
11089 @item -finhibit-size-directive
11090 @opindex finhibit-size-directive
11091 Don't output a @code{.size} assembler directive, or anything else that
11092 would cause trouble if the function is split in the middle, and the
11093 two halves are placed at locations far apart in memory.  This option is
11094 used when compiling @file{crtstuff.c}; you should not need to use it
11095 for anything else.
11096
11097 @item -fverbose-asm
11098 @opindex fverbose-asm
11099 Put extra commentary information in the generated assembly code to
11100 make it more readable.  This option is generally only of use to those
11101 who actually need to read the generated assembly code (perhaps while
11102 debugging the compiler itself).
11103
11104 @option{-fno-verbose-asm}, the default, causes the
11105 extra information to be omitted and is useful when comparing two assembler
11106 files.
11107
11108 @item -fpic
11109 @opindex fpic
11110 @cindex global offset table
11111 @cindex PIC
11112 Generate position-independent code (PIC) suitable for use in a shared
11113 library, if supported for the target machine.  Such code accesses all
11114 constant addresses through a global offset table (GOT)@.  The dynamic
11115 loader resolves the GOT entries when the program starts (the dynamic
11116 loader is not part of GCC; it is part of the operating system).  If
11117 the GOT size for the linked executable exceeds a machine-specific
11118 maximum size, you get an error message from the linker indicating that
11119 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11120 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11121 on the m68k and RS/6000.  The 386 has no such limit.)
11122
11123 Position-independent code requires special support, and therefore works
11124 only on certain machines.  For the 386, GCC supports PIC for System V
11125 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11126 position-independent.
11127
11128 @item -fPIC
11129 @opindex fPIC
11130 If supported for the target machine, emit position-independent code,
11131 suitable for dynamic linking and avoiding any limit on the size of the
11132 global offset table.  This option makes a difference on the m68k, m88k,
11133 and the SPARC.
11134
11135 Position-independent code requires special support, and therefore works
11136 only on certain machines.
11137
11138 @item -fpie
11139 @itemx -fPIE
11140 @opindex fpie
11141 @opindex fPIE
11142 These options are similar to @option{-fpic} and @option{-fPIC}, but
11143 generated position independent code can be only linked into executables.
11144 Usually these options are used when @option{-pie} GCC option will be
11145 used during linking.
11146
11147 @item -ffixed-@var{reg}
11148 @opindex ffixed
11149 Treat the register named @var{reg} as a fixed register; generated code
11150 should never refer to it (except perhaps as a stack pointer, frame
11151 pointer or in some other fixed role).
11152
11153 @var{reg} must be the name of a register.  The register names accepted
11154 are machine-specific and are defined in the @code{REGISTER_NAMES}
11155 macro in the machine description macro file.
11156
11157 This flag does not have a negative form, because it specifies a
11158 three-way choice.
11159
11160 @item -fcall-used-@var{reg}
11161 @opindex fcall-used
11162 Treat the register named @var{reg} as an allocable register that is
11163 clobbered by function calls.  It may be allocated for temporaries or
11164 variables that do not live across a call.  Functions compiled this way
11165 will not save and restore the register @var{reg}.
11166
11167 It is an error to used this flag with the frame pointer or stack pointer.
11168 Use of this flag for other registers that have fixed pervasive roles in
11169 the machine's execution model will produce disastrous results.
11170
11171 This flag does not have a negative form, because it specifies a
11172 three-way choice.
11173
11174 @item -fcall-saved-@var{reg}
11175 @opindex fcall-saved
11176 Treat the register named @var{reg} as an allocable register saved by
11177 functions.  It may be allocated even for temporaries or variables that
11178 live across a call.  Functions compiled this way will save and restore
11179 the register @var{reg} if they use it.
11180
11181 It is an error to used this flag with the frame pointer or stack pointer.
11182 Use of this flag for other registers that have fixed pervasive roles in
11183 the machine's execution model will produce disastrous results.
11184
11185 A different sort of disaster will result from the use of this flag for
11186 a register in which function values may be returned.
11187
11188 This flag does not have a negative form, because it specifies a
11189 three-way choice.
11190
11191 @item -fpack-struct
11192 @opindex fpack-struct
11193 Pack all structure members together without holes.
11194
11195 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11196 code that is not binary compatible with code generated without that switch.
11197 Additionally, it makes the code suboptimal.
11198 Use it to conform to a non-default application binary interface.
11199
11200 @item -finstrument-functions
11201 @opindex finstrument-functions
11202 Generate instrumentation calls for entry and exit to functions.  Just
11203 after function entry and just before function exit, the following
11204 profiling functions will be called with the address of the current
11205 function and its call site.  (On some platforms,
11206 @code{__builtin_return_address} does not work beyond the current
11207 function, so the call site information may not be available to the
11208 profiling functions otherwise.)
11209
11210 @example
11211 void __cyg_profile_func_enter (void *this_fn,
11212                                void *call_site);
11213 void __cyg_profile_func_exit  (void *this_fn,
11214                                void *call_site);
11215 @end example
11216
11217 The first argument is the address of the start of the current function,
11218 which may be looked up exactly in the symbol table.
11219
11220 This instrumentation is also done for functions expanded inline in other
11221 functions.  The profiling calls will indicate where, conceptually, the
11222 inline function is entered and exited.  This means that addressable
11223 versions of such functions must be available.  If all your uses of a
11224 function are expanded inline, this may mean an additional expansion of
11225 code size.  If you use @samp{extern inline} in your C code, an
11226 addressable version of such functions must be provided.  (This is
11227 normally the case anyways, but if you get lucky and the optimizer always
11228 expands the functions inline, you might have gotten away without
11229 providing static copies.)
11230
11231 A function may be given the attribute @code{no_instrument_function}, in
11232 which case this instrumentation will not be done.  This can be used, for
11233 example, for the profiling functions listed above, high-priority
11234 interrupt routines, and any functions from which the profiling functions
11235 cannot safely be called (perhaps signal handlers, if the profiling
11236 routines generate output or allocate memory).
11237
11238 @item -fstack-check
11239 @opindex fstack-check
11240 Generate code to verify that you do not go beyond the boundary of the
11241 stack.  You should specify this flag if you are running in an
11242 environment with multiple threads, but only rarely need to specify it in
11243 a single-threaded environment since stack overflow is automatically
11244 detected on nearly all systems if there is only one stack.
11245
11246 Note that this switch does not actually cause checking to be done; the
11247 operating system must do that.  The switch causes generation of code
11248 to ensure that the operating system sees the stack being extended.
11249
11250 @item -fstack-limit-register=@var{reg}
11251 @itemx -fstack-limit-symbol=@var{sym}
11252 @itemx -fno-stack-limit
11253 @opindex fstack-limit-register
11254 @opindex fstack-limit-symbol
11255 @opindex fno-stack-limit
11256 Generate code to ensure that the stack does not grow beyond a certain value,
11257 either the value of a register or the address of a symbol.  If the stack
11258 would grow beyond the value, a signal is raised.  For most targets,
11259 the signal is raised before the stack overruns the boundary, so
11260 it is possible to catch the signal without taking special precautions.
11261
11262 For instance, if the stack starts at absolute address @samp{0x80000000}
11263 and grows downwards, you can use the flags
11264 @option{-fstack-limit-symbol=__stack_limit} and
11265 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11266 of 128KB@.  Note that this may only work with the GNU linker.
11267
11268 @cindex aliasing of parameters
11269 @cindex parameters, aliased
11270 @item -fargument-alias
11271 @itemx -fargument-noalias
11272 @itemx -fargument-noalias-global
11273 @opindex fargument-alias
11274 @opindex fargument-noalias
11275 @opindex fargument-noalias-global
11276 Specify the possible relationships among parameters and between
11277 parameters and global data.
11278
11279 @option{-fargument-alias} specifies that arguments (parameters) may
11280 alias each other and may alias global storage.@*
11281 @option{-fargument-noalias} specifies that arguments do not alias
11282 each other, but may alias global storage.@*
11283 @option{-fargument-noalias-global} specifies that arguments do not
11284 alias each other and do not alias global storage.
11285
11286 Each language will automatically use whatever option is required by
11287 the language standard.  You should not need to use these options yourself.
11288
11289 @item -fleading-underscore
11290 @opindex fleading-underscore
11291 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11292 change the way C symbols are represented in the object file.  One use
11293 is to help link with legacy assembly code.
11294
11295 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11296 generate code that is not binary compatible with code generated without that
11297 switch.  Use it to conform to a non-default application binary interface.
11298 Not all targets provide complete support for this switch.
11299
11300 @item -ftls-model=@var{model}
11301 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11302 The @var{model} argument should be one of @code{global-dynamic},
11303 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11304
11305 The default without @option{-fpic} is @code{initial-exec}; with
11306 @option{-fpic} the default is @code{global-dynamic}.
11307 @end table
11308
11309 @c man end
11310
11311 @node Environment Variables
11312 @section Environment Variables Affecting GCC
11313 @cindex environment variables
11314
11315 @c man begin ENVIRONMENT
11316 This section describes several environment variables that affect how GCC
11317 operates.  Some of them work by specifying directories or prefixes to use
11318 when searching for various kinds of files.  Some are used to specify other
11319 aspects of the compilation environment.
11320
11321 Note that you can also specify places to search using options such as
11322 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11323 take precedence over places specified using environment variables, which
11324 in turn take precedence over those specified by the configuration of GCC@.
11325 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11326 GNU Compiler Collection (GCC) Internals}.
11327
11328 @table @env
11329 @item LANG
11330 @itemx LC_CTYPE
11331 @c @itemx LC_COLLATE
11332 @itemx LC_MESSAGES
11333 @c @itemx LC_MONETARY
11334 @c @itemx LC_NUMERIC
11335 @c @itemx LC_TIME
11336 @itemx LC_ALL
11337 @findex LANG
11338 @findex LC_CTYPE
11339 @c @findex LC_COLLATE
11340 @findex LC_MESSAGES
11341 @c @findex LC_MONETARY
11342 @c @findex LC_NUMERIC
11343 @c @findex LC_TIME
11344 @findex LC_ALL
11345 @cindex locale
11346 These environment variables control the way that GCC uses
11347 localization information that allow GCC to work with different
11348 national conventions.  GCC inspects the locale categories
11349 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11350 so.  These locale categories can be set to any value supported by your
11351 installation.  A typical value is @samp{en_UK} for English in the United
11352 Kingdom.
11353
11354 The @env{LC_CTYPE} environment variable specifies character
11355 classification.  GCC uses it to determine the character boundaries in
11356 a string; this is needed for some multibyte encodings that contain quote
11357 and escape characters that would otherwise be interpreted as a string
11358 end or escape.
11359
11360 The @env{LC_MESSAGES} environment variable specifies the language to
11361 use in diagnostic messages.
11362
11363 If the @env{LC_ALL} environment variable is set, it overrides the value
11364 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11365 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11366 environment variable.  If none of these variables are set, GCC
11367 defaults to traditional C English behavior.
11368
11369 @item TMPDIR
11370 @findex TMPDIR
11371 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11372 files.  GCC uses temporary files to hold the output of one stage of
11373 compilation which is to be used as input to the next stage: for example,
11374 the output of the preprocessor, which is the input to the compiler
11375 proper.
11376
11377 @item GCC_EXEC_PREFIX
11378 @findex GCC_EXEC_PREFIX
11379 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11380 names of the subprograms executed by the compiler.  No slash is added
11381 when this prefix is combined with the name of a subprogram, but you can
11382 specify a prefix that ends with a slash if you wish.
11383
11384 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11385 an appropriate prefix to use based on the pathname it was invoked with.
11386
11387 If GCC cannot find the subprogram using the specified prefix, it
11388 tries looking in the usual places for the subprogram.
11389
11390 The default value of @env{GCC_EXEC_PREFIX} is
11391 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11392 of @code{prefix} when you ran the @file{configure} script.
11393
11394 Other prefixes specified with @option{-B} take precedence over this prefix.
11395
11396 This prefix is also used for finding files such as @file{crt0.o} that are
11397 used for linking.
11398
11399 In addition, the prefix is used in an unusual way in finding the
11400 directories to search for header files.  For each of the standard
11401 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11402 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11403 replacing that beginning with the specified prefix to produce an
11404 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11405 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11406 These alternate directories are searched first; the standard directories
11407 come next.
11408
11409 @item COMPILER_PATH
11410 @findex COMPILER_PATH
11411 The value of @env{COMPILER_PATH} is a colon-separated list of
11412 directories, much like @env{PATH}.  GCC tries the directories thus
11413 specified when searching for subprograms, if it can't find the
11414 subprograms using @env{GCC_EXEC_PREFIX}.
11415
11416 @item LIBRARY_PATH
11417 @findex LIBRARY_PATH
11418 The value of @env{LIBRARY_PATH} is a colon-separated list of
11419 directories, much like @env{PATH}.  When configured as a native compiler,
11420 GCC tries the directories thus specified when searching for special
11421 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11422 using GCC also uses these directories when searching for ordinary
11423 libraries for the @option{-l} option (but directories specified with
11424 @option{-L} come first).
11425
11426 @item LANG
11427 @findex LANG
11428 @cindex locale definition
11429 This variable is used to pass locale information to the compiler.  One way in
11430 which this information is used is to determine the character set to be used
11431 when character literals, string literals and comments are parsed in C and C++.
11432 When the compiler is configured to allow multibyte characters,
11433 the following values for @env{LANG} are recognized:
11434
11435 @table @samp
11436 @item C-JIS
11437 Recognize JIS characters.
11438 @item C-SJIS
11439 Recognize SJIS characters.
11440 @item C-EUCJP
11441 Recognize EUCJP characters.
11442 @end table
11443
11444 If @env{LANG} is not defined, or if it has some other value, then the
11445 compiler will use mblen and mbtowc as defined by the default locale to
11446 recognize and translate multibyte characters.
11447 @end table
11448
11449 @noindent
11450 Some additional environments variables affect the behavior of the
11451 preprocessor.
11452
11453 @include cppenv.texi
11454
11455 @c man end
11456
11457 @node Precompiled Headers
11458 @section Using Precompiled Headers
11459 @cindex precompiled headers
11460 @cindex speed of compilation
11461
11462 Often large projects have many header files that are included in every
11463 source file.  The time the compiler takes to process these header files
11464 over and over again can account for nearly all of the time required to
11465 build the project.  To make builds faster, GCC allows users to
11466 `precompile' a header file; then, if builds can use the precompiled
11467 header file they will be much faster.
11468
11469 To create a precompiled header file, simply compile it as you would any
11470 other file, if necessary using the @option{-x} option to make the driver
11471 treat it as a C or C++ header file.  You will probably want to use a
11472 tool like @command{make} to keep the precompiled header up-to-date when
11473 the headers it contains change.
11474
11475 A precompiled header file will be searched for when @code{#include} is
11476 seen in the compilation.  As it searches for the included file
11477 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11478 compiler looks for a precompiled header in each directory just before it
11479 looks for the include file in that directory.  The name searched for is
11480 the name specified in the @code{#include} with @samp{.gch} appended.  If
11481 the precompiled header file can't be used, it is ignored.
11482
11483 For instance, if you have @code{#include "all.h"}, and you have
11484 @file{all.h.gch} in the same directory as @file{all.h}, then the
11485 precompiled header file will be used if possible, and the original
11486 header will be used otherwise.
11487
11488 Alternatively, you might decide to put the precompiled header file in a
11489 directory and use @option{-I} to ensure that directory is searched
11490 before (or instead of) the directory containing the original header.
11491 Then, if you want to check that the precompiled header file is always
11492 used, you can put a file of the same name as the original header in this
11493 directory containing an @code{#error} command.
11494
11495 This also works with @option{-include}.  So yet another way to use
11496 precompiled headers, good for projects not designed with precompiled
11497 header files in mind, is to simply take most of the header files used by
11498 a project, include them from another header file, precompile that header
11499 file, and @option{-include} the precompiled header.  If the header files
11500 have guards against multiple inclusion, they will be skipped because
11501 they've already been included (in the precompiled header).
11502
11503 If you need to precompile the same header file for different
11504 languages, targets, or compiler options, you can instead make a
11505 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11506 header in the directory.  (It doesn't matter what you call the files
11507 in the directory, every precompiled header in the directory will be
11508 considered.)  The first precompiled header encountered in the
11509 directory that is valid for this compilation will be used; they're
11510 searched in no particular order.
11511
11512 There are many other possibilities, limited only by your imagination,
11513 good sense, and the constraints of your build system.
11514
11515 A precompiled header file can be used only when these conditions apply:
11516
11517 @itemize
11518 @item
11519 Only one precompiled header can be used in a particular compilation.
11520 @item
11521 A precompiled header can't be used once the first C token is seen.  You
11522 can have preprocessor directives before a precompiled header; you can
11523 even include a precompiled header from inside another header, so long as
11524 there are no C tokens before the @code{#include}.
11525 @item
11526 The precompiled header file must be produced for the same language as
11527 the current compilation.  You can't use a C precompiled header for a C++
11528 compilation.
11529 @item
11530 The precompiled header file must be produced by the same compiler
11531 version and configuration as the current compilation is using.
11532 The easiest way to guarantee this is to use the same compiler binary
11533 for creating and using precompiled headers.
11534 @item
11535 Any macros defined before the precompiled header (including with
11536 @option{-D}) must either be defined in the same way as when the
11537 precompiled header was generated, or must not affect the precompiled
11538 header, which usually means that the they don't appear in the
11539 precompiled header at all.
11540 @item
11541 Certain command-line options must be defined in the same way as when the
11542 precompiled header was generated.  At present, it's not clear which
11543 options are safe to change and which are not; the safest choice is to
11544 use exactly the same options when generating and using the precompiled
11545 header.
11546 @end itemize
11547
11548 For all of these but the last, the compiler will automatically ignore
11549 the precompiled header if the conditions aren't met.  For the last item,
11550 some option changes will cause the precompiled header to be rejected,
11551 but not all incompatible option combinations have yet been found.  If
11552 you find a new incompatible combination, please consider filing a bug
11553 report, see @ref{Bugs}.
11554
11555 @node Running Protoize
11556 @section Running Protoize
11557
11558 The program @code{protoize} is an optional part of GCC@.  You can use
11559 it to add prototypes to a program, thus converting the program to ISO
11560 C in one respect.  The companion program @code{unprotoize} does the
11561 reverse: it removes argument types from any prototypes that are found.
11562
11563 When you run these programs, you must specify a set of source files as
11564 command line arguments.  The conversion programs start out by compiling
11565 these files to see what functions they define.  The information gathered
11566 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11567
11568 After scanning comes actual conversion.  The specified files are all
11569 eligible to be converted; any files they include (whether sources or
11570 just headers) are eligible as well.
11571
11572 But not all the eligible files are converted.  By default,
11573 @code{protoize} and @code{unprotoize} convert only source and header
11574 files in the current directory.  You can specify additional directories
11575 whose files should be converted with the @option{-d @var{directory}}
11576 option.  You can also specify particular files to exclude with the
11577 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11578 directory name matches one of the specified directory names, and its
11579 name within the directory has not been excluded.
11580
11581 Basic conversion with @code{protoize} consists of rewriting most
11582 function definitions and function declarations to specify the types of
11583 the arguments.  The only ones not rewritten are those for varargs
11584 functions.
11585
11586 @code{protoize} optionally inserts prototype declarations at the
11587 beginning of the source file, to make them available for any calls that
11588 precede the function's definition.  Or it can insert prototype
11589 declarations with block scope in the blocks where undeclared functions
11590 are called.
11591
11592 Basic conversion with @code{unprotoize} consists of rewriting most
11593 function declarations to remove any argument types, and rewriting
11594 function definitions to the old-style pre-ISO form.
11595
11596 Both conversion programs print a warning for any function declaration or
11597 definition that they can't convert.  You can suppress these warnings
11598 with @option{-q}.
11599
11600 The output from @code{protoize} or @code{unprotoize} replaces the
11601 original source file.  The original file is renamed to a name ending
11602 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11603 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11604 for DOS) file already exists, then the source file is simply discarded.
11605
11606 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11607 scan the program and collect information about the functions it uses.
11608 So neither of these programs will work until GCC is installed.
11609
11610 Here is a table of the options you can use with @code{protoize} and
11611 @code{unprotoize}.  Each option works with both programs unless
11612 otherwise stated.
11613
11614 @table @code
11615 @item -B @var{directory}
11616 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11617 usual directory (normally @file{/usr/local/lib}).  This file contains
11618 prototype information about standard system functions.  This option
11619 applies only to @code{protoize}.
11620
11621 @item -c @var{compilation-options}
11622 Use @var{compilation-options} as the options when running @command{gcc} to
11623 produce the @samp{.X} files.  The special option @option{-aux-info} is
11624 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11625
11626 Note that the compilation options must be given as a single argument to
11627 @code{protoize} or @code{unprotoize}.  If you want to specify several
11628 @command{gcc} options, you must quote the entire set of compilation options
11629 to make them a single word in the shell.
11630
11631 There are certain @command{gcc} arguments that you cannot use, because they
11632 would produce the wrong kind of output.  These include @option{-g},
11633 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11634 the @var{compilation-options}, they are ignored.
11635
11636 @item -C
11637 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11638 systems) instead of @samp{.c}.  This is convenient if you are converting
11639 a C program to C++.  This option applies only to @code{protoize}.
11640
11641 @item -g
11642 Add explicit global declarations.  This means inserting explicit
11643 declarations at the beginning of each source file for each function
11644 that is called in the file and was not declared.  These declarations
11645 precede the first function definition that contains a call to an
11646 undeclared function.  This option applies only to @code{protoize}.
11647
11648 @item -i @var{string}
11649 Indent old-style parameter declarations with the string @var{string}.
11650 This option applies only to @code{protoize}.
11651
11652 @code{unprotoize} converts prototyped function definitions to old-style
11653 function definitions, where the arguments are declared between the
11654 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11655 uses five spaces as the indentation.  If you want to indent with just
11656 one space instead, use @option{-i " "}.
11657
11658 @item -k
11659 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11660 is finished.
11661
11662 @item -l
11663 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11664 a prototype declaration for each function in each block which calls the
11665 function without any declaration.  This option applies only to
11666 @code{protoize}.
11667
11668 @item -n
11669 Make no real changes.  This mode just prints information about the conversions
11670 that would have been done without @option{-n}.
11671
11672 @item -N
11673 Make no @samp{.save} files.  The original files are simply deleted.
11674 Use this option with caution.
11675
11676 @item -p @var{program}
11677 Use the program @var{program} as the compiler.  Normally, the name
11678 @file{gcc} is used.
11679
11680 @item -q
11681 Work quietly.  Most warnings are suppressed.
11682
11683 @item -v
11684 Print the version number, just like @option{-v} for @command{gcc}.
11685 @end table
11686
11687 If you need special compiler options to compile one of your program's
11688 source files, then you should generate that file's @samp{.X} file
11689 specially, by running @command{gcc} on that source file with the
11690 appropriate options and the option @option{-aux-info}.  Then run
11691 @code{protoize} on the entire set of files.  @code{protoize} will use
11692 the existing @samp{.X} file because it is newer than the source file.
11693 For example:
11694
11695 @example
11696 gcc -Dfoo=bar file1.c -aux-info file1.X
11697 protoize *.c
11698 @end example
11699
11700 @noindent
11701 You need to include the special files along with the rest in the
11702 @code{protoize} command, even though their @samp{.X} files already
11703 exist, because otherwise they won't get converted.
11704
11705 @xref{Protoize Caveats}, for more information on how to use
11706 @code{protoize} successfully.