OSDN Git Service

* doc/invoke.texi: Add documentation for the MIPS -mexplicit-relocs
[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, 2004 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, 2004 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo  -Wsynth}
192
193 @item Objective-C Language Options
194 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
195 @gccoptlist{
196 -fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime @gol
198 -fno-nil-receivers @gol
199 -fobjc-exceptions @gol
200 -freplace-objc-classes @gol
201 -fzero-link @gol
202 -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
204
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{-fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
213 -w  -Wextra  -Wall  -Waggregate-return @gol
214 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
215 -Wconversion  -Wno-deprecated-declarations @gol
216 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
217 -Werror  -Werror-implicit-function-declaration @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wno-format-extra-args -Wformat-nonliteral @gol
220 -Wformat-security  -Wformat-y2k @gol
221 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
222 -Wimport  -Wno-import  -Winit-self  -Winline @gol
223 -Wno-invalid-offsetof  -Winvalid-pch @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
228 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
229 -Wreturn-type  -Wsequence-point  -Wshadow @gol
230 -Wsign-compare  -Wstrict-aliasing @gol
231 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
232 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings}
236
237 @item C-only Warning Options
238 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
239 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
240 -Wstrict-prototypes  -Wtraditional @gol
241 -Wdeclaration-after-statement}
242
243 @item Debugging Options
244 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
245 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
246 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
249 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
251 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
252 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
253 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report @gol
255 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
265 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
266 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
267 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
268 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
269 -fdelayed-branch  -fdelete-null-pointer-checks @gol
270 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
271 -fforce-addr  -fforce-mem  -ffunction-sections @gol
272 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -floop-optimize @gol
273 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
274 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
275 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
276 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
277 -fno-default-inline  -fno-defer-pop @gol
278 -fno-function-cse  -fno-guess-branch-probability @gol
279 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
280 -funsafe-math-optimizations  -ffinite-math-only @gol
281 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
282 -fomit-frame-pointer  -foptimize-register-move @gol
283 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
284 -fprofile-generate -fprofile-use @gol
285 -freduce-all-givs  -fregmove  -frename-registers @gol
286 -freorder-blocks  -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  @gol
291 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
292 -fsched2-use-superblocks @gol
293 -fsched2-use-traces  -fsignaling-nans @gol
294 -fsingle-precision-constant  @gol
295 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
296 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
297 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
298 --param @var{name}=@var{value}
299 -O  -O0  -O1  -O2  -O3  -Os}
300
301 @item Preprocessor Options
302 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
303 @gccoptlist{-A@var{question}=@var{answer} @gol
304 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
305 -C  -dD  -dI  -dM  -dN @gol
306 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
307 -idirafter @var{dir} @gol
308 -include @var{file}  -imacros @var{file} @gol
309 -iprefix @var{file}  -iwithprefix @var{dir} @gol
310 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
311 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
312 -P  -fworking-directory  -remap @gol
313 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
314 -Xpreprocessor @var{option}}
315
316 @item Assembler Option
317 @xref{Assembler Options,,Passing Options to the Assembler}.
318 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
319
320 @item Linker Options
321 @xref{Link Options,,Options for Linking}.
322 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
323 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
324 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
325 -Wl,@var{option}  -Xlinker @var{option} @gol
326 -u @var{symbol}}
327
328 @item Directory Options
329 @xref{Directory Options,,Options for Directory Search}.
330 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
331
332 @item Target Options
333 @c I wrote this xref this way to avoid overfull hbox. -- rms
334 @xref{Target Options}.
335 @gccoptlist{-V @var{version}  -b @var{machine}}
336
337 @item Machine Dependent Options
338 @xref{Submodel Options,,Hardware Models and Configurations}.
339
340 @emph{M680x0 Options}
341 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
342 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
343 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
344 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
345 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
346
347 @emph{M68hc1x Options}
348 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
349 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
350 -msoft-reg-count=@var{count}}
351
352 @emph{VAX Options}
353 @gccoptlist{-mg  -mgnu  -munix}
354
355 @emph{SPARC Options}
356 @gccoptlist{-mcpu=@var{cpu-type} @gol
357 -mtune=@var{cpu-type} @gol
358 -mcmodel=@var{code-model} @gol
359 -m32  -m64 @gol
360 -mapp-regs  -mbroken-saverestore  -mcypress @gol
361 -mfaster-structs  -mflat @gol
362 -mfpu  -mhard-float  -mhard-quad-float @gol
363 -mimpure-text  -mlittle-endian  -mlive-g0  -mno-app-regs @gol
364 -mno-faster-structs  -mno-flat  -mno-fpu @gol
365 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
366 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
367 -msupersparc  -munaligned-doubles  -mv8}
368
369 @emph{ARM Options}
370 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
371 -mapcs-26  -mapcs-32 @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -malignment-traps  -mno-alignment-traps @gol
378 -msoft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mabort-on-noreturn @gol
383 -mlong-calls  -mno-long-calls @gol
384 -msingle-pic-base  -mno-single-pic-base @gol
385 -mpic-register=@var{reg} @gol
386 -mnop-fun-dllimport @gol
387 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
388 -mpoke-function-name @gol
389 -mthumb  -marm @gol
390 -mtpcs-frame  -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking  -mcallee-super-interworking}
392
393 @emph{MN10200 Options}
394 @gccoptlist{-mrelax}
395
396 @emph{MN10300 Options}
397 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
398 -mam33  -mno-am33 @gol
399 -mam33-2  -mno-am33-2 @gol
400 -mno-crt0  -mrelax}
401
402 @emph{M32R/D Options}
403 @gccoptlist{-m32r2 -m32rx -m32r @gol
404 -mdebug @gol
405 -malign-loops -mno-align-loops @gol
406 -missue-rate=@var{number} @gol
407 -mbranch-cost=@var{number} @gol
408 -mmodel=@var{code-size-model-type} @gol
409 -msdata=@var{sdata-type} @gol
410 -mno-flush-func -mflush-func=@var{name} @gol
411 -mno-flush-trap -mflush-trap=@var{number} @gol
412 -G @var{num}}
413
414 @emph{M88K Options}
415 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
416 -mcheck-zero-division  -mhandle-large-shift @gol
417 -midentify-revision  -mno-check-zero-division @gol
418 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
419 -mno-optimize-arg-area  -mno-serialize-volatile @gol
420 -mno-underscores  -mocs-debug-info @gol
421 -mocs-frame-position  -moptimize-arg-area @gol
422 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
423 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
424 -mversion-03.00  -mwarn-passed-structs}
425
426 @emph{RS/6000 and PowerPC Options}
427 @gccoptlist{-mcpu=@var{cpu-type} @gol
428 -mtune=@var{cpu-type} @gol
429 -mpower  -mno-power  -mpower2  -mno-power2 @gol
430 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
431 -maltivec  -mno-altivec @gol
432 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
433 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
434 -mnew-mnemonics  -mold-mnemonics @gol
435 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
436 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
437 -malign-power  -malign-natural @gol
438 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
439 -mstring  -mno-string  -mupdate  -mno-update @gol
440 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
441 -mstrict-align  -mno-strict-align  -mrelocatable @gol
442 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
443 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
444 -mdynamic-no-pic @gol
445 -mprioritize-restricted-insns=@var{priority} @gol
446 -msched-costly-dep=@var{dependence_type} @gol
447 -minsert-sched-nops=@var{scheme} @gol
448 -mcall-sysv  -mcall-netbsd @gol
449 -maix-struct-return  -msvr4-struct-return @gol
450 -mabi=altivec  -mabi=no-altivec @gol
451 -mabi=spe  -mabi=no-spe @gol
452 -misel=yes  -misel=no @gol
453 -mspe=yes  -mspe=no @gol
454 -mfloat-gprs=yes  -mfloat-gprs=no @gol
455 -mprototype  -mno-prototype @gol
456 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
457 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
458
459 @emph{Darwin Options}
460 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
461 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
462 -client_name  -compatibility_version  -current_version @gol
463 -dependency-file  -dylib_file  -dylinker_install_name @gol
464 -dynamic  -dynamiclib  -exported_symbols_list @gol
465 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
466 -force_flat_namespace  -headerpad_max_install_names @gol
467 -image_base  -init  -install_name  -keep_private_externs @gol
468 -multi_module  -multiply_defined  -multiply_defined_unused @gol
469 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
470 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
471 -private_bundle  -read_only_relocs  -sectalign @gol
472 -sectobjectsymbols  -whyload  -seg1addr @gol
473 -sectcreate  -sectobjectsymbols  -sectorder @gol
474 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
475 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
476 -single_module  -static  -sub_library  -sub_umbrella @gol
477 -twolevel_namespace  -umbrella  -undefined @gol
478 -unexported_symbols_list  -weak_reference_mismatches @gol
479 -whatsloaded}
480
481 @emph{RT Options}
482 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
483 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
484 -mminimum-fp-blocks  -mnohc-struct-return}
485
486 @emph{MIPS Options}
487 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
488 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
489 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
490 -mxgot  -mno-xgot  -membedded-pic  -mno-embedded-pic @gol
491 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
492 -msingle-float  -mdouble-float  -mint64  -mlong64  -mlong32 @gol
493 -G@var{num}  -membedded-data  -mno-embedded-data @gol
494 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
495 -msplit-addresses  -mno-split-addresses  @gol
496 -mexplicit-relocs  -mno-explicit-relocs  @gol
497 -mrnames  -mno-rnames @gol
498 -mcheck-zero-division  -mno-check-zero-division @gol
499 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
500 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
501 -mfix-sb1  -mno-fix-sb1  -mflush-func=@var{func} @gol
502 -mno-flush-func  -mbranch-likely  -mno-branch-likely}
503
504 @emph{i386 and x86-64 Options}
505 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
506 -mfpmath=@var{unit} @gol
507 -masm=@var{dialect}  -mno-fancy-math-387 @gol
508 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
509 -mno-wide-multiply  -mrtd  -malign-double @gol
510 -mpreferred-stack-boundary=@var{num} @gol
511 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
512 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
513 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
514 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
515 -mno-red-zone -mno-tls-direct-seg-refs @gol
516 -mcmodel=@var{code-model} @gol
517 -m32  -m64}
518
519 @emph{HPPA Options}
520 @gccoptlist{-march=@var{architecture-type} @gol
521 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
522 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
523 -mjump-in-delay -mlinker-opt -mlong-calls @gol
524 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
525 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
526 -mno-jump-in-delay  -mno-long-load-store @gol
527 -mno-portable-runtime  -mno-soft-float @gol
528 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
529 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
530 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
531 -nolibdld  -static  -threads}
532
533 @emph{Intel 960 Options}
534 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
535 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
536 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
537 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
538 -mno-complex-addr  -mno-leaf-procedures @gol
539 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
540 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
541 -mtail-call}
542
543 @emph{DEC Alpha Options}
544 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
545 -mieee  -mieee-with-inexact  -mieee-conformant @gol
546 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
547 -mtrap-precision=@var{mode}  -mbuild-constants @gol
548 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
549 -mbwx  -mmax  -mfix  -mcix @gol
550 -mfloat-vax  -mfloat-ieee @gol
551 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
552 -msmall-text  -mlarge-text @gol
553 -mmemory-latency=@var{time}}
554
555 @emph{DEC Alpha/VMS Options}
556 @gccoptlist{-mvms-return-codes}
557
558 @emph{H8/300 Options}
559 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
560
561 @emph{SH Options}
562 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
563 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
564 -m5-64media  -m5-64media-nofpu @gol
565 -m5-32media  -m5-32media-nofpu @gol
566 -m5-compact  -m5-compact-nofpu @gol
567 -mb  -ml  -mdalign  -mrelax @gol
568 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
569 -mieee  -misize  -mpadstruct  -mspace @gol
570 -mprefergot  -musermode}
571
572 @emph{System V Options}
573 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
574
575 @emph{ARC Options}
576 @gccoptlist{-EB  -EL @gol
577 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
578 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
579
580 @emph{TMS320C3x/C4x Options}
581 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
582 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
583 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
584 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
585
586 @emph{V850 Options}
587 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
588 -mprolog-function  -mno-prolog-function  -mspace @gol
589 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
590 -mapp-regs  -mno-app-regs @gol
591 -mdisable-callt  -mno-disable-callt @gol
592 -mv850e1 @gol
593 -mv850e @gol
594 -mv850  -mbig-switch}
595
596 @emph{NS32K Options}
597 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
598 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
599 -mregparam  -mnoregparam  -msb  -mnosb @gol
600 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
601
602 @emph{AVR Options}
603 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
604 -mcall-prologues  -mno-tablejump  -mtiny-stack}
605
606 @emph{MCore Options}
607 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
608 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
609 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
610 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
611 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
612
613 @emph{MMIX Options}
614 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
615 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
616 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
617 -mno-base-addresses  -msingle-exit  -mno-single-exit}
618
619 @emph{IA-64 Options}
620 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
621 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
622 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
623 -minline-float-divide-max-throughput @gol
624 -minline-int-divide-min-latency @gol
625 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
626 -mfixed-range=@var{register-range}}
627
628 @emph{D30V Options}
629 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
630 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
631
632 @emph{S/390 and zSeries Options}
633 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
634 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
635 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
636 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
637
638 @emph{CRIS Options}
639 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
640 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
641 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
642 -mstack-align  -mdata-align  -mconst-align @gol
643 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
644 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
645
646 @emph{PDP-11 Options}
647 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
648 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
649 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
650 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
651 -mbranch-expensive  -mbranch-cheap @gol
652 -msplit  -mno-split  -munix-asm  -mdec-asm}
653
654 @emph{Xstormy16 Options}
655 @gccoptlist{-msim}
656
657 @emph{Xtensa Options}
658 @gccoptlist{-mconst16 -mno-const16 @gol
659 -mfused-madd  -mno-fused-madd @gol
660 -mtext-section-literals  -mno-text-section-literals @gol
661 -mtarget-align  -mno-target-align @gol
662 -mlongcalls  -mno-longcalls}
663
664 @emph{FRV Options}
665 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
666 -mhard-float  -msoft-float @gol
667 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
668 -mdouble  -mno-double @gol
669 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
670 -mlibrary-pic  -macc-4 -macc-8 @gol
671 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
672 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
673 -mvliw-branch  -mno-vliw-branch @gol
674 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
675 -mno-nested-cond-exec  -mtomcat-stats @gol
676 -mcpu=@var{cpu}}
677
678 @item Code Generation Options
679 @xref{Code Gen Options,,Options for Code Generation Conventions}.
680 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
681 -ffixed-@var{reg}  -fexceptions @gol
682 -fnon-call-exceptions  -funwind-tables @gol
683 -fasynchronous-unwind-tables @gol
684 -finhibit-size-directive  -finstrument-functions @gol
685 -fno-common  -fno-ident @gol
686 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
687 -freg-struct-return  -fshared-data  -fshort-enums @gol
688 -fshort-double  -fshort-wchar @gol
689 -fverbose-asm  -fpack-struct  -fstack-check @gol
690 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
691 -fargument-alias  -fargument-noalias @gol
692 -fargument-noalias-global  -fleading-underscore @gol
693 -ftls-model=@var{model} @gol
694 -ftrapv  -fwrapv  -fbounds-check}
695 @end table
696
697 @menu
698 * Overall Options::     Controlling the kind of output:
699                         an executable, object files, assembler files,
700                         or preprocessed source.
701 * C Dialect Options::   Controlling the variant of C language compiled.
702 * C++ Dialect Options:: Variations on C++.
703 * Objective-C Dialect Options:: Variations on Objective-C.
704 * Language Independent Options:: Controlling how diagnostics should be
705                         formatted.
706 * Warning Options::     How picky should the compiler be?
707 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
708 * Optimize Options::    How much optimization?
709 * Preprocessor Options:: Controlling header files and macro definitions.
710                          Also, getting dependency information for Make.
711 * Assembler Options::   Passing options to the assembler.
712 * Link Options::        Specifying libraries and so on.
713 * Directory Options::   Where to find header files and libraries.
714                         Where to find the compiler executable files.
715 * Spec Files::          How to pass switches to sub-processes.
716 * Target Options::      Running a cross-compiler, or an old version of GCC.
717 @end menu
718
719 @node Overall Options
720 @section Options Controlling the Kind of Output
721
722 Compilation can involve up to four stages: preprocessing, compilation
723 proper, assembly and linking, always in that order.  GCC is capable of
724 preprocessing and compiling several files either into several
725 assembler input files, or into one assembler input file; then each
726 assembler input file produces an object file, and linking combines all
727 the object files (those newly compiled, and those specified as input)
728 into an executable file.
729
730 @cindex file name suffix
731 For any given input file, the file name suffix determines what kind of
732 compilation is done:
733
734 @table @gcctabopt
735 @item @var{file}.c
736 C source code which must be preprocessed.
737
738 @item @var{file}.i
739 C source code which should not be preprocessed.
740
741 @item @var{file}.ii
742 C++ source code which should not be preprocessed.
743
744 @item @var{file}.m
745 Objective-C source code.  Note that you must link with the library
746 @file{libobjc.a} to make an Objective-C program work.
747
748 @item @var{file}.mi
749 Objective-C source code which should not be preprocessed.
750
751 @item @var{file}.h
752 C or C++ header file to be turned into a precompiled header.
753
754 @item @var{file}.cc
755 @itemx @var{file}.cp
756 @itemx @var{file}.cxx
757 @itemx @var{file}.cpp
758 @itemx @var{file}.CPP
759 @itemx @var{file}.c++
760 @itemx @var{file}.C
761 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
762 the last two letters must both be literally @samp{x}.  Likewise,
763 @samp{.C} refers to a literal capital C@.
764
765 @item @var{file}.hh
766 @itemx @var{file}.H
767 C++ header file to be turned into a precompiled header.
768
769 @item @var{file}.f
770 @itemx @var{file}.for
771 @itemx @var{file}.FOR
772 Fortran source code which should not be preprocessed.
773
774 @item @var{file}.F
775 @itemx @var{file}.fpp
776 @itemx @var{file}.FPP
777 Fortran source code which must be preprocessed (with the traditional
778 preprocessor).
779
780 @item @var{file}.r
781 Fortran source code which must be preprocessed with a RATFOR
782 preprocessor (not included with GCC)@.
783
784 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
785 Using and Porting GNU Fortran}, for more details of the handling of
786 Fortran input files.
787
788 @c FIXME: Descriptions of Java file types.
789 @c @var{file}.java
790 @c @var{file}.class
791 @c @var{file}.zip
792 @c @var{file}.jar
793
794 @item @var{file}.ads
795 Ada source code file which contains a library unit declaration (a
796 declaration of a package, subprogram, or generic, or a generic
797 instantiation), or a library unit renaming declaration (a package,
798 generic, or subprogram renaming declaration).  Such files are also
799 called @dfn{specs}.
800
801 @itemx @var{file}.adb
802 Ada source code file containing a library unit body (a subprogram or
803 package body).  Such files are also called @dfn{bodies}.
804
805 @c GCC also knows about some suffixes for languages not yet included:
806 @c Pascal:
807 @c @var{file}.p
808 @c @var{file}.pas
809
810 @item @var{file}.s
811 Assembler code.
812
813 @item @var{file}.S
814 Assembler code which must be preprocessed.
815
816 @item @var{other}
817 An object file to be fed straight into linking.
818 Any file name with no recognized suffix is treated this way.
819 @end table
820
821 @opindex x
822 You can specify the input language explicitly with the @option{-x} option:
823
824 @table @gcctabopt
825 @item -x @var{language}
826 Specify explicitly the @var{language} for the following input files
827 (rather than letting the compiler choose a default based on the file
828 name suffix).  This option applies to all following input files until
829 the next @option{-x} option.  Possible values for @var{language} are:
830 @example
831 c  c-header  cpp-output
832 c++  c++-header  c++-cpp-output
833 objective-c  objective-c-header  objc-cpp-output
834 assembler  assembler-with-cpp
835 ada
836 f77  f77-cpp-input  ratfor
837 java
838 treelang
839 @end example
840
841 @item -x none
842 Turn off any specification of a language, so that subsequent files are
843 handled according to their file name suffixes (as they are if @option{-x}
844 has not been used at all).
845
846 @item -pass-exit-codes
847 @opindex pass-exit-codes
848 Normally the @command{gcc} program will exit with the code of 1 if any
849 phase of the compiler returns a non-success return code.  If you specify
850 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
851 numerically highest error produced by any phase that returned an error
852 indication.
853 @end table
854
855 If you only want some of the stages of compilation, you can use
856 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
857 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
858 @command{gcc} is to stop.  Note that some combinations (for example,
859 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
860
861 @table @gcctabopt
862 @item -c
863 @opindex c
864 Compile or assemble the source files, but do not link.  The linking
865 stage simply is not done.  The ultimate output is in the form of an
866 object file for each source file.
867
868 By default, the object file name for a source file is made by replacing
869 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
870
871 Unrecognized input files, not requiring compilation or assembly, are
872 ignored.
873
874 @item -S
875 @opindex S
876 Stop after the stage of compilation proper; do not assemble.  The output
877 is in the form of an assembler code file for each non-assembler input
878 file specified.
879
880 By default, the assembler file name for a source file is made by
881 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
882
883 Input files that don't require compilation are ignored.
884
885 @item -E
886 @opindex E
887 Stop after the preprocessing stage; do not run the compiler proper.  The
888 output is in the form of preprocessed source code, which is sent to the
889 standard output.
890
891 Input files which don't require preprocessing are ignored.
892
893 @cindex output file option
894 @item -o @var{file}
895 @opindex o
896 Place output in file @var{file}.  This applies regardless to whatever
897 sort of output is being produced, whether it be an executable file,
898 an object file, an assembler file or preprocessed C code.
899
900 If you specify @option{-o} when compiling more than one input file, or
901 you are producing an executable file as output, all the source files
902 on the command line will be compiled at once.
903
904 If @option{-o} is not specified, the default is to put an executable file
905 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
906 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
907 all preprocessed C source on standard output.
908
909 @item -v
910 @opindex v
911 Print (on standard error output) the commands executed to run the stages
912 of compilation.  Also print the version number of the compiler driver
913 program and of the preprocessor and the compiler proper.
914
915 @item -###
916 @opindex ###
917 Like @option{-v} except the commands are not executed and all command
918 arguments are quoted.  This is useful for shell scripts to capture the
919 driver-generated command lines.
920
921 @item -pipe
922 @opindex pipe
923 Use pipes rather than temporary files for communication between the
924 various stages of compilation.  This fails to work on some systems where
925 the assembler is unable to read from a pipe; but the GNU assembler has
926 no trouble.
927
928 @item --help
929 @opindex help
930 Print (on the standard output) a description of the command line options
931 understood by @command{gcc}.  If the @option{-v} option is also specified
932 then @option{--help} will also be passed on to the various processes
933 invoked by @command{gcc}, so that they can display the command line options
934 they accept.  If the @option{-Wextra} option is also specified then command
935 line options which have no documentation associated with them will also
936 be displayed.
937
938 @item --target-help
939 @opindex target-help
940 Print (on the standard output) a description of target specific command
941 line options for each tool.
942
943 @item --version
944 @opindex version
945 Display the version number and copyrights of the invoked GCC.
946 @end table
947
948 @node Invoking G++
949 @section Compiling C++ Programs
950
951 @cindex suffixes for C++ source
952 @cindex C++ source file suffixes
953 C++ source files conventionally use one of the suffixes @samp{.C},
954 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
955 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
956 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
957 files with these names and compiles them as C++ programs even if you
958 call the compiler the same way as for compiling C programs (usually
959 with the name @command{gcc}).
960
961 @findex g++
962 @findex c++
963 However, C++ programs often require class libraries as well as a
964 compiler that understands the C++ language---and under some
965 circumstances, you might want to compile programs or header files from
966 standard input, or otherwise without a suffix that flags them as C++
967 programs.  You might also like to precompile a C header file with a
968 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
969 program that calls GCC with the default language set to C++, and
970 automatically specifies linking against the C++ library.  On many
971 systems, @command{g++} is also installed with the name @command{c++}.
972
973 @cindex invoking @command{g++}
974 When you compile C++ programs, you may specify many of the same
975 command-line options that you use for compiling programs in any
976 language; or command-line options meaningful for C and related
977 languages; or options that are meaningful only for C++ programs.
978 @xref{C Dialect Options,,Options Controlling C Dialect}, for
979 explanations of options for languages related to C@.
980 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
981 explanations of options that are meaningful only for C++ programs.
982
983 @node C Dialect Options
984 @section Options Controlling C Dialect
985 @cindex dialect options
986 @cindex language dialect options
987 @cindex options, dialect
988
989 The following options control the dialect of C (or languages derived
990 from C, such as C++ and Objective-C) that the compiler accepts:
991
992 @table @gcctabopt
993 @cindex ANSI support
994 @cindex ISO support
995 @item -ansi
996 @opindex ansi
997 In C mode, support all ISO C90 programs.  In C++ mode,
998 remove GNU extensions that conflict with ISO C++.
999
1000 This turns off certain features of GCC that are incompatible with ISO
1001 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1002 such as the @code{asm} and @code{typeof} keywords, and
1003 predefined macros such as @code{unix} and @code{vax} that identify the
1004 type of system you are using.  It also enables the undesirable and
1005 rarely used ISO trigraph feature.  For the C compiler,
1006 it disables recognition of C++ style @samp{//} comments as well as
1007 the @code{inline} keyword.
1008
1009 The alternate keywords @code{__asm__}, @code{__extension__},
1010 @code{__inline__} and @code{__typeof__} continue to work despite
1011 @option{-ansi}.  You would not want to use them in an ISO C program, of
1012 course, but it is useful to put them in header files that might be included
1013 in compilations done with @option{-ansi}.  Alternate predefined macros
1014 such as @code{__unix__} and @code{__vax__} are also available, with or
1015 without @option{-ansi}.
1016
1017 The @option{-ansi} option does not cause non-ISO programs to be
1018 rejected gratuitously.  For that, @option{-pedantic} is required in
1019 addition to @option{-ansi}.  @xref{Warning Options}.
1020
1021 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1022 option is used.  Some header files may notice this macro and refrain
1023 from declaring certain functions or defining certain macros that the
1024 ISO standard doesn't call for; this is to avoid interfering with any
1025 programs that might use these names for other things.
1026
1027 Functions which would normally be built in but do not have semantics
1028 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1029 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1030 built-in functions provided by GCC}, for details of the functions
1031 affected.
1032
1033 @item -std=
1034 @opindex std
1035 Determine the language standard.  This option is currently only
1036 supported when compiling C or C++.  A value for this option must be
1037 provided; possible values are
1038
1039 @table @samp
1040 @item c89
1041 @itemx iso9899:1990
1042 ISO C90 (same as @option{-ansi}).
1043
1044 @item iso9899:199409
1045 ISO C90 as modified in amendment 1.
1046
1047 @item c99
1048 @itemx c9x
1049 @itemx iso9899:1999
1050 @itemx iso9899:199x
1051 ISO C99.  Note that this standard is not yet fully supported; see
1052 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1053 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1054
1055 @item gnu89
1056 Default, ISO C90 plus GNU extensions (including some C99 features).
1057
1058 @item gnu99
1059 @itemx gnu9x
1060 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1061 this will become the default.  The name @samp{gnu9x} is deprecated.
1062
1063 @item c++98
1064 The 1998 ISO C++ standard plus amendments.
1065
1066 @item gnu++98
1067 The same as @option{-std=c++98} plus GNU extensions.  This is the
1068 default for C++ code.
1069 @end table
1070
1071 Even when this option is not specified, you can still use some of the
1072 features of newer standards in so far as they do not conflict with
1073 previous C standards.  For example, you may use @code{__restrict__} even
1074 when @option{-std=c99} is not specified.
1075
1076 The @option{-std} options specifying some version of ISO C have the same
1077 effects as @option{-ansi}, except that features that were not in ISO C90
1078 but are in the specified version (for example, @samp{//} comments and
1079 the @code{inline} keyword in ISO C99) are not disabled.
1080
1081 @xref{Standards,,Language Standards Supported by GCC}, for details of
1082 these standard versions.
1083
1084 @item -aux-info @var{filename}
1085 @opindex aux-info
1086 Output to the given filename prototyped declarations for all functions
1087 declared and/or defined in a translation unit, including those in header
1088 files.  This option is silently ignored in any language other than C@.
1089
1090 Besides declarations, the file indicates, in comments, the origin of
1091 each declaration (source file and line), whether the declaration was
1092 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1093 @samp{O} for old, respectively, in the first character after the line
1094 number and the colon), and whether it came from a declaration or a
1095 definition (@samp{C} or @samp{F}, respectively, in the following
1096 character).  In the case of function definitions, a K&R-style list of
1097 arguments followed by their declarations is also provided, inside
1098 comments, after the declaration.
1099
1100 @item -fno-asm
1101 @opindex fno-asm
1102 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1103 keyword, so that code can use these words as identifiers.  You can use
1104 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1105 instead.  @option{-ansi} implies @option{-fno-asm}.
1106
1107 In C++, this switch only affects the @code{typeof} keyword, since
1108 @code{asm} and @code{inline} are standard keywords.  You may want to
1109 use the @option{-fno-gnu-keywords} flag instead, which has the same
1110 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1111 switch only affects the @code{asm} and @code{typeof} keywords, since
1112 @code{inline} is a standard keyword in ISO C99.
1113
1114 @item -fno-builtin
1115 @itemx -fno-builtin-@var{function}
1116 @opindex fno-builtin
1117 @cindex built-in functions
1118 Don't recognize built-in functions that do not begin with
1119 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1120 functions provided by GCC}, for details of the functions affected,
1121 including those which are not built-in functions when @option{-ansi} or
1122 @option{-std} options for strict ISO C conformance are used because they
1123 do not have an ISO standard meaning.
1124
1125 GCC normally generates special code to handle certain built-in functions
1126 more efficiently; for instance, calls to @code{alloca} may become single
1127 instructions that adjust the stack directly, and calls to @code{memcpy}
1128 may become inline copy loops.  The resulting code is often both smaller
1129 and faster, but since the function calls no longer appear as such, you
1130 cannot set a breakpoint on those calls, nor can you change the behavior
1131 of the functions by linking with a different library.
1132
1133 With the @option{-fno-builtin-@var{function}} option
1134 only the built-in function @var{function} is
1135 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1136 function is named this is not built-in in this version of GCC, this
1137 option is ignored.  There is no corresponding
1138 @option{-fbuiltin-@var{function}} option; if you wish to enable
1139 built-in functions selectively when using @option{-fno-builtin} or
1140 @option{-ffreestanding}, you may define macros such as:
1141
1142 @smallexample
1143 #define abs(n)          __builtin_abs ((n))
1144 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1145 @end smallexample
1146
1147 @item -fhosted
1148 @opindex fhosted
1149 @cindex hosted environment
1150
1151 Assert that compilation takes place in a hosted environment.  This implies
1152 @option{-fbuiltin}.  A hosted environment is one in which the
1153 entire standard library is available, and in which @code{main} has a return
1154 type of @code{int}.  Examples are nearly everything except a kernel.
1155 This is equivalent to @option{-fno-freestanding}.
1156
1157 @item -ffreestanding
1158 @opindex ffreestanding
1159 @cindex hosted environment
1160
1161 Assert that compilation takes place in a freestanding environment.  This
1162 implies @option{-fno-builtin}.  A freestanding environment
1163 is one in which the standard library may not exist, and program startup may
1164 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1165 This is equivalent to @option{-fno-hosted}.
1166
1167 @xref{Standards,,Language Standards Supported by GCC}, for details of
1168 freestanding and hosted environments.
1169
1170 @item -fms-extensions
1171 @opindex fms-extensions
1172 Accept some non-standard constructs used in Microsoft header files.
1173
1174 @item -trigraphs
1175 @opindex trigraphs
1176 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1177 options for strict ISO C conformance) implies @option{-trigraphs}.
1178
1179 @item -no-integrated-cpp
1180 @opindex no-integrated-cpp
1181 Performs a compilation in two passes: preprocessing and compiling.  This
1182 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1183 @option{-B} option. The user supplied compilation step can then add in
1184 an additional preprocessing step after normal preprocessing but before
1185 compiling. The default is to use the integrated cpp (internal cpp)
1186
1187 The semantics of this option will change if "cc1", "cc1plus", and
1188 "cc1obj" are merged.
1189
1190 @cindex traditional C language
1191 @cindex C language, traditional
1192 @item -traditional
1193 @itemx -traditional-cpp
1194 @opindex traditional-cpp
1195 @opindex traditional
1196 Formerly, these options caused GCC to attempt to emulate a pre-standard
1197 C compiler.  They are now only supported with the @option{-E} switch.
1198 The preprocessor continues to support a pre-standard mode.  See the GNU
1199 CPP manual for details.
1200
1201 @item -fcond-mismatch
1202 @opindex fcond-mismatch
1203 Allow conditional expressions with mismatched types in the second and
1204 third arguments.  The value of such an expression is void.  This option
1205 is not supported for C++.
1206
1207 @item -funsigned-char
1208 @opindex funsigned-char
1209 Let the type @code{char} be unsigned, like @code{unsigned char}.
1210
1211 Each kind of machine has a default for what @code{char} should
1212 be.  It is either like @code{unsigned char} by default or like
1213 @code{signed char} by default.
1214
1215 Ideally, a portable program should always use @code{signed char} or
1216 @code{unsigned char} when it depends on the signedness of an object.
1217 But many programs have been written to use plain @code{char} and
1218 expect it to be signed, or expect it to be unsigned, depending on the
1219 machines they were written for.  This option, and its inverse, let you
1220 make such a program work with the opposite default.
1221
1222 The type @code{char} is always a distinct type from each of
1223 @code{signed char} or @code{unsigned char}, even though its behavior
1224 is always just like one of those two.
1225
1226 @item -fsigned-char
1227 @opindex fsigned-char
1228 Let the type @code{char} be signed, like @code{signed char}.
1229
1230 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1231 the negative form of @option{-funsigned-char}.  Likewise, the option
1232 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1233
1234 @item -fsigned-bitfields
1235 @itemx -funsigned-bitfields
1236 @itemx -fno-signed-bitfields
1237 @itemx -fno-unsigned-bitfields
1238 @opindex fsigned-bitfields
1239 @opindex funsigned-bitfields
1240 @opindex fno-signed-bitfields
1241 @opindex fno-unsigned-bitfields
1242 These options control whether a bit-field is signed or unsigned, when the
1243 declaration does not use either @code{signed} or @code{unsigned}.  By
1244 default, such a bit-field is signed, because this is consistent: the
1245 basic integer types such as @code{int} are signed types.
1246
1247 @item -fwritable-strings
1248 @opindex fwritable-strings
1249 Store string constants in the writable data segment and don't uniquize
1250 them.  This is for compatibility with old programs which assume they can
1251 write into string constants.
1252
1253 Writing into string constants is a very bad idea; ``constants'' should
1254 be constant.
1255
1256 This option is deprecated.
1257 @end table
1258
1259 @node C++ Dialect Options
1260 @section Options Controlling C++ Dialect
1261
1262 @cindex compiler options, C++
1263 @cindex C++ options, command line
1264 @cindex options, C++
1265 This section describes the command-line options that are only meaningful
1266 for C++ programs; but you can also use most of the GNU compiler options
1267 regardless of what language your program is in.  For example, you
1268 might compile a file @code{firstClass.C} like this:
1269
1270 @example
1271 g++ -g -frepo -O -c firstClass.C
1272 @end example
1273
1274 @noindent
1275 In this example, only @option{-frepo} is an option meant
1276 only for C++ programs; you can use the other options with any
1277 language supported by GCC@.
1278
1279 Here is a list of options that are @emph{only} for compiling C++ programs:
1280
1281 @table @gcctabopt
1282
1283 @item -fabi-version=@var{n}
1284 @opindex fabi-version
1285 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1286 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1287 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1288 the version that conforms most closely to the C++ ABI specification.
1289 Therefore, the ABI obtained using version 0 will change as ABI bugs
1290 are fixed.
1291
1292 The default is version 1.
1293
1294 @item -fno-access-control
1295 @opindex fno-access-control
1296 Turn off all access checking.  This switch is mainly useful for working
1297 around bugs in the access control code.
1298
1299 @item -fcheck-new
1300 @opindex fcheck-new
1301 Check that the pointer returned by @code{operator new} is non-null
1302 before attempting to modify the storage allocated.  This check is
1303 normally unnecessary because the C++ standard specifies that
1304 @code{operator new} will only return @code{0} if it is declared
1305 @samp{throw()}, in which case the compiler will always check the
1306 return value even without this option.  In all other cases, when
1307 @code{operator new} has a non-empty exception specification, memory
1308 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1309 @samp{new (nothrow)}.
1310
1311 @item -fconserve-space
1312 @opindex fconserve-space
1313 Put uninitialized or runtime-initialized global variables into the
1314 common segment, as C does.  This saves space in the executable at the
1315 cost of not diagnosing duplicate definitions.  If you compile with this
1316 flag and your program mysteriously crashes after @code{main()} has
1317 completed, you may have an object that is being destroyed twice because
1318 two definitions were merged.
1319
1320 This option is no longer useful on most targets, now that support has
1321 been added for putting variables into BSS without making them common.
1322
1323 @item -fno-const-strings
1324 @opindex fno-const-strings
1325 Give string constants type @code{char *} instead of type @code{const
1326 char *}.  By default, G++ uses type @code{const char *} as required by
1327 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1328 actually modify the value of a string constant, unless you also use
1329 @option{-fwritable-strings}.
1330
1331 This option might be removed in a future release of G++.  For maximum
1332 portability, you should structure your code so that it works with
1333 string constants that have type @code{const char *}.
1334
1335 @item -fno-elide-constructors
1336 @opindex fno-elide-constructors
1337 The C++ standard allows an implementation to omit creating a temporary
1338 which is only used to initialize another object of the same type.
1339 Specifying this option disables that optimization, and forces G++ to
1340 call the copy constructor in all cases.
1341
1342 @item -fno-enforce-eh-specs
1343 @opindex fno-enforce-eh-specs
1344 Don't check for violation of exception specifications at runtime.  This
1345 option violates the C++ standard, but may be useful for reducing code
1346 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1347 will still optimize based on the exception specifications.
1348
1349 @item -ffor-scope
1350 @itemx -fno-for-scope
1351 @opindex ffor-scope
1352 @opindex fno-for-scope
1353 If @option{-ffor-scope} is specified, the scope of variables declared in
1354 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1355 as specified by the C++ standard.
1356 If @option{-fno-for-scope} is specified, the scope of variables declared in
1357 a @i{for-init-statement} extends to the end of the enclosing scope,
1358 as was the case in old versions of G++, and other (traditional)
1359 implementations of C++.
1360
1361 The default if neither flag is given to follow the standard,
1362 but to allow and give a warning for old-style code that would
1363 otherwise be invalid, or have different behavior.
1364
1365 @item -fno-gnu-keywords
1366 @opindex fno-gnu-keywords
1367 Do not recognize @code{typeof} as a keyword, so that code can use this
1368 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1369 @option{-ansi} implies @option{-fno-gnu-keywords}.
1370
1371 @item -fno-implicit-templates
1372 @opindex fno-implicit-templates
1373 Never emit code for non-inline templates which are instantiated
1374 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1375 @xref{Template Instantiation}, for more information.
1376
1377 @item -fno-implicit-inline-templates
1378 @opindex fno-implicit-inline-templates
1379 Don't emit code for implicit instantiations of inline templates, either.
1380 The default is to handle inlines differently so that compiles with and
1381 without optimization will need the same set of explicit instantiations.
1382
1383 @item -fno-implement-inlines
1384 @opindex fno-implement-inlines
1385 To save space, do not emit out-of-line copies of inline functions
1386 controlled by @samp{#pragma implementation}.  This will cause linker
1387 errors if these functions are not inlined everywhere they are called.
1388
1389 @item -fms-extensions
1390 @opindex fms-extensions
1391 Disable pedantic warnings about constructs used in MFC, such as implicit
1392 int and getting a pointer to member function via non-standard syntax.
1393
1394 @item -fno-nonansi-builtins
1395 @opindex fno-nonansi-builtins
1396 Disable built-in declarations of functions that are not mandated by
1397 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1398 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1399
1400 @item -fno-operator-names
1401 @opindex fno-operator-names
1402 Do not treat the operator name keywords @code{and}, @code{bitand},
1403 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1404 synonyms as keywords.
1405
1406 @item -fno-optional-diags
1407 @opindex fno-optional-diags
1408 Disable diagnostics that the standard says a compiler does not need to
1409 issue.  Currently, the only such diagnostic issued by G++ is the one for
1410 a name having multiple meanings within a class.
1411
1412 @item -fpermissive
1413 @opindex fpermissive
1414 Downgrade some diagnostics about nonconformant code from errors to
1415 warnings.  Thus, using @option{-fpermissive} will allow some
1416 nonconforming code to compile.
1417
1418 @item -frepo
1419 @opindex frepo
1420 Enable automatic template instantiation at link time.  This option also
1421 implies @option{-fno-implicit-templates}.  @xref{Template
1422 Instantiation}, for more information.
1423
1424 @item -fno-rtti
1425 @opindex fno-rtti
1426 Disable generation of information about every class with virtual
1427 functions for use by the C++ runtime type identification features
1428 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1429 of the language, you can save some space by using this flag.  Note that
1430 exception handling uses the same information, but it will generate it as
1431 needed.
1432
1433 @item -fstats
1434 @opindex fstats
1435 Emit statistics about front-end processing at the end of the compilation.
1436 This information is generally only useful to the G++ development team.
1437
1438 @item -ftemplate-depth-@var{n}
1439 @opindex ftemplate-depth
1440 Set the maximum instantiation depth for template classes to @var{n}.
1441 A limit on the template instantiation depth is needed to detect
1442 endless recursions during template class instantiation.  ANSI/ISO C++
1443 conforming programs must not rely on a maximum depth greater than 17.
1444
1445 @item -fuse-cxa-atexit
1446 @opindex fuse-cxa-atexit
1447 Register destructors for objects with static storage duration with the
1448 @code{__cxa_atexit} function rather than the @code{atexit} function.
1449 This option is required for fully standards-compliant handling of static
1450 destructors, but will only work if your C library supports
1451 @code{__cxa_atexit}.
1452
1453 @item -fno-weak
1454 @opindex fno-weak
1455 Do not use weak symbol support, even if it is provided by the linker.
1456 By default, G++ will use weak symbols if they are available.  This
1457 option exists only for testing, and should not be used by end-users;
1458 it will result in inferior code and has no benefits.  This option may
1459 be removed in a future release of G++.
1460
1461 @item -nostdinc++
1462 @opindex nostdinc++
1463 Do not search for header files in the standard directories specific to
1464 C++, but do still search the other standard directories.  (This option
1465 is used when building the C++ library.)
1466 @end table
1467
1468 In addition, these optimization, warning, and code generation options
1469 have meanings only for C++ programs:
1470
1471 @table @gcctabopt
1472 @item -fno-default-inline
1473 @opindex fno-default-inline
1474 Do not assume @samp{inline} for functions defined inside a class scope.
1475 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1476 functions will have linkage like inline functions; they just won't be
1477 inlined by default.
1478
1479 @item -Wabi @r{(C++ only)}
1480 @opindex Wabi
1481 Warn when G++ generates code that is probably not compatible with the
1482 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1483 all such cases, there are probably some cases that are not warned about, 
1484 even though G++ is generating incompatible code.  There may also be
1485 cases where warnings are emitted even though the code that is generated
1486 will be compatible.
1487
1488 You should rewrite your code to avoid these warnings if you are
1489 concerned about the fact that code generated by G++ may not be binary
1490 compatible with code generated by other compilers.
1491
1492 The known incompatibilities at this point include:
1493
1494 @itemize @bullet
1495
1496 @item
1497 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1498 pack data into the same byte as a base class.  For example:
1499
1500 @smallexample
1501 struct A @{ virtual void f(); int f1 : 1; @};
1502 struct B : public A @{ int f2 : 1; @};
1503 @end smallexample
1504
1505 @noindent
1506 In this case, G++ will place @code{B::f2} into the same byte
1507 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1508 by explicitly padding @code{A} so that its size is a multiple of the
1509 byte size on your platform; that will cause G++ and other compilers to
1510 layout @code{B} identically.
1511
1512 @item
1513 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1514 tail padding when laying out virtual bases.  For example:
1515
1516 @smallexample
1517 struct A @{ virtual void f(); char c1; @};
1518 struct B @{ B(); char c2; @};
1519 struct C : public A, public virtual B @{@};
1520 @end smallexample
1521
1522 @noindent
1523 In this case, G++ will not place @code{B} into the tail-padding for
1524 @code{A}; other compilers will.  You can avoid this problem by
1525 explicitly padding @code{A} so that its size is a multiple of its
1526 alignment (ignoring virtual base classes); that will cause G++ and other
1527 compilers to layout @code{C} identically.
1528
1529 @item
1530 Incorrect handling of bit-fields with declared widths greater than that
1531 of their underlying types, when the bit-fields appear in a union.  For
1532 example:
1533
1534 @smallexample
1535 union U @{ int i : 4096; @};
1536 @end smallexample
1537
1538 @noindent
1539 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1540 union too small by the number of bits in an @code{int}.
1541
1542 @item
1543 Empty classes can be placed at incorrect offsets.  For example:
1544  
1545 @smallexample
1546 struct A @{@};
1547
1548 struct B @{
1549   A a;
1550   virtual void f ();
1551 @};
1552
1553 struct C : public B, public A @{@};
1554 @end smallexample
1555
1556 @noindent
1557 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1558 it should be placed at offset zero.  G++ mistakenly believes that the
1559 @code{A} data member of @code{B} is already at offset zero.
1560
1561 @item
1562 Names of template functions whose types involve @code{typename} or
1563 template template parameters can be mangled incorrectly.
1564
1565 @smallexample
1566 template <typename Q>
1567 void f(typename Q::X) @{@}
1568
1569 template <template <typename> class Q>
1570 void f(typename Q<int>::X) @{@}
1571 @end smallexample
1572
1573 @noindent
1574 Instantiations of these templates may be mangled incorrectly.
1575
1576 @end itemize
1577
1578 @item -Wctor-dtor-privacy @r{(C++ only)}
1579 @opindex Wctor-dtor-privacy
1580 Warn when a class seems unusable because all the constructors or
1581 destructors in that class are private, and it has neither friends nor
1582 public static member functions.
1583
1584 @item -Wnon-virtual-dtor @r{(C++ only)}
1585 @opindex Wnon-virtual-dtor
1586 Warn when a class appears to be polymorphic, thereby requiring a virtual
1587 destructor, yet it declares a non-virtual one.
1588 This warning is enabled by @option{-Wall}.
1589
1590 @item -Wreorder @r{(C++ only)}
1591 @opindex Wreorder
1592 @cindex reordering, warning
1593 @cindex warning for reordering of member initializers
1594 Warn when the order of member initializers given in the code does not
1595 match the order in which they must be executed.  For instance:
1596
1597 @smallexample
1598 struct A @{
1599   int i;
1600   int j;
1601   A(): j (0), i (1) @{ @}
1602 @};
1603 @end smallexample
1604
1605 The compiler will rearrange the member initializers for @samp{i}
1606 and @samp{j} to match the declaration order of the members, emitting
1607 a warning to that effect.  This warning is enabled by @option{-Wall}.
1608 @end table
1609
1610 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1611
1612 @table @gcctabopt
1613 @item -Weffc++ @r{(C++ only)}
1614 @opindex Weffc++
1615 Warn about violations of the following style guidelines from Scott Meyers'
1616 @cite{Effective C++} book:
1617
1618 @itemize @bullet
1619 @item
1620 Item 11:  Define a copy constructor and an assignment operator for classes
1621 with dynamically allocated memory.
1622
1623 @item
1624 Item 12:  Prefer initialization to assignment in constructors.
1625
1626 @item
1627 Item 14:  Make destructors virtual in base classes.
1628
1629 @item
1630 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1631
1632 @item
1633 Item 23:  Don't try to return a reference when you must return an object.
1634
1635 @end itemize
1636
1637 Also warn about violations of the following style guidelines from 
1638 Scott Meyers' @cite{More Effective C++} book:
1639
1640 @itemize @bullet
1641 @item
1642 Item 6:  Distinguish between prefix and postfix forms of increment and
1643 decrement operators.
1644
1645 @item
1646 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1647
1648 @end itemize
1649
1650 When selecting this option, be aware that the standard library
1651 headers do not obey all of these guidelines; use @samp{grep -v}
1652 to filter out those warnings.
1653
1654 @item -Wno-deprecated @r{(C++ only)}
1655 @opindex Wno-deprecated
1656 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1657
1658 @item -Wno-non-template-friend @r{(C++ only)}
1659 @opindex Wno-non-template-friend
1660 Disable warnings when non-templatized friend functions are declared
1661 within a template.  Since the advent of explicit template specification
1662 support in G++, if the name of the friend is an unqualified-id (i.e.,
1663 @samp{friend foo(int)}), the C++ language specification demands that the
1664 friend declare or define an ordinary, nontemplate function.  (Section
1665 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1666 could be interpreted as a particular specialization of a templatized
1667 function.  Because this non-conforming behavior is no longer the default
1668 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1669 check existing code for potential trouble spots and is on by default.
1670 This new compiler behavior can be turned off with
1671 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1672 but disables the helpful warning.
1673
1674 @item -Wold-style-cast @r{(C++ only)}
1675 @opindex Wold-style-cast
1676 Warn if an old-style (C-style) cast to a non-void type is used within
1677 a C++ program.  The new-style casts (@samp{static_cast},
1678 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1679 unintended effects and much easier to search for.
1680
1681 @item -Woverloaded-virtual @r{(C++ only)}
1682 @opindex Woverloaded-virtual
1683 @cindex overloaded virtual fn, warning
1684 @cindex warning for overloaded virtual fn
1685 Warn when a function declaration hides virtual functions from a
1686 base class.  For example, in:
1687
1688 @smallexample
1689 struct A @{
1690   virtual void f();
1691 @};
1692
1693 struct B: public A @{
1694   void f(int);
1695 @};
1696 @end smallexample
1697
1698 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1699 like:
1700
1701 @smallexample
1702 B* b;
1703 b->f();
1704 @end smallexample
1705
1706 will fail to compile.
1707
1708 @item -Wno-pmf-conversions @r{(C++ only)}
1709 @opindex Wno-pmf-conversions
1710 Disable the diagnostic for converting a bound pointer to member function
1711 to a plain pointer.
1712
1713 @item -Wsign-promo @r{(C++ only)}
1714 @opindex Wsign-promo
1715 Warn when overload resolution chooses a promotion from unsigned or
1716 enumeral type to a signed type, over a conversion to an unsigned type of
1717 the same size.  Previous versions of G++ would try to preserve
1718 unsignedness, but the standard mandates the current behavior.
1719
1720 @item -Wsynth @r{(C++ only)}
1721 @opindex Wsynth
1722 @cindex warning for synthesized methods
1723 @cindex synthesized methods, warning
1724 Warn when G++'s synthesis behavior does not match that of cfront.  For
1725 instance:
1726
1727 @smallexample
1728 struct A @{
1729   operator int ();
1730   A& operator = (int);
1731 @};
1732
1733 main ()
1734 @{
1735   A a,b;
1736   a = b;
1737 @}
1738 @end smallexample
1739
1740 In this example, G++ will synthesize a default @samp{A& operator =
1741 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1742 @end table
1743
1744 @node Objective-C Dialect Options
1745 @section Options Controlling Objective-C Dialect
1746
1747 @cindex compiler options, Objective-C
1748 @cindex Objective-C options, command line
1749 @cindex options, Objective-C
1750 (NOTE: This manual does not describe the Objective-C language itself.  See
1751 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1752
1753 This section describes the command-line options that are only meaningful
1754 for Objective-C programs, but you can also use most of the GNU compiler
1755 options regardless of what language your program is in.  For example,
1756 you might compile a file @code{some_class.m} like this:
1757
1758 @example
1759 gcc -g -fgnu-runtime -O -c some_class.m
1760 @end example
1761
1762 @noindent
1763 In this example, @option{-fgnu-runtime} is an option meant only for
1764 Objective-C programs; you can use the other options with any language
1765 supported by GCC@.
1766
1767 Here is a list of options that are @emph{only} for compiling Objective-C
1768 programs:
1769
1770 @table @gcctabopt
1771 @item -fconstant-string-class=@var{class-name}
1772 @opindex fconstant-string-class
1773 Use @var{class-name} as the name of the class to instantiate for each
1774 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1775 class name is @code{NXConstantString} if the GNU runtime is being used, and
1776 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1777 @option{-fconstant-cfstrings} option, if also present, will override the
1778 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1779 to be laid out as constant CoreFoundation strings.
1780
1781 @item -fgnu-runtime
1782 @opindex fgnu-runtime
1783 Generate object code compatible with the standard GNU Objective-C
1784 runtime.  This is the default for most types of systems.
1785
1786 @item -fnext-runtime
1787 @opindex fnext-runtime
1788 Generate output compatible with the NeXT runtime.  This is the default
1789 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1790 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1791 used.
1792
1793 @item -fno-nil-receivers
1794 @opindex -fno-nil-receivers
1795 Assume that all Objective-C message dispatches (e.g., 
1796 @code{[receiver message:arg]}) in this translation unit ensure that the receiver 
1797 is not @code{nil}.  This allows for more efficient entry points in the runtime to be 
1798 used.  Currently, this option is only available in conjunction with 
1799 the NeXT runtime on Mac OS X 10.3 and later.
1800
1801 @item -fobjc-exceptions
1802 @opindex -fobjc-exceptions
1803 Enable syntactic support for structured exception handling in Objective-C, 
1804 similar to what is offered by C++ and Java.  Currently, this option is only 
1805 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. 
1806
1807 @smallexample
1808   @@try @{
1809     @dots{}
1810        @@throw expr;
1811     @dots{}
1812   @}
1813   @@catch (AnObjCClass *exc) @{
1814     @dots{}
1815       @@throw expr;
1816     @dots{}
1817       @@throw;
1818     @dots{}
1819   @}
1820   @@catch (AnotherClass *exc) @{
1821     @dots{}
1822   @}
1823   @@catch (id allOthers) @{
1824     @dots{}
1825   @}
1826   @@finally @{
1827     @dots{}
1828       @@throw expr;
1829     @dots{}
1830   @}
1831 @end smallexample
1832
1833 The @code{@@throw} statement may appear anywhere in an Objective-C or
1834 Objective-C++ program; when used inside of a @code{@@catch} block, the 
1835 @code{@@throw} may appear without an argument (as shown above), in which case 
1836 the object caught by the @code{@@catch} will be rethrown.
1837
1838 Note that only (pointers to) Objective-C objects may be thrown and
1839 caught using this scheme.  When an object is thrown, it will be caught
1840 by the nearest @code{@@catch} clause capable of handling objects of that type,
1841 analogously to how @code{catch} blocks work in C++ and Java.  A 
1842 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch 
1843 any and all Objective-C exceptions not caught by previous @code{@@catch}
1844 clauses (if any).
1845
1846 The @code{@@finally} clause, if present, will be executed upon exit from the
1847 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1848 regardless of whether any exceptions are thrown, caught or rethrown
1849 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1850 of the @code{finally} clause in Java.
1851
1852 There are several caveats to using the new exception mechanism:
1853
1854 @itemize @bullet
1855 @item
1856 Although currently designed to be binary compatible with @code{NS_HANDLER}-style 
1857 idioms provided by the @code{NSException} class, the new
1858 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1859 systems, due to additional functionality needed in the (NeXT) Objective-C
1860 runtime.
1861
1862 @item
1863 As mentioned above, the new exceptions do not support handling
1864 types other than Objective-C objects.   Furthermore, when used from 
1865 Objective-C++, the Objective-C exception model does not interoperate with C++
1866 exceptions at this time.  This means you cannot @code{@@throw} an exception
1867 from Objective-C and @code{catch} it in C++, or vice versa 
1868 (i.e., @code{throw @dots{} @@catch}).
1869 @end itemize
1870  
1871 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1872 blocks for thread-safe execution:
1873
1874 @smallexample
1875   @@synchronized (ObjCClass *guard) @{
1876     @dots{}
1877   @}
1878 @end smallexample
1879
1880 Upon entering the @code{@@synchronized} block, a thread of execution shall
1881 first check whether a lock has been placed on the corresponding @code{guard}
1882 object by another thread.  If it has, the current thread shall wait until
1883 the other thread relinquishes its lock.  Once @code{guard} becomes available, 
1884 the current thread will place its own lock on it, execute the code contained in
1885 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1886 making @code{guard} available to other threads).
1887
1888 Unlike Java, Objective-C does not allow for entire methods to be marked
1889 @code{@@synchronized}.  Note that throwing exceptions out of
1890 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1891 to be unlocked properly.
1892
1893 @item -freplace-objc-classes
1894 @opindex -freplace-objc-classes
1895 Emit a special marker instructing @command{ld(1)} not to statically link in
1896 the resulting object file, and allow @command{dyld(1)} to load it in at
1897 run time instead.  This is used in conjunction with the Fix-and-Continue
1898 debugging mode, where the object file in question may be recompiled and 
1899 dynamically reloaded in the course of program execution, without the need
1900 to restart the program itself.  Currently, Fix-and-Continue functionality
1901 is only available in conjunction with the NeXT runtime on Mac OS X 10.3 
1902 and later.
1903
1904 @item -fzero-link
1905 @opindex -fzero-link
1906 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1907 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1908 compile time) with static class references that get initialized at load time,
1909 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1910 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1911 to be retained.  This is useful in Zero-Link debugging mode, since it allows 
1912 for individual class implementations to be modified during program execution.
1913
1914 @item -gen-decls
1915 @opindex gen-decls
1916 Dump interface declarations for all classes seen in the source file to a
1917 file named @file{@var{sourcename}.decl}.
1918
1919 @item -Wno-protocol
1920 @opindex Wno-protocol
1921 If a class is declared to implement a protocol, a warning is issued for
1922 every method in the protocol that is not implemented by the class.  The
1923 default behavior is to issue a warning for every method not explicitly
1924 implemented in the class, even if a method implementation is inherited
1925 from the superclass.  If you use the @code{-Wno-protocol} option, then
1926 methods inherited from the superclass are considered to be implemented,
1927 and no warning is issued for them.
1928
1929 @item -Wselector
1930 @opindex Wselector
1931 Warn if multiple methods of different types for the same selector are
1932 found during compilation.  The check is performed on the list of methods
1933 in the final stage of compilation.  Additionally, a check is performed
1934 for each selector appearing in a @code{@@selector(@dots{})}
1935 expression, and a corresponding method for that selector has been found
1936 during compilation.  Because these checks scan the method table only at
1937 the end of compilation, these warnings are not produced if the final
1938 stage of compilation is not reached, for example because an error is
1939 found during compilation, or because the @code{-fsyntax-only} option is
1940 being used.
1941
1942 @item -Wundeclared-selector
1943 @opindex Wundeclared-selector
1944 Warn if a @code{@@selector(@dots{})} expression referring to an
1945 undeclared selector is found.  A selector is considered undeclared if no
1946 method with that name has been declared before the 
1947 @code{@@selector(@dots{})} expression, either explicitly in an
1948 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1949 an @code{@@implementation} section.  This option always performs its
1950 checks as soon as a @code{@@selector(@dots{})} expression is found,
1951 while @code{-Wselector} only performs its checks in the final stage of
1952 compilation.  This also enforces the coding style convention
1953 that methods and selectors must be declared before being used.
1954
1955 @item -print-objc-runtime-info
1956 @opindex -print-objc-runtime-info
1957 Generate C header describing the largest structure that is passed by
1958 value, if any.
1959
1960 @end table
1961
1962 @node Language Independent Options
1963 @section Options to Control Diagnostic Messages Formatting
1964 @cindex options to control diagnostics formatting
1965 @cindex diagnostic messages
1966 @cindex message formatting
1967
1968 Traditionally, diagnostic messages have been formatted irrespective of
1969 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1970 below can be used to control the diagnostic messages formatting
1971 algorithm, e.g.@: how many characters per line, how often source location
1972 information should be reported.  Right now, only the C++ front end can
1973 honor these options.  However it is expected, in the near future, that
1974 the remaining front ends would be able to digest them correctly.
1975
1976 @table @gcctabopt
1977 @item -fmessage-length=@var{n}
1978 @opindex fmessage-length
1979 Try to format error messages so that they fit on lines of about @var{n}
1980 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1981 the front ends supported by GCC@.  If @var{n} is zero, then no
1982 line-wrapping will be done; each error message will appear on a single
1983 line.
1984
1985 @opindex fdiagnostics-show-location
1986 @item -fdiagnostics-show-location=once
1987 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1988 reporter to emit @emph{once} source location information; that is, in
1989 case the message is too long to fit on a single physical line and has to
1990 be wrapped, the source location won't be emitted (as prefix) again,
1991 over and over, in subsequent continuation lines.  This is the default
1992 behavior.
1993
1994 @item -fdiagnostics-show-location=every-line
1995 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1996 messages reporter to emit the same source location information (as
1997 prefix) for physical lines that result from the process of breaking
1998 a message which is too long to fit on a single line.
1999
2000 @end table
2001
2002 @node Warning Options
2003 @section Options to Request or Suppress Warnings
2004 @cindex options to control warnings
2005 @cindex warning messages
2006 @cindex messages, warning
2007 @cindex suppressing warnings
2008
2009 Warnings are diagnostic messages that report constructions which
2010 are not inherently erroneous but which are risky or suggest there
2011 may have been an error.
2012
2013 You can request many specific warnings with options beginning @samp{-W},
2014 for example @option{-Wimplicit} to request warnings on implicit
2015 declarations.  Each of these specific warning options also has a
2016 negative form beginning @samp{-Wno-} to turn off warnings;
2017 for example, @option{-Wno-implicit}.  This manual lists only one of the
2018 two forms, whichever is not the default.
2019
2020 The following options control the amount and kinds of warnings produced
2021 by GCC; for further, language-specific options also refer to
2022 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2023
2024 @table @gcctabopt
2025 @cindex syntax checking
2026 @item -fsyntax-only
2027 @opindex fsyntax-only
2028 Check the code for syntax errors, but don't do anything beyond that.
2029
2030 @item -pedantic
2031 @opindex pedantic
2032 Issue all the warnings demanded by strict ISO C and ISO C++;
2033 reject all programs that use forbidden extensions, and some other
2034 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2035 version of the ISO C standard specified by any @option{-std} option used.
2036
2037 Valid ISO C and ISO C++ programs should compile properly with or without
2038 this option (though a rare few will require @option{-ansi} or a
2039 @option{-std} option specifying the required version of ISO C)@.  However,
2040 without this option, certain GNU extensions and traditional C and C++
2041 features are supported as well.  With this option, they are rejected.
2042
2043 @option{-pedantic} does not cause warning messages for use of the
2044 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2045 warnings are also disabled in the expression that follows
2046 @code{__extension__}.  However, only system header files should use
2047 these escape routes; application programs should avoid them.
2048 @xref{Alternate Keywords}.
2049
2050 Some users try to use @option{-pedantic} to check programs for strict ISO
2051 C conformance.  They soon find that it does not do quite what they want:
2052 it finds some non-ISO practices, but not all---only those for which
2053 ISO C @emph{requires} a diagnostic, and some others for which
2054 diagnostics have been added.
2055
2056 A feature to report any failure to conform to ISO C might be useful in
2057 some instances, but would require considerable additional work and would
2058 be quite different from @option{-pedantic}.  We don't have plans to
2059 support such a feature in the near future.
2060
2061 Where the standard specified with @option{-std} represents a GNU
2062 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2063 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2064 extended dialect is based.  Warnings from @option{-pedantic} are given
2065 where they are required by the base standard.  (It would not make sense
2066 for such warnings to be given only for features not in the specified GNU
2067 C dialect, since by definition the GNU dialects of C include all
2068 features the compiler supports with the given option, and there would be
2069 nothing to warn about.)
2070
2071 @item -pedantic-errors
2072 @opindex pedantic-errors
2073 Like @option{-pedantic}, except that errors are produced rather than
2074 warnings.
2075
2076 @item -w
2077 @opindex w
2078 Inhibit all warning messages.
2079
2080 @item -Wno-import
2081 @opindex Wno-import
2082 Inhibit warning messages about the use of @samp{#import}.
2083
2084 @item -Wchar-subscripts
2085 @opindex Wchar-subscripts
2086 Warn if an array subscript has type @code{char}.  This is a common cause
2087 of error, as programmers often forget that this type is signed on some
2088 machines.
2089
2090 @item -Wcomment
2091 @opindex Wcomment
2092 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2093 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2094
2095 @item -Wformat
2096 @opindex Wformat
2097 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2098 the arguments supplied have types appropriate to the format string
2099 specified, and that the conversions specified in the format string make
2100 sense.  This includes standard functions, and others specified by format
2101 attributes (@pxref{Function Attributes}), in the @code{printf},
2102 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2103 not in the C standard) families.
2104
2105 The formats are checked against the format features supported by GNU
2106 libc version 2.2.  These include all ISO C90 and C99 features, as well
2107 as features from the Single Unix Specification and some BSD and GNU
2108 extensions.  Other library implementations may not support all these
2109 features; GCC does not support warning about features that go beyond a
2110 particular library's limitations.  However, if @option{-pedantic} is used
2111 with @option{-Wformat}, warnings will be given about format features not
2112 in the selected standard version (but not for @code{strfmon} formats,
2113 since those are not in any version of the C standard).  @xref{C Dialect
2114 Options,,Options Controlling C Dialect}.
2115
2116 Since @option{-Wformat} also checks for null format arguments for
2117 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2118
2119 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2120 aspects of format checking, the options @option{-Wformat-y2k},
2121 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2122 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2123 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2124
2125 @item -Wformat-y2k
2126 @opindex Wformat-y2k
2127 If @option{-Wformat} is specified, also warn about @code{strftime}
2128 formats which may yield only a two-digit year.
2129
2130 @item -Wno-format-extra-args
2131 @opindex Wno-format-extra-args
2132 If @option{-Wformat} is specified, do not warn about excess arguments to a
2133 @code{printf} or @code{scanf} format function.  The C standard specifies
2134 that such arguments are ignored.
2135
2136 Where the unused arguments lie between used arguments that are
2137 specified with @samp{$} operand number specifications, normally
2138 warnings are still given, since the implementation could not know what
2139 type to pass to @code{va_arg} to skip the unused arguments.  However,
2140 in the case of @code{scanf} formats, this option will suppress the
2141 warning if the unused arguments are all pointers, since the Single
2142 Unix Specification says that such unused arguments are allowed.
2143
2144 @item -Wno-format-zero-length
2145 @opindex Wno-format-zero-length
2146 If @option{-Wformat} is specified, do not warn about zero-length formats.
2147 The C standard specifies that zero-length formats are allowed.
2148
2149 @item -Wformat-nonliteral
2150 @opindex Wformat-nonliteral
2151 If @option{-Wformat} is specified, also warn if the format string is not a
2152 string literal and so cannot be checked, unless the format function
2153 takes its format arguments as a @code{va_list}.
2154
2155 @item -Wformat-security
2156 @opindex Wformat-security
2157 If @option{-Wformat} is specified, also warn about uses of format
2158 functions that represent possible security problems.  At present, this
2159 warns about calls to @code{printf} and @code{scanf} functions where the
2160 format string is not a string literal and there are no format arguments,
2161 as in @code{printf (foo);}.  This may be a security hole if the format
2162 string came from untrusted input and contains @samp{%n}.  (This is
2163 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2164 in future warnings may be added to @option{-Wformat-security} that are not
2165 included in @option{-Wformat-nonliteral}.)
2166
2167 @item -Wformat=2
2168 @opindex Wformat=2
2169 Enable @option{-Wformat} plus format checks not included in
2170 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2171 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2172
2173 @item -Wnonnull
2174 @opindex Wnonnull
2175 Warn about passing a null pointer for arguments marked as
2176 requiring a non-null value by the @code{nonnull} function attribute.
2177
2178 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2179 can be disabled with the @option{-Wno-nonnull} option.
2180
2181 @item -Winit-self @r{(C, C++, and Objective-C only)} 
2182 @opindex Winit-self
2183 Warn about uninitialized variables which are initialized with themselves.
2184 Note this option can only be used with the @option{-Wuninitialized} option,
2185 which in turn only works with @option{-O1} and above.
2186
2187 For example, GCC will warn about @code{i} being uninitialized in the
2188 following snippet only when @option{-Winit-self} has been specified:
2189 @smallexample
2190 @group
2191 int f()
2192 @{
2193   int i = i;
2194   return i;
2195 @}
2196 @end group
2197 @end smallexample
2198
2199 @item -Wimplicit-int
2200 @opindex Wimplicit-int
2201 Warn when a declaration does not specify a type.
2202
2203 @item -Wimplicit-function-declaration
2204 @itemx -Werror-implicit-function-declaration
2205 @opindex Wimplicit-function-declaration
2206 @opindex Werror-implicit-function-declaration
2207 Give a warning (or error) whenever a function is used before being
2208 declared.
2209
2210 @item -Wimplicit
2211 @opindex Wimplicit
2212 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2213
2214 @item -Wmain
2215 @opindex Wmain
2216 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2217 function with external linkage, returning int, taking either zero
2218 arguments, two, or three arguments of appropriate types.
2219
2220 @item -Wmissing-braces
2221 @opindex Wmissing-braces
2222 Warn if an aggregate or union initializer is not fully bracketed.  In
2223 the following example, the initializer for @samp{a} is not fully
2224 bracketed, but that for @samp{b} is fully bracketed.
2225
2226 @smallexample
2227 int a[2][2] = @{ 0, 1, 2, 3 @};
2228 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2229 @end smallexample
2230
2231 @item -Wparentheses
2232 @opindex Wparentheses
2233 Warn if parentheses are omitted in certain contexts, such
2234 as when there is an assignment in a context where a truth value
2235 is expected, or when operators are nested whose precedence people
2236 often get confused about.
2237
2238 Also warn about constructions where there may be confusion to which
2239 @code{if} statement an @code{else} branch belongs.  Here is an example of
2240 such a case:
2241
2242 @smallexample
2243 @group
2244 @{
2245   if (a)
2246     if (b)
2247       foo ();
2248   else
2249     bar ();
2250 @}
2251 @end group
2252 @end smallexample
2253
2254 In C, every @code{else} branch belongs to the innermost possible @code{if}
2255 statement, which in this example is @code{if (b)}.  This is often not
2256 what the programmer expected, as illustrated in the above example by
2257 indentation the programmer chose.  When there is the potential for this
2258 confusion, GCC will issue a warning when this flag is specified.
2259 To eliminate the warning, add explicit braces around the innermost
2260 @code{if} statement so there is no way the @code{else} could belong to
2261 the enclosing @code{if}.  The resulting code would look like this:
2262
2263 @smallexample
2264 @group
2265 @{
2266   if (a)
2267     @{
2268       if (b)
2269         foo ();
2270       else
2271         bar ();
2272     @}
2273 @}
2274 @end group
2275 @end smallexample
2276
2277 @item -Wsequence-point
2278 @opindex Wsequence-point
2279 Warn about code that may have undefined semantics because of violations
2280 of sequence point rules in the C standard.
2281
2282 The C standard defines the order in which expressions in a C program are
2283 evaluated in terms of @dfn{sequence points}, which represent a partial
2284 ordering between the execution of parts of the program: those executed
2285 before the sequence point, and those executed after it.  These occur
2286 after the evaluation of a full expression (one which is not part of a
2287 larger expression), after the evaluation of the first operand of a
2288 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2289 function is called (but after the evaluation of its arguments and the
2290 expression denoting the called function), and in certain other places.
2291 Other than as expressed by the sequence point rules, the order of
2292 evaluation of subexpressions of an expression is not specified.  All
2293 these rules describe only a partial order rather than a total order,
2294 since, for example, if two functions are called within one expression
2295 with no sequence point between them, the order in which the functions
2296 are called is not specified.  However, the standards committee have
2297 ruled that function calls do not overlap.
2298
2299 It is not specified when between sequence points modifications to the
2300 values of objects take effect.  Programs whose behavior depends on this
2301 have undefined behavior; the C standard specifies that ``Between the
2302 previous and next sequence point an object shall have its stored value
2303 modified at most once by the evaluation of an expression.  Furthermore,
2304 the prior value shall be read only to determine the value to be
2305 stored.''.  If a program breaks these rules, the results on any
2306 particular implementation are entirely unpredictable.
2307
2308 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2309 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2310 diagnosed by this option, and it may give an occasional false positive
2311 result, but in general it has been found fairly effective at detecting
2312 this sort of problem in programs.
2313
2314 The present implementation of this option only works for C programs.  A
2315 future implementation may also work for C++ programs.
2316
2317 The C standard is worded confusingly, therefore there is some debate
2318 over the precise meaning of the sequence point rules in subtle cases.
2319 Links to discussions of the problem, including proposed formal
2320 definitions, may be found on our readings page, at
2321 @w{@uref{http://gcc.gnu.org/readings.html}}.
2322
2323 @item -Wreturn-type
2324 @opindex Wreturn-type
2325 Warn whenever a function is defined with a return-type that defaults to
2326 @code{int}.  Also warn about any @code{return} statement with no
2327 return-value in a function whose return-type is not @code{void}.
2328
2329 For C++, a function without return type always produces a diagnostic
2330 message, even when @option{-Wno-return-type} is specified.  The only
2331 exceptions are @samp{main} and functions defined in system headers.
2332
2333 @item -Wswitch
2334 @opindex Wswitch
2335 Warn whenever a @code{switch} statement has an index of enumeral type
2336 and lacks a @code{case} for one or more of the named codes of that
2337 enumeration.  (The presence of a @code{default} label prevents this
2338 warning.)  @code{case} labels outside the enumeration range also
2339 provoke warnings when this option is used.
2340
2341 @item -Wswitch-default
2342 @opindex Wswitch-switch
2343 Warn whenever a @code{switch} statement does not have a @code{default}
2344 case.
2345
2346 @item -Wswitch-enum
2347 @opindex Wswitch-enum
2348 Warn whenever a @code{switch} statement has an index of enumeral type
2349 and lacks a @code{case} for one or more of the named codes of that
2350 enumeration.  @code{case} labels outside the enumeration range also
2351 provoke warnings when this option is used.
2352
2353 @item -Wtrigraphs
2354 @opindex Wtrigraphs
2355 Warn if any trigraphs are encountered that might change the meaning of
2356 the program (trigraphs within comments are not warned about).
2357
2358 @item -Wunused-function
2359 @opindex Wunused-function
2360 Warn whenever a static function is declared but not defined or a
2361 non\-inline static function is unused.
2362
2363 @item -Wunused-label
2364 @opindex Wunused-label
2365 Warn whenever a label is declared but not used.
2366
2367 To suppress this warning use the @samp{unused} attribute
2368 (@pxref{Variable Attributes}).
2369
2370 @item -Wunused-parameter
2371 @opindex Wunused-parameter
2372 Warn whenever a function parameter is unused aside from its declaration.
2373
2374 To suppress this warning use the @samp{unused} attribute
2375 (@pxref{Variable Attributes}).
2376
2377 @item -Wunused-variable
2378 @opindex Wunused-variable
2379 Warn whenever a local variable or non-constant static variable is unused
2380 aside from its declaration
2381
2382 To suppress this warning use the @samp{unused} attribute
2383 (@pxref{Variable Attributes}).
2384
2385 @item -Wunused-value
2386 @opindex Wunused-value
2387 Warn whenever a statement computes a result that is explicitly not used.
2388
2389 To suppress this warning cast the expression to @samp{void}.
2390
2391 @item -Wunused
2392 @opindex Wunused
2393 All the above @option{-Wunused} options combined.
2394
2395 In order to get a warning about an unused function parameter, you must
2396 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2397 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2398
2399 @item -Wuninitialized
2400 @opindex Wuninitialized
2401 Warn if an automatic variable is used without first being initialized or
2402 if a variable may be clobbered by a @code{setjmp} call.
2403
2404 These warnings are possible only in optimizing compilation,
2405 because they require data flow information that is computed only
2406 when optimizing.  If you don't specify @option{-O}, you simply won't
2407 get these warnings.
2408
2409 If you want to warn about code which uses the uninitialized value of the
2410 variable in its own initializer, use the @option{-Winit-self} option.
2411
2412 These warnings occur only for variables that are candidates for
2413 register allocation.  Therefore, they do not occur for a variable that
2414 is declared @code{volatile}, or whose address is taken, or whose size
2415 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2416 structures, unions or arrays, even when they are in registers.
2417
2418 Note that there may be no warning about a variable that is used only
2419 to compute a value that itself is never used, because such
2420 computations may be deleted by data flow analysis before the warnings
2421 are printed.
2422
2423 These warnings are made optional because GCC is not smart
2424 enough to see all the reasons why the code might be correct
2425 despite appearing to have an error.  Here is one example of how
2426 this can happen:
2427
2428 @smallexample
2429 @group
2430 @{
2431   int x;
2432   switch (y)
2433     @{
2434     case 1: x = 1;
2435       break;
2436     case 2: x = 4;
2437       break;
2438     case 3: x = 5;
2439     @}
2440   foo (x);
2441 @}
2442 @end group
2443 @end smallexample
2444
2445 @noindent
2446 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2447 always initialized, but GCC doesn't know this.  Here is
2448 another common case:
2449
2450 @smallexample
2451 @{
2452   int save_y;
2453   if (change_y) save_y = y, y = new_y;
2454   @dots{}
2455   if (change_y) y = save_y;
2456 @}
2457 @end smallexample
2458
2459 @noindent
2460 This has no bug because @code{save_y} is used only if it is set.
2461
2462 @cindex @code{longjmp} warnings
2463 This option also warns when a non-volatile automatic variable might be
2464 changed by a call to @code{longjmp}.  These warnings as well are possible
2465 only in optimizing compilation.
2466
2467 The compiler sees only the calls to @code{setjmp}.  It cannot know
2468 where @code{longjmp} will be called; in fact, a signal handler could
2469 call it at any point in the code.  As a result, you may get a warning
2470 even when there is in fact no problem because @code{longjmp} cannot
2471 in fact be called at the place which would cause a problem.
2472
2473 Some spurious warnings can be avoided if you declare all the functions
2474 you use that never return as @code{noreturn}.  @xref{Function
2475 Attributes}.
2476
2477 @item -Wunknown-pragmas
2478 @opindex Wunknown-pragmas
2479 @cindex warning for unknown pragmas
2480 @cindex unknown pragmas, warning
2481 @cindex pragmas, warning of unknown
2482 Warn when a #pragma directive is encountered which is not understood by
2483 GCC@.  If this command line option is used, warnings will even be issued
2484 for unknown pragmas in system header files.  This is not the case if
2485 the warnings were only enabled by the @option{-Wall} command line option.
2486
2487 @item -Wstrict-aliasing
2488 @opindex Wstrict-aliasing
2489 This option is only active when @option{-fstrict-aliasing} is active.
2490 It warns about code which might break the strict aliasing rules that the
2491 compiler is using for optimization. The warning does not catch all
2492 cases, but does attempt to catch the more common pitfalls. It is
2493 included in @option{-Wall}.
2494
2495 @item -Wall
2496 @opindex Wall
2497 All of the above @samp{-W} options combined.  This enables all the
2498 warnings about constructions that some users consider questionable, and
2499 that are easy to avoid (or modify to prevent the warning), even in
2500 conjunction with macros.  This also enables some language-specific
2501 warnings described in @ref{C++ Dialect Options} and
2502 @ref{Objective-C Dialect Options}.
2503 @end table
2504
2505 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2506 Some of them warn about constructions that users generally do not
2507 consider questionable, but which occasionally you might wish to check
2508 for; others warn about constructions that are necessary or hard to avoid
2509 in some cases, and there is no simple way to modify the code to suppress
2510 the warning.
2511
2512 @table @gcctabopt
2513 @item -Wextra
2514 @opindex W
2515 @opindex Wextra
2516 (This option used to be called @option{-W}.  The older name is still
2517 supported, but the newer name is more descriptive.)  Print extra warning
2518 messages for these events:
2519
2520 @itemize @bullet
2521 @item
2522 A function can return either with or without a value.  (Falling
2523 off the end of the function body is considered returning without
2524 a value.)  For example, this function would evoke such a
2525 warning:
2526
2527 @smallexample
2528 @group
2529 foo (a)
2530 @{
2531   if (a > 0)
2532     return a;
2533 @}
2534 @end group
2535 @end smallexample
2536
2537 @item
2538 An expression-statement or the left-hand side of a comma expression
2539 contains no side effects.
2540 To suppress the warning, cast the unused expression to void.
2541 For example, an expression such as @samp{x[i,j]} will cause a warning,
2542 but @samp{x[(void)i,j]} will not.
2543
2544 @item
2545 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2546
2547 @item
2548 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2549 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2550 that of ordinary mathematical notation.
2551
2552 @item
2553 Storage-class specifiers like @code{static} are not the first things in
2554 a declaration.  According to the C Standard, this usage is obsolescent.
2555
2556 @item
2557 The return type of a function has a type qualifier such as @code{const}.
2558 Such a type qualifier has no effect, since the value returned by a
2559 function is not an lvalue.  (But don't warn about the GNU extension of
2560 @code{volatile void} return types.  That extension will be warned about
2561 if @option{-pedantic} is specified.)
2562
2563 @item
2564 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2565 arguments.
2566
2567 @item
2568 A comparison between signed and unsigned values could produce an
2569 incorrect result when the signed value is converted to unsigned.
2570 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2571
2572 @item
2573 An aggregate has an initializer which does not initialize all members.
2574 For example, the following code would cause such a warning, because
2575 @code{x.h} would be implicitly initialized to zero:
2576
2577 @smallexample
2578 struct s @{ int f, g, h; @};
2579 struct s x = @{ 3, 4 @};
2580 @end smallexample
2581
2582 @item
2583 A function parameter is declared without a type specifier in K&R-style
2584 functions:
2585
2586 @smallexample
2587 void foo(bar) @{ @}
2588 @end smallexample
2589
2590 @item
2591 An empty body occurs in an @samp{if} or @samp{else} statement.
2592
2593 @item
2594 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2595 @samp{>}, or @samp{>=}.
2596
2597 @item
2598 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2599
2600 @item
2601 Any of several floating-point events that often indicate errors, such as
2602 overflow, underflow, loss of precision, etc.
2603
2604 @item @r{(C++ only)}
2605 An enumerator and a non-enumerator both appear in a conditional expression.
2606
2607 @item @r{(C++ only)}
2608 A non-static reference or non-static @samp{const} member appears in a
2609 class without constructors.
2610
2611 @item @r{(C++ only)}
2612 Ambiguous virtual bases.
2613
2614 @item @r{(C++ only)}
2615 Subscripting an array which has been declared @samp{register}.
2616
2617 @item @r{(C++ only)}
2618 Taking the address of a variable which has been declared @samp{register}.
2619
2620 @item @r{(C++ only)}
2621 A base class is not initialized in a derived class' copy constructor.
2622 @end itemize
2623
2624 @item -Wno-div-by-zero
2625 @opindex Wno-div-by-zero
2626 @opindex Wdiv-by-zero
2627 Do not warn about compile-time integer division by zero.  Floating point
2628 division by zero is not warned about, as it can be a legitimate way of
2629 obtaining infinities and NaNs.
2630
2631 @item -Wsystem-headers
2632 @opindex Wsystem-headers
2633 @cindex warnings from system headers
2634 @cindex system headers, warnings from
2635 Print warning messages for constructs found in system header files.
2636 Warnings from system headers are normally suppressed, on the assumption
2637 that they usually do not indicate real problems and would only make the
2638 compiler output harder to read.  Using this command line option tells
2639 GCC to emit warnings from system headers as if they occurred in user
2640 code.  However, note that using @option{-Wall} in conjunction with this
2641 option will @emph{not} warn about unknown pragmas in system
2642 headers---for that, @option{-Wunknown-pragmas} must also be used.
2643
2644 @item -Wfloat-equal
2645 @opindex Wfloat-equal
2646 Warn if floating point values are used in equality comparisons.
2647
2648 The idea behind this is that sometimes it is convenient (for the
2649 programmer) to consider floating-point values as approximations to
2650 infinitely precise real numbers.  If you are doing this, then you need
2651 to compute (by analyzing the code, or in some other way) the maximum or
2652 likely maximum error that the computation introduces, and allow for it
2653 when performing comparisons (and when producing output, but that's a
2654 different problem).  In particular, instead of testing for equality, you
2655 would check to see whether the two values have ranges that overlap; and
2656 this is done with the relational operators, so equality comparisons are
2657 probably mistaken.
2658
2659 @item -Wtraditional @r{(C only)}
2660 @opindex Wtraditional
2661 Warn about certain constructs that behave differently in traditional and
2662 ISO C@.  Also warn about ISO C constructs that have no traditional C
2663 equivalent, and/or problematic constructs which should be avoided.
2664
2665 @itemize @bullet
2666 @item
2667 Macro parameters that appear within string literals in the macro body.
2668 In traditional C macro replacement takes place within string literals,
2669 but does not in ISO C@.
2670
2671 @item
2672 In traditional C, some preprocessor directives did not exist.
2673 Traditional preprocessors would only consider a line to be a directive
2674 if the @samp{#} appeared in column 1 on the line.  Therefore
2675 @option{-Wtraditional} warns about directives that traditional C
2676 understands but would ignore because the @samp{#} does not appear as the
2677 first character on the line.  It also suggests you hide directives like
2678 @samp{#pragma} not understood by traditional C by indenting them.  Some
2679 traditional implementations would not recognize @samp{#elif}, so it
2680 suggests avoiding it altogether.
2681
2682 @item
2683 A function-like macro that appears without arguments.
2684
2685 @item
2686 The unary plus operator.
2687
2688 @item
2689 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2690 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2691 constants.)  Note, these suffixes appear in macros defined in the system
2692 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2693 Use of these macros in user code might normally lead to spurious
2694 warnings, however gcc's integrated preprocessor has enough context to
2695 avoid warning in these cases.
2696
2697 @item
2698 A function declared external in one block and then used after the end of
2699 the block.
2700
2701 @item
2702 A @code{switch} statement has an operand of type @code{long}.
2703
2704 @item
2705 A non-@code{static} function declaration follows a @code{static} one.
2706 This construct is not accepted by some traditional C compilers.
2707
2708 @item
2709 The ISO type of an integer constant has a different width or
2710 signedness from its traditional type.  This warning is only issued if
2711 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2712 typically represent bit patterns, are not warned about.
2713
2714 @item
2715 Usage of ISO string concatenation is detected.
2716
2717 @item
2718 Initialization of automatic aggregates.
2719
2720 @item
2721 Identifier conflicts with labels.  Traditional C lacks a separate
2722 namespace for labels.
2723
2724 @item
2725 Initialization of unions.  If the initializer is zero, the warning is
2726 omitted.  This is done under the assumption that the zero initializer in
2727 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2728 initializer warnings and relies on default initialization to zero in the
2729 traditional C case.
2730
2731 @item
2732 Conversions by prototypes between fixed/floating point values and vice
2733 versa.  The absence of these prototypes when compiling with traditional
2734 C would cause serious problems.  This is a subset of the possible
2735 conversion warnings, for the full set use @option{-Wconversion}.
2736
2737 @item
2738 Use of ISO C style function definitions.  This warning intentionally is
2739 @emph{not} issued for prototype declarations or variadic functions
2740 because these ISO C features will appear in your code when using
2741 libiberty's traditional C compatibility macros, @code{PARAMS} and
2742 @code{VPARAMS}.  This warning is also bypassed for nested functions
2743 because that feature is already a gcc extension and thus not relevant to
2744 traditional C compatibility.
2745 @end itemize
2746
2747 @item -Wdeclaration-after-statement @r{(C only)}
2748 @opindex Wdeclaration-after-statement
2749 Warn when a declaration is found after a statement in a block.  This
2750 construct, known from C++, was introduced with ISO C99 and is by default
2751 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2752 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2753
2754 @item -Wundef
2755 @opindex Wundef
2756 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2757
2758 @item -Wendif-labels
2759 @opindex Wendif-labels
2760 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2761
2762 @item -Wshadow
2763 @opindex Wshadow
2764 Warn whenever a local variable shadows another local variable, parameter or
2765 global variable or whenever a built-in function is shadowed.
2766
2767 @item -Wlarger-than-@var{len}
2768 @opindex Wlarger-than
2769 Warn whenever an object of larger than @var{len} bytes is defined.
2770
2771 @item -Wpointer-arith
2772 @opindex Wpointer-arith
2773 Warn about anything that depends on the ``size of'' a function type or
2774 of @code{void}.  GNU C assigns these types a size of 1, for
2775 convenience in calculations with @code{void *} pointers and pointers
2776 to functions.
2777
2778 @item -Wbad-function-cast @r{(C only)}
2779 @opindex Wbad-function-cast
2780 Warn whenever a function call is cast to a non-matching type.
2781 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2782
2783 @item -Wcast-qual
2784 @opindex Wcast-qual
2785 Warn whenever a pointer is cast so as to remove a type qualifier from
2786 the target type.  For example, warn if a @code{const char *} is cast
2787 to an ordinary @code{char *}.
2788
2789 @item -Wcast-align
2790 @opindex Wcast-align
2791 Warn whenever a pointer is cast such that the required alignment of the
2792 target is increased.  For example, warn if a @code{char *} is cast to
2793 an @code{int *} on machines where integers can only be accessed at
2794 two- or four-byte boundaries.
2795
2796 @item -Wwrite-strings
2797 @opindex Wwrite-strings
2798 When compiling C, give string constants the type @code{const
2799 char[@var{length}]} so that
2800 copying the address of one into a non-@code{const} @code{char *}
2801 pointer will get a warning; when compiling C++, warn about the
2802 deprecated conversion from string constants to @code{char *}.
2803 These warnings will help you find at
2804 compile time code that can try to write into a string constant, but
2805 only if you have been very careful about using @code{const} in
2806 declarations and prototypes.  Otherwise, it will just be a nuisance;
2807 this is why we did not make @option{-Wall} request these warnings.
2808
2809 @item -Wconversion
2810 @opindex Wconversion
2811 Warn if a prototype causes a type conversion that is different from what
2812 would happen to the same argument in the absence of a prototype.  This
2813 includes conversions of fixed point to floating and vice versa, and
2814 conversions changing the width or signedness of a fixed point argument
2815 except when the same as the default promotion.
2816
2817 Also, warn if a negative integer constant expression is implicitly
2818 converted to an unsigned type.  For example, warn about the assignment
2819 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2820 casts like @code{(unsigned) -1}.
2821
2822 @item -Wsign-compare
2823 @opindex Wsign-compare
2824 @cindex warning for comparison of signed and unsigned values
2825 @cindex comparison of signed and unsigned values, warning
2826 @cindex signed and unsigned values, comparison warning
2827 Warn when a comparison between signed and unsigned values could produce
2828 an incorrect result when the signed value is converted to unsigned.
2829 This warning is also enabled by @option{-Wextra}; to get the other warnings
2830 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2831
2832 @item -Waggregate-return
2833 @opindex Waggregate-return
2834 Warn if any functions that return structures or unions are defined or
2835 called.  (In languages where you can return an array, this also elicits
2836 a warning.)
2837
2838 @item -Wstrict-prototypes @r{(C only)}
2839 @opindex Wstrict-prototypes
2840 Warn if a function is declared or defined without specifying the
2841 argument types.  (An old-style function definition is permitted without
2842 a warning if preceded by a declaration which specifies the argument
2843 types.)
2844
2845 @item -Wold-style-definition @r{(C only)}
2846 @opindex Wold-style-definition
2847 Warn if an old-style function definition is used.  A warning is given
2848 even if there is a previous prototype.
2849
2850 @item -Wmissing-prototypes @r{(C only)}
2851 @opindex Wmissing-prototypes
2852 Warn if a global function is defined without a previous prototype
2853 declaration.  This warning is issued even if the definition itself
2854 provides a prototype.  The aim is to detect global functions that fail
2855 to be declared in header files.
2856
2857 @item -Wmissing-declarations @r{(C only)}
2858 @opindex Wmissing-declarations
2859 Warn if a global function is defined without a previous declaration.
2860 Do so even if the definition itself provides a prototype.
2861 Use this option to detect global functions that are not declared in
2862 header files.
2863
2864 @item -Wmissing-noreturn
2865 @opindex Wmissing-noreturn
2866 Warn about functions which might be candidates for attribute @code{noreturn}.
2867 Note these are only possible candidates, not absolute ones.  Care should
2868 be taken to manually verify functions actually do not ever return before
2869 adding the @code{noreturn} attribute, otherwise subtle code generation
2870 bugs could be introduced.  You will not get a warning for @code{main} in
2871 hosted C environments.
2872
2873 @item -Wmissing-format-attribute
2874 @opindex Wmissing-format-attribute
2875 @opindex Wformat
2876 If @option{-Wformat} is enabled, also warn about functions which might be
2877 candidates for @code{format} attributes.  Note these are only possible
2878 candidates, not absolute ones.  GCC will guess that @code{format}
2879 attributes might be appropriate for any function that calls a function
2880 like @code{vprintf} or @code{vscanf}, but this might not always be the
2881 case, and some functions for which @code{format} attributes are
2882 appropriate may not be detected.  This option has no effect unless
2883 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2884
2885 @item -Wno-multichar
2886 @opindex Wno-multichar
2887 @opindex Wmultichar
2888 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2889 Usually they indicate a typo in the user's code, as they have
2890 implementation-defined values, and should not be used in portable code.
2891
2892 @item -Wno-deprecated-declarations
2893 @opindex Wno-deprecated-declarations
2894 Do not warn about uses of functions, variables, and types marked as
2895 deprecated by using the @code{deprecated} attribute.
2896 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2897 @pxref{Type Attributes}.)
2898
2899 @item -Wpacked
2900 @opindex Wpacked
2901 Warn if a structure is given the packed attribute, but the packed
2902 attribute has no effect on the layout or size of the structure.
2903 Such structures may be mis-aligned for little benefit.  For
2904 instance, in this code, the variable @code{f.x} in @code{struct bar}
2905 will be misaligned even though @code{struct bar} does not itself
2906 have the packed attribute:
2907
2908 @smallexample
2909 @group
2910 struct foo @{
2911   int x;
2912   char a, b, c, d;
2913 @} __attribute__((packed));
2914 struct bar @{
2915   char z;
2916   struct foo f;
2917 @};
2918 @end group
2919 @end smallexample
2920
2921 @item -Wpadded
2922 @opindex Wpadded
2923 Warn if padding is included in a structure, either to align an element
2924 of the structure or to align the whole structure.  Sometimes when this
2925 happens it is possible to rearrange the fields of the structure to
2926 reduce the padding and so make the structure smaller.
2927
2928 @item -Wredundant-decls
2929 @opindex Wredundant-decls
2930 Warn if anything is declared more than once in the same scope, even in
2931 cases where multiple declaration is valid and changes nothing.
2932
2933 @item -Wnested-externs @r{(C only)}
2934 @opindex Wnested-externs
2935 Warn if an @code{extern} declaration is encountered within a function.
2936
2937 @item -Wunreachable-code
2938 @opindex Wunreachable-code
2939 Warn if the compiler detects that code will never be executed.
2940
2941 This option is intended to warn when the compiler detects that at
2942 least a whole line of source code will never be executed, because
2943 some condition is never satisfied or because it is after a
2944 procedure that never returns.
2945
2946 It is possible for this option to produce a warning even though there
2947 are circumstances under which part of the affected line can be executed,
2948 so care should be taken when removing apparently-unreachable code.
2949
2950 For instance, when a function is inlined, a warning may mean that the
2951 line is unreachable in only one inlined copy of the function.
2952
2953 This option is not made part of @option{-Wall} because in a debugging
2954 version of a program there is often substantial code which checks
2955 correct functioning of the program and is, hopefully, unreachable
2956 because the program does work.  Another common use of unreachable
2957 code is to provide behavior which is selectable at compile-time.
2958
2959 @item -Winline
2960 @opindex Winline
2961 Warn if a function can not be inlined and it was declared as inline.
2962 Even with this option, the compiler will not warn about failures to
2963 inline functions declared in system headers.  
2964
2965 The compiler uses a variety of heuristics to determine whether or not
2966 to inline a function.  For example, the compiler takes into account
2967 the size of the function being inlined and the the amount of inlining
2968 that has already been done in the current function.  Therefore,
2969 seemingly insignificant changes in the source program can cause the
2970 warnings produced by @option{-Winline} to appear or disappear.
2971
2972 @item -Wno-invalid-offsetof @r{(C++ only)}
2973 @opindex Wno-invalid-offsetof
2974 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2975 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2976 to a non-POD type is undefined.  In existing C++ implementations,
2977 however, @samp{offsetof} typically gives meaningful results even when
2978 applied to certain kinds of non-POD types. (Such as a simple
2979 @samp{struct} that fails to be a POD type only by virtue of having a
2980 constructor.)  This flag is for users who are aware that they are
2981 writing nonportable code and who have deliberately chosen to ignore the
2982 warning about it.
2983
2984 The restrictions on @samp{offsetof} may be relaxed in a future version
2985 of the C++ standard.
2986
2987 @item -Winvalid-pch
2988 @opindex Winvalid-pch
2989 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2990 the search path but can't be used.
2991
2992 @item -Wlong-long
2993 @opindex Wlong-long
2994 @opindex Wno-long-long
2995 Warn if @samp{long long} type is used.  This is default.  To inhibit
2996 the warning messages, use @option{-Wno-long-long}.  Flags
2997 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2998 only when @option{-pedantic} flag is used.
2999
3000 @item -Wdisabled-optimization
3001 @opindex Wdisabled-optimization
3002 Warn if a requested optimization pass is disabled.  This warning does
3003 not generally indicate that there is anything wrong with your code; it
3004 merely indicates that GCC's optimizers were unable to handle the code
3005 effectively.  Often, the problem is that your code is too big or too
3006 complex; GCC will refuse to optimize programs when the optimization
3007 itself is likely to take inordinate amounts of time.
3008
3009 @item -Werror
3010 @opindex Werror
3011 Make all warnings into errors.
3012 @end table
3013
3014 @node Debugging Options
3015 @section Options for Debugging Your Program or GCC
3016 @cindex options, debugging
3017 @cindex debugging information options
3018
3019 GCC has various special options that are used for debugging
3020 either your program or GCC:
3021
3022 @table @gcctabopt
3023 @item -g
3024 @opindex g
3025 Produce debugging information in the operating system's native format
3026 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3027 information.
3028
3029 On most systems that use stabs format, @option{-g} enables use of extra
3030 debugging information that only GDB can use; this extra information
3031 makes debugging work better in GDB but will probably make other debuggers
3032 crash or
3033 refuse to read the program.  If you want to control for certain whether
3034 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3035 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3036
3037 Unlike most other C compilers, GCC allows you to use @option{-g} with
3038 @option{-O}.  The shortcuts taken by optimized code may occasionally
3039 produce surprising results: some variables you declared may not exist
3040 at all; flow of control may briefly move where you did not expect it;
3041 some statements may not be executed because they compute constant
3042 results or their values were already at hand; some statements may
3043 execute in different places because they were moved out of loops.
3044
3045 Nevertheless it proves possible to debug optimized output.  This makes
3046 it reasonable to use the optimizer for programs that might have bugs.
3047
3048 The following options are useful when GCC is generated with the
3049 capability for more than one debugging format.
3050
3051 @item -ggdb
3052 @opindex ggdb
3053 Produce debugging information for use by GDB@.  This means to use the
3054 most expressive format available (DWARF 2, stabs, or the native format
3055 if neither of those are supported), including GDB extensions if at all
3056 possible.
3057
3058 @item -gstabs
3059 @opindex gstabs
3060 Produce debugging information in stabs format (if that is supported),
3061 without GDB extensions.  This is the format used by DBX on most BSD
3062 systems.  On MIPS, Alpha and System V Release 4 systems this option
3063 produces stabs debugging output which is not understood by DBX or SDB@.
3064 On System V Release 4 systems this option requires the GNU assembler.
3065
3066 @item -feliminate-unused-debug-symbols
3067 @opindex feliminate-unused-debug-symbols
3068 Produce debugging information in stabs format (if that is supported),
3069 for only symbols that are actually used.
3070
3071 @item -gstabs+
3072 @opindex gstabs+
3073 Produce debugging information in stabs format (if that is supported),
3074 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3075 use of these extensions is likely to make other debuggers crash or
3076 refuse to read the program.
3077
3078 @item -gcoff
3079 @opindex gcoff
3080 Produce debugging information in COFF format (if that is supported).
3081 This is the format used by SDB on most System V systems prior to
3082 System V Release 4.
3083
3084 @item -gxcoff
3085 @opindex gxcoff
3086 Produce debugging information in XCOFF format (if that is supported).
3087 This is the format used by the DBX debugger on IBM RS/6000 systems.
3088
3089 @item -gxcoff+
3090 @opindex gxcoff+
3091 Produce debugging information in XCOFF format (if that is supported),
3092 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3093 use of these extensions is likely to make other debuggers crash or
3094 refuse to read the program, and may cause assemblers other than the GNU
3095 assembler (GAS) to fail with an error.
3096
3097 @item -gdwarf-2
3098 @opindex gdwarf-2
3099 Produce debugging information in DWARF version 2 format (if that is
3100 supported).  This is the format used by DBX on IRIX 6.
3101
3102 @item -gvms
3103 @opindex gvms
3104 Produce debugging information in VMS debug format (if that is
3105 supported).  This is the format used by DEBUG on VMS systems.
3106
3107 @item -g@var{level}
3108 @itemx -ggdb@var{level}
3109 @itemx -gstabs@var{level}
3110 @itemx -gcoff@var{level}
3111 @itemx -gxcoff@var{level}
3112 @itemx -gvms@var{level}
3113 Request debugging information and also use @var{level} to specify how
3114 much information.  The default level is 2.
3115
3116 Level 1 produces minimal information, enough for making backtraces in
3117 parts of the program that you don't plan to debug.  This includes
3118 descriptions of functions and external variables, but no information
3119 about local variables and no line numbers.
3120
3121 Level 3 includes extra information, such as all the macro definitions
3122 present in the program.  Some debuggers support macro expansion when
3123 you use @option{-g3}.
3124
3125 Note that in order to avoid confusion between DWARF1 debug level 2,
3126 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3127 level.  Instead use an additional @option{-g@var{level}} option to
3128 change the debug level for DWARF2.
3129
3130 @item -feliminate-dwarf2-dups
3131 @opindex feliminate-dwarf2-dups
3132 Compress DWARF2 debugging information by eliminating duplicated
3133 information about each symbol.  This option only makes sense when
3134 generating DWARF2 debugging information with @option{-gdwarf-2}.
3135
3136 @cindex @command{prof}
3137 @item -p
3138 @opindex p
3139 Generate extra code to write profile information suitable for the
3140 analysis program @command{prof}.  You must use this option when compiling
3141 the source files you want data about, and you must also use it when
3142 linking.
3143
3144 @cindex @command{gprof}
3145 @item -pg
3146 @opindex pg
3147 Generate extra code to write profile information suitable for the
3148 analysis program @command{gprof}.  You must use this option when compiling
3149 the source files you want data about, and you must also use it when
3150 linking.
3151
3152 @item -Q
3153 @opindex Q
3154 Makes the compiler print out each function name as it is compiled, and
3155 print some statistics about each pass when it finishes.
3156
3157 @item -ftime-report
3158 @opindex ftime-report
3159 Makes the compiler print some statistics about the time consumed by each
3160 pass when it finishes.
3161
3162 @item -fmem-report
3163 @opindex fmem-report
3164 Makes the compiler print some statistics about permanent memory
3165 allocation when it finishes.
3166
3167 @item -fprofile-arcs
3168 @opindex fprofile-arcs
3169 Add code so that program flow @dfn{arcs} are instrumented.  During
3170 execution the program records how many times each branch and call is
3171 executed and how many times it is taken or returns.  When the compiled
3172 program exits it saves this data to a file called
3173 @file{@var{auxname}.gcda} for each source file. The data may be used for
3174 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3175 test coverage analysis (@option{-ftest-coverage}). Each object file's
3176 @var{auxname} is generated from the name of the output file, if
3177 explicitly specified and it is not the final executable, otherwise it is
3178 the basename of the source file. In both cases any suffix is removed
3179 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3180 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3181
3182 @itemize
3183
3184 @item
3185 Compile the source files with @option{-fprofile-arcs} plus optimization
3186 and code generation options. For test coverage analysis, use the
3187 additional @option{-ftest-coverage} option. You do not need to profile
3188 every source file in a program.
3189
3190 @item
3191 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3192 (the latter implies the former).
3193
3194 @item
3195 Run the program on a representative workload to generate the arc profile
3196 information. This may be repeated any number of times. You can run
3197 concurrent instances of your program, and provided that the file system
3198 supports locking, the data files will be correctly updated. Also
3199 @code{fork} calls are detected and correctly handled (double counting
3200 will not happen).
3201
3202 @item
3203 For profile-directed optimizations, compile the source files again with
3204 the same optimization and code generation options plus
3205 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3206 Control Optimization}).
3207
3208 @item
3209 For test coverage analysis, use @command{gcov} to produce human readable
3210 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3211 @command{gcov} documentation for further information.
3212
3213 @end itemize
3214
3215 With @option{-fprofile-arcs}, for each function of your program GCC
3216 creates a program flow graph, then finds a spanning tree for the graph.
3217 Only arcs that are not on the spanning tree have to be instrumented: the
3218 compiler adds code to count the number of times that these arcs are
3219 executed.  When an arc is the only exit or only entrance to a block, the
3220 instrumentation code can be added to the block; otherwise, a new basic
3221 block must be created to hold the instrumentation code.
3222
3223 @need 2000
3224 @item -ftest-coverage
3225 @opindex ftest-coverage
3226 Produce a notes file that the @command{gcov} code-coverage utility
3227 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3228 show program coverage. Each source file's note file is called
3229 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3230 above for a description of @var{auxname} and instructions on how to
3231 generate test coverage data. Coverage data will match the source files
3232 more closely, if you do not optimize.
3233
3234 @item -d@var{letters}
3235 @opindex d
3236 Says to make debugging dumps during compilation at times specified by
3237 @var{letters}.  This is used for debugging the compiler.  The file names
3238 for most of the dumps are made by appending a pass number and a word to
3239 the @var{dumpname}. @var{dumpname} is generated from the name of the
3240 output file, if explicitly specified and it is not an executable,
3241 otherwise it is the basename of the source file. In both cases any
3242 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3243 Here are the possible letters for use in @var{letters}, and their
3244 meanings:
3245
3246 @table @samp
3247 @item A
3248 @opindex dA
3249 Annotate the assembler output with miscellaneous debugging information.
3250 @item b
3251 @opindex db
3252 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3253 @item B
3254 @opindex dB
3255 Dump after block reordering, to @file{@var{file}.30.bbro}.
3256 @item c
3257 @opindex dc
3258 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3259 @item C
3260 @opindex dC
3261 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3262 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3263 @item d
3264 @opindex dd
3265 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3266 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3267 @item D
3268 @opindex dD
3269 Dump all macro definitions, at the end of preprocessing, in addition to
3270 normal output.
3271 @item E
3272 @opindex dE
3273 Dump after the second if conversion, to @file{@var{file}.31.ce3}.
3274 @item f
3275 @opindex df
3276 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3277 Also dump after life analysis, to @file{@var{file}.19.life}.
3278 @item F
3279 @opindex dF
3280 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3281 @item g
3282 @opindex dg
3283 Dump after global register allocation, to @file{@var{file}.25.greg}.
3284 @item G
3285 @opindex dG
3286 Dump after GCSE, to @file{@var{file}.08.gcse}.
3287 Also dump after jump bypassing and control flow optimizations, to
3288 @file{@var{file}.10.bypass}.
3289 @item h
3290 @opindex dh
3291 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3292 @item i
3293 @opindex di
3294 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3295 @item j
3296 @opindex dj
3297 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3298 @item k
3299 @opindex dk
3300 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3301 @item l
3302 @opindex dl
3303 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3304 @item L
3305 @opindex dL
3306 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3307 @file{@var{file}.16.loop2}.
3308 @item M
3309 @opindex dM
3310 Dump after performing the machine dependent reorganization pass, to
3311 @file{@var{file}.35.mach}.
3312 @item n
3313 @opindex dn
3314 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3315 @item N
3316 @opindex dN
3317 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3318 @item o
3319 @opindex do
3320 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3321 @item r
3322 @opindex dr
3323 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3324 @item R
3325 @opindex dR
3326 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3327 @item s
3328 @opindex ds
3329 Dump after CSE (including the jump optimization that sometimes follows
3330 CSE), to @file{@var{file}.06.cse}.
3331 @item S
3332 @opindex dS
3333 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3334 @item t
3335 @opindex dt
3336 Dump after the second CSE pass (including the jump optimization that
3337 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3338 @item T
3339 @opindex dT
3340 Dump after running tracer, to @file{@var{file}.15.tracer}.
3341 @item u
3342 @opindex du
3343 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3344 @item U
3345 @opindex dU
3346 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3347 @item V
3348 @opindex dV
3349 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3350 @item w
3351 @opindex dw
3352 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3353 @item z
3354 @opindex dz
3355 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3356 @item Z
3357 @opindex dZ
3358 Dump after constructing the web, to @file{@var{file}.17.web}.
3359 @item a
3360 @opindex da
3361 Produce all the dumps listed above.
3362 @item H
3363 @opindex dH
3364 Produce a core dump whenever an error occurs.
3365 @item m
3366 @opindex dm
3367 Print statistics on memory usage, at the end of the run, to
3368 standard error.
3369 @item p
3370 @opindex dp
3371 Annotate the assembler output with a comment indicating which
3372 pattern and alternative was used.  The length of each instruction is
3373 also printed.
3374 @item P
3375 @opindex dP
3376 Dump the RTL in the assembler output as a comment before each instruction.
3377 Also turns on @option{-dp} annotation.
3378 @item v
3379 @opindex dv
3380 For each of the other indicated dump files (except for
3381 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3382 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3383 @item x
3384 @opindex dx
3385 Just generate RTL for a function instead of compiling it.  Usually used
3386 with @samp{r}.
3387 @item y
3388 @opindex dy
3389 Dump debugging information during parsing, to standard error.
3390 @end table
3391
3392 @item -fdump-unnumbered
3393 @opindex fdump-unnumbered
3394 When doing debugging dumps (see @option{-d} option above), suppress instruction
3395 numbers and line number note output.  This makes it more feasible to
3396 use diff on debugging dumps for compiler invocations with different
3397 options, in particular with and without @option{-g}.
3398
3399 @item -fdump-translation-unit @r{(C and C++ only)}
3400 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3401 @opindex fdump-translation-unit
3402 Dump a representation of the tree structure for the entire translation
3403 unit to a file.  The file name is made by appending @file{.tu} to the
3404 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3405 controls the details of the dump as described for the
3406 @option{-fdump-tree} options.
3407
3408 @item -fdump-class-hierarchy @r{(C++ only)}
3409 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3410 @opindex fdump-class-hierarchy
3411 Dump a representation of each class's hierarchy and virtual function
3412 table layout to a file.  The file name is made by appending @file{.class}
3413 to the source file name.  If the @samp{-@var{options}} form is used,
3414 @var{options} controls the details of the dump as described for the
3415 @option{-fdump-tree} options.
3416
3417 @item -fdump-tree-@var{switch} @r{(C++ only)}
3418 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3419 @opindex fdump-tree
3420 Control the dumping at various stages of processing the intermediate
3421 language tree to a file.  The file name is generated by appending a switch
3422 specific suffix to the source file name.  If the @samp{-@var{options}}
3423 form is used, @var{options} is a list of @samp{-} separated options that
3424 control the details of the dump. Not all options are applicable to all
3425 dumps, those which are not meaningful will be ignored. The following
3426 options are available
3427
3428 @table @samp
3429 @item address
3430 Print the address of each node.  Usually this is not meaningful as it
3431 changes according to the environment and source file. Its primary use
3432 is for tying up a dump file with a debug environment.
3433 @item slim
3434 Inhibit dumping of members of a scope or body of a function merely
3435 because that scope has been reached. Only dump such items when they
3436 are directly reachable by some other path.
3437 @item all
3438 Turn on all options.
3439 @end table
3440
3441 The following tree dumps are possible:
3442 @table @samp
3443 @item original
3444 Dump before any tree based optimization, to @file{@var{file}.original}.
3445 @item optimized
3446 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3447 @item inlined
3448 Dump after function inlining, to @file{@var{file}.inlined}.
3449 @end table
3450
3451 @item -frandom-seed=@var{string}
3452 @opindex frandom-string
3453 This option provides a seed that GCC uses when it would otherwise use
3454 random numbers.  It is used to generate certain symbol names
3455 that have to be different in every compiled file. It is also used to
3456 place unique stamps in coverage data files and the object files that
3457 produce them. You can use the @option{-frandom-seed} option to produce
3458 reproducibly identical object files.
3459
3460 The @var{string} should be different for every file you compile.
3461
3462 @item -fsched-verbose=@var{n}
3463 @opindex fsched-verbose
3464 On targets that use instruction scheduling, this option controls the
3465 amount of debugging output the scheduler prints.  This information is
3466 written to standard error, unless @option{-dS} or @option{-dR} is
3467 specified, in which case it is output to the usual dump
3468 listing file, @file{.sched} or @file{.sched2} respectively.  However
3469 for @var{n} greater than nine, the output is always printed to standard
3470 error.
3471
3472 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3473 same information as @option{-dRS}.  For @var{n} greater than one, it
3474 also output basic block probabilities, detailed ready list information
3475 and unit/insn info.  For @var{n} greater than two, it includes RTL
3476 at abort point, control-flow and regions info.  And for @var{n} over
3477 four, @option{-fsched-verbose} also includes dependence info.
3478
3479 @item -save-temps
3480 @opindex save-temps
3481 Store the usual ``temporary'' intermediate files permanently; place them
3482 in the current directory and name them based on the source file.  Thus,
3483 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3484 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3485 preprocessed @file{foo.i} output file even though the compiler now
3486 normally uses an integrated preprocessor.
3487
3488 @item -time
3489 @opindex time
3490 Report the CPU time taken by each subprocess in the compilation
3491 sequence.  For C source files, this is the compiler proper and assembler
3492 (plus the linker if linking is done).  The output looks like this:
3493
3494 @smallexample
3495 # cc1 0.12 0.01
3496 # as 0.00 0.01
3497 @end smallexample
3498
3499 The first number on each line is the ``user time,'' that is time spent
3500 executing the program itself.  The second number is ``system time,''
3501 time spent executing operating system routines on behalf of the program.
3502 Both numbers are in seconds.
3503
3504 @item -print-file-name=@var{library}
3505 @opindex print-file-name
3506 Print the full absolute name of the library file @var{library} that
3507 would be used when linking---and don't do anything else.  With this
3508 option, GCC does not compile or link anything; it just prints the
3509 file name.
3510
3511 @item -print-multi-directory
3512 @opindex print-multi-directory
3513 Print the directory name corresponding to the multilib selected by any
3514 other switches present in the command line.  This directory is supposed
3515 to exist in @env{GCC_EXEC_PREFIX}.
3516
3517 @item -print-multi-lib
3518 @opindex print-multi-lib
3519 Print the mapping from multilib directory names to compiler switches
3520 that enable them.  The directory name is separated from the switches by
3521 @samp{;}, and each switch starts with an @samp{@@} instead of the
3522 @samp{-}, without spaces between multiple switches.  This is supposed to
3523 ease shell-processing.
3524
3525 @item -print-prog-name=@var{program}
3526 @opindex print-prog-name
3527 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3528
3529 @item -print-libgcc-file-name
3530 @opindex print-libgcc-file-name
3531 Same as @option{-print-file-name=libgcc.a}.
3532
3533 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3534 but you do want to link with @file{libgcc.a}.  You can do
3535
3536 @example
3537 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3538 @end example
3539
3540 @item -print-search-dirs
3541 @opindex print-search-dirs
3542 Print the name of the configured installation directory and a list of
3543 program and library directories gcc will search---and don't do anything else.
3544
3545 This is useful when gcc prints the error message
3546 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3547 To resolve this you either need to put @file{cpp0} and the other compiler
3548 components where gcc expects to find them, or you can set the environment
3549 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3550 Don't forget the trailing '/'.
3551 @xref{Environment Variables}.
3552
3553 @item -dumpmachine
3554 @opindex dumpmachine
3555 Print the compiler's target machine (for example,
3556 @samp{i686-pc-linux-gnu})---and don't do anything else.
3557
3558 @item -dumpversion
3559 @opindex dumpversion
3560 Print the compiler version (for example, @samp{3.0})---and don't do
3561 anything else.
3562
3563 @item -dumpspecs
3564 @opindex dumpspecs
3565 Print the compiler's built-in specs---and don't do anything else.  (This
3566 is used when GCC itself is being built.)  @xref{Spec Files}.
3567
3568 @item -feliminate-unused-debug-types
3569 @opindex feliminate-unused-debug-types
3570 Normally, when producing DWARF2 output, GCC will emit debugging
3571 information for all types declared in a compilation
3572 unit, regardless of whether or not they are actually used
3573 in that compilation unit.  Sometimes this is useful, such as
3574 if, in the debugger, you want to cast a value to a type that is
3575 not actually used in your program (but is declared).  More often,
3576 however, this results in a significant amount of wasted space.
3577 With this option, GCC will avoid producing debug symbol output
3578 for types that are nowhere used in the source file being compiled.
3579 @end table
3580
3581 @node Optimize Options
3582 @section Options That Control Optimization
3583 @cindex optimize options
3584 @cindex options, optimization
3585
3586 These options control various sorts of optimizations.
3587
3588 Without any optimization option, the compiler's goal is to reduce the
3589 cost of compilation and to make debugging produce the expected
3590 results.  Statements are independent: if you stop the program with a
3591 breakpoint between statements, you can then assign a new value to any
3592 variable or change the program counter to any other statement in the
3593 function and get exactly the results you would expect from the source
3594 code.
3595
3596 Turning on optimization flags makes the compiler attempt to improve
3597 the performance and/or code size at the expense of compilation time
3598 and possibly the ability to debug the program.
3599
3600 The compiler performs optimisation based on the knowledge it has of
3601 the program.  Using the @option{-funit-at-a-time} flag will allow the
3602 compiler to consider information gained from later functions in the
3603 file when compiling a function.  Compiling multiple files at once to a
3604 single output file (and using @option{-funit-at-a-time}) will allow
3605 the compiler to use information gained from all of the files when
3606 compiling each of them.
3607
3608 Not all optimizations are controlled directly by a flag.  Only
3609 optimizations that have a flag are listed.
3610
3611 @table @gcctabopt
3612 @item -O
3613 @itemx -O1
3614 @opindex O
3615 @opindex O1
3616 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3617 more memory for a large function.
3618
3619 With @option{-O}, the compiler tries to reduce code size and execution
3620 time, without performing any optimizations that take a great deal of
3621 compilation time.
3622
3623 @option{-O} turns on the following optimization flags: 
3624 @gccoptlist{-fdefer-pop @gol
3625 -fmerge-constants @gol
3626 -fthread-jumps @gol
3627 -floop-optimize @gol
3628 -fif-conversion @gol
3629 -fif-conversion2 @gol
3630 -fdelayed-branch @gol
3631 -fguess-branch-probability @gol
3632 -fcprop-registers}
3633
3634 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3635 where doing so does not interfere with debugging.
3636
3637 @item -O2
3638 @opindex O2
3639 Optimize even more.  GCC performs nearly all supported optimizations
3640 that do not involve a space-speed tradeoff.  The compiler does not
3641 perform loop unrolling or function inlining when you specify @option{-O2}.
3642 As compared to @option{-O}, this option increases both compilation time
3643 and the performance of the generated code.
3644
3645 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3646 also turns on the following optimization flags:
3647 @gccoptlist{-fforce-mem @gol
3648 -foptimize-sibling-calls @gol
3649 -fstrength-reduce @gol
3650 -fcse-follow-jumps  -fcse-skip-blocks @gol
3651 -frerun-cse-after-loop  -frerun-loop-opt @gol
3652 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3653 -fdelete-null-pointer-checks @gol
3654 -fexpensive-optimizations @gol
3655 -fregmove @gol
3656 -fschedule-insns  -fschedule-insns2 @gol
3657 -fsched-interblock  -fsched-spec @gol
3658 -fcaller-saves @gol
3659 -fpeephole2 @gol
3660 -freorder-blocks  -freorder-functions @gol
3661 -fstrict-aliasing @gol
3662 -funit-at-a-time @gol
3663 -falign-functions  -falign-jumps @gol
3664 -falign-loops  -falign-labels @gol
3665 -fcrossjumping}
3666
3667 Please note the warning under @option{-fgcse} about
3668 invoking @option{-O2} on programs that use computed gotos.
3669
3670 @item -O3
3671 @opindex O3
3672 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3673 @option{-O2} and also turns on the @option{-finline-functions},
3674 @option{-fweb} and @option{-frename-registers} options.
3675
3676 @item -O0
3677 @opindex O0
3678 Do not optimize.  This is the default.
3679
3680 @item -Os
3681 @opindex Os
3682 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3683 do not typically increase code size.  It also performs further
3684 optimizations designed to reduce code size.
3685
3686 @option{-Os} disables the following optimization flags:
3687 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3688 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3689
3690 If you use multiple @option{-O} options, with or without level numbers,
3691 the last such option is the one that is effective.
3692 @end table
3693
3694 Options of the form @option{-f@var{flag}} specify machine-independent
3695 flags.  Most flags have both positive and negative forms; the negative
3696 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3697 below, only one of the forms is listed---the one you typically will
3698 use.  You can figure out the other form by either removing @samp{no-}
3699 or adding it.
3700
3701 The following options control specific optimizations.  They are either
3702 activated by @option{-O} options or are related to ones that are.  You
3703 can use the following flags in the rare cases when ``fine-tuning'' of
3704 optimizations to be performed is desired.
3705
3706 @table @gcctabopt
3707 @item -fno-default-inline
3708 @opindex fno-default-inline
3709 Do not make member functions inline by default merely because they are
3710 defined inside the class scope (C++ only).  Otherwise, when you specify
3711 @w{@option{-O}}, member functions defined inside class scope are compiled
3712 inline by default; i.e., you don't need to add @samp{inline} in front of
3713 the member function name.
3714
3715 @item -fno-defer-pop
3716 @opindex fno-defer-pop
3717 Always pop the arguments to each function call as soon as that function
3718 returns.  For machines which must pop arguments after a function call,
3719 the compiler normally lets arguments accumulate on the stack for several
3720 function calls and pops them all at once.
3721
3722 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3723
3724 @item -fforce-mem
3725 @opindex fforce-mem
3726 Force memory operands to be copied into registers before doing
3727 arithmetic on them.  This produces better code by making all memory
3728 references potential common subexpressions.  When they are not common
3729 subexpressions, instruction combination should eliminate the separate
3730 register-load.
3731
3732 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3733
3734 @item -fforce-addr
3735 @opindex fforce-addr
3736 Force memory address constants to be copied into registers before
3737 doing arithmetic on them.  This may produce better code just as
3738 @option{-fforce-mem} may.
3739
3740 @item -fomit-frame-pointer
3741 @opindex fomit-frame-pointer
3742 Don't keep the frame pointer in a register for functions that
3743 don't need one.  This avoids the instructions to save, set up and
3744 restore frame pointers; it also makes an extra register available
3745 in many functions.  @strong{It also makes debugging impossible on
3746 some machines.}
3747
3748 On some machines, such as the VAX, this flag has no effect, because
3749 the standard calling sequence automatically handles the frame pointer
3750 and nothing is saved by pretending it doesn't exist.  The
3751 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3752 whether a target machine supports this flag.  @xref{Registers,,Register
3753 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3754
3755 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3756
3757 @item -foptimize-sibling-calls
3758 @opindex foptimize-sibling-calls
3759 Optimize sibling and tail recursive calls.
3760
3761 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3762
3763 @item -fno-inline
3764 @opindex fno-inline
3765 Don't pay attention to the @code{inline} keyword.  Normally this option
3766 is used to keep the compiler from expanding any functions inline.
3767 Note that if you are not optimizing, no functions can be expanded inline.
3768
3769 @item -finline-functions
3770 @opindex finline-functions
3771 Integrate all simple functions into their callers.  The compiler
3772 heuristically decides which functions are simple enough to be worth
3773 integrating in this way.
3774
3775 If all calls to a given function are integrated, and the function is
3776 declared @code{static}, then the function is normally not output as
3777 assembler code in its own right.
3778
3779 Enabled at level @option{-O3}.
3780
3781 @item -finline-limit=@var{n}
3782 @opindex finline-limit
3783 By default, gcc limits the size of functions that can be inlined.  This flag
3784 allows the control of this limit for functions that are explicitly marked as
3785 inline (i.e., marked with the inline keyword or defined within the class
3786 definition in c++).  @var{n} is the size of functions that can be inlined in
3787 number of pseudo instructions (not counting parameter handling).  The default
3788 value of @var{n} is 600.
3789 Increasing this value can result in more inlined code at
3790 the cost of compilation time and memory consumption.  Decreasing usually makes
3791 the compilation faster and less code will be inlined (which presumably
3792 means slower programs).  This option is particularly useful for programs that
3793 use inlining heavily such as those based on recursive templates with C++.
3794
3795 Inlining is actually controlled by a number of parameters, which may be
3796 specified individually by using @option{--param @var{name}=@var{value}}.
3797 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3798 as follows:
3799
3800 @table @gcctabopt
3801  @item max-inline-insns-single
3802   is set to @var{n}/2.
3803  @item max-inline-insns-auto
3804   is set to @var{n}/2.
3805  @item min-inline-insns
3806   is set to 130 or @var{n}/4, whichever is smaller.
3807  @item max-inline-insns-rtl
3808   is set to @var{n}.
3809 @end table
3810
3811 See below for a documentation of the individual
3812 parameters controlling inlining.
3813
3814 @emph{Note:} pseudo instruction represents, in this particular context, an
3815 abstract measurement of function's size.  In no way, it represents a count
3816 of assembly instructions and as such its exact meaning might change from one
3817 release to an another.
3818
3819 @item -fkeep-inline-functions
3820 @opindex fkeep-inline-functions
3821 Even if all calls to a given function are integrated, and the function
3822 is declared @code{static}, nevertheless output a separate run-time
3823 callable version of the function.  This switch does not affect
3824 @code{extern inline} functions.
3825
3826 @item -fkeep-static-consts
3827 @opindex fkeep-static-consts
3828 Emit variables declared @code{static const} when optimization isn't turned
3829 on, even if the variables aren't referenced.
3830
3831 GCC enables this option by default.  If you want to force the compiler to
3832 check if the variable was referenced, regardless of whether or not
3833 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3834
3835 @item -fmerge-constants
3836 Attempt to merge identical constants (string constants and floating point
3837 constants) across compilation units.
3838
3839 This option is the default for optimized compilation if the assembler and
3840 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3841 behavior.
3842
3843 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3844
3845 @item -fmerge-all-constants
3846 Attempt to merge identical constants and identical variables.
3847
3848 This option implies @option{-fmerge-constants}.  In addition to
3849 @option{-fmerge-constants} this considers e.g. even constant initialized
3850 arrays or initialized constant variables with integral or floating point
3851 types.  Languages like C or C++ require each non-automatic variable to
3852 have distinct location, so using this option will result in non-conforming
3853 behavior.
3854
3855 @item -fnew-ra
3856 @opindex fnew-ra
3857 Use a graph coloring register allocator.  Currently this option is meant
3858 for testing, so we are interested to hear about miscompilations with
3859 @option{-fnew-ra}.
3860
3861 @item -fno-branch-count-reg
3862 @opindex fno-branch-count-reg
3863 Do not use ``decrement and branch'' instructions on a count register,
3864 but instead generate a sequence of instructions that decrement a
3865 register, compare it against zero, then branch based upon the result.
3866 This option is only meaningful on architectures that support such
3867 instructions, which include x86, PowerPC, IA-64 and S/390.
3868
3869 The default is @option{-fbranch-count-reg}, enabled when
3870 @option{-fstrength-reduce} is enabled.
3871
3872 @item -fno-function-cse
3873 @opindex fno-function-cse
3874 Do not put function addresses in registers; make each instruction that
3875 calls a constant function contain the function's address explicitly.
3876
3877 This option results in less efficient code, but some strange hacks
3878 that alter the assembler output may be confused by the optimizations
3879 performed when this option is not used.
3880
3881 The default is @option{-ffunction-cse}
3882
3883 @item -fno-zero-initialized-in-bss
3884 @opindex fno-zero-initialized-in-bss
3885 If the target supports a BSS section, GCC by default puts variables that
3886 are initialized to zero into BSS@.  This can save space in the resulting
3887 code.
3888
3889 This option turns off this behavior because some programs explicitly
3890 rely on variables going to the data section.  E.g., so that the
3891 resulting executable can find the beginning of that section and/or make
3892 assumptions based on that.
3893
3894 The default is @option{-fzero-initialized-in-bss}.
3895
3896 @item -fstrength-reduce
3897 @opindex fstrength-reduce
3898 Perform the optimizations of loop strength reduction and
3899 elimination of iteration variables.
3900
3901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3902
3903 @item -fthread-jumps
3904 @opindex fthread-jumps
3905 Perform optimizations where we check to see if a jump branches to a
3906 location where another comparison subsumed by the first is found.  If
3907 so, the first branch is redirected to either the destination of the
3908 second branch or a point immediately following it, depending on whether
3909 the condition is known to be true or false.
3910
3911 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3912
3913 @item -fcse-follow-jumps
3914 @opindex fcse-follow-jumps
3915 In common subexpression elimination, scan through jump instructions
3916 when the target of the jump is not reached by any other path.  For
3917 example, when CSE encounters an @code{if} statement with an
3918 @code{else} clause, CSE will follow the jump when the condition
3919 tested is false.
3920
3921 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3922
3923 @item -fcse-skip-blocks
3924 @opindex fcse-skip-blocks
3925 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3926 follow jumps which conditionally skip over blocks.  When CSE
3927 encounters a simple @code{if} statement with no else clause,
3928 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3929 body of the @code{if}.
3930
3931 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3932
3933 @item -frerun-cse-after-loop
3934 @opindex frerun-cse-after-loop
3935 Re-run common subexpression elimination after loop optimizations has been
3936 performed.
3937
3938 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3939
3940 @item -frerun-loop-opt
3941 @opindex frerun-loop-opt
3942 Run the loop optimizer twice.
3943
3944 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3945
3946 @item -fgcse
3947 @opindex fgcse
3948 Perform a global common subexpression elimination pass.
3949 This pass also performs global constant and copy propagation.
3950
3951 @emph{Note:} When compiling a program using computed gotos, a GCC
3952 extension, you may get better runtime performance if you disable
3953 the global common subexpression elimination pass by adding
3954 @option{-fno-gcse} to the command line.
3955
3956 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3957
3958 @item -fgcse-lm
3959 @opindex fgcse-lm
3960 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3961 attempt to move loads which are only killed by stores into themselves.  This
3962 allows a loop containing a load/store sequence to be changed to a load outside
3963 the loop, and a copy/store within the loop.
3964
3965 Enabled by default when gcse is enabled.
3966
3967 @item -fgcse-sm
3968 @opindex fgcse-sm
3969 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3970 global common subexpression elimination.  This pass will attempt to move
3971 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3972 loops containing a load/store sequence can be changed to a load before
3973 the loop and a store after the loop.
3974
3975 Enabled by default when gcse is enabled.
3976
3977 @item -fgcse-las
3978 @opindex fgcse-las
3979 When @option{-fgcse-las} is enabled, the global common subexpression
3980 elimination pass eliminates redundant loads that come after stores to the
3981 same memory location (both partial and full redundancies).
3982
3983 Enabled by default when gcse is enabled.
3984
3985 @item -floop-optimize
3986 @opindex floop-optimize
3987 Perform loop optimizations: move constant expressions out of loops, simplify
3988 exit test conditions and optionally do strength-reduction and loop unrolling as
3989 well.
3990
3991 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3992
3993 @item -fcrossjumping
3994 @opindex crossjumping
3995 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3996 resulting code may or may not perform better than without cross-jumping.
3997
3998 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3999
4000 @item -fif-conversion
4001 @opindex if-conversion
4002 Attempt to transform conditional jumps into branch-less equivalents.  This
4003 include use of conditional moves, min, max, set flags and abs instructions, and
4004 some tricks doable by standard arithmetics.  The use of conditional execution
4005 on chips where it is available is controlled by @code{if-conversion2}.
4006
4007 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4008
4009 @item -fif-conversion2
4010 @opindex if-conversion2
4011 Use conditional execution (where available) to transform conditional jumps into
4012 branch-less equivalents.
4013
4014 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4015
4016 @item -fdelete-null-pointer-checks
4017 @opindex fdelete-null-pointer-checks
4018 Use global dataflow analysis to identify and eliminate useless checks
4019 for null pointers.  The compiler assumes that dereferencing a null
4020 pointer would have halted the program.  If a pointer is checked after
4021 it has already been dereferenced, it cannot be null.
4022
4023 In some environments, this assumption is not true, and programs can
4024 safely dereference null pointers.  Use
4025 @option{-fno-delete-null-pointer-checks} to disable this optimization
4026 for programs which depend on that behavior.
4027
4028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fexpensive-optimizations
4031 @opindex fexpensive-optimizations
4032 Perform a number of minor optimizations that are relatively expensive.
4033
4034 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4035
4036 @item -foptimize-register-move
4037 @itemx -fregmove
4038 @opindex foptimize-register-move
4039 @opindex fregmove
4040 Attempt to reassign register numbers in move instructions and as
4041 operands of other simple instructions in order to maximize the amount of
4042 register tying.  This is especially helpful on machines with two-operand
4043 instructions.
4044
4045 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4046 optimization.
4047
4048 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4049
4050 @item -fdelayed-branch
4051 @opindex fdelayed-branch
4052 If supported for the target machine, attempt to reorder instructions
4053 to exploit instruction slots available after delayed branch
4054 instructions.
4055
4056 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4057
4058 @item -fschedule-insns
4059 @opindex fschedule-insns
4060 If supported for the target machine, attempt to reorder instructions to
4061 eliminate execution stalls due to required data being unavailable.  This
4062 helps machines that have slow floating point or memory load instructions
4063 by allowing other instructions to be issued until the result of the load
4064 or floating point instruction is required.
4065
4066 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4067
4068 @item -fschedule-insns2
4069 @opindex fschedule-insns2
4070 Similar to @option{-fschedule-insns}, but requests an additional pass of
4071 instruction scheduling after register allocation has been done.  This is
4072 especially useful on machines with a relatively small number of
4073 registers and where memory load instructions take more than one cycle.
4074
4075 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4076
4077 @item -fno-sched-interblock
4078 @opindex fno-sched-interblock
4079 Don't schedule instructions across basic blocks.  This is normally
4080 enabled by default when scheduling before register allocation, i.e.@:
4081 with @option{-fschedule-insns} or at @option{-O2} or higher.
4082
4083 @item -fno-sched-spec
4084 @opindex fno-sched-spec
4085 Don't allow speculative motion of non-load instructions.  This is normally
4086 enabled by default when scheduling before register allocation, i.e.@:
4087 with @option{-fschedule-insns} or at @option{-O2} or higher.
4088
4089 @item -fsched-spec-load
4090 @opindex fsched-spec-load
4091 Allow speculative motion of some load instructions.  This only makes
4092 sense when scheduling before register allocation, i.e.@: with
4093 @option{-fschedule-insns} or at @option{-O2} or higher.
4094
4095 @item -fsched-spec-load-dangerous
4096 @opindex fsched-spec-load-dangerous
4097 Allow speculative motion of more load instructions.  This only makes
4098 sense when scheduling before register allocation, i.e.@: with
4099 @option{-fschedule-insns} or at @option{-O2} or higher.
4100
4101 @item -fsched-stalled-insns=@var{n}
4102 @opindex fsched-stalled-insns
4103 Define how many insns (if any) can be moved prematurely from the queue
4104 of stalled insns into the ready list, during the second scheduling pass.
4105
4106 @item -fsched-stalled-insns-dep=@var{n}
4107 @opindex fsched-stalled-insns-dep
4108 Define how many insn groups (cycles) will be examined for a dependency 
4109 on a stalled insn that is candidate for premature removal from the queue 
4110 of stalled insns.  Has an effect only during the second scheduling pass, 
4111 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4112
4113 @item -fsched2-use-superblocks
4114 @opindex fsched2-use-superblocks
4115 When scheduling after register allocation, do use superblock scheduling
4116 algorithm.  Superblock scheduling allows motion across basic block boundaries
4117 resulting on faster schedules.  This option is experimental, as not all machine
4118 descriptions used by GCC model the CPU closely enough to avoid unreliable
4119 results from the algorithm. 
4120
4121 This only makes sense when scheduling after register allocation, i.e.@: with
4122 @option{-fschedule-insns2} or at @option{-O2} or higher.
4123
4124 @item -fsched2-use-traces
4125 @opindex fsched2-use-traces
4126 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4127 allocation and additionally perform code duplication in order to increase the
4128 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4129 trace formation.
4130
4131 This mode should produce faster but significantly longer programs.  Also
4132 without @code{-fbranch-probabilities} the traces constructed may not match the
4133 reality and hurt the performance.  This only makes
4134 sense when scheduling after register allocation, i.e.@: with
4135 @option{-fschedule-insns2} or at @option{-O2} or higher.
4136
4137 @item -fcaller-saves
4138 @opindex fcaller-saves
4139 Enable values to be allocated in registers that will be clobbered by
4140 function calls, by emitting extra instructions to save and restore the
4141 registers around such calls.  Such allocation is done only when it
4142 seems to result in better code than would otherwise be produced.
4143
4144 This option is always enabled by default on certain machines, usually
4145 those which have no call-preserved registers to use instead.
4146
4147 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4148
4149 @item -fmove-all-movables
4150 @opindex fmove-all-movables
4151 Forces all invariant computations in loops to be moved
4152 outside the loop.
4153
4154 @item -freduce-all-givs
4155 @opindex freduce-all-givs
4156 Forces all general-induction variables in loops to be
4157 strength-reduced.
4158
4159 @emph{Note:} When compiling programs written in Fortran,
4160 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4161 by default when you use the optimizer.
4162
4163 These options may generate better or worse code; results are highly
4164 dependent on the structure of loops within the source code.
4165
4166 These two options are intended to be removed someday, once
4167 they have helped determine the efficacy of various
4168 approaches to improving loop optimizations.
4169
4170 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4171 know how use of these options affects
4172 the performance of your production code.
4173 We're very interested in code that runs @emph{slower}
4174 when these options are @emph{enabled}.
4175
4176 @item -fno-peephole
4177 @itemx -fno-peephole2
4178 @opindex fno-peephole
4179 @opindex fno-peephole2
4180 Disable any machine-specific peephole optimizations.  The difference
4181 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4182 are implemented in the compiler; some targets use one, some use the
4183 other, a few use both.
4184
4185 @option{-fpeephole} is enabled by default.
4186 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4187
4188 @item -fno-guess-branch-probability
4189 @opindex fno-guess-branch-probability
4190 Do not guess branch probabilities using a randomized model.
4191
4192 Sometimes gcc will opt to use a randomized model to guess branch
4193 probabilities, when none are available from either profiling feedback
4194 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4195 different runs of the compiler on the same program may produce different
4196 object code.
4197
4198 In a hard real-time system, people don't want different runs of the
4199 compiler to produce code that has different behavior; minimizing
4200 non-determinism is of paramount import.  This switch allows users to
4201 reduce non-determinism, possibly at the expense of inferior
4202 optimization.
4203
4204 The default is @option{-fguess-branch-probability} at levels
4205 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4206
4207 @item -freorder-blocks
4208 @opindex freorder-blocks
4209 Reorder basic blocks in the compiled function in order to reduce number of
4210 taken branches and improve code locality.
4211
4212 Enabled at levels @option{-O2}, @option{-O3}.
4213
4214 @item -freorder-functions
4215 @opindex freorder-functions
4216 Reorder basic blocks in the compiled function in order to reduce number of
4217 taken branches and improve code locality. This is implemented by using special
4218 subsections @code{text.hot} for most frequently executed functions and
4219 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4220 the linker so object file format must support named sections and linker must
4221 place them in a reasonable way.
4222
4223 Also profile feedback must be available in to make this option effective.  See
4224 @option{-fprofile-arcs} for details.
4225
4226 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4227
4228 @item -fstrict-aliasing
4229 @opindex fstrict-aliasing
4230 Allows the compiler to assume the strictest aliasing rules applicable to
4231 the language being compiled.  For C (and C++), this activates
4232 optimizations based on the type of expressions.  In particular, an
4233 object of one type is assumed never to reside at the same address as an
4234 object of a different type, unless the types are almost the same.  For
4235 example, an @code{unsigned int} can alias an @code{int}, but not a
4236 @code{void*} or a @code{double}.  A character type may alias any other
4237 type.
4238
4239 Pay special attention to code like this:
4240 @example
4241 union a_union @{
4242   int i;
4243   double d;
4244 @};
4245
4246 int f() @{
4247   a_union t;
4248   t.d = 3.0;
4249   return t.i;
4250 @}
4251 @end example
4252 The practice of reading from a different union member than the one most
4253 recently written to (called ``type-punning'') is common.  Even with
4254 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4255 is accessed through the union type.  So, the code above will work as
4256 expected.  However, this code might not:
4257 @example
4258 int f() @{
4259   a_union t;
4260   int* ip;
4261   t.d = 3.0;
4262   ip = &t.i;
4263   return *ip;
4264 @}
4265 @end example
4266
4267 Every language that wishes to perform language-specific alias analysis
4268 should define a function that computes, given an @code{tree}
4269 node, an alias set for the node.  Nodes in different alias sets are not
4270 allowed to alias.  For an example, see the C front-end function
4271 @code{c_get_alias_set}.
4272
4273 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4274
4275 @item -falign-functions
4276 @itemx -falign-functions=@var{n}
4277 @opindex falign-functions
4278 Align the start of functions to the next power-of-two greater than
4279 @var{n}, skipping up to @var{n} bytes.  For instance,
4280 @option{-falign-functions=32} aligns functions to the next 32-byte
4281 boundary, but @option{-falign-functions=24} would align to the next
4282 32-byte boundary only if this can be done by skipping 23 bytes or less.
4283
4284 @option{-fno-align-functions} and @option{-falign-functions=1} are
4285 equivalent and mean that functions will not be aligned.
4286
4287 Some assemblers only support this flag when @var{n} is a power of two;
4288 in that case, it is rounded up.
4289
4290 If @var{n} is not specified or is zero, use a machine-dependent default.
4291
4292 Enabled at levels @option{-O2}, @option{-O3}.
4293
4294 @item -falign-labels
4295 @itemx -falign-labels=@var{n}
4296 @opindex falign-labels
4297 Align all branch targets to a power-of-two boundary, skipping up to
4298 @var{n} bytes like @option{-falign-functions}.  This option can easily
4299 make code slower, because it must insert dummy operations for when the
4300 branch target is reached in the usual flow of the code.
4301
4302 @option{-fno-align-labels} and @option{-falign-labels=1} are
4303 equivalent and mean that labels will not be aligned.
4304
4305 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4306 are greater than this value, then their values are used instead.
4307
4308 If @var{n} is not specified or is zero, use a machine-dependent default
4309 which is very likely to be @samp{1}, meaning no alignment.
4310
4311 Enabled at levels @option{-O2}, @option{-O3}.
4312
4313 @item -falign-loops
4314 @itemx -falign-loops=@var{n}
4315 @opindex falign-loops
4316 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4317 like @option{-falign-functions}.  The hope is that the loop will be
4318 executed many times, which will make up for any execution of the dummy
4319 operations.
4320
4321 @option{-fno-align-loops} and @option{-falign-loops=1} are
4322 equivalent and mean that loops will not be aligned.
4323
4324 If @var{n} is not specified or is zero, use a machine-dependent default.
4325
4326 Enabled at levels @option{-O2}, @option{-O3}.
4327
4328 @item -falign-jumps
4329 @itemx -falign-jumps=@var{n}
4330 @opindex falign-jumps
4331 Align branch targets to a power-of-two boundary, for branch targets
4332 where the targets can only be reached by jumping, skipping up to @var{n}
4333 bytes like @option{-falign-functions}.  In this case, no dummy operations
4334 need be executed.
4335
4336 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4337 equivalent and mean that loops will not be aligned.
4338
4339 If @var{n} is not specified or is zero, use a machine-dependent default.
4340
4341 Enabled at levels @option{-O2}, @option{-O3}.
4342
4343 @item -frename-registers
4344 @opindex frename-registers
4345 Attempt to avoid false dependencies in scheduled code by making use
4346 of registers left over after register allocation.  This optimization
4347 will most benefit processors with lots of registers.  It can, however,
4348 make debugging impossible, since variables will no longer stay in
4349 a ``home register''.
4350
4351 @item -fweb
4352 @opindex fweb
4353 Constructs webs as commonly used for register allocation purposes and assign
4354 each web individual pseudo register.  This allows our register allocation pass
4355 to operate on pseudos directly, but also strengthens several other optimization
4356 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4357 however, make debugging impossible, since variables will no longer stay in a
4358 ``home register''.
4359
4360 Enabled at levels @option{-O3}.
4361
4362 @item -fno-cprop-registers
4363 @opindex fno-cprop-registers
4364 After register allocation and post-register allocation instruction splitting,
4365 we perform a copy-propagation pass to try to reduce scheduling dependencies
4366 and occasionally eliminate the copy.
4367
4368 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4369
4370 @item -fprofile-generate
4371 @opindex fprofile-generate
4372 Enable options usually used for instrumenting application to produce profile usefull
4373 for later recompilation profile feedback based optimization.
4374
4375 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}
4376
4377 @item -fprofile-use
4378 @opindex fprofile-use
4379 Enable profile feedback directed optimizations, and optimizations
4380 generally profitable only with profile feedback available.
4381
4382 The following options are enabled: @code{-fbranch-probabilities},
4383 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4384
4385 @end table
4386
4387 The following options control compiler behavior regarding floating
4388 point arithmetic.  These options trade off between speed and
4389 correctness.  All must be specifically enabled.
4390
4391 @table @gcctabopt
4392 @item -ffloat-store
4393 @opindex ffloat-store
4394 Do not store floating point variables in registers, and inhibit other
4395 options that might change whether a floating point value is taken from a
4396 register or memory.
4397
4398 @cindex floating point precision
4399 This option prevents undesirable excess precision on machines such as
4400 the 68000 where the floating registers (of the 68881) keep more
4401 precision than a @code{double} is supposed to have.  Similarly for the
4402 x86 architecture.  For most programs, the excess precision does only
4403 good, but a few programs rely on the precise definition of IEEE floating
4404 point.  Use @option{-ffloat-store} for such programs, after modifying
4405 them to store all pertinent intermediate computations into variables.
4406
4407 @item -ffast-math
4408 @opindex ffast-math
4409 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4410 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4411 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4412
4413 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4414
4415 This option should never be turned on by any @option{-O} option since
4416 it can result in incorrect output for programs which depend on
4417 an exact implementation of IEEE or ISO rules/specifications for
4418 math functions.
4419
4420 @item -fno-math-errno
4421 @opindex fno-math-errno
4422 Do not set ERRNO after calling math functions that are executed
4423 with a single instruction, e.g., sqrt.  A program that relies on
4424 IEEE exceptions for math error handling may want to use this flag
4425 for speed while maintaining IEEE arithmetic compatibility.
4426
4427 This option should never be turned on by any @option{-O} option since
4428 it can result in incorrect output for programs which depend on
4429 an exact implementation of IEEE or ISO rules/specifications for
4430 math functions.
4431
4432 The default is @option{-fmath-errno}.
4433
4434 @item -funsafe-math-optimizations
4435 @opindex funsafe-math-optimizations
4436 Allow optimizations for floating-point arithmetic that (a) assume
4437 that arguments and results are valid and (b) may violate IEEE or
4438 ANSI standards.  When used at link-time, it may include libraries
4439 or startup files that change the default FPU control word or other
4440 similar optimizations.
4441
4442 This option should never be turned on by any @option{-O} option since
4443 it can result in incorrect output for programs which depend on
4444 an exact implementation of IEEE or ISO rules/specifications for
4445 math functions.
4446
4447 The default is @option{-fno-unsafe-math-optimizations}.
4448
4449 @item -ffinite-math-only
4450 @opindex ffinite-math-only
4451 Allow optimizations for floating-point arithmetic that assume
4452 that arguments and results are not NaNs or +-Infs.
4453
4454 This option should never be turned on by any @option{-O} option since
4455 it can result in incorrect output for programs which depend on
4456 an exact implementation of IEEE or ISO rules/specifications.
4457
4458 The default is @option{-fno-finite-math-only}.
4459
4460 @item -fno-trapping-math
4461 @opindex fno-trapping-math
4462 Compile code assuming that floating-point operations cannot generate
4463 user-visible traps.  These traps include division by zero, overflow,
4464 underflow, inexact result and invalid operation.  This option implies
4465 @option{-fno-signaling-nans}.  Setting this option may allow faster
4466 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4467
4468 This option should never be turned on by any @option{-O} option since
4469 it can result in incorrect output for programs which depend on
4470 an exact implementation of IEEE or ISO rules/specifications for
4471 math functions.
4472
4473 The default is @option{-ftrapping-math}.
4474
4475 @item -frounding-math
4476 @opindex frounding-math
4477 Disable transformations and optimizations that assume default floating
4478 point rounding behavior.  This is round-to-zero for all floating point
4479 to integer conversions, and round-to-nearest for all other arithmetic
4480 truncations.  This option should be specified for programs that change
4481 the FP rounding mode dynamically, or that may be executed with a
4482 non-default rounding mode.  This option disables constant folding of
4483 floating point expressions at compile-time (which may be affected by
4484 rounding mode) and arithmetic transformations that are unsafe in the
4485 presence of sign-dependent rounding modes.
4486
4487 The default is @option{-fno-rounding-math}.
4488
4489 This option is experimental and does not currently guarantee to
4490 disable all GCC optimizations that are affected by rounding mode.
4491 Future versions of gcc may provide finer control of this setting
4492 using C99's @code{FENV_ACCESS} pragma.  This command line option
4493 will be used to specify the default state for @code{FENV_ACCESS}.
4494
4495 @item -fsignaling-nans
4496 @opindex fsignaling-nans
4497 Compile code assuming that IEEE signaling NaNs may generate user-visible
4498 traps during floating-point operations.  Setting this option disables
4499 optimizations that may change the number of exceptions visible with
4500 signaling NaNs.  This option implies @option{-ftrapping-math}.
4501
4502 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4503 be defined.
4504
4505 The default is @option{-fno-signaling-nans}.
4506
4507 This option is experimental and does not currently guarantee to
4508 disable all GCC optimizations that affect signaling NaN behavior.
4509
4510 @item -fsingle-precision-constant
4511 @opindex fsingle-precision-constant
4512 Treat floating point constant as single precision constant instead of
4513 implicitly converting it to double precision constant.
4514
4515
4516 @end table
4517
4518 The following options control optimizations that may improve
4519 performance, but are not enabled by any @option{-O} options.  This
4520 section includes experimental options that may produce broken code.
4521
4522 @table @gcctabopt
4523 @item -fbranch-probabilities
4524 @opindex fbranch-probabilities
4525 After running a program compiled with @option{-fprofile-arcs}
4526 (@pxref{Debugging Options,, Options for Debugging Your Program or
4527 @command{gcc}}), you can compile it a second time using
4528 @option{-fbranch-probabilities}, to improve optimizations based on
4529 the number of times each branch was taken.  When the program
4530 compiled with @option{-fprofile-arcs} exits it saves arc execution
4531 counts to a file called @file{@var{sourcename}.gcda} for each source
4532 file  The information in this data file is very dependent on the
4533 structure of the generated code, so you must use the same source code
4534 and the same optimization options for both compilations.
4535
4536 With @option{-fbranch-probabilities}, GCC puts a 
4537 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4538 These can be used to improve optimization.  Currently, they are only
4539 used in one place: in @file{reorg.c}, instead of guessing which path a
4540 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4541 exactly determine which path is taken more often.
4542
4543 @item -fprofile-values
4544 @opindex fprofile-values
4545 If combined with @option{-fprofile-arcs}, it adds code so that some
4546 data about values of expressions in the program is gathered.
4547
4548 With @option{-fbranch-probabilities}, it reads back the data gathered
4549 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4550 notes to instructions for their later usage in optimizations.
4551
4552 @item -fvpt
4553 @opindex fvpt
4554 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4555 a code to gather information about values of expressions.
4556
4557 With @option{-fbranch-probabilities}, it reads back the data gathered
4558 and actually performs the optimizations based on them.
4559 Currently the optimizations include specialization of division operation
4560 using the knowledge about the value of the denominator.
4561
4562 @item -fnew-ra
4563 @opindex fnew-ra
4564 Use a graph coloring register allocator.  Currently this option is meant
4565 for testing, so we are interested to hear about miscompilations with
4566 @option{-fnew-ra}.
4567
4568 @item -ftracer
4569 @opindex ftracer
4570 Perform tail duplication to enlarge superblock size. This transformation
4571 simplifies the control flow of the function allowing other optimizations to do
4572 better job.
4573
4574 @item -funit-at-a-time
4575 @opindex funit-at-a-time
4576 Parse the whole compilation unit before starting to produce code.
4577 This allows some extra optimizations to take place but consumes more
4578 memory.
4579
4580 @item -funroll-loops
4581 @opindex funroll-loops
4582 Unroll loops whose number of iterations can be determined at compile time or
4583 upon entry to the loop.  @option{-funroll-loops} implies
4584 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4585 (i.e. complete removal of loops with small constant number of iterations).
4586 This option makes code larger, and may or may not make it run faster.
4587
4588 @item -funroll-all-loops
4589 @opindex funroll-all-loops
4590 Unroll all loops, even if their number of iterations is uncertain when
4591 the loop is entered.  This usually makes programs run more slowly.
4592 @option{-funroll-all-loops} implies the same options as
4593 @option{-funroll-loops}.
4594
4595 @item -fpeel-loops
4596 @opindex fpeel-loops
4597 Peels the loops for that there is enough information that they do not
4598 roll much (from profile feedback).  It also turns on complete loop peeling
4599 (i.e. complete removal of loops with small constant number of iterations).
4600
4601 @item -funswitch-loops
4602 @opindex funswitch-loops
4603 Move branches with loop invariant conditions out of the loop, with duplicates
4604 of the loop on both branches (modified according to result of the condition).
4605
4606 @item -fold-unroll-loops
4607 @opindex fold-unroll-loops
4608 Unroll loops whose number of iterations can be determined at compile
4609 time or upon entry to the loop, using the old loop unroller whose loop
4610 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4611 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4612 option makes code larger, and may or may not make it run faster.
4613
4614 @item -fold-unroll-all-loops
4615 @opindex fold-unroll-all-loops
4616 Unroll all loops, even if their number of iterations is uncertain when
4617 the loop is entered. This is done using the old loop unroller whose loop
4618 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4619 @option{-fold-unroll-all-loops} implies the same options as
4620 @option{-fold-unroll-loops}.
4621  
4622 @item -funswitch-loops
4623 @opindex funswitch-loops
4624 Move branches with loop invariant conditions out of the loop, with duplicates
4625 of the loop on both branches (modified according to result of the condition).
4626
4627 @item -funswitch-loops
4628 @opindex funswitch-loops
4629 Move branches with loop invariant conditions out of the loop, with duplicates
4630 of the loop on both branches (modified according to result of the condition).
4631
4632 @item -fprefetch-loop-arrays
4633 @opindex fprefetch-loop-arrays
4634 If supported by the target machine, generate instructions to prefetch
4635 memory to improve the performance of loops that access large arrays.
4636
4637 Disabled at level @option{-Os}.
4638
4639 @item -ffunction-sections
4640 @itemx -fdata-sections
4641 @opindex ffunction-sections
4642 @opindex fdata-sections
4643 Place each function or data item into its own section in the output
4644 file if the target supports arbitrary sections.  The name of the
4645 function or the name of the data item determines the section's name
4646 in the output file.
4647
4648 Use these options on systems where the linker can perform optimizations
4649 to improve locality of reference in the instruction space.  Most systems
4650 using the ELF object format and SPARC processors running Solaris 2 have
4651 linkers with such optimizations.  AIX may have these optimizations in
4652 the future.
4653
4654 Only use these options when there are significant benefits from doing
4655 so.  When you specify these options, the assembler and linker will
4656 create larger object and executable files and will also be slower.
4657 You will not be able to use @code{gprof} on all systems if you
4658 specify this option and you may have problems with debugging if
4659 you specify both this option and @option{-g}.
4660
4661 @item -fbranch-target-load-optimize
4662 @opindex fbranch-target-load-optimize
4663 Perform branch target register load optimization before prologue / epilogue
4664 threading.
4665 The use of target registers can typically be exposed only during reload,
4666 thus hoisting loads out of loops and doing inter-block scheduling needs
4667 a separate optimization pass.
4668
4669 @item -fbranch-target-load-optimize2
4670 @opindex fbranch-target-load-optimize2
4671 Perform branch target register load optimization after prologue / epilogue
4672 threading.
4673
4674 @item --param @var{name}=@var{value}
4675 @opindex param
4676 In some places, GCC uses various constants to control the amount of
4677 optimization that is done.  For example, GCC will not inline functions
4678 that contain more that a certain number of instructions.  You can
4679 control some of these constants on the command-line using the
4680 @option{--param} option.
4681
4682 In each case, the @var{value} is an integer.  The allowable choices for
4683 @var{name} are given in the following table:
4684
4685 @table @gcctabopt
4686 @item max-crossjump-edges
4687 The maximum number of incoming edges to consider for crossjumping.
4688 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4689 the number of edges incoming to each block.  Increasing values mean
4690 more aggressive optimization, making the compile time increase with
4691 probably small improvement in executable size.
4692
4693 @item max-delay-slot-insn-search
4694 The maximum number of instructions to consider when looking for an
4695 instruction to fill a delay slot.  If more than this arbitrary number of
4696 instructions is searched, the time savings from filling the delay slot
4697 will be minimal so stop searching.  Increasing values mean more
4698 aggressive optimization, making the compile time increase with probably
4699 small improvement in executable run time.
4700
4701 @item max-delay-slot-live-search
4702 When trying to fill delay slots, the maximum number of instructions to
4703 consider when searching for a block with valid live register
4704 information.  Increasing this arbitrarily chosen value means more
4705 aggressive optimization, increasing the compile time.  This parameter
4706 should be removed when the delay slot code is rewritten to maintain the
4707 control-flow graph.
4708
4709 @item max-gcse-memory
4710 The approximate maximum amount of memory that will be allocated in
4711 order to perform the global common subexpression elimination
4712 optimization.  If more memory than specified is required, the
4713 optimization will not be done.
4714
4715 @item max-gcse-passes
4716 The maximum number of passes of GCSE to run.
4717
4718 @item max-pending-list-length
4719 The maximum number of pending dependencies scheduling will allow
4720 before flushing the current state and starting over.  Large functions
4721 with few branches or calls can create excessively large lists which
4722 needlessly consume memory and resources.
4723
4724 @item max-inline-insns-single
4725 Several parameters control the tree inliner used in gcc.
4726 This number sets the maximum number of instructions (counted in gcc's
4727 internal representation) in a single function that the tree inliner 
4728 will consider for inlining.  This only affects functions declared
4729 inline and methods implemented in a class declaration (C++).
4730 The default value is 500.
4731
4732 @item max-inline-insns-auto
4733 When you use @option{-finline-functions} (included in @option{-O3}),
4734 a lot of functions that would otherwise not be considered for inlining
4735 by the compiler will be investigated.  To those functions, a different
4736 (more restrictive) limit compared to functions declared inline can
4737 be applied.
4738 The default value is 150.
4739
4740 @item large-function-insns
4741 The limit specifying really large functions.  For functions greater than this
4742 limit inlining is constrained by @option{--param large-function-growth}.
4743 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4744 algorithms used by the backend.
4745 This parameter is ignored when @option{-funit-at-a-time} is not used.
4746 The default value is 30000.
4747
4748 @item large-function-growth
4749 Specifies maximal growth of large functtion caused by inlining in percents.
4750 This parameter is ignored when @option{-funit-at-a-time} is not used.
4751 The default value is 200.
4752
4753 @item inline-unit-growth
4754 Specifies maximal overall growth of the compilation unit caused by inlining.
4755 This parameter is ignored when @option{-funit-at-a-time} is not used.
4756 The default value is 150.
4757
4758 @item max-inline-insns-rtl
4759 For languages that use the RTL inliner (this happens at a later stage
4760 than tree inlining), you can set the maximum allowable size (counted 
4761 in RTL instructions) for the RTL inliner with this parameter.
4762 The default value is 600.
4763
4764 @item max-unrolled-insns
4765 The maximum number of instructions that a loop should have if that loop
4766 is unrolled, and if the loop is unrolled, it determines how many times
4767 the loop code is unrolled.
4768
4769 @item max-average-unrolled-insns
4770 The maximum number of instructions biased by probabilities of their execution
4771 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4772 it determines how many times the loop code is unrolled.
4773
4774 @item max-unroll-times
4775 The maximum number of unrollings of a single loop.
4776
4777 @item max-peeled-insns
4778 The maximum number of instructions that a loop should have if that loop
4779 is peeled, and if the loop is peeled, it determines how many times
4780 the loop code is peeled.
4781
4782 @item max-peel-times
4783 The maximum number of peelings of a single loop.
4784
4785 @item max-completely-peeled-insns
4786 The maximum number of insns of a completely peeled loop.
4787
4788 @item max-completely-peel-times
4789 The maximum number of iterations of a loop to be suitable for complete peeling.
4790
4791 @item max-unswitch-insns
4792 The maximum number of insns of an unswitched loop.
4793
4794 @item max-unswitch-level
4795 The maximum number of branches unswitched in a single loop.
4796
4797 @item hot-bb-count-fraction
4798 Select fraction of the maximal count of repetitions of basic block in program
4799 given basic block needs to have to be considered hot.
4800
4801 @item hot-bb-frequency-fraction
4802 Select fraction of the maximal frequency of executions of basic block in
4803 function given basic block needs to have to be considered hot
4804
4805 @item tracer-dynamic-coverage
4806 @itemx tracer-dynamic-coverage-feedback
4807
4808 This value is used to limit superblock formation once the given percentage of
4809 executed instructions is covered.  This limits unnecessary code size
4810 expansion.
4811
4812 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4813 feedback is available.  The real profiles (as opposed to statically estimated
4814 ones) are much less balanced allowing the threshold to be larger value.
4815
4816 @item tracer-max-code-growth
4817 Stop tail duplication once code growth has reached given percentage.  This is
4818 rather hokey argument, as most of the duplicates will be eliminated later in
4819 cross jumping, so it may be set to much higher values than is the desired code
4820 growth.
4821
4822 @item tracer-min-branch-ratio
4823
4824 Stop reverse growth when the reverse probability of best edge is less than this
4825 threshold (in percent).
4826
4827 @item tracer-min-branch-ratio
4828 @itemx tracer-min-branch-ratio-feedback
4829
4830 Stop forward growth if the best edge do have probability lower than this
4831 threshold.
4832
4833 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4834 compilation for profile feedback and one for compilation without.  The value
4835 for compilation with profile feedback needs to be more conservative (higher) in
4836 order to make tracer effective.
4837
4838 @item max-cse-path-length
4839
4840 Maximum number of basic blocks on path that cse considers.
4841
4842 @item ggc-min-expand
4843
4844 GCC uses a garbage collector to manage its own memory allocation.  This
4845 parameter specifies the minimum percentage by which the garbage
4846 collector's heap should be allowed to expand between collections.
4847 Tuning this may improve compilation speed; it has no effect on code
4848 generation.
4849
4850 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4851 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4852 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4853 GCC is not able to calculate RAM on a particular platform, the lower
4854 bound of 30% is used.  Setting this parameter and
4855 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4856 every opportunity.  This is extremely slow, but can be useful for
4857 debugging.
4858
4859 @item ggc-min-heapsize
4860
4861 Minimum size of the garbage collector's heap before it begins bothering
4862 to collect garbage.  The first collection occurs after the heap expands
4863 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4864 tuning this may improve compilation speed, and has no effect on code
4865 generation.
4866
4867 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4868 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4869 available, the notion of "RAM" is the smallest of actual RAM,
4870 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4871 RAM on a particular platform, the lower bound is used.  Setting this
4872 parameter very large effectively disables garbage collection.  Setting
4873 this parameter and @option{ggc-min-expand} to zero causes a full
4874 collection to occur at every opportunity.
4875
4876 @item reorder-blocks-duplicate
4877 @itemx reorder-blocks-duplicate-feedback
4878
4879 Used by basic block reordering pass to decide whether to use unconditional
4880 branch or duplicate the code on its destination.  Code is duplicated when its
4881 estimated size is smaller than this value multiplied by the estimated size of
4882 unconditional jump in the hot spots of the program.
4883
4884 The @option{reorder-block-duplicate-feedback} is used only when profile
4885 feedback is available and may be set to higher values than
4886 @option{reorder-block-duplicate} since information about the hot spots is more
4887 accurate.
4888 @end table
4889 @end table
4890
4891 @node Preprocessor Options
4892 @section Options Controlling the Preprocessor
4893 @cindex preprocessor options
4894 @cindex options, preprocessor
4895
4896 These options control the C preprocessor, which is run on each C source
4897 file before actual compilation.
4898
4899 If you use the @option{-E} option, nothing is done except preprocessing.
4900 Some of these options make sense only together with @option{-E} because
4901 they cause the preprocessor output to be unsuitable for actual
4902 compilation.
4903
4904 @table @gcctabopt
4905 @opindex Wp
4906 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4907 and pass @var{option} directly through to the preprocessor.  If
4908 @var{option} contains commas, it is split into multiple options at the
4909 commas.  However, many options are modified, translated or interpreted
4910 by the compiler driver before being passed to the preprocessor, and
4911 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4912 interface is undocumented and subject to change, so whenever possible
4913 you should avoid using @option{-Wp} and let the driver handle the
4914 options instead.
4915
4916 @item -Xpreprocessor @var{option}
4917 @opindex preprocessor
4918 Pass @var{option} as an option to the preprocessor.  You can use this to
4919 supply system-specific preprocessor options which GCC does not know how to
4920 recognize.
4921
4922 If you want to pass an option that takes an argument, you must use
4923 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4924 @end table
4925
4926 @include cppopts.texi
4927
4928 @node Assembler Options
4929 @section Passing Options to the Assembler
4930
4931 @c prevent bad page break with this line
4932 You can pass options to the assembler.
4933
4934 @table @gcctabopt
4935 @item -Wa,@var{option}
4936 @opindex Wa
4937 Pass @var{option} as an option to the assembler.  If @var{option}
4938 contains commas, it is split into multiple options at the commas.
4939
4940 @item -Xassembler @var{option}
4941 @opindex Xassembler
4942 Pass @var{option} as an option to the assembler.  You can use this to
4943 supply system-specific assembler options which GCC does not know how to
4944 recognize.
4945
4946 If you want to pass an option that takes an argument, you must use
4947 @option{-Xassembler} twice, once for the option and once for the argument.
4948
4949 @end table
4950
4951 @node Link Options
4952 @section Options for Linking
4953 @cindex link options
4954 @cindex options, linking
4955
4956 These options come into play when the compiler links object files into
4957 an executable output file.  They are meaningless if the compiler is
4958 not doing a link step.
4959
4960 @table @gcctabopt
4961 @cindex file names
4962 @item @var{object-file-name}
4963 A file name that does not end in a special recognized suffix is
4964 considered to name an object file or library.  (Object files are
4965 distinguished from libraries by the linker according to the file
4966 contents.)  If linking is done, these object files are used as input
4967 to the linker.
4968
4969 @item -c
4970 @itemx -S
4971 @itemx -E
4972 @opindex c
4973 @opindex S
4974 @opindex E
4975 If any of these options is used, then the linker is not run, and
4976 object file names should not be used as arguments.  @xref{Overall
4977 Options}.
4978
4979 @cindex Libraries
4980 @item -l@var{library}
4981 @itemx -l @var{library}
4982 @opindex l
4983 Search the library named @var{library} when linking.  (The second
4984 alternative with the library as a separate argument is only for
4985 POSIX compliance and is not recommended.)
4986
4987 It makes a difference where in the command you write this option; the
4988 linker searches and processes libraries and object files in the order they
4989 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4990 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4991 to functions in @samp{z}, those functions may not be loaded.
4992
4993 The linker searches a standard list of directories for the library,
4994 which is actually a file named @file{lib@var{library}.a}.  The linker
4995 then uses this file as if it had been specified precisely by name.
4996
4997 The directories searched include several standard system directories
4998 plus any that you specify with @option{-L}.
4999
5000 Normally the files found this way are library files---archive files
5001 whose members are object files.  The linker handles an archive file by
5002 scanning through it for members which define symbols that have so far
5003 been referenced but not defined.  But if the file that is found is an
5004 ordinary object file, it is linked in the usual fashion.  The only
5005 difference between using an @option{-l} option and specifying a file name
5006 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5007 and searches several directories.
5008
5009 @item -lobjc
5010 @opindex lobjc
5011 You need this special case of the @option{-l} option in order to
5012 link an Objective-C program.
5013
5014 @item -nostartfiles
5015 @opindex nostartfiles
5016 Do not use the standard system startup files when linking.
5017 The standard system libraries are used normally, unless @option{-nostdlib}
5018 or @option{-nodefaultlibs} is used.
5019
5020 @item -nodefaultlibs
5021 @opindex nodefaultlibs
5022 Do not use the standard system libraries when linking.
5023 Only the libraries you specify will be passed to the linker.
5024 The standard startup files are used normally, unless @option{-nostartfiles}
5025 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5026 for System V (and ISO C) environments or to bcopy and bzero for
5027 BSD environments.  These entries are usually resolved by entries in
5028 libc.  These entry points should be supplied through some other
5029 mechanism when this option is specified.
5030
5031 @item -nostdlib
5032 @opindex nostdlib
5033 Do not use the standard system startup files or libraries when linking.
5034 No startup files and only the libraries you specify will be passed to
5035 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5036 for System V (and ISO C) environments or to bcopy and bzero for
5037 BSD environments.  These entries are usually resolved by entries in
5038 libc.  These entry points should be supplied through some other
5039 mechanism when this option is specified.
5040
5041 @cindex @option{-lgcc}, use with @option{-nostdlib}
5042 @cindex @option{-nostdlib} and unresolved references
5043 @cindex unresolved references and @option{-nostdlib}
5044 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5045 @cindex @option{-nodefaultlibs} and unresolved references
5046 @cindex unresolved references and @option{-nodefaultlibs}
5047 One of the standard libraries bypassed by @option{-nostdlib} and
5048 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5049 that GCC uses to overcome shortcomings of particular machines, or special
5050 needs for some languages.
5051 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5052 Collection (GCC) Internals},
5053 for more discussion of @file{libgcc.a}.)
5054 In most cases, you need @file{libgcc.a} even when you want to avoid
5055 other standard libraries.  In other words, when you specify @option{-nostdlib}
5056 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5057 This ensures that you have no unresolved references to internal GCC
5058 library subroutines.  (For example, @samp{__main}, used to ensure C++
5059 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5060 GNU Compiler Collection (GCC) Internals}.)
5061
5062 @item -pie
5063 @opindex pie
5064 Produce a position independent executable on targets which support it.
5065 For predictable results, you must also specify the same set of options
5066 that were used to generate code (@option{-fpie}, @option{-fPIE},
5067 or model suboptions) when you specify this option.
5068
5069 @item -s
5070 @opindex s
5071 Remove all symbol table and relocation information from the executable.
5072
5073 @item -static
5074 @opindex static
5075 On systems that support dynamic linking, this prevents linking with the shared
5076 libraries.  On other systems, this option has no effect.
5077
5078 @item -shared
5079 @opindex shared
5080 Produce a shared object which can then be linked with other objects to
5081 form an executable.  Not all systems support this option.  For predictable
5082 results, you must also specify the same set of options that were used to
5083 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5084 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5085 needs to build supplementary stub code for constructors to work.  On
5086 multi-libbed systems, @samp{gcc -shared} must select the correct support
5087 libraries to link against.  Failing to supply the correct flags may lead
5088 to subtle defects.  Supplying them in cases where they are not necessary
5089 is innocuous.}
5090
5091 @item -shared-libgcc
5092 @itemx -static-libgcc
5093 @opindex shared-libgcc
5094 @opindex static-libgcc
5095 On systems that provide @file{libgcc} as a shared library, these options
5096 force the use of either the shared or static version respectively.
5097 If no shared version of @file{libgcc} was built when the compiler was
5098 configured, these options have no effect.
5099
5100 There are several situations in which an application should use the
5101 shared @file{libgcc} instead of the static version.  The most common
5102 of these is when the application wishes to throw and catch exceptions
5103 across different shared libraries.  In that case, each of the libraries
5104 as well as the application itself should use the shared @file{libgcc}.
5105
5106 Therefore, the G++ and GCJ drivers automatically add
5107 @option{-shared-libgcc} whenever you build a shared library or a main
5108 executable, because C++ and Java programs typically use exceptions, so
5109 this is the right thing to do.
5110
5111 If, instead, you use the GCC driver to create shared libraries, you may
5112 find that they will not always be linked with the shared @file{libgcc}.
5113 If GCC finds, at its configuration time, that you have a GNU linker that
5114 does not support option @option{--eh-frame-hdr}, it will link the shared
5115 version of @file{libgcc} into shared libraries by default.  Otherwise,
5116 it will take advantage of the linker and optimize away the linking with
5117 the shared version of @file{libgcc}, linking with the static version of
5118 libgcc by default.  This allows exceptions to propagate through such
5119 shared libraries, without incurring relocation costs at library load
5120 time.
5121
5122 However, if a library or main executable is supposed to throw or catch
5123 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5124 for the languages used in the program, or using the option
5125 @option{-shared-libgcc}, such that it is linked with the shared
5126 @file{libgcc}.
5127
5128 @item -symbolic
5129 @opindex symbolic
5130 Bind references to global symbols when building a shared object.  Warn
5131 about any unresolved references (unless overridden by the link editor
5132 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5133 this option.
5134
5135 @item -Xlinker @var{option}
5136 @opindex Xlinker
5137 Pass @var{option} as an option to the linker.  You can use this to
5138 supply system-specific linker options which GCC does not know how to
5139 recognize.
5140
5141 If you want to pass an option that takes an argument, you must use
5142 @option{-Xlinker} twice, once for the option and once for the argument.
5143 For example, to pass @option{-assert definitions}, you must write
5144 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5145 @option{-Xlinker "-assert definitions"}, because this passes the entire
5146 string as a single argument, which is not what the linker expects.
5147
5148 @item -Wl,@var{option}
5149 @opindex Wl
5150 Pass @var{option} as an option to the linker.  If @var{option} contains
5151 commas, it is split into multiple options at the commas.
5152
5153 @item -u @var{symbol}
5154 @opindex u
5155 Pretend the symbol @var{symbol} is undefined, to force linking of
5156 library modules to define it.  You can use @option{-u} multiple times with
5157 different symbols to force loading of additional library modules.
5158 @end table
5159
5160 @node Directory Options
5161 @section Options for Directory Search
5162 @cindex directory options
5163 @cindex options, directory search
5164 @cindex search path
5165
5166 These options specify directories to search for header files, for
5167 libraries and for parts of the compiler:
5168
5169 @table @gcctabopt
5170 @item -I@var{dir}
5171 @opindex I
5172 Add the directory @var{dir} to the head of the list of directories to be
5173 searched for header files.  This can be used to override a system header
5174 file, substituting your own version, since these directories are
5175 searched before the system header file directories.  However, you should
5176 not use this option to add directories that contain vendor-supplied
5177 system header files (use @option{-isystem} for that).  If you use more than
5178 one @option{-I} option, the directories are scanned in left-to-right
5179 order; the standard system directories come after.
5180
5181 If a standard system include directory, or a directory specified with
5182 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5183 option will be ignored.  The directory will still be searched but as a
5184 system directory at its normal position in the system include chain.
5185 This is to ensure that GCC's procedure to fix buggy system headers and
5186 the ordering for the include_next directive are not inadvertently changed.
5187 If you really need to change the search order for system directories,
5188 use the @option{-nostdinc} and/or @option{-isystem} options.
5189
5190 @item -I-
5191 @opindex I-
5192 Any directories you specify with @option{-I} options before the @option{-I-}
5193 option are searched only for the case of @samp{#include "@var{file}"};
5194 they are not searched for @samp{#include <@var{file}>}.
5195
5196 If additional directories are specified with @option{-I} options after
5197 the @option{-I-}, these directories are searched for all @samp{#include}
5198 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5199 this way.)
5200
5201 In addition, the @option{-I-} option inhibits the use of the current
5202 directory (where the current input file came from) as the first search
5203 directory for @samp{#include "@var{file}"}.  There is no way to
5204 override this effect of @option{-I-}.  With @option{-I.} you can specify
5205 searching the directory which was current when the compiler was
5206 invoked.  That is not exactly the same as what the preprocessor does
5207 by default, but it is often satisfactory.
5208
5209 @option{-I-} does not inhibit the use of the standard system directories
5210 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5211 independent.
5212
5213 @item -L@var{dir}
5214 @opindex L
5215 Add directory @var{dir} to the list of directories to be searched
5216 for @option{-l}.
5217
5218 @item -B@var{prefix}
5219 @opindex B
5220 This option specifies where to find the executables, libraries,
5221 include files, and data files of the compiler itself.
5222
5223 The compiler driver program runs one or more of the subprograms
5224 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5225 @var{prefix} as a prefix for each program it tries to run, both with and
5226 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5227
5228 For each subprogram to be run, the compiler driver first tries the
5229 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5230 was not specified, the driver tries two standard prefixes, which are
5231 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5232 those results in a file name that is found, the unmodified program
5233 name is searched for using the directories specified in your
5234 @env{PATH} environment variable.
5235
5236 The compiler will check to see if the path provided by the @option{-B}
5237 refers to a directory, and if necessary it will add a directory
5238 separator character at the end of the path.
5239
5240 @option{-B} prefixes that effectively specify directory names also apply
5241 to libraries in the linker, because the compiler translates these
5242 options into @option{-L} options for the linker.  They also apply to
5243 includes files in the preprocessor, because the compiler translates these
5244 options into @option{-isystem} options for the preprocessor.  In this case,
5245 the compiler appends @samp{include} to the prefix.
5246
5247 The run-time support file @file{libgcc.a} can also be searched for using
5248 the @option{-B} prefix, if needed.  If it is not found there, the two
5249 standard prefixes above are tried, and that is all.  The file is left
5250 out of the link if it is not found by those means.
5251
5252 Another way to specify a prefix much like the @option{-B} prefix is to use
5253 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5254 Variables}.
5255
5256 As a special kludge, if the path provided by @option{-B} is
5257 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5258 9, then it will be replaced by @file{[dir/]include}.  This is to help
5259 with boot-strapping the compiler.
5260
5261 @item -specs=@var{file}
5262 @opindex specs
5263 Process @var{file} after the compiler reads in the standard @file{specs}
5264 file, in order to override the defaults that the @file{gcc} driver
5265 program uses when determining what switches to pass to @file{cc1},
5266 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5267 @option{-specs=@var{file}} can be specified on the command line, and they
5268 are processed in order, from left to right.
5269 @end table
5270
5271 @c man end
5272
5273 @node Spec Files
5274 @section Specifying subprocesses and the switches to pass to them
5275 @cindex Spec Files
5276
5277 @command{gcc} is a driver program.  It performs its job by invoking a
5278 sequence of other programs to do the work of compiling, assembling and
5279 linking.  GCC interprets its command-line parameters and uses these to
5280 deduce which programs it should invoke, and which command-line options
5281 it ought to place on their command lines.  This behavior is controlled
5282 by @dfn{spec strings}.  In most cases there is one spec string for each
5283 program that GCC can invoke, but a few programs have multiple spec
5284 strings to control their behavior.  The spec strings built into GCC can
5285 be overridden by using the @option{-specs=} command-line switch to specify
5286 a spec file.
5287
5288 @dfn{Spec files} are plaintext files that are used to construct spec
5289 strings.  They consist of a sequence of directives separated by blank
5290 lines.  The type of directive is determined by the first non-whitespace
5291 character on the line and it can be one of the following:
5292
5293 @table @code
5294 @item %@var{command}
5295 Issues a @var{command} to the spec file processor.  The commands that can
5296 appear here are:
5297
5298 @table @code
5299 @item %include <@var{file}>
5300 @cindex %include
5301 Search for @var{file} and insert its text at the current point in the
5302 specs file.
5303
5304 @item %include_noerr <@var{file}>
5305 @cindex %include_noerr
5306 Just like @samp{%include}, but do not generate an error message if the include
5307 file cannot be found.
5308
5309 @item %rename @var{old_name} @var{new_name}
5310 @cindex %rename
5311 Rename the spec string @var{old_name} to @var{new_name}.
5312
5313 @end table
5314
5315 @item *[@var{spec_name}]:
5316 This tells the compiler to create, override or delete the named spec
5317 string.  All lines after this directive up to the next directive or
5318 blank line are considered to be the text for the spec string.  If this
5319 results in an empty string then the spec will be deleted.  (Or, if the
5320 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5321 does not currently exist a new spec will be created.  If the spec does
5322 exist then its contents will be overridden by the text of this
5323 directive, unless the first character of that text is the @samp{+}
5324 character, in which case the text will be appended to the spec.
5325
5326 @item [@var{suffix}]:
5327 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5328 and up to the next directive or blank line are considered to make up the
5329 spec string for the indicated suffix.  When the compiler encounters an
5330 input file with the named suffix, it will processes the spec string in
5331 order to work out how to compile that file.  For example:
5332
5333 @smallexample
5334 .ZZ:
5335 z-compile -input %i
5336 @end smallexample
5337
5338 This says that any input file whose name ends in @samp{.ZZ} should be
5339 passed to the program @samp{z-compile}, which should be invoked with the
5340 command-line switch @option{-input} and with the result of performing the
5341 @samp{%i} substitution.  (See below.)
5342
5343 As an alternative to providing a spec string, the text that follows a
5344 suffix directive can be one of the following:
5345
5346 @table @code
5347 @item @@@var{language}
5348 This says that the suffix is an alias for a known @var{language}.  This is
5349 similar to using the @option{-x} command-line switch to GCC to specify a
5350 language explicitly.  For example:
5351
5352 @smallexample
5353 .ZZ:
5354 @@c++
5355 @end smallexample
5356
5357 Says that .ZZ files are, in fact, C++ source files.
5358
5359 @item #@var{name}
5360 This causes an error messages saying:
5361
5362 @smallexample
5363 @var{name} compiler not installed on this system.
5364 @end smallexample
5365 @end table
5366
5367 GCC already has an extensive list of suffixes built into it.
5368 This directive will add an entry to the end of the list of suffixes, but
5369 since the list is searched from the end backwards, it is effectively
5370 possible to override earlier entries using this technique.
5371
5372 @end table
5373
5374 GCC has the following spec strings built into it.  Spec files can
5375 override these strings or create their own.  Note that individual
5376 targets can also add their own spec strings to this list.
5377
5378 @smallexample
5379 asm          Options to pass to the assembler
5380 asm_final    Options to pass to the assembler post-processor
5381 cpp          Options to pass to the C preprocessor
5382 cc1          Options to pass to the C compiler
5383 cc1plus      Options to pass to the C++ compiler
5384 endfile      Object files to include at the end of the link
5385 link         Options to pass to the linker
5386 lib          Libraries to include on the command line to the linker
5387 libgcc       Decides which GCC support library to pass to the linker
5388 linker       Sets the name of the linker
5389 predefines   Defines to be passed to the C preprocessor
5390 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5391              by default
5392 startfile    Object files to include at the start of the link
5393 @end smallexample
5394
5395 Here is a small example of a spec file:
5396
5397 @smallexample
5398 %rename lib                 old_lib
5399
5400 *lib:
5401 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5402 @end smallexample
5403
5404 This example renames the spec called @samp{lib} to @samp{old_lib} and
5405 then overrides the previous definition of @samp{lib} with a new one.
5406 The new definition adds in some extra command-line options before
5407 including the text of the old definition.
5408
5409 @dfn{Spec strings} are a list of command-line options to be passed to their
5410 corresponding program.  In addition, the spec strings can contain
5411 @samp{%}-prefixed sequences to substitute variable text or to
5412 conditionally insert text into the command line.  Using these constructs
5413 it is possible to generate quite complex command lines.
5414
5415 Here is a table of all defined @samp{%}-sequences for spec
5416 strings.  Note that spaces are not generated automatically around the
5417 results of expanding these sequences.  Therefore you can concatenate them
5418 together or combine them with constant text in a single argument.
5419
5420 @table @code
5421 @item %%
5422 Substitute one @samp{%} into the program name or argument.
5423
5424 @item %i
5425 Substitute the name of the input file being processed.
5426
5427 @item %b
5428 Substitute the basename of the input file being processed.
5429 This is the substring up to (and not including) the last period
5430 and not including the directory.
5431
5432 @item %B
5433 This is the same as @samp{%b}, but include the file suffix (text after
5434 the last period).
5435
5436 @item %d
5437 Marks the argument containing or following the @samp{%d} as a
5438 temporary file name, so that that file will be deleted if GCC exits
5439 successfully.  Unlike @samp{%g}, this contributes no text to the
5440 argument.
5441
5442 @item %g@var{suffix}
5443 Substitute a file name that has suffix @var{suffix} and is chosen
5444 once per compilation, and mark the argument in the same way as
5445 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5446 name is now chosen in a way that is hard to predict even when previously
5447 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5448 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5449 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5450 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5451 was simply substituted with a file name chosen once per compilation,
5452 without regard to any appended suffix (which was therefore treated
5453 just like ordinary text), making such attacks more likely to succeed.
5454
5455 @item %u@var{suffix}
5456 Like @samp{%g}, but generates a new temporary file name even if
5457 @samp{%u@var{suffix}} was already seen.
5458
5459 @item %U@var{suffix}
5460 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5461 new one if there is no such last file name.  In the absence of any
5462 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5463 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5464 would involve the generation of two distinct file names, one
5465 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5466 simply substituted with a file name chosen for the previous @samp{%u},
5467 without regard to any appended suffix.
5468
5469 @item %j@var{suffix}
5470 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5471 writable, and if save-temps is off; otherwise, substitute the name
5472 of a temporary file, just like @samp{%u}.  This temporary file is not
5473 meant for communication between processes, but rather as a junk
5474 disposal mechanism.
5475
5476 @item %|@var{suffix}
5477 @itemx %m@var{suffix}
5478 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5479 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5480 all.  These are the two most common ways to instruct a program that it
5481 should read from standard input or write to standard output.  If you
5482 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5483 construct: see for example @file{f/lang-specs.h}.
5484
5485 @item %.@var{SUFFIX}
5486 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5487 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5488 terminated by the next space or %.
5489
5490 @item %w
5491 Marks the argument containing or following the @samp{%w} as the
5492 designated output file of this compilation.  This puts the argument
5493 into the sequence of arguments that @samp{%o} will substitute later.
5494
5495 @item %o
5496 Substitutes the names of all the output files, with spaces
5497 automatically placed around them.  You should write spaces
5498 around the @samp{%o} as well or the results are undefined.
5499 @samp{%o} is for use in the specs for running the linker.
5500 Input files whose names have no recognized suffix are not compiled
5501 at all, but they are included among the output files, so they will
5502 be linked.
5503
5504 @item %O
5505 Substitutes the suffix for object files.  Note that this is
5506 handled specially when it immediately follows @samp{%g, %u, or %U},
5507 because of the need for those to form complete file names.  The
5508 handling is such that @samp{%O} is treated exactly as if it had already
5509 been substituted, except that @samp{%g, %u, and %U} do not currently
5510 support additional @var{suffix} characters following @samp{%O} as they would
5511 following, for example, @samp{.o}.
5512
5513 @item %p
5514 Substitutes the standard macro predefinitions for the
5515 current target machine.  Use this when running @code{cpp}.
5516
5517 @item %P
5518 Like @samp{%p}, but puts @samp{__} before and after the name of each
5519 predefined macro, except for macros that start with @samp{__} or with
5520 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5521 C@.
5522
5523 @item %I
5524 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5525 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5526 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5527 as necessary.
5528
5529 @item %s
5530 Current argument is the name of a library or startup file of some sort.
5531 Search for that file in a standard list of directories and substitute
5532 the full name found.
5533
5534 @item %e@var{str}
5535 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5536 Use this when inconsistent options are detected.
5537
5538 @item %(@var{name})
5539 Substitute the contents of spec string @var{name} at this point.
5540
5541 @item %[@var{name}]
5542 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5543
5544 @item %x@{@var{option}@}
5545 Accumulate an option for @samp{%X}.
5546
5547 @item %X
5548 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5549 spec string.
5550
5551 @item %Y
5552 Output the accumulated assembler options specified by @option{-Wa}.
5553
5554 @item %Z
5555 Output the accumulated preprocessor options specified by @option{-Wp}.
5556
5557 @item %a
5558 Process the @code{asm} spec.  This is used to compute the
5559 switches to be passed to the assembler.
5560
5561 @item %A
5562 Process the @code{asm_final} spec.  This is a spec string for
5563 passing switches to an assembler post-processor, if such a program is
5564 needed.
5565
5566 @item %l
5567 Process the @code{link} spec.  This is the spec for computing the
5568 command line passed to the linker.  Typically it will make use of the
5569 @samp{%L %G %S %D and %E} sequences.
5570
5571 @item %D
5572 Dump out a @option{-L} option for each directory that GCC believes might
5573 contain startup files.  If the target supports multilibs then the
5574 current multilib directory will be prepended to each of these paths.
5575
5576 @item %M
5577 Output the multilib directory with directory separators replaced with
5578 @samp{_}.  If multilib directories are not set, or the multilib directory is
5579 @file{.} then this option emits nothing.
5580
5581 @item %L
5582 Process the @code{lib} spec.  This is a spec string for deciding which
5583 libraries should be included on the command line to the linker.
5584
5585 @item %G
5586 Process the @code{libgcc} spec.  This is a spec string for deciding
5587 which GCC support library should be included on the command line to the linker.
5588
5589 @item %S
5590 Process the @code{startfile} spec.  This is a spec for deciding which
5591 object files should be the first ones passed to the linker.  Typically
5592 this might be a file named @file{crt0.o}.
5593
5594 @item %E
5595 Process the @code{endfile} spec.  This is a spec string that specifies
5596 the last object files that will be passed to the linker.
5597
5598 @item %C
5599 Process the @code{cpp} spec.  This is used to construct the arguments
5600 to be passed to the C preprocessor.
5601
5602 @item %c
5603 Process the @code{signed_char} spec.  This is intended to be used
5604 to tell cpp whether a char is signed.  It typically has the definition:
5605 @smallexample
5606 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5607 @end smallexample
5608
5609 @item %1
5610 Process the @code{cc1} spec.  This is used to construct the options to be
5611 passed to the actual C compiler (@samp{cc1}).
5612
5613 @item %2
5614 Process the @code{cc1plus} spec.  This is used to construct the options to be
5615 passed to the actual C++ compiler (@samp{cc1plus}).
5616
5617 @item %*
5618 Substitute the variable part of a matched option.  See below.
5619 Note that each comma in the substituted string is replaced by
5620 a single space.
5621
5622 @item %<@code{S}
5623 Remove all occurrences of @code{-S} from the command line.  Note---this
5624 command is position dependent.  @samp{%} commands in the spec string
5625 before this one will see @code{-S}, @samp{%} commands in the spec string
5626 after this one will not.
5627
5628 @item %:@var{function}(@var{args})
5629 Call the named function @var{function}, passing it @var{args}.
5630 @var{args} is first processed as a nested spec string, then split
5631 into an argument vector in the usual fashion.  The function returns
5632 a string which is processed as if it had appeared literally as part
5633 of the current spec.
5634
5635 The following built-in spec functions are provided:
5636
5637 @table @code
5638 @item @code{if-exists}
5639 The @code{if-exists} spec function takes one argument, an absolute
5640 pathname to a file.  If the file exists, @code{if-exists} returns the
5641 pathname.  Here is a small example of its usage:
5642
5643 @smallexample
5644 *startfile:
5645 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5646 @end smallexample
5647
5648 @item @code{if-exists-else}
5649 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5650 spec function, except that it takes two arguments.  The first argument is
5651 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5652 returns the pathname.  If it does not exist, it returns the second argument.
5653 This way, @code{if-exists-else} can be used to select one file or another,
5654 based on the existence of the first.  Here is a small example of its usage:
5655
5656 @smallexample 
5657 *startfile:
5658 crt0%O%s %:if-exists(crti%O%s) \
5659 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5660 @end smallexample
5661 @end table 
5662
5663 @item %@{@code{S}@}
5664 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5665 If that switch was not specified, this substitutes nothing.  Note that
5666 the leading dash is omitted when specifying this option, and it is
5667 automatically inserted if the substitution is performed.  Thus the spec
5668 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5669 and would output the command line option @option{-foo}.
5670
5671 @item %W@{@code{S}@}
5672 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5673 deleted on failure.
5674
5675 @item %@{@code{S}*@}
5676 Substitutes all the switches specified to GCC whose names start
5677 with @code{-S}, but which also take an argument.  This is used for
5678 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5679 GCC considers @option{-o foo} as being
5680 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5681 text, including the space.  Thus two arguments would be generated.
5682
5683 @item %@{@code{S}*&@code{T}*@}
5684 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5685 (the order of @code{S} and @code{T} in the spec is not significant).
5686 There can be any number of ampersand-separated variables; for each the
5687 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5688
5689 @item %@{@code{S}:@code{X}@}
5690 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5691
5692 @item %@{!@code{S}:@code{X}@}
5693 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5694
5695 @item %@{@code{S}*:@code{X}@}
5696 Substitutes @code{X} if one or more switches whose names start with
5697 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5698 once, no matter how many such switches appeared.  However, if @code{%*}
5699 appears somewhere in @code{X}, then @code{X} will be substituted once
5700 for each matching switch, with the @code{%*} replaced by the part of
5701 that switch that matched the @code{*}.
5702
5703 @item %@{.@code{S}:@code{X}@}
5704 Substitutes @code{X}, if processing a file with suffix @code{S}.
5705
5706 @item %@{!.@code{S}:@code{X}@}
5707 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5708
5709 @item %@{@code{S}|@code{P}:@code{X}@}
5710 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5711 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5712 although they have a stronger binding than the @samp{|}.  If @code{%*}
5713 appears in @code{X}, all of the alternatives must be starred, and only
5714 the first matching alternative is substituted.
5715
5716 For example, a spec string like this:
5717
5718 @smallexample
5719 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5720 @end smallexample
5721
5722 will output the following command-line options from the following input
5723 command-line options:
5724
5725 @smallexample
5726 fred.c        -foo -baz
5727 jim.d         -bar -boggle
5728 -d fred.c     -foo -baz -boggle
5729 -d jim.d      -bar -baz -boggle
5730 @end smallexample
5731
5732 @item %@{S:X; T:Y; :D@}
5733
5734 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5735 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5736 be as many clauses as you need.  This may be combined with @code{.}, 
5737 @code{!}, @code{|}, and @code{*} as needed.
5738
5739
5740 @end table
5741
5742 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5743 construct may contain other nested @samp{%} constructs or spaces, or
5744 even newlines.  They are processed as usual, as described above.
5745 Trailing white space in @code{X} is ignored.  White space may also
5746 appear anywhere on the left side of the colon in these constructs,
5747 except between @code{.} or @code{*} and the corresponding word.
5748
5749 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5750 handled specifically in these constructs.  If another value of
5751 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5752 @option{-W} switch is found later in the command line, the earlier
5753 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5754 just one letter, which passes all matching options.
5755
5756 The character @samp{|} at the beginning of the predicate text is used to
5757 indicate that a command should be piped to the following command, but
5758 only if @option{-pipe} is specified.
5759
5760 It is built into GCC which switches take arguments and which do not.
5761 (You might think it would be useful to generalize this to allow each
5762 compiler's spec to say which switches take arguments.  But this cannot
5763 be done in a consistent fashion.  GCC cannot even decide which input
5764 files have been specified without knowing which switches take arguments,
5765 and it must know which input files to compile in order to tell which
5766 compilers to run).
5767
5768 GCC also knows implicitly that arguments starting in @option{-l} are to be
5769 treated as compiler output files, and passed to the linker in their
5770 proper position among the other output files.
5771
5772 @c man begin OPTIONS
5773
5774 @node Target Options
5775 @section Specifying Target Machine and Compiler Version
5776 @cindex target options
5777 @cindex cross compiling
5778 @cindex specifying machine version
5779 @cindex specifying compiler version and target machine
5780 @cindex compiler version, specifying
5781 @cindex target machine, specifying
5782
5783 The usual way to run GCC is to run the executable called @file{gcc}, or
5784 @file{<machine>-gcc} when cross-compiling, or
5785 @file{<machine>-gcc-<version>} to run a version other than the one that
5786 was installed last.  Sometimes this is inconvenient, so GCC provides
5787 options that will switch to another cross-compiler or version.
5788
5789 @table @gcctabopt
5790 @item -b @var{machine}
5791 @opindex b
5792 The argument @var{machine} specifies the target machine for compilation.
5793
5794 The value to use for @var{machine} is the same as was specified as the
5795 machine type when configuring GCC as a cross-compiler.  For
5796 example, if a cross-compiler was configured with @samp{configure
5797 i386v}, meaning to compile for an 80386 running System V, then you
5798 would specify @option{-b i386v} to run that cross compiler.
5799
5800 @item -V @var{version}
5801 @opindex V
5802 The argument @var{version} specifies which version of GCC to run.
5803 This is useful when multiple versions are installed.  For example,
5804 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5805 @end table
5806
5807 The @option{-V} and @option{-b} options work by running the
5808 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5809 use them if you can just run that directly.
5810
5811 @node Submodel Options
5812 @section Hardware Models and Configurations
5813 @cindex submodel options
5814 @cindex specifying hardware config
5815 @cindex hardware models and configurations, specifying
5816 @cindex machine dependent options
5817
5818 Earlier we discussed the standard option @option{-b} which chooses among
5819 different installed compilers for completely different target
5820 machines, such as VAX vs.@: 68000 vs.@: 80386.
5821
5822 In addition, each of these target machine types can have its own
5823 special options, starting with @samp{-m}, to choose among various
5824 hardware models or configurations---for example, 68010 vs 68020,
5825 floating coprocessor or none.  A single installed version of the
5826 compiler can compile for any model or configuration, according to the
5827 options specified.
5828
5829 Some configurations of the compiler also support additional special
5830 options, usually for compatibility with other compilers on the same
5831 platform.
5832
5833 These options are defined by the macro @code{TARGET_SWITCHES} in the
5834 machine description.  The default for the options is also defined by
5835 that macro, which enables you to change the defaults.
5836
5837 @menu
5838 * M680x0 Options::
5839 * M68hc1x Options::
5840 * VAX Options::
5841 * SPARC Options::
5842 * ARM Options::
5843 * MN10200 Options::
5844 * MN10300 Options::
5845 * M32R/D Options::
5846 * M88K Options::
5847 * RS/6000 and PowerPC Options::
5848 * Darwin Options::
5849 * RT Options::
5850 * MIPS Options::
5851 * i386 and x86-64 Options::
5852 * HPPA Options::
5853 * Intel 960 Options::
5854 * DEC Alpha Options::
5855 * DEC Alpha/VMS Options::
5856 * H8/300 Options::
5857 * SH Options::
5858 * System V Options::
5859 * TMS320C3x/C4x Options::
5860 * V850 Options::
5861 * ARC Options::
5862 * NS32K Options::
5863 * AVR Options::
5864 * MCore Options::
5865 * IA-64 Options::
5866 * D30V Options::
5867 * S/390 and zSeries Options::
5868 * CRIS Options::
5869 * MMIX Options::
5870 * PDP-11 Options::
5871 * Xstormy16 Options::
5872 * Xtensa Options::
5873 * FRV Options::
5874 @end menu
5875
5876 @node M680x0 Options
5877 @subsection M680x0 Options
5878 @cindex M680x0 options
5879
5880 These are the @samp{-m} options defined for the 68000 series.  The default
5881 values for these options depends on which style of 68000 was selected when
5882 the compiler was configured; the defaults for the most common choices are
5883 given below.
5884
5885 @table @gcctabopt
5886 @item -m68000
5887 @itemx -mc68000
5888 @opindex m68000
5889 @opindex mc68000
5890 Generate output for a 68000.  This is the default
5891 when the compiler is configured for 68000-based systems.
5892
5893 Use this option for microcontrollers with a 68000 or EC000 core,
5894 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5895
5896 @item -m68020
5897 @itemx -mc68020
5898 @opindex m68020
5899 @opindex mc68020
5900 Generate output for a 68020.  This is the default
5901 when the compiler is configured for 68020-based systems.
5902
5903 @item -m68881
5904 @opindex m68881
5905 Generate output containing 68881 instructions for floating point.
5906 This is the default for most 68020 systems unless @option{--nfp} was
5907 specified when the compiler was configured.
5908
5909 @item -m68030
5910 @opindex m68030
5911 Generate output for a 68030.  This is the default when the compiler is
5912 configured for 68030-based systems.
5913
5914 @item -m68040
5915 @opindex m68040
5916 Generate output for a 68040.  This is the default when the compiler is
5917 configured for 68040-based systems.
5918
5919 This option inhibits the use of 68881/68882 instructions that have to be
5920 emulated by software on the 68040.  Use this option if your 68040 does not
5921 have code to emulate those instructions.
5922
5923 @item -m68060
5924 @opindex m68060
5925 Generate output for a 68060.  This is the default when the compiler is
5926 configured for 68060-based systems.
5927
5928 This option inhibits the use of 68020 and 68881/68882 instructions that
5929 have to be emulated by software on the 68060.  Use this option if your 68060
5930 does not have code to emulate those instructions.
5931
5932 @item -mcpu32
5933 @opindex mcpu32
5934 Generate output for a CPU32.  This is the default
5935 when the compiler is configured for CPU32-based systems.
5936
5937 Use this option for microcontrollers with a
5938 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5939 68336, 68340, 68341, 68349 and 68360.
5940
5941 @item -m5200
5942 @opindex m5200
5943 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5944 when the compiler is configured for 520X-based systems.
5945
5946 Use this option for microcontroller with a 5200 core, including
5947 the MCF5202, MCF5203, MCF5204 and MCF5202.
5948
5949
5950 @item -m68020-40
5951 @opindex m68020-40
5952 Generate output for a 68040, without using any of the new instructions.
5953 This results in code which can run relatively efficiently on either a
5954 68020/68881 or a 68030 or a 68040.  The generated code does use the
5955 68881 instructions that are emulated on the 68040.
5956
5957 @item -m68020-60
5958 @opindex m68020-60
5959 Generate output for a 68060, without using any of the new instructions.
5960 This results in code which can run relatively efficiently on either a
5961 68020/68881 or a 68030 or a 68040.  The generated code does use the
5962 68881 instructions that are emulated on the 68060.
5963
5964 @item -msoft-float
5965 @opindex msoft-float
5966 Generate output containing library calls for floating point.
5967 @strong{Warning:} the requisite libraries are not available for all m68k
5968 targets.  Normally the facilities of the machine's usual C compiler are
5969 used, but this can't be done directly in cross-compilation.  You must
5970 make your own arrangements to provide suitable library functions for
5971 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5972 @samp{m68k-*-coff} do provide software floating point support.
5973
5974 @item -mshort
5975 @opindex mshort
5976 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5977
5978 @item -mnobitfield
5979 @opindex mnobitfield
5980 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5981 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5982
5983 @item -mbitfield
5984 @opindex mbitfield
5985 Do use the bit-field instructions.  The @option{-m68020} option implies
5986 @option{-mbitfield}.  This is the default if you use a configuration
5987 designed for a 68020.
5988
5989 @item -mrtd
5990 @opindex mrtd
5991 Use a different function-calling convention, in which functions
5992 that take a fixed number of arguments return with the @code{rtd}
5993 instruction, which pops their arguments while returning.  This
5994 saves one instruction in the caller since there is no need to pop
5995 the arguments there.
5996
5997 This calling convention is incompatible with the one normally
5998 used on Unix, so you cannot use it if you need to call libraries
5999 compiled with the Unix compiler.
6000
6001 Also, you must provide function prototypes for all functions that
6002 take variable numbers of arguments (including @code{printf});
6003 otherwise incorrect code will be generated for calls to those
6004 functions.
6005
6006 In addition, seriously incorrect code will result if you call a
6007 function with too many arguments.  (Normally, extra arguments are
6008 harmlessly ignored.)
6009
6010 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6011 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6012
6013 @item -malign-int
6014 @itemx -mno-align-int
6015 @opindex malign-int
6016 @opindex mno-align-int
6017 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6018 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6019 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6020 Aligning variables on 32-bit boundaries produces code that runs somewhat
6021 faster on processors with 32-bit busses at the expense of more memory.
6022
6023 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6024 align structures containing the above types  differently than
6025 most published application binary interface specifications for the m68k.
6026
6027 @item -mpcrel
6028 @opindex mpcrel
6029 Use the pc-relative addressing mode of the 68000 directly, instead of
6030 using a global offset table.  At present, this option implies @option{-fpic},
6031 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6032 not presently supported with @option{-mpcrel}, though this could be supported for
6033 68020 and higher processors.
6034
6035 @item -mno-strict-align
6036 @itemx -mstrict-align
6037 @opindex mno-strict-align
6038 @opindex mstrict-align
6039 Do not (do) assume that unaligned memory references will be handled by
6040 the system.
6041
6042 @item -msep-data
6043 Generate code that allows the data segment to be located in a different
6044 area of memory from the text segment.  This allows for execute in place in
6045 an environment without virtual memory management.  This option implies -fPIC.
6046
6047 @item -mno-sep-data
6048 Generate code that assumes that the data segment follows the text segment.
6049 This is the default.
6050
6051 @item -mid-shared-library
6052 Generate code that supports shared libraries via the library ID method.
6053 This allows for execute in place and shared libraries in an environment
6054 without virtual memory management.  This option implies -fPIC.
6055
6056 @item -mno-id-shared-library
6057 Generate code that doesn't assume ID based shared libraries are being used.
6058 This is the default.
6059
6060 @item -mshared-library-id=n
6061 Specified the identification number of the ID based shared library being
6062 compiled.  Specifying a value of 0 will generate more compact code, specifying
6063 other values will force the allocation of that number to the current
6064 library but is no more space or time efficient than omitting this option.
6065
6066 @end table
6067
6068 @node M68hc1x Options
6069 @subsection M68hc1x Options
6070 @cindex M68hc1x options
6071
6072 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6073 microcontrollers.  The default values for these options depends on
6074 which style of microcontroller was selected when the compiler was configured;
6075 the defaults for the most common choices are given below.
6076
6077 @table @gcctabopt
6078 @item -m6811
6079 @itemx -m68hc11
6080 @opindex m6811
6081 @opindex m68hc11
6082 Generate output for a 68HC11.  This is the default
6083 when the compiler is configured for 68HC11-based systems.
6084
6085 @item -m6812
6086 @itemx -m68hc12
6087 @opindex m6812
6088 @opindex m68hc12
6089 Generate output for a 68HC12.  This is the default
6090 when the compiler is configured for 68HC12-based systems.
6091
6092 @item -m68S12
6093 @itemx -m68hcs12
6094 @opindex m68S12
6095 @opindex m68hcs12
6096 Generate output for a 68HCS12.  
6097
6098 @item -mauto-incdec
6099 @opindex mauto-incdec
6100 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6101 addressing modes.
6102
6103 @item -minmax
6104 @itemx -nominmax
6105 @opindex minmax
6106 @opindex mnominmax
6107 Enable the use of 68HC12 min and max instructions.
6108
6109 @item -mlong-calls
6110 @itemx -mno-long-calls
6111 @opindex mlong-calls
6112 @opindex mno-long-calls
6113 Treat all calls as being far away (near).  If calls are assumed to be
6114 far away, the compiler will use the @code{call} instruction to
6115 call a function and the @code{rtc} instruction for returning.
6116
6117 @item -mshort
6118 @opindex mshort
6119 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6120
6121 @item -msoft-reg-count=@var{count}
6122 @opindex msoft-reg-count
6123 Specify the number of pseudo-soft registers which are used for the
6124 code generation.  The maximum number is 32.  Using more pseudo-soft
6125 register may or may not result in better code depending on the program.
6126 The default is 4 for 68HC11 and 2 for 68HC12.
6127
6128 @end table
6129
6130 @node VAX Options
6131 @subsection VAX Options
6132 @cindex VAX options
6133
6134 These @samp{-m} options are defined for the VAX:
6135
6136 @table @gcctabopt
6137 @item -munix
6138 @opindex munix
6139 Do not output certain jump instructions (@code{aobleq} and so on)
6140 that the Unix assembler for the VAX cannot handle across long
6141 ranges.
6142
6143 @item -mgnu
6144 @opindex mgnu
6145 Do output those jump instructions, on the assumption that you
6146 will assemble with the GNU assembler.
6147
6148 @item -mg
6149 @opindex mg
6150 Output code for g-format floating point numbers instead of d-format.
6151 @end table
6152
6153 @node SPARC Options
6154 @subsection SPARC Options
6155 @cindex SPARC options
6156
6157 These @samp{-m} switches are supported on the SPARC:
6158
6159 @table @gcctabopt
6160 @item -mno-app-regs
6161 @itemx -mapp-regs
6162 @opindex mno-app-regs
6163 @opindex mapp-regs
6164 Specify @option{-mapp-regs} to generate output using the global registers
6165 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6166 is the default.
6167
6168 To be fully SVR4 ABI compliant at the cost of some performance loss,
6169 specify @option{-mno-app-regs}.  You should compile libraries and system
6170 software with this option.
6171
6172 @item -mfpu
6173 @itemx -mhard-float
6174 @opindex mfpu
6175 @opindex mhard-float
6176 Generate output containing floating point instructions.  This is the
6177 default.
6178
6179 @item -mno-fpu
6180 @itemx -msoft-float
6181 @opindex mno-fpu
6182 @opindex msoft-float
6183 Generate output containing library calls for floating point.
6184 @strong{Warning:} the requisite libraries are not available for all SPARC
6185 targets.  Normally the facilities of the machine's usual C compiler are
6186 used, but this cannot be done directly in cross-compilation.  You must make
6187 your own arrangements to provide suitable library functions for
6188 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6189 @samp{sparclite-*-*} do provide software floating point support.
6190
6191 @option{-msoft-float} changes the calling convention in the output file;
6192 therefore, it is only useful if you compile @emph{all} of a program with
6193 this option.  In particular, you need to compile @file{libgcc.a}, the
6194 library that comes with GCC, with @option{-msoft-float} in order for
6195 this to work.
6196
6197 @item -mhard-quad-float
6198 @opindex mhard-quad-float
6199 Generate output containing quad-word (long double) floating point
6200 instructions.
6201
6202 @item -msoft-quad-float
6203 @opindex msoft-quad-float
6204 Generate output containing library calls for quad-word (long double)
6205 floating point instructions.  The functions called are those specified
6206 in the SPARC ABI@.  This is the default.
6207
6208 As of this writing, there are no sparc implementations that have hardware
6209 support for the quad-word floating point instructions.  They all invoke
6210 a trap handler for one of these instructions, and then the trap handler
6211 emulates the effect of the instruction.  Because of the trap handler overhead,
6212 this is much slower than calling the ABI library routines.  Thus the
6213 @option{-msoft-quad-float} option is the default.
6214
6215 @item -mno-flat
6216 @itemx -mflat
6217 @opindex mno-flat
6218 @opindex mflat
6219 With @option{-mflat}, the compiler does not generate save/restore instructions
6220 and will use a ``flat'' or single register window calling convention.
6221 This model uses %i7 as the frame pointer and is compatible with the normal
6222 register window model.  Code from either may be intermixed.
6223 The local registers and the input registers (0--5) are still treated as
6224 ``call saved'' registers and will be saved on the stack as necessary.
6225
6226 With @option{-mno-flat} (the default), the compiler emits save/restore
6227 instructions (except for leaf functions) and is the normal mode of operation.
6228
6229 @item -mno-unaligned-doubles
6230 @itemx -munaligned-doubles
6231 @opindex mno-unaligned-doubles
6232 @opindex munaligned-doubles
6233 Assume that doubles have 8 byte alignment.  This is the default.
6234
6235 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6236 alignment only if they are contained in another type, or if they have an
6237 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6238 Specifying this option avoids some rare compatibility problems with code
6239 generated by other compilers.  It is not the default because it results
6240 in a performance loss, especially for floating point code.
6241
6242 @item -mno-faster-structs
6243 @itemx -mfaster-structs
6244 @opindex mno-faster-structs
6245 @opindex mfaster-structs
6246 With @option{-mfaster-structs}, the compiler assumes that structures
6247 should have 8 byte alignment.  This enables the use of pairs of
6248 @code{ldd} and @code{std} instructions for copies in structure
6249 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6250 However, the use of this changed alignment directly violates the SPARC
6251 ABI@.  Thus, it's intended only for use on targets where the developer
6252 acknowledges that their resulting code will not be directly in line with
6253 the rules of the ABI@.
6254
6255 @item -mimpure-text
6256 @opindex mimpure-text
6257 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6258 the compiler to not pass @option{-z text} to the linker when linking a
6259 shared object.  Using this option, you can link position-dependent
6260 code into a shared object.  
6261
6262 @option{-mimpure-text} suppresses the ``relocations remain against
6263 allocatable but non-writable sections'' linker error message.
6264 However, the necessary relocations will trigger copy-on-write, and the
6265 shared object is not actually shared across processes.  Instead of
6266 using @option{-mimpure-text}, you should compile all source code with
6267 @option{-fpic} or @option{-fPIC}.
6268
6269 This option is only available on SunOS and Solaris.
6270
6271 @item -mv8
6272 @itemx -msparclite
6273 @opindex mv8
6274 @opindex msparclite
6275 These two options select variations on the SPARC architecture.
6276
6277 By default (unless specifically configured for the Fujitsu SPARClite),
6278 GCC generates code for the v7 variant of the SPARC architecture.
6279
6280 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6281 code is that the compiler emits the integer multiply and integer
6282 divide instructions which exist in SPARC v8 but not in SPARC v7.
6283
6284 @option{-msparclite} will give you SPARClite code.  This adds the integer
6285 multiply, integer divide step and scan (@code{ffs}) instructions which
6286 exist in SPARClite but not in SPARC v7.
6287
6288 These options are deprecated and will be deleted in a future GCC release.
6289 They have been replaced with @option{-mcpu=xxx}.
6290
6291 @item -mcypress
6292 @itemx -msupersparc
6293 @opindex mcypress
6294 @opindex msupersparc
6295 These two options select the processor for which the code is optimized.
6296
6297 With @option{-mcypress} (the default), the compiler optimizes code for the
6298 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6299 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6300
6301 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6302 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6303 of the full SPARC v8 instruction set.
6304
6305 These options are deprecated and will be deleted in a future GCC release.
6306 They have been replaced with @option{-mcpu=xxx}.
6307
6308 @item -mcpu=@var{cpu_type}
6309 @opindex mcpu
6310 Set the instruction set, register set, and instruction scheduling parameters
6311 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6312 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6313 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6314 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6315 @samp{ultrasparc3}.
6316
6317 Default instruction scheduling parameters are used for values that select
6318 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6319 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6320
6321 Here is a list of each supported architecture and their supported
6322 implementations.
6323
6324 @smallexample
6325     v7:             cypress
6326     v8:             supersparc, hypersparc
6327     sparclite:      f930, f934, sparclite86x
6328     sparclet:       tsc701
6329     v9:             ultrasparc, ultrasparc3
6330 @end smallexample
6331
6332 @item -mtune=@var{cpu_type}
6333 @opindex mtune
6334 Set the instruction scheduling parameters for machine type
6335 @var{cpu_type}, but do not set the instruction set or register set that the
6336 option @option{-mcpu=@var{cpu_type}} would.
6337
6338 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6339 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6340 that select a particular cpu implementation.  Those are @samp{cypress},
6341 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6342 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6343 @samp{ultrasparc3}.
6344
6345 @end table
6346
6347 These @samp{-m} switches are supported in addition to the above
6348 on the SPARCLET processor.
6349
6350 @table @gcctabopt
6351 @item -mlittle-endian
6352 @opindex mlittle-endian
6353 Generate code for a processor running in little-endian mode.
6354
6355 @item -mlive-g0
6356 @opindex mlive-g0
6357 Treat register @code{%g0} as a normal register.
6358 GCC will continue to clobber it as necessary but will not assume
6359 it always reads as 0.
6360
6361 @item -mbroken-saverestore
6362 @opindex mbroken-saverestore
6363 Generate code that does not use non-trivial forms of the @code{save} and
6364 @code{restore} instructions.  Early versions of the SPARCLET processor do
6365 not correctly handle @code{save} and @code{restore} instructions used with
6366 arguments.  They correctly handle them used without arguments.  A @code{save}
6367 instruction used without arguments increments the current window pointer
6368 but does not allocate a new stack frame.  It is assumed that the window
6369 overflow trap handler will properly handle this case as will interrupt
6370 handlers.
6371 @end table
6372
6373 These @samp{-m} switches are supported in addition to the above
6374 on SPARC V9 processors in 64-bit environments.
6375
6376 @table @gcctabopt
6377 @item -mlittle-endian
6378 @opindex mlittle-endian
6379 Generate code for a processor running in little-endian mode. It is only
6380 available for a few configurations and most notably not on Solaris.
6381
6382 @item -m32
6383 @itemx -m64
6384 @opindex m32
6385 @opindex m64
6386 Generate code for a 32-bit or 64-bit environment.
6387 The 32-bit environment sets int, long and pointer to 32 bits.
6388 The 64-bit environment sets int to 32 bits and long and pointer
6389 to 64 bits.
6390
6391 @item -mcmodel=medlow
6392 @opindex mcmodel=medlow
6393 Generate code for the Medium/Low code model: the program must be linked
6394 in the low 32 bits of the address space.  Pointers are 64 bits.
6395 Programs can be statically or dynamically linked.
6396
6397 @item -mcmodel=medmid
6398 @opindex mcmodel=medmid
6399 Generate code for the Medium/Middle code model: the program must be linked
6400 in the low 44 bits of the address space, the text segment must be less than
6401 2G bytes, and data segment must be within 2G of the text segment.
6402 Pointers are 64 bits.
6403
6404 @item -mcmodel=medany
6405 @opindex mcmodel=medany
6406 Generate code for the Medium/Anywhere code model: the program may be linked
6407 anywhere in the address space, the text segment must be less than
6408 2G bytes, and data segment must be within 2G of the text segment.
6409 Pointers are 64 bits.
6410
6411 @item -mcmodel=embmedany
6412 @opindex mcmodel=embmedany
6413 Generate code for the Medium/Anywhere code model for embedded systems:
6414 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6415 (determined at link time).  Register %g4 points to the base of the
6416 data segment.  Pointers are still 64 bits.
6417 Programs are statically linked, PIC is not supported.
6418
6419 @item -mstack-bias
6420 @itemx -mno-stack-bias
6421 @opindex mstack-bias
6422 @opindex mno-stack-bias
6423 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6424 frame pointer if present, are offset by @minus{}2047 which must be added back
6425 when making stack frame references.
6426 Otherwise, assume no such offset is present.
6427 @end table
6428
6429 @node ARM Options
6430 @subsection ARM Options
6431 @cindex ARM options
6432
6433 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6434 architectures:
6435
6436 @table @gcctabopt
6437 @item -mapcs-frame
6438 @opindex mapcs-frame
6439 Generate a stack frame that is compliant with the ARM Procedure Call
6440 Standard for all functions, even if this is not strictly necessary for
6441 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6442 with this option will cause the stack frames not to be generated for
6443 leaf functions.  The default is @option{-mno-apcs-frame}.
6444
6445 @item -mapcs
6446 @opindex mapcs
6447 This is a synonym for @option{-mapcs-frame}.
6448
6449 @item -mapcs-26
6450 @opindex mapcs-26
6451 Generate code for a processor running with a 26-bit program counter,
6452 and conforming to the function calling standards for the APCS 26-bit
6453 option.  This option replaces the @option{-m2} and @option{-m3} options
6454 of previous releases of the compiler.
6455
6456 @item -mapcs-32
6457 @opindex mapcs-32
6458 Generate code for a processor running with a 32-bit program counter,
6459 and conforming to the function calling standards for the APCS 32-bit
6460 option.  This option replaces the @option{-m6} option of previous releases
6461 of the compiler.
6462
6463 @ignore
6464 @c not currently implemented
6465 @item -mapcs-stack-check
6466 @opindex mapcs-stack-check
6467 Generate code to check the amount of stack space available upon entry to
6468 every function (that actually uses some stack space).  If there is
6469 insufficient space available then either the function
6470 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6471 called, depending upon the amount of stack space required.  The run time
6472 system is required to provide these functions.  The default is
6473 @option{-mno-apcs-stack-check}, since this produces smaller code.
6474
6475 @c not currently implemented
6476 @item -mapcs-float
6477 @opindex mapcs-float
6478 Pass floating point arguments using the float point registers.  This is
6479 one of the variants of the APCS@.  This option is recommended if the
6480 target hardware has a floating point unit or if a lot of floating point
6481 arithmetic is going to be performed by the code.  The default is
6482 @option{-mno-apcs-float}, since integer only code is slightly increased in
6483 size if @option{-mapcs-float} is used.
6484
6485 @c not currently implemented
6486 @item -mapcs-reentrant
6487 @opindex mapcs-reentrant
6488 Generate reentrant, position independent code.  The default is
6489 @option{-mno-apcs-reentrant}.
6490 @end ignore
6491
6492 @item -mthumb-interwork
6493 @opindex mthumb-interwork
6494 Generate code which supports calling between the ARM and Thumb
6495 instruction sets.  Without this option the two instruction sets cannot
6496 be reliably used inside one program.  The default is
6497 @option{-mno-thumb-interwork}, since slightly larger code is generated
6498 when @option{-mthumb-interwork} is specified.
6499
6500 @item -mno-sched-prolog
6501 @opindex mno-sched-prolog
6502 Prevent the reordering of instructions in the function prolog, or the
6503 merging of those instruction with the instructions in the function's
6504 body.  This means that all functions will start with a recognizable set
6505 of instructions (or in fact one of a choice from a small set of
6506 different function prologues), and this information can be used to
6507 locate the start if functions inside an executable piece of code.  The
6508 default is @option{-msched-prolog}.
6509
6510 @item -mhard-float
6511 @opindex mhard-float
6512 Generate output containing floating point instructions.  This is the
6513 default.
6514
6515 @item -msoft-float
6516 @opindex msoft-float
6517 Generate output containing library calls for floating point.
6518 @strong{Warning:} the requisite libraries are not available for all ARM
6519 targets.  Normally the facilities of the machine's usual C compiler are
6520 used, but this cannot be done directly in cross-compilation.  You must make
6521 your own arrangements to provide suitable library functions for
6522 cross-compilation.
6523
6524 @option{-msoft-float} changes the calling convention in the output file;
6525 therefore, it is only useful if you compile @emph{all} of a program with
6526 this option.  In particular, you need to compile @file{libgcc.a}, the
6527 library that comes with GCC, with @option{-msoft-float} in order for
6528 this to work.
6529
6530 @item -mlittle-endian
6531 @opindex mlittle-endian
6532 Generate code for a processor running in little-endian mode.  This is
6533 the default for all standard configurations.
6534
6535 @item -mbig-endian
6536 @opindex mbig-endian
6537 Generate code for a processor running in big-endian mode; the default is
6538 to compile code for a little-endian processor.
6539
6540 @item -mwords-little-endian
6541 @opindex mwords-little-endian
6542 This option only applies when generating code for big-endian processors.
6543 Generate code for a little-endian word order but a big-endian byte
6544 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6545 option should only be used if you require compatibility with code for
6546 big-endian ARM processors generated by versions of the compiler prior to
6547 2.8.
6548
6549 @item -malignment-traps
6550 @opindex malignment-traps
6551 Generate code that will not trap if the MMU has alignment traps enabled.
6552 On ARM architectures prior to ARMv4, there were no instructions to
6553 access half-word objects stored in memory.  However, when reading from
6554 memory a feature of the ARM architecture allows a word load to be used,
6555 even if the address is unaligned, and the processor core will rotate the
6556 data as it is being loaded.  This option tells the compiler that such
6557 misaligned accesses will cause a MMU trap and that it should instead
6558 synthesize the access as a series of byte accesses.  The compiler can
6559 still use word accesses to load half-word data if it knows that the
6560 address is aligned to a word boundary.
6561
6562 This option is ignored when compiling for ARM architecture 4 or later,
6563 since these processors have instructions to directly access half-word
6564 objects in memory.
6565
6566 @item -mno-alignment-traps
6567 @opindex mno-alignment-traps
6568 Generate code that assumes that the MMU will not trap unaligned
6569 accesses.  This produces better code when the target instruction set
6570 does not have half-word memory operations (i.e.@: implementations prior to
6571 ARMv4).
6572
6573 Note that you cannot use this option to access unaligned word objects,
6574 since the processor will only fetch one 32-bit aligned object from
6575 memory.
6576
6577 The default setting for most targets is @option{-mno-alignment-traps}, since
6578 this produces better code when there are no half-word memory
6579 instructions available.
6580
6581 @item -mshort-load-bytes
6582 @itemx -mno-short-load-words
6583 @opindex mshort-load-bytes
6584 @opindex mno-short-load-words
6585 These are deprecated aliases for @option{-malignment-traps}.
6586
6587 @item -mno-short-load-bytes
6588 @itemx -mshort-load-words
6589 @opindex mno-short-load-bytes
6590 @opindex mshort-load-words
6591 This are deprecated aliases for @option{-mno-alignment-traps}.
6592
6593 @item -mcpu=@var{name}
6594 @opindex mcpu
6595 This specifies the name of the target ARM processor.  GCC uses this name
6596 to determine what kind of instructions it can emit when generating
6597 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6598 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6599 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6600 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6601 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6602 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6603 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6604 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6605 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6606 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6607 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6608 @samp{ep9312}.
6609
6610 @itemx -mtune=@var{name}
6611 @opindex mtune
6612 This option is very similar to the @option{-mcpu=} option, except that
6613 instead of specifying the actual target processor type, and hence
6614 restricting which instructions can be used, it specifies that GCC should
6615 tune the performance of the code as if the target were of the type
6616 specified in this option, but still choosing the instructions that it
6617 will generate based on the cpu specified by a @option{-mcpu=} option.
6618 For some ARM implementations better performance can be obtained by using
6619 this option.
6620
6621 @item -march=@var{name}
6622 @opindex march
6623 This specifies the name of the target ARM architecture.  GCC uses this
6624 name to determine what kind of instructions it can emit when generating
6625 assembly code.  This option can be used in conjunction with or instead
6626 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6627 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6628 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6629 @samp{iwmmxt}, @samp{ep9312}.
6630
6631 @item -mfpe=@var{number}
6632 @itemx -mfp=@var{number}
6633 @opindex mfpe
6634 @opindex mfp
6635 This specifies the version of the floating point emulation available on
6636 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6637 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6638
6639 @item -mstructure-size-boundary=@var{n}
6640 @opindex mstructure-size-boundary
6641 The size of all structures and unions will be rounded up to a multiple
6642 of the number of bits set by this option.  Permissible values are 8 and
6643 32.  The default value varies for different toolchains.  For the COFF
6644 targeted toolchain the default value is 8.  Specifying the larger number
6645 can produce faster, more efficient code, but can also increase the size
6646 of the program.  The two values are potentially incompatible.  Code
6647 compiled with one value cannot necessarily expect to work with code or
6648 libraries compiled with the other value, if they exchange information
6649 using structures or unions.
6650
6651 @item -mabort-on-noreturn
6652 @opindex mabort-on-noreturn
6653 Generate a call to the function @code{abort} at the end of a
6654 @code{noreturn} function.  It will be executed if the function tries to
6655 return.
6656
6657 @item -mlong-calls
6658 @itemx -mno-long-calls
6659 @opindex mlong-calls
6660 @opindex mno-long-calls
6661 Tells the compiler to perform function calls by first loading the
6662 address of the function into a register and then performing a subroutine
6663 call on this register.  This switch is needed if the target function
6664 will lie outside of the 64 megabyte addressing range of the offset based
6665 version of subroutine call instruction.
6666
6667 Even if this switch is enabled, not all function calls will be turned
6668 into long calls.  The heuristic is that static functions, functions
6669 which have the @samp{short-call} attribute, functions that are inside
6670 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6671 definitions have already been compiled within the current compilation
6672 unit, will not be turned into long calls.  The exception to this rule is
6673 that weak function definitions, functions with the @samp{long-call}
6674 attribute or the @samp{section} attribute, and functions that are within
6675 the scope of a @samp{#pragma long_calls} directive, will always be
6676 turned into long calls.
6677
6678 This feature is not enabled by default.  Specifying
6679 @option{-mno-long-calls} will restore the default behavior, as will
6680 placing the function calls within the scope of a @samp{#pragma
6681 long_calls_off} directive.  Note these switches have no effect on how
6682 the compiler generates code to handle function calls via function
6683 pointers.
6684
6685 @item -mnop-fun-dllimport
6686 @opindex mnop-fun-dllimport
6687 Disable support for the @code{dllimport} attribute.
6688
6689 @item -msingle-pic-base
6690 @opindex msingle-pic-base
6691 Treat the register used for PIC addressing as read-only, rather than
6692 loading it in the prologue for each function.  The run-time system is
6693 responsible for initializing this register with an appropriate value
6694 before execution begins.
6695
6696 @item -mpic-register=@var{reg}
6697 @opindex mpic-register
6698 Specify the register to be used for PIC addressing.  The default is R10
6699 unless stack-checking is enabled, when R9 is used.
6700
6701 @item -mcirrus-fix-invalid-insns
6702 @opindex mcirrus-fix-invalid-insns
6703 @opindex mno-cirrus-fix-invalid-insns
6704 Insert NOPs into the instruction stream to in order to work around
6705 problems with invalid Maverick instruction combinations.  This option
6706 is only valid if the @option{-mcpu=ep9312} option has been used to
6707 enable generation of instructions for the Cirrus Maverick floating
6708 point co-processor.  This option is not enabled by default, since the
6709 problem is only present in older Maverick implementations.  The default
6710 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6711 switch.
6712
6713 @item -mpoke-function-name
6714 @opindex mpoke-function-name
6715 Write the name of each function into the text section, directly
6716 preceding the function prologue.  The generated code is similar to this:
6717
6718 @smallexample
6719      t0
6720          .ascii "arm_poke_function_name", 0
6721          .align
6722      t1
6723          .word 0xff000000 + (t1 - t0)
6724      arm_poke_function_name
6725          mov     ip, sp
6726          stmfd   sp!, @{fp, ip, lr, pc@}
6727          sub     fp, ip, #4
6728 @end smallexample
6729
6730 When performing a stack backtrace, code can inspect the value of
6731 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6732 location @code{pc - 12} and the top 8 bits are set, then we know that
6733 there is a function name embedded immediately preceding this location
6734 and has length @code{((pc[-3]) & 0xff000000)}.
6735
6736 @item -mthumb
6737 @opindex mthumb
6738 Generate code for the 16-bit Thumb instruction set.  The default is to
6739 use the 32-bit ARM instruction set.
6740
6741 @item -mtpcs-frame
6742 @opindex mtpcs-frame
6743 Generate a stack frame that is compliant with the Thumb Procedure Call
6744 Standard for all non-leaf functions.  (A leaf function is one that does
6745 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6746
6747 @item -mtpcs-leaf-frame
6748 @opindex mtpcs-leaf-frame
6749 Generate a stack frame that is compliant with the Thumb Procedure Call
6750 Standard for all leaf functions.  (A leaf function is one that does
6751 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6752
6753 @item -mcallee-super-interworking
6754 @opindex mcallee-super-interworking
6755 Gives all externally visible functions in the file being compiled an ARM
6756 instruction set header which switches to Thumb mode before executing the
6757 rest of the function.  This allows these functions to be called from
6758 non-interworking code.
6759
6760 @item -mcaller-super-interworking
6761 @opindex mcaller-super-interworking
6762 Allows calls via function pointers (including virtual functions) to
6763 execute correctly regardless of whether the target code has been
6764 compiled for interworking or not.  There is a small overhead in the cost
6765 of executing a function pointer if this option is enabled.
6766
6767 @end table
6768
6769 @node MN10200 Options
6770 @subsection MN10200 Options
6771 @cindex MN10200 options
6772
6773 These @option{-m} options are defined for Matsushita MN10200 architectures:
6774 @table @gcctabopt
6775
6776 @item -mrelax
6777 @opindex mrelax
6778 Indicate to the linker that it should perform a relaxation optimization pass
6779 to shorten branches, calls and absolute memory addresses.  This option only
6780 has an effect when used on the command line for the final link step.
6781
6782 This option makes symbolic debugging impossible.
6783 @end table
6784
6785 @node MN10300 Options
6786 @subsection MN10300 Options
6787 @cindex MN10300 options
6788
6789 These @option{-m} options are defined for Matsushita MN10300 architectures:
6790
6791 @table @gcctabopt
6792 @item -mmult-bug
6793 @opindex mmult-bug
6794 Generate code to avoid bugs in the multiply instructions for the MN10300
6795 processors.  This is the default.
6796
6797 @item -mno-mult-bug
6798 @opindex mno-mult-bug
6799 Do not generate code to avoid bugs in the multiply instructions for the
6800 MN10300 processors.
6801
6802 @item -mam33
6803 @opindex mam33
6804 Generate code which uses features specific to the AM33 processor.
6805
6806 @item -mno-am33
6807 @opindex mno-am33
6808 Do not generate code which uses features specific to the AM33 processor.  This
6809 is the default.
6810
6811 @item -mno-crt0
6812 @opindex mno-crt0
6813 Do not link in the C run-time initialization object file.
6814
6815 @item -mrelax
6816 @opindex mrelax
6817 Indicate to the linker that it should perform a relaxation optimization pass
6818 to shorten branches, calls and absolute memory addresses.  This option only
6819 has an effect when used on the command line for the final link step.
6820
6821 This option makes symbolic debugging impossible.
6822 @end table
6823
6824
6825 @node M32R/D Options
6826 @subsection M32R/D Options
6827 @cindex M32R/D options
6828
6829 These @option{-m} options are defined for Renesas M32R/D architectures:
6830
6831 @table @gcctabopt
6832 @item -m32r2
6833 @opindex m32r2
6834 Generate code for the M32R/2@.
6835
6836 @item -m32rx
6837 @opindex m32rx
6838 Generate code for the M32R/X@.
6839
6840 @item -m32r
6841 @opindex m32r
6842 Generate code for the M32R@.  This is the default.
6843
6844 @item -mmodel=small
6845 @opindex mmodel=small
6846 Assume all objects live in the lower 16MB of memory (so that their addresses
6847 can be loaded with the @code{ld24} instruction), and assume all subroutines
6848 are reachable with the @code{bl} instruction.
6849 This is the default.
6850
6851 The addressability of a particular object can be set with the
6852 @code{model} attribute.
6853
6854 @item -mmodel=medium
6855 @opindex mmodel=medium
6856 Assume objects may be anywhere in the 32-bit address space (the compiler
6857 will generate @code{seth/add3} instructions to load their addresses), and
6858 assume all subroutines are reachable with the @code{bl} instruction.
6859
6860 @item -mmodel=large
6861 @opindex mmodel=large
6862 Assume objects may be anywhere in the 32-bit address space (the compiler
6863 will generate @code{seth/add3} instructions to load their addresses), and
6864 assume subroutines may not be reachable with the @code{bl} instruction
6865 (the compiler will generate the much slower @code{seth/add3/jl}
6866 instruction sequence).
6867
6868 @item -msdata=none
6869 @opindex msdata=none
6870 Disable use of the small data area.  Variables will be put into
6871 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6872 @code{section} attribute has been specified).
6873 This is the default.
6874
6875 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6876 Objects may be explicitly put in the small data area with the
6877 @code{section} attribute using one of these sections.
6878
6879 @item -msdata=sdata
6880 @opindex msdata=sdata
6881 Put small global and static data in the small data area, but do not
6882 generate special code to reference them.
6883
6884 @item -msdata=use
6885 @opindex msdata=use
6886 Put small global and static data in the small data area, and generate
6887 special instructions to reference them.
6888
6889 @item -G @var{num}
6890 @opindex G
6891 @cindex smaller data references
6892 Put global and static objects less than or equal to @var{num} bytes
6893 into the small data or bss sections instead of the normal data or bss
6894 sections.  The default value of @var{num} is 8.
6895 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6896 for this option to have any effect.
6897
6898 All modules should be compiled with the same @option{-G @var{num}} value.
6899 Compiling with different values of @var{num} may or may not work; if it
6900 doesn't the linker will give an error message---incorrect code will not be
6901 generated.
6902
6903 @item -mdebug
6904 @opindex -mdebug
6905 Makes the M32R specific code in the compiler display some statistics
6906 that might help in debugging programs.
6907
6908 @item -malign-loops
6909 @opindex malign-loops
6910 Align all loops to a 32-byte boundary.
6911
6912 @item -mno-align-loops
6913 @opindex mno-align-loops
6914 Do not enforce a 32-byte alignment for loops.  This is the default.
6915
6916 @item -missue-rate=@var{number}
6917 @opindex missue-rate=@var{number}
6918 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6919 or 2.
6920
6921 @item -mbranch-cost=@var{number}
6922 @opindex mbranch-cost=@var{number}
6923 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6924 prefered over conditional code, if it is 2, then the opposite will
6925 apply.
6926
6927 @item -mflush-trap=@var{number}
6928 @opindex mflush-trap=@var{number}
6929 Specifies the trap number to use to flush the cache.  The default is
6930 12.  Valid numbers are between 0 and 15 inclusive.
6931
6932 @item -mno-flush-trap
6933 @opindex mno-flush-trap
6934 Specifies that the cache cannot be flushed by using a trap.
6935
6936 @item -mflush-func=@var{name}
6937 @opindex mflush-func=@var{name}
6938 Specifies the name of the operating system function to call to flush
6939 the cache.  The default is @emph{_flush_cache}, but a function call
6940 will only be used if a trap is not available.
6941
6942 @item -mno-flush-func
6943 @opindex mno-flush-func
6944 Indicates that there is no OS function for flushing the cache.
6945
6946 @end table
6947
6948 @node M88K Options
6949 @subsection M88K Options
6950 @cindex M88k options
6951
6952 These @samp{-m} options are defined for Motorola 88k architectures:
6953
6954 @table @gcctabopt
6955 @item -m88000
6956 @opindex m88000
6957 Generate code that works well on both the m88100 and the
6958 m88110.
6959
6960 @item -m88100
6961 @opindex m88100
6962 Generate code that works best for the m88100, but that also
6963 runs on the m88110.
6964
6965 @item -m88110
6966 @opindex m88110
6967 Generate code that works best for the m88110, and may not run
6968 on the m88100.
6969
6970 @item -mbig-pic
6971 @opindex mbig-pic
6972 Obsolete option to be removed from the next revision.
6973 Use @option{-fPIC}.
6974
6975 @item -midentify-revision
6976 @opindex midentify-revision
6977 @cindex identifying source, compiler (88k)
6978 Include an @code{ident} directive in the assembler output recording the
6979 source file name, compiler name and version, timestamp, and compilation
6980 flags used.
6981
6982 @item -mno-underscores
6983 @opindex mno-underscores
6984 @cindex underscores, avoiding (88k)
6985 In assembler output, emit symbol names without adding an underscore
6986 character at the beginning of each name.  The default is to use an
6987 underscore as prefix on each name.
6988
6989 @item -mocs-debug-info
6990 @itemx -mno-ocs-debug-info
6991 @opindex mocs-debug-info
6992 @opindex mno-ocs-debug-info
6993 @cindex OCS (88k)
6994 @cindex debugging, 88k OCS
6995 Include (or omit) additional debugging information (about registers used
6996 in each stack frame) as specified in the 88open Object Compatibility
6997 Standard, ``OCS''@.  This extra information allows debugging of code that
6998 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6999 SVr3.2 is to include this information; other 88k configurations omit this
7000 information by default.
7001
7002 @item -mocs-frame-position
7003 @opindex mocs-frame-position
7004 @cindex register positions in frame (88k)
7005 When emitting COFF debugging information for automatic variables and
7006 parameters stored on the stack, use the offset from the canonical frame
7007 address, which is the stack pointer (register 31) on entry to the
7008 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
7009 @option{-mocs-frame-position}; other 88k configurations have the default
7010 @option{-mno-ocs-frame-position}.
7011
7012 @item -mno-ocs-frame-position
7013 @opindex mno-ocs-frame-position
7014 @cindex register positions in frame (88k)
7015 When emitting COFF debugging information for automatic variables and
7016 parameters stored on the stack, use the offset from the frame pointer
7017 register (register 30).  When this option is in effect, the frame
7018 pointer is not eliminated when debugging information is selected by the
7019 -g switch.
7020
7021 @item -moptimize-arg-area
7022 @opindex moptimize-arg-area
7023 @cindex arguments in frame (88k)
7024 Save space by reorganizing the stack frame.  This option generates code
7025 that does not agree with the 88open specifications, but uses less
7026 memory.
7027
7028 @itemx -mno-optimize-arg-area
7029 @opindex mno-optimize-arg-area
7030 Do not reorganize the stack frame to save space.  This is the default.
7031 The generated conforms to the specification, but uses more memory.
7032
7033 @item -mshort-data-@var{num}
7034 @opindex mshort-data
7035 @cindex smaller data references (88k)
7036 @cindex r0-relative references (88k)
7037 Generate smaller data references by making them relative to @code{r0},
7038 which allows loading a value using a single instruction (rather than the
7039 usual two).  You control which data references are affected by
7040 specifying @var{num} with this option.  For example, if you specify
7041 @option{-mshort-data-512}, then the data references affected are those
7042 involving displacements of less than 512 bytes.
7043 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
7044 than 64k.
7045
7046 @item -mserialize-volatile
7047 @opindex mserialize-volatile
7048 @itemx -mno-serialize-volatile
7049 @opindex mno-serialize-volatile
7050 @cindex sequential consistency on 88k
7051 Do, or don't, generate code to guarantee sequential consistency
7052 of volatile memory references.  By default, consistency is
7053 guaranteed.
7054
7055 The order of memory references made by the MC88110 processor does
7056 not always match the order of the instructions requesting those
7057 references.  In particular, a load instruction may execute before
7058 a preceding store instruction.  Such reordering violates
7059 sequential consistency of volatile memory references, when there
7060 are multiple processors.   When consistency must be guaranteed,
7061 GCC generates special instructions, as needed, to force
7062 execution in the proper order.
7063
7064 The MC88100 processor does not reorder memory references and so
7065 always provides sequential consistency.  However, by default, GCC
7066 generates the special instructions to guarantee consistency
7067 even when you use @option{-m88100}, so that the code may be run on an
7068 MC88110 processor.  If you intend to run your code only on the
7069 MC88100 processor, you may use @option{-mno-serialize-volatile}.
7070
7071 The extra code generated to guarantee consistency may affect the
7072 performance of your application.  If you know that you can safely
7073 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
7074
7075 @item -msvr4
7076 @itemx -msvr3
7077 @opindex msvr4
7078 @opindex msvr3
7079 @cindex assembler syntax, 88k
7080 @cindex SVr4
7081 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
7082 related to System V release 4 (SVr4).  This controls the following:
7083
7084 @enumerate
7085 @item
7086 Which variant of the assembler syntax to emit.
7087 @item
7088 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
7089 that is used on System V release 4.
7090 @item
7091 @option{-msvr4} makes GCC issue additional declaration directives used in
7092 SVr4.
7093 @end enumerate
7094
7095 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
7096 @option{-msvr3} is the default for all other m88k configurations.
7097
7098 @item -mversion-03.00
7099 @opindex mversion-03.00
7100 This option is obsolete, and is ignored.
7101 @c ??? which asm syntax better for GAS?  option there too?
7102
7103 @item -mno-check-zero-division
7104 @itemx -mcheck-zero-division
7105 @opindex mno-check-zero-division
7106 @opindex mcheck-zero-division
7107 @cindex zero division on 88k
7108 Do, or don't, generate code to guarantee that integer division by
7109 zero will be detected.  By default, detection is guaranteed.
7110
7111 Some models of the MC88100 processor fail to trap upon integer
7112 division by zero under certain conditions.  By default, when
7113 compiling code that might be run on such a processor, GCC
7114 generates code that explicitly checks for zero-valued divisors
7115 and traps with exception number 503 when one is detected.  Use of
7116 @option{-mno-check-zero-division} suppresses such checking for code
7117 generated to run on an MC88100 processor.
7118
7119 GCC assumes that the MC88110 processor correctly detects all instances
7120 of integer division by zero.  When @option{-m88110} is specified, no
7121 explicit checks for zero-valued divisors are generated, and both
7122 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
7123 ignored.
7124
7125 @item -muse-div-instruction
7126 @opindex muse-div-instruction
7127 @cindex divide instruction, 88k
7128 Use the div instruction for signed integer division on the
7129 MC88100 processor.  By default, the div instruction is not used.
7130
7131 On the MC88100 processor the signed integer division instruction
7132 div) traps to the operating system on a negative operand.  The
7133 operating system transparently completes the operation, but at a
7134 large cost in execution time.  By default, when compiling code
7135 that might be run on an MC88100 processor, GCC emulates signed
7136 integer division using the unsigned integer division instruction
7137 divu), thereby avoiding the large penalty of a trap to the
7138 operating system.  Such emulation has its own, smaller, execution
7139 cost in both time and space.  To the extent that your code's
7140 important signed integer division operations are performed on two
7141 nonnegative operands, it may be desirable to use the div
7142 instruction directly.
7143
7144 On the MC88110 processor the div instruction (also known as the
7145 divs instruction) processes negative operands without trapping to
7146 the operating system.  When @option{-m88110} is specified,
7147 @option{-muse-div-instruction} is ignored, and the div instruction is used
7148 for signed integer division.
7149
7150 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
7151 particular, the behavior of such a division with and without
7152 @option{-muse-div-instruction} may differ.
7153
7154 @item -mtrap-large-shift
7155 @itemx -mhandle-large-shift
7156 @opindex mtrap-large-shift
7157 @opindex mhandle-large-shift
7158 @cindex bit shift overflow (88k)
7159 @cindex large bit shifts (88k)
7160 Include code to detect bit-shifts of more than 31 bits; respectively,
7161 trap such shifts or emit code to handle them properly.  By default GCC
7162 makes no special provision for large bit shifts.
7163
7164 @item -mwarn-passed-structs
7165 @opindex mwarn-passed-structs
7166 @cindex structure passing (88k)
7167 Warn when a function passes a struct as an argument or result.
7168 Structure-passing conventions have changed during the evolution of the C
7169 language, and are often the source of portability problems.  By default,
7170 GCC issues no such warning.
7171 @end table
7172
7173 @c break page here to avoid unsightly interparagraph stretch.
7174 @c -zw, 2001-8-17
7175 @page
7176
7177 @node RS/6000 and PowerPC Options
7178 @subsection IBM RS/6000 and PowerPC Options
7179 @cindex RS/6000 and PowerPC Options
7180 @cindex IBM RS/6000 and PowerPC Options
7181
7182 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
7183 @table @gcctabopt
7184 @item -mpower
7185 @itemx -mno-power
7186 @itemx -mpower2
7187 @itemx -mno-power2
7188 @itemx -mpowerpc
7189 @itemx -mno-powerpc
7190 @itemx -mpowerpc-gpopt
7191 @itemx -mno-powerpc-gpopt
7192 @itemx -mpowerpc-gfxopt
7193 @itemx -mno-powerpc-gfxopt
7194 @itemx -mpowerpc64
7195 @itemx -mno-powerpc64
7196 @opindex mpower
7197 @opindex mno-power
7198 @opindex mpower2
7199 @opindex mno-power2
7200 @opindex mpowerpc
7201 @opindex mno-powerpc
7202 @opindex mpowerpc-gpopt
7203 @opindex mno-powerpc-gpopt
7204 @opindex mpowerpc-gfxopt
7205 @opindex mno-powerpc-gfxopt
7206 @opindex mpowerpc64
7207 @opindex mno-powerpc64
7208 GCC supports two related instruction set architectures for the
7209 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
7210 instructions supported by the @samp{rios} chip set used in the original
7211 RS/6000 systems and the @dfn{PowerPC} instruction set is the
7212 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
7213 the IBM 4xx microprocessors.
7214
7215 Neither architecture is a subset of the other.  However there is a
7216 large common subset of instructions supported by both.  An MQ
7217 register is included in processors supporting the POWER architecture.
7218
7219 You use these options to specify which instructions are available on the
7220 processor you are using.  The default value of these options is
7221 determined when configuring GCC@.  Specifying the
7222 @option{-mcpu=@var{cpu_type}} overrides the specification of these
7223 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
7224 rather than the options listed above.
7225
7226 The @option{-mpower} option allows GCC to generate instructions that
7227 are found only in the POWER architecture and to use the MQ register.
7228 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7229 to generate instructions that are present in the POWER2 architecture but
7230 not the original POWER architecture.
7231
7232 The @option{-mpowerpc} option allows GCC to generate instructions that
7233 are found only in the 32-bit subset of the PowerPC architecture.
7234 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7235 GCC to use the optional PowerPC architecture instructions in the
7236 General Purpose group, including floating-point square root.  Specifying
7237 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7238 use the optional PowerPC architecture instructions in the Graphics
7239 group, including floating-point select.
7240
7241 The @option{-mpowerpc64} option allows GCC to generate the additional
7242 64-bit instructions that are found in the full PowerPC64 architecture
7243 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7244 @option{-mno-powerpc64}.
7245
7246 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7247 will use only the instructions in the common subset of both
7248 architectures plus some special AIX common-mode calls, and will not use
7249 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7250 permits GCC to use any instruction from either architecture and to
7251 allow use of the MQ register; specify this for the Motorola MPC601.
7252
7253 @item -mnew-mnemonics
7254 @itemx -mold-mnemonics
7255 @opindex mnew-mnemonics
7256 @opindex mold-mnemonics
7257 Select which mnemonics to use in the generated assembler code.  With
7258 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7259 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7260 assembler mnemonics defined for the POWER architecture.  Instructions
7261 defined in only one architecture have only one mnemonic; GCC uses that
7262 mnemonic irrespective of which of these options is specified.
7263
7264 GCC defaults to the mnemonics appropriate for the architecture in
7265 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7266 value of these option.  Unless you are building a cross-compiler, you
7267 should normally not specify either @option{-mnew-mnemonics} or
7268 @option{-mold-mnemonics}, but should instead accept the default.
7269
7270 @item -mcpu=@var{cpu_type}
7271 @opindex mcpu
7272 Set architecture type, register usage, choice of mnemonics, and
7273 instruction scheduling parameters for machine type @var{cpu_type}.
7274 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7275 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7276 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7277 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7278 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7279 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7280 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7281 @samp{power4}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
7282 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7283
7284 @option{-mcpu=common} selects a completely generic processor.  Code
7285 generated under this option will run on any POWER or PowerPC processor.
7286 GCC will use only the instructions in the common subset of both
7287 architectures, and will not use the MQ register.  GCC assumes a generic
7288 processor model for scheduling purposes.
7289
7290 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7291 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7292 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7293 types, with an appropriate, generic processor model assumed for
7294 scheduling purposes.
7295
7296 The other options specify a specific processor.  Code generated under
7297 those options will run best on that processor, and may not run at all on
7298 others.
7299
7300 The @option{-mcpu} options automatically enable or disable the
7301 following options: @option{-maltivec}, @option{-mhard-float},
7302 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7303 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7304 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7305 @option{-mstring}.  The particular options set for any particular CPU
7306 will vary between compiler versions, depending on what setting seems
7307 to produce optimal code for that CPU; it doesn't necessarily reflect
7308 the actual hardware's capabilities.  If you wish to set an individual
7309 option to a particular value, you may specify it after the
7310 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7311
7312 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7313 not enabled or disabled by the @option{-mcpu} option at present, since
7314 AIX does not have full support for these options.  You may still
7315 enable or disable them individually if you're sure it'll work in your
7316 environment.
7317
7318 @item -mtune=@var{cpu_type}
7319 @opindex mtune
7320 Set the instruction scheduling parameters for machine type
7321 @var{cpu_type}, but do not set the architecture type, register usage, or
7322 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7323 values for @var{cpu_type} are used for @option{-mtune} as for
7324 @option{-mcpu}.  If both are specified, the code generated will use the
7325 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7326 scheduling parameters set by @option{-mtune}.
7327
7328 @item -maltivec
7329 @itemx -mno-altivec
7330 @opindex maltivec
7331 @opindex mno-altivec
7332 These switches enable or disable the use of built-in functions that
7333 allow access to the AltiVec instruction set.  You may also need to set
7334 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7335 enhancements.
7336
7337 @item -mabi=spe
7338 @opindex mabi=spe
7339 Extend the current ABI with SPE ABI extensions.  This does not change
7340 the default ABI, instead it adds the SPE ABI extensions to the current
7341 ABI@.
7342
7343 @item -mabi=no-spe
7344 @opindex mabi=no-spe
7345 Disable Booke SPE ABI extensions for the current ABI.
7346
7347 @item -misel=@var{yes/no}
7348 @itemx -misel
7349 @opindex misel
7350 This switch enables or disables the generation of ISEL instructions.
7351
7352 @item -mspe=@var{yes/no}
7353 @itemx -mspe
7354 @opindex mspe
7355 This switch enables or disables the generation of SPE simd
7356 instructions.
7357
7358 @item -mfloat-gprs=@var{yes/no}
7359 @itemx -mfloat-gprs
7360 @opindex mfloat-gprs
7361 This switch enables or disables the generation of floating point
7362 operations on the general purpose registers for architectures that
7363 support it.  This option is currently only available on the MPC8540.
7364
7365 @item -mfull-toc
7366 @itemx -mno-fp-in-toc
7367 @itemx -mno-sum-in-toc
7368 @itemx -mminimal-toc
7369 @opindex mfull-toc
7370 @opindex mno-fp-in-toc
7371 @opindex mno-sum-in-toc
7372 @opindex mminimal-toc
7373 Modify generation of the TOC (Table Of Contents), which is created for
7374 every executable file.  The @option{-mfull-toc} option is selected by
7375 default.  In that case, GCC will allocate at least one TOC entry for
7376 each unique non-automatic variable reference in your program.  GCC
7377 will also place floating-point constants in the TOC@.  However, only
7378 16,384 entries are available in the TOC@.
7379
7380 If you receive a linker error message that saying you have overflowed
7381 the available TOC space, you can reduce the amount of TOC space used
7382 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7383 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7384 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7385 generate code to calculate the sum of an address and a constant at
7386 run-time instead of putting that sum into the TOC@.  You may specify one
7387 or both of these options.  Each causes GCC to produce very slightly
7388 slower and larger code at the expense of conserving TOC space.
7389
7390 If you still run out of space in the TOC even when you specify both of
7391 these options, specify @option{-mminimal-toc} instead.  This option causes
7392 GCC to make only one TOC entry for every file.  When you specify this
7393 option, GCC will produce code that is slower and larger but which
7394 uses extremely little TOC space.  You may wish to use this option
7395 only on files that contain less frequently executed code.
7396
7397 @item -maix64
7398 @itemx -maix32
7399 @opindex maix64
7400 @opindex maix32
7401 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7402 @code{long} type, and the infrastructure needed to support them.
7403 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7404 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7405 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7406
7407 @item -mxl-call
7408 @itemx -mno-xl-call
7409 @opindex mxl-call
7410 @opindex mno-xl-call
7411 On AIX, pass floating-point arguments to prototyped functions beyond the
7412 register save area (RSA) on the stack in addition to argument FPRs.  The
7413 AIX calling convention was extended but not initially documented to
7414 handle an obscure K&R C case of calling a function that takes the
7415 address of its arguments with fewer arguments than declared.  AIX XL
7416 compilers access floating point arguments which do not fit in the
7417 RSA from the stack when a subroutine is compiled without
7418 optimization.  Because always storing floating-point arguments on the
7419 stack is inefficient and rarely needed, this option is not enabled by
7420 default and only is necessary when calling subroutines compiled by AIX
7421 XL compilers without optimization.
7422
7423 @item -mpe
7424 @opindex mpe
7425 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7426 application written to use message passing with special startup code to
7427 enable the application to run.  The system must have PE installed in the
7428 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7429 must be overridden with the @option{-specs=} option to specify the
7430 appropriate directory location.  The Parallel Environment does not
7431 support threads, so the @option{-mpe} option and the @option{-pthread}
7432 option are incompatible.
7433
7434 @item -malign-natural
7435 @itemx -malign-power
7436 @opindex malign-natural
7437 @opindex malign-power
7438 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7439 @option{-malign-natural} overrides the ABI-defined alignment of larger
7440 types, such as floating-point doubles, on their natural size-based boundary.
7441 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7442 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7443
7444 @item -msoft-float
7445 @itemx -mhard-float
7446 @opindex msoft-float
7447 @opindex mhard-float
7448 Generate code that does not use (uses) the floating-point register set.
7449 Software floating point emulation is provided if you use the
7450 @option{-msoft-float} option, and pass the option to GCC when linking.
7451
7452 @item -mmultiple
7453 @itemx -mno-multiple
7454 @opindex mmultiple
7455 @opindex mno-multiple
7456 Generate code that uses (does not use) the load multiple word
7457 instructions and the store multiple word instructions.  These
7458 instructions are generated by default on POWER systems, and not
7459 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7460 endian PowerPC systems, since those instructions do not work when the
7461 processor is in little endian mode.  The exceptions are PPC740 and
7462 PPC750 which permit the instructions usage in little endian mode.
7463
7464 @item -mstring
7465 @itemx -mno-string
7466 @opindex mstring
7467 @opindex mno-string
7468 Generate code that uses (does not use) the load string instructions
7469 and the store string word instructions to save multiple registers and
7470 do small block moves.  These instructions are generated by default on
7471 POWER systems, and not generated on PowerPC systems.  Do not use
7472 @option{-mstring} on little endian PowerPC systems, since those
7473 instructions do not work when the processor is in little endian mode.
7474 The exceptions are PPC740 and PPC750 which permit the instructions
7475 usage in little endian mode.
7476
7477 @item -mupdate
7478 @itemx -mno-update
7479 @opindex mupdate
7480 @opindex mno-update
7481 Generate code that uses (does not use) the load or store instructions
7482 that update the base register to the address of the calculated memory
7483 location.  These instructions are generated by default.  If you use
7484 @option{-mno-update}, there is a small window between the time that the
7485 stack pointer is updated and the address of the previous frame is
7486 stored, which means code that walks the stack frame across interrupts or
7487 signals may get corrupted data.
7488
7489 @item -mfused-madd
7490 @itemx -mno-fused-madd
7491 @opindex mfused-madd
7492 @opindex mno-fused-madd
7493 Generate code that uses (does not use) the floating point multiply and
7494 accumulate instructions.  These instructions are generated by default if
7495 hardware floating is used.
7496
7497 @item -mno-bit-align
7498 @itemx -mbit-align
7499 @opindex mno-bit-align
7500 @opindex mbit-align
7501 On System V.4 and embedded PowerPC systems do not (do) force structures
7502 and unions that contain bit-fields to be aligned to the base type of the
7503 bit-field.
7504
7505 For example, by default a structure containing nothing but 8
7506 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7507 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7508 the structure would be aligned to a 1 byte boundary and be one byte in
7509 size.
7510
7511 @item -mno-strict-align
7512 @itemx -mstrict-align
7513 @opindex mno-strict-align
7514 @opindex mstrict-align
7515 On System V.4 and embedded PowerPC systems do not (do) assume that
7516 unaligned memory references will be handled by the system.
7517
7518 @item -mrelocatable
7519 @itemx -mno-relocatable
7520 @opindex mrelocatable
7521 @opindex mno-relocatable
7522 On embedded PowerPC systems generate code that allows (does not allow)
7523 the program to be relocated to a different address at runtime.  If you
7524 use @option{-mrelocatable} on any module, all objects linked together must
7525 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7526
7527 @item -mrelocatable-lib
7528 @itemx -mno-relocatable-lib
7529 @opindex mrelocatable-lib
7530 @opindex mno-relocatable-lib
7531 On embedded PowerPC systems generate code that allows (does not allow)
7532 the program to be relocated to a different address at runtime.  Modules
7533 compiled with @option{-mrelocatable-lib} can be linked with either modules
7534 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7535 with modules compiled with the @option{-mrelocatable} options.
7536
7537 @item -mno-toc
7538 @itemx -mtoc
7539 @opindex mno-toc
7540 @opindex mtoc
7541 On System V.4 and embedded PowerPC systems do not (do) assume that
7542 register 2 contains a pointer to a global area pointing to the addresses
7543 used in the program.
7544
7545 @item -mlittle
7546 @itemx -mlittle-endian
7547 @opindex mlittle
7548 @opindex mlittle-endian
7549 On System V.4 and embedded PowerPC systems compile code for the
7550 processor in little endian mode.  The @option{-mlittle-endian} option is
7551 the same as @option{-mlittle}.
7552
7553 @item -mbig
7554 @itemx -mbig-endian
7555 @opindex mbig
7556 @opindex mbig-endian
7557 On System V.4 and embedded PowerPC systems compile code for the
7558 processor in big endian mode.  The @option{-mbig-endian} option is
7559 the same as @option{-mbig}.
7560
7561 @item -mdynamic-no-pic
7562 @opindex mdynamic-no-pic
7563 On Darwin and Mac OS X systems, compile code so that it is not
7564 relocatable, but that its external references are relocatable.  The
7565 resulting code is suitable for applications, but not shared
7566 libraries.
7567
7568 @item -mprioritize-restricted-insns=@var{priority}
7569 @opindex mprioritize-restricted-insns
7570 This option controls the priority that is assigned to 
7571 dispatch-slot restricted instructions during the second scheduling 
7572 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign 
7573 @var{no/highest/second-highest} priority to dispatch slot restricted 
7574 instructions.
7575
7576 @item -msched-costly-dep=@var{dependence_type}
7577 @opindex msched-costly-dep
7578 This option controls which dependences are considered costly
7579 by the target during instruction scheduling.  The argument
7580 @var{dependence_type} takes one of the following values:
7581 @var{no}: no dependence is costly, 
7582 @var{all}: all dependences are costly, 
7583 @var{true_store_to_load}: a true dependence from store to load is costly,
7584 @var{store_to_load}: any dependence from store to load is costly,
7585 @var{number}: any dependence which latency >= @var{number} is costly.
7586  
7587 @item -minsert-sched-nops=@var{scheme}
7588 @opindex minsert-sched-nops
7589 This option controls which nop insertion scheme will be used during
7590 the second scheduling pass. The argument @var{scheme} takes one of the
7591 following values:
7592 @var{no}: Don't insert nops.
7593 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7594 according to the scheduler's grouping.
7595 @var{regroup_exact}: Insert nops to force costly dependent insns into
7596 separate groups.  Insert exactly as many nops as needed to force an insn
7597 to a new group, according to the estimatied processor grouping.
7598 @var{number}: Insert nops to force costly dependent insns into 
7599 separate groups.  Insert @var{number} nops to force an insn to a new group.
7600
7601 @item -mcall-sysv
7602 @opindex mcall-sysv
7603 On System V.4 and embedded PowerPC systems compile code using calling
7604 conventions that adheres to the March 1995 draft of the System V
7605 Application Binary Interface, PowerPC processor supplement.  This is the
7606 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7607
7608 @item -mcall-sysv-eabi
7609 @opindex mcall-sysv-eabi
7610 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7611
7612 @item -mcall-sysv-noeabi
7613 @opindex mcall-sysv-noeabi
7614 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7615
7616 @item -mcall-solaris
7617 @opindex mcall-solaris
7618 On System V.4 and embedded PowerPC systems compile code for the Solaris
7619 operating system.
7620
7621 @item -mcall-linux
7622 @opindex mcall-linux
7623 On System V.4 and embedded PowerPC systems compile code for the
7624 Linux-based GNU system.
7625
7626 @item -mcall-gnu
7627 @opindex mcall-gnu
7628 On System V.4 and embedded PowerPC systems compile code for the
7629 Hurd-based GNU system.
7630
7631 @item -mcall-netbsd
7632 @opindex mcall-netbsd
7633 On System V.4 and embedded PowerPC systems compile code for the
7634 NetBSD operating system.
7635
7636 @item -maix-struct-return
7637 @opindex maix-struct-return
7638 Return all structures in memory (as specified by the AIX ABI)@.
7639
7640 @item -msvr4-struct-return
7641 @opindex msvr4-struct-return
7642 Return structures smaller than 8 bytes in registers (as specified by the
7643 SVR4 ABI)@.
7644
7645 @item -mabi=altivec
7646 @opindex mabi=altivec
7647 Extend the current ABI with AltiVec ABI extensions.  This does not
7648 change the default ABI, instead it adds the AltiVec ABI extensions to
7649 the current ABI@.
7650
7651 @item -mabi=no-altivec
7652 @opindex mabi=no-altivec
7653 Disable AltiVec ABI extensions for the current ABI.
7654
7655 @item -mprototype
7656 @itemx -mno-prototype
7657 @opindex mprototype
7658 @opindex mno-prototype
7659 On System V.4 and embedded PowerPC systems assume that all calls to
7660 variable argument functions are properly prototyped.  Otherwise, the
7661 compiler must insert an instruction before every non prototyped call to
7662 set or clear bit 6 of the condition code register (@var{CR}) to
7663 indicate whether floating point values were passed in the floating point
7664 registers in case the function takes a variable arguments.  With
7665 @option{-mprototype}, only calls to prototyped variable argument functions
7666 will set or clear the bit.
7667
7668 @item -msim
7669 @opindex msim
7670 On embedded PowerPC systems, assume that the startup module is called
7671 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7672 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7673 configurations.
7674
7675 @item -mmvme
7676 @opindex mmvme
7677 On embedded PowerPC systems, assume that the startup module is called
7678 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7679 @file{libc.a}.
7680
7681 @item -mads
7682 @opindex mads
7683 On embedded PowerPC systems, assume that the startup module is called
7684 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7685 @file{libc.a}.
7686
7687 @item -myellowknife
7688 @opindex myellowknife
7689 On embedded PowerPC systems, assume that the startup module is called
7690 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7691 @file{libc.a}.
7692
7693 @item -mvxworks
7694 @opindex mvxworks
7695 On System V.4 and embedded PowerPC systems, specify that you are
7696 compiling for a VxWorks system.
7697
7698 @item -mwindiss
7699 @opindex mwindiss
7700 Specify that you are compiling for the WindISS simulation environment.
7701
7702 @item -memb
7703 @opindex memb
7704 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7705 header to indicate that @samp{eabi} extended relocations are used.
7706
7707 @item -meabi
7708 @itemx -mno-eabi
7709 @opindex meabi
7710 @opindex mno-eabi
7711 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7712 Embedded Applications Binary Interface (eabi) which is a set of
7713 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7714 means that the stack is aligned to an 8 byte boundary, a function
7715 @code{__eabi} is called to from @code{main} to set up the eabi
7716 environment, and the @option{-msdata} option can use both @code{r2} and
7717 @code{r13} to point to two separate small data areas.  Selecting
7718 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7719 do not call an initialization function from @code{main}, and the
7720 @option{-msdata} option will only use @code{r13} to point to a single
7721 small data area.  The @option{-meabi} option is on by default if you
7722 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7723
7724 @item -msdata=eabi
7725 @opindex msdata=eabi
7726 On System V.4 and embedded PowerPC systems, put small initialized
7727 @code{const} global and static data in the @samp{.sdata2} section, which
7728 is pointed to by register @code{r2}.  Put small initialized
7729 non-@code{const} global and static data in the @samp{.sdata} section,
7730 which is pointed to by register @code{r13}.  Put small uninitialized
7731 global and static data in the @samp{.sbss} section, which is adjacent to
7732 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7733 incompatible with the @option{-mrelocatable} option.  The
7734 @option{-msdata=eabi} option also sets the @option{-memb} option.
7735
7736 @item -msdata=sysv
7737 @opindex msdata=sysv
7738 On System V.4 and embedded PowerPC systems, put small global and static
7739 data in the @samp{.sdata} section, which is pointed to by register
7740 @code{r13}.  Put small uninitialized global and static data in the
7741 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7742 The @option{-msdata=sysv} option is incompatible with the
7743 @option{-mrelocatable} option.
7744
7745 @item -msdata=default
7746 @itemx -msdata
7747 @opindex msdata=default
7748 @opindex msdata
7749 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7750 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7751 same as @option{-msdata=sysv}.
7752
7753 @item -msdata-data
7754 @opindex msdata-data
7755 On System V.4 and embedded PowerPC systems, put small global and static
7756 data in the @samp{.sdata} section.  Put small uninitialized global and
7757 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7758 to address small data however.  This is the default behavior unless
7759 other @option{-msdata} options are used.
7760
7761 @item -msdata=none
7762 @itemx -mno-sdata
7763 @opindex msdata=none
7764 @opindex mno-sdata
7765 On embedded PowerPC systems, put all initialized global and static data
7766 in the @samp{.data} section, and all uninitialized data in the
7767 @samp{.bss} section.
7768
7769 @item -G @var{num}
7770 @opindex G
7771 @cindex smaller data references (PowerPC)
7772 @cindex .sdata/.sdata2 references (PowerPC)
7773 On embedded PowerPC systems, put global and static items less than or
7774 equal to @var{num} bytes into the small data or bss sections instead of
7775 the normal data or bss section.  By default, @var{num} is 8.  The
7776 @option{-G @var{num}} switch is also passed to the linker.
7777 All modules should be compiled with the same @option{-G @var{num}} value.
7778
7779 @item -mregnames
7780 @itemx -mno-regnames
7781 @opindex mregnames
7782 @opindex mno-regnames
7783 On System V.4 and embedded PowerPC systems do (do not) emit register
7784 names in the assembly language output using symbolic forms.
7785
7786 @item -mlongcall
7787 @itemx -mno-longcall
7788 @opindex mlongcall
7789 @opindex mno-longcall
7790 Default to making all function calls via pointers, so that functions
7791 which reside further than 64 megabytes (67,108,864 bytes) from the
7792 current location can be called.  This setting can be overridden by the
7793 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7794
7795 Some linkers are capable of detecting out-of-range calls and generating
7796 glue code on the fly.  On these systems, long calls are unnecessary and
7797 generate slower code.  As of this writing, the AIX linker can do this,
7798 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7799 to the GNU linker for 32-bit PowerPC systems as well.
7800
7801 On Mach-O (Darwin) systems, this option directs the compiler emit to
7802 the glue for every direct call, and the Darwin linker decides whether
7803 to use or discard it.
7804
7805 In the future, we may cause GCC to ignore all longcall specifications
7806 when the linker is known to generate glue.
7807
7808 @item -pthread
7809 @opindex pthread
7810 Adds support for multithreading with the @dfn{pthreads} library.
7811 This option sets flags for both the preprocessor and linker.
7812
7813 @end table
7814
7815 @node Darwin Options
7816 @subsection Darwin Options
7817 @cindex Darwin options
7818
7819 These options are defined for all architectures running the Darwin operating
7820 system.  They are useful for compatibility with other Mac OS compilers.
7821
7822 @table @gcctabopt
7823 @item -all_load    
7824 @opindex all_load   
7825 Loads all members of static archive libraries.
7826 See man ld(1) for more information.
7827
7828 @item -arch_errors_fatal
7829 @opindex arch_errors_fatal
7830 Cause the errors having to do with files that have the wrong architecture
7831 to be fatal.
7832
7833 @item -bind_at_load
7834 @opindex bind_at_load
7835 Causes the output file to be marked such that the dynamic linker will
7836 bind all undefined references when the file is loaded or launched.
7837
7838 @item -bundle     
7839 @opindex bundle
7840 Produce a Mach-o bundle format file.
7841 See man ld(1) for more information.
7842
7843 @item -bundle_loader @var{executable}
7844 @opindex bundle_loader
7845 This specifies the @var{executable} that will be loading the build
7846 output file being linked. See man ld(1) for more information.
7847
7848 @item -allowable_client  @var{client_name}
7849 @itemx -arch_only
7850
7851 @itemx -client_name       
7852 @itemx -compatibility_version
7853 @itemx -current_version    
7854 @itemx -dependency-file
7855 @itemx -dylib_file    
7856 @itemx -dylinker_install_name
7857 @itemx -dynamic
7858 @itemx -dynamiclib   
7859 @itemx -exported_symbols_list  
7860 @itemx -filelist
7861 @itemx -flat_namespace   
7862 @itemx -force_cpusubtype_ALL
7863 @itemx -force_flat_namespace   
7864 @itemx -headerpad_max_install_names
7865 @itemx -image_base  
7866 @itemx -init
7867 @itemx -install_name
7868 @itemx -keep_private_externs
7869 @itemx -multi_module
7870 @itemx -multiply_defined      
7871 @itemx -multiply_defined_unused      
7872 @itemx -noall_load  
7873 @itemx -nofixprebinding
7874 @itemx -nomultidefs
7875 @itemx -noprebind     
7876 @itemx -noseglinkedit
7877 @itemx -pagezero_size    
7878 @itemx -prebind
7879 @itemx -prebind_all_twolevel_modules
7880 @itemx -private_bundle
7881 @itemx -read_only_relocs
7882 @itemx -sectalign  
7883 @itemx -sectobjectsymbols    
7884 @itemx -whyload
7885 @itemx -seg1addr 
7886 @itemx -sectcreate
7887 @itemx -sectobjectsymbols
7888 @itemx -sectorder
7889 @itemx -seg_addr_table
7890 @itemx -seg_addr_table_filename
7891 @itemx -seglinkedit
7892 @itemx -segprot   
7893 @itemx -segs_read_only_addr
7894 @itemx -segs_read_write_addr
7895 @itemx -single_module   
7896 @itemx -static
7897 @itemx -sub_library
7898 @itemx -sub_umbrella 
7899 @itemx -twolevel_namespace
7900 @itemx -umbrella
7901 @itemx -undefined
7902 @itemx -unexported_symbols_list
7903 @itemx -weak_reference_mismatches
7904 @itemx -whatsloaded  
7905
7906 @opindex allowable_client
7907 @opindex arch_only    
7908 @opindex client_name
7909 @opindex compatibility_version
7910 @opindex current_version
7911 @opindex dependency-file
7912 @opindex dylib_file
7913 @opindex dylinker_install_name
7914 @opindex dynamic
7915 @opindex dynamiclib
7916 @opindex exported_symbols_list
7917 @opindex filelist  
7918 @opindex flat_namespace    
7919 @opindex force_cpusubtype_ALL
7920 @opindex force_flat_namespace
7921 @opindex headerpad_max_install_names
7922 @opindex image_base
7923 @opindex init     
7924 @opindex install_name
7925 @opindex keep_private_externs
7926 @opindex multi_module   
7927 @opindex multiply_defined
7928 @opindex multiply_defined_unused   
7929 @opindex noall_load  
7930 @opindex nofixprebinding
7931 @opindex nomultidefs   
7932 @opindex noprebind
7933 @opindex noseglinkedit      
7934 @opindex pagezero_size
7935 @opindex prebind
7936 @opindex prebind_all_twolevel_modules
7937 @opindex private_bundle 
7938 @opindex read_only_relocs
7939 @opindex sectalign   
7940 @opindex sectobjectsymbols    
7941 @opindex whyload  
7942 @opindex seg1addr
7943 @opindex sectcreate       
7944 @opindex sectobjectsymbols 
7945 @opindex sectorder     
7946 @opindex seg_addr_table
7947 @opindex seg_addr_table_filename
7948 @opindex seglinkedit
7949 @opindex segprot
7950 @opindex segs_read_only_addr
7951 @opindex segs_read_write_addr
7952 @opindex single_module
7953 @opindex static
7954 @opindex sub_library
7955 @opindex sub_umbrella
7956 @opindex twolevel_namespace
7957 @opindex umbrella
7958 @opindex undefined
7959 @opindex unexported_symbols_list
7960 @opindex weak_reference_mismatches
7961 @opindex whatsloaded
7962
7963 These options are available for Darwin linker. Darwin linker man page
7964 describes them in detail.
7965 @end table
7966
7967
7968 @node RT Options
7969 @subsection IBM RT Options
7970 @cindex RT options
7971 @cindex IBM RT options
7972
7973 These @samp{-m} options are defined for the IBM RT PC:
7974
7975 @table @gcctabopt
7976 @item -min-line-mul
7977 @opindex min-line-mul
7978 Use an in-line code sequence for integer multiplies.  This is the
7979 default.
7980
7981 @item -mcall-lib-mul
7982 @opindex mcall-lib-mul
7983 Call @code{lmul$$} for integer multiples.
7984
7985 @item -mfull-fp-blocks
7986 @opindex mfull-fp-blocks
7987 Generate full-size floating point data blocks, including the minimum
7988 amount of scratch space recommended by IBM@.  This is the default.
7989
7990 @item -mminimum-fp-blocks
7991 @opindex mminimum-fp-blocks
7992 Do not include extra scratch space in floating point data blocks.  This
7993 results in smaller code, but slower execution, since scratch space must
7994 be allocated dynamically.
7995
7996 @cindex @file{stdarg.h} and RT PC
7997 @item -mfp-arg-in-fpregs
7998 @opindex mfp-arg-in-fpregs
7999 Use a calling sequence incompatible with the IBM calling convention in
8000 which floating point arguments are passed in floating point registers.
8001 Note that @code{stdarg.h} will not work with floating point operands
8002 if this option is specified.
8003
8004 @item -mfp-arg-in-gregs
8005 @opindex mfp-arg-in-gregs
8006 Use the normal calling convention for floating point arguments.  This is
8007 the default.
8008
8009 @item -mhc-struct-return
8010 @opindex mhc-struct-return
8011 Return structures of more than one word in memory, rather than in a
8012 register.  This provides compatibility with the MetaWare HighC (hc)
8013 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
8014 with the Portable C Compiler (pcc).
8015
8016 @item -mnohc-struct-return
8017 @opindex mnohc-struct-return
8018 Return some structures of more than one word in registers, when
8019 convenient.  This is the default.  For compatibility with the
8020 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
8021 option @option{-mhc-struct-return}.
8022 @end table
8023
8024 @node MIPS Options
8025 @subsection MIPS Options
8026 @cindex MIPS options
8027
8028 @table @gcctabopt
8029
8030 @item -EB
8031 @opindex EB
8032 Generate big-endian code.
8033
8034 @item -EL
8035 @opindex EL
8036 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
8037 configurations.
8038
8039 @item -march=@var{arch}
8040 @opindex march
8041 Generate code that will run on @var{arch}, which can be the name of a
8042 generic MIPS ISA, or the name of a particular processor.
8043 The ISA names are:
8044 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
8045 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
8046 The processor names are:
8047 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
8048 @samp{m4k},
8049 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
8050 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
8051 @samp{rm9000},
8052 @samp{orion},
8053 @samp{sb1},
8054 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
8055 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
8056 The special value @samp{from-abi} selects the
8057 most compatible architecture for the selected ABI (that is,
8058 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
8059
8060 In processor names, a final @samp{000} can be abbreviated as @samp{k}
8061 (for example, @samp{-march=r2k}).  Prefixes are optional, and
8062 @samp{vr} may be written @samp{r}.
8063
8064 GCC defines two macros based on the value of this option.  The first
8065 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
8066 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
8067 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
8068 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
8069 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
8070
8071 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
8072 above.  In other words, it will have the full prefix and will not
8073 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
8074 the macro names the resolved architecture (either @samp{"mips1"} or
8075 @samp{"mips3"}).  It names the default architecture when no
8076 @option{-march} option is given.
8077
8078 @item -mtune=@var{arch}
8079 @opindex mtune
8080 Optimize for @var{arch}.  Among other things, this option controls
8081 the way instructions are scheduled, and the perceived cost of arithmetic
8082 operations.  The list of @var{arch} values is the same as for
8083 @option{-march}.
8084
8085 When this option is not used, GCC will optimize for the processor
8086 specified by @option{-march}.  By using @option{-march} and
8087 @option{-mtune} together, it is possible to generate code that will
8088 run on a family of processors, but optimize the code for one
8089 particular member of that family.
8090
8091 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
8092 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
8093 @samp{-march} ones described above.
8094
8095 @item -mips1
8096 @opindex mips1
8097 Equivalent to @samp{-march=mips1}.
8098
8099 @item -mips2
8100 @opindex mips2
8101 Equivalent to @samp{-march=mips2}.
8102
8103 @item -mips3
8104 @opindex mips3
8105 Equivalent to @samp{-march=mips3}.
8106
8107 @item -mips4
8108 @opindex mips4
8109 Equivalent to @samp{-march=mips4}.
8110
8111 @item -mips32
8112 @opindex mips32
8113 Equivalent to @samp{-march=mips32}.
8114
8115 @item -mips32r2
8116 @opindex mips32r2
8117 Equivalent to @samp{-march=mips32r2}.
8118
8119 @item -mips64
8120 @opindex mips64
8121 Equivalent to @samp{-march=mips64}.
8122
8123 @item -mips16
8124 @itemx -mno-mips16
8125 @opindex mips16
8126 @opindex mno-mips16
8127 Use (do not use) the MIPS16 ISA.
8128
8129 @item -mabi=32
8130 @itemx -mabi=o64
8131 @itemx -mabi=n32
8132 @itemx -mabi=64
8133 @itemx -mabi=eabi
8134 @opindex mabi=32
8135 @opindex mabi=o64
8136 @opindex mabi=n32
8137 @opindex mabi=64
8138 @opindex mabi=eabi
8139 Generate code for the given ABI@.
8140
8141 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
8142 generates 64-bit code when you select a 64-bit architecture, but you
8143 can use @option{-mgp32} to get 32-bit code instead.
8144
8145 @item -mabicalls
8146 @itemx -mno-abicalls
8147 @opindex mabicalls
8148 @opindex mno-abicalls
8149 Generate (do not generate) SVR4-style position-independent code.
8150 @option{-mabicalls} is the default for SVR4-based systems.
8151
8152 @item -mxgot
8153 @itemx -mno-xgot
8154 @opindex mxgot
8155 @opindex mno-xgot
8156 Lift (do not lift) the usual restrictions on the size of the global
8157 offset table.
8158
8159 GCC normally uses a single instruction to load values from the GOT.
8160 While this is relatively efficient, it will only work if the GOT
8161 is smaller than about 64k.  Anything larger will cause the linker
8162 to report an error such as:
8163
8164 @cindex relocation truncated to fit (MIPS)
8165 @smallexample
8166 relocation truncated to fit: R_MIPS_GOT16 foobar
8167 @end smallexample
8168
8169 If this happens, you should recompile your code with @option{-mxgot}.
8170 It should then work with very large GOTs, although it will also be
8171 less efficient, since it will take three instructions to fetch the
8172 value of a global symbol.
8173
8174 Note that some linkers can create multiple GOTs.  If you have such a
8175 linker, you should only need to use @option{-mxgot} when a single object
8176 file accesses more than 64k's worth of GOT entries.  Very few do.
8177
8178 These options have no effect unless GCC is generating position
8179 independent code.
8180
8181 @item -membedded-pic
8182 @itemx -mno-embedded-pic
8183 @opindex membedded-pic
8184 @opindex mno-embedded-pic
8185 Generate (do not generate) position-independent code suitable for some
8186 embedded systems.  All calls are made using PC relative addresses, and
8187 all data is addressed using the $gp register.  No more than 65536
8188 bytes of global data may be used.  This requires GNU as and GNU ld,
8189 which do most of the work.
8190
8191 @item -mgp32
8192 @opindex mgp32
8193 Assume that general-purpose registers are 32 bits wide.
8194
8195 @item -mgp64
8196 @opindex mgp64
8197 Assume that general-purpose registers are 64 bits wide.
8198
8199 @item -mfp32
8200 @opindex mfp32
8201 Assume that floating-point registers are 32 bits wide.
8202
8203 @item -mfp64
8204 @opindex mfp64
8205 Assume that floating-point registers are 64 bits wide.
8206
8207 @item -mhard-float
8208 @opindex mhard-float
8209 Use floating-point coprocessor instructions.
8210
8211 @item -msoft-float
8212 @opindex msoft-float
8213 Do not use floating-point coprocessor instructions.  Implement
8214 floating-point calculations using library calls instead.
8215
8216 @item -msingle-float
8217 @opindex msingle-float
8218 Assume that the floating-point coprocessor only supports single-precision
8219 operations.
8220
8221 @itemx -mdouble-float
8222 @opindex mdouble-float
8223 Assume that the floating-point coprocessor supports double-precision
8224 operations.  This is the default.
8225
8226 @item -mint64
8227 @opindex mint64
8228 Force @code{int} and @code{long} types to be 64 bits wide.  See
8229 @option{-mlong32} for an explanation of the default and the way
8230 that the pointer size is determined.
8231
8232 @item -mlong64
8233 @opindex mlong64
8234 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
8235 an explanation of the default and the way that the pointer size is
8236 determined.
8237
8238 @item -mlong32
8239 @opindex mlong32
8240 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
8241
8242 The default size of @code{int}s, @code{long}s and pointers depends on
8243 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
8244 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
8245 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
8246 or the same size as integer registers, whichever is smaller.
8247
8248 @item -G @var{num}
8249 @opindex G
8250 @cindex smaller data references (MIPS)
8251 @cindex gp-relative references (MIPS)
8252 Put global and static items less than or equal to @var{num} bytes into
8253 the small data or bss section instead of the normal data or bss section.
8254 This allows the data to be accessed using a single instruction.
8255
8256 All modules should be compiled with the same @option{-G @var{num}}
8257 value.
8258
8259 @item -membedded-data
8260 @itemx -mno-embedded-data
8261 @opindex membedded-data
8262 @opindex mno-embedded-data
8263 Allocate variables to the read-only data section first if possible, then
8264 next in the small data section if possible, otherwise in data.  This gives
8265 slightly slower code than the default, but reduces the amount of RAM required
8266 when executing, and thus may be preferred for some embedded systems.
8267
8268 @item -muninit-const-in-rodata
8269 @itemx -mno-uninit-const-in-rodata
8270 @opindex muninit-const-in-rodata
8271 @opindex mno-uninit-const-in-rodata
8272 Put uninitialized @code{const} variables in the read-only data section.
8273 This option is only meaningful in conjunction with @option{-membedded-data}.
8274
8275 @item -msplit-addresses
8276 @itemx -mno-split-addresses
8277 @opindex msplit-addresses
8278 @opindex mno-split-addresses
8279 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
8280 relocation operators.  This option has been superceded by
8281 @option{-mexplicit-relocs} but is retained for backwards compatibility.
8282
8283 @item -mexplicit-relocs
8284 @itemx -mno-explicit-relocs
8285 @opindex mexplicit-relocs
8286 @opindex mno-explicit-relocs
8287 Use (do not use) assembler relocation operators when dealing with symbolic
8288 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
8289 is to use assembler macros instead.
8290
8291 @option{-mexplicit-relocs} is usually the default if GCC was
8292 configured to use an assembler that supports relocation operators.
8293 However, there are two exceptions:
8294
8295 @itemize @bullet
8296 @item
8297 GCC is not yet able to generate explicit relocations for the combination
8298 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
8299 in a future release.
8300
8301 @item
8302 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
8303 implies @option{-mno-explicit-relocs} unless explicitly overridden.
8304 This is because, when generating abicalls, the choice of relocation
8305 depends on whether a symbol is local or global.  In some rare cases,
8306 GCC will not be able to decide this until the whole compilation unit
8307 has been read.
8308 @end itemize
8309
8310 @item -mrnames
8311 @itemx -mno-rnames
8312 @opindex mrnames
8313 @opindex mno-rnames
8314 Generate (do not generate) code that refers to registers using their
8315 software names.  The default is @option{-mno-rnames}, which tells GCC
8316 to use hardware names like @samp{$4} instead of software names like
8317 @samp{a0}.  The only assembler known to support @option{-rnames} is
8318 the Algorithmics assembler.
8319
8320 @item -mcheck-zero-division
8321 @itemx -mno-check-zero-division
8322 @opindex mcheck-zero-division
8323 @opindex mno-check-zero-division
8324 Trap (do not trap) on integer division by zero.  The default is
8325 @option{-mcheck-zero-division}.
8326
8327 @item -mmemcpy
8328 @itemx -mno-memcpy
8329 @opindex mmemcpy
8330 @opindex mno-memcpy
8331 Force (do not force) the use of @code{memcpy()} for non-trivial block
8332 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8333 most constant-sized copies.
8334
8335 @item -mlong-calls
8336 @itemx -mno-long-calls
8337 @opindex mlong-calls
8338 @opindex mno-long-calls
8339 Disable (do not disable) use of the @code{jal} instruction.  Calling
8340 functions using @code{jal} is more efficient but requires the caller
8341 and callee to be in the same 256 megabyte segment.
8342
8343 This option has no effect on abicalls code.  The default is
8344 @option{-mno-long-calls}.
8345
8346 @item -mmad
8347 @itemx -mno-mad
8348 @opindex mmad
8349 @opindex mno-mad
8350 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8351 instructions, as provided by the R4650 ISA.
8352
8353 @item -mfused-madd
8354 @itemx -mno-fused-madd
8355 @opindex mfused-madd
8356 @opindex mno-fused-madd
8357 Enable (disable) use of the floating point multiply-accumulate
8358 instructions, when they are available.  The default is
8359 @option{-mfused-madd}.
8360
8361 When multiply-accumulate instructions are used, the intermediate
8362 product is calculated to infinite precision and is not subject to
8363 the FCSR Flush to Zero bit.  This may be undesirable in some
8364 circumstances.
8365
8366 @item -nocpp
8367 @opindex nocpp
8368 Tell the MIPS assembler to not run its preprocessor over user
8369 assembler files (with a @samp{.s} suffix) when assembling them.
8370
8371 @item -mfix-sb1
8372 @itemx -mno-fix-sb1
8373 @opindex mfix-sb1
8374 Work around certain SB-1 CPU core errata.
8375 (This flag currently works around the SB-1 revision 2
8376 ``F1'' and ``F2'' floating point errata.)
8377
8378 @item -mflush-func=@var{func}
8379 @itemx -mno-flush-func
8380 @opindex mflush-func
8381 Specifies the function to call to flush the I and D caches, or to not
8382 call any such function.  If called, the function must take the same
8383 arguments as the common @code{_flush_func()}, that is, the address of the
8384 memory range for which the cache is being flushed, the size of the
8385 memory range, and the number 3 (to flush both caches).  The default
8386 depends on the target gcc was configured for, but commonly is either
8387 @samp{_flush_func} or @samp{__cpu_flush}.
8388
8389 @item -mbranch-likely
8390 @itemx -mno-branch-likely
8391 @opindex mbranch-likely
8392 @opindex mno-branch-likely
8393 Enable or disable use of Branch Likely instructions, regardless of the
8394 default for the selected architecture.  By default, Branch Likely
8395 instructions may be generated if they are supported by the selected
8396 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8397 and processors which implement those architectures; for those, Branch
8398 Likely instructions will not be generated by default because the MIPS32
8399 and MIPS64 architectures specifically deprecate their use.
8400 @end table
8401
8402 @node i386 and x86-64 Options
8403 @subsection Intel 386 and AMD x86-64 Options
8404 @cindex i386 Options
8405 @cindex x86-64 Options
8406 @cindex Intel 386 Options
8407 @cindex AMD x86-64 Options
8408
8409 These @samp{-m} options are defined for the i386 and x86-64 family of
8410 computers:
8411
8412 @table @gcctabopt
8413 @item -mtune=@var{cpu-type}
8414 @opindex mtune
8415 Tune to @var{cpu-type} everything applicable about the generated code, except
8416 for the ABI and the set of available instructions.  The choices for
8417 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8418 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8419 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8420 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8421 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8422 and @samp{c3-2}.
8423
8424 While picking a specific @var{cpu-type} will schedule things appropriately
8425 for that particular chip, the compiler will not generate any code that
8426 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8427 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8428 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8429 AMD chips as opposed to the Intel ones.
8430
8431 @item -march=@var{cpu-type}
8432 @opindex march
8433 Generate instructions for the machine type @var{cpu-type}.  The choices
8434 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8435 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8436
8437 @item -mcpu=@var{cpu-type}
8438 @opindex mcpu
8439 A deprecated synonym for @option{-mtune}.
8440
8441 @item -m386
8442 @itemx -m486
8443 @itemx -mpentium
8444 @itemx -mpentiumpro
8445 @opindex m386
8446 @opindex m486
8447 @opindex mpentium
8448 @opindex mpentiumpro
8449 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8450 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8451 These synonyms are deprecated.
8452
8453 @item -mfpmath=@var{unit}
8454 @opindex march
8455 generate floating point arithmetics for selected unit @var{unit}.  the choices
8456 for @var{unit} are:
8457
8458 @table @samp
8459 @item 387
8460 Use the standard 387 floating point coprocessor present majority of chips and
8461 emulated otherwise.  Code compiled with this option will run almost everywhere.
8462 The temporary results are computed in 80bit precision instead of precision
8463 specified by the type resulting in slightly different results compared to most
8464 of other chips. See @option{-ffloat-store} for more detailed description.
8465
8466 This is the default choice for i386 compiler.
8467
8468 @item sse
8469 Use scalar floating point instructions present in the SSE instruction set.
8470 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8471 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8472 instruction set supports only single precision arithmetics, thus the double and
8473 extended precision arithmetics is still done using 387.  Later version, present
8474 only in Pentium4 and the future AMD x86-64 chips supports double precision
8475 arithmetics too.
8476
8477 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8478 @option{-msse2} switches to enable SSE extensions and make this option
8479 effective.  For x86-64 compiler, these extensions are enabled by default.
8480
8481 The resulting code should be considerably faster in majority of cases and avoid
8482 the numerical instability problems of 387 code, but may break some existing
8483 code that expects temporaries to be 80bit.
8484
8485 This is the default choice for x86-64 compiler.
8486
8487 @item pni
8488 Use all SSE extensions enabled by @option{-msse2} as well as the new
8489 SSE extensions in Prescott New Instructions. @option{-mpni} also
8490 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8491 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8492 @code{mwait}. 
8493
8494 @item sse,387
8495 Attempt to utilize both instruction sets at once.  This effectively double the
8496 amount of available registers and on chips with separate execution units for
8497 387 and SSE the execution resources too.  Use this option with care, as it is
8498 still experimental, because gcc register allocator does not model separate
8499 functional units well resulting in instable performance.
8500 @end table
8501
8502 @item -masm=@var{dialect}
8503 @opindex masm=@var{dialect}
8504 Output asm instructions using selected @var{dialect}. Supported choices are
8505 @samp{intel} or @samp{att} (the default one).
8506
8507 @item -mieee-fp
8508 @itemx -mno-ieee-fp
8509 @opindex mieee-fp
8510 @opindex mno-ieee-fp
8511 Control whether or not the compiler uses IEEE floating point
8512 comparisons.  These handle correctly the case where the result of a
8513 comparison is unordered.
8514
8515 @item -msoft-float
8516 @opindex msoft-float
8517 Generate output containing library calls for floating point.
8518 @strong{Warning:} the requisite libraries are not part of GCC@.
8519 Normally the facilities of the machine's usual C compiler are used, but
8520 this can't be done directly in cross-compilation.  You must make your
8521 own arrangements to provide suitable library functions for
8522 cross-compilation.
8523
8524 On machines where a function returns floating point results in the 80387
8525 register stack, some floating point opcodes may be emitted even if
8526 @option{-msoft-float} is used.
8527
8528 @item -mno-fp-ret-in-387
8529 @opindex mno-fp-ret-in-387
8530 Do not use the FPU registers for return values of functions.
8531
8532 The usual calling convention has functions return values of types
8533 @code{float} and @code{double} in an FPU register, even if there
8534 is no FPU@.  The idea is that the operating system should emulate
8535 an FPU@.
8536
8537 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8538 in ordinary CPU registers instead.
8539
8540 @item -mno-fancy-math-387
8541 @opindex mno-fancy-math-387
8542 Some 387 emulators do not support the @code{sin}, @code{cos} and
8543 @code{sqrt} instructions for the 387.  Specify this option to avoid
8544 generating those instructions.  This option is the default on FreeBSD,
8545 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8546 indicates that the target cpu will always have an FPU and so the
8547 instruction will not need emulation.  As of revision 2.6.1, these
8548 instructions are not generated unless you also use the
8549 @option{-funsafe-math-optimizations} switch.
8550
8551 @item -malign-double
8552 @itemx -mno-align-double
8553 @opindex malign-double
8554 @opindex mno-align-double
8555 Control whether GCC aligns @code{double}, @code{long double}, and
8556 @code{long long} variables on a two word boundary or a one word
8557 boundary.  Aligning @code{double} variables on a two word boundary will
8558 produce code that runs somewhat faster on a @samp{Pentium} at the
8559 expense of more memory.
8560
8561 @strong{Warning:} if you use the @option{-malign-double} switch,
8562 structures containing the above types will be aligned differently than
8563 the published application binary interface specifications for the 386
8564 and will not be binary compatible with structures in code compiled
8565 without that switch.
8566
8567 @item -m96bit-long-double
8568 @itemx -m128bit-long-double
8569 @opindex m96bit-long-double
8570 @opindex m128bit-long-double
8571 These switches control the size of @code{long double} type. The i386 
8572 application binary interface specifies the size to be 96 bits, 
8573 so @option{-m96bit-long-double} is the default in 32 bit mode.
8574
8575 Modern architectures (Pentium and newer) would prefer @code{long double}
8576 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8577 conforming to the ABI, this would not be possible.  So specifying a 
8578 @option{-m128bit-long-double} will align @code{long double}
8579 to a 16 byte boundary by padding the @code{long double} with an additional
8580 32 bit zero. 
8581
8582 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8583 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8584  
8585 Notice that neither of these options enable any extra precision over the x87
8586 standard of 80 bits for a @code{long double}. 
8587
8588 @strong{Warning:} if you override the default value for your target ABI, the
8589 structures and arrays containing @code{long double} will change their size as
8590 well as function calling convention for function taking @code{long double}
8591 will be modified.  Hence they will not be binary compatible with arrays or
8592 structures in code compiled without that switch.
8593
8594
8595 @item -msvr3-shlib
8596 @itemx -mno-svr3-shlib
8597 @opindex msvr3-shlib
8598 @opindex mno-svr3-shlib
8599 Control whether GCC places uninitialized local variables into the
8600 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8601 into @code{bss}.  These options are meaningful only on System V Release 3.
8602
8603 @item -mrtd
8604 @opindex mrtd
8605 Use a different function-calling convention, in which functions that
8606 take a fixed number of arguments return with the @code{ret} @var{num}
8607 instruction, which pops their arguments while returning.  This saves one
8608 instruction in the caller since there is no need to pop the arguments
8609 there.
8610
8611 You can specify that an individual function is called with this calling
8612 sequence with the function attribute @samp{stdcall}.  You can also
8613 override the @option{-mrtd} option by using the function attribute
8614 @samp{cdecl}.  @xref{Function Attributes}.
8615
8616 @strong{Warning:} this calling convention is incompatible with the one
8617 normally used on Unix, so you cannot use it if you need to call
8618 libraries compiled with the Unix compiler.
8619
8620 Also, you must provide function prototypes for all functions that
8621 take variable numbers of arguments (including @code{printf});
8622 otherwise incorrect code will be generated for calls to those
8623 functions.
8624
8625 In addition, seriously incorrect code will result if you call a
8626 function with too many arguments.  (Normally, extra arguments are
8627 harmlessly ignored.)
8628
8629 @item -mregparm=@var{num}
8630 @opindex mregparm
8631 Control how many registers are used to pass integer arguments.  By
8632 default, no registers are used to pass arguments, and at most 3
8633 registers can be used.  You can control this behavior for a specific
8634 function by using the function attribute @samp{regparm}.
8635 @xref{Function Attributes}.
8636
8637 @strong{Warning:} if you use this switch, and
8638 @var{num} is nonzero, then you must build all modules with the same
8639 value, including any libraries.  This includes the system libraries and
8640 startup modules.
8641
8642 @item -mpreferred-stack-boundary=@var{num}
8643 @opindex mpreferred-stack-boundary
8644 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8645 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8646 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8647 size (@option{-Os}), in which case the default is the minimum correct
8648 alignment (4 bytes for x86, and 8 bytes for x86-64).
8649
8650 On Pentium and PentiumPro, @code{double} and @code{long double} values
8651 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8652 suffer significant run time performance penalties.  On Pentium III, the
8653 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8654 penalties if it is not 16 byte aligned.
8655
8656 To ensure proper alignment of this values on the stack, the stack boundary
8657 must be as aligned as that required by any value stored on the stack.
8658 Further, every function must be generated such that it keeps the stack
8659 aligned.  Thus calling a function compiled with a higher preferred
8660 stack boundary from a function compiled with a lower preferred stack
8661 boundary will most likely misalign the stack.  It is recommended that
8662 libraries that use callbacks always use the default setting.
8663
8664 This extra alignment does consume extra stack space, and generally
8665 increases code size.  Code that is sensitive to stack space usage, such
8666 as embedded systems and operating system kernels, may want to reduce the
8667 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8668
8669 @item -mmmx
8670 @itemx -mno-mmx
8671 @item -msse
8672 @itemx -mno-sse
8673 @item -msse2
8674 @itemx -mno-sse2
8675 @item -mpni
8676 @itemx -mno-pni
8677 @item -m3dnow
8678 @itemx -mno-3dnow
8679 @opindex mmmx
8680 @opindex mno-mmx
8681 @opindex msse
8682 @opindex mno-sse
8683 @opindex m3dnow
8684 @opindex mno-3dnow
8685 These switches enable or disable the use of built-in functions that allow
8686 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8687
8688 @xref{X86 Built-in Functions}, for details of the functions enabled
8689 and disabled by these switches.
8690
8691 To have SSE/SSE2 instructions generated automatically from floating-point
8692 code, see @option{-mfpmath=sse}.
8693
8694 @item -mpush-args
8695 @itemx -mno-push-args
8696 @opindex mpush-args
8697 @opindex mno-push-args
8698 Use PUSH operations to store outgoing parameters.  This method is shorter
8699 and usually equally fast as method using SUB/MOV operations and is enabled
8700 by default.  In some cases disabling it may improve performance because of
8701 improved scheduling and reduced dependencies.
8702
8703 @item -maccumulate-outgoing-args
8704 @opindex maccumulate-outgoing-args
8705 If enabled, the maximum amount of space required for outgoing arguments will be
8706 computed in the function prologue.  This is faster on most modern CPUs
8707 because of reduced dependencies, improved scheduling and reduced stack usage
8708 when preferred stack boundary is not equal to 2.  The drawback is a notable
8709 increase in code size.  This switch implies @option{-mno-push-args}.
8710
8711 @item -mthreads
8712 @opindex mthreads
8713 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8714 on thread-safe exception handling must compile and link all code with the
8715 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8716 @option{-D_MT}; when linking, it links in a special thread helper library
8717 @option{-lmingwthrd} which cleans up per thread exception handling data.
8718
8719 @item -mno-align-stringops
8720 @opindex mno-align-stringops
8721 Do not align destination of inlined string operations.  This switch reduces
8722 code size and improves performance in case the destination is already aligned,
8723 but gcc don't know about it.
8724
8725 @item -minline-all-stringops
8726 @opindex minline-all-stringops
8727 By default GCC inlines string operations only when destination is known to be
8728 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8729 size, but may improve performance of code that depends on fast memcpy, strlen
8730 and memset for short lengths.
8731
8732 @item -momit-leaf-frame-pointer
8733 @opindex momit-leaf-frame-pointer
8734 Don't keep the frame pointer in a register for leaf functions.  This
8735 avoids the instructions to save, set up and restore frame pointers and
8736 makes an extra register available in leaf functions.  The option
8737 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8738 which might make debugging harder.
8739
8740 @item -mtls-direct-seg-refs
8741 @itemx -mno-tls-direct-seg-refs
8742 @opindex mtls-direct-seg-refs
8743 Controls whether TLS variables may be accessed with offsets from the
8744 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8745 or whether the thread base pointer must be added.  Whether or not this
8746 is legal depends on the operating system, and whether it maps the
8747 segment to cover the entire TLS area.
8748
8749 For systems that use GNU libc, the default is on.
8750 @end table
8751
8752 These @samp{-m} switches are supported in addition to the above
8753 on AMD x86-64 processors in 64-bit environments.
8754
8755 @table @gcctabopt
8756 @item -m32
8757 @itemx -m64
8758 @opindex m32
8759 @opindex m64
8760 Generate code for a 32-bit or 64-bit environment.
8761 The 32-bit environment sets int, long and pointer to 32 bits and
8762 generates code that runs on any i386 system.
8763 The 64-bit environment sets int to 32 bits and long and pointer
8764 to 64 bits and generates code for AMD's x86-64 architecture.
8765
8766 @item -mno-red-zone
8767 @opindex no-red-zone
8768 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8769 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8770 stack pointer that will not be modified by signal or interrupt handlers
8771 and therefore can be used for temporary data without adjusting the stack
8772 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8773
8774 @item -mcmodel=small
8775 @opindex mcmodel=small
8776 Generate code for the small code model: the program and its symbols must
8777 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8778 Programs can be statically or dynamically linked.  This is the default
8779 code model.
8780
8781 @item -mcmodel=kernel
8782 @opindex mcmodel=kernel
8783 Generate code for the kernel code model.  The kernel runs in the
8784 negative 2 GB of the address space.
8785 This model has to be used for Linux kernel code.
8786
8787 @item -mcmodel=medium
8788 @opindex mcmodel=medium
8789 Generate code for the medium model: The program is linked in the lower 2
8790 GB of the address space but symbols can be located anywhere in the
8791 address space.  Programs can be statically or dynamically linked, but
8792 building of shared libraries are not supported with the medium model.
8793
8794 @item -mcmodel=large
8795 @opindex mcmodel=large
8796 Generate code for the large model: This model makes no assumptions
8797 about addresses and sizes of sections.  Currently GCC does not implement
8798 this model.
8799 @end table
8800
8801 @node HPPA Options
8802 @subsection HPPA Options
8803 @cindex HPPA Options
8804
8805 These @samp{-m} options are defined for the HPPA family of computers:
8806
8807 @table @gcctabopt
8808 @item -march=@var{architecture-type}
8809 @opindex march
8810 Generate code for the specified architecture.  The choices for
8811 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8812 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8813 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8814 architecture option for your machine.  Code compiled for lower numbered
8815 architectures will run on higher numbered architectures, but not the
8816 other way around.
8817
8818 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8819 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8820 support.
8821
8822 @item -mpa-risc-1-0
8823 @itemx -mpa-risc-1-1
8824 @itemx -mpa-risc-2-0
8825 @opindex mpa-risc-1-0
8826 @opindex mpa-risc-1-1
8827 @opindex mpa-risc-2-0
8828 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8829
8830 @item -mbig-switch
8831 @opindex mbig-switch
8832 Generate code suitable for big switch tables.  Use this option only if
8833 the assembler/linker complain about out of range branches within a switch
8834 table.
8835
8836 @item -mjump-in-delay
8837 @opindex mjump-in-delay
8838 Fill delay slots of function calls with unconditional jump instructions
8839 by modifying the return pointer for the function call to be the target
8840 of the conditional jump.
8841
8842 @item -mdisable-fpregs
8843 @opindex mdisable-fpregs
8844 Prevent floating point registers from being used in any manner.  This is
8845 necessary for compiling kernels which perform lazy context switching of
8846 floating point registers.  If you use this option and attempt to perform
8847 floating point operations, the compiler will abort.
8848
8849 @item -mdisable-indexing
8850 @opindex mdisable-indexing
8851 Prevent the compiler from using indexing address modes.  This avoids some
8852 rather obscure problems when compiling MIG generated code under MACH@.
8853
8854 @item -mno-space-regs
8855 @opindex mno-space-regs
8856 Generate code that assumes the target has no space registers.  This allows
8857 GCC to generate faster indirect calls and use unscaled index address modes.
8858
8859 Such code is suitable for level 0 PA systems and kernels.
8860
8861 @item -mfast-indirect-calls
8862 @opindex mfast-indirect-calls
8863 Generate code that assumes calls never cross space boundaries.  This
8864 allows GCC to emit code which performs faster indirect calls.
8865
8866 This option will not work in the presence of shared libraries or nested
8867 functions.
8868
8869 @item -mlong-load-store
8870 @opindex mlong-load-store
8871 Generate 3-instruction load and store sequences as sometimes required by
8872 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8873 the HP compilers.
8874
8875 @item -mportable-runtime
8876 @opindex mportable-runtime
8877 Use the portable calling conventions proposed by HP for ELF systems.
8878
8879 @item -mgas
8880 @opindex mgas
8881 Enable the use of assembler directives only GAS understands.
8882
8883 @item -mschedule=@var{cpu-type}
8884 @opindex mschedule
8885 Schedule code according to the constraints for the machine type
8886 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8887 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8888 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8889 proper scheduling option for your machine.  The default scheduling is
8890 @samp{8000}.
8891
8892 @item -mlinker-opt
8893 @opindex mlinker-opt
8894 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8895 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8896 linkers in which they give bogus error messages when linking some programs.
8897
8898 @item -msoft-float
8899 @opindex msoft-float
8900 Generate output containing library calls for floating point.
8901 @strong{Warning:} the requisite libraries are not available for all HPPA
8902 targets.  Normally the facilities of the machine's usual C compiler are
8903 used, but this cannot be done directly in cross-compilation.  You must make
8904 your own arrangements to provide suitable library functions for
8905 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8906 does provide software floating point support.
8907
8908 @option{-msoft-float} changes the calling convention in the output file;
8909 therefore, it is only useful if you compile @emph{all} of a program with
8910 this option.  In particular, you need to compile @file{libgcc.a}, the
8911 library that comes with GCC, with @option{-msoft-float} in order for
8912 this to work.
8913
8914 @item -msio
8915 @opindex msio
8916 Generate the predefine, @code{_SIO}, for server IO.  The default is
8917 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8918 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8919 options are available under HP-UX and HI-UX.
8920
8921 @item -mgnu-ld
8922 @opindex gnu-ld
8923 Use GNU ld specific options.  This passes @option{-shared} to ld when
8924 building a shared library.  It is the default when GCC is configured,
8925 explicitly or implicitly, with the GNU linker.  This option does not
8926 have any affect on which ld is called, it only changes what parameters
8927 are passed to that ld.  The ld that is called is determined by the
8928 @option{--with-ld} configure option, gcc's program search path, and
8929 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8930 using @samp{which `gcc -print-prog-name=ld`}.
8931
8932 @item -mhp-ld
8933 @opindex hp-ld
8934 Use HP ld specific options.  This passes @option{-b} to ld when building
8935 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8936 links.  It is the default when GCC is configured, explicitly or
8937 implicitly, with the HP linker.  This option does not have any affect on
8938 which ld is called, it only changes what parameters are passed to that
8939 ld.  The ld that is called is determined by the @option{--with-ld}
8940 configure option, gcc's program search path, and finally by the user's
8941 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8942 `gcc -print-prog-name=ld`}.
8943
8944 @item -mlong-calls
8945 @opindex mno-long-calls
8946 Generate code that uses long call sequences.  This ensures that a call
8947 is always able to reach linker generated stubs.  The default is to generate
8948 long calls only when the distance from the call site to the beginning
8949 of the function or translation unit, as the case may be, exceeds a
8950 predefined limit set by the branch type being used.  The limits for
8951 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8952 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8953 240,000 bytes.
8954
8955 Distances are measured from the beginning of functions when using the
8956 @option{-ffunction-sections} option, or when using the @option{-mgas}
8957 and @option{-mno-portable-runtime} options together under HP-UX with
8958 the SOM linker.
8959
8960 It is normally not desirable to use this option as it will degrade
8961 performance.  However, it may be useful in large applications,
8962 particularly when partial linking is used to build the application.
8963
8964 The types of long calls used depends on the capabilities of the
8965 assembler and linker, and the type of code being generated.  The
8966 impact on systems that support long absolute calls, and long pic
8967 symbol-difference or pc-relative calls should be relatively small.
8968 However, an indirect call is used on 32-bit ELF systems in pic code
8969 and it is quite long.
8970
8971 @item -nolibdld
8972 @opindex nolibdld
8973 Suppress the generation of link options to search libdld.sl when the
8974 @option{-static} option is specified on HP-UX 10 and later.
8975
8976 @item -static
8977 @opindex static
8978 The HP-UX implementation of setlocale in libc has a dependency on
8979 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8980 when the @option{-static} option is specified, special link options
8981 are needed to resolve this dependency.
8982
8983 On HP-UX 10 and later, the GCC driver adds the necessary options to
8984 link with libdld.sl when the @option{-static} option is specified.
8985 This causes the resulting binary to be dynamic.  On the 64-bit port,
8986 the linkers generate dynamic binaries by default in any case.  The
8987 @option{-nolibdld} option can be used to prevent the GCC driver from
8988 adding these link options.
8989
8990 @item -threads
8991 @opindex threads
8992 Add support for multithreading with the @dfn{dce thread} library
8993 under HP-UX.  This option sets flags for both the preprocessor and
8994 linker.
8995 @end table
8996
8997 @node Intel 960 Options
8998 @subsection Intel 960 Options
8999
9000 These @samp{-m} options are defined for the Intel 960 implementations:
9001
9002 @table @gcctabopt
9003 @item -m@var{cpu-type}
9004 @opindex mka
9005 @opindex mkb
9006 @opindex mmc
9007 @opindex mca
9008 @opindex mcf
9009 @opindex msa
9010 @opindex msb
9011 Assume the defaults for the machine type @var{cpu-type} for some of
9012 the other options, including instruction scheduling, floating point
9013 support, and addressing modes.  The choices for @var{cpu-type} are
9014 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
9015 @samp{sa}, and @samp{sb}.
9016 The default is
9017 @samp{kb}.
9018
9019 @item -mnumerics
9020 @itemx -msoft-float
9021 @opindex mnumerics
9022 @opindex msoft-float
9023 The @option{-mnumerics} option indicates that the processor does support
9024 floating-point instructions.  The @option{-msoft-float} option indicates
9025 that floating-point support should not be assumed.
9026
9027 @item -mleaf-procedures
9028 @itemx -mno-leaf-procedures
9029 @opindex mleaf-procedures
9030 @opindex mno-leaf-procedures
9031 Do (or do not) attempt to alter leaf procedures to be callable with the
9032 @code{bal} instruction as well as @code{call}.  This will result in more
9033 efficient code for explicit calls when the @code{bal} instruction can be
9034 substituted by the assembler or linker, but less efficient code in other
9035 cases, such as calls via function pointers, or using a linker that doesn't
9036 support this optimization.
9037
9038 @item -mtail-call
9039 @itemx -mno-tail-call
9040 @opindex mtail-call
9041 @opindex mno-tail-call
9042 Do (or do not) make additional attempts (beyond those of the
9043 machine-independent portions of the compiler) to optimize tail-recursive
9044 calls into branches.  You may not want to do this because the detection of
9045 cases where this is not valid is not totally complete.  The default is
9046 @option{-mno-tail-call}.
9047
9048 @item -mcomplex-addr
9049 @itemx -mno-complex-addr
9050 @opindex mcomplex-addr
9051 @opindex mno-complex-addr
9052 Assume (or do not assume) that the use of a complex addressing mode is a
9053 win on this implementation of the i960.  Complex addressing modes may not
9054 be worthwhile on the K-series, but they definitely are on the C-series.
9055 The default is currently @option{-mcomplex-addr} for all processors except
9056 the CB and CC@.
9057
9058 @item -mcode-align
9059 @itemx -mno-code-align
9060 @opindex mcode-align
9061 @opindex mno-code-align
9062 Align code to 8-byte boundaries for faster fetching (or don't bother).
9063 Currently turned on by default for C-series implementations only.
9064
9065 @ignore
9066 @item -mclean-linkage
9067 @itemx -mno-clean-linkage
9068 @opindex mclean-linkage
9069 @opindex mno-clean-linkage
9070 These options are not fully implemented.
9071 @end ignore
9072
9073 @item -mic-compat
9074 @itemx -mic2.0-compat
9075 @itemx -mic3.0-compat
9076 @opindex mic-compat
9077 @opindex mic2.0-compat
9078 @opindex mic3.0-compat
9079 Enable compatibility with iC960 v2.0 or v3.0.
9080
9081 @item -masm-compat
9082 @itemx -mintel-asm
9083 @opindex masm-compat
9084 @opindex mintel-asm
9085 Enable compatibility with the iC960 assembler.
9086
9087 @item -mstrict-align
9088 @itemx -mno-strict-align
9089 @opindex mstrict-align
9090 @opindex mno-strict-align
9091 Do not permit (do permit) unaligned accesses.
9092
9093 @item -mold-align
9094 @opindex mold-align
9095 Enable structure-alignment compatibility with Intel's gcc release version
9096 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
9097
9098 @item -mlong-double-64
9099 @opindex mlong-double-64
9100 Implement type @samp{long double} as 64-bit floating point numbers.
9101 Without the option @samp{long double} is implemented by 80-bit
9102 floating point numbers.  The only reason we have it because there is
9103 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
9104 is only useful for people using soft-float targets.  Otherwise, we
9105 should recommend against use of it.
9106
9107 @end table
9108
9109 @node DEC Alpha Options
9110 @subsection DEC Alpha Options
9111
9112 These @samp{-m} options are defined for the DEC Alpha implementations:
9113
9114 @table @gcctabopt
9115 @item -mno-soft-float
9116 @itemx -msoft-float
9117 @opindex mno-soft-float
9118 @opindex msoft-float
9119 Use (do not use) the hardware floating-point instructions for
9120 floating-point operations.  When @option{-msoft-float} is specified,
9121 functions in @file{libgcc.a} will be used to perform floating-point
9122 operations.  Unless they are replaced by routines that emulate the
9123 floating-point operations, or compiled in such a way as to call such
9124 emulations routines, these routines will issue floating-point
9125 operations.   If you are compiling for an Alpha without floating-point
9126 operations, you must ensure that the library is built so as not to call
9127 them.
9128
9129 Note that Alpha implementations without floating-point operations are
9130 required to have floating-point registers.
9131
9132 @item -mfp-reg
9133 @itemx -mno-fp-regs
9134 @opindex mfp-reg
9135 @opindex mno-fp-regs
9136 Generate code that uses (does not use) the floating-point register set.
9137 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9138 register set is not used, floating point operands are passed in integer
9139 registers as if they were integers and floating-point results are passed
9140 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9141 so any function with a floating-point argument or return value called by code
9142 compiled with @option{-mno-fp-regs} must also be compiled with that
9143 option.
9144
9145 A typical use of this option is building a kernel that does not use,
9146 and hence need not save and restore, any floating-point registers.
9147
9148 @item -mieee
9149 @opindex mieee
9150 The Alpha architecture implements floating-point hardware optimized for
9151 maximum performance.  It is mostly compliant with the IEEE floating
9152 point standard.  However, for full compliance, software assistance is
9153 required.  This option generates code fully IEEE compliant code
9154 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9155 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9156 defined during compilation.  The resulting code is less efficient but is
9157 able to correctly support denormalized numbers and exceptional IEEE
9158 values such as not-a-number and plus/minus infinity.  Other Alpha
9159 compilers call this option @option{-ieee_with_no_inexact}.
9160
9161 @item -mieee-with-inexact
9162 @opindex mieee-with-inexact
9163 This is like @option{-mieee} except the generated code also maintains
9164 the IEEE @var{inexact-flag}.  Turning on this option causes the
9165 generated code to implement fully-compliant IEEE math.  In addition to
9166 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9167 macro.  On some Alpha implementations the resulting code may execute
9168 significantly slower than the code generated by default.  Since there is
9169 very little code that depends on the @var{inexact-flag}, you should
9170 normally not specify this option.  Other Alpha compilers call this
9171 option @option{-ieee_with_inexact}.
9172
9173 @item -mfp-trap-mode=@var{trap-mode}
9174 @opindex mfp-trap-mode
9175 This option controls what floating-point related traps are enabled.
9176 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9177 The trap mode can be set to one of four values:
9178
9179 @table @samp
9180 @item n
9181 This is the default (normal) setting.  The only traps that are enabled
9182 are the ones that cannot be disabled in software (e.g., division by zero
9183 trap).
9184
9185 @item u
9186 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9187 as well.
9188
9189 @item su
9190 Like @samp{su}, but the instructions are marked to be safe for software
9191 completion (see Alpha architecture manual for details).
9192
9193 @item sui
9194 Like @samp{su}, but inexact traps are enabled as well.
9195 @end table
9196
9197 @item -mfp-rounding-mode=@var{rounding-mode}
9198 @opindex mfp-rounding-mode
9199 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9200 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9201 of:
9202
9203 @table @samp
9204 @item n
9205 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9206 the nearest machine number or towards the even machine number in case
9207 of a tie.
9208
9209 @item m
9210 Round towards minus infinity.
9211
9212 @item c
9213 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9214
9215 @item d
9216 Dynamic rounding mode.  A field in the floating point control register
9217 (@var{fpcr}, see Alpha architecture reference manual) controls the
9218 rounding mode in effect.  The C library initializes this register for
9219 rounding towards plus infinity.  Thus, unless your program modifies the
9220 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9221 @end table
9222
9223 @item -mtrap-precision=@var{trap-precision}
9224 @opindex mtrap-precision
9225 In the Alpha architecture, floating point traps are imprecise.  This
9226 means without software assistance it is impossible to recover from a
9227 floating trap and program execution normally needs to be terminated.
9228 GCC can generate code that can assist operating system trap handlers
9229 in determining the exact location that caused a floating point trap.
9230 Depending on the requirements of an application, different levels of
9231 precisions can be selected:
9232
9233 @table @samp
9234 @item p
9235 Program precision.  This option is the default and means a trap handler
9236 can only identify which program caused a floating point exception.
9237
9238 @item f
9239 Function precision.  The trap handler can determine the function that
9240 caused a floating point exception.
9241
9242 @item i
9243 Instruction precision.  The trap handler can determine the exact
9244 instruction that caused a floating point exception.
9245 @end table
9246
9247 Other Alpha compilers provide the equivalent options called
9248 @option{-scope_safe} and @option{-resumption_safe}.
9249
9250 @item -mieee-conformant
9251 @opindex mieee-conformant
9252 This option marks the generated code as IEEE conformant.  You must not
9253 use this option unless you also specify @option{-mtrap-precision=i} and either
9254 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9255 is to emit the line @samp{.eflag 48} in the function prologue of the
9256 generated assembly file.  Under DEC Unix, this has the effect that
9257 IEEE-conformant math library routines will be linked in.
9258
9259 @item -mbuild-constants
9260 @opindex mbuild-constants
9261 Normally GCC examines a 32- or 64-bit integer constant to
9262 see if it can construct it from smaller constants in two or three
9263 instructions.  If it cannot, it will output the constant as a literal and
9264 generate code to load it from the data segment at runtime.
9265
9266 Use this option to require GCC to construct @emph{all} integer constants
9267 using code, even if it takes more instructions (the maximum is six).
9268
9269 You would typically use this option to build a shared library dynamic
9270 loader.  Itself a shared library, it must relocate itself in memory
9271 before it can find the variables and constants in its own data segment.
9272
9273 @item -malpha-as
9274 @itemx -mgas
9275 @opindex malpha-as
9276 @opindex mgas
9277 Select whether to generate code to be assembled by the vendor-supplied
9278 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9279
9280 @item -mbwx
9281 @itemx -mno-bwx
9282 @itemx -mcix
9283 @itemx -mno-cix
9284 @itemx -mfix
9285 @itemx -mno-fix
9286 @itemx -mmax
9287 @itemx -mno-max
9288 @opindex mbwx
9289 @opindex mno-bwx
9290 @opindex mcix
9291 @opindex mno-cix
9292 @opindex mfix
9293 @opindex mno-fix
9294 @opindex mmax
9295 @opindex mno-max
9296 Indicate whether GCC should generate code to use the optional BWX,
9297 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9298 sets supported by the CPU type specified via @option{-mcpu=} option or that
9299 of the CPU on which GCC was built if none was specified.
9300
9301 @item -mfloat-vax
9302 @itemx -mfloat-ieee
9303 @opindex mfloat-vax
9304 @opindex mfloat-ieee
9305 Generate code that uses (does not use) VAX F and G floating point
9306 arithmetic instead of IEEE single and double precision.
9307
9308 @item -mexplicit-relocs
9309 @itemx -mno-explicit-relocs
9310 @opindex mexplicit-relocs
9311 @opindex mno-explicit-relocs
9312 Older Alpha assemblers provided no way to generate symbol relocations
9313 except via assembler macros.  Use of these macros does not allow
9314 optimal instruction scheduling.  GNU binutils as of version 2.12
9315 supports a new syntax that allows the compiler to explicitly mark
9316 which relocations should apply to which instructions.  This option
9317 is mostly useful for debugging, as GCC detects the capabilities of
9318 the assembler when it is built and sets the default accordingly.
9319
9320 @item -msmall-data
9321 @itemx -mlarge-data
9322 @opindex msmall-data
9323 @opindex mlarge-data
9324 When @option{-mexplicit-relocs} is in effect, static data is
9325 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9326 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9327 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9328 16-bit relocations off of the @code{$gp} register.  This limits the
9329 size of the small data area to 64KB, but allows the variables to be
9330 directly accessed via a single instruction.
9331
9332 The default is @option{-mlarge-data}.  With this option the data area
9333 is limited to just below 2GB.  Programs that require more than 2GB of
9334 data must use @code{malloc} or @code{mmap} to allocate the data in the
9335 heap instead of in the program's data segment.
9336
9337 When generating code for shared libraries, @option{-fpic} implies
9338 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9339
9340 @item -msmall-text
9341 @itemx -mlarge-text
9342 @opindex msmall-text
9343 @opindex mlarge-text
9344 When @option{-msmall-text} is used, the compiler assumes that the
9345 code of the entire program (or shared library) fits in 4MB, and is
9346 thus reachable with a branch instruction.  When @option{-msmall-data}
9347 is used, the compiler can assume that all local symbols share the
9348 same @code{$gp} value, and thus reduce the number of instructions
9349 required for a function call from 4 to 1.
9350
9351 The default is @option{-mlarge-text}.
9352
9353 @item -mcpu=@var{cpu_type}
9354 @opindex mcpu
9355 Set the instruction set and instruction scheduling parameters for
9356 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9357 style name or the corresponding chip number.  GCC supports scheduling
9358 parameters for the EV4, EV5 and EV6 family of processors and will
9359 choose the default values for the instruction set from the processor
9360 you specify.  If you do not specify a processor type, GCC will default
9361 to the processor on which the compiler was built.
9362
9363 Supported values for @var{cpu_type} are
9364
9365 @table @samp
9366 @item ev4
9367 @itemx ev45
9368 @itemx 21064
9369 Schedules as an EV4 and has no instruction set extensions.
9370
9371 @item ev5
9372 @itemx 21164
9373 Schedules as an EV5 and has no instruction set extensions.
9374
9375 @item ev56
9376 @itemx 21164a
9377 Schedules as an EV5 and supports the BWX extension.
9378
9379 @item pca56
9380 @itemx 21164pc
9381 @itemx 21164PC
9382 Schedules as an EV5 and supports the BWX and MAX extensions.
9383
9384 @item ev6
9385 @itemx 21264
9386 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9387
9388 @item ev67
9389 @itemx 21264a
9390 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9391 @end table
9392
9393 @item -mtune=@var{cpu_type}
9394 @opindex mtune
9395 Set only the instruction scheduling parameters for machine type
9396 @var{cpu_type}.  The instruction set is not changed.
9397
9398 @item -mmemory-latency=@var{time}
9399 @opindex mmemory-latency
9400 Sets the latency the scheduler should assume for typical memory
9401 references as seen by the application.  This number is highly
9402 dependent on the memory access patterns used by the application
9403 and the size of the external cache on the machine.
9404
9405 Valid options for @var{time} are
9406
9407 @table @samp
9408 @item @var{number}
9409 A decimal number representing clock cycles.
9410
9411 @item L1
9412 @itemx L2
9413 @itemx L3
9414 @itemx main
9415 The compiler contains estimates of the number of clock cycles for
9416 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9417 (also called Dcache, Scache, and Bcache), as well as to main memory.
9418 Note that L3 is only valid for EV5.
9419
9420 @end table
9421 @end table
9422
9423 @node DEC Alpha/VMS Options
9424 @subsection DEC Alpha/VMS Options
9425
9426 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9427
9428 @table @gcctabopt
9429 @item -mvms-return-codes
9430 @opindex mvms-return-codes
9431 Return VMS condition codes from main.  The default is to return POSIX
9432 style condition (e.g.@ error) codes.
9433 @end table
9434
9435 @node H8/300 Options
9436 @subsection H8/300 Options
9437
9438 These @samp{-m} options are defined for the H8/300 implementations:
9439
9440 @table @gcctabopt
9441 @item -mrelax
9442 @opindex mrelax
9443 Shorten some address references at link time, when possible; uses the
9444 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9445 ld, Using ld}, for a fuller description.
9446
9447 @item -mh
9448 @opindex mh
9449 Generate code for the H8/300H@.
9450
9451 @item -ms
9452 @opindex ms
9453 Generate code for the H8S@.
9454
9455 @item -mn
9456 @opindex mn
9457 Generate code for the H8S and H8/300H in the normal mode.  This switch
9458 must be used either with -mh or -ms.
9459
9460 @item -ms2600
9461 @opindex ms2600
9462 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9463
9464 @item -mint32
9465 @opindex mint32
9466 Make @code{int} data 32 bits by default.
9467
9468 @item -malign-300
9469 @opindex malign-300
9470 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9471 The default for the H8/300H and H8S is to align longs and floats on 4
9472 byte boundaries.
9473 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9474 This option has no effect on the H8/300.
9475 @end table
9476
9477 @node SH Options
9478 @subsection SH Options
9479
9480 These @samp{-m} options are defined for the SH implementations:
9481
9482 @table @gcctabopt
9483 @item -m1
9484 @opindex m1
9485 Generate code for the SH1.
9486
9487 @item -m2
9488 @opindex m2
9489 Generate code for the SH2.
9490
9491 @item -m2e
9492 Generate code for the SH2e.
9493
9494 @item -m3
9495 @opindex m3
9496 Generate code for the SH3.
9497
9498 @item -m3e
9499 @opindex m3e
9500 Generate code for the SH3e.
9501
9502 @item -m4-nofpu
9503 @opindex m4-nofpu
9504 Generate code for the SH4 without a floating-point unit.
9505
9506 @item -m4-single-only
9507 @opindex m4-single-only
9508 Generate code for the SH4 with a floating-point unit that only
9509 supports single-precision arithmetic.
9510
9511 @item -m4-single
9512 @opindex m4-single
9513 Generate code for the SH4 assuming the floating-point unit is in
9514 single-precision mode by default.
9515
9516 @item -m4
9517 @opindex m4
9518 Generate code for the SH4.
9519
9520 @item -mb
9521 @opindex mb
9522 Compile code for the processor in big endian mode.
9523
9524 @item -ml
9525 @opindex ml
9526 Compile code for the processor in little endian mode.
9527
9528 @item -mdalign
9529 @opindex mdalign
9530 Align doubles at 64-bit boundaries.  Note that this changes the calling
9531 conventions, and thus some functions from the standard C library will
9532 not work unless you recompile it first with @option{-mdalign}.
9533
9534 @item -mrelax
9535 @opindex mrelax
9536 Shorten some address references at link time, when possible; uses the
9537 linker option @option{-relax}.
9538
9539 @item -mbigtable
9540 @opindex mbigtable
9541 Use 32-bit offsets in @code{switch} tables.  The default is to use
9542 16-bit offsets.
9543
9544 @item -mfmovd
9545 @opindex mfmovd
9546 Enable the use of the instruction @code{fmovd}.
9547
9548 @item -mhitachi
9549 @opindex mhitachi
9550 Comply with the calling conventions defined by Renesas.
9551
9552 @item -mnomacsave
9553 @opindex mnomacsave
9554 Mark the @code{MAC} register as call-clobbered, even if
9555 @option{-mhitachi} is given.
9556
9557 @item -mieee
9558 @opindex mieee
9559 Increase IEEE-compliance of floating-point code.
9560
9561 @item -misize
9562 @opindex misize
9563 Dump instruction size and location in the assembly code.
9564
9565 @item -mpadstruct
9566 @opindex mpadstruct
9567 This option is deprecated.  It pads structures to multiple of 4 bytes,
9568 which is incompatible with the SH ABI@.
9569
9570 @item -mspace
9571 @opindex mspace
9572 Optimize for space instead of speed.  Implied by @option{-Os}.
9573
9574 @item -mprefergot
9575 @opindex mprefergot
9576 When generating position-independent code, emit function calls using
9577 the Global Offset Table instead of the Procedure Linkage Table.
9578
9579 @item -musermode
9580 @opindex musermode
9581 Generate a library function call to invalidate instruction cache
9582 entries, after fixing up a trampoline.  This library function call
9583 doesn't assume it can write to the whole memory address space.  This
9584 is the default when the target is @code{sh-*-linux*}.
9585 @end table
9586
9587 @node System V Options
9588 @subsection Options for System V
9589
9590 These additional options are available on System V Release 4 for
9591 compatibility with other compilers on those systems:
9592
9593 @table @gcctabopt
9594 @item -G
9595 @opindex G
9596 Create a shared object.
9597 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9598
9599 @item -Qy
9600 @opindex Qy
9601 Identify the versions of each tool used by the compiler, in a
9602 @code{.ident} assembler directive in the output.
9603
9604 @item -Qn
9605 @opindex Qn
9606 Refrain from adding @code{.ident} directives to the output file (this is
9607 the default).
9608
9609 @item -YP,@var{dirs}
9610 @opindex YP
9611 Search the directories @var{dirs}, and no others, for libraries
9612 specified with @option{-l}.
9613
9614 @item -Ym,@var{dir}
9615 @opindex Ym
9616 Look in the directory @var{dir} to find the M4 preprocessor.
9617 The assembler uses this option.
9618 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9619 @c the generic assembler that comes with Solaris takes just -Ym.
9620 @end table
9621
9622 @node TMS320C3x/C4x Options
9623 @subsection TMS320C3x/C4x Options
9624 @cindex TMS320C3x/C4x Options
9625
9626 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9627
9628 @table @gcctabopt
9629
9630 @item -mcpu=@var{cpu_type}
9631 @opindex mcpu
9632 Set the instruction set, register set, and instruction scheduling
9633 parameters for machine type @var{cpu_type}.  Supported values for
9634 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9635 @samp{c44}.  The default is @samp{c40} to generate code for the
9636 TMS320C40.
9637
9638 @item -mbig-memory
9639 @itemx -mbig
9640 @itemx -msmall-memory
9641 @itemx -msmall
9642 @opindex mbig-memory
9643 @opindex mbig
9644 @opindex msmall-memory
9645 @opindex msmall
9646 Generates code for the big or small memory model.  The small memory
9647 model assumed that all data fits into one 64K word page.  At run-time
9648 the data page (DP) register must be set to point to the 64K page
9649 containing the .bss and .data program sections.  The big memory model is
9650 the default and requires reloading of the DP register for every direct
9651 memory access.
9652
9653 @item -mbk
9654 @itemx -mno-bk
9655 @opindex mbk
9656 @opindex mno-bk
9657 Allow (disallow) allocation of general integer operands into the block
9658 count register BK@.
9659
9660 @item -mdb
9661 @itemx -mno-db
9662 @opindex mdb
9663 @opindex mno-db
9664 Enable (disable) generation of code using decrement and branch,
9665 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9666 on the safe side, this is disabled for the C3x, since the maximum
9667 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9668 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9669 that it can utilize the decrement and branch instruction, but will give
9670 up if there is more than one memory reference in the loop.  Thus a loop
9671 where the loop counter is decremented can generate slightly more
9672 efficient code, in cases where the RPTB instruction cannot be utilized.
9673
9674 @item -mdp-isr-reload
9675 @itemx -mparanoid
9676 @opindex mdp-isr-reload
9677 @opindex mparanoid
9678 Force the DP register to be saved on entry to an interrupt service
9679 routine (ISR), reloaded to point to the data section, and restored on
9680 exit from the ISR@.  This should not be required unless someone has
9681 violated the small memory model by modifying the DP register, say within
9682 an object library.
9683
9684 @item -mmpyi
9685 @itemx -mno-mpyi
9686 @opindex mmpyi
9687 @opindex mno-mpyi
9688 For the C3x use the 24-bit MPYI instruction for integer multiplies
9689 instead of a library call to guarantee 32-bit results.  Note that if one
9690 of the operands is a constant, then the multiplication will be performed
9691 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9692 then squaring operations are performed inline instead of a library call.
9693
9694 @item -mfast-fix
9695 @itemx -mno-fast-fix
9696 @opindex mfast-fix
9697 @opindex mno-fast-fix
9698 The C3x/C4x FIX instruction to convert a floating point value to an
9699 integer value chooses the nearest integer less than or equal to the
9700 floating point value rather than to the nearest integer.  Thus if the
9701 floating point number is negative, the result will be incorrectly
9702 truncated an additional code is necessary to detect and correct this
9703 case.  This option can be used to disable generation of the additional
9704 code required to correct the result.
9705
9706 @item -mrptb
9707 @itemx -mno-rptb
9708 @opindex mrptb
9709 @opindex mno-rptb
9710 Enable (disable) generation of repeat block sequences using the RPTB
9711 instruction for zero overhead looping.  The RPTB construct is only used
9712 for innermost loops that do not call functions or jump across the loop
9713 boundaries.  There is no advantage having nested RPTB loops due to the
9714 overhead required to save and restore the RC, RS, and RE registers.
9715 This is enabled by default with @option{-O2}.
9716
9717 @item -mrpts=@var{count}
9718 @itemx -mno-rpts
9719 @opindex mrpts
9720 @opindex mno-rpts
9721 Enable (disable) the use of the single instruction repeat instruction
9722 RPTS@.  If a repeat block contains a single instruction, and the loop
9723 count can be guaranteed to be less than the value @var{count}, GCC will
9724 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9725 then a RPTS will be emitted even if the loop count cannot be determined
9726 at compile time.  Note that the repeated instruction following RPTS does
9727 not have to be reloaded from memory each iteration, thus freeing up the
9728 CPU buses for operands.  However, since interrupts are blocked by this
9729 instruction, it is disabled by default.
9730
9731 @item -mloop-unsigned
9732 @itemx -mno-loop-unsigned
9733 @opindex mloop-unsigned
9734 @opindex mno-loop-unsigned
9735 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9736 is @math{2^{31} + 1} since these instructions test if the iteration count is
9737 negative to terminate the loop.  If the iteration count is unsigned
9738 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9739 exceeded.  This switch allows an unsigned iteration count.
9740
9741 @item -mti
9742 @opindex mti
9743 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9744 with.  This also enforces compatibility with the API employed by the TI
9745 C3x C compiler.  For example, long doubles are passed as structures
9746 rather than in floating point registers.
9747
9748 @item -mregparm
9749 @itemx -mmemparm
9750 @opindex mregparm
9751 @opindex mmemparm
9752 Generate code that uses registers (stack) for passing arguments to functions.
9753 By default, arguments are passed in registers where possible rather
9754 than by pushing arguments on to the stack.
9755
9756 @item -mparallel-insns
9757 @itemx -mno-parallel-insns
9758 @opindex mparallel-insns
9759 @opindex mno-parallel-insns
9760 Allow the generation of parallel instructions.  This is enabled by
9761 default with @option{-O2}.
9762
9763 @item -mparallel-mpy
9764 @itemx -mno-parallel-mpy
9765 @opindex mparallel-mpy
9766 @opindex mno-parallel-mpy
9767 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9768 provided @option{-mparallel-insns} is also specified.  These instructions have
9769 tight register constraints which can pessimize the code generation
9770 of large functions.
9771
9772 @end table
9773
9774 @node V850 Options
9775 @subsection V850 Options
9776 @cindex V850 Options
9777
9778 These @samp{-m} options are defined for V850 implementations:
9779
9780 @table @gcctabopt
9781 @item -mlong-calls
9782 @itemx -mno-long-calls
9783 @opindex mlong-calls
9784 @opindex mno-long-calls
9785 Treat all calls as being far away (near).  If calls are assumed to be
9786 far away, the compiler will always load the functions address up into a
9787 register, and call indirect through the pointer.
9788
9789 @item -mno-ep
9790 @itemx -mep
9791 @opindex mno-ep
9792 @opindex mep
9793 Do not optimize (do optimize) basic blocks that use the same index
9794 pointer 4 or more times to copy pointer into the @code{ep} register, and
9795 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9796 option is on by default if you optimize.
9797
9798 @item -mno-prolog-function
9799 @itemx -mprolog-function
9800 @opindex mno-prolog-function
9801 @opindex mprolog-function
9802 Do not use (do use) external functions to save and restore registers
9803 at the prologue and epilogue of a function.  The external functions
9804 are slower, but use less code space if more than one function saves
9805 the same number of registers.  The @option{-mprolog-function} option
9806 is on by default if you optimize.
9807
9808 @item -mspace
9809 @opindex mspace
9810 Try to make the code as small as possible.  At present, this just turns
9811 on the @option{-mep} and @option{-mprolog-function} options.
9812
9813 @item -mtda=@var{n}
9814 @opindex mtda
9815 Put static or global variables whose size is @var{n} bytes or less into
9816 the tiny data area that register @code{ep} points to.  The tiny data
9817 area can hold up to 256 bytes in total (128 bytes for byte references).
9818
9819 @item -msda=@var{n}
9820 @opindex msda
9821 Put static or global variables whose size is @var{n} bytes or less into
9822 the small data area that register @code{gp} points to.  The small data
9823 area can hold up to 64 kilobytes.
9824
9825 @item -mzda=@var{n}
9826 @opindex mzda
9827 Put static or global variables whose size is @var{n} bytes or less into
9828 the first 32 kilobytes of memory.
9829
9830 @item -mv850
9831 @opindex mv850
9832 Specify that the target processor is the V850.
9833
9834 @item -mbig-switch
9835 @opindex mbig-switch
9836 Generate code suitable for big switch tables.  Use this option only if
9837 the assembler/linker complain about out of range branches within a switch
9838 table.
9839
9840 @item -mapp-regs
9841 @opindex mapp-regs
9842 This option will cause r2 and r5 to be used in the code generated by
9843 the compiler.  This setting is the default.
9844
9845 @item -mno-app-regs
9846 @opindex mno-app-regs
9847 This option will cause r2 and r5 to be treated as fixed registers.
9848   
9849 @item -mv850e1
9850 @opindex mv850e1
9851 Specify that the target processor is the V850E1.  The preprocessor
9852 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9853 this option is used.
9854
9855 @item -mv850e
9856 @opindex mv850e
9857 Specify that the target processor is the V850E.  The preprocessor
9858 constant @samp{__v850e__} will be defined if this option is used.
9859
9860 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9861 are defined then a default target processor will be chosen and the
9862 relevant @samp{__v850*__} preprocessor constant will be defined.
9863
9864 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9865 defined, regardless of which processor variant is the target.
9866
9867 @item -mdisable-callt
9868 @opindex mdisable-callt
9869 This option will suppress generation of the CALLT instruction for the
9870 v850e and v850e1 flavors of the v850 architecture.  The default is
9871 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9872
9873 @end table
9874
9875 @node ARC Options
9876 @subsection ARC Options
9877 @cindex ARC Options
9878
9879 These options are defined for ARC implementations:
9880
9881 @table @gcctabopt
9882 @item -EL
9883 @opindex EL
9884 Compile code for little endian mode.  This is the default.
9885
9886 @item -EB
9887 @opindex EB
9888 Compile code for big endian mode.
9889
9890 @item -mmangle-cpu
9891 @opindex mmangle-cpu
9892 Prepend the name of the cpu to all public symbol names.
9893 In multiple-processor systems, there are many ARC variants with different
9894 instruction and register set characteristics.  This flag prevents code
9895 compiled for one cpu to be linked with code compiled for another.
9896 No facility exists for handling variants that are ``almost identical''.
9897 This is an all or nothing option.
9898
9899 @item -mcpu=@var{cpu}
9900 @opindex mcpu
9901 Compile code for ARC variant @var{cpu}.
9902 Which variants are supported depend on the configuration.
9903 All variants support @option{-mcpu=base}, this is the default.
9904
9905 @item -mtext=@var{text-section}
9906 @itemx -mdata=@var{data-section}
9907 @itemx -mrodata=@var{readonly-data-section}
9908 @opindex mtext
9909 @opindex mdata
9910 @opindex mrodata
9911 Put functions, data, and readonly data in @var{text-section},
9912 @var{data-section}, and @var{readonly-data-section} respectively
9913 by default.  This can be overridden with the @code{section} attribute.
9914 @xref{Variable Attributes}.
9915
9916 @end table
9917
9918 @node NS32K Options
9919 @subsection NS32K Options
9920 @cindex NS32K options
9921
9922 These are the @samp{-m} options defined for the 32000 series.  The default
9923 values for these options depends on which style of 32000 was selected when
9924 the compiler was configured; the defaults for the most common choices are
9925 given below.
9926
9927 @table @gcctabopt
9928 @item -m32032
9929 @itemx -m32032
9930 @opindex m32032
9931 @opindex m32032
9932 Generate output for a 32032.  This is the default
9933 when the compiler is configured for 32032 and 32016 based systems.
9934
9935 @item -m32332
9936 @itemx -m32332
9937 @opindex m32332
9938 @opindex m32332
9939 Generate output for a 32332.  This is the default
9940 when the compiler is configured for 32332-based systems.
9941
9942 @item -m32532
9943 @itemx -m32532
9944 @opindex m32532
9945 @opindex m32532
9946 Generate output for a 32532.  This is the default
9947 when the compiler is configured for 32532-based systems.
9948
9949 @item -m32081
9950 @opindex m32081
9951 Generate output containing 32081 instructions for floating point.
9952 This is the default for all systems.
9953
9954 @item -m32381
9955 @opindex m32381
9956 Generate output containing 32381 instructions for floating point.  This
9957 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9958 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9959
9960 @item -mmulti-add
9961 @opindex mmulti-add
9962 Try and generate multiply-add floating point instructions @code{polyF}
9963 and @code{dotF}.  This option is only available if the @option{-m32381}
9964 option is in effect.  Using these instructions requires changes to
9965 register allocation which generally has a negative impact on
9966 performance.  This option should only be enabled when compiling code
9967 particularly likely to make heavy use of multiply-add instructions.
9968
9969 @item -mnomulti-add
9970 @opindex mnomulti-add
9971 Do not try and generate multiply-add floating point instructions
9972 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9973
9974 @item -msoft-float
9975 @opindex msoft-float
9976 Generate output containing library calls for floating point.
9977 @strong{Warning:} the requisite libraries may not be available.
9978
9979 @item -mieee-compare
9980 @itemx -mno-ieee-compare
9981 @opindex mieee-compare
9982 @opindex mno-ieee-compare
9983 Control whether or not the compiler uses IEEE floating point
9984 comparisons.  These handle correctly the case where the result of a
9985 comparison is unordered.
9986 @strong{Warning:} the requisite kernel support may not be available.
9987
9988 @item -mnobitfield
9989 @opindex mnobitfield
9990 Do not use the bit-field instructions.  On some machines it is faster to
9991 use shifting and masking operations.  This is the default for the pc532.
9992
9993 @item -mbitfield
9994 @opindex mbitfield
9995 Do use the bit-field instructions.  This is the default for all platforms
9996 except the pc532.
9997
9998 @item -mrtd
9999 @opindex mrtd
10000 Use a different function-calling convention, in which functions
10001 that take a fixed number of arguments return pop their
10002 arguments on return with the @code{ret} instruction.
10003
10004 This calling convention is incompatible with the one normally
10005 used on Unix, so you cannot use it if you need to call libraries
10006 compiled with the Unix compiler.
10007
10008 Also, you must provide function prototypes for all functions that
10009 take variable numbers of arguments (including @code{printf});
10010 otherwise incorrect code will be generated for calls to those
10011 functions.
10012
10013 In addition, seriously incorrect code will result if you call a
10014 function with too many arguments.  (Normally, extra arguments are
10015 harmlessly ignored.)
10016
10017 This option takes its name from the 680x0 @code{rtd} instruction.
10018
10019
10020 @item -mregparam
10021 @opindex mregparam
10022 Use a different function-calling convention where the first two arguments
10023 are passed in registers.
10024
10025 This calling convention is incompatible with the one normally
10026 used on Unix, so you cannot use it if you need to call libraries
10027 compiled with the Unix compiler.
10028
10029 @item -mnoregparam
10030 @opindex mnoregparam
10031 Do not pass any arguments in registers.  This is the default for all
10032 targets.
10033
10034 @item -msb
10035 @opindex msb
10036 It is OK to use the sb as an index register which is always loaded with
10037 zero.  This is the default for the pc532-netbsd target.
10038
10039 @item -mnosb
10040 @opindex mnosb
10041 The sb register is not available for use or has not been initialized to
10042 zero by the run time system.  This is the default for all targets except
10043 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10044 @option{-fpic} is set.
10045
10046 @item -mhimem
10047 @opindex mhimem
10048 Many ns32000 series addressing modes use displacements of up to 512MB@.
10049 If an address is above 512MB then displacements from zero can not be used.
10050 This option causes code to be generated which can be loaded above 512MB@.
10051 This may be useful for operating systems or ROM code.
10052
10053 @item -mnohimem
10054 @opindex mnohimem
10055 Assume code will be loaded in the first 512MB of virtual address space.
10056 This is the default for all platforms.
10057
10058
10059 @end table
10060
10061 @node AVR Options
10062 @subsection AVR Options
10063 @cindex AVR Options
10064
10065 These options are defined for AVR implementations:
10066
10067 @table @gcctabopt
10068 @item -mmcu=@var{mcu}
10069 @opindex mmcu
10070 Specify ATMEL AVR instruction set or MCU type.
10071
10072 Instruction set avr1 is for the minimal AVR core, not supported by the C
10073 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10074 attiny11, attiny12, attiny15, attiny28).
10075
10076 Instruction set avr2 (default) is for the classic AVR core with up to
10077 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10078 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10079 at90c8534, at90s8535).
10080
10081 Instruction set avr3 is for the classic AVR core with up to 128K program
10082 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10083
10084 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10085 memory space (MCU types: atmega8, atmega83, atmega85).
10086
10087 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10088 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10089 atmega64, atmega128, at43usb355, at94k).
10090
10091 @item -msize
10092 @opindex msize
10093 Output instruction sizes to the asm file.
10094
10095 @item -minit-stack=@var{N}
10096 @opindex minit-stack
10097 Specify the initial stack address, which may be a symbol or numeric value,
10098 @samp{__stack} is the default.
10099
10100 @item -mno-interrupts
10101 @opindex mno-interrupts
10102 Generated code is not compatible with hardware interrupts.
10103 Code size will be smaller.
10104
10105 @item -mcall-prologues
10106 @opindex mcall-prologues
10107 Functions prologues/epilogues expanded as call to appropriate
10108 subroutines.  Code size will be smaller.
10109
10110 @item -mno-tablejump
10111 @opindex mno-tablejump
10112 Do not generate tablejump insns which sometimes increase code size.
10113
10114 @item -mtiny-stack
10115 @opindex mtiny-stack
10116 Change only the low 8 bits of the stack pointer.
10117 @end table
10118
10119 @node MCore Options
10120 @subsection MCore Options
10121 @cindex MCore options
10122
10123 These are the @samp{-m} options defined for the Motorola M*Core
10124 processors.
10125
10126 @table @gcctabopt
10127
10128 @item -mhardlit
10129 @itemx -mno-hardlit
10130 @opindex mhardlit
10131 @opindex mno-hardlit
10132 Inline constants into the code stream if it can be done in two
10133 instructions or less.
10134
10135 @item -mdiv
10136 @itemx -mno-div
10137 @opindex mdiv
10138 @opindex mno-div
10139 Use the divide instruction.  (Enabled by default).
10140
10141 @item -mrelax-immediate
10142 @itemx -mno-relax-immediate
10143 @opindex mrelax-immediate
10144 @opindex mno-relax-immediate
10145 Allow arbitrary sized immediates in bit operations.
10146
10147 @item -mwide-bitfields
10148 @itemx -mno-wide-bitfields
10149 @opindex mwide-bitfields
10150 @opindex mno-wide-bitfields
10151 Always treat bit-fields as int-sized.
10152
10153 @item -m4byte-functions
10154 @itemx -mno-4byte-functions
10155 @opindex m4byte-functions
10156 @opindex mno-4byte-functions
10157 Force all functions to be aligned to a four byte boundary.
10158
10159 @item -mcallgraph-data
10160 @itemx -mno-callgraph-data
10161 @opindex mcallgraph-data
10162 @opindex mno-callgraph-data
10163 Emit callgraph information.
10164
10165 @item -mslow-bytes
10166 @itemx -mno-slow-bytes
10167 @opindex mslow-bytes
10168 @opindex mno-slow-bytes
10169 Prefer word access when reading byte quantities.
10170
10171 @item -mlittle-endian
10172 @itemx -mbig-endian
10173 @opindex mlittle-endian
10174 @opindex mbig-endian
10175 Generate code for a little endian target.
10176
10177 @item -m210
10178 @itemx -m340
10179 @opindex m210
10180 @opindex m340
10181 Generate code for the 210 processor.
10182 @end table
10183
10184 @node IA-64 Options
10185 @subsection IA-64 Options
10186 @cindex IA-64 Options
10187
10188 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10189
10190 @table @gcctabopt
10191 @item -mbig-endian
10192 @opindex mbig-endian
10193 Generate code for a big endian target.  This is the default for HP-UX@.
10194
10195 @item -mlittle-endian
10196 @opindex mlittle-endian
10197 Generate code for a little endian target.  This is the default for AIX5
10198 and Linux.
10199
10200 @item -mgnu-as
10201 @itemx -mno-gnu-as
10202 @opindex mgnu-as
10203 @opindex mno-gnu-as
10204 Generate (or don't) code for the GNU assembler.  This is the default.
10205 @c Also, this is the default if the configure option @option{--with-gnu-as}
10206 @c is used.
10207
10208 @item -mgnu-ld
10209 @itemx -mno-gnu-ld
10210 @opindex mgnu-ld
10211 @opindex mno-gnu-ld
10212 Generate (or don't) code for the GNU linker.  This is the default.
10213 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10214 @c is used.
10215
10216 @item -mno-pic
10217 @opindex mno-pic
10218 Generate code that does not use a global pointer register.  The result
10219 is not position independent code, and violates the IA-64 ABI@.
10220
10221 @item -mvolatile-asm-stop
10222 @itemx -mno-volatile-asm-stop
10223 @opindex mvolatile-asm-stop
10224 @opindex mno-volatile-asm-stop
10225 Generate (or don't) a stop bit immediately before and after volatile asm
10226 statements.
10227
10228 @item -mb-step
10229 @opindex mb-step
10230 Generate code that works around Itanium B step errata.
10231
10232 @item -mregister-names
10233 @itemx -mno-register-names
10234 @opindex mregister-names
10235 @opindex mno-register-names
10236 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10237 the stacked registers.  This may make assembler output more readable.
10238
10239 @item -mno-sdata
10240 @itemx -msdata
10241 @opindex mno-sdata
10242 @opindex msdata
10243 Disable (or enable) optimizations that use the small data section.  This may
10244 be useful for working around optimizer bugs.
10245
10246 @item -mconstant-gp
10247 @opindex mconstant-gp
10248 Generate code that uses a single constant global pointer value.  This is
10249 useful when compiling kernel code.
10250
10251 @item -mauto-pic
10252 @opindex mauto-pic
10253 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10254 This is useful when compiling firmware code.
10255
10256 @item -minline-float-divide-min-latency
10257 @opindex minline-float-divide-min-latency
10258 Generate code for inline divides of floating point values
10259 using the minimum latency algorithm.
10260
10261 @item -minline-float-divide-max-throughput
10262 @opindex minline-float-divide-max-throughput
10263 Generate code for inline divides of floating point values
10264 using the maximum throughput algorithm.
10265
10266 @item -minline-int-divide-min-latency
10267 @opindex minline-int-divide-min-latency
10268 Generate code for inline divides of integer values
10269 using the minimum latency algorithm.
10270
10271 @item -minline-int-divide-max-throughput
10272 @opindex minline-int-divide-max-throughput
10273 Generate code for inline divides of integer values
10274 using the maximum throughput algorithm.
10275
10276 @item -mno-dwarf2-asm
10277 @itemx -mdwarf2-asm
10278 @opindex mno-dwarf2-asm
10279 @opindex mdwarf2-asm
10280 Don't (or do) generate assembler code for the DWARF2 line number debugging
10281 info.  This may be useful when not using the GNU assembler.
10282
10283 @item -mfixed-range=@var{register-range}
10284 @opindex mfixed-range
10285 Generate code treating the given register range as fixed registers.
10286 A fixed register is one that the register allocator can not use.  This is
10287 useful when compiling kernel code.  A register range is specified as
10288 two registers separated by a dash.  Multiple register ranges can be
10289 specified separated by a comma.
10290
10291 @item -mearly-stop-bits
10292 @itemx -mno-early-stop-bits
10293 @opindex mearly-stop-bits
10294 @opindex mno-early-stop-bits
10295 Allow stop bits to be placed earlier than immediately preceding the
10296 instruction that triggered the stop bit.  This can improve instruction
10297 scheduling, but does not always do so.
10298 @end table
10299
10300 @node D30V Options
10301 @subsection D30V Options
10302 @cindex D30V Options
10303
10304 These @samp{-m} options are defined for D30V implementations:
10305
10306 @table @gcctabopt
10307 @item -mextmem
10308 @opindex mextmem
10309 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10310 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10311 memory, which starts at location @code{0x80000000}.
10312
10313 @item -mextmemory
10314 @opindex mextmemory
10315 Same as the @option{-mextmem} switch.
10316
10317 @item -monchip
10318 @opindex monchip
10319 Link the @samp{.text} section into onchip text memory, which starts at
10320 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10321 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10322 into onchip data memory, which starts at location @code{0x20000000}.
10323
10324 @item -mno-asm-optimize
10325 @itemx -masm-optimize
10326 @opindex mno-asm-optimize
10327 @opindex masm-optimize
10328 Disable (enable) passing @option{-O} to the assembler when optimizing.
10329 The assembler uses the @option{-O} option to automatically parallelize
10330 adjacent short instructions where possible.
10331
10332 @item -mbranch-cost=@var{n}
10333 @opindex mbranch-cost
10334 Increase the internal costs of branches to @var{n}.  Higher costs means
10335 that the compiler will issue more instructions to avoid doing a branch.
10336 The default is 2.
10337
10338 @item -mcond-exec=@var{n}
10339 @opindex mcond-exec
10340 Specify the maximum number of conditionally executed instructions that
10341 replace a branch.  The default is 4.
10342 @end table
10343
10344 @node S/390 and zSeries Options
10345 @subsection S/390 and zSeries Options
10346 @cindex S/390 and zSeries Options
10347
10348 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10349
10350 @table @gcctabopt
10351 @item -mhard-float
10352 @itemx -msoft-float
10353 @opindex mhard-float
10354 @opindex msoft-float
10355 Use (do not use) the hardware floating-point instructions and registers
10356 for floating-point operations.  When @option{-msoft-float} is specified,
10357 functions in @file{libgcc.a} will be used to perform floating-point
10358 operations.  When @option{-mhard-float} is specified, the compiler
10359 generates IEEE floating-point instructions.  This is the default.
10360
10361 @item -mbackchain
10362 @itemx -mno-backchain
10363 @opindex mbackchain
10364 @opindex mno-backchain
10365 Generate (or do not generate) code which maintains an explicit
10366 backchain within the stack frame that points to the caller's frame.
10367 This is currently needed to allow debugging.  The default is to
10368 generate the backchain.
10369
10370 @item -msmall-exec
10371 @itemx -mno-small-exec
10372 @opindex msmall-exec
10373 @opindex mno-small-exec
10374 Generate (or do not generate) code using the @code{bras} instruction
10375 to do subroutine calls.
10376 This only works reliably if the total executable size does not
10377 exceed 64k.  The default is to use the @code{basr} instruction instead,
10378 which does not have this limitation.
10379
10380 @item -m64
10381 @itemx -m31
10382 @opindex m64
10383 @opindex m31
10384 When @option{-m31} is specified, generate code compliant to the
10385 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10386 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10387 particular to generate 64-bit instructions.  For the @samp{s390}
10388 targets, the default is @option{-m31}, while the @samp{s390x}
10389 targets default to @option{-m64}.
10390
10391 @item -mzarch
10392 @itemx -mesa
10393 @opindex mzarch
10394 @opindex mesa
10395 When @option{-mzarch} is specified, generate code using the 
10396 instructions available on z/Architecture. 
10397 When @option{-mesa} is specified, generate code using the 
10398 instructions available on ESA/390. Note that @option{-mesa} is
10399 not possible with @option{-m64}.
10400 When generating code compliant to the Linux for S/390 ABI,
10401 the default is @option{-mesa}.  When generating code compliant
10402 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10403
10404 @item -mmvcle
10405 @itemx -mno-mvcle
10406 @opindex mmvcle
10407 @opindex mno-mvcle
10408 Generate (or do not generate) code using the @code{mvcle} instruction
10409 to perform block moves.  When @option{-mno-mvcle} is specified,
10410 use a @code{mvc} loop instead.  This is the default.
10411
10412 @item -mdebug
10413 @itemx -mno-debug
10414 @opindex mdebug
10415 @opindex mno-debug
10416 Print (or do not print) additional debug information when compiling.
10417 The default is to not print debug information.
10418
10419 @item -march=@var{cpu-type}
10420 @opindex march
10421 Generate code that will run on @var{cpu-type}, which is the name of a system
10422 representing a certain processor type. Possible values for
10423 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10424 When generating code using the instructions available on z/Architecture,
10425 the default is @option{-march=z900}.  Otherwise, the default is
10426 @option{-march=g5}.
10427
10428 @item -mtune=@var{cpu-type}
10429 @opindex mtune
10430 Tune to @var{cpu-type} everything applicable about the generated code,
10431 except for the ABI and the set of available instructions.
10432 The list of @var{cpu-type} values is the same as for @option{-march}.
10433 The default is the value used for @option{-march}.
10434
10435 @item -mfused-madd
10436 @itemx -mno-fused-madd
10437 @opindex mfused-madd
10438 @opindex mno-fused-madd
10439 Generate code that uses (does not use) the floating point multiply and
10440 accumulate instructions.  These instructions are generated by default if
10441 hardware floating point is used.
10442 @end table
10443
10444 @node CRIS Options
10445 @subsection CRIS Options
10446 @cindex CRIS Options
10447
10448 These options are defined specifically for the CRIS ports.
10449
10450 @table @gcctabopt
10451 @item -march=@var{architecture-type}
10452 @itemx -mcpu=@var{architecture-type}
10453 @opindex march
10454 @opindex mcpu
10455 Generate code for the specified architecture.  The choices for
10456 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10457 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10458 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10459 @samp{v10}.
10460
10461 @item -mtune=@var{architecture-type}
10462 @opindex mtune
10463 Tune to @var{architecture-type} everything applicable about the generated
10464 code, except for the ABI and the set of available instructions.  The
10465 choices for @var{architecture-type} are the same as for
10466 @option{-march=@var{architecture-type}}.
10467
10468 @item -mmax-stack-frame=@var{n}
10469 @opindex mmax-stack-frame
10470 Warn when the stack frame of a function exceeds @var{n} bytes.
10471
10472 @item -melinux-stacksize=@var{n}
10473 @opindex melinux-stacksize
10474 Only available with the @samp{cris-axis-aout} target.  Arranges for
10475 indications in the program to the kernel loader that the stack of the
10476 program should be set to @var{n} bytes.
10477
10478 @item -metrax4
10479 @itemx -metrax100
10480 @opindex metrax4
10481 @opindex metrax100
10482 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10483 @option{-march=v3} and @option{-march=v8} respectively.
10484
10485 @item -mpdebug
10486 @opindex mpdebug
10487 Enable CRIS-specific verbose debug-related information in the assembly
10488 code.  This option also has the effect to turn off the @samp{#NO_APP}
10489 formatted-code indicator to the assembler at the beginning of the
10490 assembly file.
10491
10492 @item -mcc-init
10493 @opindex mcc-init
10494 Do not use condition-code results from previous instruction; always emit
10495 compare and test instructions before use of condition codes.
10496
10497 @item -mno-side-effects
10498 @opindex mno-side-effects
10499 Do not emit instructions with side-effects in addressing modes other than
10500 post-increment.
10501
10502 @item -mstack-align
10503 @itemx -mno-stack-align
10504 @itemx -mdata-align
10505 @itemx -mno-data-align
10506 @itemx -mconst-align
10507 @itemx -mno-const-align
10508 @opindex mstack-align
10509 @opindex mno-stack-align
10510 @opindex mdata-align
10511 @opindex mno-data-align
10512 @opindex mconst-align
10513 @opindex mno-const-align
10514 These options (no-options) arranges (eliminate arrangements) for the
10515 stack-frame, individual data and constants to be aligned for the maximum
10516 single data access size for the chosen CPU model.  The default is to
10517 arrange for 32-bit alignment.  ABI details such as structure layout are
10518 not affected by these options.
10519
10520 @item -m32-bit
10521 @itemx -m16-bit
10522 @itemx -m8-bit
10523 @opindex m32-bit
10524 @opindex m16-bit
10525 @opindex m8-bit
10526 Similar to the stack- data- and const-align options above, these options
10527 arrange for stack-frame, writable data and constants to all be 32-bit,
10528 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10529
10530 @item -mno-prologue-epilogue
10531 @itemx -mprologue-epilogue
10532 @opindex mno-prologue-epilogue
10533 @opindex mprologue-epilogue
10534 With @option{-mno-prologue-epilogue}, the normal function prologue and
10535 epilogue that sets up the stack-frame are omitted and no return
10536 instructions or return sequences are generated in the code.  Use this
10537 option only together with visual inspection of the compiled code: no
10538 warnings or errors are generated when call-saved registers must be saved,
10539 or storage for local variable needs to be allocated.
10540
10541 @item -mno-gotplt
10542 @itemx -mgotplt
10543 @opindex mno-gotplt
10544 @opindex mgotplt
10545 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10546 instruction sequences that load addresses for functions from the PLT part
10547 of the GOT rather than (traditional on other architectures) calls to the
10548 PLT.  The default is @option{-mgotplt}.
10549
10550 @item -maout
10551 @opindex maout
10552 Legacy no-op option only recognized with the cris-axis-aout target.
10553
10554 @item -melf
10555 @opindex melf
10556 Legacy no-op option only recognized with the cris-axis-elf and
10557 cris-axis-linux-gnu targets.
10558
10559 @item -melinux
10560 @opindex melinux
10561 Only recognized with the cris-axis-aout target, where it selects a
10562 GNU/linux-like multilib, include files and instruction set for
10563 @option{-march=v8}.
10564
10565 @item -mlinux
10566 @opindex mlinux
10567 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10568
10569 @item -sim
10570 @opindex sim
10571 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10572 to link with input-output functions from a simulator library.  Code,
10573 initialized data and zero-initialized data are allocated consecutively.
10574
10575 @item -sim2
10576 @opindex sim2
10577 Like @option{-sim}, but pass linker options to locate initialized data at
10578 0x40000000 and zero-initialized data at 0x80000000.
10579 @end table
10580
10581 @node MMIX Options
10582 @subsection MMIX Options
10583 @cindex MMIX Options
10584
10585 These options are defined for the MMIX:
10586
10587 @table @gcctabopt
10588 @item -mlibfuncs
10589 @itemx -mno-libfuncs
10590 @opindex mlibfuncs
10591 @opindex mno-libfuncs
10592 Specify that intrinsic library functions are being compiled, passing all
10593 values in registers, no matter the size.
10594
10595 @item -mepsilon
10596 @itemx -mno-epsilon
10597 @opindex mepsilon
10598 @opindex mno-epsilon
10599 Generate floating-point comparison instructions that compare with respect
10600 to the @code{rE} epsilon register.
10601
10602 @item -mabi=mmixware
10603 @itemx -mabi=gnu
10604 @opindex mabi-mmixware
10605 @opindex mabi=gnu
10606 Generate code that passes function parameters and return values that (in
10607 the called function) are seen as registers @code{$0} and up, as opposed to
10608 the GNU ABI which uses global registers @code{$231} and up.
10609
10610 @item -mzero-extend
10611 @itemx -mno-zero-extend
10612 @opindex mzero-extend
10613 @opindex mno-zero-extend
10614 When reading data from memory in sizes shorter than 64 bits, use (do not
10615 use) zero-extending load instructions by default, rather than
10616 sign-extending ones.
10617
10618 @item -mknuthdiv
10619 @itemx -mno-knuthdiv
10620 @opindex mknuthdiv
10621 @opindex mno-knuthdiv
10622 Make the result of a division yielding a remainder have the same sign as
10623 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10624 remainder follows the sign of the dividend.  Both methods are
10625 arithmetically valid, the latter being almost exclusively used.
10626
10627 @item -mtoplevel-symbols
10628 @itemx -mno-toplevel-symbols
10629 @opindex mtoplevel-symbols
10630 @opindex mno-toplevel-symbols
10631 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10632 code can be used with the @code{PREFIX} assembly directive.
10633
10634 @item -melf
10635 @opindex melf
10636 Generate an executable in the ELF format, rather than the default
10637 @samp{mmo} format used by the @command{mmix} simulator.
10638
10639 @item -mbranch-predict
10640 @itemx -mno-branch-predict
10641 @opindex mbranch-predict
10642 @opindex mno-branch-predict
10643 Use (do not use) the probable-branch instructions, when static branch
10644 prediction indicates a probable branch.
10645
10646 @item -mbase-addresses
10647 @itemx -mno-base-addresses
10648 @opindex mbase-addresses
10649 @opindex mno-base-addresses
10650 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10651 base address automatically generates a request (handled by the assembler
10652 and the linker) for a constant to be set up in a global register.  The
10653 register is used for one or more base address requests within the range 0
10654 to 255 from the value held in the register.  The generally leads to short
10655 and fast code, but the number of different data items that can be
10656 addressed is limited.  This means that a program that uses lots of static
10657 data may require @option{-mno-base-addresses}.
10658
10659 @item -msingle-exit
10660 @itemx -mno-single-exit
10661 @opindex msingle-exit
10662 @opindex mno-single-exit
10663 Force (do not force) generated code to have a single exit point in each
10664 function.
10665 @end table
10666
10667 @node PDP-11 Options
10668 @subsection PDP-11 Options
10669 @cindex PDP-11 Options
10670
10671 These options are defined for the PDP-11:
10672
10673 @table @gcctabopt
10674 @item -mfpu
10675 @opindex mfpu
10676 Use hardware FPP floating point.  This is the default.  (FIS floating
10677 point on the PDP-11/40 is not supported.)
10678
10679 @item -msoft-float
10680 @opindex msoft-float
10681 Do not use hardware floating point.
10682
10683 @item -mac0
10684 @opindex mac0
10685 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10686
10687 @item -mno-ac0
10688 @opindex mno-ac0
10689 Return floating-point results in memory.  This is the default.
10690
10691 @item -m40
10692 @opindex m40
10693 Generate code for a PDP-11/40.
10694
10695 @item -m45
10696 @opindex m45
10697 Generate code for a PDP-11/45.  This is the default.
10698
10699 @item -m10
10700 @opindex m10
10701 Generate code for a PDP-11/10.
10702
10703 @item -mbcopy-builtin
10704 @opindex bcopy-builtin
10705 Use inline @code{movstrhi} patterns for copying memory.  This is the
10706 default.
10707
10708 @item -mbcopy
10709 @opindex mbcopy
10710 Do not use inline @code{movstrhi} patterns for copying memory.
10711
10712 @item -mint16
10713 @itemx -mno-int32
10714 @opindex mint16
10715 @opindex mno-int32
10716 Use 16-bit @code{int}.  This is the default.
10717
10718 @item -mint32
10719 @itemx -mno-int16
10720 @opindex mint32
10721 @opindex mno-int16
10722 Use 32-bit @code{int}.
10723
10724 @item -mfloat64
10725 @itemx -mno-float32
10726 @opindex mfloat64
10727 @opindex mno-float32
10728 Use 64-bit @code{float}.  This is the default.
10729
10730 @item -mfloat32
10731 @itemx -mno-float64
10732 @opindex mfloat32
10733 @opindex mno-float64
10734 Use 32-bit @code{float}.
10735
10736 @item -mabshi
10737 @opindex mabshi
10738 Use @code{abshi2} pattern.  This is the default.
10739
10740 @item -mno-abshi
10741 @opindex mno-abshi
10742 Do not use @code{abshi2} pattern.
10743
10744 @item -mbranch-expensive
10745 @opindex mbranch-expensive
10746 Pretend that branches are expensive.  This is for experimenting with
10747 code generation only.
10748
10749 @item -mbranch-cheap
10750 @opindex mbranch-cheap
10751 Do not pretend that branches are expensive.  This is the default.
10752
10753 @item -msplit
10754 @opindex msplit
10755 Generate code for a system with split I&D.
10756
10757 @item -mno-split
10758 @opindex mno-split
10759 Generate code for a system without split I&D.  This is the default.
10760
10761 @item -munix-asm
10762 @opindex munix-asm
10763 Use Unix assembler syntax.  This is the default when configured for
10764 @samp{pdp11-*-bsd}.
10765
10766 @item -mdec-asm
10767 @opindex mdec-asm
10768 Use DEC assembler syntax.  This is the default when configured for any
10769 PDP-11 target other than @samp{pdp11-*-bsd}.
10770 @end table
10771
10772 @node Xstormy16 Options
10773 @subsection Xstormy16 Options
10774 @cindex Xstormy16 Options
10775
10776 These options are defined for Xstormy16:
10777
10778 @table @gcctabopt
10779 @item -msim
10780 @opindex msim
10781 Choose startup files and linker script suitable for the simulator.
10782 @end table
10783
10784 @node FRV Options
10785 @subsection FRV Options
10786 @cindex FRV Options
10787
10788 @table @gcctabopt
10789 @item -mgpr-32
10790 @opindex mgpr-32
10791
10792 Only use the first 32 general purpose registers.
10793
10794 @item -mgpr-64
10795 @opindex mgpr-64
10796
10797 Use all 64 general purpose registers.
10798
10799 @item -mfpr-32
10800 @opindex mfpr-32
10801
10802 Use only the first 32 floating point registers.
10803
10804 @item -mfpr-64
10805 @opindex mfpr-64
10806
10807 Use all 64 floating point registers
10808
10809 @item -mhard-float
10810 @opindex mhard-float
10811
10812 Use hardware instructions for floating point operations.
10813
10814 @item -msoft-float
10815 @opindex msoft-float
10816
10817 Use library routines for floating point operations.
10818
10819 @item -malloc-cc
10820 @opindex malloc-cc
10821
10822 Dynamically allocate condition code registers.
10823
10824 @item -mfixed-cc
10825 @opindex mfixed-cc
10826
10827 Do not try to dynamically allocate condition code registers, only
10828 use @code{icc0} and @code{fcc0}.
10829
10830 @item -mdword
10831 @opindex mdword
10832
10833 Change ABI to use double word insns.
10834
10835 @item -mno-dword
10836 @opindex mno-dword
10837
10838 Do not use double word instructions.
10839
10840 @item -mdouble
10841 @opindex mdouble
10842
10843 Use floating point double instructions.
10844
10845 @item -mno-double
10846 @opindex mno-double
10847
10848 Do not use floating point double instructions.
10849
10850 @item -mmedia
10851 @opindex mmedia
10852
10853 Use media instructions.
10854
10855 @item -mno-media
10856 @opindex mno-media
10857
10858 Do not use media instructions.
10859
10860 @item -mmuladd
10861 @opindex mmuladd
10862
10863 Use multiply and add/subtract instructions.
10864
10865 @item -mno-muladd
10866 @opindex mno-muladd
10867
10868 Do not use multiply and add/subtract instructions.
10869
10870 @item -mlibrary-pic
10871 @opindex mlibrary-pic
10872
10873 Enable PIC support for building libraries
10874
10875 @item -macc-4
10876 @opindex macc-4
10877
10878 Use only the first four media accumulator registers.
10879
10880 @item -macc-8
10881 @opindex macc-8
10882
10883 Use all eight media accumulator registers.
10884
10885 @item -mpack
10886 @opindex mpack
10887
10888 Pack VLIW instructions.
10889
10890 @item -mno-pack
10891 @opindex mno-pack
10892
10893 Do not pack VLIW instructions.
10894
10895 @item -mno-eflags
10896 @opindex mno-eflags
10897
10898 Do not mark ABI switches in e_flags.
10899
10900 @item -mcond-move
10901 @opindex mcond-move
10902
10903 Enable the use of conditional-move instructions (default).
10904
10905 This switch is mainly for debugging the compiler and will likely be removed
10906 in a future version.
10907
10908 @item -mno-cond-move
10909 @opindex mno-cond-move
10910
10911 Disable the use of conditional-move instructions.
10912
10913 This switch is mainly for debugging the compiler and will likely be removed
10914 in a future version.
10915
10916 @item -mscc
10917 @opindex mscc
10918
10919 Enable the use of conditional set instructions (default).
10920
10921 This switch is mainly for debugging the compiler and will likely be removed
10922 in a future version.
10923
10924 @item -mno-scc
10925 @opindex mno-scc
10926
10927 Disable the use of conditional set instructions.
10928
10929 This switch is mainly for debugging the compiler and will likely be removed
10930 in a future version.
10931
10932 @item -mcond-exec
10933 @opindex mcond-exec
10934
10935 Enable the use of conditional execution (default).
10936
10937 This switch is mainly for debugging the compiler and will likely be removed
10938 in a future version.
10939
10940 @item -mno-cond-exec
10941 @opindex mno-cond-exec
10942
10943 Disable the use of conditional execution.
10944
10945 This switch is mainly for debugging the compiler and will likely be removed
10946 in a future version.
10947
10948 @item -mvliw-branch
10949 @opindex mvliw-branch
10950
10951 Run a pass to pack branches into VLIW instructions (default).
10952
10953 This switch is mainly for debugging the compiler and will likely be removed
10954 in a future version.
10955
10956 @item -mno-vliw-branch
10957 @opindex mno-vliw-branch
10958
10959 Do not run a pass to pack branches into VLIW instructions.
10960
10961 This switch is mainly for debugging the compiler and will likely be removed
10962 in a future version.
10963
10964 @item -mmulti-cond-exec
10965 @opindex mmulti-cond-exec
10966
10967 Enable optimization of @code{&&} and @code{||} in conditional execution
10968 (default).
10969
10970 This switch is mainly for debugging the compiler and will likely be removed
10971 in a future version.
10972
10973 @item -mno-multi-cond-exec
10974 @opindex mno-multi-cond-exec
10975
10976 Disable optimization of @code{&&} and @code{||} in conditional execution.
10977
10978 This switch is mainly for debugging the compiler and will likely be removed
10979 in a future version.
10980
10981 @item -mnested-cond-exec
10982 @opindex mnested-cond-exec
10983
10984 Enable nested conditional execution optimizations (default).
10985
10986 This switch is mainly for debugging the compiler and will likely be removed
10987 in a future version.
10988
10989 @item -mno-nested-cond-exec
10990 @opindex mno-nested-cond-exec
10991
10992 Disable nested conditional execution optimizations.
10993
10994 This switch is mainly for debugging the compiler and will likely be removed
10995 in a future version.
10996
10997 @item -mtomcat-stats
10998 @opindex mtomcat-stats
10999
11000 Cause gas to print out tomcat statistics.
11001
11002 @item -mcpu=@var{cpu}
11003 @opindex mcpu
11004
11005 Select the processor type for which to generate code.  Possible values are
11006 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
11007 @samp{frv}.
11008
11009 @end table
11010
11011 @node Xtensa Options
11012 @subsection Xtensa Options
11013 @cindex Xtensa Options
11014
11015 These options are supported for Xtensa targets:
11016
11017 @table @gcctabopt
11018 @item -mconst16
11019 @itemx -mno-const16
11020 @opindex mconst16
11021 @opindex mno-const16
11022 Enable or disable use of @code{CONST16} instructions for loading
11023 constant values.  The @code{CONST16} instruction is currently not a
11024 standard option from Tensilica.  When enabled, @code{CONST16}
11025 instructions are always used in place of the standard @code{L32R}
11026 instructions.  The use of @code{CONST16} is enabled by default only if
11027 the @code{L32R} instruction is not available.
11028
11029 @item -mfused-madd
11030 @itemx -mno-fused-madd
11031 @opindex mfused-madd
11032 @opindex mno-fused-madd
11033 Enable or disable use of fused multiply/add and multiply/subtract
11034 instructions in the floating-point option.  This has no effect if the
11035 floating-point option is not also enabled.  Disabling fused multiply/add
11036 and multiply/subtract instructions forces the compiler to use separate
11037 instructions for the multiply and add/subtract operations.  This may be
11038 desirable in some cases where strict IEEE 754-compliant results are
11039 required: the fused multiply add/subtract instructions do not round the
11040 intermediate result, thereby producing results with @emph{more} bits of
11041 precision than specified by the IEEE standard.  Disabling fused multiply
11042 add/subtract instructions also ensures that the program output is not
11043 sensitive to the compiler's ability to combine multiply and add/subtract
11044 operations.
11045
11046 @item -mtext-section-literals
11047 @itemx -mno-text-section-literals
11048 @opindex mtext-section-literals
11049 @opindex mno-text-section-literals
11050 Control the treatment of literal pools.  The default is
11051 @option{-mno-text-section-literals}, which places literals in a separate
11052 section in the output file.  This allows the literal pool to be placed
11053 in a data RAM/ROM, and it also allows the linker to combine literal
11054 pools from separate object files to remove redundant literals and
11055 improve code size.  With @option{-mtext-section-literals}, the literals
11056 are interspersed in the text section in order to keep them as close as
11057 possible to their references.  This may be necessary for large assembly
11058 files.
11059
11060 @item -mtarget-align
11061 @itemx -mno-target-align
11062 @opindex mtarget-align
11063 @opindex mno-target-align
11064 When this option is enabled, GCC instructs the assembler to
11065 automatically align instructions to reduce branch penalties at the
11066 expense of some code density.  The assembler attempts to widen density
11067 instructions to align branch targets and the instructions following call
11068 instructions.  If there are not enough preceding safe density
11069 instructions to align a target, no widening will be performed.  The
11070 default is @option{-mtarget-align}.  These options do not affect the
11071 treatment of auto-aligned instructions like @code{LOOP}, which the
11072 assembler will always align, either by widening density instructions or
11073 by inserting no-op instructions.
11074
11075 @item -mlongcalls
11076 @itemx -mno-longcalls
11077 @opindex mlongcalls
11078 @opindex mno-longcalls
11079 When this option is enabled, GCC instructs the assembler to translate
11080 direct calls to indirect calls unless it can determine that the target
11081 of a direct call is in the range allowed by the call instruction.  This
11082 translation typically occurs for calls to functions in other source
11083 files.  Specifically, the assembler translates a direct @code{CALL}
11084 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11085 The default is @option{-mno-longcalls}.  This option should be used in
11086 programs where the call target can potentially be out of range.  This
11087 option is implemented in the assembler, not the compiler, so the
11088 assembly code generated by GCC will still show direct call
11089 instructions---look at the disassembled object code to see the actual
11090 instructions.  Note that the assembler will use an indirect call for
11091 every cross-file call, not just those that really will be out of range.
11092 @end table
11093
11094 @node Code Gen Options
11095 @section Options for Code Generation Conventions
11096 @cindex code generation conventions
11097 @cindex options, code generation
11098 @cindex run-time options
11099
11100 These machine-independent options control the interface conventions
11101 used in code generation.
11102
11103 Most of them have both positive and negative forms; the negative form
11104 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11105 one of the forms is listed---the one which is not the default.  You
11106 can figure out the other form by either removing @samp{no-} or adding
11107 it.
11108
11109 @table @gcctabopt
11110 @item -fbounds-check
11111 @opindex fbounds-check
11112 For front-ends that support it, generate additional code to check that
11113 indices used to access arrays are within the declared range.  This is
11114 currently only supported by the Java and Fortran 77 front-ends, where
11115 this option defaults to true and false respectively.
11116
11117 @item -ftrapv
11118 @opindex ftrapv
11119 This option generates traps for signed overflow on addition, subtraction,
11120 multiplication operations.
11121
11122 @item -fwrapv
11123 @opindex fwrapv
11124 This option instructs the compiler to assume that signed arithmetic
11125 overflow of addition, subtraction and multiplication wraps around
11126 using twos-complement representation.  This flag enables some optimizations
11127 and disables other.  This option is enabled by default for the Java
11128 front-end, as required by the Java language specification.
11129
11130 @item -fexceptions
11131 @opindex fexceptions
11132 Enable exception handling.  Generates extra code needed to propagate
11133 exceptions.  For some targets, this implies GCC will generate frame
11134 unwind information for all functions, which can produce significant data
11135 size overhead, although it does not affect execution.  If you do not
11136 specify this option, GCC will enable it by default for languages like
11137 C++ which normally require exception handling, and disable it for
11138 languages like C that do not normally require it.  However, you may need
11139 to enable this option when compiling C code that needs to interoperate
11140 properly with exception handlers written in C++.  You may also wish to
11141 disable this option if you are compiling older C++ programs that don't
11142 use exception handling.
11143
11144 @item -fnon-call-exceptions
11145 @opindex fnon-call-exceptions
11146 Generate code that allows trapping instructions to throw exceptions.
11147 Note that this requires platform-specific runtime support that does
11148 not exist everywhere.  Moreover, it only allows @emph{trapping}
11149 instructions to throw exceptions, i.e.@: memory references or floating
11150 point instructions.  It does not allow exceptions to be thrown from
11151 arbitrary signal handlers such as @code{SIGALRM}.
11152
11153 @item -funwind-tables
11154 @opindex funwind-tables
11155 Similar to @option{-fexceptions}, except that it will just generate any needed
11156 static data, but will not affect the generated code in any other way.
11157 You will normally not enable this option; instead, a language processor
11158 that needs this handling would enable it on your behalf.
11159
11160 @item -fasynchronous-unwind-tables
11161 @opindex funwind-tables
11162 Generate unwind table in dwarf2 format, if supported by target machine.  The
11163 table is exact at each instruction boundary, so it can be used for stack
11164 unwinding from asynchronous events (such as debugger or garbage collector).
11165
11166 @item -fpcc-struct-return
11167 @opindex fpcc-struct-return
11168 Return ``short'' @code{struct} and @code{union} values in memory like
11169 longer ones, rather than in registers.  This convention is less
11170 efficient, but it has the advantage of allowing intercallability between
11171 GCC-compiled files and files compiled with other compilers, particularly
11172 the Portable C Compiler (pcc).
11173
11174 The precise convention for returning structures in memory depends
11175 on the target configuration macros.
11176
11177 Short structures and unions are those whose size and alignment match
11178 that of some integer type.
11179
11180 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11181 switch is not binary compatible with code compiled with the
11182 @option{-freg-struct-return} switch.
11183 Use it to conform to a non-default application binary interface.
11184
11185 @item -freg-struct-return
11186 @opindex freg-struct-return
11187 Return @code{struct} and @code{union} values in registers when possible.
11188 This is more efficient for small structures than
11189 @option{-fpcc-struct-return}.
11190
11191 If you specify neither @option{-fpcc-struct-return} nor
11192 @option{-freg-struct-return}, GCC defaults to whichever convention is
11193 standard for the target.  If there is no standard convention, GCC
11194 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11195 the principal compiler.  In those cases, we can choose the standard, and
11196 we chose the more efficient register return alternative.
11197
11198 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11199 switch is not binary compatible with code compiled with the
11200 @option{-fpcc-struct-return} switch.
11201 Use it to conform to a non-default application binary interface.
11202
11203 @item -fshort-enums
11204 @opindex fshort-enums
11205 Allocate to an @code{enum} type only as many bytes as it needs for the
11206 declared range of possible values.  Specifically, the @code{enum} type
11207 will be equivalent to the smallest integer type which has enough room.
11208
11209 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11210 code that is not binary compatible with code generated without that switch.
11211 Use it to conform to a non-default application binary interface.
11212
11213 @item -fshort-double
11214 @opindex fshort-double
11215 Use the same size for @code{double} as for @code{float}.
11216
11217 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11218 code that is not binary compatible with code generated without that switch.
11219 Use it to conform to a non-default application binary interface.
11220
11221 @item -fshort-wchar
11222 @opindex fshort-wchar
11223 Override the underlying type for @samp{wchar_t} to be @samp{short
11224 unsigned int} instead of the default for the target.  This option is
11225 useful for building programs to run under WINE@.
11226
11227 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11228 code that is not binary compatible with code generated without that switch.
11229 Use it to conform to a non-default application binary interface.
11230
11231 @item -fshared-data
11232 @opindex fshared-data
11233 Requests that the data and non-@code{const} variables of this
11234 compilation be shared data rather than private data.  The distinction
11235 makes sense only on certain operating systems, where shared data is
11236 shared between processes running the same program, while private data
11237 exists in one copy per process.
11238
11239 @item -fno-common
11240 @opindex fno-common
11241 In C, allocate even uninitialized global variables in the data section of the
11242 object file, rather than generating them as common blocks.  This has the
11243 effect that if the same variable is declared (without @code{extern}) in
11244 two different compilations, you will get an error when you link them.
11245 The only reason this might be useful is if you wish to verify that the
11246 program will work on other systems which always work this way.
11247
11248 @item -fno-ident
11249 @opindex fno-ident
11250 Ignore the @samp{#ident} directive.
11251
11252 @item -finhibit-size-directive
11253 @opindex finhibit-size-directive
11254 Don't output a @code{.size} assembler directive, or anything else that
11255 would cause trouble if the function is split in the middle, and the
11256 two halves are placed at locations far apart in memory.  This option is
11257 used when compiling @file{crtstuff.c}; you should not need to use it
11258 for anything else.
11259
11260 @item -fverbose-asm
11261 @opindex fverbose-asm
11262 Put extra commentary information in the generated assembly code to
11263 make it more readable.  This option is generally only of use to those
11264 who actually need to read the generated assembly code (perhaps while
11265 debugging the compiler itself).
11266
11267 @option{-fno-verbose-asm}, the default, causes the
11268 extra information to be omitted and is useful when comparing two assembler
11269 files.
11270
11271 @item -fpic
11272 @opindex fpic
11273 @cindex global offset table
11274 @cindex PIC
11275 Generate position-independent code (PIC) suitable for use in a shared
11276 library, if supported for the target machine.  Such code accesses all
11277 constant addresses through a global offset table (GOT)@.  The dynamic
11278 loader resolves the GOT entries when the program starts (the dynamic
11279 loader is not part of GCC; it is part of the operating system).  If
11280 the GOT size for the linked executable exceeds a machine-specific
11281 maximum size, you get an error message from the linker indicating that
11282 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11283 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11284 on the m68k and RS/6000.  The 386 has no such limit.)
11285
11286 Position-independent code requires special support, and therefore works
11287 only on certain machines.  For the 386, GCC supports PIC for System V
11288 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11289 position-independent.
11290
11291 @item -fPIC
11292 @opindex fPIC
11293 If supported for the target machine, emit position-independent code,
11294 suitable for dynamic linking and avoiding any limit on the size of the
11295 global offset table.  This option makes a difference on the m68k, m88k,
11296 and the SPARC.
11297
11298 Position-independent code requires special support, and therefore works
11299 only on certain machines.
11300
11301 @item -fpie
11302 @itemx -fPIE
11303 @opindex fpie
11304 @opindex fPIE
11305 These options are similar to @option{-fpic} and @option{-fPIC}, but
11306 generated position independent code can be only linked into executables.
11307 Usually these options are used when @option{-pie} GCC option will be
11308 used during linking.
11309
11310 @item -ffixed-@var{reg}
11311 @opindex ffixed
11312 Treat the register named @var{reg} as a fixed register; generated code
11313 should never refer to it (except perhaps as a stack pointer, frame
11314 pointer or in some other fixed role).
11315
11316 @var{reg} must be the name of a register.  The register names accepted
11317 are machine-specific and are defined in the @code{REGISTER_NAMES}
11318 macro in the machine description macro file.
11319
11320 This flag does not have a negative form, because it specifies a
11321 three-way choice.
11322
11323 @item -fcall-used-@var{reg}
11324 @opindex fcall-used
11325 Treat the register named @var{reg} as an allocable register that is
11326 clobbered by function calls.  It may be allocated for temporaries or
11327 variables that do not live across a call.  Functions compiled this way
11328 will not save and restore the register @var{reg}.
11329
11330 It is an error to used this flag with the frame pointer or stack pointer.
11331 Use of this flag for other registers that have fixed pervasive roles in
11332 the machine's execution model will produce disastrous results.
11333
11334 This flag does not have a negative form, because it specifies a
11335 three-way choice.
11336
11337 @item -fcall-saved-@var{reg}
11338 @opindex fcall-saved
11339 Treat the register named @var{reg} as an allocable register saved by
11340 functions.  It may be allocated even for temporaries or variables that
11341 live across a call.  Functions compiled this way will save and restore
11342 the register @var{reg} if they use it.
11343
11344 It is an error to used this flag with the frame pointer or stack pointer.
11345 Use of this flag for other registers that have fixed pervasive roles in
11346 the machine's execution model will produce disastrous results.
11347
11348 A different sort of disaster will result from the use of this flag for
11349 a register in which function values may be returned.
11350
11351 This flag does not have a negative form, because it specifies a
11352 three-way choice.
11353
11354 @item -fpack-struct
11355 @opindex fpack-struct
11356 Pack all structure members together without holes.
11357
11358 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11359 code that is not binary compatible with code generated without that switch.
11360 Additionally, it makes the code suboptimal.
11361 Use it to conform to a non-default application binary interface.
11362
11363 @item -finstrument-functions
11364 @opindex finstrument-functions
11365 Generate instrumentation calls for entry and exit to functions.  Just
11366 after function entry and just before function exit, the following
11367 profiling functions will be called with the address of the current
11368 function and its call site.  (On some platforms,
11369 @code{__builtin_return_address} does not work beyond the current
11370 function, so the call site information may not be available to the
11371 profiling functions otherwise.)
11372
11373 @example
11374 void __cyg_profile_func_enter (void *this_fn,
11375                                void *call_site);
11376 void __cyg_profile_func_exit  (void *this_fn,
11377                                void *call_site);
11378 @end example
11379
11380 The first argument is the address of the start of the current function,
11381 which may be looked up exactly in the symbol table.
11382
11383 This instrumentation is also done for functions expanded inline in other
11384 functions.  The profiling calls will indicate where, conceptually, the
11385 inline function is entered and exited.  This means that addressable
11386 versions of such functions must be available.  If all your uses of a
11387 function are expanded inline, this may mean an additional expansion of
11388 code size.  If you use @samp{extern inline} in your C code, an
11389 addressable version of such functions must be provided.  (This is
11390 normally the case anyways, but if you get lucky and the optimizer always
11391 expands the functions inline, you might have gotten away without
11392 providing static copies.)
11393
11394 A function may be given the attribute @code{no_instrument_function}, in
11395 which case this instrumentation will not be done.  This can be used, for
11396 example, for the profiling functions listed above, high-priority
11397 interrupt routines, and any functions from which the profiling functions
11398 cannot safely be called (perhaps signal handlers, if the profiling
11399 routines generate output or allocate memory).
11400
11401 @item -fstack-check
11402 @opindex fstack-check
11403 Generate code to verify that you do not go beyond the boundary of the
11404 stack.  You should specify this flag if you are running in an
11405 environment with multiple threads, but only rarely need to specify it in
11406 a single-threaded environment since stack overflow is automatically
11407 detected on nearly all systems if there is only one stack.
11408
11409 Note that this switch does not actually cause checking to be done; the
11410 operating system must do that.  The switch causes generation of code
11411 to ensure that the operating system sees the stack being extended.
11412
11413 @item -fstack-limit-register=@var{reg}
11414 @itemx -fstack-limit-symbol=@var{sym}
11415 @itemx -fno-stack-limit
11416 @opindex fstack-limit-register
11417 @opindex fstack-limit-symbol
11418 @opindex fno-stack-limit
11419 Generate code to ensure that the stack does not grow beyond a certain value,
11420 either the value of a register or the address of a symbol.  If the stack
11421 would grow beyond the value, a signal is raised.  For most targets,
11422 the signal is raised before the stack overruns the boundary, so
11423 it is possible to catch the signal without taking special precautions.
11424
11425 For instance, if the stack starts at absolute address @samp{0x80000000}
11426 and grows downwards, you can use the flags
11427 @option{-fstack-limit-symbol=__stack_limit} and
11428 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11429 of 128KB@.  Note that this may only work with the GNU linker.
11430
11431 @cindex aliasing of parameters
11432 @cindex parameters, aliased
11433 @item -fargument-alias
11434 @itemx -fargument-noalias
11435 @itemx -fargument-noalias-global
11436 @opindex fargument-alias
11437 @opindex fargument-noalias
11438 @opindex fargument-noalias-global
11439 Specify the possible relationships among parameters and between
11440 parameters and global data.
11441
11442 @option{-fargument-alias} specifies that arguments (parameters) may
11443 alias each other and may alias global storage.@*
11444 @option{-fargument-noalias} specifies that arguments do not alias
11445 each other, but may alias global storage.@*
11446 @option{-fargument-noalias-global} specifies that arguments do not
11447 alias each other and do not alias global storage.
11448
11449 Each language will automatically use whatever option is required by
11450 the language standard.  You should not need to use these options yourself.
11451
11452 @item -fleading-underscore
11453 @opindex fleading-underscore
11454 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11455 change the way C symbols are represented in the object file.  One use
11456 is to help link with legacy assembly code.
11457
11458 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11459 generate code that is not binary compatible with code generated without that
11460 switch.  Use it to conform to a non-default application binary interface.
11461 Not all targets provide complete support for this switch.
11462
11463 @item -ftls-model=@var{model}
11464 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11465 The @var{model} argument should be one of @code{global-dynamic},
11466 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11467
11468 The default without @option{-fpic} is @code{initial-exec}; with
11469 @option{-fpic} the default is @code{global-dynamic}.
11470 @end table
11471
11472 @c man end
11473
11474 @node Environment Variables
11475 @section Environment Variables Affecting GCC
11476 @cindex environment variables
11477
11478 @c man begin ENVIRONMENT
11479 This section describes several environment variables that affect how GCC
11480 operates.  Some of them work by specifying directories or prefixes to use
11481 when searching for various kinds of files.  Some are used to specify other
11482 aspects of the compilation environment.
11483
11484 Note that you can also specify places to search using options such as
11485 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11486 take precedence over places specified using environment variables, which
11487 in turn take precedence over those specified by the configuration of GCC@.
11488 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11489 GNU Compiler Collection (GCC) Internals}.
11490
11491 @table @env
11492 @item LANG
11493 @itemx LC_CTYPE
11494 @c @itemx LC_COLLATE
11495 @itemx LC_MESSAGES
11496 @c @itemx LC_MONETARY
11497 @c @itemx LC_NUMERIC
11498 @c @itemx LC_TIME
11499 @itemx LC_ALL
11500 @findex LANG
11501 @findex LC_CTYPE
11502 @c @findex LC_COLLATE
11503 @findex LC_MESSAGES
11504 @c @findex LC_MONETARY
11505 @c @findex LC_NUMERIC
11506 @c @findex LC_TIME
11507 @findex LC_ALL
11508 @cindex locale
11509 These environment variables control the way that GCC uses
11510 localization information that allow GCC to work with different
11511 national conventions.  GCC inspects the locale categories
11512 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11513 so.  These locale categories can be set to any value supported by your
11514 installation.  A typical value is @samp{en_UK} for English in the United
11515 Kingdom.
11516
11517 The @env{LC_CTYPE} environment variable specifies character
11518 classification.  GCC uses it to determine the character boundaries in
11519 a string; this is needed for some multibyte encodings that contain quote
11520 and escape characters that would otherwise be interpreted as a string
11521 end or escape.
11522
11523 The @env{LC_MESSAGES} environment variable specifies the language to
11524 use in diagnostic messages.
11525
11526 If the @env{LC_ALL} environment variable is set, it overrides the value
11527 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11528 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11529 environment variable.  If none of these variables are set, GCC
11530 defaults to traditional C English behavior.
11531
11532 @item TMPDIR
11533 @findex TMPDIR
11534 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11535 files.  GCC uses temporary files to hold the output of one stage of
11536 compilation which is to be used as input to the next stage: for example,
11537 the output of the preprocessor, which is the input to the compiler
11538 proper.
11539
11540 @item GCC_EXEC_PREFIX
11541 @findex GCC_EXEC_PREFIX
11542 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11543 names of the subprograms executed by the compiler.  No slash is added
11544 when this prefix is combined with the name of a subprogram, but you can
11545 specify a prefix that ends with a slash if you wish.
11546
11547 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11548 an appropriate prefix to use based on the pathname it was invoked with.
11549
11550 If GCC cannot find the subprogram using the specified prefix, it
11551 tries looking in the usual places for the subprogram.
11552
11553 The default value of @env{GCC_EXEC_PREFIX} is
11554 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11555 of @code{prefix} when you ran the @file{configure} script.
11556
11557 Other prefixes specified with @option{-B} take precedence over this prefix.
11558
11559 This prefix is also used for finding files such as @file{crt0.o} that are
11560 used for linking.
11561
11562 In addition, the prefix is used in an unusual way in finding the
11563 directories to search for header files.  For each of the standard
11564 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11565 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11566 replacing that beginning with the specified prefix to produce an
11567 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11568 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11569 These alternate directories are searched first; the standard directories
11570 come next.
11571
11572 @item COMPILER_PATH
11573 @findex COMPILER_PATH
11574 The value of @env{COMPILER_PATH} is a colon-separated list of
11575 directories, much like @env{PATH}.  GCC tries the directories thus
11576 specified when searching for subprograms, if it can't find the
11577 subprograms using @env{GCC_EXEC_PREFIX}.
11578
11579 @item LIBRARY_PATH
11580 @findex LIBRARY_PATH
11581 The value of @env{LIBRARY_PATH} is a colon-separated list of
11582 directories, much like @env{PATH}.  When configured as a native compiler,
11583 GCC tries the directories thus specified when searching for special
11584 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11585 using GCC also uses these directories when searching for ordinary
11586 libraries for the @option{-l} option (but directories specified with
11587 @option{-L} come first).
11588
11589 @item LANG
11590 @findex LANG
11591 @cindex locale definition
11592 This variable is used to pass locale information to the compiler.  One way in
11593 which this information is used is to determine the character set to be used
11594 when character literals, string literals and comments are parsed in C and C++.
11595 When the compiler is configured to allow multibyte characters,
11596 the following values for @env{LANG} are recognized:
11597
11598 @table @samp
11599 @item C-JIS
11600 Recognize JIS characters.
11601 @item C-SJIS
11602 Recognize SJIS characters.
11603 @item C-EUCJP
11604 Recognize EUCJP characters.
11605 @end table
11606
11607 If @env{LANG} is not defined, or if it has some other value, then the
11608 compiler will use mblen and mbtowc as defined by the default locale to
11609 recognize and translate multibyte characters.
11610 @end table
11611
11612 @noindent
11613 Some additional environments variables affect the behavior of the
11614 preprocessor.
11615
11616 @include cppenv.texi
11617
11618 @c man end
11619
11620 @node Precompiled Headers
11621 @section Using Precompiled Headers
11622 @cindex precompiled headers
11623 @cindex speed of compilation
11624
11625 Often large projects have many header files that are included in every
11626 source file.  The time the compiler takes to process these header files
11627 over and over again can account for nearly all of the time required to
11628 build the project.  To make builds faster, GCC allows users to
11629 `precompile' a header file; then, if builds can use the precompiled
11630 header file they will be much faster.
11631
11632 To create a precompiled header file, simply compile it as you would any
11633 other file, if necessary using the @option{-x} option to make the driver
11634 treat it as a C or C++ header file.  You will probably want to use a
11635 tool like @command{make} to keep the precompiled header up-to-date when
11636 the headers it contains change.
11637
11638 A precompiled header file will be searched for when @code{#include} is
11639 seen in the compilation.  As it searches for the included file
11640 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11641 compiler looks for a precompiled header in each directory just before it
11642 looks for the include file in that directory.  The name searched for is
11643 the name specified in the @code{#include} with @samp{.gch} appended.  If
11644 the precompiled header file can't be used, it is ignored.
11645
11646 For instance, if you have @code{#include "all.h"}, and you have
11647 @file{all.h.gch} in the same directory as @file{all.h}, then the
11648 precompiled header file will be used if possible, and the original
11649 header will be used otherwise.
11650
11651 Alternatively, you might decide to put the precompiled header file in a
11652 directory and use @option{-I} to ensure that directory is searched
11653 before (or instead of) the directory containing the original header.
11654 Then, if you want to check that the precompiled header file is always
11655 used, you can put a file of the same name as the original header in this
11656 directory containing an @code{#error} command.
11657
11658 This also works with @option{-include}.  So yet another way to use
11659 precompiled headers, good for projects not designed with precompiled
11660 header files in mind, is to simply take most of the header files used by
11661 a project, include them from another header file, precompile that header
11662 file, and @option{-include} the precompiled header.  If the header files
11663 have guards against multiple inclusion, they will be skipped because
11664 they've already been included (in the precompiled header).
11665
11666 If you need to precompile the same header file for different
11667 languages, targets, or compiler options, you can instead make a
11668 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11669 header in the directory.  (It doesn't matter what you call the files
11670 in the directory, every precompiled header in the directory will be
11671 considered.)  The first precompiled header encountered in the
11672 directory that is valid for this compilation will be used; they're
11673 searched in no particular order.
11674
11675 There are many other possibilities, limited only by your imagination,
11676 good sense, and the constraints of your build system.
11677
11678 A precompiled header file can be used only when these conditions apply:
11679
11680 @itemize
11681 @item
11682 Only one precompiled header can be used in a particular compilation.
11683 @item
11684 A precompiled header can't be used once the first C token is seen.  You
11685 can have preprocessor directives before a precompiled header; you can
11686 even include a precompiled header from inside another header, so long as
11687 there are no C tokens before the @code{#include}.
11688 @item
11689 The precompiled header file must be produced for the same language as
11690 the current compilation.  You can't use a C precompiled header for a C++
11691 compilation.
11692 @item
11693 The precompiled header file must be produced by the same compiler
11694 version and configuration as the current compilation is using.
11695 The easiest way to guarantee this is to use the same compiler binary
11696 for creating and using precompiled headers.
11697 @item
11698 Any macros defined before the precompiled header (including with
11699 @option{-D}) must either be defined in the same way as when the
11700 precompiled header was generated, or must not affect the precompiled
11701 header, which usually means that the they don't appear in the
11702 precompiled header at all.
11703 @item
11704 Certain command-line options must be defined in the same way as when the
11705 precompiled header was generated.  At present, it's not clear which
11706 options are safe to change and which are not; the safest choice is to
11707 use exactly the same options when generating and using the precompiled
11708 header.
11709 @end itemize
11710
11711 For all of these but the last, the compiler will automatically ignore
11712 the precompiled header if the conditions aren't met.  For the last item,
11713 some option changes will cause the precompiled header to be rejected,
11714 but not all incompatible option combinations have yet been found.  If
11715 you find a new incompatible combination, please consider filing a bug
11716 report, see @ref{Bugs}.
11717
11718 @node Running Protoize
11719 @section Running Protoize
11720
11721 The program @code{protoize} is an optional part of GCC@.  You can use
11722 it to add prototypes to a program, thus converting the program to ISO
11723 C in one respect.  The companion program @code{unprotoize} does the
11724 reverse: it removes argument types from any prototypes that are found.
11725
11726 When you run these programs, you must specify a set of source files as
11727 command line arguments.  The conversion programs start out by compiling
11728 these files to see what functions they define.  The information gathered
11729 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11730
11731 After scanning comes actual conversion.  The specified files are all
11732 eligible to be converted; any files they include (whether sources or
11733 just headers) are eligible as well.
11734
11735 But not all the eligible files are converted.  By default,
11736 @code{protoize} and @code{unprotoize} convert only source and header
11737 files in the current directory.  You can specify additional directories
11738 whose files should be converted with the @option{-d @var{directory}}
11739 option.  You can also specify particular files to exclude with the
11740 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11741 directory name matches one of the specified directory names, and its
11742 name within the directory has not been excluded.
11743
11744 Basic conversion with @code{protoize} consists of rewriting most
11745 function definitions and function declarations to specify the types of
11746 the arguments.  The only ones not rewritten are those for varargs
11747 functions.
11748
11749 @code{protoize} optionally inserts prototype declarations at the
11750 beginning of the source file, to make them available for any calls that
11751 precede the function's definition.  Or it can insert prototype
11752 declarations with block scope in the blocks where undeclared functions
11753 are called.
11754
11755 Basic conversion with @code{unprotoize} consists of rewriting most
11756 function declarations to remove any argument types, and rewriting
11757 function definitions to the old-style pre-ISO form.
11758
11759 Both conversion programs print a warning for any function declaration or
11760 definition that they can't convert.  You can suppress these warnings
11761 with @option{-q}.
11762
11763 The output from @code{protoize} or @code{unprotoize} replaces the
11764 original source file.  The original file is renamed to a name ending
11765 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11766 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11767 for DOS) file already exists, then the source file is simply discarded.
11768
11769 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11770 scan the program and collect information about the functions it uses.
11771 So neither of these programs will work until GCC is installed.
11772
11773 Here is a table of the options you can use with @code{protoize} and
11774 @code{unprotoize}.  Each option works with both programs unless
11775 otherwise stated.
11776
11777 @table @code
11778 @item -B @var{directory}
11779 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11780 usual directory (normally @file{/usr/local/lib}).  This file contains
11781 prototype information about standard system functions.  This option
11782 applies only to @code{protoize}.
11783
11784 @item -c @var{compilation-options}
11785 Use @var{compilation-options} as the options when running @command{gcc} to
11786 produce the @samp{.X} files.  The special option @option{-aux-info} is
11787 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11788
11789 Note that the compilation options must be given as a single argument to
11790 @code{protoize} or @code{unprotoize}.  If you want to specify several
11791 @command{gcc} options, you must quote the entire set of compilation options
11792 to make them a single word in the shell.
11793
11794 There are certain @command{gcc} arguments that you cannot use, because they
11795 would produce the wrong kind of output.  These include @option{-g},
11796 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11797 the @var{compilation-options}, they are ignored.
11798
11799 @item -C
11800 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11801 systems) instead of @samp{.c}.  This is convenient if you are converting
11802 a C program to C++.  This option applies only to @code{protoize}.
11803
11804 @item -g
11805 Add explicit global declarations.  This means inserting explicit
11806 declarations at the beginning of each source file for each function
11807 that is called in the file and was not declared.  These declarations
11808 precede the first function definition that contains a call to an
11809 undeclared function.  This option applies only to @code{protoize}.
11810
11811 @item -i @var{string}
11812 Indent old-style parameter declarations with the string @var{string}.
11813 This option applies only to @code{protoize}.
11814
11815 @code{unprotoize} converts prototyped function definitions to old-style
11816 function definitions, where the arguments are declared between the
11817 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11818 uses five spaces as the indentation.  If you want to indent with just
11819 one space instead, use @option{-i " "}.
11820
11821 @item -k
11822 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11823 is finished.
11824
11825 @item -l
11826 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11827 a prototype declaration for each function in each block which calls the
11828 function without any declaration.  This option applies only to
11829 @code{protoize}.
11830
11831 @item -n
11832 Make no real changes.  This mode just prints information about the conversions
11833 that would have been done without @option{-n}.
11834
11835 @item -N
11836 Make no @samp{.save} files.  The original files are simply deleted.
11837 Use this option with caution.
11838
11839 @item -p @var{program}
11840 Use the program @var{program} as the compiler.  Normally, the name
11841 @file{gcc} is used.
11842
11843 @item -q
11844 Work quietly.  Most warnings are suppressed.
11845
11846 @item -v
11847 Print the version number, just like @option{-v} for @command{gcc}.
11848 @end table
11849
11850 If you need special compiler options to compile one of your program's
11851 source files, then you should generate that file's @samp{.X} file
11852 specially, by running @command{gcc} on that source file with the
11853 appropriate options and the option @option{-aux-info}.  Then run
11854 @code{protoize} on the entire set of files.  @code{protoize} will use
11855 the existing @samp{.X} file because it is newer than the source file.
11856 For example:
11857
11858 @example
11859 gcc -Dfoo=bar file1.c -aux-info file1.X
11860 protoize *.c
11861 @end example
11862
11863 @noindent
11864 You need to include the special files along with the rest in the
11865 @code{protoize} command, even though their @samp{.X} files already
11866 exist, because otherwise they won't get converted.
11867
11868 @xref{Protoize Caveats}, for more information on how to use
11869 @code{protoize} successfully.