OSDN Git Service

* doc/invoke.texi (inline-limit): Fix pasto.
[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  -fdollars-in-identifiers @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 -Wlarger-than-@var{len}  -Wlong-long @gol
219 -Wmain  -Wmissing-braces @gol
220 -Wmissing-format-attribute  -Wmissing-noreturn @gol
221 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
222 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
223 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
224 -Wreturn-type  -Wsequence-point  -Wshadow @gol
225 -Wsign-compare  -Wstrict-aliasing @gol
226 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
227 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
228 -Wunknown-pragmas  -Wunreachable-code @gol
229 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
230 -Wunused-value  -Wunused-variable  -Wwrite-strings}
231
232 @item C-only Warning Options
233 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
234 -Wmissing-prototypes  -Wnested-externs @gol
235 -Wstrict-prototypes  -Wtraditional}
236
237 @item Debugging Options
238 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
239 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
240 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
241 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
242 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
243 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
244 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
245 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
246 -fmem-report -fprofile-arcs @gol
247 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
248 -ftest-coverage  -ftime-report @gol
249 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
250 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
251 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
252 -print-multi-directory  -print-multi-lib @gol
253 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
254 -save-temps  -time}
255
256 @item Optimization Options
257 @xref{Optimize Options,,Options that Control Optimization}.
258 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
259 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
260 -fbranch-probabilities  -fcaller-saves  -fcprop-registers @gol
261 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
262 -fdelayed-branch  -fdelete-null-pointer-checks @gol
263 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
264 -fforce-addr  -fforce-mem  -ffunction-sections @gol
265 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
266 -fif-conversion  -fif-conversion2 @gol
267 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
268 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
269 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
270 -fno-default-inline  -fno-defer-pop @gol
271 -fno-function-cse  -fno-guess-branch-probability @gol
272 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
273 -funsafe-math-optimizations  -ffinite-math-only @gol
274 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
275 -fomit-frame-pointer  -foptimize-register-move @gol
276 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
277 -freduce-all-givs  -fregmove  -frename-registers @gol
278 -freorder-blocks  -freorder-functions @gol
279 -frerun-cse-after-loop  -frerun-loop-opt @gol
280 -fschedule-insns  -fschedule-insns2 @gol
281 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
282 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
283 -fsched2-use-traces  -fsignaling-nans @gol
284 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
285 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
286 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
287 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
288 --param @var{name}=@var{value}
289 -O  -O0  -O1  -O2  -O3  -Os}
290
291 @item Preprocessor Options
292 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
293 @gccoptlist{-$  -A@var{question}=@var{answer} @gol
294 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
295 -C  -dD  -dI  -dM  -dN @gol
296 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
297 -idirafter @var{dir} @gol
298 -include @var{file}  -imacros @var{file} @gol
299 -iprefix @var{file}  -iwithprefix @var{dir} @gol
300 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
301 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
302 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
303 -Xpreprocessor @var{option}}
304
305 @item Assembler Option
306 @xref{Assembler Options,,Passing Options to the Assembler}.
307 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
308
309 @item Linker Options
310 @xref{Link Options,,Options for Linking}.
311 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
312 -nostartfiles  -nodefaultlibs  -nostdlib @gol
313 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
314 -Wl,@var{option}  -Xlinker @var{option} @gol
315 -u @var{symbol}}
316
317 @item Directory Options
318 @xref{Directory Options,,Options for Directory Search}.
319 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
320
321 @item Target Options
322 @c I wrote this xref this way to avoid overfull hbox. -- rms
323 @xref{Target Options}.
324 @gccoptlist{-V @var{version}  -b @var{machine}}
325
326 @item Machine Dependent Options
327 @xref{Submodel Options,,Hardware Models and Configurations}.
328
329 @emph{M680x0 Options}
330 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
331 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
332 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
333 -malign-int  -mstrict-align}
334
335 @emph{M68hc1x Options}
336 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
337 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
338 -msoft-reg-count=@var{count}}
339
340 @emph{VAX Options}
341 @gccoptlist{-mg  -mgnu  -munix}
342
343 @emph{SPARC Options}
344 @gccoptlist{-mcpu=@var{cpu-type} @gol
345 -mtune=@var{cpu-type} @gol
346 -mcmodel=@var{code-model} @gol
347 -m32  -m64 @gol
348 -mapp-regs  -mbroken-saverestore  -mcypress @gol
349 -mfaster-structs  -mflat @gol
350 -mfpu  -mhard-float  -mhard-quad-float @gol
351 -mimpure-text  -mlive-g0  -mno-app-regs @gol
352 -mno-faster-structs  -mno-flat  -mno-fpu @gol
353 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
354 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
355 -msupersparc  -munaligned-doubles  -mv8}
356
357 @emph{ARM Options}
358 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
359 -mapcs-26  -mapcs-32 @gol
360 -mapcs-stack-check  -mno-apcs-stack-check @gol
361 -mapcs-float  -mno-apcs-float @gol
362 -mapcs-reentrant  -mno-apcs-reentrant @gol
363 -msched-prolog  -mno-sched-prolog @gol
364 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
365 -malignment-traps  -mno-alignment-traps @gol
366 -msoft-float  -mhard-float  -mfpe @gol
367 -mthumb-interwork  -mno-thumb-interwork @gol
368 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
369 -mstructure-size-boundary=@var{n} @gol
370 -mabort-on-noreturn @gol
371 -mlong-calls  -mno-long-calls @gol
372 -msingle-pic-base  -mno-single-pic-base @gol
373 -mpic-register=@var{reg} @gol
374 -mnop-fun-dllimport @gol
375 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
376 -mpoke-function-name @gol
377 -mthumb  -marm @gol
378 -mtpcs-frame  -mtpcs-leaf-frame @gol
379 -mcaller-super-interworking  -mcallee-super-interworking}
380
381 @emph{MN10200 Options}
382 @gccoptlist{-mrelax}
383
384 @emph{MN10300 Options}
385 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
386 -mam33  -mno-am33 @gol
387 -mno-crt0  -mrelax}
388
389 @emph{M32R/D Options}
390 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
391 -msdata=@var{sdata-type}  -G @var{num}}
392
393 @emph{M88K Options}
394 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
395 -mcheck-zero-division  -mhandle-large-shift @gol
396 -midentify-revision  -mno-check-zero-division @gol
397 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
398 -mno-optimize-arg-area  -mno-serialize-volatile @gol
399 -mno-underscores  -mocs-debug-info @gol
400 -mocs-frame-position  -moptimize-arg-area @gol
401 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
402 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
403 -mversion-03.00  -mwarn-passed-structs}
404
405 @emph{RS/6000 and PowerPC Options}
406 @gccoptlist{-mcpu=@var{cpu-type} @gol
407 -mtune=@var{cpu-type} @gol
408 -mpower  -mno-power  -mpower2  -mno-power2 @gol
409 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
410 -maltivec  -mno-altivec @gol
411 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
412 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
413 -mnew-mnemonics  -mold-mnemonics @gol
414 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
415 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
416 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
417 -mstring  -mno-string  -mupdate  -mno-update @gol
418 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
419 -mstrict-align  -mno-strict-align  -mrelocatable @gol
420 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
421 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
422 -mdynamic-no-pic @gol
423 -mcall-sysv  -mcall-netbsd @gol
424 -maix-struct-return  -msvr4-struct-return @gol
425 -mabi=altivec  -mabi=no-altivec @gol
426 -mabi=spe  -mabi=no-spe @gol
427 -misel=yes  -misel=no @gol
428 -mspe=yes  -mspe=no @gol
429 -mfloat-gprs=yes  -mfloat-gprs=no @gol
430 -mprototype  -mno-prototype @gol
431 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
432 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
433
434 @emph{Darwin Options}
435 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
436 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
437 -client_name  -compatibility_version  -current_version @gol
438 -dependency-file  -dylib_file  -dylinker_install_name @gol
439 -dynamic  -dynamiclib  -exported_symbols_list @gol
440 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
441 -force_flat_namespace  -headerpad_max_install_names @gol
442 -image_base  -init  -install_name  -keep_private_externs @gol
443 -multi_module  -multiply_defined  -multiply_defined_unused @gol
444 -noall_load  -nomultidefs  -noprebind  -noseglinkedit @gol
445 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
446 -private_bundle  -read_only_relocs  -sectalign @gol
447 -sectobjectsymbols  -whyload  -seg1addr @gol
448 -sectcreate  -sectobjectsymbols  -sectorder @gol
449 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
450 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
451 -single_module  -static  -sub_library  -sub_umbrella @gol
452 -twolevel_namespace  -umbrella  -undefined @gol
453 -unexported_symbols_list  -weak_reference_mismatches @gol
454 -whatsloaded}
455
456 @emph{RT Options}
457 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
458 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
459 -mminimum-fp-blocks  -mnohc-struct-return}
460
461 @emph{MIPS Options}
462 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
463 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
464 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
465 -mgas  -mgp32  -mgp64 @gol
466 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
467 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
468 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
469 -mmips-as  -mmips-tfile  -mno-abicalls @gol
470 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
471 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
472 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
473 -mrnames  -msoft-float @gol
474 -m4650  -msingle-float  -mmad @gol
475 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
476 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
477 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
478 -mbranch-likely -mno-branch-likely}
479
480 @emph{i386 and x86-64 Options}
481 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
482 -mfpmath=@var{unit} @gol
483 -masm=@var{dialect}  -mno-fancy-math-387 @gol
484 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
485 -mno-wide-multiply  -mrtd  -malign-double @gol
486 -mpreferred-stack-boundary=@var{num} @gol
487 -mmmx  -msse  -msse2  -m3dnow @gol
488 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
489 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
490 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
491 -mno-red-zone @gol
492 -mcmodel=@var{code-model} @gol
493 -m32  -m64}
494
495 @emph{HPPA Options}
496 @gccoptlist{-march=@var{architecture-type} @gol
497 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
498 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
499 -mjump-in-delay -mlinker-opt -mlong-calls @gol
500 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
501 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
502 -mno-jump-in-delay  -mno-long-load-store @gol
503 -mno-portable-runtime  -mno-soft-float @gol
504 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
505 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
506 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
507 -nolibdld  -static  -threads}
508
509 @emph{Intel 960 Options}
510 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
511 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
512 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
513 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
514 -mno-complex-addr  -mno-leaf-procedures @gol
515 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
516 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
517 -mtail-call}
518
519 @emph{DEC Alpha Options}
520 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
521 -mieee  -mieee-with-inexact  -mieee-conformant @gol
522 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
523 -mtrap-precision=@var{mode}  -mbuild-constants @gol
524 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
525 -mbwx  -mmax  -mfix  -mcix @gol
526 -mfloat-vax  -mfloat-ieee @gol
527 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
528 -msmall-text  -mlarge-text @gol
529 -mmemory-latency=@var{time}}
530
531 @emph{DEC Alpha/VMS Options}
532 @gccoptlist{-mvms-return-codes}
533
534 @emph{H8/300 Options}
535 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
536
537 @emph{SH Options}
538 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
539 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
540 -m5-64media  -m5-64media-nofpu @gol
541 -m5-32media  -m5-32media-nofpu @gol
542 -m5-compact  -m5-compact-nofpu @gol
543 -mb  -ml  -mdalign  -mrelax @gol
544 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
545 -mieee  -misize  -mpadstruct  -mspace @gol
546 -mprefergot  -musermode}
547
548 @emph{System V Options}
549 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
550
551 @emph{ARC Options}
552 @gccoptlist{-EB  -EL @gol
553 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
554 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
555
556 @emph{TMS320C3x/C4x Options}
557 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
558 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
559 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
560 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
561
562 @emph{V850 Options}
563 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
564 -mprolog-function  -mno-prolog-function  -mspace @gol
565 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
566 -mapp-regs  -mno-app-regs @gol
567 -mdisable-callt  -mno-disable-callt @gol
568 -mv850e @gol
569 -mv850  -mbig-switch}
570
571 @emph{NS32K Options}
572 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
573 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
574 -mregparam  -mnoregparam  -msb  -mnosb @gol
575 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
576
577 @emph{AVR Options}
578 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
579 -mcall-prologues  -mno-tablejump  -mtiny-stack}
580
581 @emph{MCore Options}
582 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
583 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
584 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
585 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
586 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
587
588 @emph{MMIX Options}
589 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
590 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
591 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
592 -mno-base-addresses  -msingle-exit  -mno-single-exit}
593
594 @emph{IA-64 Options}
595 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
596 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
597 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
598 -minline-float-divide-max-throughput @gol
599 -minline-int-divide-min-latency @gol
600 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
601 -mfixed-range=@var{register-range}}
602
603 @emph{D30V Options}
604 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
605 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
606
607 @emph{S/390 and zSeries Options}
608 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
609 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
610 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
611 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
612
613 @emph{CRIS Options}
614 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
615 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
616 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
617 -mstack-align  -mdata-align  -mconst-align @gol
618 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
619 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
620
621 @emph{PDP-11 Options}
622 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
623 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
624 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
625 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
626 -mbranch-expensive  -mbranch-cheap @gol
627 -msplit  -mno-split  -munix-asm  -mdec-asm}
628
629 @emph{Xstormy16 Options}
630 @gccoptlist{-msim}
631
632 @emph{Xtensa Options}
633 @gccoptlist{-mbig-endian  -mlittle-endian @gol
634 -mdensity  -mno-density @gol
635 -mmac16  -mno-mac16 @gol
636 -mmul16  -mno-mul16 @gol
637 -mmul32  -mno-mul32 @gol
638 -mnsa  -mno-nsa @gol
639 -mminmax  -mno-minmax @gol
640 -msext  -mno-sext @gol
641 -mbooleans  -mno-booleans @gol
642 -mhard-float  -msoft-float @gol
643 -mfused-madd  -mno-fused-madd @gol
644 -mserialize-volatile  -mno-serialize-volatile @gol
645 -mtext-section-literals  -mno-text-section-literals @gol
646 -mtarget-align  -mno-target-align @gol
647 -mlongcalls  -mno-longcalls}
648
649 @emph{FRV Options}
650 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
651 -mhard-float  -msoft-float @gol
652 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
653 -mdouble  -mno-double @gol
654 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
655 -mlibrary-pic  -macc-4 -macc-8 @gol
656 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
657 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
658 -mvliw-branch  -mno-vliw-branch @gol
659 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
660 -mno-nested-cond-exec  -mtomcat-stats @gol
661 -mcpu=@var{cpu}}
662
663 @item Code Generation Options
664 @xref{Code Gen Options,,Options for Code Generation Conventions}.
665 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
666 -ffixed-@var{reg}  -fexceptions @gol
667 -fnon-call-exceptions  -funwind-tables @gol
668 -fasynchronous-unwind-tables  -fforced-unwind-exceptions @gol
669 -finhibit-size-directive  -finstrument-functions @gol
670 -fno-common  -fno-ident  -fno-gnu-linker @gol
671 -fpcc-struct-return  -fpic  -fPIC @gol
672 -freg-struct-return  -fshared-data  -fshort-enums @gol
673 -fshort-double  -fshort-wchar @gol
674 -fverbose-asm  -fpack-struct  -fstack-check @gol
675 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
676 -fargument-alias  -fargument-noalias @gol
677 -fargument-noalias-global  -fleading-underscore @gol
678 -ftls-model=@var{model} @gol
679 -ftrapv  -fbounds-check}
680 @end table
681
682 @menu
683 * Overall Options::     Controlling the kind of output:
684                         an executable, object files, assembler files,
685                         or preprocessed source.
686 * C Dialect Options::   Controlling the variant of C language compiled.
687 * C++ Dialect Options:: Variations on C++.
688 * Objective-C Dialect Options:: Variations on Objective-C.
689 * Language Independent Options:: Controlling how diagnostics should be
690                         formatted.
691 * Warning Options::     How picky should the compiler be?
692 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
693 * Optimize Options::    How much optimization?
694 * Preprocessor Options:: Controlling header files and macro definitions.
695                          Also, getting dependency information for Make.
696 * Assembler Options::   Passing options to the assembler.
697 * Link Options::        Specifying libraries and so on.
698 * Directory Options::   Where to find header files and libraries.
699                         Where to find the compiler executable files.
700 * Spec Files::          How to pass switches to sub-processes.
701 * Target Options::      Running a cross-compiler, or an old version of GCC.
702 @end menu
703
704 @node Overall Options
705 @section Options Controlling the Kind of Output
706
707 Compilation can involve up to four stages: preprocessing, compilation
708 proper, assembly and linking, always in that order.  The first three
709 stages apply to an individual source file, and end by producing an
710 object file; linking combines all the object files (those newly
711 compiled, and those specified as input) into an executable file.
712
713 @cindex file name suffix
714 For any given input file, the file name suffix determines what kind of
715 compilation is done:
716
717 @table @gcctabopt
718 @item @var{file}.c
719 C source code which must be preprocessed.
720
721 @item @var{file}.i
722 C source code which should not be preprocessed.
723
724 @item @var{file}.ii
725 C++ source code which should not be preprocessed.
726
727 @item @var{file}.m
728 Objective-C source code.  Note that you must link with the library
729 @file{libobjc.a} to make an Objective-C program work.
730
731 @item @var{file}.mi
732 Objective-C source code which should not be preprocessed.
733
734 @item @var{file}.h
735 C or C++ header file to be turned into a precompiled header.
736
737 @item @var{file}.cc
738 @itemx @var{file}.cp
739 @itemx @var{file}.cxx
740 @itemx @var{file}.cpp
741 @itemx @var{file}.CPP
742 @itemx @var{file}.c++
743 @itemx @var{file}.C
744 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
745 the last two letters must both be literally @samp{x}.  Likewise,
746 @samp{.C} refers to a literal capital C@.
747
748 @item @var{file}.hh
749 @itemx @var{file}.H
750 C++ header file to be turned into a precompiled header.
751
752 @item @var{file}.f
753 @itemx @var{file}.for
754 @itemx @var{file}.FOR
755 Fortran source code which should not be preprocessed.
756
757 @item @var{file}.F
758 @itemx @var{file}.fpp
759 @itemx @var{file}.FPP
760 Fortran source code which must be preprocessed (with the traditional
761 preprocessor).
762
763 @item @var{file}.r
764 Fortran source code which must be preprocessed with a RATFOR
765 preprocessor (not included with GCC)@.
766
767 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
768 Using and Porting GNU Fortran}, for more details of the handling of
769 Fortran input files.
770
771 @c FIXME: Descriptions of Java file types.
772 @c @var{file}.java
773 @c @var{file}.class
774 @c @var{file}.zip
775 @c @var{file}.jar
776
777 @item @var{file}.ads
778 Ada source code file which contains a library unit declaration (a
779 declaration of a package, subprogram, or generic, or a generic
780 instantiation), or a library unit renaming declaration (a package,
781 generic, or subprogram renaming declaration).  Such files are also
782 called @dfn{specs}.
783
784 @itemx @var{file}.adb
785 Ada source code file containing a library unit body (a subprogram or
786 package body).  Such files are also called @dfn{bodies}.
787
788 @c GCC also knows about some suffixes for languages not yet included:
789 @c Pascal:
790 @c @var{file}.p
791 @c @var{file}.pas
792
793 @item @var{file}.s
794 Assembler code.
795
796 @item @var{file}.S
797 Assembler code which must be preprocessed.
798
799 @item @var{other}
800 An object file to be fed straight into linking.
801 Any file name with no recognized suffix is treated this way.
802 @end table
803
804 @opindex x
805 You can specify the input language explicitly with the @option{-x} option:
806
807 @table @gcctabopt
808 @item -x @var{language}
809 Specify explicitly the @var{language} for the following input files
810 (rather than letting the compiler choose a default based on the file
811 name suffix).  This option applies to all following input files until
812 the next @option{-x} option.  Possible values for @var{language} are:
813 @example
814 c  c-header  cpp-output
815 c++  c++-header  c++-cpp-output
816 objective-c  objc-cpp-output
817 assembler  assembler-with-cpp
818 ada
819 f77  f77-cpp-input  ratfor
820 java
821 treelang
822 @end example
823
824 @item -x none
825 Turn off any specification of a language, so that subsequent files are
826 handled according to their file name suffixes (as they are if @option{-x}
827 has not been used at all).
828
829 @item -pass-exit-codes
830 @opindex pass-exit-codes
831 Normally the @command{gcc} program will exit with the code of 1 if any
832 phase of the compiler returns a non-success return code.  If you specify
833 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
834 numerically highest error produced by any phase that returned an error
835 indication.
836 @end table
837
838 If you only want some of the stages of compilation, you can use
839 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
840 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
841 @command{gcc} is to stop.  Note that some combinations (for example,
842 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
843
844 @table @gcctabopt
845 @item -c
846 @opindex c
847 Compile or assemble the source files, but do not link.  The linking
848 stage simply is not done.  The ultimate output is in the form of an
849 object file for each source file.
850
851 By default, the object file name for a source file is made by replacing
852 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
853
854 Unrecognized input files, not requiring compilation or assembly, are
855 ignored.
856
857 @item -S
858 @opindex S
859 Stop after the stage of compilation proper; do not assemble.  The output
860 is in the form of an assembler code file for each non-assembler input
861 file specified.
862
863 By default, the assembler file name for a source file is made by
864 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
865
866 Input files that don't require compilation are ignored.
867
868 @item -E
869 @opindex E
870 Stop after the preprocessing stage; do not run the compiler proper.  The
871 output is in the form of preprocessed source code, which is sent to the
872 standard output.
873
874 Input files which don't require preprocessing are ignored.
875
876 @cindex output file option
877 @item -o @var{file}
878 @opindex o
879 Place output in file @var{file}.  This applies regardless to whatever
880 sort of output is being produced, whether it be an executable file,
881 an object file, an assembler file or preprocessed C code.
882
883 Since only one output file can be specified, it does not make sense to
884 use @option{-o} when compiling more than one input file, unless you are
885 producing an executable file as output.
886
887 If @option{-o} is not specified, the default is to put an executable file
888 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
889 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
890 all preprocessed C source on standard output.
891
892 @item -v
893 @opindex v
894 Print (on standard error output) the commands executed to run the stages
895 of compilation.  Also print the version number of the compiler driver
896 program and of the preprocessor and the compiler proper.
897
898 @item -###
899 @opindex ###
900 Like @option{-v} except the commands are not executed and all command
901 arguments are quoted.  This is useful for shell scripts to capture the
902 driver-generated command lines.
903
904 @item -pipe
905 @opindex pipe
906 Use pipes rather than temporary files for communication between the
907 various stages of compilation.  This fails to work on some systems where
908 the assembler is unable to read from a pipe; but the GNU assembler has
909 no trouble.
910
911 @item --help
912 @opindex help
913 Print (on the standard output) a description of the command line options
914 understood by @command{gcc}.  If the @option{-v} option is also specified
915 then @option{--help} will also be passed on to the various processes
916 invoked by @command{gcc}, so that they can display the command line options
917 they accept.  If the @option{-Wextra} option is also specified then command
918 line options which have no documentation associated with them will also
919 be displayed.
920
921 @item --target-help
922 @opindex target-help
923 Print (on the standard output) a description of target specific command
924 line options for each tool.
925
926 @item --version
927 @opindex version
928 Display the version number and copyrights of the invoked GCC.
929 @end table
930
931 @node Invoking G++
932 @section Compiling C++ Programs
933
934 @cindex suffixes for C++ source
935 @cindex C++ source file suffixes
936 C++ source files conventionally use one of the suffixes @samp{.C},
937 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
938 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
939 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
940 files with these names and compiles them as C++ programs even if you
941 call the compiler the same way as for compiling C programs (usually
942 with the name @command{gcc}).
943
944 @findex g++
945 @findex c++
946 However, C++ programs often require class libraries as well as a
947 compiler that understands the C++ language---and under some
948 circumstances, you might want to compile programs or header files from
949 standard input, or otherwise without a suffix that flags them as C++
950 programs.  You might also like to precompile a C header file with a
951 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
952 program that calls GCC with the default language set to C++, and
953 automatically specifies linking against the C++ library.  On many
954 systems, @command{g++} is also installed with the name @command{c++}.
955
956 @cindex invoking @command{g++}
957 When you compile C++ programs, you may specify many of the same
958 command-line options that you use for compiling programs in any
959 language; or command-line options meaningful for C and related
960 languages; or options that are meaningful only for C++ programs.
961 @xref{C Dialect Options,,Options Controlling C Dialect}, for
962 explanations of options for languages related to C@.
963 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
964 explanations of options that are meaningful only for C++ programs.
965
966 @node C Dialect Options
967 @section Options Controlling C Dialect
968 @cindex dialect options
969 @cindex language dialect options
970 @cindex options, dialect
971
972 The following options control the dialect of C (or languages derived
973 from C, such as C++ and Objective-C) that the compiler accepts:
974
975 @table @gcctabopt
976 @cindex ANSI support
977 @cindex ISO support
978 @item -ansi
979 @opindex ansi
980 In C mode, support all ISO C90 programs.  In C++ mode,
981 remove GNU extensions that conflict with ISO C++.
982
983 This turns off certain features of GCC that are incompatible with ISO
984 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
985 such as the @code{asm} and @code{typeof} keywords, and
986 predefined macros such as @code{unix} and @code{vax} that identify the
987 type of system you are using.  It also enables the undesirable and
988 rarely used ISO trigraph feature.  For the C compiler,
989 it disables recognition of C++ style @samp{//} comments as well as
990 the @code{inline} keyword.
991
992 The alternate keywords @code{__asm__}, @code{__extension__},
993 @code{__inline__} and @code{__typeof__} continue to work despite
994 @option{-ansi}.  You would not want to use them in an ISO C program, of
995 course, but it is useful to put them in header files that might be included
996 in compilations done with @option{-ansi}.  Alternate predefined macros
997 such as @code{__unix__} and @code{__vax__} are also available, with or
998 without @option{-ansi}.
999
1000 The @option{-ansi} option does not cause non-ISO programs to be
1001 rejected gratuitously.  For that, @option{-pedantic} is required in
1002 addition to @option{-ansi}.  @xref{Warning Options}.
1003
1004 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1005 option is used.  Some header files may notice this macro and refrain
1006 from declaring certain functions or defining certain macros that the
1007 ISO standard doesn't call for; this is to avoid interfering with any
1008 programs that might use these names for other things.
1009
1010 Functions which would normally be built in but do not have semantics
1011 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1012 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1013 built-in functions provided by GCC}, for details of the functions
1014 affected.
1015
1016 @item -std=
1017 @opindex std
1018 Determine the language standard.  This option is currently only
1019 supported when compiling C or C++.  A value for this option must be
1020 provided; possible values are
1021
1022 @table @samp
1023 @item c89
1024 @itemx iso9899:1990
1025 ISO C90 (same as @option{-ansi}).
1026
1027 @item iso9899:199409
1028 ISO C90 as modified in amendment 1.
1029
1030 @item c99
1031 @itemx c9x
1032 @itemx iso9899:1999
1033 @itemx iso9899:199x
1034 ISO C99.  Note that this standard is not yet fully supported; see
1035 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1036 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1037
1038 @item gnu89
1039 Default, ISO C90 plus GNU extensions (including some C99 features).
1040
1041 @item gnu99
1042 @item gnu9x
1043 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1044 this will become the default.  The name @samp{gnu9x} is deprecated.
1045
1046 @item c++98
1047 The 1998 ISO C++ standard plus amendments.
1048
1049 @item gnu++98
1050 The same as @option{-std=c++98} plus GNU extensions.  This is the
1051 default for C++ code.
1052 @end table
1053
1054 Even when this option is not specified, you can still use some of the
1055 features of newer standards in so far as they do not conflict with
1056 previous C standards.  For example, you may use @code{__restrict__} even
1057 when @option{-std=c99} is not specified.
1058
1059 The @option{-std} options specifying some version of ISO C have the same
1060 effects as @option{-ansi}, except that features that were not in ISO C90
1061 but are in the specified version (for example, @samp{//} comments and
1062 the @code{inline} keyword in ISO C99) are not disabled.
1063
1064 @xref{Standards,,Language Standards Supported by GCC}, for details of
1065 these standard versions.
1066
1067 @item -aux-info @var{filename}
1068 @opindex aux-info
1069 Output to the given filename prototyped declarations for all functions
1070 declared and/or defined in a translation unit, including those in header
1071 files.  This option is silently ignored in any language other than C@.
1072
1073 Besides declarations, the file indicates, in comments, the origin of
1074 each declaration (source file and line), whether the declaration was
1075 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1076 @samp{O} for old, respectively, in the first character after the line
1077 number and the colon), and whether it came from a declaration or a
1078 definition (@samp{C} or @samp{F}, respectively, in the following
1079 character).  In the case of function definitions, a K&R-style list of
1080 arguments followed by their declarations is also provided, inside
1081 comments, after the declaration.
1082
1083 @item -fno-asm
1084 @opindex fno-asm
1085 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1086 keyword, so that code can use these words as identifiers.  You can use
1087 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1088 instead.  @option{-ansi} implies @option{-fno-asm}.
1089
1090 In C++, this switch only affects the @code{typeof} keyword, since
1091 @code{asm} and @code{inline} are standard keywords.  You may want to
1092 use the @option{-fno-gnu-keywords} flag instead, which has the same
1093 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1094 switch only affects the @code{asm} and @code{typeof} keywords, since
1095 @code{inline} is a standard keyword in ISO C99.
1096
1097 @item -fno-builtin
1098 @itemx -fno-builtin-@var{function}
1099 @opindex fno-builtin
1100 @cindex built-in functions
1101 Don't recognize built-in functions that do not begin with
1102 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1103 functions provided by GCC}, for details of the functions affected,
1104 including those which are not built-in functions when @option{-ansi} or
1105 @option{-std} options for strict ISO C conformance are used because they
1106 do not have an ISO standard meaning.
1107
1108 GCC normally generates special code to handle certain built-in functions
1109 more efficiently; for instance, calls to @code{alloca} may become single
1110 instructions that adjust the stack directly, and calls to @code{memcpy}
1111 may become inline copy loops.  The resulting code is often both smaller
1112 and faster, but since the function calls no longer appear as such, you
1113 cannot set a breakpoint on those calls, nor can you change the behavior
1114 of the functions by linking with a different library.
1115
1116 With the @option{-fno-builtin-@var{function}} option
1117 only the built-in function @var{function} is
1118 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1119 function is named this is not built-in in this version of GCC, this
1120 option is ignored.  There is no corresponding
1121 @option{-fbuiltin-@var{function}} option; if you wish to enable
1122 built-in functions selectively when using @option{-fno-builtin} or
1123 @option{-ffreestanding}, you may define macros such as:
1124
1125 @smallexample
1126 #define abs(n)          __builtin_abs ((n))
1127 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1128 @end smallexample
1129
1130 @item -fhosted
1131 @opindex fhosted
1132 @cindex hosted environment
1133
1134 Assert that compilation takes place in a hosted environment.  This implies
1135 @option{-fbuiltin}.  A hosted environment is one in which the
1136 entire standard library is available, and in which @code{main} has a return
1137 type of @code{int}.  Examples are nearly everything except a kernel.
1138 This is equivalent to @option{-fno-freestanding}.
1139
1140 @item -ffreestanding
1141 @opindex ffreestanding
1142 @cindex hosted environment
1143
1144 Assert that compilation takes place in a freestanding environment.  This
1145 implies @option{-fno-builtin}.  A freestanding environment
1146 is one in which the standard library may not exist, and program startup may
1147 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1148 This is equivalent to @option{-fno-hosted}.
1149
1150 @xref{Standards,,Language Standards Supported by GCC}, for details of
1151 freestanding and hosted environments.
1152
1153 @item -fms-extensions
1154 @opindex fms-extensions
1155 Accept some non-standard constructs used in Microsoft header files.
1156
1157 @item -trigraphs
1158 @opindex trigraphs
1159 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1160 options for strict ISO C conformance) implies @option{-trigraphs}.
1161
1162 @item -no-integrated-cpp
1163 @opindex no-integrated-cpp
1164 Performs a compilation in two passes: preprocessing and compiling.  This
1165 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1166 @option{-B} option. The user supplied compilation step can then add in
1167 an additional preprocessing step after normal preprocessing but before
1168 compiling. The default is to use the integrated cpp (internal cpp)
1169
1170 The semantics of this option will change if "cc1", "cc1plus", and
1171 "cc1obj" are merged.
1172
1173 @cindex traditional C language
1174 @cindex C language, traditional
1175 @item -traditional
1176 @itemx -traditional-cpp
1177 @opindex traditional-cpp
1178 @opindex traditional
1179 Formerly, these options caused GCC to attempt to emulate a pre-standard
1180 C compiler.  They are now only supported with the @option{-E} switch.
1181 The preprocessor continues to support a pre-standard mode.  See the GNU
1182 CPP manual for details.
1183
1184 @item -fcond-mismatch
1185 @opindex fcond-mismatch
1186 Allow conditional expressions with mismatched types in the second and
1187 third arguments.  The value of such an expression is void.  This option
1188 is not supported for C++.
1189
1190 @item -funsigned-char
1191 @opindex funsigned-char
1192 Let the type @code{char} be unsigned, like @code{unsigned char}.
1193
1194 Each kind of machine has a default for what @code{char} should
1195 be.  It is either like @code{unsigned char} by default or like
1196 @code{signed char} by default.
1197
1198 Ideally, a portable program should always use @code{signed char} or
1199 @code{unsigned char} when it depends on the signedness of an object.
1200 But many programs have been written to use plain @code{char} and
1201 expect it to be signed, or expect it to be unsigned, depending on the
1202 machines they were written for.  This option, and its inverse, let you
1203 make such a program work with the opposite default.
1204
1205 The type @code{char} is always a distinct type from each of
1206 @code{signed char} or @code{unsigned char}, even though its behavior
1207 is always just like one of those two.
1208
1209 @item -fsigned-char
1210 @opindex fsigned-char
1211 Let the type @code{char} be signed, like @code{signed char}.
1212
1213 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1214 the negative form of @option{-funsigned-char}.  Likewise, the option
1215 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1216
1217 @item -fsigned-bitfields
1218 @itemx -funsigned-bitfields
1219 @itemx -fno-signed-bitfields
1220 @itemx -fno-unsigned-bitfields
1221 @opindex fsigned-bitfields
1222 @opindex funsigned-bitfields
1223 @opindex fno-signed-bitfields
1224 @opindex fno-unsigned-bitfields
1225 These options control whether a bit-field is signed or unsigned, when the
1226 declaration does not use either @code{signed} or @code{unsigned}.  By
1227 default, such a bit-field is signed, because this is consistent: the
1228 basic integer types such as @code{int} are signed types.
1229
1230 @item -fwritable-strings
1231 @opindex fwritable-strings
1232 Store string constants in the writable data segment and don't uniquize
1233 them.  This is for compatibility with old programs which assume they can
1234 write into string constants.
1235
1236 Writing into string constants is a very bad idea; ``constants'' should
1237 be constant.
1238 @end table
1239
1240 @node C++ Dialect Options
1241 @section Options Controlling C++ Dialect
1242
1243 @cindex compiler options, C++
1244 @cindex C++ options, command line
1245 @cindex options, C++
1246 This section describes the command-line options that are only meaningful
1247 for C++ programs; but you can also use most of the GNU compiler options
1248 regardless of what language your program is in.  For example, you
1249 might compile a file @code{firstClass.C} like this:
1250
1251 @example
1252 g++ -g -frepo -O -c firstClass.C
1253 @end example
1254
1255 @noindent
1256 In this example, only @option{-frepo} is an option meant
1257 only for C++ programs; you can use the other options with any
1258 language supported by GCC@.
1259
1260 Here is a list of options that are @emph{only} for compiling C++ programs:
1261
1262 @table @gcctabopt
1263
1264 @item -fabi-version=@var{n}
1265 @opindex fabi-version
1266 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1267 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1268 version that conforms most closely to the C++ ABI specification.
1269 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1270 fixed.
1271
1272 The default is version 1.
1273
1274 @item -fno-access-control
1275 @opindex fno-access-control
1276 Turn off all access checking.  This switch is mainly useful for working
1277 around bugs in the access control code.
1278
1279 @item -fcheck-new
1280 @opindex fcheck-new
1281 Check that the pointer returned by @code{operator new} is non-null
1282 before attempting to modify the storage allocated.  This check is
1283 normally unnecessary because the C++ standard specifies that
1284 @code{operator new} will only return @code{0} if it is declared
1285 @samp{throw()}, in which case the compiler will always check the
1286 return value even without this option.  In all other cases, when
1287 @code{operator new} has a non-empty exception specification, memory
1288 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1289 @samp{new (nothrow)}.
1290
1291 @item -fconserve-space
1292 @opindex fconserve-space
1293 Put uninitialized or runtime-initialized global variables into the
1294 common segment, as C does.  This saves space in the executable at the
1295 cost of not diagnosing duplicate definitions.  If you compile with this
1296 flag and your program mysteriously crashes after @code{main()} has
1297 completed, you may have an object that is being destroyed twice because
1298 two definitions were merged.
1299
1300 This option is no longer useful on most targets, now that support has
1301 been added for putting variables into BSS without making them common.
1302
1303 @item -fno-const-strings
1304 @opindex fno-const-strings
1305 Give string constants type @code{char *} instead of type @code{const
1306 char *}.  By default, G++ uses type @code{const char *} as required by
1307 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1308 actually modify the value of a string constant, unless you also use
1309 @option{-fwritable-strings}.
1310
1311 This option might be removed in a future release of G++.  For maximum
1312 portability, you should structure your code so that it works with
1313 string constants that have type @code{const char *}.
1314
1315 @item -fdollars-in-identifiers
1316 @opindex fdollars-in-identifiers
1317 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1318 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1319 @samp{$} by default on most target systems, but there are a few exceptions.)
1320 Traditional C allowed the character @samp{$} to form part of
1321 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1322
1323 @item -fno-elide-constructors
1324 @opindex fno-elide-constructors
1325 The C++ standard allows an implementation to omit creating a temporary
1326 which is only used to initialize another object of the same type.
1327 Specifying this option disables that optimization, and forces G++ to
1328 call the copy constructor in all cases.
1329
1330 @item -fno-enforce-eh-specs
1331 @opindex fno-enforce-eh-specs
1332 Don't check for violation of exception specifications at runtime.  This
1333 option violates the C++ standard, but may be useful for reducing code
1334 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1335 will still optimize based on the exception specifications.
1336
1337 @item -fexternal-templates
1338 @opindex fexternal-templates
1339
1340 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1341 template instantiation; template instances are emitted or not according
1342 to the location of the template definition.  @xref{Template
1343 Instantiation}, for more information.
1344
1345 This option is deprecated.
1346
1347 @item -falt-external-templates
1348 @opindex falt-external-templates
1349 Similar to @option{-fexternal-templates}, but template instances are
1350 emitted or not according to the place where they are first instantiated.
1351 @xref{Template Instantiation}, for more information.
1352
1353 This option is deprecated.
1354
1355 @item -ffor-scope
1356 @itemx -fno-for-scope
1357 @opindex ffor-scope
1358 @opindex fno-for-scope
1359 If @option{-ffor-scope} is specified, the scope of variables declared in
1360 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1361 as specified by the C++ standard.
1362 If @option{-fno-for-scope} is specified, the scope of variables declared in
1363 a @i{for-init-statement} extends to the end of the enclosing scope,
1364 as was the case in old versions of G++, and other (traditional)
1365 implementations of C++.
1366
1367 The default if neither flag is given to follow the standard,
1368 but to allow and give a warning for old-style code that would
1369 otherwise be invalid, or have different behavior.
1370
1371 @item -fno-gnu-keywords
1372 @opindex fno-gnu-keywords
1373 Do not recognize @code{typeof} as a keyword, so that code can use this
1374 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1375 @option{-ansi} implies @option{-fno-gnu-keywords}.
1376
1377 @item -fno-implicit-templates
1378 @opindex fno-implicit-templates
1379 Never emit code for non-inline templates which are instantiated
1380 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1381 @xref{Template Instantiation}, for more information.
1382
1383 @item -fno-implicit-inline-templates
1384 @opindex fno-implicit-inline-templates
1385 Don't emit code for implicit instantiations of inline templates, either.
1386 The default is to handle inlines differently so that compiles with and
1387 without optimization will need the same set of explicit instantiations.
1388
1389 @item -fno-implement-inlines
1390 @opindex fno-implement-inlines
1391 To save space, do not emit out-of-line copies of inline functions
1392 controlled by @samp{#pragma implementation}.  This will cause linker
1393 errors if these functions are not inlined everywhere they are called.
1394
1395 @item -fms-extensions
1396 @opindex fms-extensions
1397 Disable pedantic warnings about constructs used in MFC, such as implicit
1398 int and getting a pointer to member function via non-standard syntax.
1399
1400 @item -fno-nonansi-builtins
1401 @opindex fno-nonansi-builtins
1402 Disable built-in declarations of functions that are not mandated by
1403 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1404 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1405
1406 @item -fno-operator-names
1407 @opindex fno-operator-names
1408 Do not treat the operator name keywords @code{and}, @code{bitand},
1409 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1410 synonyms as keywords.
1411
1412 @item -fno-optional-diags
1413 @opindex fno-optional-diags
1414 Disable diagnostics that the standard says a compiler does not need to
1415 issue.  Currently, the only such diagnostic issued by G++ is the one for
1416 a name having multiple meanings within a class.
1417
1418 @item -fpermissive
1419 @opindex fpermissive
1420 Downgrade messages about nonconformant code from errors to warnings.  By
1421 default, G++ effectively sets @option{-pedantic-errors} without
1422 @option{-pedantic}; this option reverses that.  This behavior and this
1423 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1424
1425 @item -frepo
1426 @opindex frepo
1427 Enable automatic template instantiation at link time.  This option also
1428 implies @option{-fno-implicit-templates}.  @xref{Template
1429 Instantiation}, for more information.
1430
1431 @item -fno-rtti
1432 @opindex fno-rtti
1433 Disable generation of information about every class with virtual
1434 functions for use by the C++ runtime type identification features
1435 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1436 of the language, you can save some space by using this flag.  Note that
1437 exception handling uses the same information, but it will generate it as
1438 needed.
1439
1440 @item -fstats
1441 @opindex fstats
1442 Emit statistics about front-end processing at the end of the compilation.
1443 This information is generally only useful to the G++ development team.
1444
1445 @item -ftemplate-depth-@var{n}
1446 @opindex ftemplate-depth
1447 Set the maximum instantiation depth for template classes to @var{n}.
1448 A limit on the template instantiation depth is needed to detect
1449 endless recursions during template class instantiation.  ANSI/ISO C++
1450 conforming programs must not rely on a maximum depth greater than 17.
1451
1452 @item -fuse-cxa-atexit
1453 @opindex fuse-cxa-atexit
1454 Register destructors for objects with static storage duration with the
1455 @code{__cxa_atexit} function rather than the @code{atexit} function.
1456 This option is required for fully standards-compliant handling of static
1457 destructors, but will only work if your C library supports
1458 @code{__cxa_atexit}.
1459
1460 @item -fvtable-gc
1461 @opindex fvtable-gc
1462 Emit special relocations for vtables and virtual function references
1463 so that the linker can identify unused virtual functions and zero out
1464 vtable slots that refer to them.  This is most useful with
1465 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1466 also discard the functions themselves.
1467
1468 This optimization requires GNU as and GNU ld.  Not all systems support
1469 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1470
1471 @item -fno-weak
1472 @opindex fno-weak
1473 Do not use weak symbol support, even if it is provided by the linker.
1474 By default, G++ will use weak symbols if they are available.  This
1475 option exists only for testing, and should not be used by end-users;
1476 it will result in inferior code and has no benefits.  This option may
1477 be removed in a future release of G++.
1478
1479 @item -nostdinc++
1480 @opindex nostdinc++
1481 Do not search for header files in the standard directories specific to
1482 C++, but do still search the other standard directories.  (This option
1483 is used when building the C++ library.)
1484 @end table
1485
1486 In addition, these optimization, warning, and code generation options
1487 have meanings only for C++ programs:
1488
1489 @table @gcctabopt
1490 @item -fno-default-inline
1491 @opindex fno-default-inline
1492 Do not assume @samp{inline} for functions defined inside a class scope.
1493 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1494 functions will have linkage like inline functions; they just won't be
1495 inlined by default.
1496
1497 @item -Wabi @r{(C++ only)}
1498 @opindex Wabi
1499 Warn when G++ generates code that is probably not compatible with the
1500 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1501 all such cases, there are probably some cases that are not warned about, 
1502 even though G++ is generating incompatible code.  There may also be
1503 cases where warnings are emitted even though the code that is generated
1504 will be compatible.
1505
1506 You should rewrite your code to avoid these warnings if you are
1507 concerned about the fact that code generated by G++ may not be binary
1508 compatible with code generated by other compilers.
1509
1510 The known incompatibilities at this point include:
1511
1512 @itemize @bullet
1513
1514 @item
1515 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1516 pack data into the same byte as a base class.  For example:
1517
1518 @smallexample
1519 struct A @{ virtual void f(); int f1 : 1; @};
1520 struct B : public A @{ int f2 : 1; @};
1521 @end smallexample
1522
1523 @noindent
1524 In this case, G++ will place @code{B::f2} into the same byte
1525 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1526 by explicitly padding @code{A} so that its size is a multiple of the
1527 byte size on your platform; that will cause G++ and other compilers to
1528 layout @code{B} identically.
1529
1530 @item
1531 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1532 tail padding when laying out virtual bases.  For example:
1533
1534 @smallexample
1535 struct A @{ virtual void f(); char c1; @};
1536 struct B @{ B(); char c2; @};
1537 struct C : public A, public virtual B @{@};
1538 @end smallexample
1539
1540 @noindent
1541 In this case, G++ will not place @code{B} into the tail-padding for
1542 @code{A}; other compilers will.  You can avoid this problem by
1543 explicitly padding @code{A} so that its size is a multiple of its
1544 alignment (ignoring virtual base classes); that will cause G++ and other
1545 compilers to layout @code{C} identically.
1546
1547 @item
1548 Incorrect handling of bit-fields with declared widths greater than that
1549 of their underlying types, when the bit-fields appear in a union.  For
1550 example:
1551
1552 @smallexample
1553 union U @{ int i : 4096; @};
1554 @end smallexample
1555
1556 @noindent
1557 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1558 union too small by the number of bits in an @code{int}.
1559
1560 @item
1561 Empty classes can be placed at incorrect offsets.  For example:
1562  
1563 @smallexample
1564 struct A @{@};
1565
1566 struct B @{
1567   A a;
1568   virtual void f ();
1569 @};
1570
1571 struct C : public B, public A @{@};
1572 @end smallexample
1573
1574 @noindent
1575 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1576 it should be placed at offset zero.  G++ mistakenly believes that the
1577 @code{A} data member of @code{B} is already at offset zero.
1578
1579 @item
1580 Names of template functions whose types involve @code{typename} or
1581 template template parameters can be mangled incorrectly.
1582
1583 @smallexample
1584 template <typename Q>
1585 void f(typename Q::X) @{@}
1586
1587 template <template <typename> class Q>
1588 void f(typename Q<int>::X) @{@}
1589 @end smallexample
1590
1591 @noindent
1592 Instantiations of these templates may be mangled incorrectly.
1593
1594 @end itemize
1595
1596 @item -Wctor-dtor-privacy @r{(C++ only)}
1597 @opindex Wctor-dtor-privacy
1598 Warn when a class seems unusable, because all the constructors or
1599 destructors in a class are private and the class has no friends or
1600 public static member functions.  This warning is enabled by default.
1601
1602 @item -Wnon-virtual-dtor @r{(C++ only)}
1603 @opindex Wnon-virtual-dtor
1604 Warn when a class declares a non-virtual destructor that should probably
1605 be virtual, because it looks like the class will be used polymorphically.
1606 This warning is enabled by @option{-Wall}.
1607
1608 @item -Wreorder @r{(C++ only)}
1609 @opindex Wreorder
1610 @cindex reordering, warning
1611 @cindex warning for reordering of member initializers
1612 Warn when the order of member initializers given in the code does not
1613 match the order in which they must be executed.  For instance:
1614
1615 @smallexample
1616 struct A @{
1617   int i;
1618   int j;
1619   A(): j (0), i (1) @{ @}
1620 @};
1621 @end smallexample
1622
1623 Here the compiler will warn that the member initializers for @samp{i}
1624 and @samp{j} will be rearranged to match the declaration order of the
1625 members.  This warning is enabled by @option{-Wall}.
1626 @end table
1627
1628 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1629
1630 @table @gcctabopt
1631 @item -Weffc++ @r{(C++ only)}
1632 @opindex Weffc++
1633 Warn about violations of the following style guidelines from Scott Meyers'
1634 @cite{Effective C++} book:
1635
1636 @itemize @bullet
1637 @item
1638 Item 11:  Define a copy constructor and an assignment operator for classes
1639 with dynamically allocated memory.
1640
1641 @item
1642 Item 12:  Prefer initialization to assignment in constructors.
1643
1644 @item
1645 Item 14:  Make destructors virtual in base classes.
1646
1647 @item
1648 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1649
1650 @item
1651 Item 23:  Don't try to return a reference when you must return an object.
1652
1653 @end itemize
1654
1655 and about violations of the following style guidelines from Scott Meyers'
1656 @cite{More Effective C++} book:
1657
1658 @itemize @bullet
1659 @item
1660 Item 6:  Distinguish between prefix and postfix forms of increment and
1661 decrement operators.
1662
1663 @item
1664 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1665
1666 @end itemize
1667
1668 If you use this option, you should be aware that the standard library
1669 headers do not obey all of these guidelines; you can use @samp{grep -v}
1670 to filter out those warnings.
1671
1672 @item -Wno-deprecated @r{(C++ only)}
1673 @opindex Wno-deprecated
1674 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1675
1676 @item -Wno-non-template-friend @r{(C++ only)}
1677 @opindex Wno-non-template-friend
1678 Disable warnings when non-templatized friend functions are declared
1679 within a template.  With the advent of explicit template specification
1680 support in G++, if the name of the friend is an unqualified-id (i.e.,
1681 @samp{friend foo(int)}), the C++ language specification demands that the
1682 friend declare or define an ordinary, nontemplate function.  (Section
1683 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1684 could be interpreted as a particular specialization of a templatized
1685 function.  Because this non-conforming behavior is no longer the default
1686 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1687 check existing code for potential trouble spots, and is on by default.
1688 This new compiler behavior can be turned off with
1689 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1690 but disables the helpful warning.
1691
1692 @item -Wold-style-cast @r{(C++ only)}
1693 @opindex Wold-style-cast
1694 Warn if an old-style (C-style) cast to a non-void type is used within
1695 a C++ program.  The new-style casts (@samp{static_cast},
1696 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1697 unintended effects, and much easier to grep for.
1698
1699 @item -Woverloaded-virtual @r{(C++ only)}
1700 @opindex Woverloaded-virtual
1701 @cindex overloaded virtual fn, warning
1702 @cindex warning for overloaded virtual fn
1703 Warn when a function declaration hides virtual functions from a
1704 base class.  For example, in:
1705
1706 @smallexample
1707 struct A @{
1708   virtual void f();
1709 @};
1710
1711 struct B: public A @{
1712   void f(int);
1713 @};
1714 @end smallexample
1715
1716 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1717 like this:
1718
1719 @smallexample
1720 B* b;
1721 b->f();
1722 @end smallexample
1723
1724 will fail to compile.
1725
1726 @item -Wno-pmf-conversions @r{(C++ only)}
1727 @opindex Wno-pmf-conversions
1728 Disable the diagnostic for converting a bound pointer to member function
1729 to a plain pointer.
1730
1731 @item -Wsign-promo @r{(C++ only)}
1732 @opindex Wsign-promo
1733 Warn when overload resolution chooses a promotion from unsigned or
1734 enumeral type to a signed type over a conversion to an unsigned type of
1735 the same size.  Previous versions of G++ would try to preserve
1736 unsignedness, but the standard mandates the current behavior.
1737
1738 @item -Wsynth @r{(C++ only)}
1739 @opindex Wsynth
1740 @cindex warning for synthesized methods
1741 @cindex synthesized methods, warning
1742 Warn when G++'s synthesis behavior does not match that of cfront.  For
1743 instance:
1744
1745 @smallexample
1746 struct A @{
1747   operator int ();
1748   A& operator = (int);
1749 @};
1750
1751 main ()
1752 @{
1753   A a,b;
1754   a = b;
1755 @}
1756 @end smallexample
1757
1758 In this example, G++ will synthesize a default @samp{A& operator =
1759 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1760 @end table
1761
1762 @node Objective-C Dialect Options
1763 @section Options Controlling Objective-C Dialect
1764
1765 @cindex compiler options, Objective-C
1766 @cindex Objective-C options, command line
1767 @cindex options, Objective-C
1768 This section describes the command-line options that are only meaningful
1769 for Objective-C programs; but you can also use most of the GNU compiler
1770 options regardless of what language your program is in.  For example,
1771 you might compile a file @code{some_class.m} like this:
1772
1773 @example
1774 gcc -g -fgnu-runtime -O -c some_class.m
1775 @end example
1776
1777 @noindent
1778 In this example, only @option{-fgnu-runtime} is an option meant only for
1779 Objective-C programs; you can use the other options with any language
1780 supported by GCC@.
1781
1782 Here is a list of options that are @emph{only} for compiling Objective-C
1783 programs:
1784
1785 @table @gcctabopt
1786 @item -fconstant-string-class=@var{class-name}
1787 @opindex fconstant-string-class
1788 Use @var{class-name} as the name of the class to instantiate for each
1789 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1790 class name is @code{NXConstantString}.
1791
1792 @item -fgnu-runtime
1793 @opindex fgnu-runtime
1794 Generate object code compatible with the standard GNU Objective-C
1795 runtime.  This is the default for most types of systems.
1796
1797 @item -fnext-runtime
1798 @opindex fnext-runtime
1799 Generate output compatible with the NeXT runtime.  This is the default
1800 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1801 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1802 used.
1803
1804 @item -gen-decls
1805 @opindex gen-decls
1806 Dump interface declarations for all classes seen in the source file to a
1807 file named @file{@var{sourcename}.decl}.
1808
1809 @item -Wno-protocol
1810 @opindex Wno-protocol
1811 If a class is declared to implement a protocol, a warning is issued for
1812 every method in the protocol that is not implemented by the class.  The
1813 default behavior is to issue a warning for every method not explicitly
1814 implemented in the class, even if a method implementation is inherited
1815 from the superclass.  If you use the @code{-Wno-protocol} option, then
1816 methods inherited from the superclass are considered to be implemented,
1817 and no warning is issued for them.
1818
1819 @item -Wselector
1820 @opindex Wselector
1821 Warn if multiple methods of different types for the same selector are
1822 found during compilation.  The check is performed on the list of methods
1823 in the final stage of compilation.  Additionally, a check is performed
1824 that for each selector appearing in a @code{@@selector(@dots{})}
1825 expression, a corresponding method with that selector has been found
1826 during compilation.  Because these checks scan the method table only at
1827 the end of compilation, these warnings are not produced if the final
1828 stage of compilation is not reached, for example because an error is
1829 found during compilation, or because the @code{-fsyntax-only} option is
1830 being used.
1831
1832 @item -Wundeclared-selector
1833 @opindex Wundeclared-selector
1834 Warn if a @code{@@selector(@dots{})} expression referring to an
1835 undeclared selector is found.  A selector is considered undeclared if no
1836 method with that name has been declared (explicitly, in an
1837 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1838 an @code{@@implementation} section) before the
1839 @code{@@selector(@dots{})} expression.  This option always performs its
1840 checks as soon as a @code{@@selector(@dots{})} expression is found
1841 (while @code{-Wselector} only performs its checks in the final stage of
1842 compilation), and so additionally enforces the coding style convention
1843 that methods and selectors must be declared before being used.
1844
1845 @c not documented because only avail via -Wp
1846 @c @item -print-objc-runtime-info
1847
1848 @end table
1849
1850 @node Language Independent Options
1851 @section Options to Control Diagnostic Messages Formatting
1852 @cindex options to control diagnostics formatting
1853 @cindex diagnostic messages
1854 @cindex message formatting
1855
1856 Traditionally, diagnostic messages have been formatted irrespective of
1857 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1858 below can be used to control the diagnostic messages formatting
1859 algorithm, e.g.@: how many characters per line, how often source location
1860 information should be reported.  Right now, only the C++ front end can
1861 honor these options.  However it is expected, in the near future, that
1862 the remaining front ends would be able to digest them correctly.
1863
1864 @table @gcctabopt
1865 @item -fmessage-length=@var{n}
1866 @opindex fmessage-length
1867 Try to format error messages so that they fit on lines of about @var{n}
1868 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1869 the front ends supported by GCC@.  If @var{n} is zero, then no
1870 line-wrapping will be done; each error message will appear on a single
1871 line.
1872
1873 @opindex fdiagnostics-show-location
1874 @item -fdiagnostics-show-location=once
1875 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1876 reporter to emit @emph{once} source location information; that is, in
1877 case the message is too long to fit on a single physical line and has to
1878 be wrapped, the source location won't be emitted (as prefix) again,
1879 over and over, in subsequent continuation lines.  This is the default
1880 behavior.
1881
1882 @item -fdiagnostics-show-location=every-line
1883 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1884 messages reporter to emit the same source location information (as
1885 prefix) for physical lines that result from the process of breaking
1886 a message which is too long to fit on a single line.
1887
1888 @end table
1889
1890 @node Warning Options
1891 @section Options to Request or Suppress Warnings
1892 @cindex options to control warnings
1893 @cindex warning messages
1894 @cindex messages, warning
1895 @cindex suppressing warnings
1896
1897 Warnings are diagnostic messages that report constructions which
1898 are not inherently erroneous but which are risky or suggest there
1899 may have been an error.
1900
1901 You can request many specific warnings with options beginning @samp{-W},
1902 for example @option{-Wimplicit} to request warnings on implicit
1903 declarations.  Each of these specific warning options also has a
1904 negative form beginning @samp{-Wno-} to turn off warnings;
1905 for example, @option{-Wno-implicit}.  This manual lists only one of the
1906 two forms, whichever is not the default.
1907
1908 The following options control the amount and kinds of warnings produced
1909 by GCC; for further, language-specific options also refer to
1910 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1911
1912 @table @gcctabopt
1913 @cindex syntax checking
1914 @item -fsyntax-only
1915 @opindex fsyntax-only
1916 Check the code for syntax errors, but don't do anything beyond that.
1917
1918 @item -pedantic
1919 @opindex pedantic
1920 Issue all the warnings demanded by strict ISO C and ISO C++;
1921 reject all programs that use forbidden extensions, and some other
1922 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1923 version of the ISO C standard specified by any @option{-std} option used.
1924
1925 Valid ISO C and ISO C++ programs should compile properly with or without
1926 this option (though a rare few will require @option{-ansi} or a
1927 @option{-std} option specifying the required version of ISO C)@.  However,
1928 without this option, certain GNU extensions and traditional C and C++
1929 features are supported as well.  With this option, they are rejected.
1930
1931 @option{-pedantic} does not cause warning messages for use of the
1932 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1933 warnings are also disabled in the expression that follows
1934 @code{__extension__}.  However, only system header files should use
1935 these escape routes; application programs should avoid them.
1936 @xref{Alternate Keywords}.
1937
1938 Some users try to use @option{-pedantic} to check programs for strict ISO
1939 C conformance.  They soon find that it does not do quite what they want:
1940 it finds some non-ISO practices, but not all---only those for which
1941 ISO C @emph{requires} a diagnostic, and some others for which
1942 diagnostics have been added.
1943
1944 A feature to report any failure to conform to ISO C might be useful in
1945 some instances, but would require considerable additional work and would
1946 be quite different from @option{-pedantic}.  We don't have plans to
1947 support such a feature in the near future.
1948
1949 Where the standard specified with @option{-std} represents a GNU
1950 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1951 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1952 extended dialect is based.  Warnings from @option{-pedantic} are given
1953 where they are required by the base standard.  (It would not make sense
1954 for such warnings to be given only for features not in the specified GNU
1955 C dialect, since by definition the GNU dialects of C include all
1956 features the compiler supports with the given option, and there would be
1957 nothing to warn about.)
1958
1959 @item -pedantic-errors
1960 @opindex pedantic-errors
1961 Like @option{-pedantic}, except that errors are produced rather than
1962 warnings.
1963
1964 @item -w
1965 @opindex w
1966 Inhibit all warning messages.
1967
1968 @item -Wno-import
1969 @opindex Wno-import
1970 Inhibit warning messages about the use of @samp{#import}.
1971
1972 @item -Wchar-subscripts
1973 @opindex Wchar-subscripts
1974 Warn if an array subscript has type @code{char}.  This is a common cause
1975 of error, as programmers often forget that this type is signed on some
1976 machines.
1977
1978 @item -Wcomment
1979 @opindex Wcomment
1980 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1981 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1982
1983 @item -Wformat
1984 @opindex Wformat
1985 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1986 the arguments supplied have types appropriate to the format string
1987 specified, and that the conversions specified in the format string make
1988 sense.  This includes standard functions, and others specified by format
1989 attributes (@pxref{Function Attributes}), in the @code{printf},
1990 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1991 not in the C standard) families.
1992
1993 The formats are checked against the format features supported by GNU
1994 libc version 2.2.  These include all ISO C90 and C99 features, as well
1995 as features from the Single Unix Specification and some BSD and GNU
1996 extensions.  Other library implementations may not support all these
1997 features; GCC does not support warning about features that go beyond a
1998 particular library's limitations.  However, if @option{-pedantic} is used
1999 with @option{-Wformat}, warnings will be given about format features not
2000 in the selected standard version (but not for @code{strfmon} formats,
2001 since those are not in any version of the C standard).  @xref{C Dialect
2002 Options,,Options Controlling C Dialect}.
2003
2004 Since @option{-Wformat} also checks for null format arguments for
2005 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2006
2007 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2008 aspects of format checking, the options @option{-Wno-format-y2k},
2009 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2010 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2011 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2012
2013 @item -Wno-format-y2k
2014 @opindex Wno-format-y2k
2015 If @option{-Wformat} is specified, do not warn about @code{strftime}
2016 formats which may yield only a two-digit year.
2017
2018 @item -Wno-format-extra-args
2019 @opindex Wno-format-extra-args
2020 If @option{-Wformat} is specified, do not warn about excess arguments to a
2021 @code{printf} or @code{scanf} format function.  The C standard specifies
2022 that such arguments are ignored.
2023
2024 Where the unused arguments lie between used arguments that are
2025 specified with @samp{$} operand number specifications, normally
2026 warnings are still given, since the implementation could not know what
2027 type to pass to @code{va_arg} to skip the unused arguments.  However,
2028 in the case of @code{scanf} formats, this option will suppress the
2029 warning if the unused arguments are all pointers, since the Single
2030 Unix Specification says that such unused arguments are allowed.
2031
2032 @item -Wno-format-zero-length
2033 @opindex Wno-format-zero-length
2034 If @option{-Wformat} is specified, do not warn about zero-length formats.
2035 The C standard specifies that zero-length formats are allowed.
2036
2037 @item -Wformat-nonliteral
2038 @opindex Wformat-nonliteral
2039 If @option{-Wformat} is specified, also warn if the format string is not a
2040 string literal and so cannot be checked, unless the format function
2041 takes its format arguments as a @code{va_list}.
2042
2043 @item -Wformat-security
2044 @opindex Wformat-security
2045 If @option{-Wformat} is specified, also warn about uses of format
2046 functions that represent possible security problems.  At present, this
2047 warns about calls to @code{printf} and @code{scanf} functions where the
2048 format string is not a string literal and there are no format arguments,
2049 as in @code{printf (foo);}.  This may be a security hole if the format
2050 string came from untrusted input and contains @samp{%n}.  (This is
2051 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2052 in future warnings may be added to @option{-Wformat-security} that are not
2053 included in @option{-Wformat-nonliteral}.)
2054
2055 @item -Wformat=2
2056 @opindex Wformat=2
2057 Enable @option{-Wformat} plus format checks not included in
2058 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2059 -Wformat-nonliteral -Wformat-security}.
2060
2061 @item -Wnonnull
2062 @opindex Wnonnull
2063 Enable warning about passing a null pointer for arguments marked as
2064 requiring a non-null value by the @code{nonnull} function attribute.
2065
2066 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2067 can be disabled with the @option{-Wno-nonnull} option.
2068
2069 @item -Wimplicit-int
2070 @opindex Wimplicit-int
2071 Warn when a declaration does not specify a type.
2072
2073 @item -Wimplicit-function-declaration
2074 @itemx -Werror-implicit-function-declaration
2075 @opindex Wimplicit-function-declaration
2076 @opindex Werror-implicit-function-declaration
2077 Give a warning (or error) whenever a function is used before being
2078 declared.
2079
2080 @item -Wimplicit
2081 @opindex Wimplicit
2082 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2083
2084 @item -Wmain
2085 @opindex Wmain
2086 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2087 function with external linkage, returning int, taking either zero
2088 arguments, two, or three arguments of appropriate types.
2089
2090 @item -Wmissing-braces
2091 @opindex Wmissing-braces
2092 Warn if an aggregate or union initializer is not fully bracketed.  In
2093 the following example, the initializer for @samp{a} is not fully
2094 bracketed, but that for @samp{b} is fully bracketed.
2095
2096 @smallexample
2097 int a[2][2] = @{ 0, 1, 2, 3 @};
2098 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2099 @end smallexample
2100
2101 @item -Wparentheses
2102 @opindex Wparentheses
2103 Warn if parentheses are omitted in certain contexts, such
2104 as when there is an assignment in a context where a truth value
2105 is expected, or when operators are nested whose precedence people
2106 often get confused about.
2107
2108 Also warn about constructions where there may be confusion to which
2109 @code{if} statement an @code{else} branch belongs.  Here is an example of
2110 such a case:
2111
2112 @smallexample
2113 @group
2114 @{
2115   if (a)
2116     if (b)
2117       foo ();
2118   else
2119     bar ();
2120 @}
2121 @end group
2122 @end smallexample
2123
2124 In C, every @code{else} branch belongs to the innermost possible @code{if}
2125 statement, which in this example is @code{if (b)}.  This is often not
2126 what the programmer expected, as illustrated in the above example by
2127 indentation the programmer chose.  When there is the potential for this
2128 confusion, GCC will issue a warning when this flag is specified.
2129 To eliminate the warning, add explicit braces around the innermost
2130 @code{if} statement so there is no way the @code{else} could belong to
2131 the enclosing @code{if}.  The resulting code would look like this:
2132
2133 @smallexample
2134 @group
2135 @{
2136   if (a)
2137     @{
2138       if (b)
2139         foo ();
2140       else
2141         bar ();
2142     @}
2143 @}
2144 @end group
2145 @end smallexample
2146
2147 @item -Wsequence-point
2148 @opindex Wsequence-point
2149 Warn about code that may have undefined semantics because of violations
2150 of sequence point rules in the C standard.
2151
2152 The C standard defines the order in which expressions in a C program are
2153 evaluated in terms of @dfn{sequence points}, which represent a partial
2154 ordering between the execution of parts of the program: those executed
2155 before the sequence point, and those executed after it.  These occur
2156 after the evaluation of a full expression (one which is not part of a
2157 larger expression), after the evaluation of the first operand of a
2158 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2159 function is called (but after the evaluation of its arguments and the
2160 expression denoting the called function), and in certain other places.
2161 Other than as expressed by the sequence point rules, the order of
2162 evaluation of subexpressions of an expression is not specified.  All
2163 these rules describe only a partial order rather than a total order,
2164 since, for example, if two functions are called within one expression
2165 with no sequence point between them, the order in which the functions
2166 are called is not specified.  However, the standards committee have
2167 ruled that function calls do not overlap.
2168
2169 It is not specified when between sequence points modifications to the
2170 values of objects take effect.  Programs whose behavior depends on this
2171 have undefined behavior; the C standard specifies that ``Between the
2172 previous and next sequence point an object shall have its stored value
2173 modified at most once by the evaluation of an expression.  Furthermore,
2174 the prior value shall be read only to determine the value to be
2175 stored.''.  If a program breaks these rules, the results on any
2176 particular implementation are entirely unpredictable.
2177
2178 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2179 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2180 diagnosed by this option, and it may give an occasional false positive
2181 result, but in general it has been found fairly effective at detecting
2182 this sort of problem in programs.
2183
2184 The present implementation of this option only works for C programs.  A
2185 future implementation may also work for C++ programs.
2186
2187 The C standard is worded confusingly, therefore there is some debate
2188 over the precise meaning of the sequence point rules in subtle cases.
2189 Links to discussions of the problem, including proposed formal
2190 definitions, may be found on our readings page, at
2191 @w{@uref{http://gcc.gnu.org/readings.html}}.
2192
2193 @item -Wreturn-type
2194 @opindex Wreturn-type
2195 Warn whenever a function is defined with a return-type that defaults to
2196 @code{int}.  Also warn about any @code{return} statement with no
2197 return-value in a function whose return-type is not @code{void}.
2198
2199 For C++, a function without return type always produces a diagnostic
2200 message, even when @option{-Wno-return-type} is specified.  The only
2201 exceptions are @samp{main} and functions defined in system headers.
2202
2203 @item -Wswitch
2204 @opindex Wswitch
2205 Warn whenever a @code{switch} statement has an index of enumeral type
2206 and lacks a @code{case} for one or more of the named codes of that
2207 enumeration.  (The presence of a @code{default} label prevents this
2208 warning.)  @code{case} labels outside the enumeration range also
2209 provoke warnings when this option is used.
2210
2211 @item -Wswitch-default
2212 @opindex Wswitch-switch
2213 Warn whenever a @code{switch} statement does not have a @code{default}
2214 case.
2215
2216 @item -Wswitch-enum
2217 @opindex Wswitch-enum
2218 Warn whenever a @code{switch} statement has an index of enumeral type
2219 and lacks a @code{case} for one or more of the named codes of that
2220 enumeration.  @code{case} labels outside the enumeration range also
2221 provoke warnings when this option is used.
2222
2223 @item -Wtrigraphs
2224 @opindex Wtrigraphs
2225 Warn if any trigraphs are encountered that might change the meaning of
2226 the program (trigraphs within comments are not warned about).
2227
2228 @item -Wunused-function
2229 @opindex Wunused-function
2230 Warn whenever a static function is declared but not defined or a
2231 non\-inline static function is unused.
2232
2233 @item -Wunused-label
2234 @opindex Wunused-label
2235 Warn whenever a label is declared but not used.
2236
2237 To suppress this warning use the @samp{unused} attribute
2238 (@pxref{Variable Attributes}).
2239
2240 @item -Wunused-parameter
2241 @opindex Wunused-parameter
2242 Warn whenever a function parameter is unused aside from its declaration.
2243
2244 To suppress this warning use the @samp{unused} attribute
2245 (@pxref{Variable Attributes}).
2246
2247 @item -Wunused-variable
2248 @opindex Wunused-variable
2249 Warn whenever a local variable or non-constant static variable is unused
2250 aside from its declaration
2251
2252 To suppress this warning use the @samp{unused} attribute
2253 (@pxref{Variable Attributes}).
2254
2255 @item -Wunused-value
2256 @opindex Wunused-value
2257 Warn whenever a statement computes a result that is explicitly not used.
2258
2259 To suppress this warning cast the expression to @samp{void}.
2260
2261 @item -Wunused
2262 @opindex Wunused
2263 All the above @option{-Wunused} options combined.
2264
2265 In order to get a warning about an unused function parameter, you must
2266 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2267 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2268
2269 @item -Wuninitialized
2270 @opindex Wuninitialized
2271 Warn if an automatic variable is used without first being initialized or
2272 if a variable may be clobbered by a @code{setjmp} call.
2273
2274 These warnings are possible only in optimizing compilation,
2275 because they require data flow information that is computed only
2276 when optimizing.  If you don't specify @option{-O}, you simply won't
2277 get these warnings.
2278
2279 These warnings occur only for variables that are candidates for
2280 register allocation.  Therefore, they do not occur for a variable that
2281 is declared @code{volatile}, or whose address is taken, or whose size
2282 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2283 structures, unions or arrays, even when they are in registers.
2284
2285 Note that there may be no warning about a variable that is used only
2286 to compute a value that itself is never used, because such
2287 computations may be deleted by data flow analysis before the warnings
2288 are printed.
2289
2290 These warnings are made optional because GCC is not smart
2291 enough to see all the reasons why the code might be correct
2292 despite appearing to have an error.  Here is one example of how
2293 this can happen:
2294
2295 @smallexample
2296 @group
2297 @{
2298   int x;
2299   switch (y)
2300     @{
2301     case 1: x = 1;
2302       break;
2303     case 2: x = 4;
2304       break;
2305     case 3: x = 5;
2306     @}
2307   foo (x);
2308 @}
2309 @end group
2310 @end smallexample
2311
2312 @noindent
2313 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2314 always initialized, but GCC doesn't know this.  Here is
2315 another common case:
2316
2317 @smallexample
2318 @{
2319   int save_y;
2320   if (change_y) save_y = y, y = new_y;
2321   @dots{}
2322   if (change_y) y = save_y;
2323 @}
2324 @end smallexample
2325
2326 @noindent
2327 This has no bug because @code{save_y} is used only if it is set.
2328
2329 @cindex @code{longjmp} warnings
2330 This option also warns when a non-volatile automatic variable might be
2331 changed by a call to @code{longjmp}.  These warnings as well are possible
2332 only in optimizing compilation.
2333
2334 The compiler sees only the calls to @code{setjmp}.  It cannot know
2335 where @code{longjmp} will be called; in fact, a signal handler could
2336 call it at any point in the code.  As a result, you may get a warning
2337 even when there is in fact no problem because @code{longjmp} cannot
2338 in fact be called at the place which would cause a problem.
2339
2340 Some spurious warnings can be avoided if you declare all the functions
2341 you use that never return as @code{noreturn}.  @xref{Function
2342 Attributes}.
2343
2344 @item -Wunknown-pragmas
2345 @opindex Wunknown-pragmas
2346 @cindex warning for unknown pragmas
2347 @cindex unknown pragmas, warning
2348 @cindex pragmas, warning of unknown
2349 Warn when a #pragma directive is encountered which is not understood by
2350 GCC@.  If this command line option is used, warnings will even be issued
2351 for unknown pragmas in system header files.  This is not the case if
2352 the warnings were only enabled by the @option{-Wall} command line option.
2353
2354 @item -Wstrict-aliasing
2355 @opindex Wstrict-aliasing
2356 This option is only active when @option{-fstrict-aliasing} is active.
2357 It warns about code which might break the strict aliasing rules that the
2358 compiler is using for optimization. The warning does not catch all
2359 cases, but does attempt to catch the more common pitfalls. It is
2360 included in @option{-Wall}.
2361
2362 @item -Wall
2363 @opindex Wall
2364 All of the above @samp{-W} options combined.  This enables all the
2365 warnings about constructions that some users consider questionable, and
2366 that are easy to avoid (or modify to prevent the warning), even in
2367 conjunction with macros.  This also enables some language-specific
2368 warnings described in @ref{C++ Dialect Options} and
2369 @ref{Objective-C Dialect Options}.
2370 @end table
2371
2372 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2373 Some of them warn about constructions that users generally do not
2374 consider questionable, but which occasionally you might wish to check
2375 for; others warn about constructions that are necessary or hard to avoid
2376 in some cases, and there is no simple way to modify the code to suppress
2377 the warning.
2378
2379 @table @gcctabopt
2380 @item -Wextra
2381 @opindex W
2382 @opindex Wextra
2383 (This option used to be called @option{-W}.  The older name is still
2384 supported, but the newer name is more descriptive.)  Print extra warning
2385 messages for these events:
2386
2387 @itemize @bullet
2388 @item
2389 A function can return either with or without a value.  (Falling
2390 off the end of the function body is considered returning without
2391 a value.)  For example, this function would evoke such a
2392 warning:
2393
2394 @smallexample
2395 @group
2396 foo (a)
2397 @{
2398   if (a > 0)
2399     return a;
2400 @}
2401 @end group
2402 @end smallexample
2403
2404 @item
2405 An expression-statement or the left-hand side of a comma expression
2406 contains no side effects.
2407 To suppress the warning, cast the unused expression to void.
2408 For example, an expression such as @samp{x[i,j]} will cause a warning,
2409 but @samp{x[(void)i,j]} will not.
2410
2411 @item
2412 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2413
2414 @item
2415 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2416 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2417 that of ordinary mathematical notation.
2418
2419 @item
2420 Storage-class specifiers like @code{static} are not the first things in
2421 a declaration.  According to the C Standard, this usage is obsolescent.
2422
2423 @item
2424 The return type of a function has a type qualifier such as @code{const}.
2425 Such a type qualifier has no effect, since the value returned by a
2426 function is not an lvalue.  (But don't warn about the GNU extension of
2427 @code{volatile void} return types.  That extension will be warned about
2428 if @option{-pedantic} is specified.)
2429
2430 @item
2431 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2432 arguments.
2433
2434 @item
2435 A comparison between signed and unsigned values could produce an
2436 incorrect result when the signed value is converted to unsigned.
2437 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2438
2439 @item
2440 An aggregate has an initializer which does not initialize all members.
2441 For example, the following code would cause such a warning, because
2442 @code{x.h} would be implicitly initialized to zero:
2443
2444 @smallexample
2445 struct s @{ int f, g, h; @};
2446 struct s x = @{ 3, 4 @};
2447 @end smallexample
2448
2449 @item
2450 A function parameter is declared without a type specifier in K&R-style
2451 functions:
2452
2453 @smallexample
2454 void foo(bar) @{ @}
2455 @end smallexample
2456
2457 @item
2458 An empty body occurs in an @samp{if} or @samp{else} statement.
2459
2460 @item
2461 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2462 @samp{>}, or @samp{>=}.
2463
2464 @item
2465 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2466
2467 @item
2468 Any of several floating-point events that often indicate errors, such as
2469 overflow, underflow, loss of precision, etc.
2470
2471 @item @r{(C++ only)}
2472 An enumerator and a non-enumerator both appear in a conditional expression.
2473
2474 @item @r{(C++ only)}
2475 A non-static reference or non-static @samp{const} member appears in a
2476 class without constructors.
2477
2478 @item @r{(C++ only)}
2479 Ambiguous virtual bases.
2480
2481 @item @r{(C++ only)}
2482 Subscripting an array which has been declared @samp{register}.
2483
2484 @item @r{(C++ only)}
2485 Taking the address of a variable which has been declared @samp{register}.
2486
2487 @item @r{(C++ only)}
2488 A base class is not initialized in a derived class' copy constructor.
2489 @end itemize
2490
2491 @item -Wno-div-by-zero
2492 @opindex Wno-div-by-zero
2493 @opindex Wdiv-by-zero
2494 Do not warn about compile-time integer division by zero.  Floating point
2495 division by zero is not warned about, as it can be a legitimate way of
2496 obtaining infinities and NaNs.
2497
2498 @item -Wsystem-headers
2499 @opindex Wsystem-headers
2500 @cindex warnings from system headers
2501 @cindex system headers, warnings from
2502 Print warning messages for constructs found in system header files.
2503 Warnings from system headers are normally suppressed, on the assumption
2504 that they usually do not indicate real problems and would only make the
2505 compiler output harder to read.  Using this command line option tells
2506 GCC to emit warnings from system headers as if they occurred in user
2507 code.  However, note that using @option{-Wall} in conjunction with this
2508 option will @emph{not} warn about unknown pragmas in system
2509 headers---for that, @option{-Wunknown-pragmas} must also be used.
2510
2511 @item -Wfloat-equal
2512 @opindex Wfloat-equal
2513 Warn if floating point values are used in equality comparisons.
2514
2515 The idea behind this is that sometimes it is convenient (for the
2516 programmer) to consider floating-point values as approximations to
2517 infinitely precise real numbers.  If you are doing this, then you need
2518 to compute (by analyzing the code, or in some other way) the maximum or
2519 likely maximum error that the computation introduces, and allow for it
2520 when performing comparisons (and when producing output, but that's a
2521 different problem).  In particular, instead of testing for equality, you
2522 would check to see whether the two values have ranges that overlap; and
2523 this is done with the relational operators, so equality comparisons are
2524 probably mistaken.
2525
2526 @item -Wtraditional @r{(C only)}
2527 @opindex Wtraditional
2528 Warn about certain constructs that behave differently in traditional and
2529 ISO C@.  Also warn about ISO C constructs that have no traditional C
2530 equivalent, and/or problematic constructs which should be avoided.
2531
2532 @itemize @bullet
2533 @item
2534 Macro parameters that appear within string literals in the macro body.
2535 In traditional C macro replacement takes place within string literals,
2536 but does not in ISO C@.
2537
2538 @item
2539 In traditional C, some preprocessor directives did not exist.
2540 Traditional preprocessors would only consider a line to be a directive
2541 if the @samp{#} appeared in column 1 on the line.  Therefore
2542 @option{-Wtraditional} warns about directives that traditional C
2543 understands but would ignore because the @samp{#} does not appear as the
2544 first character on the line.  It also suggests you hide directives like
2545 @samp{#pragma} not understood by traditional C by indenting them.  Some
2546 traditional implementations would not recognize @samp{#elif}, so it
2547 suggests avoiding it altogether.
2548
2549 @item
2550 A function-like macro that appears without arguments.
2551
2552 @item
2553 The unary plus operator.
2554
2555 @item
2556 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2557 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2558 constants.)  Note, these suffixes appear in macros defined in the system
2559 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2560 Use of these macros in user code might normally lead to spurious
2561 warnings, however gcc's integrated preprocessor has enough context to
2562 avoid warning in these cases.
2563
2564 @item
2565 A function declared external in one block and then used after the end of
2566 the block.
2567
2568 @item
2569 A @code{switch} statement has an operand of type @code{long}.
2570
2571 @item
2572 A non-@code{static} function declaration follows a @code{static} one.
2573 This construct is not accepted by some traditional C compilers.
2574
2575 @item
2576 The ISO type of an integer constant has a different width or
2577 signedness from its traditional type.  This warning is only issued if
2578 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2579 typically represent bit patterns, are not warned about.
2580
2581 @item
2582 Usage of ISO string concatenation is detected.
2583
2584 @item
2585 Initialization of automatic aggregates.
2586
2587 @item
2588 Identifier conflicts with labels.  Traditional C lacks a separate
2589 namespace for labels.
2590
2591 @item
2592 Initialization of unions.  If the initializer is zero, the warning is
2593 omitted.  This is done under the assumption that the zero initializer in
2594 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2595 initializer warnings and relies on default initialization to zero in the
2596 traditional C case.
2597
2598 @item
2599 Conversions by prototypes between fixed/floating point values and vice
2600 versa.  The absence of these prototypes when compiling with traditional
2601 C would cause serious problems.  This is a subset of the possible
2602 conversion warnings, for the full set use @option{-Wconversion}.
2603
2604 @item
2605 Use of ISO C style function definitions.  This warning intentionally is
2606 @emph{not} issued for prototype declarations or variadic functions
2607 because these ISO C features will appear in your code when using
2608 libiberty's traditional C compatibility macros, @code{PARAMS} and
2609 @code{VPARAMS}.  This warning is also bypassed for nested functions
2610 because that feature is already a gcc extension and thus not relevant to
2611 traditional C compatibility.
2612 @end itemize
2613
2614 @item -Wundef
2615 @opindex Wundef
2616 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2617
2618 @item -Wendif-labels
2619 @opindex Wendif-labels
2620 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2621
2622 @item -Wshadow
2623 @opindex Wshadow
2624 Warn whenever a local variable shadows another local variable, parameter or
2625 global variable or whenever a built-in function is shadowed.
2626
2627 @item -Wlarger-than-@var{len}
2628 @opindex Wlarger-than
2629 Warn whenever an object of larger than @var{len} bytes is defined.
2630
2631 @item -Wpointer-arith
2632 @opindex Wpointer-arith
2633 Warn about anything that depends on the ``size of'' a function type or
2634 of @code{void}.  GNU C assigns these types a size of 1, for
2635 convenience in calculations with @code{void *} pointers and pointers
2636 to functions.
2637
2638 @item -Wbad-function-cast @r{(C only)}
2639 @opindex Wbad-function-cast
2640 Warn whenever a function call is cast to a non-matching type.
2641 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2642
2643 @item -Wcast-qual
2644 @opindex Wcast-qual
2645 Warn whenever a pointer is cast so as to remove a type qualifier from
2646 the target type.  For example, warn if a @code{const char *} is cast
2647 to an ordinary @code{char *}.
2648
2649 @item -Wcast-align
2650 @opindex Wcast-align
2651 Warn whenever a pointer is cast such that the required alignment of the
2652 target is increased.  For example, warn if a @code{char *} is cast to
2653 an @code{int *} on machines where integers can only be accessed at
2654 two- or four-byte boundaries.
2655
2656 @item -Wwrite-strings
2657 @opindex Wwrite-strings
2658 When compiling C, give string constants the type @code{const
2659 char[@var{length}]} so that
2660 copying the address of one into a non-@code{const} @code{char *}
2661 pointer will get a warning; when compiling C++, warn about the
2662 deprecated conversion from string constants to @code{char *}.
2663 These warnings will help you find at
2664 compile time code that can try to write into a string constant, but
2665 only if you have been very careful about using @code{const} in
2666 declarations and prototypes.  Otherwise, it will just be a nuisance;
2667 this is why we did not make @option{-Wall} request these warnings.
2668
2669 @item -Wconversion
2670 @opindex Wconversion
2671 Warn if a prototype causes a type conversion that is different from what
2672 would happen to the same argument in the absence of a prototype.  This
2673 includes conversions of fixed point to floating and vice versa, and
2674 conversions changing the width or signedness of a fixed point argument
2675 except when the same as the default promotion.
2676
2677 Also, warn if a negative integer constant expression is implicitly
2678 converted to an unsigned type.  For example, warn about the assignment
2679 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2680 casts like @code{(unsigned) -1}.
2681
2682 @item -Wsign-compare
2683 @opindex Wsign-compare
2684 @cindex warning for comparison of signed and unsigned values
2685 @cindex comparison of signed and unsigned values, warning
2686 @cindex signed and unsigned values, comparison warning
2687 Warn when a comparison between signed and unsigned values could produce
2688 an incorrect result when the signed value is converted to unsigned.
2689 This warning is also enabled by @option{-Wextra}; to get the other warnings
2690 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2691
2692 @item -Waggregate-return
2693 @opindex Waggregate-return
2694 Warn if any functions that return structures or unions are defined or
2695 called.  (In languages where you can return an array, this also elicits
2696 a warning.)
2697
2698 @item -Wstrict-prototypes @r{(C only)}
2699 @opindex Wstrict-prototypes
2700 Warn if a function is declared or defined without specifying the
2701 argument types.  (An old-style function definition is permitted without
2702 a warning if preceded by a declaration which specifies the argument
2703 types.)
2704
2705 @item -Wmissing-prototypes @r{(C only)}
2706 @opindex Wmissing-prototypes
2707 Warn if a global function is defined without a previous prototype
2708 declaration.  This warning is issued even if the definition itself
2709 provides a prototype.  The aim is to detect global functions that fail
2710 to be declared in header files.
2711
2712 @item -Wmissing-declarations
2713 @opindex Wmissing-declarations
2714 Warn if a global function is defined without a previous declaration.
2715 Do so even if the definition itself provides a prototype.
2716 Use this option to detect global functions that are not declared in
2717 header files.
2718
2719 @item -Wmissing-noreturn
2720 @opindex Wmissing-noreturn
2721 Warn about functions which might be candidates for attribute @code{noreturn}.
2722 Note these are only possible candidates, not absolute ones.  Care should
2723 be taken to manually verify functions actually do not ever return before
2724 adding the @code{noreturn} attribute, otherwise subtle code generation
2725 bugs could be introduced.  You will not get a warning for @code{main} in
2726 hosted C environments.
2727
2728 @item -Wmissing-format-attribute
2729 @opindex Wmissing-format-attribute
2730 @opindex Wformat
2731 If @option{-Wformat} is enabled, also warn about functions which might be
2732 candidates for @code{format} attributes.  Note these are only possible
2733 candidates, not absolute ones.  GCC will guess that @code{format}
2734 attributes might be appropriate for any function that calls a function
2735 like @code{vprintf} or @code{vscanf}, but this might not always be the
2736 case, and some functions for which @code{format} attributes are
2737 appropriate may not be detected.  This option has no effect unless
2738 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2739
2740 @item -Wno-multichar
2741 @opindex Wno-multichar
2742 @opindex Wmultichar
2743 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2744 Usually they indicate a typo in the user's code, as they have
2745 implementation-defined values, and should not be used in portable code.
2746
2747 @item -Wno-deprecated-declarations
2748 @opindex Wno-deprecated-declarations
2749 Do not warn about uses of functions, variables, and types marked as
2750 deprecated by using the @code{deprecated} attribute.
2751 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2752 @pxref{Type Attributes}.)
2753
2754 @item -Wpacked
2755 @opindex Wpacked
2756 Warn if a structure is given the packed attribute, but the packed
2757 attribute has no effect on the layout or size of the structure.
2758 Such structures may be mis-aligned for little benefit.  For
2759 instance, in this code, the variable @code{f.x} in @code{struct bar}
2760 will be misaligned even though @code{struct bar} does not itself
2761 have the packed attribute:
2762
2763 @smallexample
2764 @group
2765 struct foo @{
2766   int x;
2767   char a, b, c, d;
2768 @} __attribute__((packed));
2769 struct bar @{
2770   char z;
2771   struct foo f;
2772 @};
2773 @end group
2774 @end smallexample
2775
2776 @item -Wpadded
2777 @opindex Wpadded
2778 Warn if padding is included in a structure, either to align an element
2779 of the structure or to align the whole structure.  Sometimes when this
2780 happens it is possible to rearrange the fields of the structure to
2781 reduce the padding and so make the structure smaller.
2782
2783 @item -Wredundant-decls
2784 @opindex Wredundant-decls
2785 Warn if anything is declared more than once in the same scope, even in
2786 cases where multiple declaration is valid and changes nothing.
2787
2788 @item -Wnested-externs @r{(C only)}
2789 @opindex Wnested-externs
2790 Warn if an @code{extern} declaration is encountered within a function.
2791
2792 @item -Wunreachable-code
2793 @opindex Wunreachable-code
2794 Warn if the compiler detects that code will never be executed.
2795
2796 This option is intended to warn when the compiler detects that at
2797 least a whole line of source code will never be executed, because
2798 some condition is never satisfied or because it is after a
2799 procedure that never returns.
2800
2801 It is possible for this option to produce a warning even though there
2802 are circumstances under which part of the affected line can be executed,
2803 so care should be taken when removing apparently-unreachable code.
2804
2805 For instance, when a function is inlined, a warning may mean that the
2806 line is unreachable in only one inlined copy of the function.
2807
2808 This option is not made part of @option{-Wall} because in a debugging
2809 version of a program there is often substantial code which checks
2810 correct functioning of the program and is, hopefully, unreachable
2811 because the program does work.  Another common use of unreachable
2812 code is to provide behavior which is selectable at compile-time.
2813
2814 @item -Winline
2815 @opindex Winline
2816 Warn if a function can not be inlined and it was declared as inline.
2817
2818 @item -Winvalid-pch
2819 @opindex Winvalid-pch
2820 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2821 the search path but can't be used.
2822
2823 @item -Wlong-long
2824 @opindex Wlong-long
2825 @opindex Wno-long-long
2826 Warn if @samp{long long} type is used.  This is default.  To inhibit
2827 the warning messages, use @option{-Wno-long-long}.  Flags
2828 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2829 only when @option{-pedantic} flag is used.
2830
2831 @item -Wdisabled-optimization
2832 @opindex Wdisabled-optimization
2833 Warn if a requested optimization pass is disabled.  This warning does
2834 not generally indicate that there is anything wrong with your code; it
2835 merely indicates that GCC's optimizers were unable to handle the code
2836 effectively.  Often, the problem is that your code is too big or too
2837 complex; GCC will refuse to optimize programs when the optimization
2838 itself is likely to take inordinate amounts of time.
2839
2840 @item -Werror
2841 @opindex Werror
2842 Make all warnings into errors.
2843 @end table
2844
2845 @node Debugging Options
2846 @section Options for Debugging Your Program or GCC
2847 @cindex options, debugging
2848 @cindex debugging information options
2849
2850 GCC has various special options that are used for debugging
2851 either your program or GCC:
2852
2853 @table @gcctabopt
2854 @item -g
2855 @opindex g
2856 Produce debugging information in the operating system's native format
2857 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2858 information.
2859
2860 On most systems that use stabs format, @option{-g} enables use of extra
2861 debugging information that only GDB can use; this extra information
2862 makes debugging work better in GDB but will probably make other debuggers
2863 crash or
2864 refuse to read the program.  If you want to control for certain whether
2865 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2866 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2867 or @option{-gvms} (see below).
2868
2869 Unlike most other C compilers, GCC allows you to use @option{-g} with
2870 @option{-O}.  The shortcuts taken by optimized code may occasionally
2871 produce surprising results: some variables you declared may not exist
2872 at all; flow of control may briefly move where you did not expect it;
2873 some statements may not be executed because they compute constant
2874 results or their values were already at hand; some statements may
2875 execute in different places because they were moved out of loops.
2876
2877 Nevertheless it proves possible to debug optimized output.  This makes
2878 it reasonable to use the optimizer for programs that might have bugs.
2879
2880 The following options are useful when GCC is generated with the
2881 capability for more than one debugging format.
2882
2883 @item -ggdb
2884 @opindex ggdb
2885 Produce debugging information for use by GDB@.  This means to use the
2886 most expressive format available (DWARF 2, stabs, or the native format
2887 if neither of those are supported), including GDB extensions if at all
2888 possible.
2889
2890 @item -gstabs
2891 @opindex gstabs
2892 Produce debugging information in stabs format (if that is supported),
2893 without GDB extensions.  This is the format used by DBX on most BSD
2894 systems.  On MIPS, Alpha and System V Release 4 systems this option
2895 produces stabs debugging output which is not understood by DBX or SDB@.
2896 On System V Release 4 systems this option requires the GNU assembler.
2897
2898 @item -gstabs+
2899 @opindex gstabs+
2900 Produce debugging information in stabs format (if that is supported),
2901 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2902 use of these extensions is likely to make other debuggers crash or
2903 refuse to read the program.
2904
2905 @item -gcoff
2906 @opindex gcoff
2907 Produce debugging information in COFF format (if that is supported).
2908 This is the format used by SDB on most System V systems prior to
2909 System V Release 4.
2910
2911 @item -gxcoff
2912 @opindex gxcoff
2913 Produce debugging information in XCOFF format (if that is supported).
2914 This is the format used by the DBX debugger on IBM RS/6000 systems.
2915
2916 @item -gxcoff+
2917 @opindex gxcoff+
2918 Produce debugging information in XCOFF format (if that is supported),
2919 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2920 use of these extensions is likely to make other debuggers crash or
2921 refuse to read the program, and may cause assemblers other than the GNU
2922 assembler (GAS) to fail with an error.
2923
2924 @item -gdwarf
2925 @opindex gdwarf
2926 Produce debugging information in DWARF version 1 format (if that is
2927 supported).  This is the format used by SDB on most System V Release 4
2928 systems.
2929
2930 This option is deprecated.
2931
2932 @item -gdwarf+
2933 @opindex gdwarf+
2934 Produce debugging information in DWARF version 1 format (if that is
2935 supported), using GNU extensions understood only by the GNU debugger
2936 (GDB)@.  The use of these extensions is likely to make other debuggers
2937 crash or refuse to read the program.
2938
2939 This option is deprecated.
2940
2941 @item -gdwarf-2
2942 @opindex gdwarf-2
2943 Produce debugging information in DWARF version 2 format (if that is
2944 supported).  This is the format used by DBX on IRIX 6.
2945
2946 @item -gvms
2947 @opindex gvms
2948 Produce debugging information in VMS debug format (if that is
2949 supported).  This is the format used by DEBUG on VMS systems.
2950
2951 @item -g@var{level}
2952 @itemx -ggdb@var{level}
2953 @itemx -gstabs@var{level}
2954 @itemx -gcoff@var{level}
2955 @itemx -gxcoff@var{level}
2956 @itemx -gvms@var{level}
2957 Request debugging information and also use @var{level} to specify how
2958 much information.  The default level is 2.
2959
2960 Level 1 produces minimal information, enough for making backtraces in
2961 parts of the program that you don't plan to debug.  This includes
2962 descriptions of functions and external variables, but no information
2963 about local variables and no line numbers.
2964
2965 Level 3 includes extra information, such as all the macro definitions
2966 present in the program.  Some debuggers support macro expansion when
2967 you use @option{-g3}.
2968
2969 Note that in order to avoid confusion between DWARF1 debug level 2,
2970 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2971 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2972 option to change the debug level for DWARF1 or DWARF2.
2973
2974 @item -feliminate-dwarf2-dups
2975 @opindex feliminate-dwarf2-dups
2976 Compress DWARF2 debugging information by eliminating duplicated
2977 information about each symbol.  This option only makes sense when
2978 generating DWARF2 debugging information with @option{-gdwarf-2}.
2979
2980 @cindex @command{prof}
2981 @item -p
2982 @opindex p
2983 Generate extra code to write profile information suitable for the
2984 analysis program @command{prof}.  You must use this option when compiling
2985 the source files you want data about, and you must also use it when
2986 linking.
2987
2988 @cindex @command{gprof}
2989 @item -pg
2990 @opindex pg
2991 Generate extra code to write profile information suitable for the
2992 analysis program @command{gprof}.  You must use this option when compiling
2993 the source files you want data about, and you must also use it when
2994 linking.
2995
2996 @item -Q
2997 @opindex Q
2998 Makes the compiler print out each function name as it is compiled, and
2999 print some statistics about each pass when it finishes.
3000
3001 @item -ftime-report
3002 @opindex ftime-report
3003 Makes the compiler print some statistics about the time consumed by each
3004 pass when it finishes.
3005
3006 @item -fmem-report
3007 @opindex fmem-report
3008 Makes the compiler print some statistics about permanent memory
3009 allocation when it finishes.
3010
3011 @item -fprofile-arcs
3012 @opindex fprofile-arcs
3013 Add code so that program flow @dfn{arcs} are instrumented.  During
3014 execution the program records how many times each branch and call is
3015 executed and how many times it is taken or returns.  When the compiled
3016 program exits it saves this data to a file called
3017 @file{@var{auxname}.da} for each source file. The data may be used for
3018 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3019 test coverage analysis (@option{-ftest-coverage}). Each object file's
3020 @var{auxname} is generated from the name of the output file, if
3021 explicitly specified and it is not the final executable, otherwise it is
3022 the basename of the source file. In both cases any suffix is removed
3023 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3024 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3025
3026 @itemize
3027
3028 @item
3029 Compile the source files with @option{-fprofile-arcs} plus optimization
3030 and code generation options. For test coverage analysis, use the
3031 additional @option{-ftest-coverage} option. You do not need to profile
3032 every source file in a program.
3033
3034 @item
3035 Link your object files as normal.
3036
3037 @item
3038 Run the program on a representative workload to generate the arc profile
3039 information. This may be repeated any number of times.
3040
3041 @item
3042 For profile-directed optimizations, compile the source files again with
3043 the same optimization and code generation options plus
3044 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3045 Control Optimization}).
3046
3047 @item
3048 For test coverage analysis, use @command{gcov} to produce human readable
3049 information from the @file{.bbg} and @file{.da} files. Refer to the
3050 @command{gcov} documentation for further information.
3051
3052 @end itemize
3053
3054 With @option{-fprofile-arcs}, for each function of your program GCC
3055 creates a program flow graph, then finds a spanning tree for the graph.
3056 Only arcs that are not on the spanning tree have to be instrumented: the
3057 compiler adds code to count the number of times that these arcs are
3058 executed.  When an arc is the only exit or only entrance to a block, the
3059 instrumentation code can be added to the block; otherwise, a new basic
3060 block must be created to hold the instrumentation code.
3061
3062 @need 2000
3063 @item -ftest-coverage
3064 @opindex ftest-coverage
3065 Produce a graph file that the @command{gcov} code-coverage utility
3066 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3067 show program coverage. Each source file's data file is called
3068 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3069 above for a description of @var{auxname} and instructions on how to
3070 generate test coverage data. Coverage data will match the source files
3071 more closely, if you do not optimize.
3072
3073 @item -d@var{letters}
3074 @opindex d
3075 Says to make debugging dumps during compilation at times specified by
3076 @var{letters}.  This is used for debugging the compiler.  The file names
3077 for most of the dumps are made by appending a pass number and a word to
3078 the @var{dumpname}. @var{dumpname} is generated from the name of the
3079 output file, if explicitly specified and it is not an executable,
3080 otherwise it is the basename of the source file. In both cases any
3081 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3082 Here are the possible letters for use in @var{letters}, and their
3083 meanings:
3084
3085 @table @samp
3086 @item A
3087 @opindex dA
3088 Annotate the assembler output with miscellaneous debugging information.
3089 @item b
3090 @opindex db
3091 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3092 @item B
3093 @opindex dB
3094 Dump after block reordering, to @file{@var{file}.32.bbro}.
3095 @item c
3096 @opindex dc
3097 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3098 @item C
3099 @opindex dC
3100 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3101 @item d
3102 @opindex dd
3103 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3104 @item D
3105 @opindex dD
3106 Dump all macro definitions, at the end of preprocessing, in addition to
3107 normal output.
3108 @item e
3109 @opindex de
3110 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3111 @file{@var{file}.07.ussa}.
3112 @item E
3113 @opindex dE
3114 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3115 @item f
3116 @opindex df
3117 Dump after life analysis, to @file{@var{file}.18.life}.
3118 @item F
3119 @opindex dF
3120 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3121 @item g
3122 @opindex dg
3123 Dump after global register allocation, to @file{@var{file}.24.greg}.
3124 @item h
3125 @opindex dh
3126 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3127 @item k
3128 @opindex dk
3129 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3130 @item o
3131 @opindex do
3132 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3133 @item G
3134 @opindex dG
3135 Dump after GCSE, to @file{@var{file}.11.gcse}.
3136 @item i
3137 @opindex di
3138 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3139 @item j
3140 @opindex dj
3141 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3142 @item k
3143 @opindex dk
3144 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3145 @item l
3146 @opindex dl
3147 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3148 @item L
3149 @opindex dL
3150 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3151 @file{@var{file}.18.loop2}.
3152 @item M
3153 @opindex dM
3154 Dump after performing the machine dependent reorganization pass, to
3155 @file{@var{file}.33.mach}.
3156 @item n
3157 @opindex dn
3158 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3159 @item N
3160 @opindex dN
3161 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3162 @item r
3163 @opindex dr
3164 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3165 @item R
3166 @opindex dR
3167 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3168 @item s
3169 @opindex ds
3170 Dump after CSE (including the jump optimization that sometimes follows
3171 CSE), to @file{@var{file}.09.cse}.
3172 @item S
3173 @opindex dS
3174 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3175 @item t
3176 @opindex dt
3177 Dump after the second CSE pass (including the jump optimization that
3178 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3179 @item u
3180 @opindex du
3181 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3182 @item w
3183 @opindex dw
3184 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3185 @item X
3186 @opindex dX
3187 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3188 @item z
3189 @opindex dz
3190 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3191 @item a
3192 @opindex da
3193 Produce all the dumps listed above.
3194 @item H
3195 @opindex dH
3196 Produce a core dump whenever an error occurs.
3197 @item m
3198 @opindex dm
3199 Print statistics on memory usage, at the end of the run, to
3200 standard error.
3201 @item p
3202 @opindex dp
3203 Annotate the assembler output with a comment indicating which
3204 pattern and alternative was used.  The length of each instruction is
3205 also printed.
3206 @item P
3207 @opindex dP
3208 Dump the RTL in the assembler output as a comment before each instruction.
3209 Also turns on @option{-dp} annotation.
3210 @item v
3211 @opindex dv
3212 For each of the other indicated dump files (except for
3213 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3214 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3215 @item x
3216 @opindex dx
3217 Just generate RTL for a function instead of compiling it.  Usually used
3218 with @samp{r}.
3219 @item y
3220 @opindex dy
3221 Dump debugging information during parsing, to standard error.
3222 @end table
3223
3224 @item -fdump-unnumbered
3225 @opindex fdump-unnumbered
3226 When doing debugging dumps (see @option{-d} option above), suppress instruction
3227 numbers and line number note output.  This makes it more feasible to
3228 use diff on debugging dumps for compiler invocations with different
3229 options, in particular with and without @option{-g}.
3230
3231 @item -fdump-translation-unit @r{(C and C++ only)}
3232 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3233 @opindex fdump-translation-unit
3234 Dump a representation of the tree structure for the entire translation
3235 unit to a file.  The file name is made by appending @file{.tu} to the
3236 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3237 controls the details of the dump as described for the
3238 @option{-fdump-tree} options.
3239
3240 @item -fdump-class-hierarchy @r{(C++ only)}
3241 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3242 @opindex fdump-class-hierarchy
3243 Dump a representation of each class's hierarchy and virtual function
3244 table layout to a file.  The file name is made by appending @file{.class}
3245 to the source file name.  If the @samp{-@var{options}} form is used,
3246 @var{options} controls the details of the dump as described for the
3247 @option{-fdump-tree} options.
3248
3249 @item -fdump-tree-@var{switch} @r{(C++ only)}
3250 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3251 @opindex fdump-tree
3252 Control the dumping at various stages of processing the intermediate
3253 language tree to a file.  The file name is generated by appending a switch
3254 specific suffix to the source file name.  If the @samp{-@var{options}}
3255 form is used, @var{options} is a list of @samp{-} separated options that
3256 control the details of the dump. Not all options are applicable to all
3257 dumps, those which are not meaningful will be ignored. The following
3258 options are available
3259
3260 @table @samp
3261 @item address
3262 Print the address of each node.  Usually this is not meaningful as it
3263 changes according to the environment and source file. Its primary use
3264 is for tying up a dump file with a debug environment.
3265 @item slim
3266 Inhibit dumping of members of a scope or body of a function merely
3267 because that scope has been reached. Only dump such items when they
3268 are directly reachable by some other path.
3269 @item all
3270 Turn on all options.
3271 @end table
3272
3273 The following tree dumps are possible:
3274 @table @samp
3275 @item original
3276 Dump before any tree based optimization, to @file{@var{file}.original}.
3277 @item optimized
3278 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3279 @item inlined
3280 Dump after function inlining, to @file{@var{file}.inlined}.
3281 @end table
3282
3283 @item -frandom-seed=@var{string}
3284 @opindex frandom-string
3285 This option provides a seed that GCC uses when it would otherwise use
3286 random numbers.  At present, this is used to generate certain symbol names
3287 that have to be different in every compiled file.
3288
3289 The @var{string} should be different for every file you compile.
3290
3291 @item -fsched-verbose=@var{n}
3292 @opindex fsched-verbose
3293 On targets that use instruction scheduling, this option controls the
3294 amount of debugging output the scheduler prints.  This information is
3295 written to standard error, unless @option{-dS} or @option{-dR} is
3296 specified, in which case it is output to the usual dump
3297 listing file, @file{.sched} or @file{.sched2} respectively.  However
3298 for @var{n} greater than nine, the output is always printed to standard
3299 error.
3300
3301 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3302 same information as @option{-dRS}.  For @var{n} greater than one, it
3303 also output basic block probabilities, detailed ready list information
3304 and unit/insn info.  For @var{n} greater than two, it includes RTL
3305 at abort point, control-flow and regions info.  And for @var{n} over
3306 four, @option{-fsched-verbose} also includes dependence info.
3307
3308 @item -save-temps
3309 @opindex save-temps
3310 Store the usual ``temporary'' intermediate files permanently; place them
3311 in the current directory and name them based on the source file.  Thus,
3312 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3313 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3314 preprocessed @file{foo.i} output file even though the compiler now
3315 normally uses an integrated preprocessor.
3316
3317 @item -time
3318 @opindex time
3319 Report the CPU time taken by each subprocess in the compilation
3320 sequence.  For C source files, this is the compiler proper and assembler
3321 (plus the linker if linking is done).  The output looks like this:
3322
3323 @smallexample
3324 # cc1 0.12 0.01
3325 # as 0.00 0.01
3326 @end smallexample
3327
3328 The first number on each line is the ``user time,'' that is time spent
3329 executing the program itself.  The second number is ``system time,''
3330 time spent executing operating system routines on behalf of the program.
3331 Both numbers are in seconds.
3332
3333 @item -print-file-name=@var{library}
3334 @opindex print-file-name
3335 Print the full absolute name of the library file @var{library} that
3336 would be used when linking---and don't do anything else.  With this
3337 option, GCC does not compile or link anything; it just prints the
3338 file name.
3339
3340 @item -print-multi-directory
3341 @opindex print-multi-directory
3342 Print the directory name corresponding to the multilib selected by any
3343 other switches present in the command line.  This directory is supposed
3344 to exist in @env{GCC_EXEC_PREFIX}.
3345
3346 @item -print-multi-lib
3347 @opindex print-multi-lib
3348 Print the mapping from multilib directory names to compiler switches
3349 that enable them.  The directory name is separated from the switches by
3350 @samp{;}, and each switch starts with an @samp{@@} instead of the
3351 @samp{-}, without spaces between multiple switches.  This is supposed to
3352 ease shell-processing.
3353
3354 @item -print-prog-name=@var{program}
3355 @opindex print-prog-name
3356 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3357
3358 @item -print-libgcc-file-name
3359 @opindex print-libgcc-file-name
3360 Same as @option{-print-file-name=libgcc.a}.
3361
3362 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3363 but you do want to link with @file{libgcc.a}.  You can do
3364
3365 @example
3366 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3367 @end example
3368
3369 @item -print-search-dirs
3370 @opindex print-search-dirs
3371 Print the name of the configured installation directory and a list of
3372 program and library directories gcc will search---and don't do anything else.
3373
3374 This is useful when gcc prints the error message
3375 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3376 To resolve this you either need to put @file{cpp0} and the other compiler
3377 components where gcc expects to find them, or you can set the environment
3378 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3379 Don't forget the trailing '/'.
3380 @xref{Environment Variables}.
3381
3382 @item -dumpmachine
3383 @opindex dumpmachine
3384 Print the compiler's target machine (for example,
3385 @samp{i686-pc-linux-gnu})---and don't do anything else.
3386
3387 @item -dumpversion
3388 @opindex dumpversion
3389 Print the compiler version (for example, @samp{3.0})---and don't do
3390 anything else.
3391
3392 @item -dumpspecs
3393 @opindex dumpspecs
3394 Print the compiler's built-in specs---and don't do anything else.  (This
3395 is used when GCC itself is being built.)  @xref{Spec Files}.
3396
3397 @item -feliminate-unused-debug-types
3398 @opindex feliminate-unused-debug-types
3399 Normally, when producing DWARF2 output, GCC will emit debugging
3400 information for all types declared in a compilation
3401 unit, regardless of whether or not they are actually used
3402 in that compilation unit.  Sometimes this is useful, such as
3403 if, in the debugger, you want to cast a value to a type that is
3404 not actually used in your program (but is declared).  More often,
3405 however, this results in a significant amount of wasted space.
3406 With this option, GCC will avoid producing debug symbol output
3407 for types that are nowhere used in the source file being compiled.
3408 @end table
3409
3410 @node Optimize Options
3411 @section Options That Control Optimization
3412 @cindex optimize options
3413 @cindex options, optimization
3414
3415 These options control various sorts of optimizations.
3416
3417 Without any optimization option, the compiler's goal is to reduce the
3418 cost of compilation and to make debugging produce the expected
3419 results.  Statements are independent: if you stop the program with a
3420 breakpoint between statements, you can then assign a new value to any
3421 variable or change the program counter to any other statement in the
3422 function and get exactly the results you would expect from the source
3423 code.
3424
3425 Turning on optimization flags makes the compiler attempt to improve
3426 the performance and/or code size at the expense of compilation time
3427 and possibly the ability to debug the program.
3428
3429 Not all optimizations are controlled directly by a flag.  Only
3430 optimizations that have a flag are listed.
3431
3432 @table @gcctabopt
3433 @item -O
3434 @itemx -O1
3435 @opindex O
3436 @opindex O1
3437 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3438 more memory for a large function.
3439
3440 With @option{-O}, the compiler tries to reduce code size and execution
3441 time, without performing any optimizations that take a great deal of
3442 compilation time.
3443
3444 @option{-O} turns on the following optimization flags: 
3445 @gccoptlist{-fdefer-pop @gol
3446 -fmerge-constants @gol
3447 -fthread-jumps @gol
3448 -floop-optimize @gol
3449 -fcrossjumping @gol
3450 -fif-conversion @gol
3451 -fif-conversion2 @gol
3452 -fdelayed-branch @gol
3453 -fguess-branch-probability @gol
3454 -fcprop-registers}
3455
3456 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3457 where doing so does not interfere with debugging.
3458
3459 @item -O2
3460 @opindex O2
3461 Optimize even more.  GCC performs nearly all supported optimizations
3462 that do not involve a space-speed tradeoff.  The compiler does not
3463 perform loop unrolling or function inlining when you specify @option{-O2}.
3464 As compared to @option{-O}, this option increases both compilation time
3465 and the performance of the generated code.
3466
3467 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3468 also turns on the following optimization flags:
3469 @gccoptlist{-fforce-mem @gol
3470 -foptimize-sibling-calls @gol
3471 -fstrength-reduce @gol
3472 -fcse-follow-jumps  -fcse-skip-blocks @gol
3473 -frerun-cse-after-loop  -frerun-loop-opt @gol
3474 -fgcse   -fgcse-lm   -fgcse-sm @gol
3475 -fdelete-null-pointer-checks @gol
3476 -fexpensive-optimizations @gol
3477 -fregmove @gol
3478 -fschedule-insns  -fschedule-insns2 @gol
3479 -fsched-interblock  -fsched-spec @gol
3480 -fcaller-saves @gol
3481 -fpeephole2 @gol
3482 -freorder-blocks  -freorder-functions @gol
3483 -fstrict-aliasing @gol
3484 -falign-functions  -falign-jumps @gol
3485 -falign-loops  -falign-labels}
3486
3487 Please note the warning under @option{-fgcse} about
3488 invoking @option{-O2} on programs that use computed gotos.
3489
3490 @item -O3
3491 @opindex O3
3492 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3493 @option{-O2} and also turns on the @option{-finline-functions},
3494 @option{-funit-at-a-time} and @option{-frename-registers} options.
3495
3496 @item -O0
3497 @opindex O0
3498 Do not optimize.  This is the default.
3499
3500 @item -Os
3501 @opindex Os
3502 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3503 do not typically increase code size.  It also performs further
3504 optimizations designed to reduce code size.
3505
3506 @option{-Os} disables the following optimization flags:
3507 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3508 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3509
3510 If you use multiple @option{-O} options, with or without level numbers,
3511 the last such option is the one that is effective.
3512 @end table
3513
3514 Options of the form @option{-f@var{flag}} specify machine-independent
3515 flags.  Most flags have both positive and negative forms; the negative
3516 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3517 below, only one of the forms is listed---the one you typically will
3518 use.  You can figure out the other form by either removing @samp{no-}
3519 or adding it.
3520
3521 The following options control specific optimizations.  They are either
3522 activated by @option{-O} options or are related to ones that are.  You
3523 can use the following flags in the rare cases when ``fine-tuning'' of
3524 optimizations to be performed is desired.
3525
3526 @table @gcctabopt
3527 @item -fno-default-inline
3528 @opindex fno-default-inline
3529 Do not make member functions inline by default merely because they are
3530 defined inside the class scope (C++ only).  Otherwise, when you specify
3531 @w{@option{-O}}, member functions defined inside class scope are compiled
3532 inline by default; i.e., you don't need to add @samp{inline} in front of
3533 the member function name.
3534
3535 @item -fno-defer-pop
3536 @opindex fno-defer-pop
3537 Always pop the arguments to each function call as soon as that function
3538 returns.  For machines which must pop arguments after a function call,
3539 the compiler normally lets arguments accumulate on the stack for several
3540 function calls and pops them all at once.
3541
3542 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3543
3544 @item -fforce-mem
3545 @opindex fforce-mem
3546 Force memory operands to be copied into registers before doing
3547 arithmetic on them.  This produces better code by making all memory
3548 references potential common subexpressions.  When they are not common
3549 subexpressions, instruction combination should eliminate the separate
3550 register-load.
3551
3552 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3553
3554 @item -fforce-addr
3555 @opindex fforce-addr
3556 Force memory address constants to be copied into registers before
3557 doing arithmetic on them.  This may produce better code just as
3558 @option{-fforce-mem} may.
3559
3560 @item -fomit-frame-pointer
3561 @opindex fomit-frame-pointer
3562 Don't keep the frame pointer in a register for functions that
3563 don't need one.  This avoids the instructions to save, set up and
3564 restore frame pointers; it also makes an extra register available
3565 in many functions.  @strong{It also makes debugging impossible on
3566 some machines.}
3567
3568 On some machines, such as the VAX, this flag has no effect, because
3569 the standard calling sequence automatically handles the frame pointer
3570 and nothing is saved by pretending it doesn't exist.  The
3571 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3572 whether a target machine supports this flag.  @xref{Registers,,Register
3573 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3574
3575 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3576
3577 @item -foptimize-sibling-calls
3578 @opindex foptimize-sibling-calls
3579 Optimize sibling and tail recursive calls.
3580
3581 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3582
3583 @item -fno-inline
3584 @opindex fno-inline
3585 Don't pay attention to the @code{inline} keyword.  Normally this option
3586 is used to keep the compiler from expanding any functions inline.
3587 Note that if you are not optimizing, no functions can be expanded inline.
3588
3589 @item -finline-functions
3590 @opindex finline-functions
3591 Integrate all simple functions into their callers.  The compiler
3592 heuristically decides which functions are simple enough to be worth
3593 integrating in this way.
3594
3595 If all calls to a given function are integrated, and the function is
3596 declared @code{static}, then the function is normally not output as
3597 assembler code in its own right.
3598
3599 Enabled at level @option{-O3}.
3600
3601 @item -finline-limit=@var{n}
3602 @opindex finline-limit
3603 By default, gcc limits the size of functions that can be inlined.  This flag
3604 allows the control of this limit for functions that are explicitly marked as
3605 inline (i.e., marked with the inline keyword or defined within the class
3606 definition in c++).  @var{n} is the size of functions that can be inlined in
3607 number of pseudo instructions (not counting parameter handling).  The default
3608 value of @var{n} is 600.
3609 Increasing this value can result in more inlined code at
3610 the cost of compilation time and memory consumption.  Decreasing usually makes
3611 the compilation faster and less code will be inlined (which presumably
3612 means slower programs).  This option is particularly useful for programs that
3613 use inlining heavily such as those based on recursive templates with C++.
3614
3615 Inlining is actually controlled by a number of parameters, which may be
3616 specified individually by using @option{--param @var{name}=@var{value}}.
3617 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3618 as follows:
3619
3620 @table @gcctabopt
3621  @item max-inline-insns
3622   is set to @var{n}.
3623  @item max-inline-insns-single
3624   is set to @var{n}/2.
3625  @item max-inline-insns-auto
3626   is set to @var{n}/2.
3627  @item min-inline-insns
3628   is set to 130 or @var{n}/4, whichever is smaller.
3629  @item max-inline-insns-rtl
3630   is set to @var{n}.
3631 @end table
3632
3633 Using @option{-finline-limit=600} thus results in the default settings
3634 for these parameters.  See below for a documentation of the individual
3635 parameters controlling inlining.
3636
3637 @emph{Note:} pseudo instruction represents, in this particular context, an
3638 abstract measurement of function's size.  In no way, it represents a count
3639 of assembly instructions and as such its exact meaning might change from one
3640 release to an another.
3641
3642 @item -fkeep-inline-functions
3643 @opindex fkeep-inline-functions
3644 Even if all calls to a given function are integrated, and the function
3645 is declared @code{static}, nevertheless output a separate run-time
3646 callable version of the function.  This switch does not affect
3647 @code{extern inline} functions.
3648
3649 @item -fkeep-static-consts
3650 @opindex fkeep-static-consts
3651 Emit variables declared @code{static const} when optimization isn't turned
3652 on, even if the variables aren't referenced.
3653
3654 GCC enables this option by default.  If you want to force the compiler to
3655 check if the variable was referenced, regardless of whether or not
3656 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3657
3658 @item -fmerge-constants
3659 Attempt to merge identical constants (string constants and floating point
3660 constants) across compilation units.
3661
3662 This option is the default for optimized compilation if the assembler and
3663 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3664 behavior.
3665
3666 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3667
3668 @item -fmerge-all-constants
3669 Attempt to merge identical constants and identical variables.
3670
3671 This option implies @option{-fmerge-constants}.  In addition to
3672 @option{-fmerge-constants} this considers e.g. even constant initialized
3673 arrays or initialized constant variables with integral or floating point
3674 types.  Languages like C or C++ require each non-automatic variable to
3675 have distinct location, so using this option will result in non-conforming
3676 behavior.
3677
3678 @item -fnew-ra
3679 @opindex fnew-ra
3680 Use a graph coloring register allocator.  Currently this option is meant
3681 for testing, so we are interested to hear about miscompilations with
3682 @option{-fnew-ra}.
3683
3684 @item -fno-branch-count-reg
3685 @opindex fno-branch-count-reg
3686 Do not use ``decrement and branch'' instructions on a count register,
3687 but instead generate a sequence of instructions that decrement a
3688 register, compare it against zero, then branch based upon the result.
3689 This option is only meaningful on architectures that support such
3690 instructions, which include x86, PowerPC, IA-64 and S/390.
3691
3692 The default is @option{-fbranch-count-reg}, enabled when
3693 @option{-fstrength-reduce} is enabled.
3694
3695 @item -fno-function-cse
3696 @opindex fno-function-cse
3697 Do not put function addresses in registers; make each instruction that
3698 calls a constant function contain the function's address explicitly.
3699
3700 This option results in less efficient code, but some strange hacks
3701 that alter the assembler output may be confused by the optimizations
3702 performed when this option is not used.
3703
3704 The default is @option{-ffunction-cse}
3705
3706 @item -fno-zero-initialized-in-bss
3707 @opindex fno-zero-initialized-in-bss
3708 If the target supports a BSS section, GCC by default puts variables that
3709 are initialized to zero into BSS@.  This can save space in the resulting
3710 code.
3711
3712 This option turns off this behavior because some programs explicitly
3713 rely on variables going to the data section.  E.g., so that the
3714 resulting executable can find the beginning of that section and/or make
3715 assumptions based on that.
3716
3717 The default is @option{-fzero-initialized-in-bss}.
3718
3719 @item -fstrength-reduce
3720 @opindex fstrength-reduce
3721 Perform the optimizations of loop strength reduction and
3722 elimination of iteration variables.
3723
3724 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3725
3726 @item -fthread-jumps
3727 @opindex fthread-jumps
3728 Perform optimizations where we check to see if a jump branches to a
3729 location where another comparison subsumed by the first is found.  If
3730 so, the first branch is redirected to either the destination of the
3731 second branch or a point immediately following it, depending on whether
3732 the condition is known to be true or false.
3733
3734 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3735
3736 @item -fcse-follow-jumps
3737 @opindex fcse-follow-jumps
3738 In common subexpression elimination, scan through jump instructions
3739 when the target of the jump is not reached by any other path.  For
3740 example, when CSE encounters an @code{if} statement with an
3741 @code{else} clause, CSE will follow the jump when the condition
3742 tested is false.
3743
3744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3745
3746 @item -fcse-skip-blocks
3747 @opindex fcse-skip-blocks
3748 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3749 follow jumps which conditionally skip over blocks.  When CSE
3750 encounters a simple @code{if} statement with no else clause,
3751 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3752 body of the @code{if}.
3753
3754 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3755
3756 @item -frerun-cse-after-loop
3757 @opindex frerun-cse-after-loop
3758 Re-run common subexpression elimination after loop optimizations has been
3759 performed.
3760
3761 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3762
3763 @item -frerun-loop-opt
3764 @opindex frerun-loop-opt
3765 Run the loop optimizer twice.
3766
3767 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3768
3769 @item -fgcse
3770 @opindex fgcse
3771 Perform a global common subexpression elimination pass.
3772 This pass also performs global constant and copy propagation.
3773
3774 @emph{Note:} When compiling a program using computed gotos, a GCC
3775 extension, you may get better runtime performance if you disable
3776 the global common subexpression elimination pass by adding
3777 @option{-fno-gcse} to the command line.
3778
3779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3780
3781 @item -fgcse-lm
3782 @opindex fgcse-lm
3783 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3784 attempt to move loads which are only killed by stores into themselves.  This
3785 allows a loop containing a load/store sequence to be changed to a load outside
3786 the loop, and a copy/store within the loop.
3787
3788 Enabled by default when gcse is enabled.
3789
3790 @item -fgcse-sm
3791 @opindex fgcse-sm
3792 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3793 subexpression elimination.  This pass will attempt to move stores out of loops.
3794 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3795 can be changed to a load before the loop and a store after the loop.
3796
3797 Enabled by default when gcse is enabled.
3798
3799 @item -floop-optimize
3800 @opindex floop-optimize
3801 Perform loop optimizations: move constant expressions out of loops, simplify
3802 exit test conditions and optionally do strength-reduction and loop unrolling as
3803 well.
3804
3805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3806
3807 @item -fcrossjumping
3808 @opindex crossjumping
3809 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3810 resulting code may or may not perform better than without cross-jumping.
3811
3812 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3813
3814 @item -fif-conversion
3815 @opindex if-conversion
3816 Attempt to transform conditional jumps into branch-less equivalents.  This
3817 include use of conditional moves, min, max, set flags and abs instructions, and
3818 some tricks doable by standard arithmetics.  The use of conditional execution
3819 on chips where it is available is controlled by @code{if-conversion2}.
3820
3821 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3822
3823 @item -fif-conversion2
3824 @opindex if-conversion2
3825 Use conditional execution (where available) to transform conditional jumps into
3826 branch-less equivalents.
3827
3828 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3829
3830 @item -fdelete-null-pointer-checks
3831 @opindex fdelete-null-pointer-checks
3832 Use global dataflow analysis to identify and eliminate useless checks
3833 for null pointers.  The compiler assumes that dereferencing a null
3834 pointer would have halted the program.  If a pointer is checked after
3835 it has already been dereferenced, it cannot be null.
3836
3837 In some environments, this assumption is not true, and programs can
3838 safely dereference null pointers.  Use
3839 @option{-fno-delete-null-pointer-checks} to disable this optimization
3840 for programs which depend on that behavior.
3841
3842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3843
3844 @item -fexpensive-optimizations
3845 @opindex fexpensive-optimizations
3846 Perform a number of minor optimizations that are relatively expensive.
3847
3848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3849
3850 @item -foptimize-register-move
3851 @itemx -fregmove
3852 @opindex foptimize-register-move
3853 @opindex fregmove
3854 Attempt to reassign register numbers in move instructions and as
3855 operands of other simple instructions in order to maximize the amount of
3856 register tying.  This is especially helpful on machines with two-operand
3857 instructions.
3858
3859 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3860 optimization.
3861
3862 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3863
3864 @item -fdelayed-branch
3865 @opindex fdelayed-branch
3866 If supported for the target machine, attempt to reorder instructions
3867 to exploit instruction slots available after delayed branch
3868 instructions.
3869
3870 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3871
3872 @item -fschedule-insns
3873 @opindex fschedule-insns
3874 If supported for the target machine, attempt to reorder instructions to
3875 eliminate execution stalls due to required data being unavailable.  This
3876 helps machines that have slow floating point or memory load instructions
3877 by allowing other instructions to be issued until the result of the load
3878 or floating point instruction is required.
3879
3880 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3881
3882 @item -fschedule-insns2
3883 @opindex fschedule-insns2
3884 Similar to @option{-fschedule-insns}, but requests an additional pass of
3885 instruction scheduling after register allocation has been done.  This is
3886 especially useful on machines with a relatively small number of
3887 registers and where memory load instructions take more than one cycle.
3888
3889 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3890
3891 @item -fno-sched-interblock
3892 @opindex fno-sched-interblock
3893 Don't schedule instructions across basic blocks.  This is normally
3894 enabled by default when scheduling before register allocation, i.e.@:
3895 with @option{-fschedule-insns} or at @option{-O2} or higher.
3896
3897 @item -fno-sched-spec
3898 @opindex fno-sched-spec
3899 Don't allow speculative motion of non-load instructions.  This is normally
3900 enabled by default when scheduling before register allocation, i.e.@:
3901 with @option{-fschedule-insns} or at @option{-O2} or higher.
3902
3903 @item -fsched-spec-load
3904 @opindex fsched-spec-load
3905 Allow speculative motion of some load instructions.  This only makes
3906 sense when scheduling before register allocation, i.e.@: with
3907 @option{-fschedule-insns} or at @option{-O2} or higher.
3908
3909 @item -fsched-spec-load-dangerous
3910 @opindex fsched-spec-load-dangerous
3911 Allow speculative motion of more load instructions.  This only makes
3912 sense when scheduling before register allocation, i.e.@: with
3913 @option{-fschedule-insns} or at @option{-O2} or higher.
3914
3915 @item -fsched2-use-superblocks
3916 @opindex fsched2-use-superblocks
3917 When schedulilng after register allocation, do use superblock scheduling
3918 algorithm.  Superblock scheduling allows motion across basic block boundaries
3919 resulting on faster schedules.  This option is experimental, as not all machine
3920 descriptions used by GCC model the CPU closely enough to avoid unreliable
3921 results from the algorithm. 
3922
3923 This only makes sense when scheduling after register allocation, i.e.@: with
3924 @option{-fschedule-insns2} or at @option{-O2} or higher.
3925
3926 @item -fsched2-use-traces
3927 @opindex fsched2-use-traces
3928 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3929 allocation and additionally perform code duplication in order to increase the
3930 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3931 trace formation.
3932
3933 This mode should produce faster but significantly longer programs.  Also
3934 without @code{-fbranch-probabilities} the traces constructed may not match the
3935 reality and hurt the performance.  This only makes
3936 sense when scheduling after register allocation, i.e.@: with
3937 @option{-fschedule-insns2} or at @option{-O2} or higher.
3938
3939 @item -fcaller-saves
3940 @opindex fcaller-saves
3941 Enable values to be allocated in registers that will be clobbered by
3942 function calls, by emitting extra instructions to save and restore the
3943 registers around such calls.  Such allocation is done only when it
3944 seems to result in better code than would otherwise be produced.
3945
3946 This option is always enabled by default on certain machines, usually
3947 those which have no call-preserved registers to use instead.
3948
3949 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3950
3951 @item -fmove-all-movables
3952 @opindex fmove-all-movables
3953 Forces all invariant computations in loops to be moved
3954 outside the loop.
3955
3956 @item -freduce-all-givs
3957 @opindex freduce-all-givs
3958 Forces all general-induction variables in loops to be
3959 strength-reduced.
3960
3961 @emph{Note:} When compiling programs written in Fortran,
3962 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3963 by default when you use the optimizer.
3964
3965 These options may generate better or worse code; results are highly
3966 dependent on the structure of loops within the source code.
3967
3968 These two options are intended to be removed someday, once
3969 they have helped determine the efficacy of various
3970 approaches to improving loop optimizations.
3971
3972 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3973 know how use of these options affects
3974 the performance of your production code.
3975 We're very interested in code that runs @emph{slower}
3976 when these options are @emph{enabled}.
3977
3978 @item -fno-peephole
3979 @itemx -fno-peephole2
3980 @opindex fno-peephole
3981 @opindex fno-peephole2
3982 Disable any machine-specific peephole optimizations.  The difference
3983 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3984 are implemented in the compiler; some targets use one, some use the
3985 other, a few use both.
3986
3987 @option{-fpeephole} is enabled by default.
3988 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3989
3990 @item -fno-guess-branch-probability
3991 @opindex fno-guess-branch-probability
3992 Do not guess branch probabilities using a randomized model.
3993
3994 Sometimes gcc will opt to use a randomized model to guess branch
3995 probabilities, when none are available from either profiling feedback
3996 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3997 different runs of the compiler on the same program may produce different
3998 object code.
3999
4000 In a hard real-time system, people don't want different runs of the
4001 compiler to produce code that has different behavior; minimizing
4002 non-determinism is of paramount import.  This switch allows users to
4003 reduce non-determinism, possibly at the expense of inferior
4004 optimization.
4005
4006 The default is @option{-fguess-branch-probability} at levels
4007 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4008
4009 @item -freorder-blocks
4010 @opindex freorder-blocks
4011 Reorder basic blocks in the compiled function in order to reduce number of
4012 taken branches and improve code locality.
4013
4014 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015
4016 @item -freorder-functions
4017 @opindex freorder-functions
4018 Reorder basic blocks in the compiled function in order to reduce number of
4019 taken branches and improve code locality. This is implemented by using special
4020 subsections @code{text.hot} for most frequently executed functions and
4021 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4022 the linker so object file format must support named sections and linker must
4023 place them in a reasonable way.
4024
4025 Also profile feedback must be available in to make this option effective.  See
4026 @option{-fprofile-arcs} for details.
4027
4028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fstrict-aliasing
4031 @opindex fstrict-aliasing
4032 Allows the compiler to assume the strictest aliasing rules applicable to
4033 the language being compiled.  For C (and C++), this activates
4034 optimizations based on the type of expressions.  In particular, an
4035 object of one type is assumed never to reside at the same address as an
4036 object of a different type, unless the types are almost the same.  For
4037 example, an @code{unsigned int} can alias an @code{int}, but not a
4038 @code{void*} or a @code{double}.  A character type may alias any other
4039 type.
4040
4041 Pay special attention to code like this:
4042 @example
4043 union a_union @{
4044   int i;
4045   double d;
4046 @};
4047
4048 int f() @{
4049   a_union t;
4050   t.d = 3.0;
4051   return t.i;
4052 @}
4053 @end example
4054 The practice of reading from a different union member than the one most
4055 recently written to (called ``type-punning'') is common.  Even with
4056 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4057 is accessed through the union type.  So, the code above will work as
4058 expected.  However, this code might not:
4059 @example
4060 int f() @{
4061   a_union t;
4062   int* ip;
4063   t.d = 3.0;
4064   ip = &t.i;
4065   return *ip;
4066 @}
4067 @end example
4068
4069 Every language that wishes to perform language-specific alias analysis
4070 should define a function that computes, given an @code{tree}
4071 node, an alias set for the node.  Nodes in different alias sets are not
4072 allowed to alias.  For an example, see the C front-end function
4073 @code{c_get_alias_set}.
4074
4075 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4076
4077 @item -falign-functions
4078 @itemx -falign-functions=@var{n}
4079 @opindex falign-functions
4080 Align the start of functions to the next power-of-two greater than
4081 @var{n}, skipping up to @var{n} bytes.  For instance,
4082 @option{-falign-functions=32} aligns functions to the next 32-byte
4083 boundary, but @option{-falign-functions=24} would align to the next
4084 32-byte boundary only if this can be done by skipping 23 bytes or less.
4085
4086 @option{-fno-align-functions} and @option{-falign-functions=1} are
4087 equivalent and mean that functions will not be aligned.
4088
4089 Some assemblers only support this flag when @var{n} is a power of two;
4090 in that case, it is rounded up.
4091
4092 If @var{n} is not specified, use a machine-dependent default.
4093
4094 Enabled at levels @option{-O2}, @option{-O3}.
4095
4096 @item -falign-labels
4097 @itemx -falign-labels=@var{n}
4098 @opindex falign-labels
4099 Align all branch targets to a power-of-two boundary, skipping up to
4100 @var{n} bytes like @option{-falign-functions}.  This option can easily
4101 make code slower, because it must insert dummy operations for when the
4102 branch target is reached in the usual flow of the code.
4103
4104 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4105 are greater than this value, then their values are used instead.
4106
4107 If @var{n} is not specified, use a machine-dependent default which is
4108 very likely to be @samp{1}, meaning no alignment.
4109
4110 Enabled at levels @option{-O2}, @option{-O3}.
4111
4112 @item -falign-loops
4113 @itemx -falign-loops=@var{n}
4114 @opindex falign-loops
4115 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4116 like @option{-falign-functions}.  The hope is that the loop will be
4117 executed many times, which will make up for any execution of the dummy
4118 operations.
4119
4120 If @var{n} is not specified, use a machine-dependent default.
4121
4122 Enabled at levels @option{-O2}, @option{-O3}.
4123
4124 @item -falign-jumps
4125 @itemx -falign-jumps=@var{n}
4126 @opindex falign-jumps
4127 Align branch targets to a power-of-two boundary, for branch targets
4128 where the targets can only be reached by jumping, skipping up to @var{n}
4129 bytes like @option{-falign-functions}.  In this case, no dummy operations
4130 need be executed.
4131
4132 If @var{n} is not specified, use a machine-dependent default.
4133
4134 Enabled at levels @option{-O2}, @option{-O3}.
4135
4136 @item -frename-registers
4137 @opindex frename-registers
4138 Attempt to avoid false dependencies in scheduled code by making use
4139 of registers left over after register allocation.  This optimization
4140 will most benefit processors with lots of registers.  It can, however,
4141 make debugging impossible, since variables will no longer stay in
4142 a ``home register''.
4143
4144 Enabled at levels @option{-O3}.
4145
4146 @item -fno-cprop-registers
4147 @opindex fno-cprop-registers
4148 After register allocation and post-register allocation instruction splitting,
4149 we perform a copy-propagation pass to try to reduce scheduling dependencies
4150 and occasionally eliminate the copy.
4151
4152 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4153
4154 @end table
4155
4156 The following options control compiler behavior regarding floating
4157 point arithmetic.  These options trade off between speed and
4158 correctness.  All must be specifically enabled.
4159
4160 @table @gcctabopt
4161 @item -ffloat-store
4162 @opindex ffloat-store
4163 Do not store floating point variables in registers, and inhibit other
4164 options that might change whether a floating point value is taken from a
4165 register or memory.
4166
4167 @cindex floating point precision
4168 This option prevents undesirable excess precision on machines such as
4169 the 68000 where the floating registers (of the 68881) keep more
4170 precision than a @code{double} is supposed to have.  Similarly for the
4171 x86 architecture.  For most programs, the excess precision does only
4172 good, but a few programs rely on the precise definition of IEEE floating
4173 point.  Use @option{-ffloat-store} for such programs, after modifying
4174 them to store all pertinent intermediate computations into variables.
4175
4176 @item -ffast-math
4177 @opindex ffast-math
4178 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4179 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4180 @option{-fno-signaling-nans}.
4181
4182 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4183
4184 This option should never be turned on by any @option{-O} option since
4185 it can result in incorrect output for programs which depend on
4186 an exact implementation of IEEE or ISO rules/specifications for
4187 math functions.
4188
4189 @item -fno-math-errno
4190 @opindex fno-math-errno
4191 Do not set ERRNO after calling math functions that are executed
4192 with a single instruction, e.g., sqrt.  A program that relies on
4193 IEEE exceptions for math error handling may want to use this flag
4194 for speed while maintaining IEEE arithmetic compatibility.
4195
4196 This option should never be turned on by any @option{-O} option since
4197 it can result in incorrect output for programs which depend on
4198 an exact implementation of IEEE or ISO rules/specifications for
4199 math functions.
4200
4201 The default is @option{-fmath-errno}.
4202
4203 @item -funsafe-math-optimizations
4204 @opindex funsafe-math-optimizations
4205 Allow optimizations for floating-point arithmetic that (a) assume
4206 that arguments and results are valid and (b) may violate IEEE or
4207 ANSI standards.  When used at link-time, it may include libraries
4208 or startup files that change the default FPU control word or other
4209 similar optimizations.
4210
4211 This option should never be turned on by any @option{-O} option since
4212 it can result in incorrect output for programs which depend on
4213 an exact implementation of IEEE or ISO rules/specifications for
4214 math functions.
4215
4216 The default is @option{-fno-unsafe-math-optimizations}.
4217
4218 @item -ffinite-math-only
4219 @opindex ffinite-math-only
4220 Allow optimizations for floating-point arithmetic that assume
4221 that arguments and results are not NaNs or +-Infs.
4222
4223 This option should never be turned on by any @option{-O} option since
4224 it can result in incorrect output for programs which depend on
4225 an exact implementation of IEEE or ISO rules/specifications.
4226
4227 The default is @option{-fno-finite-math-only}.
4228
4229 @item -fno-trapping-math
4230 @opindex fno-trapping-math
4231 Compile code assuming that floating-point operations cannot generate
4232 user-visible traps.  These traps include division by zero, overflow,
4233 underflow, inexact result and invalid operation.  This option implies
4234 @option{-fno-signaling-nans}.  Setting this option may allow faster
4235 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4236
4237 This option should never be turned on by any @option{-O} option since
4238 it can result in incorrect output for programs which depend on
4239 an exact implementation of IEEE or ISO rules/specifications for
4240 math functions.
4241
4242 The default is @option{-ftrapping-math}.
4243
4244 @item -fsignaling-nans
4245 @opindex fsignaling-nans
4246 Compile code assuming that IEEE signaling NaNs may generate user-visible
4247 traps during floating-point operations.  Setting this option disables
4248 optimizations that may change the number of exceptions visible with
4249 signaling NaNs.  This option implies @option{-ftrapping-math}.
4250
4251 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4252 be defined.
4253
4254 The default is @option{-fno-signaling-nans}.
4255
4256 This option is experimental and does not currently guarantee to
4257 disable all GCC optimizations that affect signaling NaN behavior.
4258
4259 @item -fsingle-precision-constant
4260 @opindex fsingle-precision-constant
4261 Treat floating point constant as single precision constant instead of
4262 implicitly converting it to double precision constant.
4263
4264
4265 @end table
4266
4267 The following options control optimizations that may improve
4268 performance, but are not enabled by any @option{-O} options.  This
4269 section includes experimental options that may produce broken code.
4270
4271 @table @gcctabopt
4272 @item -fbranch-probabilities
4273 @opindex fbranch-probabilities
4274 After running a program compiled with @option{-fprofile-arcs}
4275 (@pxref{Debugging Options,, Options for Debugging Your Program or
4276 @command{gcc}}), you can compile it a second time using
4277 @option{-fbranch-probabilities}, to improve optimizations based on
4278 the number of times each branch was taken.  When the program
4279 compiled with @option{-fprofile-arcs} exits it saves arc execution
4280 counts to a file called @file{@var{sourcename}.da} for each source
4281 file  The information in this data file is very dependent on the
4282 structure of the generated code, so you must use the same source code
4283 and the same optimization options for both compilations.
4284
4285 With @option{-fbranch-probabilities}, GCC puts a 
4286 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4287 These can be used to improve optimization.  Currently, they are only
4288 used in one place: in @file{reorg.c}, instead of guessing which path a
4289 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4290 exactly determine which path is taken more often.
4291
4292 @item -fnew-ra
4293 @opindex fnew-ra
4294 Use a graph coloring register allocator.  Currently this option is meant
4295 for testing, so we are interested to hear about miscompilations with
4296 @option{-fnew-ra}.
4297
4298 @item -ftracer
4299 @opindex ftracer
4300 Perform tail duplication to enlarge superblock size. This transformation
4301 simplifies the control flow of the function allowing other optimizations to do
4302 better job.
4303
4304 @item -funit-at-a-time
4305 @opindex funit-at-a-time
4306 Parse the whole compilation unit before starting to produce code.  This allows some
4307 extra optimizations to take place but consumes more memory.
4308
4309 @item -funroll-loops
4310 @opindex funroll-loops
4311 Unroll loops whose number of iterations can be determined at compile time or
4312 upon entry to the loop.  @option{-funroll-loops} implies
4313 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4314 (i.e. complete removal of loops with small constant number of iterations).
4315 This option makes code larger, and may or may not make it run faster.
4316
4317 @item -funroll-all-loops
4318 @opindex funroll-all-loops
4319 Unroll all loops, even if their number of iterations is uncertain when
4320 the loop is entered.  This usually makes programs run more slowly.
4321 @option{-funroll-all-loops} implies the same options as
4322 @option{-funroll-loops}.
4323
4324 @item -fpeel-loops
4325 @opindex fpeel-loops
4326 Peels the loops for that there is enough information that they do not
4327 roll much (from profile feedback).  It also turns on complete loop peeling
4328 (i.e. complete removal of loops with small constant number of iterations).
4329
4330 @item -funswitch-loops
4331 @opindex funswitch-loops
4332 Move branches with loop invariant conditions out of the loop, with duplicates
4333 of the loop on both branches (modified according to result of the condition).
4334
4335 @item -fold-unroll-loops
4336 @opindex fold-unroll-loops
4337 Unroll loops whose number of iterations can be determined at compile
4338 time or upon entry to the loop, using the old loop unroller whose loop
4339 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4340 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4341 option makes code larger, and may or may not make it run faster.
4342
4343 @item -fold-unroll-all-loops
4344 @opindex fold-unroll-all-loops
4345 Unroll all loops, even if their number of iterations is uncertain when
4346 the loop is entered. This is done using the old loop unroller whose loop
4347 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4348 @option{-fold-unroll-all-loops} implies the same options as
4349 @option{-fold-unroll-loops}.
4350  
4351 @item -funswitch-loops
4352 @opindex funswitch-loops
4353 Move branches with loop invariant conditions out of the loop, with duplicates
4354 of the loop on both branches (modified according to result of the condition).
4355
4356 @item -funswitch-loops
4357 @opindex funswitch-loops
4358 Move branches with loop invariant conditions out of the loop, with duplicates
4359 of the loop on both branches (modified according to result of the condition).
4360
4361 @item -fprefetch-loop-arrays
4362 @opindex fprefetch-loop-arrays
4363 If supported by the target machine, generate instructions to prefetch
4364 memory to improve the performance of loops that access large arrays.
4365
4366 Disabled at level @option{-Os}.
4367
4368 @item -ffunction-sections
4369 @itemx -fdata-sections
4370 @opindex ffunction-sections
4371 @opindex fdata-sections
4372 Place each function or data item into its own section in the output
4373 file if the target supports arbitrary sections.  The name of the
4374 function or the name of the data item determines the section's name
4375 in the output file.
4376
4377 Use these options on systems where the linker can perform optimizations
4378 to improve locality of reference in the instruction space.  Most systems
4379 using the ELF object format and SPARC processors running Solaris 2 have
4380 linkers with such optimizations.  AIX may have these optimizations in
4381 the future.
4382
4383 Only use these options when there are significant benefits from doing
4384 so.  When you specify these options, the assembler and linker will
4385 create larger object and executable files and will also be slower.
4386 You will not be able to use @code{gprof} on all systems if you
4387 specify this option and you may have problems with debugging if
4388 you specify both this option and @option{-g}.
4389
4390 @item -fssa
4391 @opindex fssa
4392 Perform optimizations in static single assignment form.  Each function's
4393 flow graph is translated into SSA form, optimizations are performed, and
4394 the flow graph is translated back from SSA form.  Users should not
4395 specify this option, since it is not yet ready for production use.
4396
4397 @item -fssa-ccp
4398 @opindex fssa-ccp
4399 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4400 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4401
4402 @item -fssa-dce
4403 @opindex fssa-dce
4404 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4405 Like @option{-fssa}, this is an experimental feature.
4406
4407
4408
4409
4410 @item --param @var{name}=@var{value}
4411 @opindex param
4412 In some places, GCC uses various constants to control the amount of
4413 optimization that is done.  For example, GCC will not inline functions
4414 that contain more that a certain number of instructions.  You can
4415 control some of these constants on the command-line using the
4416 @option{--param} option.
4417
4418 In each case, the @var{value} is an integer.  The allowable choices for
4419 @var{name} are given in the following table:
4420
4421 @table @gcctabopt
4422 @item max-crossjump-edges
4423 The maximum number of incoming edges to consider for crossjumping.
4424 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4425 the number of edges incoming to each block.  Increasing values mean
4426 more aggressive optimization, making the compile time increase with
4427 probably small improvement in executable size.
4428
4429 @item max-delay-slot-insn-search
4430 The maximum number of instructions to consider when looking for an
4431 instruction to fill a delay slot.  If more than this arbitrary number of
4432 instructions is searched, the time savings from filling the delay slot
4433 will be minimal so stop searching.  Increasing values mean more
4434 aggressive optimization, making the compile time increase with probably
4435 small improvement in executable run time.
4436
4437 @item max-delay-slot-live-search
4438 When trying to fill delay slots, the maximum number of instructions to
4439 consider when searching for a block with valid live register
4440 information.  Increasing this arbitrarily chosen value means more
4441 aggressive optimization, increasing the compile time.  This parameter
4442 should be removed when the delay slot code is rewritten to maintain the
4443 control-flow graph.
4444
4445 @item max-gcse-memory
4446 The approximate maximum amount of memory that will be allocated in
4447 order to perform the global common subexpression elimination
4448 optimization.  If more memory than specified is required, the
4449 optimization will not be done.
4450
4451 @item max-gcse-passes
4452 The maximum number of passes of GCSE to run.
4453
4454 @item max-pending-list-length
4455 The maximum number of pending dependencies scheduling will allow
4456 before flushing the current state and starting over.  Large functions
4457 with few branches or calls can create excessively large lists which
4458 needlessly consume memory and resources.
4459
4460 @item max-inline-insns-single
4461 Several parameters control the tree inliner used in gcc.
4462 This number sets the maximum number of instructions (counted in gcc's
4463 internal representation) in a single function that the tree inliner 
4464 will consider for inlining.  This only affects functions declared
4465 inline and methods implemented in a class declaration (C++).
4466 The default value is 300.
4467
4468 @item max-inline-insns-auto
4469 When you use @option{-finline-functions} (included in @option{-O3}),
4470 a lot of functions that would otherwise not be considered for inlining
4471 by the compiler will be investigated.  To those functions, a different
4472 (more restrictive) limit compared to functions declared inline can
4473 be applied.
4474 The default value is 300.
4475
4476 @item max-inline-insns
4477 The tree inliner does decrease the allowable size for single functions 
4478 to be inlined after we already inlined the number of instructions
4479 given here by repeated inlining.  This number should be a factor of 
4480 two or more larger than the single function limit.
4481 Higher numbers result in better runtime performance, but incur higher
4482 compile-time resource (CPU time, memory) requirements and result in
4483 larger binaries.  Very high values are not advisable, as too large
4484 binaries may adversely affect runtime performance.
4485 The default value is 600.
4486
4487 @item max-inline-slope
4488 After exceeding the maximum number of inlined instructions by repeated
4489 inlining, a linear function is used to decrease the allowable size
4490 for single functions.  The slope of that function is the negative
4491 reciprocal of the number specified here.
4492 The default value is 32.
4493
4494 @item min-inline-insns
4495 The repeated inlining is throttled more and more by the linear function
4496 after exceeding the limit.  To avoid too much throttling, a minimum for
4497 this function is specified here to allow repeated inlining for very small
4498 functions even when a lot of repeated inlining already has been done.
4499 The default value is 130.
4500
4501 @item max-inline-insns-rtl
4502 For languages that use the RTL inliner (this happens at a later stage
4503 than tree inlining), you can set the maximum allowable size (counted 
4504 in RTL instructions) for the RTL inliner with this parameter.
4505 The default value is 600.
4506
4507
4508 @item max-unrolled-insns
4509 The maximum number of instructions that a loop should have if that loop
4510 is unrolled, and if the loop is unrolled, it determines how many times
4511 the loop code is unrolled.
4512
4513 @item max-average-unrolled-insns
4514 The maximum number of instructions biased by probabilities of their execution
4515 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4516 it determines how many times the loop code is unrolled.
4517
4518 @item max-unroll-times
4519 The maximum number of unrollings of a single loop.
4520
4521 @item max-peeled-insns
4522 The maximum number of instructions that a loop should have if that loop
4523 is peeled, and if the loop is peeled, it determines how many times
4524 the loop code is peeled.
4525
4526 @item max-peel-times
4527 The maximum number of peelings of a single loop.
4528
4529 @item max-completely-peeled-insns
4530 The maximum number of insns of a completely peeled loop.
4531
4532 @item max-completely-peel-times
4533 The maximum number of iterations of a loop to be suitable for complete peeling.
4534
4535 @item max-unswitch-insns
4536 The maximum number of insns of an unswitched loop.
4537
4538 @item max-unswitch-level
4539 The maximum number of branches unswitched in a single loop.
4540
4541 @item hot-bb-count-fraction
4542 Select fraction of the maximal count of repetitions of basic block in program
4543 given basic block needs to have to be considered hot.
4544
4545 @item hot-bb-frequency-fraction
4546 Select fraction of the maximal frequency of executions of basic block in
4547 function given basic block needs to have to be considered hot
4548
4549 @item tracer-dynamic-coverage
4550 @itemx tracer-dynamic-coverage-feedback
4551
4552 This value is used to limit superblock formation once the given percentage of
4553 executed instructions is covered.  This limits unnecessary code size
4554 expansion.
4555
4556 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4557 feedback is available.  The real profiles (as opposed to statically estimated
4558 ones) are much less balanced allowing the threshold to be larger value.
4559
4560 @item tracer-max-code-growth
4561 Stop tail duplication once code growth has reached given percentage.  This is
4562 rather hokey argument, as most of the duplicates will be eliminated later in
4563 cross jumping, so it may be set to much higher values than is the desired code
4564 growth.
4565
4566 @item tracer-min-branch-ratio
4567
4568 Stop reverse growth when the reverse probability of best edge is less than this
4569 threshold (in percent).
4570
4571 @item tracer-min-branch-ratio
4572 @itemx tracer-min-branch-ratio-feedback
4573
4574 Stop forward growth if the best edge do have probability lower than this
4575 threshold.
4576
4577 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4578 compilation for profile feedback and one for compilation without.  The value
4579 for compilation with profile feedback needs to be more conservative (higher) in
4580 order to make tracer effective.
4581
4582 @item ggc-min-expand
4583
4584 GCC uses a garbage collector to manage its own memory allocation.  This
4585 parameter specifies the minimum percentage by which the garbage
4586 collector's heap should be allowed to expand between collections.
4587 Tuning this may improve compilation speed; it has no effect on code
4588 generation.
4589
4590 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4591 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4592 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4593 GCC is not able to calculate RAM on a particular platform, the lower
4594 bound of 30% is used.  Setting this parameter and
4595 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4596 every opportunity.  This is extremely slow, but can be useful for
4597 debugging.
4598
4599 @item ggc-min-heapsize
4600
4601 Minimum size of the garbage collector's heap before it begins bothering
4602 to collect garbage.  The first collection occurs after the heap expands
4603 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4604 tuning this may improve compilation speed, and has no effect on code
4605 generation.
4606
4607 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4608 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4609 available, the notion of "RAM" is the smallest of actual RAM,
4610 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4611 RAM on a particular platform, the lower bound is used.  Setting this
4612 parameter very large effectively disables garbage collection.  Setting
4613 this parameter and @option{ggc-min-expand} to zero causes a full
4614 collection to occur at every opportunity.
4615
4616 @end table
4617 @end table
4618
4619 @node Preprocessor Options
4620 @section Options Controlling the Preprocessor
4621 @cindex preprocessor options
4622 @cindex options, preprocessor
4623
4624 These options control the C preprocessor, which is run on each C source
4625 file before actual compilation.
4626
4627 If you use the @option{-E} option, nothing is done except preprocessing.
4628 Some of these options make sense only together with @option{-E} because
4629 they cause the preprocessor output to be unsuitable for actual
4630 compilation.
4631
4632 @table @gcctabopt
4633 @opindex Wp
4634 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4635 and pass @var{option} directly through to the preprocessor.  If
4636 @var{option} contains commas, it is split into multiple options at the
4637 commas.  However, many options are modified, translated or interpreted
4638 by the compiler driver before being passed to the preprocessor, and
4639 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4640 interface is undocumented and subject to change, so whenever possible
4641 you should avoid using @option{-Wp} and let the driver handle the
4642 options instead.
4643
4644 @item -Xpreprocessor @var{option}
4645 @opindex preprocessor
4646 Pass @var{option} as an option to the preprocessor.  You can use this to
4647 supply system-specific preprocessor options which GCC does not know how to
4648 recognize.
4649
4650 If you want to pass an option that takes an argument, you must use
4651 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4652 @end table
4653
4654 @include cppopts.texi
4655
4656 @node Assembler Options
4657 @section Passing Options to the Assembler
4658
4659 @c prevent bad page break with this line
4660 You can pass options to the assembler.
4661
4662 @table @gcctabopt
4663 @item -Wa,@var{option}
4664 @opindex Wa
4665 Pass @var{option} as an option to the assembler.  If @var{option}
4666 contains commas, it is split into multiple options at the commas.
4667
4668 @item -Xassembler @var{option}
4669 @opindex Xassembler
4670 Pass @var{option} as an option to the assembler.  You can use this to
4671 supply system-specific assembler options which GCC does not know how to
4672 recognize.
4673
4674 If you want to pass an option that takes an argument, you must use
4675 @option{-Xassembler} twice, once for the option and once for the argument.
4676
4677 @end table
4678
4679 @node Link Options
4680 @section Options for Linking
4681 @cindex link options
4682 @cindex options, linking
4683
4684 These options come into play when the compiler links object files into
4685 an executable output file.  They are meaningless if the compiler is
4686 not doing a link step.
4687
4688 @table @gcctabopt
4689 @cindex file names
4690 @item @var{object-file-name}
4691 A file name that does not end in a special recognized suffix is
4692 considered to name an object file or library.  (Object files are
4693 distinguished from libraries by the linker according to the file
4694 contents.)  If linking is done, these object files are used as input
4695 to the linker.
4696
4697 @item -c
4698 @itemx -S
4699 @itemx -E
4700 @opindex c
4701 @opindex S
4702 @opindex E
4703 If any of these options is used, then the linker is not run, and
4704 object file names should not be used as arguments.  @xref{Overall
4705 Options}.
4706
4707 @cindex Libraries
4708 @item -l@var{library}
4709 @itemx -l @var{library}
4710 @opindex l
4711 Search the library named @var{library} when linking.  (The second
4712 alternative with the library as a separate argument is only for
4713 POSIX compliance and is not recommended.)
4714
4715 It makes a difference where in the command you write this option; the
4716 linker searches and processes libraries and object files in the order they
4717 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4718 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4719 to functions in @samp{z}, those functions may not be loaded.
4720
4721 The linker searches a standard list of directories for the library,
4722 which is actually a file named @file{lib@var{library}.a}.  The linker
4723 then uses this file as if it had been specified precisely by name.
4724
4725 The directories searched include several standard system directories
4726 plus any that you specify with @option{-L}.
4727
4728 Normally the files found this way are library files---archive files
4729 whose members are object files.  The linker handles an archive file by
4730 scanning through it for members which define symbols that have so far
4731 been referenced but not defined.  But if the file that is found is an
4732 ordinary object file, it is linked in the usual fashion.  The only
4733 difference between using an @option{-l} option and specifying a file name
4734 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4735 and searches several directories.
4736
4737 @item -lobjc
4738 @opindex lobjc
4739 You need this special case of the @option{-l} option in order to
4740 link an Objective-C program.
4741
4742 @item -nostartfiles
4743 @opindex nostartfiles
4744 Do not use the standard system startup files when linking.
4745 The standard system libraries are used normally, unless @option{-nostdlib}
4746 or @option{-nodefaultlibs} is used.
4747
4748 @item -nodefaultlibs
4749 @opindex nodefaultlibs
4750 Do not use the standard system libraries when linking.
4751 Only the libraries you specify will be passed to the linker.
4752 The standard startup files are used normally, unless @option{-nostartfiles}
4753 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4754 for System V (and ISO C) environments or to bcopy and bzero for
4755 BSD environments.  These entries are usually resolved by entries in
4756 libc.  These entry points should be supplied through some other
4757 mechanism when this option is specified.
4758
4759 @item -nostdlib
4760 @opindex nostdlib
4761 Do not use the standard system startup files or libraries when linking.
4762 No startup files and only the libraries you specify will be passed to
4763 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4764 for System V (and ISO C) environments or to bcopy and bzero for
4765 BSD environments.  These entries are usually resolved by entries in
4766 libc.  These entry points should be supplied through some other
4767 mechanism when this option is specified.
4768
4769 @cindex @option{-lgcc}, use with @option{-nostdlib}
4770 @cindex @option{-nostdlib} and unresolved references
4771 @cindex unresolved references and @option{-nostdlib}
4772 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4773 @cindex @option{-nodefaultlibs} and unresolved references
4774 @cindex unresolved references and @option{-nodefaultlibs}
4775 One of the standard libraries bypassed by @option{-nostdlib} and
4776 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4777 that GCC uses to overcome shortcomings of particular machines, or special
4778 needs for some languages.
4779 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4780 Collection (GCC) Internals},
4781 for more discussion of @file{libgcc.a}.)
4782 In most cases, you need @file{libgcc.a} even when you want to avoid
4783 other standard libraries.  In other words, when you specify @option{-nostdlib}
4784 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4785 This ensures that you have no unresolved references to internal GCC
4786 library subroutines.  (For example, @samp{__main}, used to ensure C++
4787 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4788 GNU Compiler Collection (GCC) Internals}.)
4789
4790 @item -s
4791 @opindex s
4792 Remove all symbol table and relocation information from the executable.
4793
4794 @item -static
4795 @opindex static
4796 On systems that support dynamic linking, this prevents linking with the shared
4797 libraries.  On other systems, this option has no effect.
4798
4799 @item -shared
4800 @opindex shared
4801 Produce a shared object which can then be linked with other objects to
4802 form an executable.  Not all systems support this option.  For predictable
4803 results, you must also specify the same set of options that were used to
4804 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4805 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4806 needs to build supplementary stub code for constructors to work.  On
4807 multi-libbed systems, @samp{gcc -shared} must select the correct support
4808 libraries to link against.  Failing to supply the correct flags may lead
4809 to subtle defects.  Supplying them in cases where they are not necessary
4810 is innocuous.}
4811
4812 @item -shared-libgcc
4813 @itemx -static-libgcc
4814 @opindex shared-libgcc
4815 @opindex static-libgcc
4816 On systems that provide @file{libgcc} as a shared library, these options
4817 force the use of either the shared or static version respectively.
4818 If no shared version of @file{libgcc} was built when the compiler was
4819 configured, these options have no effect.
4820
4821 There are several situations in which an application should use the
4822 shared @file{libgcc} instead of the static version.  The most common
4823 of these is when the application wishes to throw and catch exceptions
4824 across different shared libraries.  In that case, each of the libraries
4825 as well as the application itself should use the shared @file{libgcc}.
4826
4827 Therefore, the G++ and GCJ drivers automatically add
4828 @option{-shared-libgcc} whenever you build a shared library or a main
4829 executable, because C++ and Java programs typically use exceptions, so
4830 this is the right thing to do.
4831
4832 If, instead, you use the GCC driver to create shared libraries, you may
4833 find that they will not always be linked with the shared @file{libgcc}.
4834 If GCC finds, at its configuration time, that you have a GNU linker that
4835 does not support option @option{--eh-frame-hdr}, it will link the shared
4836 version of @file{libgcc} into shared libraries by default.  Otherwise,
4837 it will take advantage of the linker and optimize away the linking with
4838 the shared version of @file{libgcc}, linking with the static version of
4839 libgcc by default.  This allows exceptions to propagate through such
4840 shared libraries, without incurring relocation costs at library load
4841 time.
4842
4843 However, if a library or main executable is supposed to throw or catch
4844 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4845 for the languages used in the program, or using the option
4846 @option{-shared-libgcc}, such that it is linked with the shared
4847 @file{libgcc}.
4848
4849 @item -symbolic
4850 @opindex symbolic
4851 Bind references to global symbols when building a shared object.  Warn
4852 about any unresolved references (unless overridden by the link editor
4853 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4854 this option.
4855
4856 @item -Xlinker @var{option}
4857 @opindex Xlinker
4858 Pass @var{option} as an option to the linker.  You can use this to
4859 supply system-specific linker options which GCC does not know how to
4860 recognize.
4861
4862 If you want to pass an option that takes an argument, you must use
4863 @option{-Xlinker} twice, once for the option and once for the argument.
4864 For example, to pass @option{-assert definitions}, you must write
4865 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4866 @option{-Xlinker "-assert definitions"}, because this passes the entire
4867 string as a single argument, which is not what the linker expects.
4868
4869 @item -Wl,@var{option}
4870 @opindex Wl
4871 Pass @var{option} as an option to the linker.  If @var{option} contains
4872 commas, it is split into multiple options at the commas.
4873
4874 @item -u @var{symbol}
4875 @opindex u
4876 Pretend the symbol @var{symbol} is undefined, to force linking of
4877 library modules to define it.  You can use @option{-u} multiple times with
4878 different symbols to force loading of additional library modules.
4879 @end table
4880
4881 @node Directory Options
4882 @section Options for Directory Search
4883 @cindex directory options
4884 @cindex options, directory search
4885 @cindex search path
4886
4887 These options specify directories to search for header files, for
4888 libraries and for parts of the compiler:
4889
4890 @table @gcctabopt
4891 @item -I@var{dir}
4892 @opindex I
4893 Add the directory @var{dir} to the head of the list of directories to be
4894 searched for header files.  This can be used to override a system header
4895 file, substituting your own version, since these directories are
4896 searched before the system header file directories.  However, you should
4897 not use this option to add directories that contain vendor-supplied
4898 system header files (use @option{-isystem} for that).  If you use more than
4899 one @option{-I} option, the directories are scanned in left-to-right
4900 order; the standard system directories come after.
4901
4902 If a standard system include directory, or a directory specified with
4903 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4904 option will be ignored.  The directory will still be searched but as a
4905 system directory at its normal position in the system include chain.
4906 This is to ensure that GCC's procedure to fix buggy system headers and
4907 the ordering for the include_next directive are not inadvertently changed.
4908 If you really need to change the search order for system directories,
4909 use the @option{-nostdinc} and/or @option{-isystem} options.
4910
4911 @item -I-
4912 @opindex I-
4913 Any directories you specify with @option{-I} options before the @option{-I-}
4914 option are searched only for the case of @samp{#include "@var{file}"};
4915 they are not searched for @samp{#include <@var{file}>}.
4916
4917 If additional directories are specified with @option{-I} options after
4918 the @option{-I-}, these directories are searched for all @samp{#include}
4919 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4920 this way.)
4921
4922 In addition, the @option{-I-} option inhibits the use of the current
4923 directory (where the current input file came from) as the first search
4924 directory for @samp{#include "@var{file}"}.  There is no way to
4925 override this effect of @option{-I-}.  With @option{-I.} you can specify
4926 searching the directory which was current when the compiler was
4927 invoked.  That is not exactly the same as what the preprocessor does
4928 by default, but it is often satisfactory.
4929
4930 @option{-I-} does not inhibit the use of the standard system directories
4931 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4932 independent.
4933
4934 @item -L@var{dir}
4935 @opindex L
4936 Add directory @var{dir} to the list of directories to be searched
4937 for @option{-l}.
4938
4939 @item -B@var{prefix}
4940 @opindex B
4941 This option specifies where to find the executables, libraries,
4942 include files, and data files of the compiler itself.
4943
4944 The compiler driver program runs one or more of the subprograms
4945 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4946 @var{prefix} as a prefix for each program it tries to run, both with and
4947 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4948
4949 For each subprogram to be run, the compiler driver first tries the
4950 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4951 was not specified, the driver tries two standard prefixes, which are
4952 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4953 those results in a file name that is found, the unmodified program
4954 name is searched for using the directories specified in your
4955 @env{PATH} environment variable.
4956
4957 The compiler will check to see if the path provided by the @option{-B}
4958 refers to a directory, and if necessary it will add a directory
4959 separator character at the end of the path.
4960
4961 @option{-B} prefixes that effectively specify directory names also apply
4962 to libraries in the linker, because the compiler translates these
4963 options into @option{-L} options for the linker.  They also apply to
4964 includes files in the preprocessor, because the compiler translates these
4965 options into @option{-isystem} options for the preprocessor.  In this case,
4966 the compiler appends @samp{include} to the prefix.
4967
4968 The run-time support file @file{libgcc.a} can also be searched for using
4969 the @option{-B} prefix, if needed.  If it is not found there, the two
4970 standard prefixes above are tried, and that is all.  The file is left
4971 out of the link if it is not found by those means.
4972
4973 Another way to specify a prefix much like the @option{-B} prefix is to use
4974 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4975 Variables}.
4976
4977 As a special kludge, if the path provided by @option{-B} is
4978 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4979 9, then it will be replaced by @file{[dir/]include}.  This is to help
4980 with boot-strapping the compiler.
4981
4982 @item -specs=@var{file}
4983 @opindex specs
4984 Process @var{file} after the compiler reads in the standard @file{specs}
4985 file, in order to override the defaults that the @file{gcc} driver
4986 program uses when determining what switches to pass to @file{cc1},
4987 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4988 @option{-specs=@var{file}} can be specified on the command line, and they
4989 are processed in order, from left to right.
4990 @end table
4991
4992 @c man end
4993
4994 @node Spec Files
4995 @section Specifying subprocesses and the switches to pass to them
4996 @cindex Spec Files
4997
4998 @command{gcc} is a driver program.  It performs its job by invoking a
4999 sequence of other programs to do the work of compiling, assembling and
5000 linking.  GCC interprets its command-line parameters and uses these to
5001 deduce which programs it should invoke, and which command-line options
5002 it ought to place on their command lines.  This behavior is controlled
5003 by @dfn{spec strings}.  In most cases there is one spec string for each
5004 program that GCC can invoke, but a few programs have multiple spec
5005 strings to control their behavior.  The spec strings built into GCC can
5006 be overridden by using the @option{-specs=} command-line switch to specify
5007 a spec file.
5008
5009 @dfn{Spec files} are plaintext files that are used to construct spec
5010 strings.  They consist of a sequence of directives separated by blank
5011 lines.  The type of directive is determined by the first non-whitespace
5012 character on the line and it can be one of the following:
5013
5014 @table @code
5015 @item %@var{command}
5016 Issues a @var{command} to the spec file processor.  The commands that can
5017 appear here are:
5018
5019 @table @code
5020 @item %include <@var{file}>
5021 @cindex %include
5022 Search for @var{file} and insert its text at the current point in the
5023 specs file.
5024
5025 @item %include_noerr <@var{file}>
5026 @cindex %include_noerr
5027 Just like @samp{%include}, but do not generate an error message if the include
5028 file cannot be found.
5029
5030 @item %rename @var{old_name} @var{new_name}
5031 @cindex %rename
5032 Rename the spec string @var{old_name} to @var{new_name}.
5033
5034 @end table
5035
5036 @item *[@var{spec_name}]:
5037 This tells the compiler to create, override or delete the named spec
5038 string.  All lines after this directive up to the next directive or
5039 blank line are considered to be the text for the spec string.  If this
5040 results in an empty string then the spec will be deleted.  (Or, if the
5041 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5042 does not currently exist a new spec will be created.  If the spec does
5043 exist then its contents will be overridden by the text of this
5044 directive, unless the first character of that text is the @samp{+}
5045 character, in which case the text will be appended to the spec.
5046
5047 @item [@var{suffix}]:
5048 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5049 and up to the next directive or blank line are considered to make up the
5050 spec string for the indicated suffix.  When the compiler encounters an
5051 input file with the named suffix, it will processes the spec string in
5052 order to work out how to compile that file.  For example:
5053
5054 @smallexample
5055 .ZZ:
5056 z-compile -input %i
5057 @end smallexample
5058
5059 This says that any input file whose name ends in @samp{.ZZ} should be
5060 passed to the program @samp{z-compile}, which should be invoked with the
5061 command-line switch @option{-input} and with the result of performing the
5062 @samp{%i} substitution.  (See below.)
5063
5064 As an alternative to providing a spec string, the text that follows a
5065 suffix directive can be one of the following:
5066
5067 @table @code
5068 @item @@@var{language}
5069 This says that the suffix is an alias for a known @var{language}.  This is
5070 similar to using the @option{-x} command-line switch to GCC to specify a
5071 language explicitly.  For example:
5072
5073 @smallexample
5074 .ZZ:
5075 @@c++
5076 @end smallexample
5077
5078 Says that .ZZ files are, in fact, C++ source files.
5079
5080 @item #@var{name}
5081 This causes an error messages saying:
5082
5083 @smallexample
5084 @var{name} compiler not installed on this system.
5085 @end smallexample
5086 @end table
5087
5088 GCC already has an extensive list of suffixes built into it.
5089 This directive will add an entry to the end of the list of suffixes, but
5090 since the list is searched from the end backwards, it is effectively
5091 possible to override earlier entries using this technique.
5092
5093 @end table
5094
5095 GCC has the following spec strings built into it.  Spec files can
5096 override these strings or create their own.  Note that individual
5097 targets can also add their own spec strings to this list.
5098
5099 @smallexample
5100 asm          Options to pass to the assembler
5101 asm_final    Options to pass to the assembler post-processor
5102 cpp          Options to pass to the C preprocessor
5103 cc1          Options to pass to the C compiler
5104 cc1plus      Options to pass to the C++ compiler
5105 endfile      Object files to include at the end of the link
5106 link         Options to pass to the linker
5107 lib          Libraries to include on the command line to the linker
5108 libgcc       Decides which GCC support library to pass to the linker
5109 linker       Sets the name of the linker
5110 predefines   Defines to be passed to the C preprocessor
5111 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5112              by default
5113 startfile    Object files to include at the start of the link
5114 @end smallexample
5115
5116 Here is a small example of a spec file:
5117
5118 @smallexample
5119 %rename lib                 old_lib
5120
5121 *lib:
5122 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5123 @end smallexample
5124
5125 This example renames the spec called @samp{lib} to @samp{old_lib} and
5126 then overrides the previous definition of @samp{lib} with a new one.
5127 The new definition adds in some extra command-line options before
5128 including the text of the old definition.
5129
5130 @dfn{Spec strings} are a list of command-line options to be passed to their
5131 corresponding program.  In addition, the spec strings can contain
5132 @samp{%}-prefixed sequences to substitute variable text or to
5133 conditionally insert text into the command line.  Using these constructs
5134 it is possible to generate quite complex command lines.
5135
5136 Here is a table of all defined @samp{%}-sequences for spec
5137 strings.  Note that spaces are not generated automatically around the
5138 results of expanding these sequences.  Therefore you can concatenate them
5139 together or combine them with constant text in a single argument.
5140
5141 @table @code
5142 @item %%
5143 Substitute one @samp{%} into the program name or argument.
5144
5145 @item %i
5146 Substitute the name of the input file being processed.
5147
5148 @item %b
5149 Substitute the basename of the input file being processed.
5150 This is the substring up to (and not including) the last period
5151 and not including the directory.
5152
5153 @item %B
5154 This is the same as @samp{%b}, but include the file suffix (text after
5155 the last period).
5156
5157 @item %d
5158 Marks the argument containing or following the @samp{%d} as a
5159 temporary file name, so that that file will be deleted if GCC exits
5160 successfully.  Unlike @samp{%g}, this contributes no text to the
5161 argument.
5162
5163 @item %g@var{suffix}
5164 Substitute a file name that has suffix @var{suffix} and is chosen
5165 once per compilation, and mark the argument in the same way as
5166 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5167 name is now chosen in a way that is hard to predict even when previously
5168 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5169 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5170 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5171 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5172 was simply substituted with a file name chosen once per compilation,
5173 without regard to any appended suffix (which was therefore treated
5174 just like ordinary text), making such attacks more likely to succeed.
5175
5176 @item %u@var{suffix}
5177 Like @samp{%g}, but generates a new temporary file name even if
5178 @samp{%u@var{suffix}} was already seen.
5179
5180 @item %U@var{suffix}
5181 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5182 new one if there is no such last file name.  In the absence of any
5183 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5184 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5185 would involve the generation of two distinct file names, one
5186 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5187 simply substituted with a file name chosen for the previous @samp{%u},
5188 without regard to any appended suffix.
5189
5190 @item %j@var{suffix}
5191 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5192 writable, and if save-temps is off; otherwise, substitute the name
5193 of a temporary file, just like @samp{%u}.  This temporary file is not
5194 meant for communication between processes, but rather as a junk
5195 disposal mechanism.
5196
5197 @item %|@var{suffix}
5198 @itemx %m@var{suffix}
5199 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5200 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5201 all.  These are the two most common ways to instruct a program that it
5202 should read from standard input or write to standard output.  If you
5203 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5204 construct: see for example @file{f/lang-specs.h}.
5205
5206 @item %.@var{SUFFIX}
5207 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5208 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5209 terminated by the next space or %.
5210
5211 @item %w
5212 Marks the argument containing or following the @samp{%w} as the
5213 designated output file of this compilation.  This puts the argument
5214 into the sequence of arguments that @samp{%o} will substitute later.
5215
5216 @item %o
5217 Substitutes the names of all the output files, with spaces
5218 automatically placed around them.  You should write spaces
5219 around the @samp{%o} as well or the results are undefined.
5220 @samp{%o} is for use in the specs for running the linker.
5221 Input files whose names have no recognized suffix are not compiled
5222 at all, but they are included among the output files, so they will
5223 be linked.
5224
5225 @item %O
5226 Substitutes the suffix for object files.  Note that this is
5227 handled specially when it immediately follows @samp{%g, %u, or %U},
5228 because of the need for those to form complete file names.  The
5229 handling is such that @samp{%O} is treated exactly as if it had already
5230 been substituted, except that @samp{%g, %u, and %U} do not currently
5231 support additional @var{suffix} characters following @samp{%O} as they would
5232 following, for example, @samp{.o}.
5233
5234 @item %p
5235 Substitutes the standard macro predefinitions for the
5236 current target machine.  Use this when running @code{cpp}.
5237
5238 @item %P
5239 Like @samp{%p}, but puts @samp{__} before and after the name of each
5240 predefined macro, except for macros that start with @samp{__} or with
5241 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5242 C@.
5243
5244 @item %I
5245 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5246 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5247 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5248 as necessary.
5249
5250 @item %s
5251 Current argument is the name of a library or startup file of some sort.
5252 Search for that file in a standard list of directories and substitute
5253 the full name found.
5254
5255 @item %e@var{str}
5256 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5257 Use this when inconsistent options are detected.
5258
5259 @item %(@var{name})
5260 Substitute the contents of spec string @var{name} at this point.
5261
5262 @item %[@var{name}]
5263 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5264
5265 @item %x@{@var{option}@}
5266 Accumulate an option for @samp{%X}.
5267
5268 @item %X
5269 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5270 spec string.
5271
5272 @item %Y
5273 Output the accumulated assembler options specified by @option{-Wa}.
5274
5275 @item %Z
5276 Output the accumulated preprocessor options specified by @option{-Wp}.
5277
5278 @item %a
5279 Process the @code{asm} spec.  This is used to compute the
5280 switches to be passed to the assembler.
5281
5282 @item %A
5283 Process the @code{asm_final} spec.  This is a spec string for
5284 passing switches to an assembler post-processor, if such a program is
5285 needed.
5286
5287 @item %l
5288 Process the @code{link} spec.  This is the spec for computing the
5289 command line passed to the linker.  Typically it will make use of the
5290 @samp{%L %G %S %D and %E} sequences.
5291
5292 @item %D
5293 Dump out a @option{-L} option for each directory that GCC believes might
5294 contain startup files.  If the target supports multilibs then the
5295 current multilib directory will be prepended to each of these paths.
5296
5297 @item %M
5298 Output the multilib directory with directory separators replaced with
5299 @samp{_}.  If multilib directories are not set, or the multilib directory is
5300 @file{.} then this option emits nothing.
5301
5302 @item %L
5303 Process the @code{lib} spec.  This is a spec string for deciding which
5304 libraries should be included on the command line to the linker.
5305
5306 @item %G
5307 Process the @code{libgcc} spec.  This is a spec string for deciding
5308 which GCC support library should be included on the command line to the linker.
5309
5310 @item %S
5311 Process the @code{startfile} spec.  This is a spec for deciding which
5312 object files should be the first ones passed to the linker.  Typically
5313 this might be a file named @file{crt0.o}.
5314
5315 @item %E
5316 Process the @code{endfile} spec.  This is a spec string that specifies
5317 the last object files that will be passed to the linker.
5318
5319 @item %C
5320 Process the @code{cpp} spec.  This is used to construct the arguments
5321 to be passed to the C preprocessor.
5322
5323 @item %c
5324 Process the @code{signed_char} spec.  This is intended to be used
5325 to tell cpp whether a char is signed.  It typically has the definition:
5326 @smallexample
5327 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5328 @end smallexample
5329
5330 @item %1
5331 Process the @code{cc1} spec.  This is used to construct the options to be
5332 passed to the actual C compiler (@samp{cc1}).
5333
5334 @item %2
5335 Process the @code{cc1plus} spec.  This is used to construct the options to be
5336 passed to the actual C++ compiler (@samp{cc1plus}).
5337
5338 @item %*
5339 Substitute the variable part of a matched option.  See below.
5340 Note that each comma in the substituted string is replaced by
5341 a single space.
5342
5343 @item %<@code{S}
5344 Remove all occurrences of @code{-S} from the command line.  Note---this
5345 command is position dependent.  @samp{%} commands in the spec string
5346 before this one will see @code{-S}, @samp{%} commands in the spec string
5347 after this one will not.
5348
5349 @item %:@var{function}(@var{args})
5350 Call the named function @var{function}, passing it @var{args}.
5351 @var{args} is first processed as a nested spec string, then split
5352 into an argument vector in the usual fashion.  The function returns
5353 a string which is processed as if it had appeared literally as part
5354 of the current spec.
5355
5356 The following built-in spec functions are provided:
5357
5358 @table @code
5359 @item @code{if-exists}
5360 The @code{if-exists} spec function takes one argument, an absolute
5361 pathname to a file.  If the file exists, @code{if-exists} returns the
5362 pathname.  Here is a small example of its usage:
5363
5364 @smallexample
5365 *startfile:
5366 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5367 @end smallexample
5368
5369 @item @code{if-exists-else}
5370 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5371 spec function, except that it takes two arguments.  The first argument is
5372 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5373 returns the pathname.  If it does not exist, it returns the second argument.
5374 This way, @code{if-exists-else} can be used to select one file or another,
5375 based on the existence of the first.  Here is a small example of its usage:
5376
5377 @smallexample 
5378 *startfile:
5379 crt0%O%s %:if-exists(crti%O%s) \
5380 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5381 @end smallexample
5382 @end table 
5383
5384 @item %@{@code{S}@}
5385 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5386 If that switch was not specified, this substitutes nothing.  Note that
5387 the leading dash is omitted when specifying this option, and it is
5388 automatically inserted if the substitution is performed.  Thus the spec
5389 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5390 and would output the command line option @option{-foo}.
5391
5392 @item %W@{@code{S}@}
5393 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5394 deleted on failure.
5395
5396 @item %@{@code{S}*@}
5397 Substitutes all the switches specified to GCC whose names start
5398 with @code{-S}, but which also take an argument.  This is used for
5399 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5400 GCC considers @option{-o foo} as being
5401 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5402 text, including the space.  Thus two arguments would be generated.
5403
5404 @item %@{@code{S}*&@code{T}*@}
5405 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5406 (the order of @code{S} and @code{T} in the spec is not significant).
5407 There can be any number of ampersand-separated variables; for each the
5408 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5409
5410 @item %@{@code{S}:@code{X}@}
5411 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5412
5413 @item %@{!@code{S}:@code{X}@}
5414 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5415
5416 @item %@{@code{S}*:@code{X}@}
5417 Substitutes @code{X} if one or more switches whose names start with
5418 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5419 once, no matter how many such switches appeared.  However, if @code{%*}
5420 appears somewhere in @code{X}, then @code{X} will be substituted once
5421 for each matching switch, with the @code{%*} replaced by the part of
5422 that switch that matched the @code{*}.
5423
5424 @item %@{.@code{S}:@code{X}@}
5425 Substitutes @code{X}, if processing a file with suffix @code{S}.
5426
5427 @item %@{!.@code{S}:@code{X}@}
5428 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5429
5430 @item %@{@code{S}|@code{P}:@code{X}@}
5431 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5432 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5433 although they have a stronger binding than the @samp{|}.  If @code{%*}
5434 appears in @code{X}, all of the alternatives must be starred, and only
5435 the first matching alternative is substituted.
5436
5437 For example, a spec string like this:
5438
5439 @smallexample
5440 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5441 @end smallexample
5442
5443 will output the following command-line options from the following input
5444 command-line options:
5445
5446 @smallexample
5447 fred.c        -foo -baz
5448 jim.d         -bar -boggle
5449 -d fred.c     -foo -baz -boggle
5450 -d jim.d      -bar -baz -boggle
5451 @end smallexample
5452
5453 @item %@{S:X; T:Y; :D@}
5454
5455 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5456 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5457 be as many clauses as you need.  This may be combined with @code{.}, 
5458 @code{!}, @code{|}, and @code{*} as needed.
5459
5460
5461 @end table
5462
5463 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5464 construct may contain other nested @samp{%} constructs or spaces, or
5465 even newlines.  They are processed as usual, as described above.
5466 Trailing white space in @code{X} is ignored.  White space may also
5467 appear anywhere on the left side of the colon in these constructs,
5468 except between @code{.} or @code{*} and the corresponding word.
5469
5470 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5471 handled specifically in these constructs.  If another value of
5472 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5473 @option{-W} switch is found later in the command line, the earlier
5474 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5475 just one letter, which passes all matching options.
5476
5477 The character @samp{|} at the beginning of the predicate text is used to
5478 indicate that a command should be piped to the following command, but
5479 only if @option{-pipe} is specified.
5480
5481 It is built into GCC which switches take arguments and which do not.
5482 (You might think it would be useful to generalize this to allow each
5483 compiler's spec to say which switches take arguments.  But this cannot
5484 be done in a consistent fashion.  GCC cannot even decide which input
5485 files have been specified without knowing which switches take arguments,
5486 and it must know which input files to compile in order to tell which
5487 compilers to run).
5488
5489 GCC also knows implicitly that arguments starting in @option{-l} are to be
5490 treated as compiler output files, and passed to the linker in their
5491 proper position among the other output files.
5492
5493 @c man begin OPTIONS
5494
5495 @node Target Options
5496 @section Specifying Target Machine and Compiler Version
5497 @cindex target options
5498 @cindex cross compiling
5499 @cindex specifying machine version
5500 @cindex specifying compiler version and target machine
5501 @cindex compiler version, specifying
5502 @cindex target machine, specifying
5503
5504 The usual way to run GCC is to run the executable called @file{gcc}, or
5505 @file{<machine>-gcc} when cross-compiling, or
5506 @file{<machine>-gcc-<version>} to run a version other than the one that
5507 was installed last.  Sometimes this is inconvenient, so GCC provides
5508 options that will switch to another cross-compiler or version.
5509
5510 @table @gcctabopt
5511 @item -b @var{machine}
5512 @opindex b
5513 The argument @var{machine} specifies the target machine for compilation.
5514
5515 The value to use for @var{machine} is the same as was specified as the
5516 machine type when configuring GCC as a cross-compiler.  For
5517 example, if a cross-compiler was configured with @samp{configure
5518 i386v}, meaning to compile for an 80386 running System V, then you
5519 would specify @option{-b i386v} to run that cross compiler.
5520
5521 @item -V @var{version}
5522 @opindex V
5523 The argument @var{version} specifies which version of GCC to run.
5524 This is useful when multiple versions are installed.  For example,
5525 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5526 @end table
5527
5528 The @option{-V} and @option{-b} options work by running the
5529 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5530 use them if you can just run that directly.
5531
5532 @node Submodel Options
5533 @section Hardware Models and Configurations
5534 @cindex submodel options
5535 @cindex specifying hardware config
5536 @cindex hardware models and configurations, specifying
5537 @cindex machine dependent options
5538
5539 Earlier we discussed the standard option @option{-b} which chooses among
5540 different installed compilers for completely different target
5541 machines, such as VAX vs.@: 68000 vs.@: 80386.
5542
5543 In addition, each of these target machine types can have its own
5544 special options, starting with @samp{-m}, to choose among various
5545 hardware models or configurations---for example, 68010 vs 68020,
5546 floating coprocessor or none.  A single installed version of the
5547 compiler can compile for any model or configuration, according to the
5548 options specified.
5549
5550 Some configurations of the compiler also support additional special
5551 options, usually for compatibility with other compilers on the same
5552 platform.
5553
5554 These options are defined by the macro @code{TARGET_SWITCHES} in the
5555 machine description.  The default for the options is also defined by
5556 that macro, which enables you to change the defaults.
5557
5558 @menu
5559 * M680x0 Options::
5560 * M68hc1x Options::
5561 * VAX Options::
5562 * SPARC Options::
5563 * ARM Options::
5564 * MN10200 Options::
5565 * MN10300 Options::
5566 * M32R/D Options::
5567 * M88K Options::
5568 * RS/6000 and PowerPC Options::
5569 * Darwin Options::
5570 * RT Options::
5571 * MIPS Options::
5572 * i386 and x86-64 Options::
5573 * HPPA Options::
5574 * Intel 960 Options::
5575 * DEC Alpha Options::
5576 * DEC Alpha/VMS Options::
5577 * H8/300 Options::
5578 * SH Options::
5579 * System V Options::
5580 * TMS320C3x/C4x Options::
5581 * V850 Options::
5582 * ARC Options::
5583 * NS32K Options::
5584 * AVR Options::
5585 * MCore Options::
5586 * IA-64 Options::
5587 * D30V Options::
5588 * S/390 and zSeries Options::
5589 * CRIS Options::
5590 * MMIX Options::
5591 * PDP-11 Options::
5592 * Xstormy16 Options::
5593 * Xtensa Options::
5594 * FRV Options::
5595 @end menu
5596
5597 @node M680x0 Options
5598 @subsection M680x0 Options
5599 @cindex M680x0 options
5600
5601 These are the @samp{-m} options defined for the 68000 series.  The default
5602 values for these options depends on which style of 68000 was selected when
5603 the compiler was configured; the defaults for the most common choices are
5604 given below.
5605
5606 @table @gcctabopt
5607 @item -m68000
5608 @itemx -mc68000
5609 @opindex m68000
5610 @opindex mc68000
5611 Generate output for a 68000.  This is the default
5612 when the compiler is configured for 68000-based systems.
5613
5614 Use this option for microcontrollers with a 68000 or EC000 core,
5615 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5616
5617 @item -m68020
5618 @itemx -mc68020
5619 @opindex m68020
5620 @opindex mc68020
5621 Generate output for a 68020.  This is the default
5622 when the compiler is configured for 68020-based systems.
5623
5624 @item -m68881
5625 @opindex m68881
5626 Generate output containing 68881 instructions for floating point.
5627 This is the default for most 68020 systems unless @option{--nfp} was
5628 specified when the compiler was configured.
5629
5630 @item -m68030
5631 @opindex m68030
5632 Generate output for a 68030.  This is the default when the compiler is
5633 configured for 68030-based systems.
5634
5635 @item -m68040
5636 @opindex m68040
5637 Generate output for a 68040.  This is the default when the compiler is
5638 configured for 68040-based systems.
5639
5640 This option inhibits the use of 68881/68882 instructions that have to be
5641 emulated by software on the 68040.  Use this option if your 68040 does not
5642 have code to emulate those instructions.
5643
5644 @item -m68060
5645 @opindex m68060
5646 Generate output for a 68060.  This is the default when the compiler is
5647 configured for 68060-based systems.
5648
5649 This option inhibits the use of 68020 and 68881/68882 instructions that
5650 have to be emulated by software on the 68060.  Use this option if your 68060
5651 does not have code to emulate those instructions.
5652
5653 @item -mcpu32
5654 @opindex mcpu32
5655 Generate output for a CPU32.  This is the default
5656 when the compiler is configured for CPU32-based systems.
5657
5658 Use this option for microcontrollers with a
5659 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5660 68336, 68340, 68341, 68349 and 68360.
5661
5662 @item -m5200
5663 @opindex m5200
5664 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5665 when the compiler is configured for 520X-based systems.
5666
5667 Use this option for microcontroller with a 5200 core, including
5668 the MCF5202, MCF5203, MCF5204 and MCF5202.
5669
5670
5671 @item -m68020-40
5672 @opindex m68020-40
5673 Generate output for a 68040, without using any of the new instructions.
5674 This results in code which can run relatively efficiently on either a
5675 68020/68881 or a 68030 or a 68040.  The generated code does use the
5676 68881 instructions that are emulated on the 68040.
5677
5678 @item -m68020-60
5679 @opindex m68020-60
5680 Generate output for a 68060, without using any of the new instructions.
5681 This results in code which can run relatively efficiently on either a
5682 68020/68881 or a 68030 or a 68040.  The generated code does use the
5683 68881 instructions that are emulated on the 68060.
5684
5685 @item -mfpa
5686 @opindex mfpa
5687 Generate output containing Sun FPA instructions for floating point.
5688
5689 @item -msoft-float
5690 @opindex msoft-float
5691 Generate output containing library calls for floating point.
5692 @strong{Warning:} the requisite libraries are not available for all m68k
5693 targets.  Normally the facilities of the machine's usual C compiler are
5694 used, but this can't be done directly in cross-compilation.  You must
5695 make your own arrangements to provide suitable library functions for
5696 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5697 @samp{m68k-*-coff} do provide software floating point support.
5698
5699 @item -mshort
5700 @opindex mshort
5701 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5702
5703 @item -mnobitfield
5704 @opindex mnobitfield
5705 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5706 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5707
5708 @item -mbitfield
5709 @opindex mbitfield
5710 Do use the bit-field instructions.  The @option{-m68020} option implies
5711 @option{-mbitfield}.  This is the default if you use a configuration
5712 designed for a 68020.
5713
5714 @item -mrtd
5715 @opindex mrtd
5716 Use a different function-calling convention, in which functions
5717 that take a fixed number of arguments return with the @code{rtd}
5718 instruction, which pops their arguments while returning.  This
5719 saves one instruction in the caller since there is no need to pop
5720 the arguments there.
5721
5722 This calling convention is incompatible with the one normally
5723 used on Unix, so you cannot use it if you need to call libraries
5724 compiled with the Unix compiler.
5725
5726 Also, you must provide function prototypes for all functions that
5727 take variable numbers of arguments (including @code{printf});
5728 otherwise incorrect code will be generated for calls to those
5729 functions.
5730
5731 In addition, seriously incorrect code will result if you call a
5732 function with too many arguments.  (Normally, extra arguments are
5733 harmlessly ignored.)
5734
5735 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5736 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5737
5738 @item -malign-int
5739 @itemx -mno-align-int
5740 @opindex malign-int
5741 @opindex mno-align-int
5742 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5743 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5744 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5745 Aligning variables on 32-bit boundaries produces code that runs somewhat
5746 faster on processors with 32-bit busses at the expense of more memory.
5747
5748 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5749 align structures containing the above types  differently than
5750 most published application binary interface specifications for the m68k.
5751
5752 @item -mpcrel
5753 @opindex mpcrel
5754 Use the pc-relative addressing mode of the 68000 directly, instead of
5755 using a global offset table.  At present, this option implies @option{-fpic},
5756 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5757 not presently supported with @option{-mpcrel}, though this could be supported for
5758 68020 and higher processors.
5759
5760 @item -mno-strict-align
5761 @itemx -mstrict-align
5762 @opindex mno-strict-align
5763 @opindex mstrict-align
5764 Do not (do) assume that unaligned memory references will be handled by
5765 the system.
5766
5767 @end table
5768
5769 @node M68hc1x Options
5770 @subsection M68hc1x Options
5771 @cindex M68hc1x options
5772
5773 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5774 microcontrollers.  The default values for these options depends on
5775 which style of microcontroller was selected when the compiler was configured;
5776 the defaults for the most common choices are given below.
5777
5778 @table @gcctabopt
5779 @item -m6811
5780 @itemx -m68hc11
5781 @opindex m6811
5782 @opindex m68hc11
5783 Generate output for a 68HC11.  This is the default
5784 when the compiler is configured for 68HC11-based systems.
5785
5786 @item -m6812
5787 @itemx -m68hc12
5788 @opindex m6812
5789 @opindex m68hc12
5790 Generate output for a 68HC12.  This is the default
5791 when the compiler is configured for 68HC12-based systems.
5792
5793 @item -m68S12
5794 @itemx -m68hcs12
5795 @opindex m68S12
5796 @opindex m68hcs12
5797 Generate output for a 68HCS12.  
5798
5799 @item -mauto-incdec
5800 @opindex mauto-incdec
5801 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5802 addressing modes.
5803
5804 @item -minmax
5805 @itemx -nominmax
5806 @opindex minmax
5807 @opindex mnominmax
5808 Enable the use of 68HC12 min and max instructions.
5809
5810 @item -mlong-calls
5811 @itemx -mno-long-calls
5812 @opindex mlong-calls
5813 @opindex mno-long-calls
5814 Treat all calls as being far away (near).  If calls are assumed to be
5815 far away, the compiler will use the @code{call} instruction to
5816 call a function and the @code{rtc} instruction for returning.
5817
5818 @item -mshort
5819 @opindex mshort
5820 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5821
5822 @item -msoft-reg-count=@var{count}
5823 @opindex msoft-reg-count
5824 Specify the number of pseudo-soft registers which are used for the
5825 code generation.  The maximum number is 32.  Using more pseudo-soft
5826 register may or may not result in better code depending on the program.
5827 The default is 4 for 68HC11 and 2 for 68HC12.
5828
5829 @end table
5830
5831 @node VAX Options
5832 @subsection VAX Options
5833 @cindex VAX options
5834
5835 These @samp{-m} options are defined for the VAX:
5836
5837 @table @gcctabopt
5838 @item -munix
5839 @opindex munix
5840 Do not output certain jump instructions (@code{aobleq} and so on)
5841 that the Unix assembler for the VAX cannot handle across long
5842 ranges.
5843
5844 @item -mgnu
5845 @opindex mgnu
5846 Do output those jump instructions, on the assumption that you
5847 will assemble with the GNU assembler.
5848
5849 @item -mg
5850 @opindex mg
5851 Output code for g-format floating point numbers instead of d-format.
5852 @end table
5853
5854 @node SPARC Options
5855 @subsection SPARC Options
5856 @cindex SPARC options
5857
5858 These @samp{-m} switches are supported on the SPARC:
5859
5860 @table @gcctabopt
5861 @item -mno-app-regs
5862 @itemx -mapp-regs
5863 @opindex mno-app-regs
5864 @opindex mapp-regs
5865 Specify @option{-mapp-regs} to generate output using the global registers
5866 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5867 is the default.
5868
5869 To be fully SVR4 ABI compliant at the cost of some performance loss,
5870 specify @option{-mno-app-regs}.  You should compile libraries and system
5871 software with this option.
5872
5873 @item -mfpu
5874 @itemx -mhard-float
5875 @opindex mfpu
5876 @opindex mhard-float
5877 Generate output containing floating point instructions.  This is the
5878 default.
5879
5880 @item -mno-fpu
5881 @itemx -msoft-float
5882 @opindex mno-fpu
5883 @opindex msoft-float
5884 Generate output containing library calls for floating point.
5885 @strong{Warning:} the requisite libraries are not available for all SPARC
5886 targets.  Normally the facilities of the machine's usual C compiler are
5887 used, but this cannot be done directly in cross-compilation.  You must make
5888 your own arrangements to provide suitable library functions for
5889 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5890 @samp{sparclite-*-*} do provide software floating point support.
5891
5892 @option{-msoft-float} changes the calling convention in the output file;
5893 therefore, it is only useful if you compile @emph{all} of a program with
5894 this option.  In particular, you need to compile @file{libgcc.a}, the
5895 library that comes with GCC, with @option{-msoft-float} in order for
5896 this to work.
5897
5898 @item -mhard-quad-float
5899 @opindex mhard-quad-float
5900 Generate output containing quad-word (long double) floating point
5901 instructions.
5902
5903 @item -msoft-quad-float
5904 @opindex msoft-quad-float
5905 Generate output containing library calls for quad-word (long double)
5906 floating point instructions.  The functions called are those specified
5907 in the SPARC ABI@.  This is the default.
5908
5909 As of this writing, there are no sparc implementations that have hardware
5910 support for the quad-word floating point instructions.  They all invoke
5911 a trap handler for one of these instructions, and then the trap handler
5912 emulates the effect of the instruction.  Because of the trap handler overhead,
5913 this is much slower than calling the ABI library routines.  Thus the
5914 @option{-msoft-quad-float} option is the default.
5915
5916 @item -mno-flat
5917 @itemx -mflat
5918 @opindex mno-flat
5919 @opindex mflat
5920 With @option{-mflat}, the compiler does not generate save/restore instructions
5921 and will use a ``flat'' or single register window calling convention.
5922 This model uses %i7 as the frame pointer and is compatible with the normal
5923 register window model.  Code from either may be intermixed.
5924 The local registers and the input registers (0--5) are still treated as
5925 ``call saved'' registers and will be saved on the stack as necessary.
5926
5927 With @option{-mno-flat} (the default), the compiler emits save/restore
5928 instructions (except for leaf functions) and is the normal mode of operation.
5929
5930 @item -mno-unaligned-doubles
5931 @itemx -munaligned-doubles
5932 @opindex mno-unaligned-doubles
5933 @opindex munaligned-doubles
5934 Assume that doubles have 8 byte alignment.  This is the default.
5935
5936 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5937 alignment only if they are contained in another type, or if they have an
5938 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5939 Specifying this option avoids some rare compatibility problems with code
5940 generated by other compilers.  It is not the default because it results
5941 in a performance loss, especially for floating point code.
5942
5943 @item -mno-faster-structs
5944 @itemx -mfaster-structs
5945 @opindex mno-faster-structs
5946 @opindex mfaster-structs
5947 With @option{-mfaster-structs}, the compiler assumes that structures
5948 should have 8 byte alignment.  This enables the use of pairs of
5949 @code{ldd} and @code{std} instructions for copies in structure
5950 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5951 However, the use of this changed alignment directly violates the SPARC
5952 ABI@.  Thus, it's intended only for use on targets where the developer
5953 acknowledges that their resulting code will not be directly in line with
5954 the rules of the ABI@.
5955
5956 @item -mv8
5957 @itemx -msparclite
5958 @opindex mv8
5959 @opindex msparclite
5960 These two options select variations on the SPARC architecture.
5961
5962 By default (unless specifically configured for the Fujitsu SPARClite),
5963 GCC generates code for the v7 variant of the SPARC architecture.
5964
5965 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5966 code is that the compiler emits the integer multiply and integer
5967 divide instructions which exist in SPARC v8 but not in SPARC v7.
5968
5969 @option{-msparclite} will give you SPARClite code.  This adds the integer
5970 multiply, integer divide step and scan (@code{ffs}) instructions which
5971 exist in SPARClite but not in SPARC v7.
5972
5973 These options are deprecated and will be deleted in a future GCC release.
5974 They have been replaced with @option{-mcpu=xxx}.
5975
5976 @item -mcypress
5977 @itemx -msupersparc
5978 @opindex mcypress
5979 @opindex msupersparc
5980 These two options select the processor for which the code is optimized.
5981
5982 With @option{-mcypress} (the default), the compiler optimizes code for the
5983 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5984 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5985
5986 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5987 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5988 of the full SPARC v8 instruction set.
5989
5990 These options are deprecated and will be deleted in a future GCC release.
5991 They have been replaced with @option{-mcpu=xxx}.
5992
5993 @item -mcpu=@var{cpu_type}
5994 @opindex mcpu
5995 Set the instruction set, register set, and instruction scheduling parameters
5996 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5997 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5998 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5999 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6000 @samp{ultrasparc3}.
6001
6002 Default instruction scheduling parameters are used for values that select
6003 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6004 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6005
6006 Here is a list of each supported architecture and their supported
6007 implementations.
6008
6009 @smallexample
6010     v7:             cypress
6011     v8:             supersparc, hypersparc
6012     sparclite:      f930, f934, sparclite86x
6013     sparclet:       tsc701
6014     v9:             ultrasparc, ultrasparc3
6015 @end smallexample
6016
6017 @item -mtune=@var{cpu_type}
6018 @opindex mtune
6019 Set the instruction scheduling parameters for machine type
6020 @var{cpu_type}, but do not set the instruction set or register set that the
6021 option @option{-mcpu=@var{cpu_type}} would.
6022
6023 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6024 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6025 that select a particular cpu implementation.  Those are @samp{cypress},
6026 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6027 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6028 @samp{ultrasparc3}.
6029
6030 @end table
6031
6032 These @samp{-m} switches are supported in addition to the above
6033 on the SPARCLET processor.
6034
6035 @table @gcctabopt
6036 @item -mlittle-endian
6037 @opindex mlittle-endian
6038 Generate code for a processor running in little-endian mode.
6039
6040 @item -mlive-g0
6041 @opindex mlive-g0
6042 Treat register @code{%g0} as a normal register.
6043 GCC will continue to clobber it as necessary but will not assume
6044 it always reads as 0.
6045
6046 @item -mbroken-saverestore
6047 @opindex mbroken-saverestore
6048 Generate code that does not use non-trivial forms of the @code{save} and
6049 @code{restore} instructions.  Early versions of the SPARCLET processor do
6050 not correctly handle @code{save} and @code{restore} instructions used with
6051 arguments.  They correctly handle them used without arguments.  A @code{save}
6052 instruction used without arguments increments the current window pointer
6053 but does not allocate a new stack frame.  It is assumed that the window
6054 overflow trap handler will properly handle this case as will interrupt
6055 handlers.
6056 @end table
6057
6058 These @samp{-m} switches are supported in addition to the above
6059 on SPARC V9 processors in 64-bit environments.
6060
6061 @table @gcctabopt
6062 @item -mlittle-endian
6063 @opindex mlittle-endian
6064 Generate code for a processor running in little-endian mode.
6065
6066 @item -m32
6067 @itemx -m64
6068 @opindex m32
6069 @opindex m64
6070 Generate code for a 32-bit or 64-bit environment.
6071 The 32-bit environment sets int, long and pointer to 32 bits.
6072 The 64-bit environment sets int to 32 bits and long and pointer
6073 to 64 bits.
6074
6075 @item -mcmodel=medlow
6076 @opindex mcmodel=medlow
6077 Generate code for the Medium/Low code model: the program must be linked
6078 in the low 32 bits of the address space.  Pointers are 64 bits.
6079 Programs can be statically or dynamically linked.
6080
6081 @item -mcmodel=medmid
6082 @opindex mcmodel=medmid
6083 Generate code for the Medium/Middle code model: the program must be linked
6084 in the low 44 bits of the address space, the text segment must be less than
6085 2G bytes, and data segment must be within 2G of the text segment.
6086 Pointers are 64 bits.
6087
6088 @item -mcmodel=medany
6089 @opindex mcmodel=medany
6090 Generate code for the Medium/Anywhere code model: the program may be linked
6091 anywhere in the address space, the text segment must be less than
6092 2G bytes, and data segment must be within 2G of the text segment.
6093 Pointers are 64 bits.
6094
6095 @item -mcmodel=embmedany
6096 @opindex mcmodel=embmedany
6097 Generate code for the Medium/Anywhere code model for embedded systems:
6098 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6099 (determined at link time).  Register %g4 points to the base of the
6100 data segment.  Pointers are still 64 bits.
6101 Programs are statically linked, PIC is not supported.
6102
6103 @item -mstack-bias
6104 @itemx -mno-stack-bias
6105 @opindex mstack-bias
6106 @opindex mno-stack-bias
6107 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6108 frame pointer if present, are offset by @minus{}2047 which must be added back
6109 when making stack frame references.
6110 Otherwise, assume no such offset is present.
6111 @end table
6112
6113 @node ARM Options
6114 @subsection ARM Options
6115 @cindex ARM options
6116
6117 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6118 architectures:
6119
6120 @table @gcctabopt
6121 @item -mapcs-frame
6122 @opindex mapcs-frame
6123 Generate a stack frame that is compliant with the ARM Procedure Call
6124 Standard for all functions, even if this is not strictly necessary for
6125 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6126 with this option will cause the stack frames not to be generated for
6127 leaf functions.  The default is @option{-mno-apcs-frame}.
6128
6129 @item -mapcs
6130 @opindex mapcs
6131 This is a synonym for @option{-mapcs-frame}.
6132
6133 @item -mapcs-26
6134 @opindex mapcs-26
6135 Generate code for a processor running with a 26-bit program counter,
6136 and conforming to the function calling standards for the APCS 26-bit
6137 option.  This option replaces the @option{-m2} and @option{-m3} options
6138 of previous releases of the compiler.
6139
6140 @item -mapcs-32
6141 @opindex mapcs-32
6142 Generate code for a processor running with a 32-bit program counter,
6143 and conforming to the function calling standards for the APCS 32-bit
6144 option.  This option replaces the @option{-m6} option of previous releases
6145 of the compiler.
6146
6147 @ignore
6148 @c not currently implemented
6149 @item -mapcs-stack-check
6150 @opindex mapcs-stack-check
6151 Generate code to check the amount of stack space available upon entry to
6152 every function (that actually uses some stack space).  If there is
6153 insufficient space available then either the function
6154 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6155 called, depending upon the amount of stack space required.  The run time
6156 system is required to provide these functions.  The default is
6157 @option{-mno-apcs-stack-check}, since this produces smaller code.
6158
6159 @c not currently implemented
6160 @item -mapcs-float
6161 @opindex mapcs-float
6162 Pass floating point arguments using the float point registers.  This is
6163 one of the variants of the APCS@.  This option is recommended if the
6164 target hardware has a floating point unit or if a lot of floating point
6165 arithmetic is going to be performed by the code.  The default is
6166 @option{-mno-apcs-float}, since integer only code is slightly increased in
6167 size if @option{-mapcs-float} is used.
6168
6169 @c not currently implemented
6170 @item -mapcs-reentrant
6171 @opindex mapcs-reentrant
6172 Generate reentrant, position independent code.  The default is
6173 @option{-mno-apcs-reentrant}.
6174 @end ignore
6175
6176 @item -mthumb-interwork
6177 @opindex mthumb-interwork
6178 Generate code which supports calling between the ARM and Thumb
6179 instruction sets.  Without this option the two instruction sets cannot
6180 be reliably used inside one program.  The default is
6181 @option{-mno-thumb-interwork}, since slightly larger code is generated
6182 when @option{-mthumb-interwork} is specified.
6183
6184 @item -mno-sched-prolog
6185 @opindex mno-sched-prolog
6186 Prevent the reordering of instructions in the function prolog, or the
6187 merging of those instruction with the instructions in the function's
6188 body.  This means that all functions will start with a recognizable set
6189 of instructions (or in fact one of a choice from a small set of
6190 different function prologues), and this information can be used to
6191 locate the start if functions inside an executable piece of code.  The
6192 default is @option{-msched-prolog}.
6193
6194 @item -mhard-float
6195 @opindex mhard-float
6196 Generate output containing floating point instructions.  This is the
6197 default.
6198
6199 @item -msoft-float
6200 @opindex msoft-float
6201 Generate output containing library calls for floating point.
6202 @strong{Warning:} the requisite libraries are not available for all ARM
6203 targets.  Normally the facilities of the machine's usual C compiler are
6204 used, but this cannot be done directly in cross-compilation.  You must make
6205 your own arrangements to provide suitable library functions for
6206 cross-compilation.
6207
6208 @option{-msoft-float} changes the calling convention in the output file;
6209 therefore, it is only useful if you compile @emph{all} of a program with
6210 this option.  In particular, you need to compile @file{libgcc.a}, the
6211 library that comes with GCC, with @option{-msoft-float} in order for
6212 this to work.
6213
6214 @item -mlittle-endian
6215 @opindex mlittle-endian
6216 Generate code for a processor running in little-endian mode.  This is
6217 the default for all standard configurations.
6218
6219 @item -mbig-endian
6220 @opindex mbig-endian
6221 Generate code for a processor running in big-endian mode; the default is
6222 to compile code for a little-endian processor.
6223
6224 @item -mwords-little-endian
6225 @opindex mwords-little-endian
6226 This option only applies when generating code for big-endian processors.
6227 Generate code for a little-endian word order but a big-endian byte
6228 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6229 option should only be used if you require compatibility with code for
6230 big-endian ARM processors generated by versions of the compiler prior to
6231 2.8.
6232
6233 @item -malignment-traps
6234 @opindex malignment-traps
6235 Generate code that will not trap if the MMU has alignment traps enabled.
6236 On ARM architectures prior to ARMv4, there were no instructions to
6237 access half-word objects stored in memory.  However, when reading from
6238 memory a feature of the ARM architecture allows a word load to be used,
6239 even if the address is unaligned, and the processor core will rotate the
6240 data as it is being loaded.  This option tells the compiler that such
6241 misaligned accesses will cause a MMU trap and that it should instead
6242 synthesize the access as a series of byte accesses.  The compiler can
6243 still use word accesses to load half-word data if it knows that the
6244 address is aligned to a word boundary.
6245
6246 This option is ignored when compiling for ARM architecture 4 or later,
6247 since these processors have instructions to directly access half-word
6248 objects in memory.
6249
6250 @item -mno-alignment-traps
6251 @opindex mno-alignment-traps
6252 Generate code that assumes that the MMU will not trap unaligned
6253 accesses.  This produces better code when the target instruction set
6254 does not have half-word memory operations (i.e.@: implementations prior to
6255 ARMv4).
6256
6257 Note that you cannot use this option to access unaligned word objects,
6258 since the processor will only fetch one 32-bit aligned object from
6259 memory.
6260
6261 The default setting for most targets is @option{-mno-alignment-traps}, since
6262 this produces better code when there are no half-word memory
6263 instructions available.
6264
6265 @item -mshort-load-bytes
6266 @itemx -mno-short-load-words
6267 @opindex mshort-load-bytes
6268 @opindex mno-short-load-words
6269 These are deprecated aliases for @option{-malignment-traps}.
6270
6271 @item -mno-short-load-bytes
6272 @itemx -mshort-load-words
6273 @opindex mno-short-load-bytes
6274 @opindex mshort-load-words
6275 This are deprecated aliases for @option{-mno-alignment-traps}.
6276
6277 @item -mcpu=@var{name}
6278 @opindex mcpu
6279 This specifies the name of the target ARM processor.  GCC uses this name
6280 to determine what kind of instructions it can emit when generating
6281 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6282 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6283 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6284 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6285 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6286 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6287 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6288 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6289 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6290 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6291
6292 @itemx -mtune=@var{name}
6293 @opindex mtune
6294 This option is very similar to the @option{-mcpu=} option, except that
6295 instead of specifying the actual target processor type, and hence
6296 restricting which instructions can be used, it specifies that GCC should
6297 tune the performance of the code as if the target were of the type
6298 specified in this option, but still choosing the instructions that it
6299 will generate based on the cpu specified by a @option{-mcpu=} option.
6300 For some ARM implementations better performance can be obtained by using
6301 this option.
6302
6303 @item -march=@var{name}
6304 @opindex march
6305 This specifies the name of the target ARM architecture.  GCC uses this
6306 name to determine what kind of instructions it can emit when generating
6307 assembly code.  This option can be used in conjunction with or instead
6308 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6309 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6310 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6311
6312 @item -mfpe=@var{number}
6313 @itemx -mfp=@var{number}
6314 @opindex mfpe
6315 @opindex mfp
6316 This specifies the version of the floating point emulation available on
6317 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6318 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6319
6320 @item -mstructure-size-boundary=@var{n}
6321 @opindex mstructure-size-boundary
6322 The size of all structures and unions will be rounded up to a multiple
6323 of the number of bits set by this option.  Permissible values are 8 and
6324 32.  The default value varies for different toolchains.  For the COFF
6325 targeted toolchain the default value is 8.  Specifying the larger number
6326 can produce faster, more efficient code, but can also increase the size
6327 of the program.  The two values are potentially incompatible.  Code
6328 compiled with one value cannot necessarily expect to work with code or
6329 libraries compiled with the other value, if they exchange information
6330 using structures or unions.
6331
6332 @item -mabort-on-noreturn
6333 @opindex mabort-on-noreturn
6334 Generate a call to the function @code{abort} at the end of a
6335 @code{noreturn} function.  It will be executed if the function tries to
6336 return.
6337
6338 @item -mlong-calls
6339 @itemx -mno-long-calls
6340 @opindex mlong-calls
6341 @opindex mno-long-calls
6342 Tells the compiler to perform function calls by first loading the
6343 address of the function into a register and then performing a subroutine
6344 call on this register.  This switch is needed if the target function
6345 will lie outside of the 64 megabyte addressing range of the offset based
6346 version of subroutine call instruction.
6347
6348 Even if this switch is enabled, not all function calls will be turned
6349 into long calls.  The heuristic is that static functions, functions
6350 which have the @samp{short-call} attribute, functions that are inside
6351 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6352 definitions have already been compiled within the current compilation
6353 unit, will not be turned into long calls.  The exception to this rule is
6354 that weak function definitions, functions with the @samp{long-call}
6355 attribute or the @samp{section} attribute, and functions that are within
6356 the scope of a @samp{#pragma long_calls} directive, will always be
6357 turned into long calls.
6358
6359 This feature is not enabled by default.  Specifying
6360 @option{-mno-long-calls} will restore the default behavior, as will
6361 placing the function calls within the scope of a @samp{#pragma
6362 long_calls_off} directive.  Note these switches have no effect on how
6363 the compiler generates code to handle function calls via function
6364 pointers.
6365
6366 @item -mnop-fun-dllimport
6367 @opindex mnop-fun-dllimport
6368 Disable support for the @code{dllimport} attribute.
6369
6370 @item -msingle-pic-base
6371 @opindex msingle-pic-base
6372 Treat the register used for PIC addressing as read-only, rather than
6373 loading it in the prologue for each function.  The run-time system is
6374 responsible for initializing this register with an appropriate value
6375 before execution begins.
6376
6377 @item -mpic-register=@var{reg}
6378 @opindex mpic-register
6379 Specify the register to be used for PIC addressing.  The default is R10
6380 unless stack-checking is enabled, when R9 is used.
6381
6382 @item -mcirrus-fix-invalid-insns
6383 @opindex -mcirrus-fix-invalid-insns
6384 @opindex -mno-cirrus-fix-invalid-insns
6385 Insert NOPs into the instruction stream to in order to work around
6386 problems with invalid Maverick instruction combinations.  This option
6387 is only valid if the @option{-mcpu=ep9312} option has been used to
6388 enable generation of instructions for the Cirrus Maverick floating
6389 point co-processor.  This option is not enabled by default, since the
6390 problem is only present in older Maverick implementations.  The default
6391 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6392 switch.
6393
6394 @item -mpoke-function-name
6395 @opindex mpoke-function-name
6396 Write the name of each function into the text section, directly
6397 preceding the function prologue.  The generated code is similar to this:
6398
6399 @smallexample
6400      t0
6401          .ascii "arm_poke_function_name", 0
6402          .align
6403      t1
6404          .word 0xff000000 + (t1 - t0)
6405      arm_poke_function_name
6406          mov     ip, sp
6407          stmfd   sp!, @{fp, ip, lr, pc@}
6408          sub     fp, ip, #4
6409 @end smallexample
6410
6411 When performing a stack backtrace, code can inspect the value of
6412 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6413 location @code{pc - 12} and the top 8 bits are set, then we know that
6414 there is a function name embedded immediately preceding this location
6415 and has length @code{((pc[-3]) & 0xff000000)}.
6416
6417 @item -mthumb
6418 @opindex mthumb
6419 Generate code for the 16-bit Thumb instruction set.  The default is to
6420 use the 32-bit ARM instruction set.
6421
6422 @item -mtpcs-frame
6423 @opindex mtpcs-frame
6424 Generate a stack frame that is compliant with the Thumb Procedure Call
6425 Standard for all non-leaf functions.  (A leaf function is one that does
6426 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6427
6428 @item -mtpcs-leaf-frame
6429 @opindex mtpcs-leaf-frame
6430 Generate a stack frame that is compliant with the Thumb Procedure Call
6431 Standard for all leaf functions.  (A leaf function is one that does
6432 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6433
6434 @item -mcallee-super-interworking
6435 @opindex mcallee-super-interworking
6436 Gives all externally visible functions in the file being compiled an ARM
6437 instruction set header which switches to Thumb mode before executing the
6438 rest of the function.  This allows these functions to be called from
6439 non-interworking code.
6440
6441 @item -mcaller-super-interworking
6442 @opindex mcaller-super-interworking
6443 Allows calls via function pointers (including virtual functions) to
6444 execute correctly regardless of whether the target code has been
6445 compiled for interworking or not.  There is a small overhead in the cost
6446 of executing a function pointer if this option is enabled.
6447
6448 @end table
6449
6450 @node MN10200 Options
6451 @subsection MN10200 Options
6452 @cindex MN10200 options
6453
6454 These @option{-m} options are defined for Matsushita MN10200 architectures:
6455 @table @gcctabopt
6456
6457 @item -mrelax
6458 @opindex mrelax
6459 Indicate to the linker that it should perform a relaxation optimization pass
6460 to shorten branches, calls and absolute memory addresses.  This option only
6461 has an effect when used on the command line for the final link step.
6462
6463 This option makes symbolic debugging impossible.
6464 @end table
6465
6466 @node MN10300 Options
6467 @subsection MN10300 Options
6468 @cindex MN10300 options
6469
6470 These @option{-m} options are defined for Matsushita MN10300 architectures:
6471
6472 @table @gcctabopt
6473 @item -mmult-bug
6474 @opindex mmult-bug
6475 Generate code to avoid bugs in the multiply instructions for the MN10300
6476 processors.  This is the default.
6477
6478 @item -mno-mult-bug
6479 @opindex mno-mult-bug
6480 Do not generate code to avoid bugs in the multiply instructions for the
6481 MN10300 processors.
6482
6483 @item -mam33
6484 @opindex mam33
6485 Generate code which uses features specific to the AM33 processor.
6486
6487 @item -mno-am33
6488 @opindex mno-am33
6489 Do not generate code which uses features specific to the AM33 processor.  This
6490 is the default.
6491
6492 @item -mno-crt0
6493 @opindex mno-crt0
6494 Do not link in the C run-time initialization object file.
6495
6496 @item -mrelax
6497 @opindex mrelax
6498 Indicate to the linker that it should perform a relaxation optimization pass
6499 to shorten branches, calls and absolute memory addresses.  This option only
6500 has an effect when used on the command line for the final link step.
6501
6502 This option makes symbolic debugging impossible.
6503 @end table
6504
6505
6506 @node M32R/D Options
6507 @subsection M32R/D Options
6508 @cindex M32R/D options
6509
6510 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6511
6512 @table @gcctabopt
6513 @item -m32rx
6514 @opindex m32rx
6515 Generate code for the M32R/X@.
6516
6517 @item -m32r
6518 @opindex m32r
6519 Generate code for the M32R@.  This is the default.
6520
6521 @item -mcode-model=small
6522 @opindex mcode-model=small
6523 Assume all objects live in the lower 16MB of memory (so that their addresses
6524 can be loaded with the @code{ld24} instruction), and assume all subroutines
6525 are reachable with the @code{bl} instruction.
6526 This is the default.
6527
6528 The addressability of a particular object can be set with the
6529 @code{model} attribute.
6530
6531 @item -mcode-model=medium
6532 @opindex mcode-model=medium
6533 Assume objects may be anywhere in the 32-bit address space (the compiler
6534 will generate @code{seth/add3} instructions to load their addresses), and
6535 assume all subroutines are reachable with the @code{bl} instruction.
6536
6537 @item -mcode-model=large
6538 @opindex mcode-model=large
6539 Assume objects may be anywhere in the 32-bit address space (the compiler
6540 will generate @code{seth/add3} instructions to load their addresses), and
6541 assume subroutines may not be reachable with the @code{bl} instruction
6542 (the compiler will generate the much slower @code{seth/add3/jl}
6543 instruction sequence).
6544
6545 @item -msdata=none
6546 @opindex msdata=none
6547 Disable use of the small data area.  Variables will be put into
6548 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6549 @code{section} attribute has been specified).
6550 This is the default.
6551
6552 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6553 Objects may be explicitly put in the small data area with the
6554 @code{section} attribute using one of these sections.
6555
6556 @item -msdata=sdata
6557 @opindex msdata=sdata
6558 Put small global and static data in the small data area, but do not
6559 generate special code to reference them.
6560
6561 @item -msdata=use
6562 @opindex msdata=use
6563 Put small global and static data in the small data area, and generate
6564 special instructions to reference them.
6565
6566 @item -G @var{num}
6567 @opindex G
6568 @cindex smaller data references
6569 Put global and static objects less than or equal to @var{num} bytes
6570 into the small data or bss sections instead of the normal data or bss
6571 sections.  The default value of @var{num} is 8.
6572 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6573 for this option to have any effect.
6574
6575 All modules should be compiled with the same @option{-G @var{num}} value.
6576 Compiling with different values of @var{num} may or may not work; if it
6577 doesn't the linker will give an error message---incorrect code will not be
6578 generated.
6579
6580 @end table
6581
6582 @node M88K Options
6583 @subsection M88K Options
6584 @cindex M88k options
6585
6586 These @samp{-m} options are defined for Motorola 88k architectures:
6587
6588 @table @gcctabopt
6589 @item -m88000
6590 @opindex m88000
6591 Generate code that works well on both the m88100 and the
6592 m88110.
6593
6594 @item -m88100
6595 @opindex m88100
6596 Generate code that works best for the m88100, but that also
6597 runs on the m88110.
6598
6599 @item -m88110
6600 @opindex m88110
6601 Generate code that works best for the m88110, and may not run
6602 on the m88100.
6603
6604 @item -mbig-pic
6605 @opindex mbig-pic
6606 Obsolete option to be removed from the next revision.
6607 Use @option{-fPIC}.
6608
6609 @item -midentify-revision
6610 @opindex midentify-revision
6611 @cindex identifying source, compiler (88k)
6612 Include an @code{ident} directive in the assembler output recording the
6613 source file name, compiler name and version, timestamp, and compilation
6614 flags used.
6615
6616 @item -mno-underscores
6617 @opindex mno-underscores
6618 @cindex underscores, avoiding (88k)
6619 In assembler output, emit symbol names without adding an underscore
6620 character at the beginning of each name.  The default is to use an
6621 underscore as prefix on each name.
6622
6623 @item -mocs-debug-info
6624 @itemx -mno-ocs-debug-info
6625 @opindex mocs-debug-info
6626 @opindex mno-ocs-debug-info
6627 @cindex OCS (88k)
6628 @cindex debugging, 88k OCS
6629 Include (or omit) additional debugging information (about registers used
6630 in each stack frame) as specified in the 88open Object Compatibility
6631 Standard, ``OCS''@.  This extra information allows debugging of code that
6632 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6633 SVr3.2 is to include this information; other 88k configurations omit this
6634 information by default.
6635
6636 @item -mocs-frame-position
6637 @opindex mocs-frame-position
6638 @cindex register positions in frame (88k)
6639 When emitting COFF debugging information for automatic variables and
6640 parameters stored on the stack, use the offset from the canonical frame
6641 address, which is the stack pointer (register 31) on entry to the
6642 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6643 @option{-mocs-frame-position}; other 88k configurations have the default
6644 @option{-mno-ocs-frame-position}.
6645
6646 @item -mno-ocs-frame-position
6647 @opindex mno-ocs-frame-position
6648 @cindex register positions in frame (88k)
6649 When emitting COFF debugging information for automatic variables and
6650 parameters stored on the stack, use the offset from the frame pointer
6651 register (register 30).  When this option is in effect, the frame
6652 pointer is not eliminated when debugging information is selected by the
6653 -g switch.
6654
6655 @item -moptimize-arg-area
6656 @opindex moptimize-arg-area
6657 @cindex arguments in frame (88k)
6658 Save space by reorganizing the stack frame.  This option generates code
6659 that does not agree with the 88open specifications, but uses less
6660 memory.
6661
6662 @itemx -mno-optimize-arg-area
6663 @opindex mno-optimize-arg-area
6664 Do not reorganize the stack frame to save space.  This is the default.
6665 The generated conforms to the specification, but uses more memory.
6666
6667 @item -mshort-data-@var{num}
6668 @opindex mshort-data
6669 @cindex smaller data references (88k)
6670 @cindex r0-relative references (88k)
6671 Generate smaller data references by making them relative to @code{r0},
6672 which allows loading a value using a single instruction (rather than the
6673 usual two).  You control which data references are affected by
6674 specifying @var{num} with this option.  For example, if you specify
6675 @option{-mshort-data-512}, then the data references affected are those
6676 involving displacements of less than 512 bytes.
6677 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6678 than 64k.
6679
6680 @item -mserialize-volatile
6681 @opindex mserialize-volatile
6682 @itemx -mno-serialize-volatile
6683 @opindex mno-serialize-volatile
6684 @cindex sequential consistency on 88k
6685 Do, or don't, generate code to guarantee sequential consistency
6686 of volatile memory references.  By default, consistency is
6687 guaranteed.
6688
6689 The order of memory references made by the MC88110 processor does
6690 not always match the order of the instructions requesting those
6691 references.  In particular, a load instruction may execute before
6692 a preceding store instruction.  Such reordering violates
6693 sequential consistency of volatile memory references, when there
6694 are multiple processors.   When consistency must be guaranteed,
6695 GCC generates special instructions, as needed, to force
6696 execution in the proper order.
6697
6698 The MC88100 processor does not reorder memory references and so
6699 always provides sequential consistency.  However, by default, GCC
6700 generates the special instructions to guarantee consistency
6701 even when you use @option{-m88100}, so that the code may be run on an
6702 MC88110 processor.  If you intend to run your code only on the
6703 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6704
6705 The extra code generated to guarantee consistency may affect the
6706 performance of your application.  If you know that you can safely
6707 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6708
6709 @item -msvr4
6710 @itemx -msvr3
6711 @opindex msvr4
6712 @opindex msvr3
6713 @cindex assembler syntax, 88k
6714 @cindex SVr4
6715 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6716 related to System V release 4 (SVr4).  This controls the following:
6717
6718 @enumerate
6719 @item
6720 Which variant of the assembler syntax to emit.
6721 @item
6722 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6723 that is used on System V release 4.
6724 @item
6725 @option{-msvr4} makes GCC issue additional declaration directives used in
6726 SVr4.
6727 @end enumerate
6728
6729 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6730 @option{-msvr3} is the default for all other m88k configurations.
6731
6732 @item -mversion-03.00
6733 @opindex mversion-03.00
6734 This option is obsolete, and is ignored.
6735 @c ??? which asm syntax better for GAS?  option there too?
6736
6737 @item -mno-check-zero-division
6738 @itemx -mcheck-zero-division
6739 @opindex mno-check-zero-division
6740 @opindex mcheck-zero-division
6741 @cindex zero division on 88k
6742 Do, or don't, generate code to guarantee that integer division by
6743 zero will be detected.  By default, detection is guaranteed.
6744
6745 Some models of the MC88100 processor fail to trap upon integer
6746 division by zero under certain conditions.  By default, when
6747 compiling code that might be run on such a processor, GCC
6748 generates code that explicitly checks for zero-valued divisors
6749 and traps with exception number 503 when one is detected.  Use of
6750 @option{-mno-check-zero-division} suppresses such checking for code
6751 generated to run on an MC88100 processor.
6752
6753 GCC assumes that the MC88110 processor correctly detects all instances
6754 of integer division by zero.  When @option{-m88110} is specified, no
6755 explicit checks for zero-valued divisors are generated, and both
6756 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6757 ignored.
6758
6759 @item -muse-div-instruction
6760 @opindex muse-div-instruction
6761 @cindex divide instruction, 88k
6762 Use the div instruction for signed integer division on the
6763 MC88100 processor.  By default, the div instruction is not used.
6764
6765 On the MC88100 processor the signed integer division instruction
6766 div) traps to the operating system on a negative operand.  The
6767 operating system transparently completes the operation, but at a
6768 large cost in execution time.  By default, when compiling code
6769 that might be run on an MC88100 processor, GCC emulates signed
6770 integer division using the unsigned integer division instruction
6771 divu), thereby avoiding the large penalty of a trap to the
6772 operating system.  Such emulation has its own, smaller, execution
6773 cost in both time and space.  To the extent that your code's
6774 important signed integer division operations are performed on two
6775 nonnegative operands, it may be desirable to use the div
6776 instruction directly.
6777
6778 On the MC88110 processor the div instruction (also known as the
6779 divs instruction) processes negative operands without trapping to
6780 the operating system.  When @option{-m88110} is specified,
6781 @option{-muse-div-instruction} is ignored, and the div instruction is used
6782 for signed integer division.
6783
6784 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6785 particular, the behavior of such a division with and without
6786 @option{-muse-div-instruction} may differ.
6787
6788 @item -mtrap-large-shift
6789 @itemx -mhandle-large-shift
6790 @opindex mtrap-large-shift
6791 @opindex mhandle-large-shift
6792 @cindex bit shift overflow (88k)
6793 @cindex large bit shifts (88k)
6794 Include code to detect bit-shifts of more than 31 bits; respectively,
6795 trap such shifts or emit code to handle them properly.  By default GCC
6796 makes no special provision for large bit shifts.
6797
6798 @item -mwarn-passed-structs
6799 @opindex mwarn-passed-structs
6800 @cindex structure passing (88k)
6801 Warn when a function passes a struct as an argument or result.
6802 Structure-passing conventions have changed during the evolution of the C
6803 language, and are often the source of portability problems.  By default,
6804 GCC issues no such warning.
6805 @end table
6806
6807 @c break page here to avoid unsightly interparagraph stretch.
6808 @c -zw, 2001-8-17
6809 @page
6810
6811 @node RS/6000 and PowerPC Options
6812 @subsection IBM RS/6000 and PowerPC Options
6813 @cindex RS/6000 and PowerPC Options
6814 @cindex IBM RS/6000 and PowerPC Options
6815
6816 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6817 @table @gcctabopt
6818 @item -mpower
6819 @itemx -mno-power
6820 @itemx -mpower2
6821 @itemx -mno-power2
6822 @itemx -mpowerpc
6823 @itemx -mno-powerpc
6824 @itemx -mpowerpc-gpopt
6825 @itemx -mno-powerpc-gpopt
6826 @itemx -mpowerpc-gfxopt
6827 @itemx -mno-powerpc-gfxopt
6828 @itemx -mpowerpc64
6829 @itemx -mno-powerpc64
6830 @opindex mpower
6831 @opindex mno-power
6832 @opindex mpower2
6833 @opindex mno-power2
6834 @opindex mpowerpc
6835 @opindex mno-powerpc
6836 @opindex mpowerpc-gpopt
6837 @opindex mno-powerpc-gpopt
6838 @opindex mpowerpc-gfxopt
6839 @opindex mno-powerpc-gfxopt
6840 @opindex mpowerpc64
6841 @opindex mno-powerpc64
6842 GCC supports two related instruction set architectures for the
6843 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6844 instructions supported by the @samp{rios} chip set used in the original
6845 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6846 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6847 the IBM 4xx microprocessors.
6848
6849 Neither architecture is a subset of the other.  However there is a
6850 large common subset of instructions supported by both.  An MQ
6851 register is included in processors supporting the POWER architecture.
6852
6853 You use these options to specify which instructions are available on the
6854 processor you are using.  The default value of these options is
6855 determined when configuring GCC@.  Specifying the
6856 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6857 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6858 rather than the options listed above.
6859
6860 The @option{-mpower} option allows GCC to generate instructions that
6861 are found only in the POWER architecture and to use the MQ register.
6862 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6863 to generate instructions that are present in the POWER2 architecture but
6864 not the original POWER architecture.
6865
6866 The @option{-mpowerpc} option allows GCC to generate instructions that
6867 are found only in the 32-bit subset of the PowerPC architecture.
6868 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6869 GCC to use the optional PowerPC architecture instructions in the
6870 General Purpose group, including floating-point square root.  Specifying
6871 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6872 use the optional PowerPC architecture instructions in the Graphics
6873 group, including floating-point select.
6874
6875 The @option{-mpowerpc64} option allows GCC to generate the additional
6876 64-bit instructions that are found in the full PowerPC64 architecture
6877 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6878 @option{-mno-powerpc64}.
6879
6880 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6881 will use only the instructions in the common subset of both
6882 architectures plus some special AIX common-mode calls, and will not use
6883 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6884 permits GCC to use any instruction from either architecture and to
6885 allow use of the MQ register; specify this for the Motorola MPC601.
6886
6887 @item -mnew-mnemonics
6888 @itemx -mold-mnemonics
6889 @opindex mnew-mnemonics
6890 @opindex mold-mnemonics
6891 Select which mnemonics to use in the generated assembler code.  With
6892 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6893 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6894 assembler mnemonics defined for the POWER architecture.  Instructions
6895 defined in only one architecture have only one mnemonic; GCC uses that
6896 mnemonic irrespective of which of these options is specified.
6897
6898 GCC defaults to the mnemonics appropriate for the architecture in
6899 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6900 value of these option.  Unless you are building a cross-compiler, you
6901 should normally not specify either @option{-mnew-mnemonics} or
6902 @option{-mold-mnemonics}, but should instead accept the default.
6903
6904 @item -mcpu=@var{cpu_type}
6905 @opindex mcpu
6906 Set architecture type, register usage, choice of mnemonics, and
6907 instruction scheduling parameters for machine type @var{cpu_type}.
6908 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6909 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6910 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6911 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6912 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6913 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6914
6915 @option{-mcpu=common} selects a completely generic processor.  Code
6916 generated under this option will run on any POWER or PowerPC processor.
6917 GCC will use only the instructions in the common subset of both
6918 architectures, and will not use the MQ register.  GCC assumes a generic
6919 processor model for scheduling purposes.
6920
6921 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6922 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6923 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6924 types, with an appropriate, generic processor model assumed for
6925 scheduling purposes.
6926
6927 The other options specify a specific processor.  Code generated under
6928 those options will run best on that processor, and may not run at all on
6929 others.
6930
6931 The @option{-mcpu} options automatically enable or disable other
6932 @option{-m} options as follows:
6933
6934 @table @samp
6935 @item common
6936 @option{-mno-power}, @option{-mno-powerpc}
6937
6938 @item power
6939 @itemx power2
6940 @itemx rios1
6941 @itemx rios2
6942 @itemx rsc
6943 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6944
6945 @item powerpc
6946 @itemx rs64a
6947 @itemx 602
6948 @itemx 603
6949 @itemx 603e
6950 @itemx 604
6951 @itemx 620
6952 @itemx 630
6953 @itemx 740
6954 @itemx 7400
6955 @itemx 7450
6956 @itemx 750
6957 @itemx 505
6958 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6959
6960 @item 601
6961 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6962
6963 @item 403
6964 @itemx 821
6965 @itemx 860
6966 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6967 @end table
6968
6969 @item -mtune=@var{cpu_type}
6970 @opindex mtune
6971 Set the instruction scheduling parameters for machine type
6972 @var{cpu_type}, but do not set the architecture type, register usage, or
6973 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6974 values for @var{cpu_type} are used for @option{-mtune} as for
6975 @option{-mcpu}.  If both are specified, the code generated will use the
6976 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6977 scheduling parameters set by @option{-mtune}.
6978
6979 @item -maltivec
6980 @itemx -mno-altivec
6981 @opindex maltivec
6982 @opindex mno-altivec
6983 These switches enable or disable the use of built-in functions that
6984 allow access to the AltiVec instruction set.  You may also need to set
6985 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6986 enhancements.
6987
6988 @item -mabi=spe
6989 @opindex mabi=spe
6990 Extend the current ABI with SPE ABI extensions.  This does not change
6991 the default ABI, instead it adds the SPE ABI extensions to the current
6992 ABI@.
6993
6994 @item -mabi=no-spe
6995 @opindex mabi=no-spe
6996 Disable Booke SPE ABI extensions for the current ABI.
6997
6998 @item -misel=@var{yes/no}
6999 @itemx -misel
7000 @opindex misel
7001 This switch enables or disables the generation of ISEL instructions.
7002
7003 @item -mspe=@var{yes/no}
7004 @itemx -mspe
7005 @opindex mspe
7006 This switch enables or disables the generation of SPE simd
7007 instructions.
7008
7009 @item -mfloat-gprs=@var{yes/no}
7010 @itemx -mfloat-gprs
7011 @opindex mfloat-gprs
7012 This switch enables or disables the generation of floating point
7013 operations on the general purpose registers for architectures that
7014 support it.  This option is currently only available on the MPC8540.
7015
7016 @item -mfull-toc
7017 @itemx -mno-fp-in-toc
7018 @itemx -mno-sum-in-toc
7019 @itemx -mminimal-toc
7020 @opindex mfull-toc
7021 @opindex mno-fp-in-toc
7022 @opindex mno-sum-in-toc
7023 @opindex mminimal-toc
7024 Modify generation of the TOC (Table Of Contents), which is created for
7025 every executable file.  The @option{-mfull-toc} option is selected by
7026 default.  In that case, GCC will allocate at least one TOC entry for
7027 each unique non-automatic variable reference in your program.  GCC
7028 will also place floating-point constants in the TOC@.  However, only
7029 16,384 entries are available in the TOC@.
7030
7031 If you receive a linker error message that saying you have overflowed
7032 the available TOC space, you can reduce the amount of TOC space used
7033 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7034 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7035 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7036 generate code to calculate the sum of an address and a constant at
7037 run-time instead of putting that sum into the TOC@.  You may specify one
7038 or both of these options.  Each causes GCC to produce very slightly
7039 slower and larger code at the expense of conserving TOC space.
7040
7041 If you still run out of space in the TOC even when you specify both of
7042 these options, specify @option{-mminimal-toc} instead.  This option causes
7043 GCC to make only one TOC entry for every file.  When you specify this
7044 option, GCC will produce code that is slower and larger but which
7045 uses extremely little TOC space.  You may wish to use this option
7046 only on files that contain less frequently executed code.
7047
7048 @item -maix64
7049 @itemx -maix32
7050 @opindex maix64
7051 @opindex maix32
7052 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7053 @code{long} type, and the infrastructure needed to support them.
7054 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7055 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7056 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7057
7058 @item -mxl-call
7059 @itemx -mno-xl-call
7060 @opindex mxl-call
7061 @opindex mno-xl-call
7062 On AIX, pass floating-point arguments to prototyped functions beyond the
7063 register save area (RSA) on the stack in addition to argument FPRs.  The
7064 AIX calling convention was extended but not initially documented to
7065 handle an obscure K&R C case of calling a function that takes the
7066 address of its arguments with fewer arguments than declared.  AIX XL
7067 compilers access floating point arguments which do not fit in the
7068 RSA from the stack when a subroutine is compiled without
7069 optimization.  Because always storing floating-point arguments on the
7070 stack is inefficient and rarely needed, this option is not enabled by
7071 default and only is necessary when calling subroutines compiled by AIX
7072 XL compilers without optimization.
7073
7074 @item -mpe
7075 @opindex mpe
7076 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7077 application written to use message passing with special startup code to
7078 enable the application to run.  The system must have PE installed in the
7079 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7080 must be overridden with the @option{-specs=} option to specify the
7081 appropriate directory location.  The Parallel Environment does not
7082 support threads, so the @option{-mpe} option and the @option{-pthread}
7083 option are incompatible.
7084
7085 @item -msoft-float
7086 @itemx -mhard-float
7087 @opindex msoft-float
7088 @opindex mhard-float
7089 Generate code that does not use (uses) the floating-point register set.
7090 Software floating point emulation is provided if you use the
7091 @option{-msoft-float} option, and pass the option to GCC when linking.
7092
7093 @item -mmultiple
7094 @itemx -mno-multiple
7095 @opindex mmultiple
7096 @opindex mno-multiple
7097 Generate code that uses (does not use) the load multiple word
7098 instructions and the store multiple word instructions.  These
7099 instructions are generated by default on POWER systems, and not
7100 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7101 endian PowerPC systems, since those instructions do not work when the
7102 processor is in little endian mode.  The exceptions are PPC740 and
7103 PPC750 which permit the instructions usage in little endian mode.
7104
7105 @item -mstring
7106 @itemx -mno-string
7107 @opindex mstring
7108 @opindex mno-string
7109 Generate code that uses (does not use) the load string instructions
7110 and the store string word instructions to save multiple registers and
7111 do small block moves.  These instructions are generated by default on
7112 POWER systems, and not generated on PowerPC systems.  Do not use
7113 @option{-mstring} on little endian PowerPC systems, since those
7114 instructions do not work when the processor is in little endian mode.
7115 The exceptions are PPC740 and PPC750 which permit the instructions
7116 usage in little endian mode.
7117
7118 @item -mupdate
7119 @itemx -mno-update
7120 @opindex mupdate
7121 @opindex mno-update
7122 Generate code that uses (does not use) the load or store instructions
7123 that update the base register to the address of the calculated memory
7124 location.  These instructions are generated by default.  If you use
7125 @option{-mno-update}, there is a small window between the time that the
7126 stack pointer is updated and the address of the previous frame is
7127 stored, which means code that walks the stack frame across interrupts or
7128 signals may get corrupted data.
7129
7130 @item -mfused-madd
7131 @itemx -mno-fused-madd
7132 @opindex mfused-madd
7133 @opindex mno-fused-madd
7134 Generate code that uses (does not use) the floating point multiply and
7135 accumulate instructions.  These instructions are generated by default if
7136 hardware floating is used.
7137
7138 @item -mno-bit-align
7139 @itemx -mbit-align
7140 @opindex mno-bit-align
7141 @opindex mbit-align
7142 On System V.4 and embedded PowerPC systems do not (do) force structures
7143 and unions that contain bit-fields to be aligned to the base type of the
7144 bit-field.
7145
7146 For example, by default a structure containing nothing but 8
7147 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7148 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7149 the structure would be aligned to a 1 byte boundary and be one byte in
7150 size.
7151
7152 @item -mno-strict-align
7153 @itemx -mstrict-align
7154 @opindex mno-strict-align
7155 @opindex mstrict-align
7156 On System V.4 and embedded PowerPC systems do not (do) assume that
7157 unaligned memory references will be handled by the system.
7158
7159 @item -mrelocatable
7160 @itemx -mno-relocatable
7161 @opindex mrelocatable
7162 @opindex mno-relocatable
7163 On embedded PowerPC systems generate code that allows (does not allow)
7164 the program to be relocated to a different address at runtime.  If you
7165 use @option{-mrelocatable} on any module, all objects linked together must
7166 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7167
7168 @item -mrelocatable-lib
7169 @itemx -mno-relocatable-lib
7170 @opindex mrelocatable-lib
7171 @opindex mno-relocatable-lib
7172 On embedded PowerPC systems generate code that allows (does not allow)
7173 the program to be relocated to a different address at runtime.  Modules
7174 compiled with @option{-mrelocatable-lib} can be linked with either modules
7175 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7176 with modules compiled with the @option{-mrelocatable} options.
7177
7178 @item -mno-toc
7179 @itemx -mtoc
7180 @opindex mno-toc
7181 @opindex mtoc
7182 On System V.4 and embedded PowerPC systems do not (do) assume that
7183 register 2 contains a pointer to a global area pointing to the addresses
7184 used in the program.
7185
7186 @item -mlittle
7187 @itemx -mlittle-endian
7188 @opindex mlittle
7189 @opindex mlittle-endian
7190 On System V.4 and embedded PowerPC systems compile code for the
7191 processor in little endian mode.  The @option{-mlittle-endian} option is
7192 the same as @option{-mlittle}.
7193
7194 @item -mbig
7195 @itemx -mbig-endian
7196 @opindex mbig
7197 @opindex mbig-endian
7198 On System V.4 and embedded PowerPC systems compile code for the
7199 processor in big endian mode.  The @option{-mbig-endian} option is
7200 the same as @option{-mbig}.
7201
7202 @item -mdynamic-no-pic
7203 @opindex mdynamic-no-pic
7204 On Darwin and Mac OS X systems, compile code so that it is not
7205 relocatable, but that its external references are relocatable.  The
7206 resulting code is suitable for applications, but not shared
7207 libraries.
7208
7209 @item -mcall-sysv
7210 @opindex mcall-sysv
7211 On System V.4 and embedded PowerPC systems compile code using calling
7212 conventions that adheres to the March 1995 draft of the System V
7213 Application Binary Interface, PowerPC processor supplement.  This is the
7214 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7215
7216 @item -mcall-sysv-eabi
7217 @opindex mcall-sysv-eabi
7218 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7219
7220 @item -mcall-sysv-noeabi
7221 @opindex mcall-sysv-noeabi
7222 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7223
7224 @item -mcall-solaris
7225 @opindex mcall-solaris
7226 On System V.4 and embedded PowerPC systems compile code for the Solaris
7227 operating system.
7228
7229 @item -mcall-linux
7230 @opindex mcall-linux
7231 On System V.4 and embedded PowerPC systems compile code for the
7232 Linux-based GNU system.
7233
7234 @item -mcall-gnu
7235 @opindex mcall-gnu
7236 On System V.4 and embedded PowerPC systems compile code for the
7237 Hurd-based GNU system.
7238
7239 @item -mcall-netbsd
7240 @opindex mcall-netbsd
7241 On System V.4 and embedded PowerPC systems compile code for the
7242 NetBSD operating system.
7243
7244 @item -maix-struct-return
7245 @opindex maix-struct-return
7246 Return all structures in memory (as specified by the AIX ABI)@.
7247
7248 @item -msvr4-struct-return
7249 @opindex msvr4-struct-return
7250 Return structures smaller than 8 bytes in registers (as specified by the
7251 SVR4 ABI)@.
7252
7253 @item -mabi=altivec
7254 @opindex mabi=altivec
7255 Extend the current ABI with AltiVec ABI extensions.  This does not
7256 change the default ABI, instead it adds the AltiVec ABI extensions to
7257 the current ABI@.
7258
7259 @item -mabi=no-altivec
7260 @opindex mabi=no-altivec
7261 Disable AltiVec ABI extensions for the current ABI.
7262
7263 @item -mprototype
7264 @itemx -mno-prototype
7265 @opindex mprototype
7266 @opindex mno-prototype
7267 On System V.4 and embedded PowerPC systems assume that all calls to
7268 variable argument functions are properly prototyped.  Otherwise, the
7269 compiler must insert an instruction before every non prototyped call to
7270 set or clear bit 6 of the condition code register (@var{CR}) to
7271 indicate whether floating point values were passed in the floating point
7272 registers in case the function takes a variable arguments.  With
7273 @option{-mprototype}, only calls to prototyped variable argument functions
7274 will set or clear the bit.
7275
7276 @item -msim
7277 @opindex msim
7278 On embedded PowerPC systems, assume that the startup module is called
7279 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7280 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7281 configurations.
7282
7283 @item -mmvme
7284 @opindex mmvme
7285 On embedded PowerPC systems, assume that the startup module is called
7286 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7287 @file{libc.a}.
7288
7289 @item -mads
7290 @opindex mads
7291 On embedded PowerPC systems, assume that the startup module is called
7292 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7293 @file{libc.a}.
7294
7295 @item -myellowknife
7296 @opindex myellowknife
7297 On embedded PowerPC systems, assume that the startup module is called
7298 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7299 @file{libc.a}.
7300
7301 @item -mvxworks
7302 @opindex mvxworks
7303 On System V.4 and embedded PowerPC systems, specify that you are
7304 compiling for a VxWorks system.
7305
7306 @item -mwindiss
7307 @opindex mwindiss
7308 Specify that you are compiling for the WindISS simulation environment.
7309
7310 @item -memb
7311 @opindex memb
7312 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7313 header to indicate that @samp{eabi} extended relocations are used.
7314
7315 @item -meabi
7316 @itemx -mno-eabi
7317 @opindex meabi
7318 @opindex mno-eabi
7319 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7320 Embedded Applications Binary Interface (eabi) which is a set of
7321 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7322 means that the stack is aligned to an 8 byte boundary, a function
7323 @code{__eabi} is called to from @code{main} to set up the eabi
7324 environment, and the @option{-msdata} option can use both @code{r2} and
7325 @code{r13} to point to two separate small data areas.  Selecting
7326 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7327 do not call an initialization function from @code{main}, and the
7328 @option{-msdata} option will only use @code{r13} to point to a single
7329 small data area.  The @option{-meabi} option is on by default if you
7330 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7331
7332 @item -msdata=eabi
7333 @opindex msdata=eabi
7334 On System V.4 and embedded PowerPC systems, put small initialized
7335 @code{const} global and static data in the @samp{.sdata2} section, which
7336 is pointed to by register @code{r2}.  Put small initialized
7337 non-@code{const} global and static data in the @samp{.sdata} section,
7338 which is pointed to by register @code{r13}.  Put small uninitialized
7339 global and static data in the @samp{.sbss} section, which is adjacent to
7340 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7341 incompatible with the @option{-mrelocatable} option.  The
7342 @option{-msdata=eabi} option also sets the @option{-memb} option.
7343
7344 @item -msdata=sysv
7345 @opindex msdata=sysv
7346 On System V.4 and embedded PowerPC systems, put small global and static
7347 data in the @samp{.sdata} section, which is pointed to by register
7348 @code{r13}.  Put small uninitialized global and static data in the
7349 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7350 The @option{-msdata=sysv} option is incompatible with the
7351 @option{-mrelocatable} option.
7352
7353 @item -msdata=default
7354 @itemx -msdata
7355 @opindex msdata=default
7356 @opindex msdata
7357 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7358 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7359 same as @option{-msdata=sysv}.
7360
7361 @item -msdata-data
7362 @opindex msdata-data
7363 On System V.4 and embedded PowerPC systems, put small global and static
7364 data in the @samp{.sdata} section.  Put small uninitialized global and
7365 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7366 to address small data however.  This is the default behavior unless
7367 other @option{-msdata} options are used.
7368
7369 @item -msdata=none
7370 @itemx -mno-sdata
7371 @opindex msdata=none
7372 @opindex mno-sdata
7373 On embedded PowerPC systems, put all initialized global and static data
7374 in the @samp{.data} section, and all uninitialized data in the
7375 @samp{.bss} section.
7376
7377 @item -G @var{num}
7378 @opindex G
7379 @cindex smaller data references (PowerPC)
7380 @cindex .sdata/.sdata2 references (PowerPC)
7381 On embedded PowerPC systems, put global and static items less than or
7382 equal to @var{num} bytes into the small data or bss sections instead of
7383 the normal data or bss section.  By default, @var{num} is 8.  The
7384 @option{-G @var{num}} switch is also passed to the linker.
7385 All modules should be compiled with the same @option{-G @var{num}} value.
7386
7387 @item -mregnames
7388 @itemx -mno-regnames
7389 @opindex mregnames
7390 @opindex mno-regnames
7391 On System V.4 and embedded PowerPC systems do (do not) emit register
7392 names in the assembly language output using symbolic forms.
7393
7394 @item -mlongcall
7395 @itemx -mno-longcall
7396 @opindex mlongcall
7397 @opindex mno-longcall
7398 Default to making all function calls via pointers, so that functions
7399 which reside further than 64 megabytes (67,108,864 bytes) from the
7400 current location can be called.  This setting can be overridden by the
7401 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7402
7403 Some linkers are capable of detecting out-of-range calls and generating
7404 glue code on the fly.  On these systems, long calls are unnecessary and
7405 generate slower code.  As of this writing, the AIX linker can do this,
7406 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7407 to the GNU linker for 32-bit PowerPC systems as well.
7408
7409 In the future, we may cause GCC to ignore all longcall specifications
7410 when the linker is known to generate glue.
7411
7412 @item -pthread
7413 @opindex pthread
7414 Adds support for multithreading with the @dfn{pthreads} library.
7415 This option sets flags for both the preprocessor and linker.
7416
7417 @end table
7418
7419 @node Darwin Options
7420 @subsection Darwin Options
7421 @cindex Darwin options
7422
7423 These options are defined for all architectures running the Darwin operating
7424 system.  They are useful for compatibility with other Mac OS compilers.
7425
7426 @table @gcctabopt
7427 @item -all_load    
7428 @opindex all_load   
7429 Loads all members of static archive libraries.
7430 See man ld(1) for more information.
7431
7432 @item -arch_errors_fatal
7433 @opindex arch_errors_fatal
7434 Cause the errors having to do with files that have the wrong architecture
7435 to be fatal.
7436
7437 @item -bind_at_load
7438 @opindex bind_at_load
7439 Causes the output file to be marked such that the dynamic linker will
7440 bind all undefined references when the file is loaded or launched.
7441
7442 @item -bundle     
7443 @opindex bundle
7444 Produce a Mach-o bundle format file.
7445 See man ld(1) for more information.
7446
7447 @item -bundle_loader @var{executable}
7448 @opindex bundle_loader
7449 This specifies the @var{executable} that will be loading the build
7450 output file being linked. See man ld(1) for more information.
7451
7452 @item -allowable_client  @var{client_name}
7453 @item -arch_only
7454
7455 @item -client_name       
7456 @item -compatibility_version
7457 @item -current_version    
7458 @item -dependency-file
7459 @item -dylib_file    
7460 @item -dylinker_install_name
7461 @item -dynamic
7462 @item -dynamiclib   
7463 @item -exported_symbols_list  
7464 @item -filelist
7465 @item -flat_namespace   
7466 @item -force_cpusubtype_ALL
7467 @item -force_flat_namespace   
7468 @item -headerpad_max_install_names
7469 @item -image_base  
7470 @item -init
7471 @item -install_name
7472 @item -keep_private_externs
7473 @item -multi_module
7474 @item -multiply_defined      
7475 @item -multiply_defined_unused      
7476 @item -noall_load  
7477 @item -nomultidefs
7478 @item -noprebind     
7479 @item -noseglinkedit
7480 @item -pagezero_size    
7481 @item -prebind
7482 @item -prebind_all_twolevel_modules
7483 @item -private_bundle
7484 @item -read_only_relocs
7485 @item -sectalign  
7486 @item -sectobjectsymbols    
7487 @item -whyload
7488 @item -seg1addr 
7489 @item -sectcreate
7490 @item -sectobjectsymbols
7491 @item -sectorder
7492 @item -seg_addr_table
7493 @item -seg_addr_table_filename
7494 @item -seglinkedit
7495 @item -segprot   
7496 @item -segs_read_only_addr
7497 @item -segs_read_write_addr
7498 @item -single_module   
7499 @item -static
7500 @item -sub_library
7501 @item -sub_umbrella 
7502 @item -twolevel_namespace
7503 @item -umbrella
7504 @item -undefined
7505 @item -unexported_symbols_list
7506 @item -weak_reference_mismatches
7507 @item -whatsloaded  
7508
7509 @opindex allowable_client
7510 @opindex arch_only    
7511 @opindex client_name
7512 @opindex compatibility_version
7513 @opindex current_version
7514 @opindex dependency-file
7515 @opindex dylib_file
7516 @opindex dylinker_install_name
7517 @opindex dynamic
7518 @opindex dynamiclib
7519 @opindex exported_symbols_list
7520 @opindex filelist  
7521 @opindex flat_namespace    
7522 @opindex force_cpusubtype_ALL
7523 @opindex force_flat_namespace
7524 @opindex headerpad_max_install_names
7525 @opindex image_base
7526 @opindex init     
7527 @opindex install_name
7528 @opindex keep_private_externs
7529 @opindex multi_module   
7530 @opindex multiply_defined
7531 @opindex multiply_defined_unused   
7532 @opindex noall_load  
7533 @opindex nomultidefs   
7534 @opindex noprebind
7535 @opindex noseglinkedit      
7536 @opindex pagezero_size
7537 @opindex prebind
7538 @opindex prebind_all_twolevel_modules
7539 @opindex private_bundle 
7540 @opindex read_only_relocs
7541 @opindex sectalign   
7542 @opindex sectobjectsymbols    
7543 @opindex whyload  
7544 @opindex seg1addr
7545 @opindex sectcreate       
7546 @opindex sectobjectsymbols 
7547 @opindex sectorder     
7548 @opindex seg_addr_table
7549 @opindex seg_addr_table_filename
7550 @opindex seglinkedit
7551 @opindex segprot
7552 @opindex segs_read_only_addr
7553 @opindex segs_read_write_addr
7554 @opindex single_module
7555 @opindex static
7556 @opindex sub_library
7557 @opindex sub_umbrella
7558 @opindex twolevel_namespace
7559 @opindex umbrella
7560 @opindex undefined
7561 @opindex unexported_symbols_list
7562 @opindex weak_reference_mismatches
7563 @opindex whatsloaded
7564
7565 This options are available for Darwin linker. Darwin linker man page
7566 describes them in detail.
7567 @end table
7568
7569
7570 @node RT Options
7571 @subsection IBM RT Options
7572 @cindex RT options
7573 @cindex IBM RT options
7574
7575 These @samp{-m} options are defined for the IBM RT PC:
7576
7577 @table @gcctabopt
7578 @item -min-line-mul
7579 @opindex min-line-mul
7580 Use an in-line code sequence for integer multiplies.  This is the
7581 default.
7582
7583 @item -mcall-lib-mul
7584 @opindex mcall-lib-mul
7585 Call @code{lmul$$} for integer multiples.
7586
7587 @item -mfull-fp-blocks
7588 @opindex mfull-fp-blocks
7589 Generate full-size floating point data blocks, including the minimum
7590 amount of scratch space recommended by IBM@.  This is the default.
7591
7592 @item -mminimum-fp-blocks
7593 @opindex mminimum-fp-blocks
7594 Do not include extra scratch space in floating point data blocks.  This
7595 results in smaller code, but slower execution, since scratch space must
7596 be allocated dynamically.
7597
7598 @cindex @file{stdarg.h} and RT PC
7599 @item -mfp-arg-in-fpregs
7600 @opindex mfp-arg-in-fpregs
7601 Use a calling sequence incompatible with the IBM calling convention in
7602 which floating point arguments are passed in floating point registers.
7603 Note that @code{stdarg.h} will not work with floating point operands
7604 if this option is specified.
7605
7606 @item -mfp-arg-in-gregs
7607 @opindex mfp-arg-in-gregs
7608 Use the normal calling convention for floating point arguments.  This is
7609 the default.
7610
7611 @item -mhc-struct-return
7612 @opindex mhc-struct-return
7613 Return structures of more than one word in memory, rather than in a
7614 register.  This provides compatibility with the MetaWare HighC (hc)
7615 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7616 with the Portable C Compiler (pcc).
7617
7618 @item -mnohc-struct-return
7619 @opindex mnohc-struct-return
7620 Return some structures of more than one word in registers, when
7621 convenient.  This is the default.  For compatibility with the
7622 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7623 option @option{-mhc-struct-return}.
7624 @end table
7625
7626 @node MIPS Options
7627 @subsection MIPS Options
7628 @cindex MIPS options
7629
7630 These @samp{-m} options are defined for the MIPS family of computers:
7631
7632 @table @gcctabopt
7633
7634 @item -march=@var{arch}
7635 @opindex march
7636 Generate code that will run on @var{arch}, which can be the name of a
7637 generic MIPS ISA, or the name of a particular processor.
7638 The ISA names are:
7639 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7640 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7641 The processor names are:
7642 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7643 @samp{m4k},
7644 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7645 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7646 @samp{orion},
7647 @samp{sb1},
7648 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7649 The special value @samp{from-abi} selects the
7650 most compatible architecture for the selected ABI (that is,
7651 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7652
7653 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7654 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7655 @samp{vr} may be written @samp{r}.
7656
7657 GCC defines two macros based on the value of this option.  The first
7658 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7659 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7660 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7661 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7662 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7663
7664 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7665 above.  In other words, it will have the full prefix and will not
7666 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7667 the macro names the resolved architecture (either @samp{"mips1"} or
7668 @samp{"mips3"}).  It names the default architecture when no
7669 @option{-march} option is given.
7670
7671 @item -mtune=@var{arch}
7672 @opindex mtune
7673 Optimize for @var{arch}.  Among other things, this option controls
7674 the way instructions are scheduled, and the perceived cost of arithmetic
7675 operations.  The list of @var{arch} values is the same as for
7676 @option{-march}.
7677
7678 When this option is not used, GCC will optimize for the processor
7679 specified by @option{-march}.  By using @option{-march} and
7680 @option{-mtune} together, it is possible to generate code that will
7681 run on a family of processors, but optimize the code for one
7682 particular member of that family.
7683
7684 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7685 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7686 @samp{-march} ones described above.
7687
7688 @item -mips1
7689 @opindex mips1
7690 Equivalent to @samp{-march=mips1}.
7691
7692 @item -mips2
7693 @opindex mips2
7694 Equivalent to @samp{-march=mips2}.
7695
7696 @item -mips3
7697 @opindex mips3
7698 Equivalent to @samp{-march=mips3}.
7699
7700 @item -mips4
7701 @opindex mips4
7702 Equivalent to @samp{-march=mips4}.
7703
7704 @item -mips32
7705 @opindex mips32
7706 Equivalent to @samp{-march=mips32}.
7707
7708 @item -mips32r2
7709 @opindex mips32r2
7710 Equivalent to @samp{-march=mips32r2}.
7711
7712 @item -mips64
7713 @opindex mips64
7714 Equivalent to @samp{-march=mips64}.
7715
7716 @item -mfused-madd
7717 @itemx -mno-fused-madd
7718 @opindex mfused-madd
7719 @opindex mno-fused-madd
7720 Generate code that uses (does not use) the floating point multiply and
7721 accumulate instructions, when they are available.  These instructions
7722 are generated by default if they are available, but this may be
7723 undesirable if the extra precision causes problems or on certain chips
7724 in the mode where denormals are rounded to zero where denormals
7725 generated by multiply and accumulate instructions cause exceptions
7726 anyway.
7727
7728 @item -mfp32
7729 @opindex mfp32
7730 Assume that floating point registers are 32 bits wide.
7731
7732 @item -mfp64
7733 @opindex mfp64
7734 Assume that floating point registers are 64 bits wide.
7735
7736 @item -mgp32
7737 @opindex mgp32
7738 Assume that general purpose registers are 32 bits wide.
7739
7740 @item -mgp64
7741 @opindex mgp64
7742 Assume that general purpose registers are 64 bits wide.
7743
7744 @item -mint64
7745 @opindex mint64
7746 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7747 explanation of the default, and the width of pointers.
7748
7749 @item -mlong64
7750 @opindex mlong64
7751 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7752 explanation of the default, and the width of pointers.
7753
7754 @item -mlong32
7755 @opindex mlong32
7756 Force long, int, and pointer types to be 32 bits wide.
7757
7758 The default size of ints, longs and pointers depends on the ABI@.  All
7759 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7760 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7761 are the same size as longs, or the same size as integer registers,
7762 whichever is smaller.
7763
7764 @item -mabi=32
7765 @itemx -mabi=o64
7766 @itemx -mabi=n32
7767 @itemx -mabi=64
7768 @itemx -mabi=eabi
7769 @itemx -mabi=meabi
7770 @opindex mabi=32
7771 @opindex mabi=o64
7772 @opindex mabi=n32
7773 @opindex mabi=64
7774 @opindex mabi=eabi
7775 @opindex mabi=meabi
7776 Generate code for the given ABI@.
7777
7778 Note that there are two embedded ABIs: @option{-mabi=eabi}
7779 selects the one defined by Cygnus while @option{-meabi=meabi}
7780 selects the one defined by MIPS@.  Both these ABIs have
7781 32-bit and 64-bit variants.  Normally, GCC will generate
7782 64-bit code when you select a 64-bit architecture, but you
7783 can use @option{-mgp32} to get 32-bit code instead.
7784
7785 @item -mabi-fake-default
7786 @opindex mabi-fake-default
7787 You don't want to know what this option does.  No, really.  I mean
7788 it.  Move on to the next option.
7789
7790 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7791 wants the default set of options to get the root of the multilib tree,
7792 and the shared library SONAMEs without any multilib-indicating
7793 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7794 we want to default to the N32 ABI, while still being binary-compatible
7795 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7796 binary-compatible means shared libraries should have the same SONAMEs,
7797 and libraries should live in the same location.  Having O32 libraries
7798 in a sub-directory named say @file{o32} is not acceptable.
7799
7800 So we trick GCC into believing that O32 is the default ABI, except
7801 that we override the default with some internal command-line
7802 processing magic.  Problem is, if we stopped at that, and you then
7803 created a multilib-aware package that used the output of @command{gcc
7804 -print-multi-lib} to decide which multilibs to build, and how, and
7805 you'd find yourself in an awkward situation when you found out that
7806 some of the options listed ended up mapping to the same multilib, and
7807 none of your libraries was actually built for the multilib that
7808 @option{-print-multi-lib} claims to be the default.  So we added this
7809 option that disables the default switcher, falling back to GCC's
7810 original notion of the default library.  Confused yet?
7811
7812 For short: don't ever use this option, unless you find it in the list
7813 of additional options to be used when building for multilibs, in the
7814 output of @option{gcc -print-multi-lib}.
7815
7816 @item -mmips-as
7817 @opindex mmips-as
7818 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7819 add normal debug information.  This is the default for all
7820 platforms except for the OSF/1 reference platform, using the OSF/rose
7821 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7822 switches are used, the @file{mips-tfile} program will encapsulate the
7823 stabs within MIPS ECOFF@.
7824
7825 @item -mgas
7826 @opindex mgas
7827 Generate code for the GNU assembler.  This is the default on the OSF/1
7828 reference platform, using the OSF/rose object format.  Also, this is
7829 the default if the configure option @option{--with-gnu-as} is used.
7830
7831 @item -msplit-addresses
7832 @itemx -mno-split-addresses
7833 @opindex msplit-addresses
7834 @opindex mno-split-addresses
7835 Generate code to load the high and low parts of address constants separately.
7836 This allows GCC to optimize away redundant loads of the high order
7837 bits of addresses.  This optimization requires GNU as and GNU ld.
7838 This optimization is enabled by default for some embedded targets where
7839 GNU as and GNU ld are standard.
7840
7841 @item -mrnames
7842 @itemx -mno-rnames
7843 @opindex mrnames
7844 @opindex mno-rnames
7845 The @option{-mrnames} switch says to output code using the MIPS software
7846 names for the registers, instead of the hardware names (ie, @var{a0}
7847 instead of @var{$4}).  The only known assembler that supports this option
7848 is the Algorithmics assembler.
7849
7850 @item -mgpopt
7851 @itemx -mno-gpopt
7852 @opindex mgpopt
7853 @opindex mno-gpopt
7854 The @option{-mgpopt} switch says to write all of the data declarations
7855 before the instructions in the text section, this allows the MIPS
7856 assembler to generate one word memory references instead of using two
7857 words for short global or static data items.  This is on by default if
7858 optimization is selected.
7859
7860 @item -mstats
7861 @itemx -mno-stats
7862 @opindex mstats
7863 @opindex mno-stats
7864 For each non-inline function processed, the @option{-mstats} switch
7865 causes the compiler to emit one line to the standard error file to
7866 print statistics about the program (number of registers saved, stack
7867 size, etc.).
7868
7869 @item -mmemcpy
7870 @itemx -mno-memcpy
7871 @opindex mmemcpy
7872 @opindex mno-memcpy
7873 The @option{-mmemcpy} switch makes all block moves call the appropriate
7874 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7875 generating inline code.
7876
7877 @item -mmips-tfile
7878 @itemx -mno-mips-tfile
7879 @opindex mmips-tfile
7880 @opindex mno-mips-tfile
7881 The @option{-mno-mips-tfile} switch causes the compiler not
7882 postprocess the object file with the @file{mips-tfile} program,
7883 after the MIPS assembler has generated it to add debug support.  If
7884 @file{mips-tfile} is not run, then no local variables will be
7885 available to the debugger.  In addition, @file{stage2} and
7886 @file{stage3} objects will have the temporary file names passed to the
7887 assembler embedded in the object file, which means the objects will
7888 not compare the same.  The @option{-mno-mips-tfile} switch should only
7889 be used when there are bugs in the @file{mips-tfile} program that
7890 prevents compilation.
7891
7892 @item -msoft-float
7893 @opindex msoft-float
7894 Generate output containing library calls for floating point.
7895 @strong{Warning:} the requisite libraries are not part of GCC@.
7896 Normally the facilities of the machine's usual C compiler are used, but
7897 this can't be done directly in cross-compilation.  You must make your
7898 own arrangements to provide suitable library functions for
7899 cross-compilation.
7900
7901 @item -mhard-float
7902 @opindex mhard-float
7903 Generate output containing floating point instructions.  This is the
7904 default if you use the unmodified sources.
7905
7906 @item -mabicalls
7907 @itemx -mno-abicalls
7908 @opindex mabicalls
7909 @opindex mno-abicalls
7910 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7911 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7912 position independent code.
7913
7914 @item -mlong-calls
7915 @itemx -mno-long-calls
7916 @opindex mlong-calls
7917 @opindex mno-long-calls
7918 Do all calls with the @samp{JALR} instruction, which requires
7919 loading up a function's address into a register before the call.
7920 You need to use this switch, if you call outside of the current
7921 512 megabyte segment to functions that are not through pointers.
7922
7923 @item -mhalf-pic
7924 @itemx -mno-half-pic
7925 @opindex mhalf-pic
7926 @opindex mno-half-pic
7927 Put pointers to extern references into the data section and load them
7928 up, rather than put the references in the text section.
7929
7930 @item -membedded-pic
7931 @itemx -mno-embedded-pic
7932 @opindex membedded-pic
7933 @opindex mno-embedded-pic
7934 Generate PIC code suitable for some embedded systems.  All calls are
7935 made using PC relative address, and all data is addressed using the $gp
7936 register.  No more than 65536 bytes of global data may be used.  This
7937 requires GNU as and GNU ld which do most of the work.  This currently
7938 only works on targets which use ECOFF; it does not work with ELF@.
7939
7940 @item -membedded-data
7941 @itemx -mno-embedded-data
7942 @opindex membedded-data
7943 @opindex mno-embedded-data
7944 Allocate variables to the read-only data section first if possible, then
7945 next in the small data section if possible, otherwise in data.  This gives
7946 slightly slower code than the default, but reduces the amount of RAM required
7947 when executing, and thus may be preferred for some embedded systems.
7948
7949 @item -muninit-const-in-rodata
7950 @itemx -mno-uninit-const-in-rodata
7951 @opindex muninit-const-in-rodata
7952 @opindex mno-uninit-const-in-rodata
7953 When used together with @option{-membedded-data}, it will always store uninitialized
7954 const variables in the read-only data section.
7955
7956 @item -msingle-float
7957 @itemx -mdouble-float
7958 @opindex msingle-float
7959 @opindex mdouble-float
7960 The @option{-msingle-float} switch tells gcc to assume that the floating
7961 point coprocessor only supports single precision operations, as on the
7962 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7963 double precision operations.  This is the default.
7964
7965 @item -mmad
7966 @itemx -mno-mad
7967 @opindex mmad
7968 @opindex mno-mad
7969 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7970 as on the @samp{r4650} chip.
7971
7972 @item -m4650
7973 @opindex m4650
7974 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7975 @option{-mcpu=r4650}.
7976
7977 @item -mips16
7978 @itemx -mno-mips16
7979 @opindex mips16
7980 @opindex mno-mips16
7981 Enable 16-bit instructions.
7982
7983 @item -mentry
7984 @opindex mentry
7985 Use the entry and exit pseudo ops.  This option can only be used with
7986 @option{-mips16}.
7987
7988 @item -EL
7989 @opindex EL
7990 Compile code for the processor in little endian mode.
7991 The requisite libraries are assumed to exist.
7992
7993 @item -EB
7994 @opindex EB
7995 Compile code for the processor in big endian mode.
7996 The requisite libraries are assumed to exist.
7997
7998 @item -G @var{num}
7999 @opindex G
8000 @cindex smaller data references (MIPS)
8001 @cindex gp-relative references (MIPS)
8002 Put global and static items less than or equal to @var{num} bytes into
8003 the small data or bss sections instead of the normal data or bss
8004 section.  This allows the assembler to emit one word memory reference
8005 instructions based on the global pointer (@var{gp} or @var{$28}),
8006 instead of the normal two words used.  By default, @var{num} is 8 when
8007 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8008 @option{-G @var{num}} switch is also passed to the assembler and linker.
8009 All modules should be compiled with the same @option{-G @var{num}}
8010 value.
8011
8012 @item -nocpp
8013 @opindex nocpp
8014 Tell the MIPS assembler to not run its preprocessor over user
8015 assembler files (with a @samp{.s} suffix) when assembling them.
8016
8017 @item -mfix7000
8018 @opindex mfix7000
8019 Pass an option to gas which will cause nops to be inserted if
8020 the read of the destination register of an mfhi or mflo instruction
8021 occurs in the following two instructions.
8022
8023 @item -no-crt0
8024 @opindex no-crt0
8025 Do not include the default crt0.
8026
8027 @item -mflush-func=@var{func}
8028 @itemx -mno-flush-func
8029 @opindex mflush-func
8030 Specifies the function to call to flush the I and D caches, or to not
8031 call any such function.  If called, the function must take the same
8032 arguments as the common @code{_flush_func()}, that is, the address of the
8033 memory range for which the cache is being flushed, the size of the
8034 memory range, and the number 3 (to flush both caches).  The default
8035 depends on the target gcc was configured for, but commonly is either
8036 @samp{_flush_func} or @samp{__cpu_flush}.
8037
8038 @item -mbranch-likely
8039 @itemx -mno-branch-likely
8040 @opindex mbranch-likely
8041 @opindex mno-branch-likely
8042 Enable or disable use of Branch Likely instructions, regardless of the
8043 default for the selected architecture.  By default, Branch Likely
8044 instructions may be generated if they are supported by the selected
8045 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8046 and processors which implement those architectures; for those, Branch
8047 Likely instructions will not be generated by default because the MIPS32
8048 and MIPS64 architectures specifically deprecate their use.
8049 @end table
8050
8051 @node i386 and x86-64 Options
8052 @subsection Intel 386 and AMD x86-64 Options
8053 @cindex i386 Options
8054 @cindex x86-64 Options
8055 @cindex Intel 386 Options
8056 @cindex AMD x86-64 Options
8057
8058 These @samp{-m} options are defined for the i386 and x86-64 family of
8059 computers:
8060
8061 @table @gcctabopt
8062 @item -mtune=@var{cpu-type}
8063 @opindex mtune
8064 Tune to @var{cpu-type} everything applicable about the generated code, except
8065 for the ABI and the set of available instructions.  The choices for
8066 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8067 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8068 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8069 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8070 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8071 and @samp{c3-2}.
8072
8073 While picking a specific @var{cpu-type} will schedule things appropriately
8074 for that particular chip, the compiler will not generate any code that
8075 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8076 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8077 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8078 AMD chips as opposed to the Intel ones.
8079
8080 @item -march=@var{cpu-type}
8081 @opindex march
8082 Generate instructions for the machine type @var{cpu-type}.  The choices
8083 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8084 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8085
8086 @item -mcpu=@var{cpu-type}
8087 @opindex mcpu
8088 A deprecated synonym for @option{-mtune}.
8089
8090 @item -m386
8091 @itemx -m486
8092 @itemx -mpentium
8093 @itemx -mpentiumpro
8094 @opindex m386
8095 @opindex m486
8096 @opindex mpentium
8097 @opindex mpentiumpro
8098 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8099 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8100 These synonyms are deprecated.
8101
8102 @item -mfpmath=@var{unit}
8103 @opindex march
8104 generate floating point arithmetics for selected unit @var{unit}.  the choices
8105 for @var{unit} are:
8106
8107 @table @samp
8108 @item 387
8109 Use the standard 387 floating point coprocessor present majority of chips and
8110 emulated otherwise.  Code compiled with this option will run almost everywhere.
8111 The temporary results are computed in 80bit precision instead of precision
8112 specified by the type resulting in slightly different results compared to most
8113 of other chips. See @option{-ffloat-store} for more detailed description.
8114
8115 This is the default choice for i386 compiler.
8116
8117 @item sse
8118 Use scalar floating point instructions present in the SSE instruction set.
8119 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8120 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8121 instruction set supports only single precision arithmetics, thus the double and
8122 extended precision arithmetics is still done using 387.  Later version, present
8123 only in Pentium4 and the future AMD x86-64 chips supports double precision
8124 arithmetics too.
8125
8126 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8127 @option{-msse2} switches to enable SSE extensions and make this option
8128 effective.  For x86-64 compiler, these extensions are enabled by default.
8129
8130 The resulting code should be considerably faster in majority of cases and avoid
8131 the numerical instability problems of 387 code, but may break some existing
8132 code that expects temporaries to be 80bit.
8133
8134 This is the default choice for x86-64 compiler.
8135
8136 @item sse,387
8137 Attempt to utilize both instruction sets at once.  This effectively double the
8138 amount of available registers and on chips with separate execution units for
8139 387 and SSE the execution resources too.  Use this option with care, as it is
8140 still experimental, because gcc register allocator does not model separate
8141 functional units well resulting in instable performance.
8142 @end table
8143
8144 @item -masm=@var{dialect}
8145 @opindex masm=@var{dialect}
8146 Output asm instructions using selected @var{dialect}. Supported choices are
8147 @samp{intel} or @samp{att} (the default one).
8148
8149 @item -mieee-fp
8150 @itemx -mno-ieee-fp
8151 @opindex mieee-fp
8152 @opindex mno-ieee-fp
8153 Control whether or not the compiler uses IEEE floating point
8154 comparisons.  These handle correctly the case where the result of a
8155 comparison is unordered.
8156
8157 @item -msoft-float
8158 @opindex msoft-float
8159 Generate output containing library calls for floating point.
8160 @strong{Warning:} the requisite libraries are not part of GCC@.
8161 Normally the facilities of the machine's usual C compiler are used, but
8162 this can't be done directly in cross-compilation.  You must make your
8163 own arrangements to provide suitable library functions for
8164 cross-compilation.
8165
8166 On machines where a function returns floating point results in the 80387
8167 register stack, some floating point opcodes may be emitted even if
8168 @option{-msoft-float} is used.
8169
8170 @item -mno-fp-ret-in-387
8171 @opindex mno-fp-ret-in-387
8172 Do not use the FPU registers for return values of functions.
8173
8174 The usual calling convention has functions return values of types
8175 @code{float} and @code{double} in an FPU register, even if there
8176 is no FPU@.  The idea is that the operating system should emulate
8177 an FPU@.
8178
8179 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8180 in ordinary CPU registers instead.
8181
8182 @item -mno-fancy-math-387
8183 @opindex mno-fancy-math-387
8184 Some 387 emulators do not support the @code{sin}, @code{cos} and
8185 @code{sqrt} instructions for the 387.  Specify this option to avoid
8186 generating those instructions.  This option is the default on FreeBSD,
8187 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8188 indicates that the target cpu will always have an FPU and so the
8189 instruction will not need emulation.  As of revision 2.6.1, these
8190 instructions are not generated unless you also use the
8191 @option{-funsafe-math-optimizations} switch.
8192
8193 @item -malign-double
8194 @itemx -mno-align-double
8195 @opindex malign-double
8196 @opindex mno-align-double
8197 Control whether GCC aligns @code{double}, @code{long double}, and
8198 @code{long long} variables on a two word boundary or a one word
8199 boundary.  Aligning @code{double} variables on a two word boundary will
8200 produce code that runs somewhat faster on a @samp{Pentium} at the
8201 expense of more memory.
8202
8203 @strong{Warning:} if you use the @option{-malign-double} switch,
8204 structures containing the above types will be aligned differently than
8205 the published application binary interface specifications for the 386
8206 and will not be binary compatible with structures in code compiled
8207 without that switch.
8208
8209 @item -m128bit-long-double
8210 @opindex m128bit-long-double
8211 Control the size of @code{long double} type. i386 application binary interface
8212 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8213 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8214 impossible to reach with 12 byte long doubles in the array accesses.
8215
8216 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8217 structures and arrays containing @code{long double} will change their size as
8218 well as function calling convention for function taking @code{long double}
8219 will be modified.
8220
8221 @item -m96bit-long-double
8222 @opindex m96bit-long-double
8223 Set the size of @code{long double} to 96 bits as required by the i386
8224 application binary interface.  This is the default.
8225
8226 @item -msvr3-shlib
8227 @itemx -mno-svr3-shlib
8228 @opindex msvr3-shlib
8229 @opindex mno-svr3-shlib
8230 Control whether GCC places uninitialized local variables into the
8231 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8232 into @code{bss}.  These options are meaningful only on System V Release 3.
8233
8234 @item -mrtd
8235 @opindex mrtd
8236 Use a different function-calling convention, in which functions that
8237 take a fixed number of arguments return with the @code{ret} @var{num}
8238 instruction, which pops their arguments while returning.  This saves one
8239 instruction in the caller since there is no need to pop the arguments
8240 there.
8241
8242 You can specify that an individual function is called with this calling
8243 sequence with the function attribute @samp{stdcall}.  You can also
8244 override the @option{-mrtd} option by using the function attribute
8245 @samp{cdecl}.  @xref{Function Attributes}.
8246
8247 @strong{Warning:} this calling convention is incompatible with the one
8248 normally used on Unix, so you cannot use it if you need to call
8249 libraries compiled with the Unix compiler.
8250
8251 Also, you must provide function prototypes for all functions that
8252 take variable numbers of arguments (including @code{printf});
8253 otherwise incorrect code will be generated for calls to those
8254 functions.
8255
8256 In addition, seriously incorrect code will result if you call a
8257 function with too many arguments.  (Normally, extra arguments are
8258 harmlessly ignored.)
8259
8260 @item -mregparm=@var{num}
8261 @opindex mregparm
8262 Control how many registers are used to pass integer arguments.  By
8263 default, no registers are used to pass arguments, and at most 3
8264 registers can be used.  You can control this behavior for a specific
8265 function by using the function attribute @samp{regparm}.
8266 @xref{Function Attributes}.
8267
8268 @strong{Warning:} if you use this switch, and
8269 @var{num} is nonzero, then you must build all modules with the same
8270 value, including any libraries.  This includes the system libraries and
8271 startup modules.
8272
8273 @item -mpreferred-stack-boundary=@var{num}
8274 @opindex mpreferred-stack-boundary
8275 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8276 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8277 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8278 size (@option{-Os}), in which case the default is the minimum correct
8279 alignment (4 bytes for x86, and 8 bytes for x86-64).
8280
8281 On Pentium and PentiumPro, @code{double} and @code{long double} values
8282 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8283 suffer significant run time performance penalties.  On Pentium III, the
8284 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8285 penalties if it is not 16 byte aligned.
8286
8287 To ensure proper alignment of this values on the stack, the stack boundary
8288 must be as aligned as that required by any value stored on the stack.
8289 Further, every function must be generated such that it keeps the stack
8290 aligned.  Thus calling a function compiled with a higher preferred
8291 stack boundary from a function compiled with a lower preferred stack
8292 boundary will most likely misalign the stack.  It is recommended that
8293 libraries that use callbacks always use the default setting.
8294
8295 This extra alignment does consume extra stack space, and generally
8296 increases code size.  Code that is sensitive to stack space usage, such
8297 as embedded systems and operating system kernels, may want to reduce the
8298 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8299
8300 @item -mmmx
8301 @itemx -mno-mmx
8302 @item -msse
8303 @itemx -mno-sse
8304 @item -msse2
8305 @itemx -mno-sse2
8306 @item -m3dnow
8307 @itemx -mno-3dnow
8308 @opindex mmmx
8309 @opindex mno-mmx
8310 @opindex msse
8311 @opindex mno-sse
8312 @opindex m3dnow
8313 @opindex mno-3dnow
8314 These switches enable or disable the use of built-in functions that allow
8315 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8316
8317 @xref{X86 Built-in Functions}, for details of the functions enabled
8318 and disabled by these switches.
8319
8320 To have SSE/SSE2 instructions generated automatically from floating-point
8321 code, see @option{-mfpmath=sse}.
8322
8323 @item -mpush-args
8324 @itemx -mno-push-args
8325 @opindex mpush-args
8326 @opindex mno-push-args
8327 Use PUSH operations to store outgoing parameters.  This method is shorter
8328 and usually equally fast as method using SUB/MOV operations and is enabled
8329 by default.  In some cases disabling it may improve performance because of
8330 improved scheduling and reduced dependencies.
8331
8332 @item -maccumulate-outgoing-args
8333 @opindex maccumulate-outgoing-args
8334 If enabled, the maximum amount of space required for outgoing arguments will be
8335 computed in the function prologue.  This is faster on most modern CPUs
8336 because of reduced dependencies, improved scheduling and reduced stack usage
8337 when preferred stack boundary is not equal to 2.  The drawback is a notable
8338 increase in code size.  This switch implies @option{-mno-push-args}.
8339
8340 @item -mthreads
8341 @opindex mthreads
8342 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8343 on thread-safe exception handling must compile and link all code with the
8344 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8345 @option{-D_MT}; when linking, it links in a special thread helper library
8346 @option{-lmingwthrd} which cleans up per thread exception handling data.
8347
8348 @item -mno-align-stringops
8349 @opindex mno-align-stringops
8350 Do not align destination of inlined string operations.  This switch reduces
8351 code size and improves performance in case the destination is already aligned,
8352 but gcc don't know about it.
8353
8354 @item -minline-all-stringops
8355 @opindex minline-all-stringops
8356 By default GCC inlines string operations only when destination is known to be
8357 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8358 size, but may improve performance of code that depends on fast memcpy, strlen
8359 and memset for short lengths.
8360
8361 @item -momit-leaf-frame-pointer
8362 @opindex momit-leaf-frame-pointer
8363 Don't keep the frame pointer in a register for leaf functions.  This
8364 avoids the instructions to save, set up and restore frame pointers and
8365 makes an extra register available in leaf functions.  The option
8366 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8367 which might make debugging harder.
8368 @end table
8369
8370 These @samp{-m} switches are supported in addition to the above
8371 on AMD x86-64 processors in 64-bit environments.
8372
8373 @table @gcctabopt
8374 @item -m32
8375 @itemx -m64
8376 @opindex m32
8377 @opindex m64
8378 Generate code for a 32-bit or 64-bit environment.
8379 The 32-bit environment sets int, long and pointer to 32 bits and
8380 generates code that runs on any i386 system.
8381 The 64-bit environment sets int to 32 bits and long and pointer
8382 to 64 bits and generates code for AMD's x86-64 architecture.
8383
8384 @item -mno-red-zone
8385 @opindex no-red-zone
8386 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8387 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8388 stack pointer that will not be modified by signal or interrupt handlers
8389 and therefore can be used for temporary data without adjusting the stack
8390 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8391
8392 @item -mcmodel=small
8393 @opindex mcmodel=small
8394 Generate code for the small code model: the program and its symbols must
8395 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8396 Programs can be statically or dynamically linked.  This is the default
8397 code model.
8398
8399 @item -mcmodel=kernel
8400 @opindex mcmodel=kernel
8401 Generate code for the kernel code model.  The kernel runs in the
8402 negative 2 GB of the address space.
8403 This model has to be used for Linux kernel code.
8404
8405 @item -mcmodel=medium
8406 @opindex mcmodel=medium
8407 Generate code for the medium model: The program is linked in the lower 2
8408 GB of the address space but symbols can be located anywhere in the
8409 address space.  Programs can be statically or dynamically linked, but
8410 building of shared libraries are not supported with the medium model.
8411
8412 @item -mcmodel=large
8413 @opindex mcmodel=large
8414 Generate code for the large model: This model makes no assumptions
8415 about addresses and sizes of sections.  Currently GCC does not implement
8416 this model.
8417 @end table
8418
8419 @node HPPA Options
8420 @subsection HPPA Options
8421 @cindex HPPA Options
8422
8423 These @samp{-m} options are defined for the HPPA family of computers:
8424
8425 @table @gcctabopt
8426 @item -march=@var{architecture-type}
8427 @opindex march
8428 Generate code for the specified architecture.  The choices for
8429 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8430 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8431 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8432 architecture option for your machine.  Code compiled for lower numbered
8433 architectures will run on higher numbered architectures, but not the
8434 other way around.
8435
8436 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8437 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8438 support.
8439
8440 @item -mpa-risc-1-0
8441 @itemx -mpa-risc-1-1
8442 @itemx -mpa-risc-2-0
8443 @opindex mpa-risc-1-0
8444 @opindex mpa-risc-1-1
8445 @opindex mpa-risc-2-0
8446 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8447
8448 @item -mbig-switch
8449 @opindex mbig-switch
8450 Generate code suitable for big switch tables.  Use this option only if
8451 the assembler/linker complain about out of range branches within a switch
8452 table.
8453
8454 @item -mjump-in-delay
8455 @opindex mjump-in-delay
8456 Fill delay slots of function calls with unconditional jump instructions
8457 by modifying the return pointer for the function call to be the target
8458 of the conditional jump.
8459
8460 @item -mdisable-fpregs
8461 @opindex mdisable-fpregs
8462 Prevent floating point registers from being used in any manner.  This is
8463 necessary for compiling kernels which perform lazy context switching of
8464 floating point registers.  If you use this option and attempt to perform
8465 floating point operations, the compiler will abort.
8466
8467 @item -mdisable-indexing
8468 @opindex mdisable-indexing
8469 Prevent the compiler from using indexing address modes.  This avoids some
8470 rather obscure problems when compiling MIG generated code under MACH@.
8471
8472 @item -mno-space-regs
8473 @opindex mno-space-regs
8474 Generate code that assumes the target has no space registers.  This allows
8475 GCC to generate faster indirect calls and use unscaled index address modes.
8476
8477 Such code is suitable for level 0 PA systems and kernels.
8478
8479 @item -mfast-indirect-calls
8480 @opindex mfast-indirect-calls
8481 Generate code that assumes calls never cross space boundaries.  This
8482 allows GCC to emit code which performs faster indirect calls.
8483
8484 This option will not work in the presence of shared libraries or nested
8485 functions.
8486
8487 @item -mlong-load-store
8488 @opindex mlong-load-store
8489 Generate 3-instruction load and store sequences as sometimes required by
8490 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8491 the HP compilers.
8492
8493 @item -mportable-runtime
8494 @opindex mportable-runtime
8495 Use the portable calling conventions proposed by HP for ELF systems.
8496
8497 @item -mgas
8498 @opindex mgas
8499 Enable the use of assembler directives only GAS understands.
8500
8501 @item -mschedule=@var{cpu-type}
8502 @opindex mschedule
8503 Schedule code according to the constraints for the machine type
8504 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8505 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8506 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8507 proper scheduling option for your machine.  The default scheduling is
8508 @samp{8000}.
8509
8510 @item -mlinker-opt
8511 @opindex mlinker-opt
8512 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8513 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8514 linkers in which they give bogus error messages when linking some programs.
8515
8516 @item -msoft-float
8517 @opindex msoft-float
8518 Generate output containing library calls for floating point.
8519 @strong{Warning:} the requisite libraries are not available for all HPPA
8520 targets.  Normally the facilities of the machine's usual C compiler are
8521 used, but this cannot be done directly in cross-compilation.  You must make
8522 your own arrangements to provide suitable library functions for
8523 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8524 does provide software floating point support.
8525
8526 @option{-msoft-float} changes the calling convention in the output file;
8527 therefore, it is only useful if you compile @emph{all} of a program with
8528 this option.  In particular, you need to compile @file{libgcc.a}, the
8529 library that comes with GCC, with @option{-msoft-float} in order for
8530 this to work.
8531
8532 @item -msio
8533 @opindex msio
8534 Generate the predefine, @code{_SIO}, for server IO.  The default is
8535 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8536 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8537 options are available under HP-UX and HI-UX.
8538
8539 @item -mgnu-ld
8540 @opindex gnu-ld
8541 Use GNU ld specific options.  This passes @option{-shared} to ld when
8542 building a shared library.  It is the default when GCC is configured,
8543 explicitly or implicitly, with the GNU linker.  This option does not
8544 have any affect on which ld is called, it only changes what parameters
8545 are passed to that ld.  The ld that is called is determined by the
8546 @option{--with-ld} configure option, gcc's program search path, and
8547 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8548 using @samp{which `gcc -print-prog-name=ld`}.
8549
8550 @item -mhp-ld
8551 @opindex hp-ld
8552 Use HP ld specific options.  This passes @option{-b} to ld when building
8553 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8554 links.  It is the default when GCC is configured, explicitly or
8555 implicitly, with the HP linker.  This option does not have any affect on
8556 which ld is called, it only changes what parameters are passed to that
8557 ld.  The ld that is called is determined by the @option{--with-ld}
8558 configure option, gcc's program search path, and finally by the user's
8559 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8560 `gcc -print-prog-name=ld`}.
8561
8562 @item -mlong-calls
8563 @opindex mno-long-calls
8564 Generate code that uses long call sequences.  This ensures that a call
8565 is always able to reach linker generated stubs.  The default is to generate
8566 long calls only when the distance from the call site to the beginning
8567 of the function or translation unit, as the case may be, exceeds a
8568 predefined limit set by the branch type being used.  The limits for
8569 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8570 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8571 240,000 bytes.
8572
8573 Distances are measured from the beginning of functions when using the
8574 @option{-ffunction-sections} option, or when using the @option{-mgas}
8575 and @option{-mno-portable-runtime} options together under HP-UX with
8576 the SOM linker.
8577
8578 It is normally not desirable to use this option as it will degrade
8579 performance.  However, it may be useful in large applications,
8580 particularly when partial linking is used to build the application.
8581
8582 The types of long calls used depends on the capabilities of the
8583 assembler and linker, and the type of code being generated.  The
8584 impact on systems that support long absolute calls, and long pic
8585 symbol-difference or pc-relative calls should be relatively small.
8586 However, an indirect call is used on 32-bit ELF systems in pic code
8587 and it is quite long.
8588
8589 @item -nolibdld
8590 @opindex nolibdld
8591 Suppress the generation of link options to search libdld.sl when the
8592 @option{-static} option is specified on HP-UX 10 and later.
8593
8594 @item -static
8595 @opindex static
8596 The HP-UX implementation of setlocale in libc has a dependency on
8597 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8598 when the @option{-static} option is specified, special link options
8599 are needed to resolve this dependency.
8600
8601 On HP-UX 10 and later, the GCC driver adds the necessary options to
8602 link with libdld.sl when the @option{-static} option is specified.
8603 This causes the resulting binary to be dynamic.  On the 64-bit port,
8604 the linkers generate dynamic binaries by default in any case.  The
8605 @option{-nolibdld} option can be used to prevent the GCC driver from
8606 adding these link options.
8607
8608 @item -threads
8609 @opindex threads
8610 Add support for multithreading with the @dfn{dce thread} library
8611 under HP-UX.  This option sets flags for both the preprocessor and
8612 linker.
8613 @end table
8614
8615 @node Intel 960 Options
8616 @subsection Intel 960 Options
8617
8618 These @samp{-m} options are defined for the Intel 960 implementations:
8619
8620 @table @gcctabopt
8621 @item -m@var{cpu-type}
8622 @opindex mka
8623 @opindex mkb
8624 @opindex mmc
8625 @opindex mca
8626 @opindex mcf
8627 @opindex msa
8628 @opindex msb
8629 Assume the defaults for the machine type @var{cpu-type} for some of
8630 the other options, including instruction scheduling, floating point
8631 support, and addressing modes.  The choices for @var{cpu-type} are
8632 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8633 @samp{sa}, and @samp{sb}.
8634 The default is
8635 @samp{kb}.
8636
8637 @item -mnumerics
8638 @itemx -msoft-float
8639 @opindex mnumerics
8640 @opindex msoft-float
8641 The @option{-mnumerics} option indicates that the processor does support
8642 floating-point instructions.  The @option{-msoft-float} option indicates
8643 that floating-point support should not be assumed.
8644
8645 @item -mleaf-procedures
8646 @itemx -mno-leaf-procedures
8647 @opindex mleaf-procedures
8648 @opindex mno-leaf-procedures
8649 Do (or do not) attempt to alter leaf procedures to be callable with the
8650 @code{bal} instruction as well as @code{call}.  This will result in more
8651 efficient code for explicit calls when the @code{bal} instruction can be
8652 substituted by the assembler or linker, but less efficient code in other
8653 cases, such as calls via function pointers, or using a linker that doesn't
8654 support this optimization.
8655
8656 @item -mtail-call
8657 @itemx -mno-tail-call
8658 @opindex mtail-call
8659 @opindex mno-tail-call
8660 Do (or do not) make additional attempts (beyond those of the
8661 machine-independent portions of the compiler) to optimize tail-recursive
8662 calls into branches.  You may not want to do this because the detection of
8663 cases where this is not valid is not totally complete.  The default is
8664 @option{-mno-tail-call}.
8665
8666 @item -mcomplex-addr
8667 @itemx -mno-complex-addr
8668 @opindex mcomplex-addr
8669 @opindex mno-complex-addr
8670 Assume (or do not assume) that the use of a complex addressing mode is a
8671 win on this implementation of the i960.  Complex addressing modes may not
8672 be worthwhile on the K-series, but they definitely are on the C-series.
8673 The default is currently @option{-mcomplex-addr} for all processors except
8674 the CB and CC@.
8675
8676 @item -mcode-align
8677 @itemx -mno-code-align
8678 @opindex mcode-align
8679 @opindex mno-code-align
8680 Align code to 8-byte boundaries for faster fetching (or don't bother).
8681 Currently turned on by default for C-series implementations only.
8682
8683 @ignore
8684 @item -mclean-linkage
8685 @itemx -mno-clean-linkage
8686 @opindex mclean-linkage
8687 @opindex mno-clean-linkage
8688 These options are not fully implemented.
8689 @end ignore
8690
8691 @item -mic-compat
8692 @itemx -mic2.0-compat
8693 @itemx -mic3.0-compat
8694 @opindex mic-compat
8695 @opindex mic2.0-compat
8696 @opindex mic3.0-compat
8697 Enable compatibility with iC960 v2.0 or v3.0.
8698
8699 @item -masm-compat
8700 @itemx -mintel-asm
8701 @opindex masm-compat
8702 @opindex mintel-asm
8703 Enable compatibility with the iC960 assembler.
8704
8705 @item -mstrict-align
8706 @itemx -mno-strict-align
8707 @opindex mstrict-align
8708 @opindex mno-strict-align
8709 Do not permit (do permit) unaligned accesses.
8710
8711 @item -mold-align
8712 @opindex mold-align
8713 Enable structure-alignment compatibility with Intel's gcc release version
8714 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8715
8716 @item -mlong-double-64
8717 @opindex mlong-double-64
8718 Implement type @samp{long double} as 64-bit floating point numbers.
8719 Without the option @samp{long double} is implemented by 80-bit
8720 floating point numbers.  The only reason we have it because there is
8721 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8722 is only useful for people using soft-float targets.  Otherwise, we
8723 should recommend against use of it.
8724
8725 @end table
8726
8727 @node DEC Alpha Options
8728 @subsection DEC Alpha Options
8729
8730 These @samp{-m} options are defined for the DEC Alpha implementations:
8731
8732 @table @gcctabopt
8733 @item -mno-soft-float
8734 @itemx -msoft-float
8735 @opindex mno-soft-float
8736 @opindex msoft-float
8737 Use (do not use) the hardware floating-point instructions for
8738 floating-point operations.  When @option{-msoft-float} is specified,
8739 functions in @file{libgcc.a} will be used to perform floating-point
8740 operations.  Unless they are replaced by routines that emulate the
8741 floating-point operations, or compiled in such a way as to call such
8742 emulations routines, these routines will issue floating-point
8743 operations.   If you are compiling for an Alpha without floating-point
8744 operations, you must ensure that the library is built so as not to call
8745 them.
8746
8747 Note that Alpha implementations without floating-point operations are
8748 required to have floating-point registers.
8749
8750 @item -mfp-reg
8751 @itemx -mno-fp-regs
8752 @opindex mfp-reg
8753 @opindex mno-fp-regs
8754 Generate code that uses (does not use) the floating-point register set.
8755 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8756 register set is not used, floating point operands are passed in integer
8757 registers as if they were integers and floating-point results are passed
8758 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8759 so any function with a floating-point argument or return value called by code
8760 compiled with @option{-mno-fp-regs} must also be compiled with that
8761 option.
8762
8763 A typical use of this option is building a kernel that does not use,
8764 and hence need not save and restore, any floating-point registers.
8765
8766 @item -mieee
8767 @opindex mieee
8768 The Alpha architecture implements floating-point hardware optimized for
8769 maximum performance.  It is mostly compliant with the IEEE floating
8770 point standard.  However, for full compliance, software assistance is
8771 required.  This option generates code fully IEEE compliant code
8772 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8773 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8774 defined during compilation.  The resulting code is less efficient but is
8775 able to correctly support denormalized numbers and exceptional IEEE
8776 values such as not-a-number and plus/minus infinity.  Other Alpha
8777 compilers call this option @option{-ieee_with_no_inexact}.
8778
8779 @item -mieee-with-inexact
8780 @opindex mieee-with-inexact
8781 This is like @option{-mieee} except the generated code also maintains
8782 the IEEE @var{inexact-flag}.  Turning on this option causes the
8783 generated code to implement fully-compliant IEEE math.  In addition to
8784 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8785 macro.  On some Alpha implementations the resulting code may execute
8786 significantly slower than the code generated by default.  Since there is
8787 very little code that depends on the @var{inexact-flag}, you should
8788 normally not specify this option.  Other Alpha compilers call this
8789 option @option{-ieee_with_inexact}.
8790
8791 @item -mfp-trap-mode=@var{trap-mode}
8792 @opindex mfp-trap-mode
8793 This option controls what floating-point related traps are enabled.
8794 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8795 The trap mode can be set to one of four values:
8796
8797 @table @samp
8798 @item n
8799 This is the default (normal) setting.  The only traps that are enabled
8800 are the ones that cannot be disabled in software (e.g., division by zero
8801 trap).
8802
8803 @item u
8804 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8805 as well.
8806
8807 @item su
8808 Like @samp{su}, but the instructions are marked to be safe for software
8809 completion (see Alpha architecture manual for details).
8810
8811 @item sui
8812 Like @samp{su}, but inexact traps are enabled as well.
8813 @end table
8814
8815 @item -mfp-rounding-mode=@var{rounding-mode}
8816 @opindex mfp-rounding-mode
8817 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8818 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8819 of:
8820
8821 @table @samp
8822 @item n
8823 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8824 the nearest machine number or towards the even machine number in case
8825 of a tie.
8826
8827 @item m
8828 Round towards minus infinity.
8829
8830 @item c
8831 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8832
8833 @item d
8834 Dynamic rounding mode.  A field in the floating point control register
8835 (@var{fpcr}, see Alpha architecture reference manual) controls the
8836 rounding mode in effect.  The C library initializes this register for
8837 rounding towards plus infinity.  Thus, unless your program modifies the
8838 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8839 @end table
8840
8841 @item -mtrap-precision=@var{trap-precision}
8842 @opindex mtrap-precision
8843 In the Alpha architecture, floating point traps are imprecise.  This
8844 means without software assistance it is impossible to recover from a
8845 floating trap and program execution normally needs to be terminated.
8846 GCC can generate code that can assist operating system trap handlers
8847 in determining the exact location that caused a floating point trap.
8848 Depending on the requirements of an application, different levels of
8849 precisions can be selected:
8850
8851 @table @samp
8852 @item p
8853 Program precision.  This option is the default and means a trap handler
8854 can only identify which program caused a floating point exception.
8855
8856 @item f
8857 Function precision.  The trap handler can determine the function that
8858 caused a floating point exception.
8859
8860 @item i
8861 Instruction precision.  The trap handler can determine the exact
8862 instruction that caused a floating point exception.
8863 @end table
8864
8865 Other Alpha compilers provide the equivalent options called
8866 @option{-scope_safe} and @option{-resumption_safe}.
8867
8868 @item -mieee-conformant
8869 @opindex mieee-conformant
8870 This option marks the generated code as IEEE conformant.  You must not
8871 use this option unless you also specify @option{-mtrap-precision=i} and either
8872 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8873 is to emit the line @samp{.eflag 48} in the function prologue of the
8874 generated assembly file.  Under DEC Unix, this has the effect that
8875 IEEE-conformant math library routines will be linked in.
8876
8877 @item -mbuild-constants
8878 @opindex mbuild-constants
8879 Normally GCC examines a 32- or 64-bit integer constant to
8880 see if it can construct it from smaller constants in two or three
8881 instructions.  If it cannot, it will output the constant as a literal and
8882 generate code to load it from the data segment at runtime.
8883
8884 Use this option to require GCC to construct @emph{all} integer constants
8885 using code, even if it takes more instructions (the maximum is six).
8886
8887 You would typically use this option to build a shared library dynamic
8888 loader.  Itself a shared library, it must relocate itself in memory
8889 before it can find the variables and constants in its own data segment.
8890
8891 @item -malpha-as
8892 @itemx -mgas
8893 @opindex malpha-as
8894 @opindex mgas
8895 Select whether to generate code to be assembled by the vendor-supplied
8896 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8897
8898 @item -mbwx
8899 @itemx -mno-bwx
8900 @itemx -mcix
8901 @itemx -mno-cix
8902 @itemx -mfix
8903 @itemx -mno-fix
8904 @itemx -mmax
8905 @itemx -mno-max
8906 @opindex mbwx
8907 @opindex mno-bwx
8908 @opindex mcix
8909 @opindex mno-cix
8910 @opindex mfix
8911 @opindex mno-fix
8912 @opindex mmax
8913 @opindex mno-max
8914 Indicate whether GCC should generate code to use the optional BWX,
8915 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8916 sets supported by the CPU type specified via @option{-mcpu=} option or that
8917 of the CPU on which GCC was built if none was specified.
8918
8919 @item -mfloat-vax
8920 @itemx -mfloat-ieee
8921 @opindex mfloat-vax
8922 @opindex mfloat-ieee
8923 Generate code that uses (does not use) VAX F and G floating point
8924 arithmetic instead of IEEE single and double precision.
8925
8926 @item -mexplicit-relocs
8927 @itemx -mno-explicit-relocs
8928 @opindex mexplicit-relocs
8929 @opindex mno-explicit-relocs
8930 Older Alpha assemblers provided no way to generate symbol relocations
8931 except via assembler macros.  Use of these macros does not allow
8932 optimal instruction scheduling.  GNU binutils as of version 2.12
8933 supports a new syntax that allows the compiler to explicitly mark
8934 which relocations should apply to which instructions.  This option
8935 is mostly useful for debugging, as GCC detects the capabilities of
8936 the assembler when it is built and sets the default accordingly.
8937
8938 @item -msmall-data
8939 @itemx -mlarge-data
8940 @opindex msmall-data
8941 @opindex mlarge-data
8942 When @option{-mexplicit-relocs} is in effect, static data is
8943 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8944 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8945 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8946 16-bit relocations off of the @code{$gp} register.  This limits the
8947 size of the small data area to 64KB, but allows the variables to be
8948 directly accessed via a single instruction.
8949
8950 The default is @option{-mlarge-data}.  With this option the data area
8951 is limited to just below 2GB.  Programs that require more than 2GB of
8952 data must use @code{malloc} or @code{mmap} to allocate the data in the
8953 heap instead of in the program's data segment.
8954
8955 When generating code for shared libraries, @option{-fpic} implies
8956 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8957
8958 @item -msmall-text
8959 @itemx -mlarge-text
8960 @opindex msmall-text
8961 @opindex mlarge-text
8962 When @option{-msmall-text} is used, the compiler assumes that the
8963 code of the entire program (or shared library) fits in 4MB, and is
8964 thus reachable with a branch instruction.  When @option{-msmall-data}
8965 is used, the compiler can assume that all local symbols share the
8966 same @code{$gp} value, and thus reduce the number of instructions
8967 required for a function call from 4 to 1.
8968
8969 The default is @option{-mlarge-text}.
8970
8971 @item -mcpu=@var{cpu_type}
8972 @opindex mcpu
8973 Set the instruction set and instruction scheduling parameters for
8974 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8975 style name or the corresponding chip number.  GCC supports scheduling
8976 parameters for the EV4, EV5 and EV6 family of processors and will
8977 choose the default values for the instruction set from the processor
8978 you specify.  If you do not specify a processor type, GCC will default
8979 to the processor on which the compiler was built.
8980
8981 Supported values for @var{cpu_type} are
8982
8983 @table @samp
8984 @item ev4
8985 @item ev45
8986 @itemx 21064
8987 Schedules as an EV4 and has no instruction set extensions.
8988
8989 @item ev5
8990 @itemx 21164
8991 Schedules as an EV5 and has no instruction set extensions.
8992
8993 @item ev56
8994 @itemx 21164a
8995 Schedules as an EV5 and supports the BWX extension.
8996
8997 @item pca56
8998 @itemx 21164pc
8999 @itemx 21164PC
9000 Schedules as an EV5 and supports the BWX and MAX extensions.
9001
9002 @item ev6
9003 @itemx 21264
9004 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9005
9006 @item ev67
9007 @item 21264a
9008 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9009 @end table
9010
9011 @item -mtune=@var{cpu_type}
9012 @opindex mtune
9013 Set only the instruction scheduling parameters for machine type
9014 @var{cpu_type}.  The instruction set is not changed.
9015
9016 @item -mmemory-latency=@var{time}
9017 @opindex mmemory-latency
9018 Sets the latency the scheduler should assume for typical memory
9019 references as seen by the application.  This number is highly
9020 dependent on the memory access patterns used by the application
9021 and the size of the external cache on the machine.
9022
9023 Valid options for @var{time} are
9024
9025 @table @samp
9026 @item @var{number}
9027 A decimal number representing clock cycles.
9028
9029 @item L1
9030 @itemx L2
9031 @itemx L3
9032 @itemx main
9033 The compiler contains estimates of the number of clock cycles for
9034 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9035 (also called Dcache, Scache, and Bcache), as well as to main memory.
9036 Note that L3 is only valid for EV5.
9037
9038 @end table
9039 @end table
9040
9041 @node DEC Alpha/VMS Options
9042 @subsection DEC Alpha/VMS Options
9043
9044 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9045
9046 @table @gcctabopt
9047 @item -mvms-return-codes
9048 @opindex mvms-return-codes
9049 Return VMS condition codes from main.  The default is to return POSIX
9050 style condition (e.g.@ error) codes.
9051 @end table
9052
9053 @node H8/300 Options
9054 @subsection H8/300 Options
9055
9056 These @samp{-m} options are defined for the H8/300 implementations:
9057
9058 @table @gcctabopt
9059 @item -mrelax
9060 @opindex mrelax
9061 Shorten some address references at link time, when possible; uses the
9062 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9063 ld.info, Using ld}, for a fuller description.
9064
9065 @item -mh
9066 @opindex mh
9067 Generate code for the H8/300H@.
9068
9069 @item -ms
9070 @opindex ms
9071 Generate code for the H8S@.
9072
9073 @item -mn
9074 @opindex mn
9075 Generate code for the H8S and H8/300H in the normal mode.  This switch
9076 must be used either with -mh or -ms.
9077
9078 @item -ms2600
9079 @opindex ms2600
9080 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9081
9082 @item -mint32
9083 @opindex mint32
9084 Make @code{int} data 32 bits by default.
9085
9086 @item -malign-300
9087 @opindex malign-300
9088 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9089 The default for the H8/300H and H8S is to align longs and floats on 4
9090 byte boundaries.
9091 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9092 This option has no effect on the H8/300.
9093 @end table
9094
9095 @node SH Options
9096 @subsection SH Options
9097
9098 These @samp{-m} options are defined for the SH implementations:
9099
9100 @table @gcctabopt
9101 @item -m1
9102 @opindex m1
9103 Generate code for the SH1.
9104
9105 @item -m2
9106 @opindex m2
9107 Generate code for the SH2.
9108
9109 @item -m2e
9110 Generate code for the SH2e.
9111
9112 @item -m3
9113 @opindex m3
9114 Generate code for the SH3.
9115
9116 @item -m3e
9117 @opindex m3e
9118 Generate code for the SH3e.
9119
9120 @item -m4-nofpu
9121 @opindex m4-nofpu
9122 Generate code for the SH4 without a floating-point unit.
9123
9124 @item -m4-single-only
9125 @opindex m4-single-only
9126 Generate code for the SH4 with a floating-point unit that only
9127 supports single-precision arithmetic.
9128
9129 @item -m4-single
9130 @opindex m4-single
9131 Generate code for the SH4 assuming the floating-point unit is in
9132 single-precision mode by default.
9133
9134 @item -m4
9135 @opindex m4
9136 Generate code for the SH4.
9137
9138 @item -mb
9139 @opindex mb
9140 Compile code for the processor in big endian mode.
9141
9142 @item -ml
9143 @opindex ml
9144 Compile code for the processor in little endian mode.
9145
9146 @item -mdalign
9147 @opindex mdalign
9148 Align doubles at 64-bit boundaries.  Note that this changes the calling
9149 conventions, and thus some functions from the standard C library will
9150 not work unless you recompile it first with @option{-mdalign}.
9151
9152 @item -mrelax
9153 @opindex mrelax
9154 Shorten some address references at link time, when possible; uses the
9155 linker option @option{-relax}.
9156
9157 @item -mbigtable
9158 @opindex mbigtable
9159 Use 32-bit offsets in @code{switch} tables.  The default is to use
9160 16-bit offsets.
9161
9162 @item -mfmovd
9163 @opindex mfmovd
9164 Enable the use of the instruction @code{fmovd}.
9165
9166 @item -mhitachi
9167 @opindex mhitachi
9168 Comply with the calling conventions defined by Hitachi.
9169
9170 @item -mnomacsave
9171 @opindex mnomacsave
9172 Mark the @code{MAC} register as call-clobbered, even if
9173 @option{-mhitachi} is given.
9174
9175 @item -mieee
9176 @opindex mieee
9177 Increase IEEE-compliance of floating-point code.
9178
9179 @item -misize
9180 @opindex misize
9181 Dump instruction size and location in the assembly code.
9182
9183 @item -mpadstruct
9184 @opindex mpadstruct
9185 This option is deprecated.  It pads structures to multiple of 4 bytes,
9186 which is incompatible with the SH ABI@.
9187
9188 @item -mspace
9189 @opindex mspace
9190 Optimize for space instead of speed.  Implied by @option{-Os}.
9191
9192 @item -mprefergot
9193 @opindex mprefergot
9194 When generating position-independent code, emit function calls using
9195 the Global Offset Table instead of the Procedure Linkage Table.
9196
9197 @item -musermode
9198 @opindex musermode
9199 Generate a library function call to invalidate instruction cache
9200 entries, after fixing up a trampoline.  This library function call
9201 doesn't assume it can write to the whole memory address space.  This
9202 is the default when the target is @code{sh-*-linux*}.
9203 @end table
9204
9205 @node System V Options
9206 @subsection Options for System V
9207
9208 These additional options are available on System V Release 4 for
9209 compatibility with other compilers on those systems:
9210
9211 @table @gcctabopt
9212 @item -G
9213 @opindex G
9214 Create a shared object.
9215 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9216
9217 @item -Qy
9218 @opindex Qy
9219 Identify the versions of each tool used by the compiler, in a
9220 @code{.ident} assembler directive in the output.
9221
9222 @item -Qn
9223 @opindex Qn
9224 Refrain from adding @code{.ident} directives to the output file (this is
9225 the default).
9226
9227 @item -YP,@var{dirs}
9228 @opindex YP
9229 Search the directories @var{dirs}, and no others, for libraries
9230 specified with @option{-l}.
9231
9232 @item -Ym,@var{dir}
9233 @opindex Ym
9234 Look in the directory @var{dir} to find the M4 preprocessor.
9235 The assembler uses this option.
9236 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9237 @c the generic assembler that comes with Solaris takes just -Ym.
9238 @end table
9239
9240 @node TMS320C3x/C4x Options
9241 @subsection TMS320C3x/C4x Options
9242 @cindex TMS320C3x/C4x Options
9243
9244 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9245
9246 @table @gcctabopt
9247
9248 @item -mcpu=@var{cpu_type}
9249 @opindex mcpu
9250 Set the instruction set, register set, and instruction scheduling
9251 parameters for machine type @var{cpu_type}.  Supported values for
9252 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9253 @samp{c44}.  The default is @samp{c40} to generate code for the
9254 TMS320C40.
9255
9256 @item -mbig-memory
9257 @item -mbig
9258 @itemx -msmall-memory
9259 @itemx -msmall
9260 @opindex mbig-memory
9261 @opindex mbig
9262 @opindex msmall-memory
9263 @opindex msmall
9264 Generates code for the big or small memory model.  The small memory
9265 model assumed that all data fits into one 64K word page.  At run-time
9266 the data page (DP) register must be set to point to the 64K page
9267 containing the .bss and .data program sections.  The big memory model is
9268 the default and requires reloading of the DP register for every direct
9269 memory access.
9270
9271 @item -mbk
9272 @itemx -mno-bk
9273 @opindex mbk
9274 @opindex mno-bk
9275 Allow (disallow) allocation of general integer operands into the block
9276 count register BK@.
9277
9278 @item -mdb
9279 @itemx -mno-db
9280 @opindex mdb
9281 @opindex mno-db
9282 Enable (disable) generation of code using decrement and branch,
9283 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9284 on the safe side, this is disabled for the C3x, since the maximum
9285 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9286 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9287 that it can utilize the decrement and branch instruction, but will give
9288 up if there is more than one memory reference in the loop.  Thus a loop
9289 where the loop counter is decremented can generate slightly more
9290 efficient code, in cases where the RPTB instruction cannot be utilized.
9291
9292 @item -mdp-isr-reload
9293 @itemx -mparanoid
9294 @opindex mdp-isr-reload
9295 @opindex mparanoid
9296 Force the DP register to be saved on entry to an interrupt service
9297 routine (ISR), reloaded to point to the data section, and restored on
9298 exit from the ISR@.  This should not be required unless someone has
9299 violated the small memory model by modifying the DP register, say within
9300 an object library.
9301
9302 @item -mmpyi
9303 @itemx -mno-mpyi
9304 @opindex mmpyi
9305 @opindex mno-mpyi
9306 For the C3x use the 24-bit MPYI instruction for integer multiplies
9307 instead of a library call to guarantee 32-bit results.  Note that if one
9308 of the operands is a constant, then the multiplication will be performed
9309 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9310 then squaring operations are performed inline instead of a library call.
9311
9312 @item -mfast-fix
9313 @itemx -mno-fast-fix
9314 @opindex mfast-fix
9315 @opindex mno-fast-fix
9316 The C3x/C4x FIX instruction to convert a floating point value to an
9317 integer value chooses the nearest integer less than or equal to the
9318 floating point value rather than to the nearest integer.  Thus if the
9319 floating point number is negative, the result will be incorrectly
9320 truncated an additional code is necessary to detect and correct this
9321 case.  This option can be used to disable generation of the additional
9322 code required to correct the result.
9323
9324 @item -mrptb
9325 @itemx -mno-rptb
9326 @opindex mrptb
9327 @opindex mno-rptb
9328 Enable (disable) generation of repeat block sequences using the RPTB
9329 instruction for zero overhead looping.  The RPTB construct is only used
9330 for innermost loops that do not call functions or jump across the loop
9331 boundaries.  There is no advantage having nested RPTB loops due to the
9332 overhead required to save and restore the RC, RS, and RE registers.
9333 This is enabled by default with @option{-O2}.
9334
9335 @item -mrpts=@var{count}
9336 @itemx -mno-rpts
9337 @opindex mrpts
9338 @opindex mno-rpts
9339 Enable (disable) the use of the single instruction repeat instruction
9340 RPTS@.  If a repeat block contains a single instruction, and the loop
9341 count can be guaranteed to be less than the value @var{count}, GCC will
9342 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9343 then a RPTS will be emitted even if the loop count cannot be determined
9344 at compile time.  Note that the repeated instruction following RPTS does
9345 not have to be reloaded from memory each iteration, thus freeing up the
9346 CPU buses for operands.  However, since interrupts are blocked by this
9347 instruction, it is disabled by default.
9348
9349 @item -mloop-unsigned
9350 @itemx -mno-loop-unsigned
9351 @opindex mloop-unsigned
9352 @opindex mno-loop-unsigned
9353 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9354 is @math{2^{31} + 1} since these instructions test if the iteration count is
9355 negative to terminate the loop.  If the iteration count is unsigned
9356 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9357 exceeded.  This switch allows an unsigned iteration count.
9358
9359 @item -mti
9360 @opindex mti
9361 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9362 with.  This also enforces compatibility with the API employed by the TI
9363 C3x C compiler.  For example, long doubles are passed as structures
9364 rather than in floating point registers.
9365
9366 @item -mregparm
9367 @itemx -mmemparm
9368 @opindex mregparm
9369 @opindex mmemparm
9370 Generate code that uses registers (stack) for passing arguments to functions.
9371 By default, arguments are passed in registers where possible rather
9372 than by pushing arguments on to the stack.
9373
9374 @item -mparallel-insns
9375 @itemx -mno-parallel-insns
9376 @opindex mparallel-insns
9377 @opindex mno-parallel-insns
9378 Allow the generation of parallel instructions.  This is enabled by
9379 default with @option{-O2}.
9380
9381 @item -mparallel-mpy
9382 @itemx -mno-parallel-mpy
9383 @opindex mparallel-mpy
9384 @opindex mno-parallel-mpy
9385 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9386 provided @option{-mparallel-insns} is also specified.  These instructions have
9387 tight register constraints which can pessimize the code generation
9388 of large functions.
9389
9390 @end table
9391
9392 @node V850 Options
9393 @subsection V850 Options
9394 @cindex V850 Options
9395
9396 These @samp{-m} options are defined for V850 implementations:
9397
9398 @table @gcctabopt
9399 @item -mlong-calls
9400 @itemx -mno-long-calls
9401 @opindex mlong-calls
9402 @opindex mno-long-calls
9403 Treat all calls as being far away (near).  If calls are assumed to be
9404 far away, the compiler will always load the functions address up into a
9405 register, and call indirect through the pointer.
9406
9407 @item -mno-ep
9408 @itemx -mep
9409 @opindex mno-ep
9410 @opindex mep
9411 Do not optimize (do optimize) basic blocks that use the same index
9412 pointer 4 or more times to copy pointer into the @code{ep} register, and
9413 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9414 option is on by default if you optimize.
9415
9416 @item -mno-prolog-function
9417 @itemx -mprolog-function
9418 @opindex mno-prolog-function
9419 @opindex mprolog-function
9420 Do not use (do use) external functions to save and restore registers at
9421 the prolog and epilog of a function.  The external functions are slower,
9422 but use less code space if more than one function saves the same number
9423 of registers.  The @option{-mprolog-function} option is on by default if
9424 you optimize.
9425
9426 @item -mspace
9427 @opindex mspace
9428 Try to make the code as small as possible.  At present, this just turns
9429 on the @option{-mep} and @option{-mprolog-function} options.
9430
9431 @item -mtda=@var{n}
9432 @opindex mtda
9433 Put static or global variables whose size is @var{n} bytes or less into
9434 the tiny data area that register @code{ep} points to.  The tiny data
9435 area can hold up to 256 bytes in total (128 bytes for byte references).
9436
9437 @item -msda=@var{n}
9438 @opindex msda
9439 Put static or global variables whose size is @var{n} bytes or less into
9440 the small data area that register @code{gp} points to.  The small data
9441 area can hold up to 64 kilobytes.
9442
9443 @item -mzda=@var{n}
9444 @opindex mzda
9445 Put static or global variables whose size is @var{n} bytes or less into
9446 the first 32 kilobytes of memory.
9447
9448 @item -mv850
9449 @opindex mv850
9450 Specify that the target processor is the V850.
9451
9452 @item -mbig-switch
9453 @opindex mbig-switch
9454 Generate code suitable for big switch tables.  Use this option only if
9455 the assembler/linker complain about out of range branches within a switch
9456 table.
9457
9458 @item -mapp-regs
9459 @opindex -mapp-regs
9460 This option will cause r2 and r5 to be used in the code generated by
9461 the compiler.  This setting is the default.
9462
9463 @item -mno-app-regs
9464 @opindex -mno-app-regs
9465 This option will cause r2 and r5 to be treated as fixed registers.
9466   
9467 @item -mv850e
9468 @opindex -mv850e
9469 Specify that the target processor is the V850E.  The preprocessor
9470 constant @samp{__v850e__} will be defined if this option is used.
9471
9472 If neither @option{-mv850} nor @option{-mv850e} are defined
9473 then a default target processor will be chosen and the relevant
9474 @samp{__v850*__} preprocessor constant will be defined.
9475
9476 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9477 defined, regardless of which processor variant is the target.
9478
9479 @item -mdisable-callt
9480 @opindex -mdisable-callt
9481 This option will suppress generation of the CALLT instruction for the
9482 v850e flavors of the v850 architecture.  The default is
9483 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9484
9485 @end table
9486
9487 @node ARC Options
9488 @subsection ARC Options
9489 @cindex ARC Options
9490
9491 These options are defined for ARC implementations:
9492
9493 @table @gcctabopt
9494 @item -EL
9495 @opindex EL
9496 Compile code for little endian mode.  This is the default.
9497
9498 @item -EB
9499 @opindex EB
9500 Compile code for big endian mode.
9501
9502 @item -mmangle-cpu
9503 @opindex mmangle-cpu
9504 Prepend the name of the cpu to all public symbol names.
9505 In multiple-processor systems, there are many ARC variants with different
9506 instruction and register set characteristics.  This flag prevents code
9507 compiled for one cpu to be linked with code compiled for another.
9508 No facility exists for handling variants that are ``almost identical''.
9509 This is an all or nothing option.
9510
9511 @item -mcpu=@var{cpu}
9512 @opindex mcpu
9513 Compile code for ARC variant @var{cpu}.
9514 Which variants are supported depend on the configuration.
9515 All variants support @option{-mcpu=base}, this is the default.
9516
9517 @item -mtext=@var{text-section}
9518 @itemx -mdata=@var{data-section}
9519 @itemx -mrodata=@var{readonly-data-section}
9520 @opindex mtext
9521 @opindex mdata
9522 @opindex mrodata
9523 Put functions, data, and readonly data in @var{text-section},
9524 @var{data-section}, and @var{readonly-data-section} respectively
9525 by default.  This can be overridden with the @code{section} attribute.
9526 @xref{Variable Attributes}.
9527
9528 @end table
9529
9530 @node NS32K Options
9531 @subsection NS32K Options
9532 @cindex NS32K options
9533
9534 These are the @samp{-m} options defined for the 32000 series.  The default
9535 values for these options depends on which style of 32000 was selected when
9536 the compiler was configured; the defaults for the most common choices are
9537 given below.
9538
9539 @table @gcctabopt
9540 @item -m32032
9541 @itemx -m32032
9542 @opindex m32032
9543 @opindex m32032
9544 Generate output for a 32032.  This is the default
9545 when the compiler is configured for 32032 and 32016 based systems.
9546
9547 @item -m32332
9548 @itemx -m32332
9549 @opindex m32332
9550 @opindex m32332
9551 Generate output for a 32332.  This is the default
9552 when the compiler is configured for 32332-based systems.
9553
9554 @item -m32532
9555 @itemx -m32532
9556 @opindex m32532
9557 @opindex m32532
9558 Generate output for a 32532.  This is the default
9559 when the compiler is configured for 32532-based systems.
9560
9561 @item -m32081
9562 @opindex m32081
9563 Generate output containing 32081 instructions for floating point.
9564 This is the default for all systems.
9565
9566 @item -m32381
9567 @opindex m32381
9568 Generate output containing 32381 instructions for floating point.  This
9569 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9570 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9571
9572 @item -mmulti-add
9573 @opindex mmulti-add
9574 Try and generate multiply-add floating point instructions @code{polyF}
9575 and @code{dotF}.  This option is only available if the @option{-m32381}
9576 option is in effect.  Using these instructions requires changes to
9577 register allocation which generally has a negative impact on
9578 performance.  This option should only be enabled when compiling code
9579 particularly likely to make heavy use of multiply-add instructions.
9580
9581 @item -mnomulti-add
9582 @opindex mnomulti-add
9583 Do not try and generate multiply-add floating point instructions
9584 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9585
9586 @item -msoft-float
9587 @opindex msoft-float
9588 Generate output containing library calls for floating point.
9589 @strong{Warning:} the requisite libraries may not be available.
9590
9591 @item -mieee-compare
9592 @itemx -mno-ieee-compare
9593 @opindex mieee-compare
9594 @opindex mno-ieee-compare
9595 Control whether or not the compiler uses IEEE floating point
9596 comparisons.  These handle correctly the case where the result of a
9597 comparison is unordered.
9598 @strong{Warning:} the requisite kernel support may not be available.
9599
9600 @item -mnobitfield
9601 @opindex mnobitfield
9602 Do not use the bit-field instructions.  On some machines it is faster to
9603 use shifting and masking operations.  This is the default for the pc532.
9604
9605 @item -mbitfield
9606 @opindex mbitfield
9607 Do use the bit-field instructions.  This is the default for all platforms
9608 except the pc532.
9609
9610 @item -mrtd
9611 @opindex mrtd
9612 Use a different function-calling convention, in which functions
9613 that take a fixed number of arguments return pop their
9614 arguments on return with the @code{ret} instruction.
9615
9616 This calling convention is incompatible with the one normally
9617 used on Unix, so you cannot use it if you need to call libraries
9618 compiled with the Unix compiler.
9619
9620 Also, you must provide function prototypes for all functions that
9621 take variable numbers of arguments (including @code{printf});
9622 otherwise incorrect code will be generated for calls to those
9623 functions.
9624
9625 In addition, seriously incorrect code will result if you call a
9626 function with too many arguments.  (Normally, extra arguments are
9627 harmlessly ignored.)
9628
9629 This option takes its name from the 680x0 @code{rtd} instruction.
9630
9631
9632 @item -mregparam
9633 @opindex mregparam
9634 Use a different function-calling convention where the first two arguments
9635 are passed in registers.
9636
9637 This calling convention is incompatible with the one normally
9638 used on Unix, so you cannot use it if you need to call libraries
9639 compiled with the Unix compiler.
9640
9641 @item -mnoregparam
9642 @opindex mnoregparam
9643 Do not pass any arguments in registers.  This is the default for all
9644 targets.
9645
9646 @item -msb
9647 @opindex msb
9648 It is OK to use the sb as an index register which is always loaded with
9649 zero.  This is the default for the pc532-netbsd target.
9650
9651 @item -mnosb
9652 @opindex mnosb
9653 The sb register is not available for use or has not been initialized to
9654 zero by the run time system.  This is the default for all targets except
9655 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9656 @option{-fpic} is set.
9657
9658 @item -mhimem
9659 @opindex mhimem
9660 Many ns32000 series addressing modes use displacements of up to 512MB@.
9661 If an address is above 512MB then displacements from zero can not be used.
9662 This option causes code to be generated which can be loaded above 512MB@.
9663 This may be useful for operating systems or ROM code.
9664
9665 @item -mnohimem
9666 @opindex mnohimem
9667 Assume code will be loaded in the first 512MB of virtual address space.
9668 This is the default for all platforms.
9669
9670
9671 @end table
9672
9673 @node AVR Options
9674 @subsection AVR Options
9675 @cindex AVR Options
9676
9677 These options are defined for AVR implementations:
9678
9679 @table @gcctabopt
9680 @item -mmcu=@var{mcu}
9681 @opindex mmcu
9682 Specify ATMEL AVR instruction set or MCU type.
9683
9684 Instruction set avr1 is for the minimal AVR core, not supported by the C
9685 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9686 attiny11, attiny12, attiny15, attiny28).
9687
9688 Instruction set avr2 (default) is for the classic AVR core with up to
9689 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9690 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9691 at90c8534, at90s8535).
9692
9693 Instruction set avr3 is for the classic AVR core with up to 128K program
9694 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9695
9696 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9697 memory space (MCU types: atmega8, atmega83, atmega85).
9698
9699 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9700 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9701 atmega64, atmega128, at43usb355, at94k).
9702
9703 @item -msize
9704 @opindex msize
9705 Output instruction sizes to the asm file.
9706
9707 @item -minit-stack=@var{N}
9708 @opindex minit-stack
9709 Specify the initial stack address, which may be a symbol or numeric value,
9710 @samp{__stack} is the default.
9711
9712 @item -mno-interrupts
9713 @opindex mno-interrupts
9714 Generated code is not compatible with hardware interrupts.
9715 Code size will be smaller.
9716
9717 @item -mcall-prologues
9718 @opindex mcall-prologues
9719 Functions prologues/epilogues expanded as call to appropriate
9720 subroutines.  Code size will be smaller.
9721
9722 @item -mno-tablejump
9723 @opindex mno-tablejump
9724 Do not generate tablejump insns which sometimes increase code size.
9725
9726 @item -mtiny-stack
9727 @opindex mtiny-stack
9728 Change only the low 8 bits of the stack pointer.
9729 @end table
9730
9731 @node MCore Options
9732 @subsection MCore Options
9733 @cindex MCore options
9734
9735 These are the @samp{-m} options defined for the Motorola M*Core
9736 processors.
9737
9738 @table @gcctabopt
9739
9740 @item -mhardlit
9741 @itemx -mno-hardlit
9742 @opindex mhardlit
9743 @opindex mno-hardlit
9744 Inline constants into the code stream if it can be done in two
9745 instructions or less.
9746
9747 @item -mdiv
9748 @itemx -mno-div
9749 @opindex mdiv
9750 @opindex mno-div
9751 Use the divide instruction.  (Enabled by default).
9752
9753 @item -mrelax-immediate
9754 @itemx -mno-relax-immediate
9755 @opindex mrelax-immediate
9756 @opindex mno-relax-immediate
9757 Allow arbitrary sized immediates in bit operations.
9758
9759 @item -mwide-bitfields
9760 @itemx -mno-wide-bitfields
9761 @opindex mwide-bitfields
9762 @opindex mno-wide-bitfields
9763 Always treat bit-fields as int-sized.
9764
9765 @item -m4byte-functions
9766 @itemx -mno-4byte-functions
9767 @opindex m4byte-functions
9768 @opindex mno-4byte-functions
9769 Force all functions to be aligned to a four byte boundary.
9770
9771 @item -mcallgraph-data
9772 @itemx -mno-callgraph-data
9773 @opindex mcallgraph-data
9774 @opindex mno-callgraph-data
9775 Emit callgraph information.
9776
9777 @item -mslow-bytes
9778 @itemx -mno-slow-bytes
9779 @opindex mslow-bytes
9780 @opindex mno-slow-bytes
9781 Prefer word access when reading byte quantities.
9782
9783 @item -mlittle-endian
9784 @itemx -mbig-endian
9785 @opindex mlittle-endian
9786 @opindex mbig-endian
9787 Generate code for a little endian target.
9788
9789 @item -m210
9790 @itemx -m340
9791 @opindex m210
9792 @opindex m340
9793 Generate code for the 210 processor.
9794 @end table
9795
9796 @node IA-64 Options
9797 @subsection IA-64 Options
9798 @cindex IA-64 Options
9799
9800 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9801
9802 @table @gcctabopt
9803 @item -mbig-endian
9804 @opindex mbig-endian
9805 Generate code for a big endian target.  This is the default for HP-UX@.
9806
9807 @item -mlittle-endian
9808 @opindex mlittle-endian
9809 Generate code for a little endian target.  This is the default for AIX5
9810 and Linux.
9811
9812 @item -mgnu-as
9813 @itemx -mno-gnu-as
9814 @opindex mgnu-as
9815 @opindex mno-gnu-as
9816 Generate (or don't) code for the GNU assembler.  This is the default.
9817 @c Also, this is the default if the configure option @option{--with-gnu-as}
9818 @c is used.
9819
9820 @item -mgnu-ld
9821 @itemx -mno-gnu-ld
9822 @opindex mgnu-ld
9823 @opindex mno-gnu-ld
9824 Generate (or don't) code for the GNU linker.  This is the default.
9825 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9826 @c is used.
9827
9828 @item -mno-pic
9829 @opindex mno-pic
9830 Generate code that does not use a global pointer register.  The result
9831 is not position independent code, and violates the IA-64 ABI@.
9832
9833 @item -mvolatile-asm-stop
9834 @itemx -mno-volatile-asm-stop
9835 @opindex mvolatile-asm-stop
9836 @opindex mno-volatile-asm-stop
9837 Generate (or don't) a stop bit immediately before and after volatile asm
9838 statements.
9839
9840 @item -mb-step
9841 @opindex mb-step
9842 Generate code that works around Itanium B step errata.
9843
9844 @item -mregister-names
9845 @itemx -mno-register-names
9846 @opindex mregister-names
9847 @opindex mno-register-names
9848 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9849 the stacked registers.  This may make assembler output more readable.
9850
9851 @item -mno-sdata
9852 @itemx -msdata
9853 @opindex mno-sdata
9854 @opindex msdata
9855 Disable (or enable) optimizations that use the small data section.  This may
9856 be useful for working around optimizer bugs.
9857
9858 @item -mconstant-gp
9859 @opindex mconstant-gp
9860 Generate code that uses a single constant global pointer value.  This is
9861 useful when compiling kernel code.
9862
9863 @item -mauto-pic
9864 @opindex mauto-pic
9865 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9866 This is useful when compiling firmware code.
9867
9868 @item -minline-float-divide-min-latency
9869 @opindex minline-float-divide-min-latency
9870 Generate code for inline divides of floating point values
9871 using the minimum latency algorithm.
9872
9873 @item -minline-float-divide-max-throughput
9874 @opindex minline-float-divide-max-throughput
9875 Generate code for inline divides of floating point values
9876 using the maximum throughput algorithm.
9877
9878 @item -minline-int-divide-min-latency
9879 @opindex minline-int-divide-min-latency
9880 Generate code for inline divides of integer values
9881 using the minimum latency algorithm.
9882
9883 @item -minline-int-divide-max-throughput
9884 @opindex minline-int-divide-max-throughput
9885 Generate code for inline divides of integer values
9886 using the maximum throughput algorithm.
9887
9888 @item -mno-dwarf2-asm
9889 @itemx -mdwarf2-asm
9890 @opindex mno-dwarf2-asm
9891 @opindex mdwarf2-asm
9892 Don't (or do) generate assembler code for the DWARF2 line number debugging
9893 info.  This may be useful when not using the GNU assembler.
9894
9895 @item -mfixed-range=@var{register-range}
9896 @opindex mfixed-range
9897 Generate code treating the given register range as fixed registers.
9898 A fixed register is one that the register allocator can not use.  This is
9899 useful when compiling kernel code.  A register range is specified as
9900 two registers separated by a dash.  Multiple register ranges can be
9901 specified separated by a comma.
9902
9903 @item -mearly-stop-bits
9904 @itemx -mno-early-stop-bits
9905 @opindex mearly-stop-bits
9906 @opindex mno-early-stop-bits
9907 Allow stop bits to be placed earlier than immediately preceding the
9908 instruction that triggered the stop bit.  This can improve instruction
9909 scheduling, but does not always do so.
9910 @end table
9911
9912 @node D30V Options
9913 @subsection D30V Options
9914 @cindex D30V Options
9915
9916 These @samp{-m} options are defined for D30V implementations:
9917
9918 @table @gcctabopt
9919 @item -mextmem
9920 @opindex mextmem
9921 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9922 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9923 memory, which starts at location @code{0x80000000}.
9924
9925 @item -mextmemory
9926 @opindex mextmemory
9927 Same as the @option{-mextmem} switch.
9928
9929 @item -monchip
9930 @opindex monchip
9931 Link the @samp{.text} section into onchip text memory, which starts at
9932 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9933 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9934 into onchip data memory, which starts at location @code{0x20000000}.
9935
9936 @item -mno-asm-optimize
9937 @itemx -masm-optimize
9938 @opindex mno-asm-optimize
9939 @opindex masm-optimize
9940 Disable (enable) passing @option{-O} to the assembler when optimizing.
9941 The assembler uses the @option{-O} option to automatically parallelize
9942 adjacent short instructions where possible.
9943
9944 @item -mbranch-cost=@var{n}
9945 @opindex mbranch-cost
9946 Increase the internal costs of branches to @var{n}.  Higher costs means
9947 that the compiler will issue more instructions to avoid doing a branch.
9948 The default is 2.
9949
9950 @item -mcond-exec=@var{n}
9951 @opindex mcond-exec
9952 Specify the maximum number of conditionally executed instructions that
9953 replace a branch.  The default is 4.
9954 @end table
9955
9956 @node S/390 and zSeries Options
9957 @subsection S/390 and zSeries Options
9958 @cindex S/390 and zSeries Options
9959
9960 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9961
9962 @table @gcctabopt
9963 @item -mhard-float
9964 @itemx -msoft-float
9965 @opindex mhard-float
9966 @opindex msoft-float
9967 Use (do not use) the hardware floating-point instructions and registers
9968 for floating-point operations.  When @option{-msoft-float} is specified,
9969 functions in @file{libgcc.a} will be used to perform floating-point
9970 operations.  When @option{-mhard-float} is specified, the compiler
9971 generates IEEE floating-point instructions.  This is the default.
9972
9973 @item -mbackchain
9974 @itemx -mno-backchain
9975 @opindex mbackchain
9976 @opindex mno-backchain
9977 Generate (or do not generate) code which maintains an explicit
9978 backchain within the stack frame that points to the caller's frame.
9979 This is currently needed to allow debugging.  The default is to
9980 generate the backchain.
9981
9982 @item -msmall-exec
9983 @itemx -mno-small-exec
9984 @opindex msmall-exec
9985 @opindex mno-small-exec
9986 Generate (or do not generate) code using the @code{bras} instruction
9987 to do subroutine calls.
9988 This only works reliably if the total executable size does not
9989 exceed 64k.  The default is to use the @code{basr} instruction instead,
9990 which does not have this limitation.
9991
9992 @item -m64
9993 @itemx -m31
9994 @opindex m64
9995 @opindex m31
9996 When @option{-m31} is specified, generate code compliant to the
9997 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9998 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9999 particular to generate 64-bit instructions.  For the @samp{s390}
10000 targets, the default is @option{-m31}, while the @samp{s390x}
10001 targets default to @option{-m64}.
10002
10003 @item -mzarch
10004 @itemx -mesa
10005 @opindex mzarch
10006 @opindex mesa
10007 When @option{-mzarch} is specified, generate code using the 
10008 instructions available on z/Architecture. 
10009 When @option{-mesa} is specified, generate code using the 
10010 instructions available on ESA/390. Note that @option{-mesa} is
10011 not possible with @option{-m64}.
10012 For the @samp{s390} targets, the default is @option{-mesa}, 
10013 while the @samp{s390x} targets default to @option{-mzarch}.
10014
10015 @item -mmvcle
10016 @itemx -mno-mvcle
10017 @opindex mmvcle
10018 @opindex mno-mvcle
10019 Generate (or do not generate) code using the @code{mvcle} instruction
10020 to perform block moves.  When @option{-mno-mvcle} is specified,
10021 use a @code{mvc} loop instead.  This is the default.
10022
10023 @item -mdebug
10024 @itemx -mno-debug
10025 @opindex mdebug
10026 @opindex mno-debug
10027 Print (or do not print) additional debug information when compiling.
10028 The default is to not print debug information.
10029
10030 @item -march=@var{arch}
10031 @opindex march
10032 Generate code that will run on @var{arch}, which is the name of system
10033 representing a certain processor type. Possible values for
10034 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
10035
10036 @item -mtune=@var{arch}
10037 @opindex mtune
10038 Tune to @var{cpu-type} everything applicable about the generated code,
10039  except for the ABI and the set of available instructions. 
10040 The list of @var{arch} values is the same as for @option{-march}.
10041
10042 @end table
10043
10044 @node CRIS Options
10045 @subsection CRIS Options
10046 @cindex CRIS Options
10047
10048 These options are defined specifically for the CRIS ports.
10049
10050 @table @gcctabopt
10051 @item -march=@var{architecture-type}
10052 @itemx -mcpu=@var{architecture-type}
10053 @opindex march
10054 @opindex mcpu
10055 Generate code for the specified architecture.  The choices for
10056 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10057 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10058 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10059 @samp{v10}.
10060
10061 @item -mtune=@var{architecture-type}
10062 @opindex mtune
10063 Tune to @var{architecture-type} everything applicable about the generated
10064 code, except for the ABI and the set of available instructions.  The
10065 choices for @var{architecture-type} are the same as for
10066 @option{-march=@var{architecture-type}}.
10067
10068 @item -mmax-stack-frame=@var{n}
10069 @opindex mmax-stack-frame
10070 Warn when the stack frame of a function exceeds @var{n} bytes.
10071
10072 @item -melinux-stacksize=@var{n}
10073 @opindex melinux-stacksize
10074 Only available with the @samp{cris-axis-aout} target.  Arranges for
10075 indications in the program to the kernel loader that the stack of the
10076 program should be set to @var{n} bytes.
10077
10078 @item -metrax4
10079 @itemx -metrax100
10080 @opindex metrax4
10081 @opindex metrax100
10082 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10083 @option{-march=v3} and @option{-march=v8} respectively.
10084
10085 @item -mpdebug
10086 @opindex mpdebug
10087 Enable CRIS-specific verbose debug-related information in the assembly
10088 code.  This option also has the effect to turn off the @samp{#NO_APP}
10089 formatted-code indicator to the assembler at the beginning of the
10090 assembly file.
10091
10092 @item -mcc-init
10093 @opindex mcc-init
10094 Do not use condition-code results from previous instruction; always emit
10095 compare and test instructions before use of condition codes.
10096
10097 @item -mno-side-effects
10098 @opindex mno-side-effects
10099 Do not emit instructions with side-effects in addressing modes other than
10100 post-increment.
10101
10102 @item -mstack-align
10103 @itemx -mno-stack-align
10104 @itemx -mdata-align
10105 @itemx -mno-data-align
10106 @itemx -mconst-align
10107 @itemx -mno-const-align
10108 @opindex mstack-align
10109 @opindex mno-stack-align
10110 @opindex mdata-align
10111 @opindex mno-data-align
10112 @opindex mconst-align
10113 @opindex mno-const-align
10114 These options (no-options) arranges (eliminate arrangements) for the
10115 stack-frame, individual data and constants to be aligned for the maximum
10116 single data access size for the chosen CPU model.  The default is to
10117 arrange for 32-bit alignment.  ABI details such as structure layout are
10118 not affected by these options.
10119
10120 @item -m32-bit
10121 @itemx -m16-bit
10122 @itemx -m8-bit
10123 @opindex m32-bit
10124 @opindex m16-bit
10125 @opindex m8-bit
10126 Similar to the stack- data- and const-align options above, these options
10127 arrange for stack-frame, writable data and constants to all be 32-bit,
10128 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10129
10130 @item -mno-prologue-epilogue
10131 @itemx -mprologue-epilogue
10132 @opindex mno-prologue-epilogue
10133 @opindex mprologue-epilogue
10134 With @option{-mno-prologue-epilogue}, the normal function prologue and
10135 epilogue that sets up the stack-frame are omitted and no return
10136 instructions or return sequences are generated in the code.  Use this
10137 option only together with visual inspection of the compiled code: no
10138 warnings or errors are generated when call-saved registers must be saved,
10139 or storage for local variable needs to be allocated.
10140
10141 @item -mno-gotplt
10142 @itemx -mgotplt
10143 @opindex mno-gotplt
10144 @opindex mgotplt
10145 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10146 instruction sequences that load addresses for functions from the PLT part
10147 of the GOT rather than (traditional on other architectures) calls to the
10148 PLT.  The default is @option{-mgotplt}.
10149
10150 @item -maout
10151 @opindex maout
10152 Legacy no-op option only recognized with the cris-axis-aout target.
10153
10154 @item -melf
10155 @opindex melf
10156 Legacy no-op option only recognized with the cris-axis-elf and
10157 cris-axis-linux-gnu targets.
10158
10159 @item -melinux
10160 @opindex melinux
10161 Only recognized with the cris-axis-aout target, where it selects a
10162 GNU/linux-like multilib, include files and instruction set for
10163 @option{-march=v8}.
10164
10165 @item -mlinux
10166 @opindex mlinux
10167 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10168
10169 @item -sim
10170 @opindex sim
10171 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10172 to link with input-output functions from a simulator library.  Code,
10173 initialized data and zero-initialized data are allocated consecutively.
10174
10175 @item -sim2
10176 @opindex sim2
10177 Like @option{-sim}, but pass linker options to locate initialized data at
10178 0x40000000 and zero-initialized data at 0x80000000.
10179 @end table
10180
10181 @node MMIX Options
10182 @subsection MMIX Options
10183 @cindex MMIX Options
10184
10185 These options are defined for the MMIX:
10186
10187 @table @gcctabopt
10188 @item -mlibfuncs
10189 @itemx -mno-libfuncs
10190 @opindex mlibfuncs
10191 @opindex mno-libfuncs
10192 Specify that intrinsic library functions are being compiled, passing all
10193 values in registers, no matter the size.
10194
10195 @item -mepsilon
10196 @itemx -mno-epsilon
10197 @opindex mepsilon
10198 @opindex mno-epsilon
10199 Generate floating-point comparison instructions that compare with respect
10200 to the @code{rE} epsilon register.
10201
10202 @item -mabi=mmixware
10203 @itemx -mabi=gnu
10204 @opindex mabi-mmixware
10205 @opindex mabi=gnu
10206 Generate code that passes function parameters and return values that (in
10207 the called function) are seen as registers @code{$0} and up, as opposed to
10208 the GNU ABI which uses global registers @code{$231} and up.
10209
10210 @item -mzero-extend
10211 @itemx -mno-zero-extend
10212 @opindex mzero-extend
10213 @opindex mno-zero-extend
10214 When reading data from memory in sizes shorter than 64 bits, use (do not
10215 use) zero-extending load instructions by default, rather than
10216 sign-extending ones.
10217
10218 @item -mknuthdiv
10219 @itemx -mno-knuthdiv
10220 @opindex mknuthdiv
10221 @opindex mno-knuthdiv
10222 Make the result of a division yielding a remainder have the same sign as
10223 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10224 remainder follows the sign of the dividend.  Both methods are
10225 arithmetically valid, the latter being almost exclusively used.
10226
10227 @item -mtoplevel-symbols
10228 @itemx -mno-toplevel-symbols
10229 @opindex mtoplevel-symbols
10230 @opindex mno-toplevel-symbols
10231 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10232 code can be used with the @code{PREFIX} assembly directive.
10233
10234 @item -melf
10235 @opindex melf
10236 Generate an executable in the ELF format, rather than the default
10237 @samp{mmo} format used by the @command{mmix} simulator.
10238
10239 @item -mbranch-predict
10240 @itemx -mno-branch-predict
10241 @opindex mbranch-predict
10242 @opindex mno-branch-predict
10243 Use (do not use) the probable-branch instructions, when static branch
10244 prediction indicates a probable branch.
10245
10246 @item -mbase-addresses
10247 @itemx -mno-base-addresses
10248 @opindex mbase-addresses
10249 @opindex mno-base-addresses
10250 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10251 base address automatically generates a request (handled by the assembler
10252 and the linker) for a constant to be set up in a global register.  The
10253 register is used for one or more base address requests within the range 0
10254 to 255 from the value held in the register.  The generally leads to short
10255 and fast code, but the number of different data items that can be
10256 addressed is limited.  This means that a program that uses lots of static
10257 data may require @option{-mno-base-addresses}.
10258
10259 @item -msingle-exit
10260 @itemx -mno-single-exit
10261 @opindex msingle-exit
10262 @opindex mno-single-exit
10263 Force (do not force) generated code to have a single exit point in each
10264 function.
10265 @end table
10266
10267 @node PDP-11 Options
10268 @subsection PDP-11 Options
10269 @cindex PDP-11 Options
10270
10271 These options are defined for the PDP-11:
10272
10273 @table @gcctabopt
10274 @item -mfpu
10275 @opindex mfpu
10276 Use hardware FPP floating point.  This is the default.  (FIS floating
10277 point on the PDP-11/40 is not supported.)
10278
10279 @item -msoft-float
10280 @opindex msoft-float
10281 Do not use hardware floating point.
10282
10283 @item -mac0
10284 @opindex mac0
10285 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10286
10287 @item -mno-ac0
10288 @opindex mno-ac0
10289 Return floating-point results in memory.  This is the default.
10290
10291 @item -m40
10292 @opindex m40
10293 Generate code for a PDP-11/40.
10294
10295 @item -m45
10296 @opindex m45
10297 Generate code for a PDP-11/45.  This is the default.
10298
10299 @item -m10
10300 @opindex m10
10301 Generate code for a PDP-11/10.
10302
10303 @item -mbcopy-builtin
10304 @opindex bcopy-builtin
10305 Use inline @code{movstrhi} patterns for copying memory.  This is the
10306 default.
10307
10308 @item -mbcopy
10309 @opindex mbcopy
10310 Do not use inline @code{movstrhi} patterns for copying memory.
10311
10312 @item -mint16
10313 @itemx -mno-int32
10314 @opindex mint16
10315 @opindex mno-int32
10316 Use 16-bit @code{int}.  This is the default.
10317
10318 @item -mint32
10319 @itemx -mno-int16
10320 @opindex mint32
10321 @opindex mno-int16
10322 Use 32-bit @code{int}.
10323
10324 @item -mfloat64
10325 @itemx -mno-float32
10326 @opindex mfloat64
10327 @opindex mno-float32
10328 Use 64-bit @code{float}.  This is the default.
10329
10330 @item -mfloat32
10331 @item -mno-float64
10332 @opindex mfloat32
10333 @opindex mno-float64
10334 Use 32-bit @code{float}.
10335
10336 @item -mabshi
10337 @opindex mabshi
10338 Use @code{abshi2} pattern.  This is the default.
10339
10340 @item -mno-abshi
10341 @opindex mno-abshi
10342 Do not use @code{abshi2} pattern.
10343
10344 @item -mbranch-expensive
10345 @opindex mbranch-expensive
10346 Pretend that branches are expensive.  This is for experimenting with
10347 code generation only.
10348
10349 @item -mbranch-cheap
10350 @opindex mbranch-cheap
10351 Do not pretend that branches are expensive.  This is the default.
10352
10353 @item -msplit
10354 @opindex msplit
10355 Generate code for a system with split I&D.
10356
10357 @item -mno-split
10358 @opindex mno-split
10359 Generate code for a system without split I&D.  This is the default.
10360
10361 @item -munix-asm
10362 @opindex munix-asm
10363 Use Unix assembler syntax.  This is the default when configured for
10364 @samp{pdp11-*-bsd}.
10365
10366 @item -mdec-asm
10367 @opindex mdec-asm
10368 Use DEC assembler syntax.  This is the default when configured for any
10369 PDP-11 target other than @samp{pdp11-*-bsd}.
10370 @end table
10371
10372 @node Xstormy16 Options
10373 @subsection Xstormy16 Options
10374 @cindex Xstormy16 Options
10375
10376 These options are defined for Xstormy16:
10377
10378 @table @gcctabopt
10379 @item -msim
10380 @opindex msim
10381 Choose startup files and linker script suitable for the simulator.
10382 @end table
10383
10384 @node FRV Options
10385 @subsection FRV Options
10386 @cindex FRV Options
10387
10388 @table @gcctabopt
10389 @item -mgpr-32
10390 @opindex mgpr-32
10391
10392 Only use the first 32 general purpose registers.
10393
10394 @item -mgpr-64
10395 @opindex mgpr-64
10396
10397 Use all 64 general purpose registers.
10398
10399 @item -mfpr-32
10400 @opindex mfpr-32
10401
10402 Use only the first 32 floating point registers.
10403
10404 @item -mfpr-64
10405 @opindex mfpr-64
10406
10407 Use all 64 floating point registers
10408
10409 @item -mhard-float
10410 @opindex mhard-float
10411
10412 Use hardware instructions for floating point operations.
10413
10414 @item -msoft-float
10415 @opindex msoft-float
10416
10417 Use library routines for floating point operations.
10418
10419 @item -malloc-cc
10420 @opindex malloc-cc
10421
10422 Dynamically allocate condition code registers.
10423
10424 @item -mfixed-cc
10425 @opindex mfixed-cc
10426
10427 Do not try to dynamically allocate condition code registers, only
10428 use @code{icc0} and @code{fcc0}.
10429
10430 @item -mdword
10431 @opindex mdword
10432
10433 Change ABI to use double word insns.
10434
10435 @item -mno-dword
10436 @opindex mno-dword
10437
10438 Do not use double word instructions.
10439
10440 @item -mdouble
10441 @opindex mdouble
10442
10443 Use floating point double instructions.
10444
10445 @item -mno-double
10446 @opindex mno-double
10447
10448 Do not use floating point double instructions.
10449
10450 @item -mmedia
10451 @opindex mmedia
10452
10453 Use media instructions.
10454
10455 @item -mno-media
10456 @opindex mno-media
10457
10458 Do not use media instructions.
10459
10460 @item -mmuladd
10461 @opindex mmuladd
10462
10463 Use multiply and add/subtract instructions.
10464
10465 @item -mno-muladd
10466 @opindex mno-muladd
10467
10468 Do not use multiply and add/subtract instructions.
10469
10470 @item -mlibrary-pic
10471 @opindex mlibrary-pic
10472
10473 Enable PIC support for building libraries
10474
10475 @item -macc-4
10476 @opindex macc-4
10477
10478 Use only the first four media accumulator registers.
10479
10480 @item -macc-8
10481 @opindex macc-8
10482
10483 Use all eight media accumulator registers.
10484
10485 @item -mpack
10486 @opindex mpack
10487
10488 Pack VLIW instructions.
10489
10490 @item -mno-pack
10491 @opindex mno-pack
10492
10493 Do not pack VLIW instructions.
10494
10495 @item -mno-eflags
10496 @opindex mno-eflags
10497
10498 Do not mark ABI switches in e_flags.
10499
10500 @item -mcond-move
10501 @opindex mcond-move
10502
10503 Enable the use of conditional-move instructions (default).
10504
10505 This switch is mainly for debugging the compiler and will likely be removed
10506 in a future version.
10507
10508 @item -mno-cond-move
10509 @opindex mno-cond-move
10510
10511 Disable the use of conditional-move instructions.
10512
10513 This switch is mainly for debugging the compiler and will likely be removed
10514 in a future version.
10515
10516 @item -mscc
10517 @opindex mscc
10518
10519 Enable the use of conditional set instructions (default).
10520
10521 This switch is mainly for debugging the compiler and will likely be removed
10522 in a future version.
10523
10524 @item -mno-scc
10525 @opindex mno-scc
10526
10527 Disable the use of conditional set instructions.
10528
10529 This switch is mainly for debugging the compiler and will likely be removed
10530 in a future version.
10531
10532 @item -mcond-exec
10533 @opindex mcond-exec
10534
10535 Enable the use of conditional execution (default).
10536
10537 This switch is mainly for debugging the compiler and will likely be removed
10538 in a future version.
10539
10540 @item -mno-cond-exec
10541 @opindex mno-cond-exec
10542
10543 Disable the use of conditional execution.
10544
10545 This switch is mainly for debugging the compiler and will likely be removed
10546 in a future version.
10547
10548 @item -mvliw-branch
10549 @opindex mvliw-branch
10550
10551 Run a pass to pack branches into VLIW instructions (default).
10552
10553 This switch is mainly for debugging the compiler and will likely be removed
10554 in a future version.
10555
10556 @item -mno-vliw-branch
10557 @opindex mno-vliw-branch
10558
10559 Do not run a pass to pack branches into VLIW instructions.
10560
10561 This switch is mainly for debugging the compiler and will likely be removed
10562 in a future version.
10563
10564 @item -mmulti-cond-exec
10565 @opindex mmulti-cond-exec
10566
10567 Enable optimization of @code{&&} and @code{||} in conditional execution
10568 (default).
10569
10570 This switch is mainly for debugging the compiler and will likely be removed
10571 in a future version.
10572
10573 @item -mno-multi-cond-exec
10574 @opindex mno-multi-cond-exec
10575
10576 Disable optimization of @code{&&} and @code{||} in conditional execution.
10577
10578 This switch is mainly for debugging the compiler and will likely be removed
10579 in a future version.
10580
10581 @item -mnested-cond-exec
10582 @opindex mnested-cond-exec
10583
10584 Enable nested conditional execution optimizations (default).
10585
10586 This switch is mainly for debugging the compiler and will likely be removed
10587 in a future version.
10588
10589 @item -mno-nested-cond-exec
10590 @opindex mno-nested-cond-exec
10591
10592 Disable nested conditional execution optimizations.
10593
10594 This switch is mainly for debugging the compiler and will likely be removed
10595 in a future version.
10596
10597 @item -mtomcat-stats
10598 @opindex mtomcat-stats
10599
10600 Cause gas to print out tomcat statistics.
10601
10602 @item -mcpu=@var{cpu}
10603 @opindex mcpu
10604
10605 Select the processor type for which to generate code.  Possible values are
10606 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10607 @samp{frv}.
10608
10609 @end table
10610
10611 @node Xtensa Options
10612 @subsection Xtensa Options
10613 @cindex Xtensa Options
10614
10615 The Xtensa architecture is designed to support many different
10616 configurations.  The compiler's default options can be set to match a
10617 particular Xtensa configuration by copying a configuration file into the
10618 GCC sources when building GCC@.  The options below may be used to
10619 override the default options.
10620
10621 @table @gcctabopt
10622 @item -mbig-endian
10623 @itemx -mlittle-endian
10624 @opindex mbig-endian
10625 @opindex mlittle-endian
10626 Specify big-endian or little-endian byte ordering for the target Xtensa
10627 processor.
10628
10629 @item -mdensity
10630 @itemx -mno-density
10631 @opindex mdensity
10632 @opindex mno-density
10633 Enable or disable use of the optional Xtensa code density instructions.
10634
10635 @item -mmac16
10636 @itemx -mno-mac16
10637 @opindex mmac16
10638 @opindex mno-mac16
10639 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10640 will generate MAC16 instructions from standard C code, with the
10641 limitation that it will use neither the MR register file nor any
10642 instruction that operates on the MR registers.  When this option is
10643 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10644 combination of core instructions and library calls, depending on whether
10645 any other multiplier options are enabled.
10646
10647 @item -mmul16
10648 @itemx -mno-mul16
10649 @opindex mmul16
10650 @opindex mno-mul16
10651 Enable or disable use of the 16-bit integer multiplier option.  When
10652 enabled, the compiler will generate 16-bit multiply instructions for
10653 multiplications of 16 bits or smaller in standard C code.  When this
10654 option is disabled, the compiler will either use 32-bit multiply or
10655 MAC16 instructions if they are available or generate library calls to
10656 perform the multiply operations using shifts and adds.
10657
10658 @item -mmul32
10659 @itemx -mno-mul32
10660 @opindex mmul32
10661 @opindex mno-mul32
10662 Enable or disable use of the 32-bit integer multiplier option.  When
10663 enabled, the compiler will generate 32-bit multiply instructions for
10664 multiplications of 32 bits or smaller in standard C code.  When this
10665 option is disabled, the compiler will generate library calls to perform
10666 the multiply operations using either shifts and adds or 16-bit multiply
10667 instructions if they are available.
10668
10669 @item -mnsa
10670 @itemx -mno-nsa
10671 @opindex mnsa
10672 @opindex mno-nsa
10673 Enable or disable use of the optional normalization shift amount
10674 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10675
10676 @item -mminmax
10677 @itemx -mno-minmax
10678 @opindex mminmax
10679 @opindex mno-minmax
10680 Enable or disable use of the optional minimum and maximum value
10681 instructions.
10682
10683 @item -msext
10684 @itemx -mno-sext
10685 @opindex msext
10686 @opindex mno-sext
10687 Enable or disable use of the optional sign extend (@code{SEXT})
10688 instruction.
10689
10690 @item -mbooleans
10691 @itemx -mno-booleans
10692 @opindex mbooleans
10693 @opindex mno-booleans
10694 Enable or disable support for the boolean register file used by Xtensa
10695 coprocessors.  This is not typically useful by itself but may be
10696 required for other options that make use of the boolean registers (e.g.,
10697 the floating-point option).
10698
10699 @item -mhard-float
10700 @itemx -msoft-float
10701 @opindex mhard-float
10702 @opindex msoft-float
10703 Enable or disable use of the floating-point option.  When enabled, GCC
10704 generates floating-point instructions for 32-bit @code{float}
10705 operations.  When this option is disabled, GCC generates library calls
10706 to emulate 32-bit floating-point operations using integer instructions.
10707 Regardless of this option, 64-bit @code{double} operations are always
10708 emulated with calls to library functions.
10709
10710 @item -mfused-madd
10711 @itemx -mno-fused-madd
10712 @opindex mfused-madd
10713 @opindex mno-fused-madd
10714 Enable or disable use of fused multiply/add and multiply/subtract
10715 instructions in the floating-point option.  This has no effect if the
10716 floating-point option is not also enabled.  Disabling fused multiply/add
10717 and multiply/subtract instructions forces the compiler to use separate
10718 instructions for the multiply and add/subtract operations.  This may be
10719 desirable in some cases where strict IEEE 754-compliant results are
10720 required: the fused multiply add/subtract instructions do not round the
10721 intermediate result, thereby producing results with @emph{more} bits of
10722 precision than specified by the IEEE standard.  Disabling fused multiply
10723 add/subtract instructions also ensures that the program output is not
10724 sensitive to the compiler's ability to combine multiply and add/subtract
10725 operations.
10726
10727 @item -mserialize-volatile
10728 @itemx -mno-serialize-volatile
10729 @opindex mserialize-volatile
10730 @opindex mno-serialize-volatile
10731 When this option is enabled, GCC inserts @code{MEMW} instructions before
10732 @code{volatile} memory references to guarantee sequential consistency.
10733 The default is @option{-mserialize-volatile}.  Use
10734 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10735
10736 @item -mtext-section-literals
10737 @itemx -mno-text-section-literals
10738 @opindex mtext-section-literals
10739 @opindex mno-text-section-literals
10740 Control the treatment of literal pools.  The default is
10741 @option{-mno-text-section-literals}, which places literals in a separate
10742 section in the output file.  This allows the literal pool to be placed
10743 in a data RAM/ROM, and it also allows the linker to combine literal
10744 pools from separate object files to remove redundant literals and
10745 improve code size.  With @option{-mtext-section-literals}, the literals
10746 are interspersed in the text section in order to keep them as close as
10747 possible to their references.  This may be necessary for large assembly
10748 files.
10749
10750 @item -mtarget-align
10751 @itemx -mno-target-align
10752 @opindex mtarget-align
10753 @opindex mno-target-align
10754 When this option is enabled, GCC instructs the assembler to
10755 automatically align instructions to reduce branch penalties at the
10756 expense of some code density.  The assembler attempts to widen density
10757 instructions to align branch targets and the instructions following call
10758 instructions.  If there are not enough preceding safe density
10759 instructions to align a target, no widening will be performed.  The
10760 default is @option{-mtarget-align}.  These options do not affect the
10761 treatment of auto-aligned instructions like @code{LOOP}, which the
10762 assembler will always align, either by widening density instructions or
10763 by inserting no-op instructions.
10764
10765 @item -mlongcalls
10766 @itemx -mno-longcalls
10767 @opindex mlongcalls
10768 @opindex mno-longcalls
10769 When this option is enabled, GCC instructs the assembler to translate
10770 direct calls to indirect calls unless it can determine that the target
10771 of a direct call is in the range allowed by the call instruction.  This
10772 translation typically occurs for calls to functions in other source
10773 files.  Specifically, the assembler translates a direct @code{CALL}
10774 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10775 The default is @option{-mno-longcalls}.  This option should be used in
10776 programs where the call target can potentially be out of range.  This
10777 option is implemented in the assembler, not the compiler, so the
10778 assembly code generated by GCC will still show direct call
10779 instructions---look at the disassembled object code to see the actual
10780 instructions.  Note that the assembler will use an indirect call for
10781 every cross-file call, not just those that really will be out of range.
10782 @end table
10783
10784 @node Code Gen Options
10785 @section Options for Code Generation Conventions
10786 @cindex code generation conventions
10787 @cindex options, code generation
10788 @cindex run-time options
10789
10790 These machine-independent options control the interface conventions
10791 used in code generation.
10792
10793 Most of them have both positive and negative forms; the negative form
10794 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10795 one of the forms is listed---the one which is not the default.  You
10796 can figure out the other form by either removing @samp{no-} or adding
10797 it.
10798
10799 @table @gcctabopt
10800 @item -fbounds-check
10801 @opindex fbounds-check
10802 For front-ends that support it, generate additional code to check that
10803 indices used to access arrays are within the declared range.  This is
10804 currently only supported by the Java and Fortran 77 front-ends, where
10805 this option defaults to true and false respectively.
10806
10807 @item -ftrapv
10808 @opindex ftrapv
10809 This option generates traps for signed overflow on addition, subtraction,
10810 multiplication operations.
10811
10812 @item -fexceptions
10813 @opindex fexceptions
10814 Enable exception handling.  Generates extra code needed to propagate
10815 exceptions.  For some targets, this implies GCC will generate frame
10816 unwind information for all functions, which can produce significant data
10817 size overhead, although it does not affect execution.  If you do not
10818 specify this option, GCC will enable it by default for languages like
10819 C++ which normally require exception handling, and disable it for
10820 languages like C that do not normally require it.  However, you may need
10821 to enable this option when compiling C code that needs to interoperate
10822 properly with exception handlers written in C++.  You may also wish to
10823 disable this option if you are compiling older C++ programs that don't
10824 use exception handling.
10825
10826 @item -fnon-call-exceptions
10827 @opindex fnon-call-exceptions
10828 Generate code that allows trapping instructions to throw exceptions.
10829 Note that this requires platform-specific runtime support that does
10830 not exist everywhere.  Moreover, it only allows @emph{trapping}
10831 instructions to throw exceptions, i.e.@: memory references or floating
10832 point instructions.  It does not allow exceptions to be thrown from
10833 arbitrary signal handlers such as @code{SIGALRM}.
10834
10835 @item -fforced-unwind-exceptions
10836 @opindex fforced-unwind-exceptions
10837 Generate code that checks for non-catchable exceptions derived from
10838 @code{_Unwind_ForcedUnwind}, such as from @code{longjmp_unwind} or
10839 from pthread cancellation.  There is some amount of code-size 
10840 overhead associated with this, so it is not default.
10841
10842 @item -funwind-tables
10843 @opindex funwind-tables
10844 Similar to @option{-fexceptions}, except that it will just generate any needed
10845 static data, but will not affect the generated code in any other way.
10846 You will normally not enable this option; instead, a language processor
10847 that needs this handling would enable it on your behalf.
10848
10849 @item -fasynchronous-unwind-tables
10850 @opindex funwind-tables
10851 Generate unwind table in dwarf2 format, if supported by target machine.  The
10852 table is exact at each instruction boundary, so it can be used for stack
10853 unwinding from asynchronous events (such as debugger or garbage collector).
10854
10855 @item -fpcc-struct-return
10856 @opindex fpcc-struct-return
10857 Return ``short'' @code{struct} and @code{union} values in memory like
10858 longer ones, rather than in registers.  This convention is less
10859 efficient, but it has the advantage of allowing intercallability between
10860 GCC-compiled files and files compiled with other compilers, particularly
10861 the Portable C Compiler (pcc).
10862
10863 The precise convention for returning structures in memory depends
10864 on the target configuration macros.
10865
10866 Short structures and unions are those whose size and alignment match
10867 that of some integer type.
10868
10869 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10870 switch is not binary compatible with code compiled with the
10871 @option{-freg-struct-return} switch.
10872 Use it to conform to a non-default application binary interface.
10873
10874 @item -freg-struct-return
10875 @opindex freg-struct-return
10876 Return @code{struct} and @code{union} values in registers when possible.
10877 This is more efficient for small structures than
10878 @option{-fpcc-struct-return}.
10879
10880 If you specify neither @option{-fpcc-struct-return} nor
10881 @option{-freg-struct-return}, GCC defaults to whichever convention is
10882 standard for the target.  If there is no standard convention, GCC
10883 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10884 the principal compiler.  In those cases, we can choose the standard, and
10885 we chose the more efficient register return alternative.
10886
10887 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10888 switch is not binary compatible with code compiled with the
10889 @option{-fpcc-struct-return} switch.
10890 Use it to conform to a non-default application binary interface.
10891
10892 @item -fshort-enums
10893 @opindex fshort-enums
10894 Allocate to an @code{enum} type only as many bytes as it needs for the
10895 declared range of possible values.  Specifically, the @code{enum} type
10896 will be equivalent to the smallest integer type which has enough room.
10897
10898 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10899 code that is not binary compatible with code generated without that switch.
10900 Use it to conform to a non-default application binary interface.
10901
10902 @item -fshort-double
10903 @opindex fshort-double
10904 Use the same size for @code{double} as for @code{float}.
10905
10906 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10907 code that is not binary compatible with code generated without that switch.
10908 Use it to conform to a non-default application binary interface.
10909
10910 @item -fshort-wchar
10911 @opindex fshort-wchar
10912 Override the underlying type for @samp{wchar_t} to be @samp{short
10913 unsigned int} instead of the default for the target.  This option is
10914 useful for building programs to run under WINE@.
10915
10916 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10917 code that is not binary compatible with code generated without that switch.
10918 Use it to conform to a non-default application binary interface.
10919
10920 @item -fshared-data
10921 @opindex fshared-data
10922 Requests that the data and non-@code{const} variables of this
10923 compilation be shared data rather than private data.  The distinction
10924 makes sense only on certain operating systems, where shared data is
10925 shared between processes running the same program, while private data
10926 exists in one copy per process.
10927
10928 @item -fno-common
10929 @opindex fno-common
10930 In C, allocate even uninitialized global variables in the data section of the
10931 object file, rather than generating them as common blocks.  This has the
10932 effect that if the same variable is declared (without @code{extern}) in
10933 two different compilations, you will get an error when you link them.
10934 The only reason this might be useful is if you wish to verify that the
10935 program will work on other systems which always work this way.
10936
10937 @item -fno-ident
10938 @opindex fno-ident
10939 Ignore the @samp{#ident} directive.
10940
10941 @item -fno-gnu-linker
10942 @opindex fno-gnu-linker
10943 Do not output global initializations (such as C++ constructors and
10944 destructors) in the form used by the GNU linker (on systems where the GNU
10945 linker is the standard method of handling them).  Use this option when
10946 you want to use a non-GNU linker, which also requires using the
10947 @command{collect2} program to make sure the system linker includes
10948 constructors and destructors.  (@command{collect2} is included in the GCC
10949 distribution.)  For systems which @emph{must} use @command{collect2}, the
10950 compiler driver @command{gcc} is configured to do this automatically.
10951
10952 @item -finhibit-size-directive
10953 @opindex finhibit-size-directive
10954 Don't output a @code{.size} assembler directive, or anything else that
10955 would cause trouble if the function is split in the middle, and the
10956 two halves are placed at locations far apart in memory.  This option is
10957 used when compiling @file{crtstuff.c}; you should not need to use it
10958 for anything else.
10959
10960 @item -fverbose-asm
10961 @opindex fverbose-asm
10962 Put extra commentary information in the generated assembly code to
10963 make it more readable.  This option is generally only of use to those
10964 who actually need to read the generated assembly code (perhaps while
10965 debugging the compiler itself).
10966
10967 @option{-fno-verbose-asm}, the default, causes the
10968 extra information to be omitted and is useful when comparing two assembler
10969 files.
10970
10971 @item -fpic
10972 @opindex fpic
10973 @cindex global offset table
10974 @cindex PIC
10975 Generate position-independent code (PIC) suitable for use in a shared
10976 library, if supported for the target machine.  Such code accesses all
10977 constant addresses through a global offset table (GOT)@.  The dynamic
10978 loader resolves the GOT entries when the program starts (the dynamic
10979 loader is not part of GCC; it is part of the operating system).  If
10980 the GOT size for the linked executable exceeds a machine-specific
10981 maximum size, you get an error message from the linker indicating that
10982 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10983 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10984 on the m68k and RS/6000.  The 386 has no such limit.)
10985
10986 Position-independent code requires special support, and therefore works
10987 only on certain machines.  For the 386, GCC supports PIC for System V
10988 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10989 position-independent.
10990
10991 @item -fPIC
10992 @opindex fPIC
10993 If supported for the target machine, emit position-independent code,
10994 suitable for dynamic linking and avoiding any limit on the size of the
10995 global offset table.  This option makes a difference on the m68k, m88k,
10996 and the SPARC.
10997
10998 Position-independent code requires special support, and therefore works
10999 only on certain machines.
11000
11001 @item -ffixed-@var{reg}
11002 @opindex ffixed
11003 Treat the register named @var{reg} as a fixed register; generated code
11004 should never refer to it (except perhaps as a stack pointer, frame
11005 pointer or in some other fixed role).
11006
11007 @var{reg} must be the name of a register.  The register names accepted
11008 are machine-specific and are defined in the @code{REGISTER_NAMES}
11009 macro in the machine description macro file.
11010
11011 This flag does not have a negative form, because it specifies a
11012 three-way choice.
11013
11014 @item -fcall-used-@var{reg}
11015 @opindex fcall-used
11016 Treat the register named @var{reg} as an allocable register that is
11017 clobbered by function calls.  It may be allocated for temporaries or
11018 variables that do not live across a call.  Functions compiled this way
11019 will not save and restore the register @var{reg}.
11020
11021 It is an error to used this flag with the frame pointer or stack pointer.
11022 Use of this flag for other registers that have fixed pervasive roles in
11023 the machine's execution model will produce disastrous results.
11024
11025 This flag does not have a negative form, because it specifies a
11026 three-way choice.
11027
11028 @item -fcall-saved-@var{reg}
11029 @opindex fcall-saved
11030 Treat the register named @var{reg} as an allocable register saved by
11031 functions.  It may be allocated even for temporaries or variables that
11032 live across a call.  Functions compiled this way will save and restore
11033 the register @var{reg} if they use it.
11034
11035 It is an error to used this flag with the frame pointer or stack pointer.
11036 Use of this flag for other registers that have fixed pervasive roles in
11037 the machine's execution model will produce disastrous results.
11038
11039 A different sort of disaster will result from the use of this flag for
11040 a register in which function values may be returned.
11041
11042 This flag does not have a negative form, because it specifies a
11043 three-way choice.
11044
11045 @item -fpack-struct
11046 @opindex fpack-struct
11047 Pack all structure members together without holes.
11048
11049 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11050 code that is not binary compatible with code generated without that switch.
11051 Additionally, it makes the code suboptimal.
11052 Use it to conform to a non-default application binary interface.
11053
11054 @item -finstrument-functions
11055 @opindex finstrument-functions
11056 Generate instrumentation calls for entry and exit to functions.  Just
11057 after function entry and just before function exit, the following
11058 profiling functions will be called with the address of the current
11059 function and its call site.  (On some platforms,
11060 @code{__builtin_return_address} does not work beyond the current
11061 function, so the call site information may not be available to the
11062 profiling functions otherwise.)
11063
11064 @example
11065 void __cyg_profile_func_enter (void *this_fn,
11066                                void *call_site);
11067 void __cyg_profile_func_exit  (void *this_fn,
11068                                void *call_site);
11069 @end example
11070
11071 The first argument is the address of the start of the current function,
11072 which may be looked up exactly in the symbol table.
11073
11074 This instrumentation is also done for functions expanded inline in other
11075 functions.  The profiling calls will indicate where, conceptually, the
11076 inline function is entered and exited.  This means that addressable
11077 versions of such functions must be available.  If all your uses of a
11078 function are expanded inline, this may mean an additional expansion of
11079 code size.  If you use @samp{extern inline} in your C code, an
11080 addressable version of such functions must be provided.  (This is
11081 normally the case anyways, but if you get lucky and the optimizer always
11082 expands the functions inline, you might have gotten away without
11083 providing static copies.)
11084
11085 A function may be given the attribute @code{no_instrument_function}, in
11086 which case this instrumentation will not be done.  This can be used, for
11087 example, for the profiling functions listed above, high-priority
11088 interrupt routines, and any functions from which the profiling functions
11089 cannot safely be called (perhaps signal handlers, if the profiling
11090 routines generate output or allocate memory).
11091
11092 @item -fstack-check
11093 @opindex fstack-check
11094 Generate code to verify that you do not go beyond the boundary of the
11095 stack.  You should specify this flag if you are running in an
11096 environment with multiple threads, but only rarely need to specify it in
11097 a single-threaded environment since stack overflow is automatically
11098 detected on nearly all systems if there is only one stack.
11099
11100 Note that this switch does not actually cause checking to be done; the
11101 operating system must do that.  The switch causes generation of code
11102 to ensure that the operating system sees the stack being extended.
11103
11104 @item -fstack-limit-register=@var{reg}
11105 @itemx -fstack-limit-symbol=@var{sym}
11106 @itemx -fno-stack-limit
11107 @opindex fstack-limit-register
11108 @opindex fstack-limit-symbol
11109 @opindex fno-stack-limit
11110 Generate code to ensure that the stack does not grow beyond a certain value,
11111 either the value of a register or the address of a symbol.  If the stack
11112 would grow beyond the value, a signal is raised.  For most targets,
11113 the signal is raised before the stack overruns the boundary, so
11114 it is possible to catch the signal without taking special precautions.
11115
11116 For instance, if the stack starts at absolute address @samp{0x80000000}
11117 and grows downwards, you can use the flags
11118 @option{-fstack-limit-symbol=__stack_limit} and
11119 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11120 of 128KB@.  Note that this may only work with the GNU linker.
11121
11122 @cindex aliasing of parameters
11123 @cindex parameters, aliased
11124 @item -fargument-alias
11125 @itemx -fargument-noalias
11126 @itemx -fargument-noalias-global
11127 @opindex fargument-alias
11128 @opindex fargument-noalias
11129 @opindex fargument-noalias-global
11130 Specify the possible relationships among parameters and between
11131 parameters and global data.
11132
11133 @option{-fargument-alias} specifies that arguments (parameters) may
11134 alias each other and may alias global storage.@*
11135 @option{-fargument-noalias} specifies that arguments do not alias
11136 each other, but may alias global storage.@*
11137 @option{-fargument-noalias-global} specifies that arguments do not
11138 alias each other and do not alias global storage.
11139
11140 Each language will automatically use whatever option is required by
11141 the language standard.  You should not need to use these options yourself.
11142
11143 @item -fleading-underscore
11144 @opindex fleading-underscore
11145 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11146 change the way C symbols are represented in the object file.  One use
11147 is to help link with legacy assembly code.
11148
11149 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11150 generate code that is not binary compatible with code generated without that
11151 switch.  Use it to conform to a non-default application binary interface.
11152 Not all targets provide complete support for this switch.
11153
11154 @item -ftls-model=@var{model}
11155 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11156 The @var{model} argument should be one of @code{global-dynamic},
11157 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11158
11159 The default without @option{-fpic} is @code{initial-exec}; with
11160 @option{-fpic} the default is @code{global-dynamic}.
11161 @end table
11162
11163 @c man end
11164
11165 @node Environment Variables
11166 @section Environment Variables Affecting GCC
11167 @cindex environment variables
11168
11169 @c man begin ENVIRONMENT
11170 This section describes several environment variables that affect how GCC
11171 operates.  Some of them work by specifying directories or prefixes to use
11172 when searching for various kinds of files.  Some are used to specify other
11173 aspects of the compilation environment.
11174
11175 Note that you can also specify places to search using options such as
11176 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11177 take precedence over places specified using environment variables, which
11178 in turn take precedence over those specified by the configuration of GCC@.
11179 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11180 GNU Compiler Collection (GCC) Internals}.
11181
11182 @table @env
11183 @item LANG
11184 @itemx LC_CTYPE
11185 @c @itemx LC_COLLATE
11186 @itemx LC_MESSAGES
11187 @c @itemx LC_MONETARY
11188 @c @itemx LC_NUMERIC
11189 @c @itemx LC_TIME
11190 @itemx LC_ALL
11191 @findex LANG
11192 @findex LC_CTYPE
11193 @c @findex LC_COLLATE
11194 @findex LC_MESSAGES
11195 @c @findex LC_MONETARY
11196 @c @findex LC_NUMERIC
11197 @c @findex LC_TIME
11198 @findex LC_ALL
11199 @cindex locale
11200 These environment variables control the way that GCC uses
11201 localization information that allow GCC to work with different
11202 national conventions.  GCC inspects the locale categories
11203 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11204 so.  These locale categories can be set to any value supported by your
11205 installation.  A typical value is @samp{en_UK} for English in the United
11206 Kingdom.
11207
11208 The @env{LC_CTYPE} environment variable specifies character
11209 classification.  GCC uses it to determine the character boundaries in
11210 a string; this is needed for some multibyte encodings that contain quote
11211 and escape characters that would otherwise be interpreted as a string
11212 end or escape.
11213
11214 The @env{LC_MESSAGES} environment variable specifies the language to
11215 use in diagnostic messages.
11216
11217 If the @env{LC_ALL} environment variable is set, it overrides the value
11218 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11219 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11220 environment variable.  If none of these variables are set, GCC
11221 defaults to traditional C English behavior.
11222
11223 @item TMPDIR
11224 @findex TMPDIR
11225 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11226 files.  GCC uses temporary files to hold the output of one stage of
11227 compilation which is to be used as input to the next stage: for example,
11228 the output of the preprocessor, which is the input to the compiler
11229 proper.
11230
11231 @item GCC_EXEC_PREFIX
11232 @findex GCC_EXEC_PREFIX
11233 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11234 names of the subprograms executed by the compiler.  No slash is added
11235 when this prefix is combined with the name of a subprogram, but you can
11236 specify a prefix that ends with a slash if you wish.
11237
11238 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11239 an appropriate prefix to use based on the pathname it was invoked with.
11240
11241 If GCC cannot find the subprogram using the specified prefix, it
11242 tries looking in the usual places for the subprogram.
11243
11244 The default value of @env{GCC_EXEC_PREFIX} is
11245 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11246 of @code{prefix} when you ran the @file{configure} script.
11247
11248 Other prefixes specified with @option{-B} take precedence over this prefix.
11249
11250 This prefix is also used for finding files such as @file{crt0.o} that are
11251 used for linking.
11252
11253 In addition, the prefix is used in an unusual way in finding the
11254 directories to search for header files.  For each of the standard
11255 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11256 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11257 replacing that beginning with the specified prefix to produce an
11258 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11259 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11260 These alternate directories are searched first; the standard directories
11261 come next.
11262
11263 @item COMPILER_PATH
11264 @findex COMPILER_PATH
11265 The value of @env{COMPILER_PATH} is a colon-separated list of
11266 directories, much like @env{PATH}.  GCC tries the directories thus
11267 specified when searching for subprograms, if it can't find the
11268 subprograms using @env{GCC_EXEC_PREFIX}.
11269
11270 @item LIBRARY_PATH
11271 @findex LIBRARY_PATH
11272 The value of @env{LIBRARY_PATH} is a colon-separated list of
11273 directories, much like @env{PATH}.  When configured as a native compiler,
11274 GCC tries the directories thus specified when searching for special
11275 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11276 using GCC also uses these directories when searching for ordinary
11277 libraries for the @option{-l} option (but directories specified with
11278 @option{-L} come first).
11279
11280 @item LANG
11281 @findex LANG
11282 @cindex locale definition
11283 This variable is used to pass locale information to the compiler.  One way in
11284 which this information is used is to determine the character set to be used
11285 when character literals, string literals and comments are parsed in C and C++.
11286 When the compiler is configured to allow multibyte characters,
11287 the following values for @env{LANG} are recognized:
11288
11289 @table @samp
11290 @item C-JIS
11291 Recognize JIS characters.
11292 @item C-SJIS
11293 Recognize SJIS characters.
11294 @item C-EUCJP
11295 Recognize EUCJP characters.
11296 @end table
11297
11298 If @env{LANG} is not defined, or if it has some other value, then the
11299 compiler will use mblen and mbtowc as defined by the default locale to
11300 recognize and translate multibyte characters.
11301 @end table
11302
11303 @noindent
11304 Some additional environments variables affect the behavior of the
11305 preprocessor.
11306
11307 @include cppenv.texi
11308
11309 @c man end
11310
11311 @node Precompiled Headers
11312 @section Using Precompiled Headers
11313 @cindex precompiled headers
11314 @cindex speed of compilation
11315
11316 Often large projects have many header files that are included in every
11317 source file.  The time the compiler takes to process these header files
11318 over and over again can account for nearly all of the time required to
11319 build the project.  To make builds faster, GCC allows users to
11320 `precompile' a header file; then, if builds can use the precompiled
11321 header file they will be much faster.
11322
11323 To create a precompiled header file, simply compile it as you would any
11324 other file, if necessary using the @option{-x} option to make the driver
11325 treat it as a C or C++ header file.  You will probably want to use a
11326 tool like @command{make} to keep the precompiled header up-to-date when
11327 the headers it contains change.
11328
11329 A precompiled header file will be searched for when @code{#include} is
11330 seen in the compilation.  As it searches for the included file
11331 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11332 compiler looks for a precompiled header in each directory just before it
11333 looks for the include file in that directory.  The name searched for is
11334 the name specified in the @code{#include} with @samp{.gch} appended.  If
11335 the precompiled header file can't be used, it is ignored.
11336
11337 For instance, if you have @code{#include "all.h"}, and you have
11338 @file{all.h.gch} in the same directory as @file{all.h}, then the
11339 precompiled header file will be used if possible, and the original
11340 header will be used otherwise.
11341
11342 Alternatively, you might decide to put the precompiled header file in a
11343 directory and use @option{-I} to ensure that directory is searched
11344 before (or instead of) the directory containing the original header.
11345 Then, if you want to check that the precompiled header file is always
11346 used, you can put a file of the same name as the original header in this
11347 directory containing an @code{#error} command.
11348
11349 This also works with @option{-include}.  So yet another way to use
11350 precompiled headers, good for projects not designed with precompiled
11351 header files in mind, is to simply take most of the header files used by
11352 a project, include them from another header file, precompile that header
11353 file, and @option{-include} the precompiled header.  If the header files
11354 have guards against multiple inclusion, they will be skipped because
11355 they've already been included (in the precompiled header).
11356
11357 If you need to precompile the same header file for different
11358 languages, targets, or compiler options, you can instead make a
11359 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11360 header in the directory.  (It doesn't matter what you call the files
11361 in the directory, every precompiled header in the directory will be
11362 considered.)  The first precompiled header encountered in the
11363 directory that is valid for this compilation will be used; they're
11364 searched in no particular order.
11365
11366 There are many other possibilities, limited only by your imagination,
11367 good sense, and the constraints of your build system.
11368
11369 A precompiled header file can be used only when these conditions apply:
11370
11371 @itemize
11372 @item
11373 Only one precompiled header can be used in a particular compilation.
11374 @item
11375 A precompiled header can't be used once the first C token is seen.  You
11376 can have preprocessor directives before a precompiled header; you can
11377 even include a precompiled header from inside another header, so long as
11378 there are no C tokens before the @code{#include}.
11379 @item
11380 The precompiled header file must be produced for the same language as
11381 the current compilation.  You can't use a C precompiled header for a C++
11382 compilation.
11383 @item
11384 The precompiled header file must be produced by the same compiler
11385 version and configuration as the current compilation is using.
11386 The easiest way to guarantee this is to use the same compiler binary
11387 for creating and using precompiled headers.
11388 @item
11389 Any macros defined before the precompiled header (including with
11390 @option{-D}) must either be defined in the same way as when the
11391 precompiled header was generated, or must not affect the precompiled
11392 header, which usually means that the they don't appear in the
11393 precompiled header at all.
11394 @item
11395 Certain command-line options must be defined in the same way as when the
11396 precompiled header was generated.  At present, it's not clear which
11397 options are safe to change and which are not; the safest choice is to
11398 use exactly the same options when generating and using the precompiled
11399 header.
11400 @end itemize
11401
11402 For all of these but the last, the compiler will automatically ignore
11403 the precompiled header if the conditions aren't met.  For the last item,
11404 some option changes will cause the precompiled header to be rejected,
11405 but not all incompatible option combinations have yet been found.  If
11406 you find a new incompatible combination, please consider filing a bug
11407 report, see @ref{Bugs}.
11408
11409 @node Running Protoize
11410 @section Running Protoize
11411
11412 The program @code{protoize} is an optional part of GCC@.  You can use
11413 it to add prototypes to a program, thus converting the program to ISO
11414 C in one respect.  The companion program @code{unprotoize} does the
11415 reverse: it removes argument types from any prototypes that are found.
11416
11417 When you run these programs, you must specify a set of source files as
11418 command line arguments.  The conversion programs start out by compiling
11419 these files to see what functions they define.  The information gathered
11420 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11421
11422 After scanning comes actual conversion.  The specified files are all
11423 eligible to be converted; any files they include (whether sources or
11424 just headers) are eligible as well.
11425
11426 But not all the eligible files are converted.  By default,
11427 @code{protoize} and @code{unprotoize} convert only source and header
11428 files in the current directory.  You can specify additional directories
11429 whose files should be converted with the @option{-d @var{directory}}
11430 option.  You can also specify particular files to exclude with the
11431 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11432 directory name matches one of the specified directory names, and its
11433 name within the directory has not been excluded.
11434
11435 Basic conversion with @code{protoize} consists of rewriting most
11436 function definitions and function declarations to specify the types of
11437 the arguments.  The only ones not rewritten are those for varargs
11438 functions.
11439
11440 @code{protoize} optionally inserts prototype declarations at the
11441 beginning of the source file, to make them available for any calls that
11442 precede the function's definition.  Or it can insert prototype
11443 declarations with block scope in the blocks where undeclared functions
11444 are called.
11445
11446 Basic conversion with @code{unprotoize} consists of rewriting most
11447 function declarations to remove any argument types, and rewriting
11448 function definitions to the old-style pre-ISO form.
11449
11450 Both conversion programs print a warning for any function declaration or
11451 definition that they can't convert.  You can suppress these warnings
11452 with @option{-q}.
11453
11454 The output from @code{protoize} or @code{unprotoize} replaces the
11455 original source file.  The original file is renamed to a name ending
11456 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11457 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11458 for DOS) file already exists, then the source file is simply discarded.
11459
11460 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11461 scan the program and collect information about the functions it uses.
11462 So neither of these programs will work until GCC is installed.
11463
11464 Here is a table of the options you can use with @code{protoize} and
11465 @code{unprotoize}.  Each option works with both programs unless
11466 otherwise stated.
11467
11468 @table @code
11469 @item -B @var{directory}
11470 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11471 usual directory (normally @file{/usr/local/lib}).  This file contains
11472 prototype information about standard system functions.  This option
11473 applies only to @code{protoize}.
11474
11475 @item -c @var{compilation-options}
11476 Use @var{compilation-options} as the options when running @command{gcc} to
11477 produce the @samp{.X} files.  The special option @option{-aux-info} is
11478 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11479
11480 Note that the compilation options must be given as a single argument to
11481 @code{protoize} or @code{unprotoize}.  If you want to specify several
11482 @command{gcc} options, you must quote the entire set of compilation options
11483 to make them a single word in the shell.
11484
11485 There are certain @command{gcc} arguments that you cannot use, because they
11486 would produce the wrong kind of output.  These include @option{-g},
11487 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11488 the @var{compilation-options}, they are ignored.
11489
11490 @item -C
11491 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11492 systems) instead of @samp{.c}.  This is convenient if you are converting
11493 a C program to C++.  This option applies only to @code{protoize}.
11494
11495 @item -g
11496 Add explicit global declarations.  This means inserting explicit
11497 declarations at the beginning of each source file for each function
11498 that is called in the file and was not declared.  These declarations
11499 precede the first function definition that contains a call to an
11500 undeclared function.  This option applies only to @code{protoize}.
11501
11502 @item -i @var{string}
11503 Indent old-style parameter declarations with the string @var{string}.
11504 This option applies only to @code{protoize}.
11505
11506 @code{unprotoize} converts prototyped function definitions to old-style
11507 function definitions, where the arguments are declared between the
11508 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11509 uses five spaces as the indentation.  If you want to indent with just
11510 one space instead, use @option{-i " "}.
11511
11512 @item -k
11513 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11514 is finished.
11515
11516 @item -l
11517 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11518 a prototype declaration for each function in each block which calls the
11519 function without any declaration.  This option applies only to
11520 @code{protoize}.
11521
11522 @item -n
11523 Make no real changes.  This mode just prints information about the conversions
11524 that would have been done without @option{-n}.
11525
11526 @item -N
11527 Make no @samp{.save} files.  The original files are simply deleted.
11528 Use this option with caution.
11529
11530 @item -p @var{program}
11531 Use the program @var{program} as the compiler.  Normally, the name
11532 @file{gcc} is used.
11533
11534 @item -q
11535 Work quietly.  Most warnings are suppressed.
11536
11537 @item -v
11538 Print the version number, just like @option{-v} for @command{gcc}.
11539 @end table
11540
11541 If you need special compiler options to compile one of your program's
11542 source files, then you should generate that file's @samp{.X} file
11543 specially, by running @command{gcc} on that source file with the
11544 appropriate options and the option @option{-aux-info}.  Then run
11545 @code{protoize} on the entire set of files.  @code{protoize} will use
11546 the existing @samp{.X} file because it is newer than the source file.
11547 For example:
11548
11549 @example
11550 gcc -Dfoo=bar file1.c -aux-info file1.X
11551 protoize *.c
11552 @end example
11553
11554 @noindent
11555 You need to include the special files along with the rest in the
11556 @code{protoize} command, even though their @samp{.X} files already
11557 exist, because otherwise they won't get converted.
11558
11559 @xref{Protoize Caveats}, for more information on how to use
11560 @code{protoize} successfully.