OSDN Git Service

2003-10-13 Andreas Krebbel <krebbel1@de.ibm.com>
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs  -fexternal-templates @gol
178 -falt-external-templates @gol
179 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
180 -fno-implicit-templates @gol
181 -fno-implicit-inline-templates @gol
182 -fno-implement-inlines  -fms-extensions @gol
183 -fno-nonansi-builtins  -fno-operator-names @gol
184 -fno-optional-diags  -fpermissive @gol
185 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
186 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
205
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -Wextra  -Wall  -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
218 -Werror  -Werror-implicit-function-declaration @gol
219 -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security  -Wno-format-y2k @gol
222 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
223 -Wimport  -Wno-import  -Winit-self  -Winline @gol
224 -Wno-invalid-offsetof  -Winvalid-pch @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces @gol
227 -Wmissing-format-attribute  -Wmissing-noreturn @gol
228 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
229 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
230 -Wreturn-type  -Wsequence-point  -Wshadow @gol
231 -Wsign-compare  -Wstrict-aliasing @gol
232 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
233 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
234 -Wunknown-pragmas  -Wunreachable-code @gol
235 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
236 -Wunused-value  -Wunused-variable  -Wwrite-strings}
237
238 @item C-only Warning Options
239 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
240 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
241 -Wstrict-prototypes  -Wtraditional @gol
242 -Wdeclaration-after-statement}
243
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
247 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
248 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
250 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
252 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
253 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
254 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
255 -ftest-coverage  -ftime-report @gol
256 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
257 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
258 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
259 -print-multi-directory  -print-multi-lib @gol
260 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
261 -save-temps  -time}
262
263 @item Optimization Options
264 @xref{Optimize Options,,Options that Control Optimization}.
265 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
266 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
267 -fbranch-probabilities -fprofile-values -fbranch-target-load-optimize @gol
268 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
274 -fif-conversion  -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations  -ffinite-math-only @gol
282 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @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  -fssa  -fssa-ccp  -fssa-dce @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}
345
346 @emph{M68hc1x Options}
347 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
348 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
349 -msoft-reg-count=@var{count}}
350
351 @emph{VAX Options}
352 @gccoptlist{-mg  -mgnu  -munix}
353
354 @emph{SPARC Options}
355 @gccoptlist{-mcpu=@var{cpu-type} @gol
356 -mtune=@var{cpu-type} @gol
357 -mcmodel=@var{code-model} @gol
358 -m32  -m64 @gol
359 -mapp-regs  -mbroken-saverestore  -mcypress @gol
360 -mfaster-structs  -mflat @gol
361 -mfpu  -mhard-float  -mhard-quad-float @gol
362 -mimpure-text  -mlittle-endian  -mlive-g0  -mno-app-regs @gol
363 -mno-faster-structs  -mno-flat  -mno-fpu @gol
364 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
365 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
366 -msupersparc  -munaligned-doubles  -mv8}
367
368 @emph{ARM Options}
369 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
370 -mapcs-26  -mapcs-32 @gol
371 -mapcs-stack-check  -mno-apcs-stack-check @gol
372 -mapcs-float  -mno-apcs-float @gol
373 -mapcs-reentrant  -mno-apcs-reentrant @gol
374 -msched-prolog  -mno-sched-prolog @gol
375 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
376 -malignment-traps  -mno-alignment-traps @gol
377 -msoft-float  -mhard-float  -mfpe @gol
378 -mthumb-interwork  -mno-thumb-interwork @gol
379 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
380 -mstructure-size-boundary=@var{n} @gol
381 -mabort-on-noreturn @gol
382 -mlong-calls  -mno-long-calls @gol
383 -msingle-pic-base  -mno-single-pic-base @gol
384 -mpic-register=@var{reg} @gol
385 -mnop-fun-dllimport @gol
386 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
387 -mpoke-function-name @gol
388 -mthumb  -marm @gol
389 -mtpcs-frame  -mtpcs-leaf-frame @gol
390 -mcaller-super-interworking  -mcallee-super-interworking}
391
392 @emph{MN10200 Options}
393 @gccoptlist{-mrelax}
394
395 @emph{MN10300 Options}
396 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
397 -mam33  -mno-am33 @gol
398 -mam33-2  -mno-am33-2 @gol
399 -mno-crt0  -mrelax}
400
401 @emph{M32R/D Options}
402 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
403 -msdata=@var{sdata-type}  -G @var{num}}
404
405 @emph{M88K Options}
406 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
407 -mcheck-zero-division  -mhandle-large-shift @gol
408 -midentify-revision  -mno-check-zero-division @gol
409 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
410 -mno-optimize-arg-area  -mno-serialize-volatile @gol
411 -mno-underscores  -mocs-debug-info @gol
412 -mocs-frame-position  -moptimize-arg-area @gol
413 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
414 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
415 -mversion-03.00  -mwarn-passed-structs}
416
417 @emph{RS/6000 and PowerPC Options}
418 @gccoptlist{-mcpu=@var{cpu-type} @gol
419 -mtune=@var{cpu-type} @gol
420 -mpower  -mno-power  -mpower2  -mno-power2 @gol
421 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
422 -maltivec  -mno-altivec @gol
423 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
424 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
425 -mnew-mnemonics  -mold-mnemonics @gol
426 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
427 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
428 -malign-power  -malign-natural @gol
429 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
430 -mstring  -mno-string  -mupdate  -mno-update @gol
431 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
432 -mstrict-align  -mno-strict-align  -mrelocatable @gol
433 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
434 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
435 -mdynamic-no-pic @gol
436 -mprioritize-restricted-insns=@var{priority} @gol
437 -msched-costly-dep=@var{dependence_type} @gol
438 -mcall-sysv  -mcall-netbsd @gol
439 -maix-struct-return  -msvr4-struct-return @gol
440 -mabi=altivec  -mabi=no-altivec @gol
441 -mabi=spe  -mabi=no-spe @gol
442 -misel=yes  -misel=no @gol
443 -mspe=yes  -mspe=no @gol
444 -mfloat-gprs=yes  -mfloat-gprs=no @gol
445 -mprototype  -mno-prototype @gol
446 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
447 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
448
449 @emph{Darwin Options}
450 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
451 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
452 -client_name  -compatibility_version  -current_version @gol
453 -dependency-file  -dylib_file  -dylinker_install_name @gol
454 -dynamic  -dynamiclib  -exported_symbols_list @gol
455 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
456 -force_flat_namespace  -headerpad_max_install_names @gol
457 -image_base  -init  -install_name  -keep_private_externs @gol
458 -multi_module  -multiply_defined  -multiply_defined_unused @gol
459 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
460 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
461 -private_bundle  -read_only_relocs  -sectalign @gol
462 -sectobjectsymbols  -whyload  -seg1addr @gol
463 -sectcreate  -sectobjectsymbols  -sectorder @gol
464 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
465 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
466 -single_module  -static  -sub_library  -sub_umbrella @gol
467 -twolevel_namespace  -umbrella  -undefined @gol
468 -unexported_symbols_list  -weak_reference_mismatches @gol
469 -whatsloaded}
470
471 @emph{RT Options}
472 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
473 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
474 -mminimum-fp-blocks  -mnohc-struct-return}
475
476 @emph{MIPS Options}
477 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
478 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
479 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
480 -mgas  -mgp32  -mgp64  -mhard-float  -mint64  -mips1 @gol
481 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
482 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
483 -mmips-as  -mmips-tfile  -mno-abicalls  -mxgot @gol
484 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
485 -mno-embedded-pic  -mno-long-calls @gol
486 -mno-memcpy  -mno-mips-tfile  -mno-rnames @gol
487 -mrnames  -msoft-float @gol
488 -m4650  -msingle-float  -mmad @gol
489 -EL  -EB  -G @var{num}  -nocpp @gol
490 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
491 -mfix7000  -mfix-sb1  -mno-fix-sb1 @gol
492 -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
493 -mbranch-likely -mno-branch-likely}
494
495 @emph{i386 and x86-64 Options}
496 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
497 -mfpmath=@var{unit} @gol
498 -masm=@var{dialect}  -mno-fancy-math-387 @gol
499 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
500 -mno-wide-multiply  -mrtd  -malign-double @gol
501 -mpreferred-stack-boundary=@var{num} @gol
502 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
503 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
504 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
505 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
506 -mno-red-zone -mno-tls-direct-seg-refs @gol
507 -mcmodel=@var{code-model} @gol
508 -m32  -m64}
509
510 @emph{HPPA Options}
511 @gccoptlist{-march=@var{architecture-type} @gol
512 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
513 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
514 -mjump-in-delay -mlinker-opt -mlong-calls @gol
515 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
516 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
517 -mno-jump-in-delay  -mno-long-load-store @gol
518 -mno-portable-runtime  -mno-soft-float @gol
519 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
520 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
521 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
522 -nolibdld  -static  -threads}
523
524 @emph{Intel 960 Options}
525 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
526 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
527 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
528 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
529 -mno-complex-addr  -mno-leaf-procedures @gol
530 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
531 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
532 -mtail-call}
533
534 @emph{DEC Alpha Options}
535 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
536 -mieee  -mieee-with-inexact  -mieee-conformant @gol
537 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
538 -mtrap-precision=@var{mode}  -mbuild-constants @gol
539 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
540 -mbwx  -mmax  -mfix  -mcix @gol
541 -mfloat-vax  -mfloat-ieee @gol
542 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
543 -msmall-text  -mlarge-text @gol
544 -mmemory-latency=@var{time}}
545
546 @emph{DEC Alpha/VMS Options}
547 @gccoptlist{-mvms-return-codes}
548
549 @emph{H8/300 Options}
550 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
551
552 @emph{SH Options}
553 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
554 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
555 -m5-64media  -m5-64media-nofpu @gol
556 -m5-32media  -m5-32media-nofpu @gol
557 -m5-compact  -m5-compact-nofpu @gol
558 -mb  -ml  -mdalign  -mrelax @gol
559 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
560 -mieee  -misize  -mpadstruct  -mspace @gol
561 -mprefergot  -musermode}
562
563 @emph{System V Options}
564 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
565
566 @emph{ARC Options}
567 @gccoptlist{-EB  -EL @gol
568 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
569 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
570
571 @emph{TMS320C3x/C4x Options}
572 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
573 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
574 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
575 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
576
577 @emph{V850 Options}
578 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
579 -mprolog-function  -mno-prolog-function  -mspace @gol
580 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
581 -mapp-regs  -mno-app-regs @gol
582 -mdisable-callt  -mno-disable-callt @gol
583 -mv850e1 @gol
584 -mv850e @gol
585 -mv850  -mbig-switch}
586
587 @emph{NS32K Options}
588 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
589 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
590 -mregparam  -mnoregparam  -msb  -mnosb @gol
591 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
592
593 @emph{AVR Options}
594 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
595 -mcall-prologues  -mno-tablejump  -mtiny-stack}
596
597 @emph{MCore Options}
598 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
599 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
600 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
601 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
602 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
603
604 @emph{MMIX Options}
605 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
606 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
607 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
608 -mno-base-addresses  -msingle-exit  -mno-single-exit}
609
610 @emph{IA-64 Options}
611 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
612 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
613 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
614 -minline-float-divide-max-throughput @gol
615 -minline-int-divide-min-latency @gol
616 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
617 -mfixed-range=@var{register-range}}
618
619 @emph{D30V Options}
620 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
621 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
622
623 @emph{S/390 and zSeries Options}
624 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
625 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
626 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
627 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
628
629 @emph{CRIS Options}
630 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
631 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
632 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
633 -mstack-align  -mdata-align  -mconst-align @gol
634 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
635 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
636
637 @emph{PDP-11 Options}
638 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
639 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
640 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
641 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
642 -mbranch-expensive  -mbranch-cheap @gol
643 -msplit  -mno-split  -munix-asm  -mdec-asm}
644
645 @emph{Xstormy16 Options}
646 @gccoptlist{-msim}
647
648 @emph{Xtensa Options}
649 @gccoptlist{-mconst16 -mno-const16 @gol
650 -mfused-madd  -mno-fused-madd @gol
651 -mtext-section-literals  -mno-text-section-literals @gol
652 -mtarget-align  -mno-target-align @gol
653 -mlongcalls  -mno-longcalls}
654
655 @emph{FRV Options}
656 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
657 -mhard-float  -msoft-float @gol
658 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
659 -mdouble  -mno-double @gol
660 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
661 -mlibrary-pic  -macc-4 -macc-8 @gol
662 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
663 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
664 -mvliw-branch  -mno-vliw-branch @gol
665 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
666 -mno-nested-cond-exec  -mtomcat-stats @gol
667 -mcpu=@var{cpu}}
668
669 @item Code Generation Options
670 @xref{Code Gen Options,,Options for Code Generation Conventions}.
671 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
672 -ffixed-@var{reg}  -fexceptions @gol
673 -fnon-call-exceptions  -funwind-tables @gol
674 -fasynchronous-unwind-tables @gol
675 -finhibit-size-directive  -finstrument-functions @gol
676 -fno-common  -fno-ident  -fno-gnu-linker @gol
677 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
678 -freg-struct-return  -fshared-data  -fshort-enums @gol
679 -fshort-double  -fshort-wchar @gol
680 -fverbose-asm  -fpack-struct  -fstack-check @gol
681 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
682 -fargument-alias  -fargument-noalias @gol
683 -fargument-noalias-global  -fleading-underscore @gol
684 -ftls-model=@var{model} @gol
685 -ftrapv  -fwrapv  -fbounds-check}
686 @end table
687
688 @menu
689 * Overall Options::     Controlling the kind of output:
690                         an executable, object files, assembler files,
691                         or preprocessed source.
692 * C Dialect Options::   Controlling the variant of C language compiled.
693 * C++ Dialect Options:: Variations on C++.
694 * Objective-C Dialect Options:: Variations on Objective-C.
695 * Language Independent Options:: Controlling how diagnostics should be
696                         formatted.
697 * Warning Options::     How picky should the compiler be?
698 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
699 * Optimize Options::    How much optimization?
700 * Preprocessor Options:: Controlling header files and macro definitions.
701                          Also, getting dependency information for Make.
702 * Assembler Options::   Passing options to the assembler.
703 * Link Options::        Specifying libraries and so on.
704 * Directory Options::   Where to find header files and libraries.
705                         Where to find the compiler executable files.
706 * Spec Files::          How to pass switches to sub-processes.
707 * Target Options::      Running a cross-compiler, or an old version of GCC.
708 @end menu
709
710 @node Overall Options
711 @section Options Controlling the Kind of Output
712
713 Compilation can involve up to four stages: preprocessing, compilation
714 proper, assembly and linking, always in that order.  GCC is capable of
715 preprocessing and compiling several files either into several
716 assembler input files, or into one assembler input file; then each
717 assembler input file produces an object file, and linking combines all
718 the object files (those newly compiled, and those specified as input)
719 into an executable file.
720
721 @cindex file name suffix
722 For any given input file, the file name suffix determines what kind of
723 compilation is done:
724
725 @table @gcctabopt
726 @item @var{file}.c
727 C source code which must be preprocessed.
728
729 @item @var{file}.i
730 C source code which should not be preprocessed.
731
732 @item @var{file}.ii
733 C++ source code which should not be preprocessed.
734
735 @item @var{file}.m
736 Objective-C source code.  Note that you must link with the library
737 @file{libobjc.a} to make an Objective-C program work.
738
739 @item @var{file}.mi
740 Objective-C source code which should not be preprocessed.
741
742 @item @var{file}.h
743 C or C++ header file to be turned into a precompiled header.
744
745 @item @var{file}.cc
746 @itemx @var{file}.cp
747 @itemx @var{file}.cxx
748 @itemx @var{file}.cpp
749 @itemx @var{file}.CPP
750 @itemx @var{file}.c++
751 @itemx @var{file}.C
752 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
753 the last two letters must both be literally @samp{x}.  Likewise,
754 @samp{.C} refers to a literal capital C@.
755
756 @item @var{file}.hh
757 @itemx @var{file}.H
758 C++ header file to be turned into a precompiled header.
759
760 @item @var{file}.f
761 @itemx @var{file}.for
762 @itemx @var{file}.FOR
763 Fortran source code which should not be preprocessed.
764
765 @item @var{file}.F
766 @itemx @var{file}.fpp
767 @itemx @var{file}.FPP
768 Fortran source code which must be preprocessed (with the traditional
769 preprocessor).
770
771 @item @var{file}.r
772 Fortran source code which must be preprocessed with a RATFOR
773 preprocessor (not included with GCC)@.
774
775 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
776 Using and Porting GNU Fortran}, for more details of the handling of
777 Fortran input files.
778
779 @c FIXME: Descriptions of Java file types.
780 @c @var{file}.java
781 @c @var{file}.class
782 @c @var{file}.zip
783 @c @var{file}.jar
784
785 @item @var{file}.ads
786 Ada source code file which contains a library unit declaration (a
787 declaration of a package, subprogram, or generic, or a generic
788 instantiation), or a library unit renaming declaration (a package,
789 generic, or subprogram renaming declaration).  Such files are also
790 called @dfn{specs}.
791
792 @itemx @var{file}.adb
793 Ada source code file containing a library unit body (a subprogram or
794 package body).  Such files are also called @dfn{bodies}.
795
796 @c GCC also knows about some suffixes for languages not yet included:
797 @c Pascal:
798 @c @var{file}.p
799 @c @var{file}.pas
800
801 @item @var{file}.s
802 Assembler code.
803
804 @item @var{file}.S
805 Assembler code which must be preprocessed.
806
807 @item @var{other}
808 An object file to be fed straight into linking.
809 Any file name with no recognized suffix is treated this way.
810 @end table
811
812 @opindex x
813 You can specify the input language explicitly with the @option{-x} option:
814
815 @table @gcctabopt
816 @item -x @var{language}
817 Specify explicitly the @var{language} for the following input files
818 (rather than letting the compiler choose a default based on the file
819 name suffix).  This option applies to all following input files until
820 the next @option{-x} option.  Possible values for @var{language} are:
821 @example
822 c  c-header  cpp-output
823 c++  c++-header  c++-cpp-output
824 objective-c  objective-c-header  objc-cpp-output
825 assembler  assembler-with-cpp
826 ada
827 f77  f77-cpp-input  ratfor
828 java
829 treelang
830 @end example
831
832 @item -x none
833 Turn off any specification of a language, so that subsequent files are
834 handled according to their file name suffixes (as they are if @option{-x}
835 has not been used at all).
836
837 @item -pass-exit-codes
838 @opindex pass-exit-codes
839 Normally the @command{gcc} program will exit with the code of 1 if any
840 phase of the compiler returns a non-success return code.  If you specify
841 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
842 numerically highest error produced by any phase that returned an error
843 indication.
844 @end table
845
846 If you only want some of the stages of compilation, you can use
847 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
848 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
849 @command{gcc} is to stop.  Note that some combinations (for example,
850 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
851
852 @table @gcctabopt
853 @item -c
854 @opindex c
855 Compile or assemble the source files, but do not link.  The linking
856 stage simply is not done.  The ultimate output is in the form of an
857 object file for each source file.
858
859 By default, the object file name for a source file is made by replacing
860 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
861
862 Unrecognized input files, not requiring compilation or assembly, are
863 ignored.
864
865 @item -S
866 @opindex S
867 Stop after the stage of compilation proper; do not assemble.  The output
868 is in the form of an assembler code file for each non-assembler input
869 file specified.
870
871 By default, the assembler file name for a source file is made by
872 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
873
874 Input files that don't require compilation are ignored.
875
876 @item -E
877 @opindex E
878 Stop after the preprocessing stage; do not run the compiler proper.  The
879 output is in the form of preprocessed source code, which is sent to the
880 standard output.
881
882 Input files which don't require preprocessing are ignored.
883
884 @cindex output file option
885 @item -o @var{file}
886 @opindex o
887 Place output in file @var{file}.  This applies regardless to whatever
888 sort of output is being produced, whether it be an executable file,
889 an object file, an assembler file or preprocessed C code.
890
891 If you specify @option{-o} when compiling more than one input file, or
892 you are producing an executable file as output, all the source files
893 on the command line will be compiled at once.
894
895 If @option{-o} is not specified, the default is to put an executable file
896 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
897 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
898 all preprocessed C source on standard output.
899
900 @item -v
901 @opindex v
902 Print (on standard error output) the commands executed to run the stages
903 of compilation.  Also print the version number of the compiler driver
904 program and of the preprocessor and the compiler proper.
905
906 @item -###
907 @opindex ###
908 Like @option{-v} except the commands are not executed and all command
909 arguments are quoted.  This is useful for shell scripts to capture the
910 driver-generated command lines.
911
912 @item -pipe
913 @opindex pipe
914 Use pipes rather than temporary files for communication between the
915 various stages of compilation.  This fails to work on some systems where
916 the assembler is unable to read from a pipe; but the GNU assembler has
917 no trouble.
918
919 @item --help
920 @opindex help
921 Print (on the standard output) a description of the command line options
922 understood by @command{gcc}.  If the @option{-v} option is also specified
923 then @option{--help} will also be passed on to the various processes
924 invoked by @command{gcc}, so that they can display the command line options
925 they accept.  If the @option{-Wextra} option is also specified then command
926 line options which have no documentation associated with them will also
927 be displayed.
928
929 @item --target-help
930 @opindex target-help
931 Print (on the standard output) a description of target specific command
932 line options for each tool.
933
934 @item --version
935 @opindex version
936 Display the version number and copyrights of the invoked GCC.
937 @end table
938
939 @node Invoking G++
940 @section Compiling C++ Programs
941
942 @cindex suffixes for C++ source
943 @cindex C++ source file suffixes
944 C++ source files conventionally use one of the suffixes @samp{.C},
945 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
946 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
947 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
948 files with these names and compiles them as C++ programs even if you
949 call the compiler the same way as for compiling C programs (usually
950 with the name @command{gcc}).
951
952 @findex g++
953 @findex c++
954 However, C++ programs often require class libraries as well as a
955 compiler that understands the C++ language---and under some
956 circumstances, you might want to compile programs or header files from
957 standard input, or otherwise without a suffix that flags them as C++
958 programs.  You might also like to precompile a C header file with a
959 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
960 program that calls GCC with the default language set to C++, and
961 automatically specifies linking against the C++ library.  On many
962 systems, @command{g++} is also installed with the name @command{c++}.
963
964 @cindex invoking @command{g++}
965 When you compile C++ programs, you may specify many of the same
966 command-line options that you use for compiling programs in any
967 language; or command-line options meaningful for C and related
968 languages; or options that are meaningful only for C++ programs.
969 @xref{C Dialect Options,,Options Controlling C Dialect}, for
970 explanations of options for languages related to C@.
971 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
972 explanations of options that are meaningful only for C++ programs.
973
974 @node C Dialect Options
975 @section Options Controlling C Dialect
976 @cindex dialect options
977 @cindex language dialect options
978 @cindex options, dialect
979
980 The following options control the dialect of C (or languages derived
981 from C, such as C++ and Objective-C) that the compiler accepts:
982
983 @table @gcctabopt
984 @cindex ANSI support
985 @cindex ISO support
986 @item -ansi
987 @opindex ansi
988 In C mode, support all ISO C90 programs.  In C++ mode,
989 remove GNU extensions that conflict with ISO C++.
990
991 This turns off certain features of GCC that are incompatible with ISO
992 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
993 such as the @code{asm} and @code{typeof} keywords, and
994 predefined macros such as @code{unix} and @code{vax} that identify the
995 type of system you are using.  It also enables the undesirable and
996 rarely used ISO trigraph feature.  For the C compiler,
997 it disables recognition of C++ style @samp{//} comments as well as
998 the @code{inline} keyword.
999
1000 The alternate keywords @code{__asm__}, @code{__extension__},
1001 @code{__inline__} and @code{__typeof__} continue to work despite
1002 @option{-ansi}.  You would not want to use them in an ISO C program, of
1003 course, but it is useful to put them in header files that might be included
1004 in compilations done with @option{-ansi}.  Alternate predefined macros
1005 such as @code{__unix__} and @code{__vax__} are also available, with or
1006 without @option{-ansi}.
1007
1008 The @option{-ansi} option does not cause non-ISO programs to be
1009 rejected gratuitously.  For that, @option{-pedantic} is required in
1010 addition to @option{-ansi}.  @xref{Warning Options}.
1011
1012 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1013 option is used.  Some header files may notice this macro and refrain
1014 from declaring certain functions or defining certain macros that the
1015 ISO standard doesn't call for; this is to avoid interfering with any
1016 programs that might use these names for other things.
1017
1018 Functions which would normally be built in but do not have semantics
1019 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1020 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1021 built-in functions provided by GCC}, for details of the functions
1022 affected.
1023
1024 @item -std=
1025 @opindex std
1026 Determine the language standard.  This option is currently only
1027 supported when compiling C or C++.  A value for this option must be
1028 provided; possible values are
1029
1030 @table @samp
1031 @item c89
1032 @itemx iso9899:1990
1033 ISO C90 (same as @option{-ansi}).
1034
1035 @item iso9899:199409
1036 ISO C90 as modified in amendment 1.
1037
1038 @item c99
1039 @itemx c9x
1040 @itemx iso9899:1999
1041 @itemx iso9899:199x
1042 ISO C99.  Note that this standard is not yet fully supported; see
1043 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1044 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1045
1046 @item gnu89
1047 Default, ISO C90 plus GNU extensions (including some C99 features).
1048
1049 @item gnu99
1050 @item gnu9x
1051 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1052 this will become the default.  The name @samp{gnu9x} is deprecated.
1053
1054 @item c++98
1055 The 1998 ISO C++ standard plus amendments.
1056
1057 @item gnu++98
1058 The same as @option{-std=c++98} plus GNU extensions.  This is the
1059 default for C++ code.
1060 @end table
1061
1062 Even when this option is not specified, you can still use some of the
1063 features of newer standards in so far as they do not conflict with
1064 previous C standards.  For example, you may use @code{__restrict__} even
1065 when @option{-std=c99} is not specified.
1066
1067 The @option{-std} options specifying some version of ISO C have the same
1068 effects as @option{-ansi}, except that features that were not in ISO C90
1069 but are in the specified version (for example, @samp{//} comments and
1070 the @code{inline} keyword in ISO C99) are not disabled.
1071
1072 @xref{Standards,,Language Standards Supported by GCC}, for details of
1073 these standard versions.
1074
1075 @item -aux-info @var{filename}
1076 @opindex aux-info
1077 Output to the given filename prototyped declarations for all functions
1078 declared and/or defined in a translation unit, including those in header
1079 files.  This option is silently ignored in any language other than C@.
1080
1081 Besides declarations, the file indicates, in comments, the origin of
1082 each declaration (source file and line), whether the declaration was
1083 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1084 @samp{O} for old, respectively, in the first character after the line
1085 number and the colon), and whether it came from a declaration or a
1086 definition (@samp{C} or @samp{F}, respectively, in the following
1087 character).  In the case of function definitions, a K&R-style list of
1088 arguments followed by their declarations is also provided, inside
1089 comments, after the declaration.
1090
1091 @item -fno-asm
1092 @opindex fno-asm
1093 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1094 keyword, so that code can use these words as identifiers.  You can use
1095 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1096 instead.  @option{-ansi} implies @option{-fno-asm}.
1097
1098 In C++, this switch only affects the @code{typeof} keyword, since
1099 @code{asm} and @code{inline} are standard keywords.  You may want to
1100 use the @option{-fno-gnu-keywords} flag instead, which has the same
1101 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1102 switch only affects the @code{asm} and @code{typeof} keywords, since
1103 @code{inline} is a standard keyword in ISO C99.
1104
1105 @item -fno-builtin
1106 @itemx -fno-builtin-@var{function}
1107 @opindex fno-builtin
1108 @cindex built-in functions
1109 Don't recognize built-in functions that do not begin with
1110 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1111 functions provided by GCC}, for details of the functions affected,
1112 including those which are not built-in functions when @option{-ansi} or
1113 @option{-std} options for strict ISO C conformance are used because they
1114 do not have an ISO standard meaning.
1115
1116 GCC normally generates special code to handle certain built-in functions
1117 more efficiently; for instance, calls to @code{alloca} may become single
1118 instructions that adjust the stack directly, and calls to @code{memcpy}
1119 may become inline copy loops.  The resulting code is often both smaller
1120 and faster, but since the function calls no longer appear as such, you
1121 cannot set a breakpoint on those calls, nor can you change the behavior
1122 of the functions by linking with a different library.
1123
1124 With the @option{-fno-builtin-@var{function}} option
1125 only the built-in function @var{function} is
1126 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1127 function is named this is not built-in in this version of GCC, this
1128 option is ignored.  There is no corresponding
1129 @option{-fbuiltin-@var{function}} option; if you wish to enable
1130 built-in functions selectively when using @option{-fno-builtin} or
1131 @option{-ffreestanding}, you may define macros such as:
1132
1133 @smallexample
1134 #define abs(n)          __builtin_abs ((n))
1135 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1136 @end smallexample
1137
1138 @item -fhosted
1139 @opindex fhosted
1140 @cindex hosted environment
1141
1142 Assert that compilation takes place in a hosted environment.  This implies
1143 @option{-fbuiltin}.  A hosted environment is one in which the
1144 entire standard library is available, and in which @code{main} has a return
1145 type of @code{int}.  Examples are nearly everything except a kernel.
1146 This is equivalent to @option{-fno-freestanding}.
1147
1148 @item -ffreestanding
1149 @opindex ffreestanding
1150 @cindex hosted environment
1151
1152 Assert that compilation takes place in a freestanding environment.  This
1153 implies @option{-fno-builtin}.  A freestanding environment
1154 is one in which the standard library may not exist, and program startup may
1155 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1156 This is equivalent to @option{-fno-hosted}.
1157
1158 @xref{Standards,,Language Standards Supported by GCC}, for details of
1159 freestanding and hosted environments.
1160
1161 @item -fms-extensions
1162 @opindex fms-extensions
1163 Accept some non-standard constructs used in Microsoft header files.
1164
1165 @item -trigraphs
1166 @opindex trigraphs
1167 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1168 options for strict ISO C conformance) implies @option{-trigraphs}.
1169
1170 @item -no-integrated-cpp
1171 @opindex no-integrated-cpp
1172 Performs a compilation in two passes: preprocessing and compiling.  This
1173 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1174 @option{-B} option. The user supplied compilation step can then add in
1175 an additional preprocessing step after normal preprocessing but before
1176 compiling. The default is to use the integrated cpp (internal cpp)
1177
1178 The semantics of this option will change if "cc1", "cc1plus", and
1179 "cc1obj" are merged.
1180
1181 @cindex traditional C language
1182 @cindex C language, traditional
1183 @item -traditional
1184 @itemx -traditional-cpp
1185 @opindex traditional-cpp
1186 @opindex traditional
1187 Formerly, these options caused GCC to attempt to emulate a pre-standard
1188 C compiler.  They are now only supported with the @option{-E} switch.
1189 The preprocessor continues to support a pre-standard mode.  See the GNU
1190 CPP manual for details.
1191
1192 @item -fcond-mismatch
1193 @opindex fcond-mismatch
1194 Allow conditional expressions with mismatched types in the second and
1195 third arguments.  The value of such an expression is void.  This option
1196 is not supported for C++.
1197
1198 @item -funsigned-char
1199 @opindex funsigned-char
1200 Let the type @code{char} be unsigned, like @code{unsigned char}.
1201
1202 Each kind of machine has a default for what @code{char} should
1203 be.  It is either like @code{unsigned char} by default or like
1204 @code{signed char} by default.
1205
1206 Ideally, a portable program should always use @code{signed char} or
1207 @code{unsigned char} when it depends on the signedness of an object.
1208 But many programs have been written to use plain @code{char} and
1209 expect it to be signed, or expect it to be unsigned, depending on the
1210 machines they were written for.  This option, and its inverse, let you
1211 make such a program work with the opposite default.
1212
1213 The type @code{char} is always a distinct type from each of
1214 @code{signed char} or @code{unsigned char}, even though its behavior
1215 is always just like one of those two.
1216
1217 @item -fsigned-char
1218 @opindex fsigned-char
1219 Let the type @code{char} be signed, like @code{signed char}.
1220
1221 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1222 the negative form of @option{-funsigned-char}.  Likewise, the option
1223 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1224
1225 @item -fsigned-bitfields
1226 @itemx -funsigned-bitfields
1227 @itemx -fno-signed-bitfields
1228 @itemx -fno-unsigned-bitfields
1229 @opindex fsigned-bitfields
1230 @opindex funsigned-bitfields
1231 @opindex fno-signed-bitfields
1232 @opindex fno-unsigned-bitfields
1233 These options control whether a bit-field is signed or unsigned, when the
1234 declaration does not use either @code{signed} or @code{unsigned}.  By
1235 default, such a bit-field is signed, because this is consistent: the
1236 basic integer types such as @code{int} are signed types.
1237
1238 @item -fwritable-strings
1239 @opindex fwritable-strings
1240 Store string constants in the writable data segment and don't uniquize
1241 them.  This is for compatibility with old programs which assume they can
1242 write into string constants.
1243
1244 Writing into string constants is a very bad idea; ``constants'' should
1245 be constant.
1246 @end table
1247
1248 @node C++ Dialect Options
1249 @section Options Controlling C++ Dialect
1250
1251 @cindex compiler options, C++
1252 @cindex C++ options, command line
1253 @cindex options, C++
1254 This section describes the command-line options that are only meaningful
1255 for C++ programs; but you can also use most of the GNU compiler options
1256 regardless of what language your program is in.  For example, you
1257 might compile a file @code{firstClass.C} like this:
1258
1259 @example
1260 g++ -g -frepo -O -c firstClass.C
1261 @end example
1262
1263 @noindent
1264 In this example, only @option{-frepo} is an option meant
1265 only for C++ programs; you can use the other options with any
1266 language supported by GCC@.
1267
1268 Here is a list of options that are @emph{only} for compiling C++ programs:
1269
1270 @table @gcctabopt
1271
1272 @item -fabi-version=@var{n}
1273 @opindex fabi-version
1274 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1275 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1276 version that conforms most closely to the C++ ABI specification.
1277 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1278 fixed.
1279
1280 The default is version 1.
1281
1282 @item -fno-access-control
1283 @opindex fno-access-control
1284 Turn off all access checking.  This switch is mainly useful for working
1285 around bugs in the access control code.
1286
1287 @item -fcheck-new
1288 @opindex fcheck-new
1289 Check that the pointer returned by @code{operator new} is non-null
1290 before attempting to modify the storage allocated.  This check is
1291 normally unnecessary because the C++ standard specifies that
1292 @code{operator new} will only return @code{0} if it is declared
1293 @samp{throw()}, in which case the compiler will always check the
1294 return value even without this option.  In all other cases, when
1295 @code{operator new} has a non-empty exception specification, memory
1296 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1297 @samp{new (nothrow)}.
1298
1299 @item -fconserve-space
1300 @opindex fconserve-space
1301 Put uninitialized or runtime-initialized global variables into the
1302 common segment, as C does.  This saves space in the executable at the
1303 cost of not diagnosing duplicate definitions.  If you compile with this
1304 flag and your program mysteriously crashes after @code{main()} has
1305 completed, you may have an object that is being destroyed twice because
1306 two definitions were merged.
1307
1308 This option is no longer useful on most targets, now that support has
1309 been added for putting variables into BSS without making them common.
1310
1311 @item -fno-const-strings
1312 @opindex fno-const-strings
1313 Give string constants type @code{char *} instead of type @code{const
1314 char *}.  By default, G++ uses type @code{const char *} as required by
1315 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1316 actually modify the value of a string constant, unless you also use
1317 @option{-fwritable-strings}.
1318
1319 This option might be removed in a future release of G++.  For maximum
1320 portability, you should structure your code so that it works with
1321 string constants that have type @code{const char *}.
1322
1323 @item -fno-elide-constructors
1324 @opindex fno-elide-constructors
1325 The C++ standard allows an implementation to omit creating a temporary
1326 which is only used to initialize another object of the same type.
1327 Specifying this option disables that optimization, and forces G++ to
1328 call the copy constructor in all cases.
1329
1330 @item -fno-enforce-eh-specs
1331 @opindex fno-enforce-eh-specs
1332 Don't check for violation of exception specifications at runtime.  This
1333 option violates the C++ standard, but may be useful for reducing code
1334 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1335 will still optimize based on the exception specifications.
1336
1337 @item -fexternal-templates
1338 @opindex fexternal-templates
1339
1340 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1341 template instantiation; template instances are emitted or not according
1342 to the location of the template definition.  @xref{Template
1343 Instantiation}, for more information.
1344
1345 This option is deprecated.
1346
1347 @item -falt-external-templates
1348 @opindex falt-external-templates
1349 Similar to @option{-fexternal-templates}, but template instances are
1350 emitted or not according to the place where they are first instantiated.
1351 @xref{Template Instantiation}, for more information.
1352
1353 This option is deprecated.
1354
1355 @item -ffor-scope
1356 @itemx -fno-for-scope
1357 @opindex ffor-scope
1358 @opindex fno-for-scope
1359 If @option{-ffor-scope} is specified, the scope of variables declared in
1360 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1361 as specified by the C++ standard.
1362 If @option{-fno-for-scope} is specified, the scope of variables declared in
1363 a @i{for-init-statement} extends to the end of the enclosing scope,
1364 as was the case in old versions of G++, and other (traditional)
1365 implementations of C++.
1366
1367 The default if neither flag is given to follow the standard,
1368 but to allow and give a warning for old-style code that would
1369 otherwise be invalid, or have different behavior.
1370
1371 @item -fno-gnu-keywords
1372 @opindex fno-gnu-keywords
1373 Do not recognize @code{typeof} as a keyword, so that code can use this
1374 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1375 @option{-ansi} implies @option{-fno-gnu-keywords}.
1376
1377 @item -fno-implicit-templates
1378 @opindex fno-implicit-templates
1379 Never emit code for non-inline templates which are instantiated
1380 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1381 @xref{Template Instantiation}, for more information.
1382
1383 @item -fno-implicit-inline-templates
1384 @opindex fno-implicit-inline-templates
1385 Don't emit code for implicit instantiations of inline templates, either.
1386 The default is to handle inlines differently so that compiles with and
1387 without optimization will need the same set of explicit instantiations.
1388
1389 @item -fno-implement-inlines
1390 @opindex fno-implement-inlines
1391 To save space, do not emit out-of-line copies of inline functions
1392 controlled by @samp{#pragma implementation}.  This will cause linker
1393 errors if these functions are not inlined everywhere they are called.
1394
1395 @item -fms-extensions
1396 @opindex fms-extensions
1397 Disable pedantic warnings about constructs used in MFC, such as implicit
1398 int and getting a pointer to member function via non-standard syntax.
1399
1400 @item -fno-nonansi-builtins
1401 @opindex fno-nonansi-builtins
1402 Disable built-in declarations of functions that are not mandated by
1403 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1404 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1405
1406 @item -fno-operator-names
1407 @opindex fno-operator-names
1408 Do not treat the operator name keywords @code{and}, @code{bitand},
1409 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1410 synonyms as keywords.
1411
1412 @item -fno-optional-diags
1413 @opindex fno-optional-diags
1414 Disable diagnostics that the standard says a compiler does not need to
1415 issue.  Currently, the only such diagnostic issued by G++ is the one for
1416 a name having multiple meanings within a class.
1417
1418 @item -fpermissive
1419 @opindex fpermissive
1420 Downgrade some diagnostics about nonconformant code from errors to
1421 warnings.  Thus, using @option{-fpermissive} will allow some
1422 nonconforming code to compile.
1423
1424 @item -frepo
1425 @opindex frepo
1426 Enable automatic template instantiation at link time.  This option also
1427 implies @option{-fno-implicit-templates}.  @xref{Template
1428 Instantiation}, for more information.
1429
1430 @item -fno-rtti
1431 @opindex fno-rtti
1432 Disable generation of information about every class with virtual
1433 functions for use by the C++ runtime type identification features
1434 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1435 of the language, you can save some space by using this flag.  Note that
1436 exception handling uses the same information, but it will generate it as
1437 needed.
1438
1439 @item -fstats
1440 @opindex fstats
1441 Emit statistics about front-end processing at the end of the compilation.
1442 This information is generally only useful to the G++ development team.
1443
1444 @item -ftemplate-depth-@var{n}
1445 @opindex ftemplate-depth
1446 Set the maximum instantiation depth for template classes to @var{n}.
1447 A limit on the template instantiation depth is needed to detect
1448 endless recursions during template class instantiation.  ANSI/ISO C++
1449 conforming programs must not rely on a maximum depth greater than 17.
1450
1451 @item -fuse-cxa-atexit
1452 @opindex fuse-cxa-atexit
1453 Register destructors for objects with static storage duration with the
1454 @code{__cxa_atexit} function rather than the @code{atexit} function.
1455 This option is required for fully standards-compliant handling of static
1456 destructors, but will only work if your C library supports
1457 @code{__cxa_atexit}.
1458
1459 @item -fno-weak
1460 @opindex fno-weak
1461 Do not use weak symbol support, even if it is provided by the linker.
1462 By default, G++ will use weak symbols if they are available.  This
1463 option exists only for testing, and should not be used by end-users;
1464 it will result in inferior code and has no benefits.  This option may
1465 be removed in a future release of G++.
1466
1467 @item -nostdinc++
1468 @opindex nostdinc++
1469 Do not search for header files in the standard directories specific to
1470 C++, but do still search the other standard directories.  (This option
1471 is used when building the C++ library.)
1472 @end table
1473
1474 In addition, these optimization, warning, and code generation options
1475 have meanings only for C++ programs:
1476
1477 @table @gcctabopt
1478 @item -fno-default-inline
1479 @opindex fno-default-inline
1480 Do not assume @samp{inline} for functions defined inside a class scope.
1481 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1482 functions will have linkage like inline functions; they just won't be
1483 inlined by default.
1484
1485 @item -Wabi @r{(C++ only)}
1486 @opindex Wabi
1487 Warn when G++ generates code that is probably not compatible with the
1488 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1489 all such cases, there are probably some cases that are not warned about, 
1490 even though G++ is generating incompatible code.  There may also be
1491 cases where warnings are emitted even though the code that is generated
1492 will be compatible.
1493
1494 You should rewrite your code to avoid these warnings if you are
1495 concerned about the fact that code generated by G++ may not be binary
1496 compatible with code generated by other compilers.
1497
1498 The known incompatibilities at this point include:
1499
1500 @itemize @bullet
1501
1502 @item
1503 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1504 pack data into the same byte as a base class.  For example:
1505
1506 @smallexample
1507 struct A @{ virtual void f(); int f1 : 1; @};
1508 struct B : public A @{ int f2 : 1; @};
1509 @end smallexample
1510
1511 @noindent
1512 In this case, G++ will place @code{B::f2} into the same byte
1513 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1514 by explicitly padding @code{A} so that its size is a multiple of the
1515 byte size on your platform; that will cause G++ and other compilers to
1516 layout @code{B} identically.
1517
1518 @item
1519 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1520 tail padding when laying out virtual bases.  For example:
1521
1522 @smallexample
1523 struct A @{ virtual void f(); char c1; @};
1524 struct B @{ B(); char c2; @};
1525 struct C : public A, public virtual B @{@};
1526 @end smallexample
1527
1528 @noindent
1529 In this case, G++ will not place @code{B} into the tail-padding for
1530 @code{A}; other compilers will.  You can avoid this problem by
1531 explicitly padding @code{A} so that its size is a multiple of its
1532 alignment (ignoring virtual base classes); that will cause G++ and other
1533 compilers to layout @code{C} identically.
1534
1535 @item
1536 Incorrect handling of bit-fields with declared widths greater than that
1537 of their underlying types, when the bit-fields appear in a union.  For
1538 example:
1539
1540 @smallexample
1541 union U @{ int i : 4096; @};
1542 @end smallexample
1543
1544 @noindent
1545 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1546 union too small by the number of bits in an @code{int}.
1547
1548 @item
1549 Empty classes can be placed at incorrect offsets.  For example:
1550  
1551 @smallexample
1552 struct A @{@};
1553
1554 struct B @{
1555   A a;
1556   virtual void f ();
1557 @};
1558
1559 struct C : public B, public A @{@};
1560 @end smallexample
1561
1562 @noindent
1563 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1564 it should be placed at offset zero.  G++ mistakenly believes that the
1565 @code{A} data member of @code{B} is already at offset zero.
1566
1567 @item
1568 Names of template functions whose types involve @code{typename} or
1569 template template parameters can be mangled incorrectly.
1570
1571 @smallexample
1572 template <typename Q>
1573 void f(typename Q::X) @{@}
1574
1575 template <template <typename> class Q>
1576 void f(typename Q<int>::X) @{@}
1577 @end smallexample
1578
1579 @noindent
1580 Instantiations of these templates may be mangled incorrectly.
1581
1582 @end itemize
1583
1584 @item -Wctor-dtor-privacy @r{(C++ only)}
1585 @opindex Wctor-dtor-privacy
1586 Warn when a class seems unusable because all the constructors or
1587 destructors in that class are private, and it has neither friends nor
1588 public static member functions.
1589
1590 @item -Wnon-virtual-dtor @r{(C++ only)}
1591 @opindex Wnon-virtual-dtor
1592 Warn when a class appears to be polymorphic, thereby requiring a virtual
1593 destructor, yet it declares a non-virtual one.
1594 This warning is enabled by @option{-Wall}.
1595
1596 @item -Wreorder @r{(C++ only)}
1597 @opindex Wreorder
1598 @cindex reordering, warning
1599 @cindex warning for reordering of member initializers
1600 Warn when the order of member initializers given in the code does not
1601 match the order in which they must be executed.  For instance:
1602
1603 @smallexample
1604 struct A @{
1605   int i;
1606   int j;
1607   A(): j (0), i (1) @{ @}
1608 @};
1609 @end smallexample
1610
1611 The compiler will rearrange the member initializers for @samp{i}
1612 and @samp{j} to match the declaration order of the members, emitting
1613 a warning to that effect.  This warning is enabled by @option{-Wall}.
1614 @end table
1615
1616 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1617
1618 @table @gcctabopt
1619 @item -Weffc++ @r{(C++ only)}
1620 @opindex Weffc++
1621 Warn about violations of the following style guidelines from Scott Meyers'
1622 @cite{Effective C++} book:
1623
1624 @itemize @bullet
1625 @item
1626 Item 11:  Define a copy constructor and an assignment operator for classes
1627 with dynamically allocated memory.
1628
1629 @item
1630 Item 12:  Prefer initialization to assignment in constructors.
1631
1632 @item
1633 Item 14:  Make destructors virtual in base classes.
1634
1635 @item
1636 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1637
1638 @item
1639 Item 23:  Don't try to return a reference when you must return an object.
1640
1641 @end itemize
1642
1643 Also warn about violations of the following style guidelines from 
1644 Scott Meyers' @cite{More Effective C++} book:
1645
1646 @itemize @bullet
1647 @item
1648 Item 6:  Distinguish between prefix and postfix forms of increment and
1649 decrement operators.
1650
1651 @item
1652 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1653
1654 @end itemize
1655
1656 When selecting this option, be aware that the standard library
1657 headers do not obey all of these guidelines; use @samp{grep -v}
1658 to filter out those warnings.
1659
1660 @item -Wno-deprecated @r{(C++ only)}
1661 @opindex Wno-deprecated
1662 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1663
1664 @item -Wno-non-template-friend @r{(C++ only)}
1665 @opindex Wno-non-template-friend
1666 Disable warnings when non-templatized friend functions are declared
1667 within a template.  Since the advent of explicit template specification
1668 support in G++, if the name of the friend is an unqualified-id (i.e.,
1669 @samp{friend foo(int)}), the C++ language specification demands that the
1670 friend declare or define an ordinary, nontemplate function.  (Section
1671 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1672 could be interpreted as a particular specialization of a templatized
1673 function.  Because this non-conforming behavior is no longer the default
1674 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1675 check existing code for potential trouble spots and is on by default.
1676 This new compiler behavior can be turned off with
1677 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1678 but disables the helpful warning.
1679
1680 @item -Wold-style-cast @r{(C++ only)}
1681 @opindex Wold-style-cast
1682 Warn if an old-style (C-style) cast to a non-void type is used within
1683 a C++ program.  The new-style casts (@samp{static_cast},
1684 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1685 unintended effects and much easier to search for.
1686
1687 @item -Woverloaded-virtual @r{(C++ only)}
1688 @opindex Woverloaded-virtual
1689 @cindex overloaded virtual fn, warning
1690 @cindex warning for overloaded virtual fn
1691 Warn when a function declaration hides virtual functions from a
1692 base class.  For example, in:
1693
1694 @smallexample
1695 struct A @{
1696   virtual void f();
1697 @};
1698
1699 struct B: public A @{
1700   void f(int);
1701 @};
1702 @end smallexample
1703
1704 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1705 like:
1706
1707 @smallexample
1708 B* b;
1709 b->f();
1710 @end smallexample
1711
1712 will fail to compile.
1713
1714 @item -Wno-pmf-conversions @r{(C++ only)}
1715 @opindex Wno-pmf-conversions
1716 Disable the diagnostic for converting a bound pointer to member function
1717 to a plain pointer.
1718
1719 @item -Wsign-promo @r{(C++ only)}
1720 @opindex Wsign-promo
1721 Warn when overload resolution chooses a promotion from unsigned or
1722 enumeral type to a signed type, over a conversion to an unsigned type of
1723 the same size.  Previous versions of G++ would try to preserve
1724 unsignedness, but the standard mandates the current behavior.
1725
1726 @item -Wsynth @r{(C++ only)}
1727 @opindex Wsynth
1728 @cindex warning for synthesized methods
1729 @cindex synthesized methods, warning
1730 Warn when G++'s synthesis behavior does not match that of cfront.  For
1731 instance:
1732
1733 @smallexample
1734 struct A @{
1735   operator int ();
1736   A& operator = (int);
1737 @};
1738
1739 main ()
1740 @{
1741   A a,b;
1742   a = b;
1743 @}
1744 @end smallexample
1745
1746 In this example, G++ will synthesize a default @samp{A& operator =
1747 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1748 @end table
1749
1750 @node Objective-C Dialect Options
1751 @section Options Controlling Objective-C Dialect
1752
1753 @cindex compiler options, Objective-C
1754 @cindex Objective-C options, command line
1755 @cindex options, Objective-C
1756 (NOTE: This manual does not describe the Objective-C language itself.  See
1757 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1758
1759 This section describes the command-line options that are only meaningful
1760 for Objective-C programs, but you can also use most of the GNU compiler
1761 options regardless of what language your program is in.  For example,
1762 you might compile a file @code{some_class.m} like this:
1763
1764 @example
1765 gcc -g -fgnu-runtime -O -c some_class.m
1766 @end example
1767
1768 @noindent
1769 In this example, @option{-fgnu-runtime} is an option meant only for
1770 Objective-C programs; you can use the other options with any language
1771 supported by GCC@.
1772
1773 Here is a list of options that are @emph{only} for compiling Objective-C
1774 programs:
1775
1776 @table @gcctabopt
1777 @item -fconstant-string-class=@var{class-name}
1778 @opindex fconstant-string-class
1779 Use @var{class-name} as the name of the class to instantiate for each
1780 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1781 class name is @code{NXConstantString} if the GNU runtime is being used, and
1782 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1783 @option{-fconstant-cfstrings} option, if also present, will override the
1784 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1785 to be laid out as constant CoreFoundation strings.
1786
1787 @item -fgnu-runtime
1788 @opindex fgnu-runtime
1789 Generate object code compatible with the standard GNU Objective-C
1790 runtime.  This is the default for most types of systems.
1791
1792 @item -fnext-runtime
1793 @opindex fnext-runtime
1794 Generate output compatible with the NeXT runtime.  This is the default
1795 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1796 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1797 used.
1798
1799 @item -fno-nil-receivers
1800 @opindex -fno-nil-receivers
1801 Assume that all Objective-C message dispatches (e.g., 
1802 @code{[receiver message:arg]}) in this translation unit ensure that the receiver 
1803 is not @code{nil}.  This allows for more efficient entry points in the runtime to be 
1804 used.  Currently, this option is only available in conjunction with 
1805 the NeXT runtime on Mac OS X 10.3 and later.
1806
1807 @item -fobjc-exceptions
1808 @opindex -fobjc-exceptions
1809 Enable syntactic support for structured exception handling in Objective-C, 
1810 similar to what is offered by C++ and Java.  Currently, this option is only 
1811 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. 
1812
1813 @smallexample
1814   @@try @{
1815     @dots{}
1816        @@throw expr;
1817     @dots{}
1818   @}
1819   @@catch (AnObjCClass *exc) @{
1820     @dots{}
1821       @@throw expr;
1822     @dots{}
1823       @@throw;
1824     @dots{}
1825   @}
1826   @@catch (AnotherClass *exc) @{
1827     @dots{}
1828   @}
1829   @@catch (id allOthers) @{
1830     @dots{}
1831   @}
1832   @@finally @{
1833     @dots{}
1834       @@throw expr;
1835     @dots{}
1836   @}
1837 @end smallexample
1838
1839 The @code{@@throw} statement may appear anywhere in an Objective-C or
1840 Objective-C++ program; when used inside of a @code{@@catch} block, the 
1841 @code{@@throw} may appear without an argument (as shown above), in which case 
1842 the object caught by the @code{@@catch} will be rethrown.
1843
1844 Note that only (pointers to) Objective-C objects may be thrown and
1845 caught using this scheme.  When an object is thrown, it will be caught
1846 by the nearest @code{@@catch} clause capable of handling objects of that type,
1847 analogously to how @code{catch} blocks work in C++ and Java.  A 
1848 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch 
1849 any and all Objective-C exceptions not caught by previous @code{@@catch}
1850 clauses (if any).
1851
1852 The @code{@@finally} clause, if present, will be executed upon exit from the
1853 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1854 regardless of whether any exceptions are thrown, caught or rethrown
1855 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1856 of the @code{finally} clause in Java.
1857
1858 There are several caveats to using the new exception mechanism:
1859
1860 @itemize @bullet
1861 @item
1862 Although currently designed to be binary compatible with @code{NS_HANDLER}-style 
1863 idioms provided by the @code{NSException} class, the new
1864 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1865 systems, due to additional functionality needed in the (NeXT) Objective-C
1866 runtime.
1867
1868 @item
1869 As mentioned above, the new exceptions do not support handling
1870 types other than Objective-C objects.   Furthermore, when used from 
1871 Objective-C++, the Objective-C exception model does not interoperate with C++
1872 exceptions at this time.  This means you cannot @code{@@throw} an exception
1873 from Objective-C and @code{catch} it in C++, or vice versa 
1874 (i.e., @code{throw @dots{} @@catch}).
1875 @end itemize
1876  
1877 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1878 blocks for thread-safe execution:
1879
1880 @smallexample
1881   @@synchronized (ObjCClass *guard) @{
1882     @dots{}
1883   @}
1884 @end smallexample
1885
1886 Upon entering the @code{@@synchronized} block, a thread of execution shall
1887 first check whether a lock has been placed on the corresponding @code{guard}
1888 object by another thread.  If it has, the current thread shall wait until
1889 the other thread relinquishes its lock.  Once @code{guard} becomes available, 
1890 the current thread will place its own lock on it, execute the code contained in
1891 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1892 making @code{guard} available to other threads).
1893
1894 Unlike Java, Objective-C does not allow for entire methods to be marked
1895 @code{@@synchronized}.  Note that throwing exceptions out of
1896 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1897 to be unlocked properly.
1898
1899 @item -freplace-objc-classes
1900 @opindex -freplace-objc-classes
1901 Emit a special marker instructing @command{ld(1)} not to statically link in
1902 the resulting object file, and allow @command{dyld(1)} to load it in at
1903 run time instead.  This is used in conjunction with the Fix-and-Continue
1904 debugging mode, where the object file in question may be recompiled and 
1905 dynamically reloaded in the course of program execution, without the need
1906 to restart the program itself.  Currently, Fix-and-Continue functionality
1907 is only available in conjunciton withthe NeXT runtime on Mac OS X 10.3 
1908 and later.
1909
1910 @item -fzero-link
1911 @opindex -fzero-link
1912 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1913 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1914 compile time) with static class references that get initialized at load time,
1915 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1916 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1917 to be retained.  This is useful in Zero-Link debugging mode, since it allows 
1918 for individual class implementations to be modified during program execution.
1919
1920 @item -gen-decls
1921 @opindex gen-decls
1922 Dump interface declarations for all classes seen in the source file to a
1923 file named @file{@var{sourcename}.decl}.
1924
1925 @item -Wno-protocol
1926 @opindex Wno-protocol
1927 If a class is declared to implement a protocol, a warning is issued for
1928 every method in the protocol that is not implemented by the class.  The
1929 default behavior is to issue a warning for every method not explicitly
1930 implemented in the class, even if a method implementation is inherited
1931 from the superclass.  If you use the @code{-Wno-protocol} option, then
1932 methods inherited from the superclass are considered to be implemented,
1933 and no warning is issued for them.
1934
1935 @item -Wselector
1936 @opindex Wselector
1937 Warn if multiple methods of different types for the same selector are
1938 found during compilation.  The check is performed on the list of methods
1939 in the final stage of compilation.  Additionally, a check is performed
1940 for each selector appearing in a @code{@@selector(@dots{})}
1941 expression, and a corresponding method for that selector has been found
1942 during compilation.  Because these checks scan the method table only at
1943 the end of compilation, these warnings are not produced if the final
1944 stage of compilation is not reached, for example because an error is
1945 found during compilation, or because the @code{-fsyntax-only} option is
1946 being used.
1947
1948 @item -Wundeclared-selector
1949 @opindex Wundeclared-selector
1950 Warn if a @code{@@selector(@dots{})} expression referring to an
1951 undeclared selector is found.  A selector is considered undeclared if no
1952 method with that name has been declared before the 
1953 @code{@@selector(@dots{})} expression, either explicitly in an
1954 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1955 an @code{@@implementation} section.  This option always performs its
1956 checks as soon as a @code{@@selector(@dots{})} expression is found,
1957 while @code{-Wselector} only performs its checks in the final stage of
1958 compilation.  This also enforces the coding style convention
1959 that methods and selectors must be declared before being used.
1960
1961 @c not documented because only avail via -Wp
1962 @c @item -print-objc-runtime-info
1963
1964 @end table
1965
1966 @node Language Independent Options
1967 @section Options to Control Diagnostic Messages Formatting
1968 @cindex options to control diagnostics formatting
1969 @cindex diagnostic messages
1970 @cindex message formatting
1971
1972 Traditionally, diagnostic messages have been formatted irrespective of
1973 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1974 below can be used to control the diagnostic messages formatting
1975 algorithm, e.g.@: how many characters per line, how often source location
1976 information should be reported.  Right now, only the C++ front end can
1977 honor these options.  However it is expected, in the near future, that
1978 the remaining front ends would be able to digest them correctly.
1979
1980 @table @gcctabopt
1981 @item -fmessage-length=@var{n}
1982 @opindex fmessage-length
1983 Try to format error messages so that they fit on lines of about @var{n}
1984 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1985 the front ends supported by GCC@.  If @var{n} is zero, then no
1986 line-wrapping will be done; each error message will appear on a single
1987 line.
1988
1989 @opindex fdiagnostics-show-location
1990 @item -fdiagnostics-show-location=once
1991 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1992 reporter to emit @emph{once} source location information; that is, in
1993 case the message is too long to fit on a single physical line and has to
1994 be wrapped, the source location won't be emitted (as prefix) again,
1995 over and over, in subsequent continuation lines.  This is the default
1996 behavior.
1997
1998 @item -fdiagnostics-show-location=every-line
1999 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2000 messages reporter to emit the same source location information (as
2001 prefix) for physical lines that result from the process of breaking
2002 a message which is too long to fit on a single line.
2003
2004 @end table
2005
2006 @node Warning Options
2007 @section Options to Request or Suppress Warnings
2008 @cindex options to control warnings
2009 @cindex warning messages
2010 @cindex messages, warning
2011 @cindex suppressing warnings
2012
2013 Warnings are diagnostic messages that report constructions which
2014 are not inherently erroneous but which are risky or suggest there
2015 may have been an error.
2016
2017 You can request many specific warnings with options beginning @samp{-W},
2018 for example @option{-Wimplicit} to request warnings on implicit
2019 declarations.  Each of these specific warning options also has a
2020 negative form beginning @samp{-Wno-} to turn off warnings;
2021 for example, @option{-Wno-implicit}.  This manual lists only one of the
2022 two forms, whichever is not the default.
2023
2024 The following options control the amount and kinds of warnings produced
2025 by GCC; for further, language-specific options also refer to
2026 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2027
2028 @table @gcctabopt
2029 @cindex syntax checking
2030 @item -fsyntax-only
2031 @opindex fsyntax-only
2032 Check the code for syntax errors, but don't do anything beyond that.
2033
2034 @item -pedantic
2035 @opindex pedantic
2036 Issue all the warnings demanded by strict ISO C and ISO C++;
2037 reject all programs that use forbidden extensions, and some other
2038 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2039 version of the ISO C standard specified by any @option{-std} option used.
2040
2041 Valid ISO C and ISO C++ programs should compile properly with or without
2042 this option (though a rare few will require @option{-ansi} or a
2043 @option{-std} option specifying the required version of ISO C)@.  However,
2044 without this option, certain GNU extensions and traditional C and C++
2045 features are supported as well.  With this option, they are rejected.
2046
2047 @option{-pedantic} does not cause warning messages for use of the
2048 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2049 warnings are also disabled in the expression that follows
2050 @code{__extension__}.  However, only system header files should use
2051 these escape routes; application programs should avoid them.
2052 @xref{Alternate Keywords}.
2053
2054 Some users try to use @option{-pedantic} to check programs for strict ISO
2055 C conformance.  They soon find that it does not do quite what they want:
2056 it finds some non-ISO practices, but not all---only those for which
2057 ISO C @emph{requires} a diagnostic, and some others for which
2058 diagnostics have been added.
2059
2060 A feature to report any failure to conform to ISO C might be useful in
2061 some instances, but would require considerable additional work and would
2062 be quite different from @option{-pedantic}.  We don't have plans to
2063 support such a feature in the near future.
2064
2065 Where the standard specified with @option{-std} represents a GNU
2066 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2067 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2068 extended dialect is based.  Warnings from @option{-pedantic} are given
2069 where they are required by the base standard.  (It would not make sense
2070 for such warnings to be given only for features not in the specified GNU
2071 C dialect, since by definition the GNU dialects of C include all
2072 features the compiler supports with the given option, and there would be
2073 nothing to warn about.)
2074
2075 @item -pedantic-errors
2076 @opindex pedantic-errors
2077 Like @option{-pedantic}, except that errors are produced rather than
2078 warnings.
2079
2080 @item -w
2081 @opindex w
2082 Inhibit all warning messages.
2083
2084 @item -Wno-import
2085 @opindex Wno-import
2086 Inhibit warning messages about the use of @samp{#import}.
2087
2088 @item -Wchar-subscripts
2089 @opindex Wchar-subscripts
2090 Warn if an array subscript has type @code{char}.  This is a common cause
2091 of error, as programmers often forget that this type is signed on some
2092 machines.
2093
2094 @item -Wcomment
2095 @opindex Wcomment
2096 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2097 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2098
2099 @item -Wformat
2100 @opindex Wformat
2101 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2102 the arguments supplied have types appropriate to the format string
2103 specified, and that the conversions specified in the format string make
2104 sense.  This includes standard functions, and others specified by format
2105 attributes (@pxref{Function Attributes}), in the @code{printf},
2106 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2107 not in the C standard) families.
2108
2109 The formats are checked against the format features supported by GNU
2110 libc version 2.2.  These include all ISO C90 and C99 features, as well
2111 as features from the Single Unix Specification and some BSD and GNU
2112 extensions.  Other library implementations may not support all these
2113 features; GCC does not support warning about features that go beyond a
2114 particular library's limitations.  However, if @option{-pedantic} is used
2115 with @option{-Wformat}, warnings will be given about format features not
2116 in the selected standard version (but not for @code{strfmon} formats,
2117 since those are not in any version of the C standard).  @xref{C Dialect
2118 Options,,Options Controlling C Dialect}.
2119
2120 Since @option{-Wformat} also checks for null format arguments for
2121 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2122
2123 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2124 aspects of format checking, the options @option{-Wno-format-y2k},
2125 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2126 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2127 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2128
2129 @item -Wno-format-y2k
2130 @opindex Wno-format-y2k
2131 If @option{-Wformat} is specified, do not warn about @code{strftime}
2132 formats which may yield only a two-digit year.
2133
2134 @item -Wno-format-extra-args
2135 @opindex Wno-format-extra-args
2136 If @option{-Wformat} is specified, do not warn about excess arguments to a
2137 @code{printf} or @code{scanf} format function.  The C standard specifies
2138 that such arguments are ignored.
2139
2140 Where the unused arguments lie between used arguments that are
2141 specified with @samp{$} operand number specifications, normally
2142 warnings are still given, since the implementation could not know what
2143 type to pass to @code{va_arg} to skip the unused arguments.  However,
2144 in the case of @code{scanf} formats, this option will suppress the
2145 warning if the unused arguments are all pointers, since the Single
2146 Unix Specification says that such unused arguments are allowed.
2147
2148 @item -Wno-format-zero-length
2149 @opindex Wno-format-zero-length
2150 If @option{-Wformat} is specified, do not warn about zero-length formats.
2151 The C standard specifies that zero-length formats are allowed.
2152
2153 @item -Wformat-nonliteral
2154 @opindex Wformat-nonliteral
2155 If @option{-Wformat} is specified, also warn if the format string is not a
2156 string literal and so cannot be checked, unless the format function
2157 takes its format arguments as a @code{va_list}.
2158
2159 @item -Wformat-security
2160 @opindex Wformat-security
2161 If @option{-Wformat} is specified, also warn about uses of format
2162 functions that represent possible security problems.  At present, this
2163 warns about calls to @code{printf} and @code{scanf} functions where the
2164 format string is not a string literal and there are no format arguments,
2165 as in @code{printf (foo);}.  This may be a security hole if the format
2166 string came from untrusted input and contains @samp{%n}.  (This is
2167 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2168 in future warnings may be added to @option{-Wformat-security} that are not
2169 included in @option{-Wformat-nonliteral}.)
2170
2171 @item -Wformat=2
2172 @opindex Wformat=2
2173 Enable @option{-Wformat} plus format checks not included in
2174 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2175 -Wformat-nonliteral -Wformat-security}.
2176
2177 @item -Wnonnull
2178 @opindex Wnonnull
2179 Warn about passing a null pointer for arguments marked as
2180 requiring a non-null value by the @code{nonnull} function attribute.
2181
2182 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2183 can be disabled with the @option{-Wno-nonnull} option.
2184
2185 @item -Winit-self @r{(C, C++, and Objective-C only)} 
2186 @opindex Winit-self
2187 Warn about uninitialized variables which are initialized with themselves.
2188 Note this option can only be used with the @option{-Wuninitialized} option,
2189 which in turn only works with @option{-O1} and above.
2190
2191 For example, GCC will warn about @code{i} being uninitialized in the
2192 following snippet only when @option{-Winit-self} has been specified:
2193 @smallexample
2194 @group
2195 int f()
2196 @{
2197   int i = i;
2198   return i;
2199 @}
2200 @end group
2201 @end smallexample
2202
2203 @item -Wimplicit-int
2204 @opindex Wimplicit-int
2205 Warn when a declaration does not specify a type.
2206
2207 @item -Wimplicit-function-declaration
2208 @itemx -Werror-implicit-function-declaration
2209 @opindex Wimplicit-function-declaration
2210 @opindex Werror-implicit-function-declaration
2211 Give a warning (or error) whenever a function is used before being
2212 declared.
2213
2214 @item -Wimplicit
2215 @opindex Wimplicit
2216 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2217
2218 @item -Wmain
2219 @opindex Wmain
2220 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2221 function with external linkage, returning int, taking either zero
2222 arguments, two, or three arguments of appropriate types.
2223
2224 @item -Wmissing-braces
2225 @opindex Wmissing-braces
2226 Warn if an aggregate or union initializer is not fully bracketed.  In
2227 the following example, the initializer for @samp{a} is not fully
2228 bracketed, but that for @samp{b} is fully bracketed.
2229
2230 @smallexample
2231 int a[2][2] = @{ 0, 1, 2, 3 @};
2232 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2233 @end smallexample
2234
2235 @item -Wparentheses
2236 @opindex Wparentheses
2237 Warn if parentheses are omitted in certain contexts, such
2238 as when there is an assignment in a context where a truth value
2239 is expected, or when operators are nested whose precedence people
2240 often get confused about.
2241
2242 Also warn about constructions where there may be confusion to which
2243 @code{if} statement an @code{else} branch belongs.  Here is an example of
2244 such a case:
2245
2246 @smallexample
2247 @group
2248 @{
2249   if (a)
2250     if (b)
2251       foo ();
2252   else
2253     bar ();
2254 @}
2255 @end group
2256 @end smallexample
2257
2258 In C, every @code{else} branch belongs to the innermost possible @code{if}
2259 statement, which in this example is @code{if (b)}.  This is often not
2260 what the programmer expected, as illustrated in the above example by
2261 indentation the programmer chose.  When there is the potential for this
2262 confusion, GCC will issue a warning when this flag is specified.
2263 To eliminate the warning, add explicit braces around the innermost
2264 @code{if} statement so there is no way the @code{else} could belong to
2265 the enclosing @code{if}.  The resulting code would look like this:
2266
2267 @smallexample
2268 @group
2269 @{
2270   if (a)
2271     @{
2272       if (b)
2273         foo ();
2274       else
2275         bar ();
2276     @}
2277 @}
2278 @end group
2279 @end smallexample
2280
2281 @item -Wsequence-point
2282 @opindex Wsequence-point
2283 Warn about code that may have undefined semantics because of violations
2284 of sequence point rules in the C standard.
2285
2286 The C standard defines the order in which expressions in a C program are
2287 evaluated in terms of @dfn{sequence points}, which represent a partial
2288 ordering between the execution of parts of the program: those executed
2289 before the sequence point, and those executed after it.  These occur
2290 after the evaluation of a full expression (one which is not part of a
2291 larger expression), after the evaluation of the first operand of a
2292 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2293 function is called (but after the evaluation of its arguments and the
2294 expression denoting the called function), and in certain other places.
2295 Other than as expressed by the sequence point rules, the order of
2296 evaluation of subexpressions of an expression is not specified.  All
2297 these rules describe only a partial order rather than a total order,
2298 since, for example, if two functions are called within one expression
2299 with no sequence point between them, the order in which the functions
2300 are called is not specified.  However, the standards committee have
2301 ruled that function calls do not overlap.
2302
2303 It is not specified when between sequence points modifications to the
2304 values of objects take effect.  Programs whose behavior depends on this
2305 have undefined behavior; the C standard specifies that ``Between the
2306 previous and next sequence point an object shall have its stored value
2307 modified at most once by the evaluation of an expression.  Furthermore,
2308 the prior value shall be read only to determine the value to be
2309 stored.''.  If a program breaks these rules, the results on any
2310 particular implementation are entirely unpredictable.
2311
2312 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2313 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2314 diagnosed by this option, and it may give an occasional false positive
2315 result, but in general it has been found fairly effective at detecting
2316 this sort of problem in programs.
2317
2318 The present implementation of this option only works for C programs.  A
2319 future implementation may also work for C++ programs.
2320
2321 The C standard is worded confusingly, therefore there is some debate
2322 over the precise meaning of the sequence point rules in subtle cases.
2323 Links to discussions of the problem, including proposed formal
2324 definitions, may be found on our readings page, at
2325 @w{@uref{http://gcc.gnu.org/readings.html}}.
2326
2327 @item -Wreturn-type
2328 @opindex Wreturn-type
2329 Warn whenever a function is defined with a return-type that defaults to
2330 @code{int}.  Also warn about any @code{return} statement with no
2331 return-value in a function whose return-type is not @code{void}.
2332
2333 For C++, a function without return type always produces a diagnostic
2334 message, even when @option{-Wno-return-type} is specified.  The only
2335 exceptions are @samp{main} and functions defined in system headers.
2336
2337 @item -Wswitch
2338 @opindex Wswitch
2339 Warn whenever a @code{switch} statement has an index of enumeral type
2340 and lacks a @code{case} for one or more of the named codes of that
2341 enumeration.  (The presence of a @code{default} label prevents this
2342 warning.)  @code{case} labels outside the enumeration range also
2343 provoke warnings when this option is used.
2344
2345 @item -Wswitch-default
2346 @opindex Wswitch-switch
2347 Warn whenever a @code{switch} statement does not have a @code{default}
2348 case.
2349
2350 @item -Wswitch-enum
2351 @opindex Wswitch-enum
2352 Warn whenever a @code{switch} statement has an index of enumeral type
2353 and lacks a @code{case} for one or more of the named codes of that
2354 enumeration.  @code{case} labels outside the enumeration range also
2355 provoke warnings when this option is used.
2356
2357 @item -Wtrigraphs
2358 @opindex Wtrigraphs
2359 Warn if any trigraphs are encountered that might change the meaning of
2360 the program (trigraphs within comments are not warned about).
2361
2362 @item -Wunused-function
2363 @opindex Wunused-function
2364 Warn whenever a static function is declared but not defined or a
2365 non\-inline static function is unused.
2366
2367 @item -Wunused-label
2368 @opindex Wunused-label
2369 Warn whenever a label is declared but not used.
2370
2371 To suppress this warning use the @samp{unused} attribute
2372 (@pxref{Variable Attributes}).
2373
2374 @item -Wunused-parameter
2375 @opindex Wunused-parameter
2376 Warn whenever a function parameter is unused aside from its declaration.
2377
2378 To suppress this warning use the @samp{unused} attribute
2379 (@pxref{Variable Attributes}).
2380
2381 @item -Wunused-variable
2382 @opindex Wunused-variable
2383 Warn whenever a local variable or non-constant static variable is unused
2384 aside from its declaration
2385
2386 To suppress this warning use the @samp{unused} attribute
2387 (@pxref{Variable Attributes}).
2388
2389 @item -Wunused-value
2390 @opindex Wunused-value
2391 Warn whenever a statement computes a result that is explicitly not used.
2392
2393 To suppress this warning cast the expression to @samp{void}.
2394
2395 @item -Wunused
2396 @opindex Wunused
2397 All the above @option{-Wunused} options combined.
2398
2399 In order to get a warning about an unused function parameter, you must
2400 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2401 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2402
2403 @item -Wuninitialized
2404 @opindex Wuninitialized
2405 Warn if an automatic variable is used without first being initialized or
2406 if a variable may be clobbered by a @code{setjmp} call.
2407
2408 These warnings are possible only in optimizing compilation,
2409 because they require data flow information that is computed only
2410 when optimizing.  If you don't specify @option{-O}, you simply won't
2411 get these warnings.
2412
2413 If you want to warn about code which uses the uninitialized value of the
2414 variable in its own initializer, use the @option{-Winit-self} option.
2415
2416 These warnings occur only for variables that are candidates for
2417 register allocation.  Therefore, they do not occur for a variable that
2418 is declared @code{volatile}, or whose address is taken, or whose size
2419 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2420 structures, unions or arrays, even when they are in registers.
2421
2422 Note that there may be no warning about a variable that is used only
2423 to compute a value that itself is never used, because such
2424 computations may be deleted by data flow analysis before the warnings
2425 are printed.
2426
2427 These warnings are made optional because GCC is not smart
2428 enough to see all the reasons why the code might be correct
2429 despite appearing to have an error.  Here is one example of how
2430 this can happen:
2431
2432 @smallexample
2433 @group
2434 @{
2435   int x;
2436   switch (y)
2437     @{
2438     case 1: x = 1;
2439       break;
2440     case 2: x = 4;
2441       break;
2442     case 3: x = 5;
2443     @}
2444   foo (x);
2445 @}
2446 @end group
2447 @end smallexample
2448
2449 @noindent
2450 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2451 always initialized, but GCC doesn't know this.  Here is
2452 another common case:
2453
2454 @smallexample
2455 @{
2456   int save_y;
2457   if (change_y) save_y = y, y = new_y;
2458   @dots{}
2459   if (change_y) y = save_y;
2460 @}
2461 @end smallexample
2462
2463 @noindent
2464 This has no bug because @code{save_y} is used only if it is set.
2465
2466 @cindex @code{longjmp} warnings
2467 This option also warns when a non-volatile automatic variable might be
2468 changed by a call to @code{longjmp}.  These warnings as well are possible
2469 only in optimizing compilation.
2470
2471 The compiler sees only the calls to @code{setjmp}.  It cannot know
2472 where @code{longjmp} will be called; in fact, a signal handler could
2473 call it at any point in the code.  As a result, you may get a warning
2474 even when there is in fact no problem because @code{longjmp} cannot
2475 in fact be called at the place which would cause a problem.
2476
2477 Some spurious warnings can be avoided if you declare all the functions
2478 you use that never return as @code{noreturn}.  @xref{Function
2479 Attributes}.
2480
2481 @item -Wunknown-pragmas
2482 @opindex Wunknown-pragmas
2483 @cindex warning for unknown pragmas
2484 @cindex unknown pragmas, warning
2485 @cindex pragmas, warning of unknown
2486 Warn when a #pragma directive is encountered which is not understood by
2487 GCC@.  If this command line option is used, warnings will even be issued
2488 for unknown pragmas in system header files.  This is not the case if
2489 the warnings were only enabled by the @option{-Wall} command line option.
2490
2491 @item -Wstrict-aliasing
2492 @opindex Wstrict-aliasing
2493 This option is only active when @option{-fstrict-aliasing} is active.
2494 It warns about code which might break the strict aliasing rules that the
2495 compiler is using for optimization. The warning does not catch all
2496 cases, but does attempt to catch the more common pitfalls. It is
2497 included in @option{-Wall}.
2498
2499 @item -Wall
2500 @opindex Wall
2501 All of the above @samp{-W} options combined.  This enables all the
2502 warnings about constructions that some users consider questionable, and
2503 that are easy to avoid (or modify to prevent the warning), even in
2504 conjunction with macros.  This also enables some language-specific
2505 warnings described in @ref{C++ Dialect Options} and
2506 @ref{Objective-C Dialect Options}.
2507 @end table
2508
2509 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2510 Some of them warn about constructions that users generally do not
2511 consider questionable, but which occasionally you might wish to check
2512 for; others warn about constructions that are necessary or hard to avoid
2513 in some cases, and there is no simple way to modify the code to suppress
2514 the warning.
2515
2516 @table @gcctabopt
2517 @item -Wextra
2518 @opindex W
2519 @opindex Wextra
2520 (This option used to be called @option{-W}.  The older name is still
2521 supported, but the newer name is more descriptive.)  Print extra warning
2522 messages for these events:
2523
2524 @itemize @bullet
2525 @item
2526 A function can return either with or without a value.  (Falling
2527 off the end of the function body is considered returning without
2528 a value.)  For example, this function would evoke such a
2529 warning:
2530
2531 @smallexample
2532 @group
2533 foo (a)
2534 @{
2535   if (a > 0)
2536     return a;
2537 @}
2538 @end group
2539 @end smallexample
2540
2541 @item
2542 An expression-statement or the left-hand side of a comma expression
2543 contains no side effects.
2544 To suppress the warning, cast the unused expression to void.
2545 For example, an expression such as @samp{x[i,j]} will cause a warning,
2546 but @samp{x[(void)i,j]} will not.
2547
2548 @item
2549 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2550
2551 @item
2552 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2553 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2554 that of ordinary mathematical notation.
2555
2556 @item
2557 Storage-class specifiers like @code{static} are not the first things in
2558 a declaration.  According to the C Standard, this usage is obsolescent.
2559
2560 @item
2561 The return type of a function has a type qualifier such as @code{const}.
2562 Such a type qualifier has no effect, since the value returned by a
2563 function is not an lvalue.  (But don't warn about the GNU extension of
2564 @code{volatile void} return types.  That extension will be warned about
2565 if @option{-pedantic} is specified.)
2566
2567 @item
2568 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2569 arguments.
2570
2571 @item
2572 A comparison between signed and unsigned values could produce an
2573 incorrect result when the signed value is converted to unsigned.
2574 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2575
2576 @item
2577 An aggregate has an initializer which does not initialize all members.
2578 For example, the following code would cause such a warning, because
2579 @code{x.h} would be implicitly initialized to zero:
2580
2581 @smallexample
2582 struct s @{ int f, g, h; @};
2583 struct s x = @{ 3, 4 @};
2584 @end smallexample
2585
2586 @item
2587 A function parameter is declared without a type specifier in K&R-style
2588 functions:
2589
2590 @smallexample
2591 void foo(bar) @{ @}
2592 @end smallexample
2593
2594 @item
2595 An empty body occurs in an @samp{if} or @samp{else} statement.
2596
2597 @item
2598 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2599 @samp{>}, or @samp{>=}.
2600
2601 @item
2602 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2603
2604 @item
2605 Any of several floating-point events that often indicate errors, such as
2606 overflow, underflow, loss of precision, etc.
2607
2608 @item @r{(C++ only)}
2609 An enumerator and a non-enumerator both appear in a conditional expression.
2610
2611 @item @r{(C++ only)}
2612 A non-static reference or non-static @samp{const} member appears in a
2613 class without constructors.
2614
2615 @item @r{(C++ only)}
2616 Ambiguous virtual bases.
2617
2618 @item @r{(C++ only)}
2619 Subscripting an array which has been declared @samp{register}.
2620
2621 @item @r{(C++ only)}
2622 Taking the address of a variable which has been declared @samp{register}.
2623
2624 @item @r{(C++ only)}
2625 A base class is not initialized in a derived class' copy constructor.
2626 @end itemize
2627
2628 @item -Wno-div-by-zero
2629 @opindex Wno-div-by-zero
2630 @opindex Wdiv-by-zero
2631 Do not warn about compile-time integer division by zero.  Floating point
2632 division by zero is not warned about, as it can be a legitimate way of
2633 obtaining infinities and NaNs.
2634
2635 @item -Wsystem-headers
2636 @opindex Wsystem-headers
2637 @cindex warnings from system headers
2638 @cindex system headers, warnings from
2639 Print warning messages for constructs found in system header files.
2640 Warnings from system headers are normally suppressed, on the assumption
2641 that they usually do not indicate real problems and would only make the
2642 compiler output harder to read.  Using this command line option tells
2643 GCC to emit warnings from system headers as if they occurred in user
2644 code.  However, note that using @option{-Wall} in conjunction with this
2645 option will @emph{not} warn about unknown pragmas in system
2646 headers---for that, @option{-Wunknown-pragmas} must also be used.
2647
2648 @item -Wfloat-equal
2649 @opindex Wfloat-equal
2650 Warn if floating point values are used in equality comparisons.
2651
2652 The idea behind this is that sometimes it is convenient (for the
2653 programmer) to consider floating-point values as approximations to
2654 infinitely precise real numbers.  If you are doing this, then you need
2655 to compute (by analyzing the code, or in some other way) the maximum or
2656 likely maximum error that the computation introduces, and allow for it
2657 when performing comparisons (and when producing output, but that's a
2658 different problem).  In particular, instead of testing for equality, you
2659 would check to see whether the two values have ranges that overlap; and
2660 this is done with the relational operators, so equality comparisons are
2661 probably mistaken.
2662
2663 @item -Wtraditional @r{(C only)}
2664 @opindex Wtraditional
2665 Warn about certain constructs that behave differently in traditional and
2666 ISO C@.  Also warn about ISO C constructs that have no traditional C
2667 equivalent, and/or problematic constructs which should be avoided.
2668
2669 @itemize @bullet
2670 @item
2671 Macro parameters that appear within string literals in the macro body.
2672 In traditional C macro replacement takes place within string literals,
2673 but does not in ISO C@.
2674
2675 @item
2676 In traditional C, some preprocessor directives did not exist.
2677 Traditional preprocessors would only consider a line to be a directive
2678 if the @samp{#} appeared in column 1 on the line.  Therefore
2679 @option{-Wtraditional} warns about directives that traditional C
2680 understands but would ignore because the @samp{#} does not appear as the
2681 first character on the line.  It also suggests you hide directives like
2682 @samp{#pragma} not understood by traditional C by indenting them.  Some
2683 traditional implementations would not recognize @samp{#elif}, so it
2684 suggests avoiding it altogether.
2685
2686 @item
2687 A function-like macro that appears without arguments.
2688
2689 @item
2690 The unary plus operator.
2691
2692 @item
2693 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2694 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2695 constants.)  Note, these suffixes appear in macros defined in the system
2696 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2697 Use of these macros in user code might normally lead to spurious
2698 warnings, however gcc's integrated preprocessor has enough context to
2699 avoid warning in these cases.
2700
2701 @item
2702 A function declared external in one block and then used after the end of
2703 the block.
2704
2705 @item
2706 A @code{switch} statement has an operand of type @code{long}.
2707
2708 @item
2709 A non-@code{static} function declaration follows a @code{static} one.
2710 This construct is not accepted by some traditional C compilers.
2711
2712 @item
2713 The ISO type of an integer constant has a different width or
2714 signedness from its traditional type.  This warning is only issued if
2715 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2716 typically represent bit patterns, are not warned about.
2717
2718 @item
2719 Usage of ISO string concatenation is detected.
2720
2721 @item
2722 Initialization of automatic aggregates.
2723
2724 @item
2725 Identifier conflicts with labels.  Traditional C lacks a separate
2726 namespace for labels.
2727
2728 @item
2729 Initialization of unions.  If the initializer is zero, the warning is
2730 omitted.  This is done under the assumption that the zero initializer in
2731 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2732 initializer warnings and relies on default initialization to zero in the
2733 traditional C case.
2734
2735 @item
2736 Conversions by prototypes between fixed/floating point values and vice
2737 versa.  The absence of these prototypes when compiling with traditional
2738 C would cause serious problems.  This is a subset of the possible
2739 conversion warnings, for the full set use @option{-Wconversion}.
2740
2741 @item
2742 Use of ISO C style function definitions.  This warning intentionally is
2743 @emph{not} issued for prototype declarations or variadic functions
2744 because these ISO C features will appear in your code when using
2745 libiberty's traditional C compatibility macros, @code{PARAMS} and
2746 @code{VPARAMS}.  This warning is also bypassed for nested functions
2747 because that feature is already a gcc extension and thus not relevant to
2748 traditional C compatibility.
2749 @end itemize
2750
2751 @item -Wdeclaration-after-statement @r{(C only)}
2752 @opindex Wdeclaration-after-statement
2753 Warn when a declaration is found after a statement in a block.  This
2754 construct, known from C++, was introduced with ISO C99 and is by default
2755 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2756 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2757
2758 @item -Wundef
2759 @opindex Wundef
2760 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2761
2762 @item -Wendif-labels
2763 @opindex Wendif-labels
2764 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2765
2766 @item -Wshadow
2767 @opindex Wshadow
2768 Warn whenever a local variable shadows another local variable, parameter or
2769 global variable or whenever a built-in function is shadowed.
2770
2771 @item -Wlarger-than-@var{len}
2772 @opindex Wlarger-than
2773 Warn whenever an object of larger than @var{len} bytes is defined.
2774
2775 @item -Wpointer-arith
2776 @opindex Wpointer-arith
2777 Warn about anything that depends on the ``size of'' a function type or
2778 of @code{void}.  GNU C assigns these types a size of 1, for
2779 convenience in calculations with @code{void *} pointers and pointers
2780 to functions.
2781
2782 @item -Wbad-function-cast @r{(C only)}
2783 @opindex Wbad-function-cast
2784 Warn whenever a function call is cast to a non-matching type.
2785 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2786
2787 @item -Wcast-qual
2788 @opindex Wcast-qual
2789 Warn whenever a pointer is cast so as to remove a type qualifier from
2790 the target type.  For example, warn if a @code{const char *} is cast
2791 to an ordinary @code{char *}.
2792
2793 @item -Wcast-align
2794 @opindex Wcast-align
2795 Warn whenever a pointer is cast such that the required alignment of the
2796 target is increased.  For example, warn if a @code{char *} is cast to
2797 an @code{int *} on machines where integers can only be accessed at
2798 two- or four-byte boundaries.
2799
2800 @item -Wwrite-strings
2801 @opindex Wwrite-strings
2802 When compiling C, give string constants the type @code{const
2803 char[@var{length}]} so that
2804 copying the address of one into a non-@code{const} @code{char *}
2805 pointer will get a warning; when compiling C++, warn about the
2806 deprecated conversion from string constants to @code{char *}.
2807 These warnings will help you find at
2808 compile time code that can try to write into a string constant, but
2809 only if you have been very careful about using @code{const} in
2810 declarations and prototypes.  Otherwise, it will just be a nuisance;
2811 this is why we did not make @option{-Wall} request these warnings.
2812
2813 @item -Wconversion
2814 @opindex Wconversion
2815 Warn if a prototype causes a type conversion that is different from what
2816 would happen to the same argument in the absence of a prototype.  This
2817 includes conversions of fixed point to floating and vice versa, and
2818 conversions changing the width or signedness of a fixed point argument
2819 except when the same as the default promotion.
2820
2821 Also, warn if a negative integer constant expression is implicitly
2822 converted to an unsigned type.  For example, warn about the assignment
2823 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2824 casts like @code{(unsigned) -1}.
2825
2826 @item -Wsign-compare
2827 @opindex Wsign-compare
2828 @cindex warning for comparison of signed and unsigned values
2829 @cindex comparison of signed and unsigned values, warning
2830 @cindex signed and unsigned values, comparison warning
2831 Warn when a comparison between signed and unsigned values could produce
2832 an incorrect result when the signed value is converted to unsigned.
2833 This warning is also enabled by @option{-Wextra}; to get the other warnings
2834 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2835
2836 @item -Waggregate-return
2837 @opindex Waggregate-return
2838 Warn if any functions that return structures or unions are defined or
2839 called.  (In languages where you can return an array, this also elicits
2840 a warning.)
2841
2842 @item -Wstrict-prototypes @r{(C only)}
2843 @opindex Wstrict-prototypes
2844 Warn if a function is declared or defined without specifying the
2845 argument types.  (An old-style function definition is permitted without
2846 a warning if preceded by a declaration which specifies the argument
2847 types.)
2848
2849 @item -Wold-style-definition @r{(C only)}
2850 @opindex Wold-style-definition
2851 Warn if an old-style function definition is used.  A warning is given
2852 even if there is a previous prototype.
2853
2854 @item -Wmissing-prototypes @r{(C only)}
2855 @opindex Wmissing-prototypes
2856 Warn if a global function is defined without a previous prototype
2857 declaration.  This warning is issued even if the definition itself
2858 provides a prototype.  The aim is to detect global functions that fail
2859 to be declared in header files.
2860
2861 @item -Wmissing-declarations @r{(C only)}
2862 @opindex Wmissing-declarations
2863 Warn if a global function is defined without a previous declaration.
2864 Do so even if the definition itself provides a prototype.
2865 Use this option to detect global functions that are not declared in
2866 header files.
2867
2868 @item -Wmissing-noreturn
2869 @opindex Wmissing-noreturn
2870 Warn about functions which might be candidates for attribute @code{noreturn}.
2871 Note these are only possible candidates, not absolute ones.  Care should
2872 be taken to manually verify functions actually do not ever return before
2873 adding the @code{noreturn} attribute, otherwise subtle code generation
2874 bugs could be introduced.  You will not get a warning for @code{main} in
2875 hosted C environments.
2876
2877 @item -Wmissing-format-attribute
2878 @opindex Wmissing-format-attribute
2879 @opindex Wformat
2880 If @option{-Wformat} is enabled, also warn about functions which might be
2881 candidates for @code{format} attributes.  Note these are only possible
2882 candidates, not absolute ones.  GCC will guess that @code{format}
2883 attributes might be appropriate for any function that calls a function
2884 like @code{vprintf} or @code{vscanf}, but this might not always be the
2885 case, and some functions for which @code{format} attributes are
2886 appropriate may not be detected.  This option has no effect unless
2887 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2888
2889 @item -Wno-multichar
2890 @opindex Wno-multichar
2891 @opindex Wmultichar
2892 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2893 Usually they indicate a typo in the user's code, as they have
2894 implementation-defined values, and should not be used in portable code.
2895
2896 @item -Wno-deprecated-declarations
2897 @opindex Wno-deprecated-declarations
2898 Do not warn about uses of functions, variables, and types marked as
2899 deprecated by using the @code{deprecated} attribute.
2900 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2901 @pxref{Type Attributes}.)
2902
2903 @item -Wpacked
2904 @opindex Wpacked
2905 Warn if a structure is given the packed attribute, but the packed
2906 attribute has no effect on the layout or size of the structure.
2907 Such structures may be mis-aligned for little benefit.  For
2908 instance, in this code, the variable @code{f.x} in @code{struct bar}
2909 will be misaligned even though @code{struct bar} does not itself
2910 have the packed attribute:
2911
2912 @smallexample
2913 @group
2914 struct foo @{
2915   int x;
2916   char a, b, c, d;
2917 @} __attribute__((packed));
2918 struct bar @{
2919   char z;
2920   struct foo f;
2921 @};
2922 @end group
2923 @end smallexample
2924
2925 @item -Wpadded
2926 @opindex Wpadded
2927 Warn if padding is included in a structure, either to align an element
2928 of the structure or to align the whole structure.  Sometimes when this
2929 happens it is possible to rearrange the fields of the structure to
2930 reduce the padding and so make the structure smaller.
2931
2932 @item -Wredundant-decls
2933 @opindex Wredundant-decls
2934 Warn if anything is declared more than once in the same scope, even in
2935 cases where multiple declaration is valid and changes nothing.
2936
2937 @item -Wnested-externs @r{(C only)}
2938 @opindex Wnested-externs
2939 Warn if an @code{extern} declaration is encountered within a function.
2940
2941 @item -Wunreachable-code
2942 @opindex Wunreachable-code
2943 Warn if the compiler detects that code will never be executed.
2944
2945 This option is intended to warn when the compiler detects that at
2946 least a whole line of source code will never be executed, because
2947 some condition is never satisfied or because it is after a
2948 procedure that never returns.
2949
2950 It is possible for this option to produce a warning even though there
2951 are circumstances under which part of the affected line can be executed,
2952 so care should be taken when removing apparently-unreachable code.
2953
2954 For instance, when a function is inlined, a warning may mean that the
2955 line is unreachable in only one inlined copy of the function.
2956
2957 This option is not made part of @option{-Wall} because in a debugging
2958 version of a program there is often substantial code which checks
2959 correct functioning of the program and is, hopefully, unreachable
2960 because the program does work.  Another common use of unreachable
2961 code is to provide behavior which is selectable at compile-time.
2962
2963 @item -Winline
2964 @opindex Winline
2965 Warn if a function can not be inlined and it was declared as inline.
2966 Even with this option, the compiler will not warn about failures to
2967 inline functions declared in system headers.  
2968
2969 The compiler uses a variety of heuristics to determine whether or not
2970 to inline a function.  For example, the compiler takes into account
2971 the size of the function being inlined and the the amount of inlining
2972 that has already been done in the current function.  Therefore,
2973 seemingly insignificant changes in the source program can cause the
2974 warnings produced by @option{-Winline} to appear or disappear.
2975
2976 @item -Wno-invalid-offsetof @r{(C++ only)}
2977 @opindex Wno-invalid-offsetof
2978 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2979 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2980 to a non-POD type is undefined.  In existing C++ implementations,
2981 however, @samp{offsetof} typically gives meaningful results even when
2982 applied to certain kinds of non-POD types. (Such as a simple
2983 @samp{struct} that fails to be a POD type only by virtue of having a
2984 constructor.)  This flag is for users who are aware that they are
2985 writing nonportable code and who have deliberately chosen to ignore the
2986 warning about it.
2987
2988 The restrictions on @samp{offsetof} may be relaxed in a future version
2989 of the C++ standard.
2990
2991 @item -Winvalid-pch
2992 @opindex Winvalid-pch
2993 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2994 the search path but can't be used.
2995
2996 @item -Wlong-long
2997 @opindex Wlong-long
2998 @opindex Wno-long-long
2999 Warn if @samp{long long} type is used.  This is default.  To inhibit
3000 the warning messages, use @option{-Wno-long-long}.  Flags
3001 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3002 only when @option{-pedantic} flag is used.
3003
3004 @item -Wdisabled-optimization
3005 @opindex Wdisabled-optimization
3006 Warn if a requested optimization pass is disabled.  This warning does
3007 not generally indicate that there is anything wrong with your code; it
3008 merely indicates that GCC's optimizers were unable to handle the code
3009 effectively.  Often, the problem is that your code is too big or too
3010 complex; GCC will refuse to optimize programs when the optimization
3011 itself is likely to take inordinate amounts of time.
3012
3013 @item -Werror
3014 @opindex Werror
3015 Make all warnings into errors.
3016 @end table
3017
3018 @node Debugging Options
3019 @section Options for Debugging Your Program or GCC
3020 @cindex options, debugging
3021 @cindex debugging information options
3022
3023 GCC has various special options that are used for debugging
3024 either your program or GCC:
3025
3026 @table @gcctabopt
3027 @item -g
3028 @opindex g
3029 Produce debugging information in the operating system's native format
3030 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3031 information.
3032
3033 On most systems that use stabs format, @option{-g} enables use of extra
3034 debugging information that only GDB can use; this extra information
3035 makes debugging work better in GDB but will probably make other debuggers
3036 crash or
3037 refuse to read the program.  If you want to control for certain whether
3038 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3039 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
3040 or @option{-gvms} (see below).
3041
3042 Unlike most other C compilers, GCC allows you to use @option{-g} with
3043 @option{-O}.  The shortcuts taken by optimized code may occasionally
3044 produce surprising results: some variables you declared may not exist
3045 at all; flow of control may briefly move where you did not expect it;
3046 some statements may not be executed because they compute constant
3047 results or their values were already at hand; some statements may
3048 execute in different places because they were moved out of loops.
3049
3050 Nevertheless it proves possible to debug optimized output.  This makes
3051 it reasonable to use the optimizer for programs that might have bugs.
3052
3053 The following options are useful when GCC is generated with the
3054 capability for more than one debugging format.
3055
3056 @item -ggdb
3057 @opindex ggdb
3058 Produce debugging information for use by GDB@.  This means to use the
3059 most expressive format available (DWARF 2, stabs, or the native format
3060 if neither of those are supported), including GDB extensions if at all
3061 possible.
3062
3063 @item -gstabs
3064 @opindex gstabs
3065 Produce debugging information in stabs format (if that is supported),
3066 without GDB extensions.  This is the format used by DBX on most BSD
3067 systems.  On MIPS, Alpha and System V Release 4 systems this option
3068 produces stabs debugging output which is not understood by DBX or SDB@.
3069 On System V Release 4 systems this option requires the GNU assembler.
3070
3071 @item -feliminate-unused-debug-symbols
3072 @opindex feliminate-unused-debug-symbols
3073 Produce debugging information in stabs format (if that is supported),
3074 for only symbols that are actually used.
3075
3076 @item -gstabs+
3077 @opindex gstabs+
3078 Produce debugging information in stabs format (if that is supported),
3079 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3080 use of these extensions is likely to make other debuggers crash or
3081 refuse to read the program.
3082
3083 @item -gcoff
3084 @opindex gcoff
3085 Produce debugging information in COFF format (if that is supported).
3086 This is the format used by SDB on most System V systems prior to
3087 System V Release 4.
3088
3089 @item -gxcoff
3090 @opindex gxcoff
3091 Produce debugging information in XCOFF format (if that is supported).
3092 This is the format used by the DBX debugger on IBM RS/6000 systems.
3093
3094 @item -gxcoff+
3095 @opindex gxcoff+
3096 Produce debugging information in XCOFF format (if that is supported),
3097 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3098 use of these extensions is likely to make other debuggers crash or
3099 refuse to read the program, and may cause assemblers other than the GNU
3100 assembler (GAS) to fail with an error.
3101
3102 @item -gdwarf
3103 @opindex gdwarf
3104 Produce debugging information in DWARF version 1 format (if that is
3105 supported).  This is the format used by SDB on most System V Release 4
3106 systems.
3107
3108 This option is deprecated.
3109
3110 @item -gdwarf+
3111 @opindex gdwarf+
3112 Produce debugging information in DWARF version 1 format (if that is
3113 supported), using GNU extensions understood only by the GNU debugger
3114 (GDB)@.  The use of these extensions is likely to make other debuggers
3115 crash or refuse to read the program.
3116
3117 This option is deprecated.
3118
3119 @item -gdwarf-2
3120 @opindex gdwarf-2
3121 Produce debugging information in DWARF version 2 format (if that is
3122 supported).  This is the format used by DBX on IRIX 6.
3123
3124 @item -gvms
3125 @opindex gvms
3126 Produce debugging information in VMS debug format (if that is
3127 supported).  This is the format used by DEBUG on VMS systems.
3128
3129 @item -g@var{level}
3130 @itemx -ggdb@var{level}
3131 @itemx -gstabs@var{level}
3132 @itemx -gcoff@var{level}
3133 @itemx -gxcoff@var{level}
3134 @itemx -gvms@var{level}
3135 Request debugging information and also use @var{level} to specify how
3136 much information.  The default level is 2.
3137
3138 Level 1 produces minimal information, enough for making backtraces in
3139 parts of the program that you don't plan to debug.  This includes
3140 descriptions of functions and external variables, but no information
3141 about local variables and no line numbers.
3142
3143 Level 3 includes extra information, such as all the macro definitions
3144 present in the program.  Some debuggers support macro expansion when
3145 you use @option{-g3}.
3146
3147 Note that in order to avoid confusion between DWARF1 debug level 2,
3148 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
3149 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
3150 option to change the debug level for DWARF1 or DWARF2.
3151
3152 @item -feliminate-dwarf2-dups
3153 @opindex feliminate-dwarf2-dups
3154 Compress DWARF2 debugging information by eliminating duplicated
3155 information about each symbol.  This option only makes sense when
3156 generating DWARF2 debugging information with @option{-gdwarf-2}.
3157
3158 @cindex @command{prof}
3159 @item -p
3160 @opindex p
3161 Generate extra code to write profile information suitable for the
3162 analysis program @command{prof}.  You must use this option when compiling
3163 the source files you want data about, and you must also use it when
3164 linking.
3165
3166 @cindex @command{gprof}
3167 @item -pg
3168 @opindex pg
3169 Generate extra code to write profile information suitable for the
3170 analysis program @command{gprof}.  You must use this option when compiling
3171 the source files you want data about, and you must also use it when
3172 linking.
3173
3174 @item -Q
3175 @opindex Q
3176 Makes the compiler print out each function name as it is compiled, and
3177 print some statistics about each pass when it finishes.
3178
3179 @item -ftime-report
3180 @opindex ftime-report
3181 Makes the compiler print some statistics about the time consumed by each
3182 pass when it finishes.
3183
3184 @item -fmem-report
3185 @opindex fmem-report
3186 Makes the compiler print some statistics about permanent memory
3187 allocation when it finishes.
3188
3189 @item -fprofile-arcs
3190 @opindex fprofile-arcs
3191 Add code so that program flow @dfn{arcs} are instrumented.  During
3192 execution the program records how many times each branch and call is
3193 executed and how many times it is taken or returns.  When the compiled
3194 program exits it saves this data to a file called
3195 @file{@var{auxname}.gcda} for each source file. The data may be used for
3196 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3197 test coverage analysis (@option{-ftest-coverage}). Each object file's
3198 @var{auxname} is generated from the name of the output file, if
3199 explicitly specified and it is not the final executable, otherwise it is
3200 the basename of the source file. In both cases any suffix is removed
3201 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3202 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3203
3204 @itemize
3205
3206 @item
3207 Compile the source files with @option{-fprofile-arcs} plus optimization
3208 and code generation options. For test coverage analysis, use the
3209 additional @option{-ftest-coverage} option. You do not need to profile
3210 every source file in a program.
3211
3212 @item
3213 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3214 (the latter implies the former).
3215
3216 @item
3217 Run the program on a representative workload to generate the arc profile
3218 information. This may be repeated any number of times. You can run
3219 concurrent instances of your program, and provided that the file system
3220 supports locking, the data files will be correctly updated. Also
3221 @code{fork} calls are detected and correctly handled (double counting
3222 will not happen).
3223
3224 @item
3225 For profile-directed optimizations, compile the source files again with
3226 the same optimization and code generation options plus
3227 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3228 Control Optimization}).
3229
3230 @item
3231 For test coverage analysis, use @command{gcov} to produce human readable
3232 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3233 @command{gcov} documentation for further information.
3234
3235 @end itemize
3236
3237 With @option{-fprofile-arcs}, for each function of your program GCC
3238 creates a program flow graph, then finds a spanning tree for the graph.
3239 Only arcs that are not on the spanning tree have to be instrumented: the
3240 compiler adds code to count the number of times that these arcs are
3241 executed.  When an arc is the only exit or only entrance to a block, the
3242 instrumentation code can be added to the block; otherwise, a new basic
3243 block must be created to hold the instrumentation code.
3244
3245 @need 2000
3246 @item -ftest-coverage
3247 @opindex ftest-coverage
3248 Produce a notes file that the @command{gcov} code-coverage utility
3249 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3250 show program coverage. Each source file's note file is called
3251 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3252 above for a description of @var{auxname} and instructions on how to
3253 generate test coverage data. Coverage data will match the source files
3254 more closely, if you do not optimize.
3255
3256 @item -d@var{letters}
3257 @opindex d
3258 Says to make debugging dumps during compilation at times specified by
3259 @var{letters}.  This is used for debugging the compiler.  The file names
3260 for most of the dumps are made by appending a pass number and a word to
3261 the @var{dumpname}. @var{dumpname} is generated from the name of the
3262 output file, if explicitly specified and it is not an executable,
3263 otherwise it is the basename of the source file. In both cases any
3264 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3265 Here are the possible letters for use in @var{letters}, and their
3266 meanings:
3267
3268 @table @samp
3269 @item A
3270 @opindex dA
3271 Annotate the assembler output with miscellaneous debugging information.
3272 @item b
3273 @opindex db
3274 Dump after computing branch probabilities, to @file{@var{file}.16.bp}.
3275 @item B
3276 @opindex dB
3277 Dump after block reordering, to @file{@var{file}.32.bbro}.
3278 @item c
3279 @opindex dc
3280 Dump after instruction combination, to the file @file{@var{file}.22.combine}.
3281 @item C
3282 @opindex dC
3283 Dump after the first if conversion, to the file @file{@var{file}.17.ce1}.
3284 Also dump after the second if conversion, to the file @file{@var{file}.23.ce2}.
3285 @item d
3286 @opindex dd
3287 Dump after branch target load optimization, to to @file{@var{file}.34.btl}.
3288 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3289 @item D
3290 @opindex dD
3291 Dump all macro definitions, at the end of preprocessing, in addition to
3292 normal output.
3293 @item e
3294 @opindex de
3295 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
3296 @file{@var{file}.010.ussa}.
3297 @item E
3298 @opindex dE
3299 Dump after the second if conversion, to @file{@var{file}.33.ce3}.
3300 @item f
3301 @opindex df
3302 Dump after control and data flow analysis, to @file{@var{file}.15.cfg}.
3303 Also dump after life analysis, to @file{@var{file}.21.life}.
3304 @item F
3305 @opindex dF
3306 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.11.addressof}.
3307 @item g
3308 @opindex dg
3309 Dump after global register allocation, to @file{@var{file}.27.greg}.
3310 @item G
3311 @opindex dG
3312 Dump after GCSE, to @file{@var{file}.12.gcse}.
3313 Also dump after jump bypassing and control flow optimizations, to
3314 @file{@var{file}.14.bypass}.
3315 @item h
3316 @opindex dh
3317 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3318 @item i
3319 @opindex di
3320 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3321 @item j
3322 @opindex dj
3323 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3324 @item k
3325 @opindex dk
3326 Dump after conversion from registers to stack, to @file{@var{file}.36.stack}.
3327 @item l
3328 @opindex dl
3329 Dump after local register allocation, to @file{@var{file}.26.lreg}.
3330 @item L
3331 @opindex dL
3332 Dump after loop optimization passes, to @file{@var{file}.13.loop} and
3333 @file{@var{file}.19.loop2}.
3334 @item M
3335 @opindex dM
3336 Dump after performing the machine dependent reorganization pass, to
3337 @file{@var{file}.37.mach}.
3338 @item n
3339 @opindex dn
3340 Dump after register renumbering, to @file{@var{file}.31.rnreg}.
3341 @item N
3342 @opindex dN
3343 Dump after the register move pass, to @file{@var{file}.24.regmove}.
3344 @item o
3345 @opindex do
3346 Dump after post-reload optimizations, to @file{@var{file}.28.postreload}.
3347 @item r
3348 @opindex dr
3349 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3350 @item R
3351 @opindex dR
3352 Dump after the second scheduling pass, to @file{@var{file}.35.sched2}.
3353 @item s
3354 @opindex ds
3355 Dump after CSE (including the jump optimization that sometimes follows
3356 CSE), to @file{@var{file}.019.cse}.
3357 @item S
3358 @opindex dS
3359 Dump after the first scheduling pass, to @file{@var{file}.25.sched}.
3360 @item t
3361 @opindex dt
3362 Dump after the second CSE pass (including the jump optimization that
3363 sometimes follows CSE), to @file{@var{file}.20.cse2}.
3364 @item T
3365 @opindex dT
3366 Dump after running tracer, to @file{@var{file}.18.tracer}.
3367 @item u
3368 @opindex du
3369 Dump after null pointer elimination pass to @file{@var{file}.018.null}.
3370 @item U
3371 @opindex dU
3372 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3373 @item w
3374 @opindex dw
3375 Dump after the second flow pass, to @file{@var{file}.29.flow2}.
3376 @item W
3377 @opindex dW
3378 Dump after SSA conditional constant propagation, to
3379 @file{@var{file}.06.ssaccp}.
3380 @item X
3381 @opindex dX
3382 Dump after SSA dead code elimination, to @file{@var{file}.07.ssadce}.
3383 @item z
3384 @opindex dz
3385 Dump after the peephole pass, to @file{@var{file}.30.peephole2}.
3386 @item a
3387 @opindex da
3388 Produce all the dumps listed above.
3389 @item H
3390 @opindex dH
3391 Produce a core dump whenever an error occurs.
3392 @item m
3393 @opindex dm
3394 Print statistics on memory usage, at the end of the run, to
3395 standard error.
3396 @item p
3397 @opindex dp
3398 Annotate the assembler output with a comment indicating which
3399 pattern and alternative was used.  The length of each instruction is
3400 also printed.
3401 @item P
3402 @opindex dP
3403 Dump the RTL in the assembler output as a comment before each instruction.
3404 Also turns on @option{-dp} annotation.
3405 @item v
3406 @opindex dv
3407 For each of the other indicated dump files (except for
3408 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3409 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3410 @item x
3411 @opindex dx
3412 Just generate RTL for a function instead of compiling it.  Usually used
3413 with @samp{r}.
3414 @item y
3415 @opindex dy
3416 Dump debugging information during parsing, to standard error.
3417 @end table
3418
3419 @item -fdump-unnumbered
3420 @opindex fdump-unnumbered
3421 When doing debugging dumps (see @option{-d} option above), suppress instruction
3422 numbers and line number note output.  This makes it more feasible to
3423 use diff on debugging dumps for compiler invocations with different
3424 options, in particular with and without @option{-g}.
3425
3426 @item -fdump-translation-unit @r{(C and C++ only)}
3427 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3428 @opindex fdump-translation-unit
3429 Dump a representation of the tree structure for the entire translation
3430 unit to a file.  The file name is made by appending @file{.tu} to the
3431 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3432 controls the details of the dump as described for the
3433 @option{-fdump-tree} options.
3434
3435 @item -fdump-class-hierarchy @r{(C++ only)}
3436 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3437 @opindex fdump-class-hierarchy
3438 Dump a representation of each class's hierarchy and virtual function
3439 table layout to a file.  The file name is made by appending @file{.class}
3440 to the source file name.  If the @samp{-@var{options}} form is used,
3441 @var{options} controls the details of the dump as described for the
3442 @option{-fdump-tree} options.
3443
3444 @item -fdump-tree-@var{switch} @r{(C++ only)}
3445 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3446 @opindex fdump-tree
3447 Control the dumping at various stages of processing the intermediate
3448 language tree to a file.  The file name is generated by appending a switch
3449 specific suffix to the source file name.  If the @samp{-@var{options}}
3450 form is used, @var{options} is a list of @samp{-} separated options that
3451 control the details of the dump. Not all options are applicable to all
3452 dumps, those which are not meaningful will be ignored. The following
3453 options are available
3454
3455 @table @samp
3456 @item address
3457 Print the address of each node.  Usually this is not meaningful as it
3458 changes according to the environment and source file. Its primary use
3459 is for tying up a dump file with a debug environment.
3460 @item slim
3461 Inhibit dumping of members of a scope or body of a function merely
3462 because that scope has been reached. Only dump such items when they
3463 are directly reachable by some other path.
3464 @item all
3465 Turn on all options.
3466 @end table
3467
3468 The following tree dumps are possible:
3469 @table @samp
3470 @item original
3471 Dump before any tree based optimization, to @file{@var{file}.original}.
3472 @item optimized
3473 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3474 @item inlined
3475 Dump after function inlining, to @file{@var{file}.inlined}.
3476 @end table
3477
3478 @item -frandom-seed=@var{string}
3479 @opindex frandom-string
3480 This option provides a seed that GCC uses when it would otherwise use
3481 random numbers.  It is used to generate certain symbol names
3482 that have to be different in every compiled file. It is also used to
3483 place unique stamps in coverage data files and the object files that
3484 produce them. You can use the @option{-frandom-seed} option to produce
3485 reproducibly identical object files.
3486
3487 The @var{string} should be different for every file you compile.
3488
3489 @item -fsched-verbose=@var{n}
3490 @opindex fsched-verbose
3491 On targets that use instruction scheduling, this option controls the
3492 amount of debugging output the scheduler prints.  This information is
3493 written to standard error, unless @option{-dS} or @option{-dR} is
3494 specified, in which case it is output to the usual dump
3495 listing file, @file{.sched} or @file{.sched2} respectively.  However
3496 for @var{n} greater than nine, the output is always printed to standard
3497 error.
3498
3499 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3500 same information as @option{-dRS}.  For @var{n} greater than one, it
3501 also output basic block probabilities, detailed ready list information
3502 and unit/insn info.  For @var{n} greater than two, it includes RTL
3503 at abort point, control-flow and regions info.  And for @var{n} over
3504 four, @option{-fsched-verbose} also includes dependence info.
3505
3506 @item -save-temps
3507 @opindex save-temps
3508 Store the usual ``temporary'' intermediate files permanently; place them
3509 in the current directory and name them based on the source file.  Thus,
3510 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3511 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3512 preprocessed @file{foo.i} output file even though the compiler now
3513 normally uses an integrated preprocessor.
3514
3515 @item -time
3516 @opindex time
3517 Report the CPU time taken by each subprocess in the compilation
3518 sequence.  For C source files, this is the compiler proper and assembler
3519 (plus the linker if linking is done).  The output looks like this:
3520
3521 @smallexample
3522 # cc1 0.12 0.01
3523 # as 0.00 0.01
3524 @end smallexample
3525
3526 The first number on each line is the ``user time,'' that is time spent
3527 executing the program itself.  The second number is ``system time,''
3528 time spent executing operating system routines on behalf of the program.
3529 Both numbers are in seconds.
3530
3531 @item -print-file-name=@var{library}
3532 @opindex print-file-name
3533 Print the full absolute name of the library file @var{library} that
3534 would be used when linking---and don't do anything else.  With this
3535 option, GCC does not compile or link anything; it just prints the
3536 file name.
3537
3538 @item -print-multi-directory
3539 @opindex print-multi-directory
3540 Print the directory name corresponding to the multilib selected by any
3541 other switches present in the command line.  This directory is supposed
3542 to exist in @env{GCC_EXEC_PREFIX}.
3543
3544 @item -print-multi-lib
3545 @opindex print-multi-lib
3546 Print the mapping from multilib directory names to compiler switches
3547 that enable them.  The directory name is separated from the switches by
3548 @samp{;}, and each switch starts with an @samp{@@} instead of the
3549 @samp{-}, without spaces between multiple switches.  This is supposed to
3550 ease shell-processing.
3551
3552 @item -print-prog-name=@var{program}
3553 @opindex print-prog-name
3554 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3555
3556 @item -print-libgcc-file-name
3557 @opindex print-libgcc-file-name
3558 Same as @option{-print-file-name=libgcc.a}.
3559
3560 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3561 but you do want to link with @file{libgcc.a}.  You can do
3562
3563 @example
3564 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3565 @end example
3566
3567 @item -print-search-dirs
3568 @opindex print-search-dirs
3569 Print the name of the configured installation directory and a list of
3570 program and library directories gcc will search---and don't do anything else.
3571
3572 This is useful when gcc prints the error message
3573 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3574 To resolve this you either need to put @file{cpp0} and the other compiler
3575 components where gcc expects to find them, or you can set the environment
3576 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3577 Don't forget the trailing '/'.
3578 @xref{Environment Variables}.
3579
3580 @item -dumpmachine
3581 @opindex dumpmachine
3582 Print the compiler's target machine (for example,
3583 @samp{i686-pc-linux-gnu})---and don't do anything else.
3584
3585 @item -dumpversion
3586 @opindex dumpversion
3587 Print the compiler version (for example, @samp{3.0})---and don't do
3588 anything else.
3589
3590 @item -dumpspecs
3591 @opindex dumpspecs
3592 Print the compiler's built-in specs---and don't do anything else.  (This
3593 is used when GCC itself is being built.)  @xref{Spec Files}.
3594
3595 @item -feliminate-unused-debug-types
3596 @opindex feliminate-unused-debug-types
3597 Normally, when producing DWARF2 output, GCC will emit debugging
3598 information for all types declared in a compilation
3599 unit, regardless of whether or not they are actually used
3600 in that compilation unit.  Sometimes this is useful, such as
3601 if, in the debugger, you want to cast a value to a type that is
3602 not actually used in your program (but is declared).  More often,
3603 however, this results in a significant amount of wasted space.
3604 With this option, GCC will avoid producing debug symbol output
3605 for types that are nowhere used in the source file being compiled.
3606 @end table
3607
3608 @node Optimize Options
3609 @section Options That Control Optimization
3610 @cindex optimize options
3611 @cindex options, optimization
3612
3613 These options control various sorts of optimizations.
3614
3615 Without any optimization option, the compiler's goal is to reduce the
3616 cost of compilation and to make debugging produce the expected
3617 results.  Statements are independent: if you stop the program with a
3618 breakpoint between statements, you can then assign a new value to any
3619 variable or change the program counter to any other statement in the
3620 function and get exactly the results you would expect from the source
3621 code.
3622
3623 Turning on optimization flags makes the compiler attempt to improve
3624 the performance and/or code size at the expense of compilation time
3625 and possibly the ability to debug the program.
3626
3627 The compiler performs optimisation based on the knowledge it has of
3628 the program.  Using the @option{-funit-at-a-time} flag will allow the
3629 compiler to consider information gained from later functions in the
3630 file when compiling a function.  Compiling multiple files at once to a
3631 single output file (and using @option{-funit-at-a-time}) will allow
3632 the compiler to use information gained from all of the files when
3633 compiling each of them.
3634
3635 Not all optimizations are controlled directly by a flag.  Only
3636 optimizations that have a flag are listed.
3637
3638 @table @gcctabopt
3639 @item -O
3640 @itemx -O1
3641 @opindex O
3642 @opindex O1
3643 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3644 more memory for a large function.
3645
3646 With @option{-O}, the compiler tries to reduce code size and execution
3647 time, without performing any optimizations that take a great deal of
3648 compilation time.
3649
3650 @option{-O} turns on the following optimization flags: 
3651 @gccoptlist{-fdefer-pop @gol
3652 -fmerge-constants @gol
3653 -fthread-jumps @gol
3654 -floop-optimize @gol
3655 -fcrossjumping @gol
3656 -fif-conversion @gol
3657 -fif-conversion2 @gol
3658 -fdelayed-branch @gol
3659 -fguess-branch-probability @gol
3660 -fcprop-registers}
3661
3662 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3663 where doing so does not interfere with debugging.
3664
3665 @item -O2
3666 @opindex O2
3667 Optimize even more.  GCC performs nearly all supported optimizations
3668 that do not involve a space-speed tradeoff.  The compiler does not
3669 perform loop unrolling or function inlining when you specify @option{-O2}.
3670 As compared to @option{-O}, this option increases both compilation time
3671 and the performance of the generated code.
3672
3673 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3674 also turns on the following optimization flags:
3675 @gccoptlist{-fforce-mem @gol
3676 -foptimize-sibling-calls @gol
3677 -fstrength-reduce @gol
3678 -fcse-follow-jumps  -fcse-skip-blocks @gol
3679 -frerun-cse-after-loop  -frerun-loop-opt @gol
3680 -fgcse   -fgcse-lm   -fgcse-sm @gol
3681 -fdelete-null-pointer-checks @gol
3682 -fexpensive-optimizations @gol
3683 -fregmove -@gol
3684 -fschedule-insns  -fschedule-insns2 @gol
3685 -fsched-interblock  -fsched-spec @gol
3686 -fcaller-saves @gol
3687 -fpeephole2 @gol
3688 -freorder-blocks  -freorder-functions @gol
3689 -fstrict-aliasing @gol
3690 -funit-at-a-time @gol
3691 -falign-functions  -falign-jumps @gol
3692 -falign-loops  -falign-labels}
3693
3694 Please note the warning under @option{-fgcse} about
3695 invoking @option{-O2} on programs that use computed gotos.
3696
3697 @item -O3
3698 @opindex O3
3699 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3700 @option{-O2} and also turns on the @option{-finline-functions},
3701 @option{-fweb} and @option{-frename-registers} options.
3702
3703 @item -O0
3704 @opindex O0
3705 Do not optimize.  This is the default.
3706
3707 @item -Os
3708 @opindex Os
3709 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3710 do not typically increase code size.  It also performs further
3711 optimizations designed to reduce code size.
3712
3713 @option{-Os} disables the following optimization flags:
3714 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3715 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3716
3717 If you use multiple @option{-O} options, with or without level numbers,
3718 the last such option is the one that is effective.
3719 @end table
3720
3721 Options of the form @option{-f@var{flag}} specify machine-independent
3722 flags.  Most flags have both positive and negative forms; the negative
3723 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3724 below, only one of the forms is listed---the one you typically will
3725 use.  You can figure out the other form by either removing @samp{no-}
3726 or adding it.
3727
3728 The following options control specific optimizations.  They are either
3729 activated by @option{-O} options or are related to ones that are.  You
3730 can use the following flags in the rare cases when ``fine-tuning'' of
3731 optimizations to be performed is desired.
3732
3733 @table @gcctabopt
3734 @item -fno-default-inline
3735 @opindex fno-default-inline
3736 Do not make member functions inline by default merely because they are
3737 defined inside the class scope (C++ only).  Otherwise, when you specify
3738 @w{@option{-O}}, member functions defined inside class scope are compiled
3739 inline by default; i.e., you don't need to add @samp{inline} in front of
3740 the member function name.
3741
3742 @item -fno-defer-pop
3743 @opindex fno-defer-pop
3744 Always pop the arguments to each function call as soon as that function
3745 returns.  For machines which must pop arguments after a function call,
3746 the compiler normally lets arguments accumulate on the stack for several
3747 function calls and pops them all at once.
3748
3749 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3750
3751 @item -fforce-mem
3752 @opindex fforce-mem
3753 Force memory operands to be copied into registers before doing
3754 arithmetic on them.  This produces better code by making all memory
3755 references potential common subexpressions.  When they are not common
3756 subexpressions, instruction combination should eliminate the separate
3757 register-load.
3758
3759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3760
3761 @item -fforce-addr
3762 @opindex fforce-addr
3763 Force memory address constants to be copied into registers before
3764 doing arithmetic on them.  This may produce better code just as
3765 @option{-fforce-mem} may.
3766
3767 @item -fomit-frame-pointer
3768 @opindex fomit-frame-pointer
3769 Don't keep the frame pointer in a register for functions that
3770 don't need one.  This avoids the instructions to save, set up and
3771 restore frame pointers; it also makes an extra register available
3772 in many functions.  @strong{It also makes debugging impossible on
3773 some machines.}
3774
3775 On some machines, such as the VAX, this flag has no effect, because
3776 the standard calling sequence automatically handles the frame pointer
3777 and nothing is saved by pretending it doesn't exist.  The
3778 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3779 whether a target machine supports this flag.  @xref{Registers,,Register
3780 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3781
3782 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3783
3784 @item -foptimize-sibling-calls
3785 @opindex foptimize-sibling-calls
3786 Optimize sibling and tail recursive calls.
3787
3788 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3789
3790 @item -fno-inline
3791 @opindex fno-inline
3792 Don't pay attention to the @code{inline} keyword.  Normally this option
3793 is used to keep the compiler from expanding any functions inline.
3794 Note that if you are not optimizing, no functions can be expanded inline.
3795
3796 @item -finline-functions
3797 @opindex finline-functions
3798 Integrate all simple functions into their callers.  The compiler
3799 heuristically decides which functions are simple enough to be worth
3800 integrating in this way.
3801
3802 If all calls to a given function are integrated, and the function is
3803 declared @code{static}, then the function is normally not output as
3804 assembler code in its own right.
3805
3806 Enabled at level @option{-O3}.
3807
3808 @item -finline-limit=@var{n}
3809 @opindex finline-limit
3810 By default, gcc limits the size of functions that can be inlined.  This flag
3811 allows the control of this limit for functions that are explicitly marked as
3812 inline (i.e., marked with the inline keyword or defined within the class
3813 definition in c++).  @var{n} is the size of functions that can be inlined in
3814 number of pseudo instructions (not counting parameter handling).  The default
3815 value of @var{n} is 600.
3816 Increasing this value can result in more inlined code at
3817 the cost of compilation time and memory consumption.  Decreasing usually makes
3818 the compilation faster and less code will be inlined (which presumably
3819 means slower programs).  This option is particularly useful for programs that
3820 use inlining heavily such as those based on recursive templates with C++.
3821
3822 Inlining is actually controlled by a number of parameters, which may be
3823 specified individually by using @option{--param @var{name}=@var{value}}.
3824 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3825 as follows:
3826
3827 @table @gcctabopt
3828  @item max-inline-insns
3829   is set to @var{n}.
3830  @item max-inline-insns-single
3831   is set to @var{n}/2.
3832  @item max-inline-insns-auto
3833   is set to @var{n}/2.
3834  @item min-inline-insns
3835   is set to 130 or @var{n}/4, whichever is smaller.
3836  @item max-inline-insns-rtl
3837   is set to @var{n}.
3838 @end table
3839
3840 Using @option{-finline-limit=600} thus results in the default settings
3841 for these parameters.  See below for a documentation of the individual
3842 parameters controlling inlining.
3843
3844 @emph{Note:} pseudo instruction represents, in this particular context, an
3845 abstract measurement of function's size.  In no way, it represents a count
3846 of assembly instructions and as such its exact meaning might change from one
3847 release to an another.
3848
3849 @item -fkeep-inline-functions
3850 @opindex fkeep-inline-functions
3851 Even if all calls to a given function are integrated, and the function
3852 is declared @code{static}, nevertheless output a separate run-time
3853 callable version of the function.  This switch does not affect
3854 @code{extern inline} functions.
3855
3856 @item -fkeep-static-consts
3857 @opindex fkeep-static-consts
3858 Emit variables declared @code{static const} when optimization isn't turned
3859 on, even if the variables aren't referenced.
3860
3861 GCC enables this option by default.  If you want to force the compiler to
3862 check if the variable was referenced, regardless of whether or not
3863 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3864
3865 @item -fmerge-constants
3866 Attempt to merge identical constants (string constants and floating point
3867 constants) across compilation units.
3868
3869 This option is the default for optimized compilation if the assembler and
3870 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3871 behavior.
3872
3873 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3874
3875 @item -fmerge-all-constants
3876 Attempt to merge identical constants and identical variables.
3877
3878 This option implies @option{-fmerge-constants}.  In addition to
3879 @option{-fmerge-constants} this considers e.g. even constant initialized
3880 arrays or initialized constant variables with integral or floating point
3881 types.  Languages like C or C++ require each non-automatic variable to
3882 have distinct location, so using this option will result in non-conforming
3883 behavior.
3884
3885 @item -fnew-ra
3886 @opindex fnew-ra
3887 Use a graph coloring register allocator.  Currently this option is meant
3888 for testing, so we are interested to hear about miscompilations with
3889 @option{-fnew-ra}.
3890
3891 @item -fno-branch-count-reg
3892 @opindex fno-branch-count-reg
3893 Do not use ``decrement and branch'' instructions on a count register,
3894 but instead generate a sequence of instructions that decrement a
3895 register, compare it against zero, then branch based upon the result.
3896 This option is only meaningful on architectures that support such
3897 instructions, which include x86, PowerPC, IA-64 and S/390.
3898
3899 The default is @option{-fbranch-count-reg}, enabled when
3900 @option{-fstrength-reduce} is enabled.
3901
3902 @item -fno-function-cse
3903 @opindex fno-function-cse
3904 Do not put function addresses in registers; make each instruction that
3905 calls a constant function contain the function's address explicitly.
3906
3907 This option results in less efficient code, but some strange hacks
3908 that alter the assembler output may be confused by the optimizations
3909 performed when this option is not used.
3910
3911 The default is @option{-ffunction-cse}
3912
3913 @item -fno-zero-initialized-in-bss
3914 @opindex fno-zero-initialized-in-bss
3915 If the target supports a BSS section, GCC by default puts variables that
3916 are initialized to zero into BSS@.  This can save space in the resulting
3917 code.
3918
3919 This option turns off this behavior because some programs explicitly
3920 rely on variables going to the data section.  E.g., so that the
3921 resulting executable can find the beginning of that section and/or make
3922 assumptions based on that.
3923
3924 The default is @option{-fzero-initialized-in-bss}.
3925
3926 @item -fstrength-reduce
3927 @opindex fstrength-reduce
3928 Perform the optimizations of loop strength reduction and
3929 elimination of iteration variables.
3930
3931 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3932
3933 @item -fthread-jumps
3934 @opindex fthread-jumps
3935 Perform optimizations where we check to see if a jump branches to a
3936 location where another comparison subsumed by the first is found.  If
3937 so, the first branch is redirected to either the destination of the
3938 second branch or a point immediately following it, depending on whether
3939 the condition is known to be true or false.
3940
3941 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3942
3943 @item -fcse-follow-jumps
3944 @opindex fcse-follow-jumps
3945 In common subexpression elimination, scan through jump instructions
3946 when the target of the jump is not reached by any other path.  For
3947 example, when CSE encounters an @code{if} statement with an
3948 @code{else} clause, CSE will follow the jump when the condition
3949 tested is false.
3950
3951 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3952
3953 @item -fcse-skip-blocks
3954 @opindex fcse-skip-blocks
3955 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3956 follow jumps which conditionally skip over blocks.  When CSE
3957 encounters a simple @code{if} statement with no else clause,
3958 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3959 body of the @code{if}.
3960
3961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3962
3963 @item -frerun-cse-after-loop
3964 @opindex frerun-cse-after-loop
3965 Re-run common subexpression elimination after loop optimizations has been
3966 performed.
3967
3968 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3969
3970 @item -frerun-loop-opt
3971 @opindex frerun-loop-opt
3972 Run the loop optimizer twice.
3973
3974 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3975
3976 @item -fgcse
3977 @opindex fgcse
3978 Perform a global common subexpression elimination pass.
3979 This pass also performs global constant and copy propagation.
3980
3981 @emph{Note:} When compiling a program using computed gotos, a GCC
3982 extension, you may get better runtime performance if you disable
3983 the global common subexpression elimination pass by adding
3984 @option{-fno-gcse} to the command line.
3985
3986 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3987
3988 @item -fgcse-lm
3989 @opindex fgcse-lm
3990 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3991 attempt to move loads which are only killed by stores into themselves.  This
3992 allows a loop containing a load/store sequence to be changed to a load outside
3993 the loop, and a copy/store within the loop.
3994
3995 Enabled by default when gcse is enabled.
3996
3997 @item -fgcse-sm
3998 @opindex fgcse-sm
3999 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
4000 subexpression elimination.  This pass will attempt to move stores out of loops.
4001 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
4002 can be changed to a load before the loop and a store after the loop.
4003
4004 Enabled by default when gcse is enabled.
4005
4006 @item -floop-optimize
4007 @opindex floop-optimize
4008 Perform loop optimizations: move constant expressions out of loops, simplify
4009 exit test conditions and optionally do strength-reduction and loop unrolling as
4010 well.
4011
4012 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4013
4014 @item -fcrossjumping
4015 @opindex crossjumping
4016 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4017 resulting code may or may not perform better than without cross-jumping.
4018
4019 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4020
4021 @item -fif-conversion
4022 @opindex if-conversion
4023 Attempt to transform conditional jumps into branch-less equivalents.  This
4024 include use of conditional moves, min, max, set flags and abs instructions, and
4025 some tricks doable by standard arithmetics.  The use of conditional execution
4026 on chips where it is available is controlled by @code{if-conversion2}.
4027
4028 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fif-conversion2
4031 @opindex if-conversion2
4032 Use conditional execution (where available) to transform conditional jumps into
4033 branch-less equivalents.
4034
4035 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4036
4037 @item -fdelete-null-pointer-checks
4038 @opindex fdelete-null-pointer-checks
4039 Use global dataflow analysis to identify and eliminate useless checks
4040 for null pointers.  The compiler assumes that dereferencing a null
4041 pointer would have halted the program.  If a pointer is checked after
4042 it has already been dereferenced, it cannot be null.
4043
4044 In some environments, this assumption is not true, and programs can
4045 safely dereference null pointers.  Use
4046 @option{-fno-delete-null-pointer-checks} to disable this optimization
4047 for programs which depend on that behavior.
4048
4049 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4050
4051 @item -fexpensive-optimizations
4052 @opindex fexpensive-optimizations
4053 Perform a number of minor optimizations that are relatively expensive.
4054
4055 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4056
4057 @item -foptimize-register-move
4058 @itemx -fregmove
4059 @opindex foptimize-register-move
4060 @opindex fregmove
4061 Attempt to reassign register numbers in move instructions and as
4062 operands of other simple instructions in order to maximize the amount of
4063 register tying.  This is especially helpful on machines with two-operand
4064 instructions.
4065
4066 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4067 optimization.
4068
4069 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4070
4071 @item -fdelayed-branch
4072 @opindex fdelayed-branch
4073 If supported for the target machine, attempt to reorder instructions
4074 to exploit instruction slots available after delayed branch
4075 instructions.
4076
4077 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4078
4079 @item -fschedule-insns
4080 @opindex fschedule-insns
4081 If supported for the target machine, attempt to reorder instructions to
4082 eliminate execution stalls due to required data being unavailable.  This
4083 helps machines that have slow floating point or memory load instructions
4084 by allowing other instructions to be issued until the result of the load
4085 or floating point instruction is required.
4086
4087 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4088
4089 @item -fschedule-insns2
4090 @opindex fschedule-insns2
4091 Similar to @option{-fschedule-insns}, but requests an additional pass of
4092 instruction scheduling after register allocation has been done.  This is
4093 especially useful on machines with a relatively small number of
4094 registers and where memory load instructions take more than one cycle.
4095
4096 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4097
4098 @item -fno-sched-interblock
4099 @opindex fno-sched-interblock
4100 Don't schedule instructions across basic blocks.  This is normally
4101 enabled by default when scheduling before register allocation, i.e.@:
4102 with @option{-fschedule-insns} or at @option{-O2} or higher.
4103
4104 @item -fno-sched-spec
4105 @opindex fno-sched-spec
4106 Don't allow speculative motion of non-load instructions.  This is normally
4107 enabled by default when scheduling before register allocation, i.e.@:
4108 with @option{-fschedule-insns} or at @option{-O2} or higher.
4109
4110 @item -fsched-spec-load
4111 @opindex fsched-spec-load
4112 Allow speculative motion of some load instructions.  This only makes
4113 sense when scheduling before register allocation, i.e.@: with
4114 @option{-fschedule-insns} or at @option{-O2} or higher.
4115
4116 @item -fsched-spec-load-dangerous
4117 @opindex fsched-spec-load-dangerous
4118 Allow speculative motion of more load instructions.  This only makes
4119 sense when scheduling before register allocation, i.e.@: with
4120 @option{-fschedule-insns} or at @option{-O2} or higher.
4121
4122 @item -fsched-stalled-insns=@var{n}
4123 @opindex fsched-stalled-insns
4124 Define how many insns (if any) can be moved prematurely from the queue
4125 of stalled insns into the ready list, during the second scheduling pass.
4126
4127 @item -fsched-stalled-insns-dep=@var{n}
4128 @opindex fsched-stalled-insns-dep
4129 Define how many insn groups (cycles) will be examined for a dependency 
4130 on a stalled insn that is candidate for premature removal from the queue 
4131 of stalled insns.  Has an effect only during the second scheduling pass, 
4132 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4133
4134 @item -fsched2-use-superblocks
4135 @opindex fsched2-use-superblocks
4136 When scheduling after register allocation, do use superblock scheduling
4137 algorithm.  Superblock scheduling allows motion across basic block boundaries
4138 resulting on faster schedules.  This option is experimental, as not all machine
4139 descriptions used by GCC model the CPU closely enough to avoid unreliable
4140 results from the algorithm. 
4141
4142 This only makes sense when scheduling after register allocation, i.e.@: with
4143 @option{-fschedule-insns2} or at @option{-O2} or higher.
4144
4145 @item -fsched2-use-traces
4146 @opindex fsched2-use-traces
4147 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4148 allocation and additionally perform code duplication in order to increase the
4149 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4150 trace formation.
4151
4152 This mode should produce faster but significantly longer programs.  Also
4153 without @code{-fbranch-probabilities} the traces constructed may not match the
4154 reality and hurt the performance.  This only makes
4155 sense when scheduling after register allocation, i.e.@: with
4156 @option{-fschedule-insns2} or at @option{-O2} or higher.
4157
4158 @item -fcaller-saves
4159 @opindex fcaller-saves
4160 Enable values to be allocated in registers that will be clobbered by
4161 function calls, by emitting extra instructions to save and restore the
4162 registers around such calls.  Such allocation is done only when it
4163 seems to result in better code than would otherwise be produced.
4164
4165 This option is always enabled by default on certain machines, usually
4166 those which have no call-preserved registers to use instead.
4167
4168 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4169
4170 @item -fmove-all-movables
4171 @opindex fmove-all-movables
4172 Forces all invariant computations in loops to be moved
4173 outside the loop.
4174
4175 @item -freduce-all-givs
4176 @opindex freduce-all-givs
4177 Forces all general-induction variables in loops to be
4178 strength-reduced.
4179
4180 @emph{Note:} When compiling programs written in Fortran,
4181 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4182 by default when you use the optimizer.
4183
4184 These options may generate better or worse code; results are highly
4185 dependent on the structure of loops within the source code.
4186
4187 These two options are intended to be removed someday, once
4188 they have helped determine the efficacy of various
4189 approaches to improving loop optimizations.
4190
4191 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4192 know how use of these options affects
4193 the performance of your production code.
4194 We're very interested in code that runs @emph{slower}
4195 when these options are @emph{enabled}.
4196
4197 @item -fno-peephole
4198 @itemx -fno-peephole2
4199 @opindex fno-peephole
4200 @opindex fno-peephole2
4201 Disable any machine-specific peephole optimizations.  The difference
4202 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4203 are implemented in the compiler; some targets use one, some use the
4204 other, a few use both.
4205
4206 @option{-fpeephole} is enabled by default.
4207 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4208
4209 @item -fno-guess-branch-probability
4210 @opindex fno-guess-branch-probability
4211 Do not guess branch probabilities using a randomized model.
4212
4213 Sometimes gcc will opt to use a randomized model to guess branch
4214 probabilities, when none are available from either profiling feedback
4215 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4216 different runs of the compiler on the same program may produce different
4217 object code.
4218
4219 In a hard real-time system, people don't want different runs of the
4220 compiler to produce code that has different behavior; minimizing
4221 non-determinism is of paramount import.  This switch allows users to
4222 reduce non-determinism, possibly at the expense of inferior
4223 optimization.
4224
4225 The default is @option{-fguess-branch-probability} at levels
4226 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4227
4228 @item -freorder-blocks
4229 @opindex freorder-blocks
4230 Reorder basic blocks in the compiled function in order to reduce number of
4231 taken branches and improve code locality.
4232
4233 Enabled at levels @option{-O2}, @option{-O3}.
4234
4235 @item -freorder-functions
4236 @opindex freorder-functions
4237 Reorder basic blocks in the compiled function in order to reduce number of
4238 taken branches and improve code locality. This is implemented by using special
4239 subsections @code{text.hot} for most frequently executed functions and
4240 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4241 the linker so object file format must support named sections and linker must
4242 place them in a reasonable way.
4243
4244 Also profile feedback must be available in to make this option effective.  See
4245 @option{-fprofile-arcs} for details.
4246
4247 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4248
4249 @item -fstrict-aliasing
4250 @opindex fstrict-aliasing
4251 Allows the compiler to assume the strictest aliasing rules applicable to
4252 the language being compiled.  For C (and C++), this activates
4253 optimizations based on the type of expressions.  In particular, an
4254 object of one type is assumed never to reside at the same address as an
4255 object of a different type, unless the types are almost the same.  For
4256 example, an @code{unsigned int} can alias an @code{int}, but not a
4257 @code{void*} or a @code{double}.  A character type may alias any other
4258 type.
4259
4260 Pay special attention to code like this:
4261 @example
4262 union a_union @{
4263   int i;
4264   double d;
4265 @};
4266
4267 int f() @{
4268   a_union t;
4269   t.d = 3.0;
4270   return t.i;
4271 @}
4272 @end example
4273 The practice of reading from a different union member than the one most
4274 recently written to (called ``type-punning'') is common.  Even with
4275 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4276 is accessed through the union type.  So, the code above will work as
4277 expected.  However, this code might not:
4278 @example
4279 int f() @{
4280   a_union t;
4281   int* ip;
4282   t.d = 3.0;
4283   ip = &t.i;
4284   return *ip;
4285 @}
4286 @end example
4287
4288 Every language that wishes to perform language-specific alias analysis
4289 should define a function that computes, given an @code{tree}
4290 node, an alias set for the node.  Nodes in different alias sets are not
4291 allowed to alias.  For an example, see the C front-end function
4292 @code{c_get_alias_set}.
4293
4294 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4295
4296 @item -falign-functions
4297 @itemx -falign-functions=@var{n}
4298 @opindex falign-functions
4299 Align the start of functions to the next power-of-two greater than
4300 @var{n}, skipping up to @var{n} bytes.  For instance,
4301 @option{-falign-functions=32} aligns functions to the next 32-byte
4302 boundary, but @option{-falign-functions=24} would align to the next
4303 32-byte boundary only if this can be done by skipping 23 bytes or less.
4304
4305 @option{-fno-align-functions} and @option{-falign-functions=1} are
4306 equivalent and mean that functions will not be aligned.
4307
4308 Some assemblers only support this flag when @var{n} is a power of two;
4309 in that case, it is rounded up.
4310
4311 If @var{n} is not specified or is zero, use a machine-dependent default.
4312
4313 Enabled at levels @option{-O2}, @option{-O3}.
4314
4315 @item -falign-labels
4316 @itemx -falign-labels=@var{n}
4317 @opindex falign-labels
4318 Align all branch targets to a power-of-two boundary, skipping up to
4319 @var{n} bytes like @option{-falign-functions}.  This option can easily
4320 make code slower, because it must insert dummy operations for when the
4321 branch target is reached in the usual flow of the code.
4322
4323 @option{-fno-align-labels} and @option{-falign-labels=1} are
4324 equivalent and mean that labels will not be aligned.
4325
4326 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4327 are greater than this value, then their values are used instead.
4328
4329 If @var{n} is not specified or is zero, use a machine-dependent default
4330 which is very likely to be @samp{1}, meaning no alignment.
4331
4332 Enabled at levels @option{-O2}, @option{-O3}.
4333
4334 @item -falign-loops
4335 @itemx -falign-loops=@var{n}
4336 @opindex falign-loops
4337 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4338 like @option{-falign-functions}.  The hope is that the loop will be
4339 executed many times, which will make up for any execution of the dummy
4340 operations.
4341
4342 @option{-fno-align-loops} and @option{-falign-loops=1} are
4343 equivalent and mean that loops will not be aligned.
4344
4345 If @var{n} is not specified or is zero, use a machine-dependent default.
4346
4347 Enabled at levels @option{-O2}, @option{-O3}.
4348
4349 @item -falign-jumps
4350 @itemx -falign-jumps=@var{n}
4351 @opindex falign-jumps
4352 Align branch targets to a power-of-two boundary, for branch targets
4353 where the targets can only be reached by jumping, skipping up to @var{n}
4354 bytes like @option{-falign-functions}.  In this case, no dummy operations
4355 need be executed.
4356
4357 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4358 equivalent and mean that loops will not be aligned.
4359
4360 If @var{n} is not specified or is zero, use a machine-dependent default.
4361
4362 Enabled at levels @option{-O2}, @option{-O3}.
4363
4364 @item -frename-registers
4365 @opindex frename-registers
4366 Attempt to avoid false dependencies in scheduled code by making use
4367 of registers left over after register allocation.  This optimization
4368 will most benefit processors with lots of registers.  It can, however,
4369 make debugging impossible, since variables will no longer stay in
4370 a ``home register''.
4371
4372 Enabled at levels @option{-O3}.
4373
4374 @item -fno-cprop-registers
4375 @opindex fno-cprop-registers
4376 After register allocation and post-register allocation instruction splitting,
4377 we perform a copy-propagation pass to try to reduce scheduling dependencies
4378 and occasionally eliminate the copy.
4379
4380 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4381
4382 @end table
4383
4384 The following options control compiler behavior regarding floating
4385 point arithmetic.  These options trade off between speed and
4386 correctness.  All must be specifically enabled.
4387
4388 @table @gcctabopt
4389 @item -ffloat-store
4390 @opindex ffloat-store
4391 Do not store floating point variables in registers, and inhibit other
4392 options that might change whether a floating point value is taken from a
4393 register or memory.
4394
4395 @cindex floating point precision
4396 This option prevents undesirable excess precision on machines such as
4397 the 68000 where the floating registers (of the 68881) keep more
4398 precision than a @code{double} is supposed to have.  Similarly for the
4399 x86 architecture.  For most programs, the excess precision does only
4400 good, but a few programs rely on the precise definition of IEEE floating
4401 point.  Use @option{-ffloat-store} for such programs, after modifying
4402 them to store all pertinent intermediate computations into variables.
4403
4404 @item -ffast-math
4405 @opindex ffast-math
4406 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4407 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4408 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4409
4410 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4411
4412 This option should never be turned on by any @option{-O} option since
4413 it can result in incorrect output for programs which depend on
4414 an exact implementation of IEEE or ISO rules/specifications for
4415 math functions.
4416
4417 @item -fno-math-errno
4418 @opindex fno-math-errno
4419 Do not set ERRNO after calling math functions that are executed
4420 with a single instruction, e.g., sqrt.  A program that relies on
4421 IEEE exceptions for math error handling may want to use this flag
4422 for speed while maintaining IEEE arithmetic compatibility.
4423
4424 This option should never be turned on by any @option{-O} option since
4425 it can result in incorrect output for programs which depend on
4426 an exact implementation of IEEE or ISO rules/specifications for
4427 math functions.
4428
4429 The default is @option{-fmath-errno}.
4430
4431 @item -funsafe-math-optimizations
4432 @opindex funsafe-math-optimizations
4433 Allow optimizations for floating-point arithmetic that (a) assume
4434 that arguments and results are valid and (b) may violate IEEE or
4435 ANSI standards.  When used at link-time, it may include libraries
4436 or startup files that change the default FPU control word or other
4437 similar optimizations.
4438
4439 This option should never be turned on by any @option{-O} option since
4440 it can result in incorrect output for programs which depend on
4441 an exact implementation of IEEE or ISO rules/specifications for
4442 math functions.
4443
4444 The default is @option{-fno-unsafe-math-optimizations}.
4445
4446 @item -ffinite-math-only
4447 @opindex ffinite-math-only
4448 Allow optimizations for floating-point arithmetic that assume
4449 that arguments and results are not NaNs or +-Infs.
4450
4451 This option should never be turned on by any @option{-O} option since
4452 it can result in incorrect output for programs which depend on
4453 an exact implementation of IEEE or ISO rules/specifications.
4454
4455 The default is @option{-fno-finite-math-only}.
4456
4457 @item -fno-trapping-math
4458 @opindex fno-trapping-math
4459 Compile code assuming that floating-point operations cannot generate
4460 user-visible traps.  These traps include division by zero, overflow,
4461 underflow, inexact result and invalid operation.  This option implies
4462 @option{-fno-signaling-nans}.  Setting this option may allow faster
4463 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4464
4465 This option should never be turned on by any @option{-O} option since
4466 it can result in incorrect output for programs which depend on
4467 an exact implementation of IEEE or ISO rules/specifications for
4468 math functions.
4469
4470 The default is @option{-ftrapping-math}.
4471
4472 @item -frounding-math
4473 @opindex frounding-math
4474 Disable transformations and optimizations that assume default floating
4475 point rounding behavior.  This is round-to-zero for all floating point
4476 to integer conversions, and round-to-nearest for all other arithmetic
4477 truncations.  This option should be specified for programs that change
4478 the FP rounding mode dynamically, or that may be executed with a
4479 non-default rounding mode.  This option disables constant folding of
4480 floating point expressions at compile-time (which may be affected by
4481 rounding mode) and arithmetic transformations that are unsafe in the
4482 presence of sign-dependent rounding modes.
4483
4484 The default is @option{-fno-rounding-math}.
4485
4486 This option is experimental and does not currently guarantee to
4487 disable all GCC optimizations that are affected by rounding mode.
4488 Future versions of gcc may provide finer control of this setting
4489 using C99's @code{FENV_ACCESS} pragma.  This command line option
4490 will be used to specify the default state for @code{FENV_ACCESS}.
4491
4492 @item -fsignaling-nans
4493 @opindex fsignaling-nans
4494 Compile code assuming that IEEE signaling NaNs may generate user-visible
4495 traps during floating-point operations.  Setting this option disables
4496 optimizations that may change the number of exceptions visible with
4497 signaling NaNs.  This option implies @option{-ftrapping-math}.
4498
4499 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4500 be defined.
4501
4502 The default is @option{-fno-signaling-nans}.
4503
4504 This option is experimental and does not currently guarantee to
4505 disable all GCC optimizations that affect signaling NaN behavior.
4506
4507 @item -fsingle-precision-constant
4508 @opindex fsingle-precision-constant
4509 Treat floating point constant as single precision constant instead of
4510 implicitly converting it to double precision constant.
4511
4512
4513 @end table
4514
4515 The following options control optimizations that may improve
4516 performance, but are not enabled by any @option{-O} options.  This
4517 section includes experimental options that may produce broken code.
4518
4519 @table @gcctabopt
4520 @item -fbranch-probabilities
4521 @opindex fbranch-probabilities
4522 After running a program compiled with @option{-fprofile-arcs}
4523 (@pxref{Debugging Options,, Options for Debugging Your Program or
4524 @command{gcc}}), you can compile it a second time using
4525 @option{-fbranch-probabilities}, to improve optimizations based on
4526 the number of times each branch was taken.  When the program
4527 compiled with @option{-fprofile-arcs} exits it saves arc execution
4528 counts to a file called @file{@var{sourcename}.gcda} for each source
4529 file  The information in this data file is very dependent on the
4530 structure of the generated code, so you must use the same source code
4531 and the same optimization options for both compilations.
4532
4533 With @option{-fbranch-probabilities}, GCC puts a 
4534 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4535 These can be used to improve optimization.  Currently, they are only
4536 used in one place: in @file{reorg.c}, instead of guessing which path a
4537 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4538 exactly determine which path is taken more often.
4539
4540 @item -fprofile-values
4541 @opindex fprofile-values
4542 If combined with @option{-fprofile-arcs}, it adds code so that some
4543 data about values of expressions in the program is gathered.
4544
4545 With @option{-fbranch-probabilities}, it reads back the data gathered
4546 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4547 notes to instructions for their later usage in optimizations.
4548
4549 @item -fnew-ra
4550 @opindex fnew-ra
4551 Use a graph coloring register allocator.  Currently this option is meant
4552 for testing, so we are interested to hear about miscompilations with
4553 @option{-fnew-ra}.
4554
4555 @item -ftracer
4556 @opindex ftracer
4557 Perform tail duplication to enlarge superblock size. This transformation
4558 simplifies the control flow of the function allowing other optimizations to do
4559 better job.
4560
4561 @item -funit-at-a-time
4562 @opindex funit-at-a-time
4563 Parse the whole compilation unit before starting to produce code.
4564 This allows some extra optimizations to take place but consumes more
4565 memory.
4566
4567 @item -funroll-loops
4568 @opindex funroll-loops
4569 Unroll loops whose number of iterations can be determined at compile time or
4570 upon entry to the loop.  @option{-funroll-loops} implies
4571 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4572 (i.e. complete removal of loops with small constant number of iterations).
4573 This option makes code larger, and may or may not make it run faster.
4574
4575 @item -funroll-all-loops
4576 @opindex funroll-all-loops
4577 Unroll all loops, even if their number of iterations is uncertain when
4578 the loop is entered.  This usually makes programs run more slowly.
4579 @option{-funroll-all-loops} implies the same options as
4580 @option{-funroll-loops}.
4581
4582 @item -fpeel-loops
4583 @opindex fpeel-loops
4584 Peels the loops for that there is enough information that they do not
4585 roll much (from profile feedback).  It also turns on complete loop peeling
4586 (i.e. complete removal of loops with small constant number of iterations).
4587
4588 @item -funswitch-loops
4589 @opindex funswitch-loops
4590 Move branches with loop invariant conditions out of the loop, with duplicates
4591 of the loop on both branches (modified according to result of the condition).
4592
4593 @item -fold-unroll-loops
4594 @opindex fold-unroll-loops
4595 Unroll loops whose number of iterations can be determined at compile
4596 time or upon entry to the loop, using the old loop unroller whose loop
4597 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4598 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4599 option makes code larger, and may or may not make it run faster.
4600
4601 @item -fold-unroll-all-loops
4602 @opindex fold-unroll-all-loops
4603 Unroll all loops, even if their number of iterations is uncertain when
4604 the loop is entered. This is done using the old loop unroller whose loop
4605 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4606 @option{-fold-unroll-all-loops} implies the same options as
4607 @option{-fold-unroll-loops}.
4608  
4609 @item -funswitch-loops
4610 @opindex funswitch-loops
4611 Move branches with loop invariant conditions out of the loop, with duplicates
4612 of the loop on both branches (modified according to result of the condition).
4613
4614 @item -funswitch-loops
4615 @opindex funswitch-loops
4616 Move branches with loop invariant conditions out of the loop, with duplicates
4617 of the loop on both branches (modified according to result of the condition).
4618
4619 @item -fprefetch-loop-arrays
4620 @opindex fprefetch-loop-arrays
4621 If supported by the target machine, generate instructions to prefetch
4622 memory to improve the performance of loops that access large arrays.
4623
4624 Disabled at level @option{-Os}.
4625
4626 @item -ffunction-sections
4627 @itemx -fdata-sections
4628 @opindex ffunction-sections
4629 @opindex fdata-sections
4630 Place each function or data item into its own section in the output
4631 file if the target supports arbitrary sections.  The name of the
4632 function or the name of the data item determines the section's name
4633 in the output file.
4634
4635 Use these options on systems where the linker can perform optimizations
4636 to improve locality of reference in the instruction space.  Most systems
4637 using the ELF object format and SPARC processors running Solaris 2 have
4638 linkers with such optimizations.  AIX may have these optimizations in
4639 the future.
4640
4641 Only use these options when there are significant benefits from doing
4642 so.  When you specify these options, the assembler and linker will
4643 create larger object and executable files and will also be slower.
4644 You will not be able to use @code{gprof} on all systems if you
4645 specify this option and you may have problems with debugging if
4646 you specify both this option and @option{-g}.
4647
4648 @item -fssa
4649 @opindex fssa
4650 Perform optimizations in static single assignment form.  Each function's
4651 flow graph is translated into SSA form, optimizations are performed, and
4652 the flow graph is translated back from SSA form.  Users should not
4653 specify this option, since it is not yet ready for production use.
4654
4655 @item -fssa-ccp
4656 @opindex fssa-ccp
4657 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4658 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4659
4660 @item -fssa-dce
4661 @opindex fssa-dce
4662 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4663 Like @option{-fssa}, this is an experimental feature.
4664
4665 @item -fbranch-target-load-optimize
4666 @opindex fbranch-target-load-optimize
4667 Perform branch target register load optimization before prologue / epilogue
4668 threading.
4669 The use of target registers can typically be exposed only during reload,
4670 thus hoisting loads out of loops and doing inter-block scheduling needs
4671 a separate optimization pass.
4672
4673 @item -fbranch-target-load-optimize2
4674 @opindex fbranch-target-load-optimize2
4675 Perform branch target register load optimization after prologue / epilogue
4676 threading.
4677
4678
4679
4680
4681 @item --param @var{name}=@var{value}
4682 @opindex param
4683 In some places, GCC uses various constants to control the amount of
4684 optimization that is done.  For example, GCC will not inline functions
4685 that contain more that a certain number of instructions.  You can
4686 control some of these constants on the command-line using the
4687 @option{--param} option.
4688
4689 In each case, the @var{value} is an integer.  The allowable choices for
4690 @var{name} are given in the following table:
4691
4692 @table @gcctabopt
4693 @item max-crossjump-edges
4694 The maximum number of incoming edges to consider for crossjumping.
4695 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4696 the number of edges incoming to each block.  Increasing values mean
4697 more aggressive optimization, making the compile time increase with
4698 probably small improvement in executable size.
4699
4700 @item max-delay-slot-insn-search
4701 The maximum number of instructions to consider when looking for an
4702 instruction to fill a delay slot.  If more than this arbitrary number of
4703 instructions is searched, the time savings from filling the delay slot
4704 will be minimal so stop searching.  Increasing values mean more
4705 aggressive optimization, making the compile time increase with probably
4706 small improvement in executable run time.
4707
4708 @item max-delay-slot-live-search
4709 When trying to fill delay slots, the maximum number of instructions to
4710 consider when searching for a block with valid live register
4711 information.  Increasing this arbitrarily chosen value means more
4712 aggressive optimization, increasing the compile time.  This parameter
4713 should be removed when the delay slot code is rewritten to maintain the
4714 control-flow graph.
4715
4716 @item max-gcse-memory
4717 The approximate maximum amount of memory that will be allocated in
4718 order to perform the global common subexpression elimination
4719 optimization.  If more memory than specified is required, the
4720 optimization will not be done.
4721
4722 @item max-gcse-passes
4723 The maximum number of passes of GCSE to run.
4724
4725 @item max-pending-list-length
4726 The maximum number of pending dependencies scheduling will allow
4727 before flushing the current state and starting over.  Large functions
4728 with few branches or calls can create excessively large lists which
4729 needlessly consume memory and resources.
4730
4731 @item max-inline-insns-single
4732 Several parameters control the tree inliner used in gcc.
4733 This number sets the maximum number of instructions (counted in gcc's
4734 internal representation) in a single function that the tree inliner 
4735 will consider for inlining.  This only affects functions declared
4736 inline and methods implemented in a class declaration (C++).
4737 The default value is 500.
4738
4739 @item max-inline-insns-auto
4740 When you use @option{-finline-functions} (included in @option{-O3}),
4741 a lot of functions that would otherwise not be considered for inlining
4742 by the compiler will be investigated.  To those functions, a different
4743 (more restrictive) limit compared to functions declared inline can
4744 be applied.
4745 The default value is 150.
4746
4747 @item max-inline-insns
4748 The tree inliner does decrease the allowable size for single functions 
4749 to be inlined after we already inlined the number of instructions
4750 given here by repeated inlining.  This number should be a factor of 
4751 two or more larger than the single function limit.
4752 Higher numbers result in better runtime performance, but incur higher
4753 compile-time resource (CPU time, memory) requirements and result in
4754 larger binaries.  Very high values are not advisable, as too large
4755 binaries may adversely affect runtime performance.
4756 The default value is 200.
4757
4758 @item max-inline-slope
4759 After exceeding the maximum number of inlined instructions by repeated
4760 inlining, a linear function is used to decrease the allowable size
4761 for single functions.  The slope of that function is the negative
4762 reciprocal of the number specified here.
4763 This parameter is ignored when @option{-funit-at-a-time} is used.
4764 The default value is 32.
4765
4766 @item min-inline-insns
4767 The repeated inlining is throttled more and more by the linear function
4768 after exceeding the limit.  To avoid too much throttling, a minimum for
4769 this function is specified here to allow repeated inlining for very small
4770 functions even when a lot of repeated inlining already has been done.
4771 This parameter is ignored when @option{-funit-at-a-time} is used.
4772 The default value is 10.
4773
4774 @item large-function-insns
4775 The limit specifying really large functions.  For functions greater than this
4776 limit inlining is constrained by @option{--param large-function-growth}.
4777 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4778 algorithms used by the backend.
4779 This parameter is ignored when @option{-funit-at-a-time} is not used.
4780 The default value is 30000.
4781
4782 @item large-function-growth
4783 Specifies maximal growth of large functtion caused by inlining in percents.
4784 This parameter is ignored when @option{-funit-at-a-time} is not used.
4785 The default value is 200.
4786
4787 @item inline-unit-growth
4788 Specifies maximal overall growth of the compilation unit caused by inlining.
4789 This parameter is ignored when @option{-funit-at-a-time} is not used.
4790 The default value is 150.
4791
4792 @item max-inline-insns-rtl
4793 For languages that use the RTL inliner (this happens at a later stage
4794 than tree inlining), you can set the maximum allowable size (counted 
4795 in RTL instructions) for the RTL inliner with this parameter.
4796 The default value is 600.
4797
4798
4799 @item max-unrolled-insns
4800 The maximum number of instructions that a loop should have if that loop
4801 is unrolled, and if the loop is unrolled, it determines how many times
4802 the loop code is unrolled.
4803
4804 @item max-average-unrolled-insns
4805 The maximum number of instructions biased by probabilities of their execution
4806 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4807 it determines how many times the loop code is unrolled.
4808
4809 @item max-unroll-times
4810 The maximum number of unrollings of a single loop.
4811
4812 @item max-peeled-insns
4813 The maximum number of instructions that a loop should have if that loop
4814 is peeled, and if the loop is peeled, it determines how many times
4815 the loop code is peeled.
4816
4817 @item max-peel-times
4818 The maximum number of peelings of a single loop.
4819
4820 @item max-completely-peeled-insns
4821 The maximum number of insns of a completely peeled loop.
4822
4823 @item max-completely-peel-times
4824 The maximum number of iterations of a loop to be suitable for complete peeling.
4825
4826 @item max-unswitch-insns
4827 The maximum number of insns of an unswitched loop.
4828
4829 @item max-unswitch-level
4830 The maximum number of branches unswitched in a single loop.
4831
4832 @item hot-bb-count-fraction
4833 Select fraction of the maximal count of repetitions of basic block in program
4834 given basic block needs to have to be considered hot.
4835
4836 @item hot-bb-frequency-fraction
4837 Select fraction of the maximal frequency of executions of basic block in
4838 function given basic block needs to have to be considered hot
4839
4840 @item tracer-dynamic-coverage
4841 @itemx tracer-dynamic-coverage-feedback
4842
4843 This value is used to limit superblock formation once the given percentage of
4844 executed instructions is covered.  This limits unnecessary code size
4845 expansion.
4846
4847 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4848 feedback is available.  The real profiles (as opposed to statically estimated
4849 ones) are much less balanced allowing the threshold to be larger value.
4850
4851 @item tracer-max-code-growth
4852 Stop tail duplication once code growth has reached given percentage.  This is
4853 rather hokey argument, as most of the duplicates will be eliminated later in
4854 cross jumping, so it may be set to much higher values than is the desired code
4855 growth.
4856
4857 @item tracer-min-branch-ratio
4858
4859 Stop reverse growth when the reverse probability of best edge is less than this
4860 threshold (in percent).
4861
4862 @item tracer-min-branch-ratio
4863 @itemx tracer-min-branch-ratio-feedback
4864
4865 Stop forward growth if the best edge do have probability lower than this
4866 threshold.
4867
4868 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4869 compilation for profile feedback and one for compilation without.  The value
4870 for compilation with profile feedback needs to be more conservative (higher) in
4871 order to make tracer effective.
4872
4873 @item max-cse-path-length
4874
4875 Maximum number of basic blocks on path that cse considers.
4876
4877 @item ggc-min-expand
4878
4879 GCC uses a garbage collector to manage its own memory allocation.  This
4880 parameter specifies the minimum percentage by which the garbage
4881 collector's heap should be allowed to expand between collections.
4882 Tuning this may improve compilation speed; it has no effect on code
4883 generation.
4884
4885 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4886 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4887 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4888 GCC is not able to calculate RAM on a particular platform, the lower
4889 bound of 30% is used.  Setting this parameter and
4890 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4891 every opportunity.  This is extremely slow, but can be useful for
4892 debugging.
4893
4894 @item ggc-min-heapsize
4895
4896 Minimum size of the garbage collector's heap before it begins bothering
4897 to collect garbage.  The first collection occurs after the heap expands
4898 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4899 tuning this may improve compilation speed, and has no effect on code
4900 generation.
4901
4902 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4903 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4904 available, the notion of "RAM" is the smallest of actual RAM,
4905 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4906 RAM on a particular platform, the lower bound is used.  Setting this
4907 parameter very large effectively disables garbage collection.  Setting
4908 this parameter and @option{ggc-min-expand} to zero causes a full
4909 collection to occur at every opportunity.
4910
4911 @item reorder-blocks-duplicate
4912 @itemx reorder-blocks-duplicate-feedback
4913
4914 Used by basic block reordering pass to decide whether to use unconditional
4915 branch or duplicate the code on its destination.  Code is duplicated when its
4916 estimated size is smaller than this value multiplied by the estimated size of
4917 unconditional jump in the hot spots of the program.
4918
4919 The @option{reorder-block-duplicate-feedback} is used only when profile
4920 feedback is available and may be set to higher values than
4921 @option{reorder-block-duplicate} since information about the hot spots is more
4922 accurate.
4923 @end table
4924 @end table
4925
4926 @node Preprocessor Options
4927 @section Options Controlling the Preprocessor
4928 @cindex preprocessor options
4929 @cindex options, preprocessor
4930
4931 These options control the C preprocessor, which is run on each C source
4932 file before actual compilation.
4933
4934 If you use the @option{-E} option, nothing is done except preprocessing.
4935 Some of these options make sense only together with @option{-E} because
4936 they cause the preprocessor output to be unsuitable for actual
4937 compilation.
4938
4939 @table @gcctabopt
4940 @opindex Wp
4941 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4942 and pass @var{option} directly through to the preprocessor.  If
4943 @var{option} contains commas, it is split into multiple options at the
4944 commas.  However, many options are modified, translated or interpreted
4945 by the compiler driver before being passed to the preprocessor, and
4946 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4947 interface is undocumented and subject to change, so whenever possible
4948 you should avoid using @option{-Wp} and let the driver handle the
4949 options instead.
4950
4951 @item -Xpreprocessor @var{option}
4952 @opindex preprocessor
4953 Pass @var{option} as an option to the preprocessor.  You can use this to
4954 supply system-specific preprocessor options which GCC does not know how to
4955 recognize.
4956
4957 If you want to pass an option that takes an argument, you must use
4958 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4959 @end table
4960
4961 @include cppopts.texi
4962
4963 @node Assembler Options
4964 @section Passing Options to the Assembler
4965
4966 @c prevent bad page break with this line
4967 You can pass options to the assembler.
4968
4969 @table @gcctabopt
4970 @item -Wa,@var{option}
4971 @opindex Wa
4972 Pass @var{option} as an option to the assembler.  If @var{option}
4973 contains commas, it is split into multiple options at the commas.
4974
4975 @item -Xassembler @var{option}
4976 @opindex Xassembler
4977 Pass @var{option} as an option to the assembler.  You can use this to
4978 supply system-specific assembler options which GCC does not know how to
4979 recognize.
4980
4981 If you want to pass an option that takes an argument, you must use
4982 @option{-Xassembler} twice, once for the option and once for the argument.
4983
4984 @end table
4985
4986 @node Link Options
4987 @section Options for Linking
4988 @cindex link options
4989 @cindex options, linking
4990
4991 These options come into play when the compiler links object files into
4992 an executable output file.  They are meaningless if the compiler is
4993 not doing a link step.
4994
4995 @table @gcctabopt
4996 @cindex file names
4997 @item @var{object-file-name}
4998 A file name that does not end in a special recognized suffix is
4999 considered to name an object file or library.  (Object files are
5000 distinguished from libraries by the linker according to the file
5001 contents.)  If linking is done, these object files are used as input
5002 to the linker.
5003
5004 @item -c
5005 @itemx -S
5006 @itemx -E
5007 @opindex c
5008 @opindex S
5009 @opindex E
5010 If any of these options is used, then the linker is not run, and
5011 object file names should not be used as arguments.  @xref{Overall
5012 Options}.
5013
5014 @cindex Libraries
5015 @item -l@var{library}
5016 @itemx -l @var{library}
5017 @opindex l
5018 Search the library named @var{library} when linking.  (The second
5019 alternative with the library as a separate argument is only for
5020 POSIX compliance and is not recommended.)
5021
5022 It makes a difference where in the command you write this option; the
5023 linker searches and processes libraries and object files in the order they
5024 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5025 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5026 to functions in @samp{z}, those functions may not be loaded.
5027
5028 The linker searches a standard list of directories for the library,
5029 which is actually a file named @file{lib@var{library}.a}.  The linker
5030 then uses this file as if it had been specified precisely by name.
5031
5032 The directories searched include several standard system directories
5033 plus any that you specify with @option{-L}.
5034
5035 Normally the files found this way are library files---archive files
5036 whose members are object files.  The linker handles an archive file by
5037 scanning through it for members which define symbols that have so far
5038 been referenced but not defined.  But if the file that is found is an
5039 ordinary object file, it is linked in the usual fashion.  The only
5040 difference between using an @option{-l} option and specifying a file name
5041 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5042 and searches several directories.
5043
5044 @item -lobjc
5045 @opindex lobjc
5046 You need this special case of the @option{-l} option in order to
5047 link an Objective-C program.
5048
5049 @item -nostartfiles
5050 @opindex nostartfiles
5051 Do not use the standard system startup files when linking.
5052 The standard system libraries are used normally, unless @option{-nostdlib}
5053 or @option{-nodefaultlibs} is used.
5054
5055 @item -nodefaultlibs
5056 @opindex nodefaultlibs
5057 Do not use the standard system libraries when linking.
5058 Only the libraries you specify will be passed to the linker.
5059 The standard startup files are used normally, unless @option{-nostartfiles}
5060 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5061 for System V (and ISO C) environments or to bcopy and bzero for
5062 BSD environments.  These entries are usually resolved by entries in
5063 libc.  These entry points should be supplied through some other
5064 mechanism when this option is specified.
5065
5066 @item -nostdlib
5067 @opindex nostdlib
5068 Do not use the standard system startup files or libraries when linking.
5069 No startup files and only the libraries you specify will be passed to
5070 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5071 for System V (and ISO C) environments or to bcopy and bzero for
5072 BSD environments.  These entries are usually resolved by entries in
5073 libc.  These entry points should be supplied through some other
5074 mechanism when this option is specified.
5075
5076 @cindex @option{-lgcc}, use with @option{-nostdlib}
5077 @cindex @option{-nostdlib} and unresolved references
5078 @cindex unresolved references and @option{-nostdlib}
5079 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5080 @cindex @option{-nodefaultlibs} and unresolved references
5081 @cindex unresolved references and @option{-nodefaultlibs}
5082 One of the standard libraries bypassed by @option{-nostdlib} and
5083 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5084 that GCC uses to overcome shortcomings of particular machines, or special
5085 needs for some languages.
5086 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5087 Collection (GCC) Internals},
5088 for more discussion of @file{libgcc.a}.)
5089 In most cases, you need @file{libgcc.a} even when you want to avoid
5090 other standard libraries.  In other words, when you specify @option{-nostdlib}
5091 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5092 This ensures that you have no unresolved references to internal GCC
5093 library subroutines.  (For example, @samp{__main}, used to ensure C++
5094 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5095 GNU Compiler Collection (GCC) Internals}.)
5096
5097 @item -pie
5098 @opindex pie
5099 Produce a position independent executable on targets which support it.
5100 For predictable results, you must also specify the same set of options
5101 that were used to generate code (@option{-fpie}, @option{-fPIE},
5102 or model suboptions) when you specify this option.
5103
5104 @item -s
5105 @opindex s
5106 Remove all symbol table and relocation information from the executable.
5107
5108 @item -static
5109 @opindex static
5110 On systems that support dynamic linking, this prevents linking with the shared
5111 libraries.  On other systems, this option has no effect.
5112
5113 @item -shared
5114 @opindex shared
5115 Produce a shared object which can then be linked with other objects to
5116 form an executable.  Not all systems support this option.  For predictable
5117 results, you must also specify the same set of options that were used to
5118 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5119 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5120 needs to build supplementary stub code for constructors to work.  On
5121 multi-libbed systems, @samp{gcc -shared} must select the correct support
5122 libraries to link against.  Failing to supply the correct flags may lead
5123 to subtle defects.  Supplying them in cases where they are not necessary
5124 is innocuous.}
5125
5126 @item -shared-libgcc
5127 @itemx -static-libgcc
5128 @opindex shared-libgcc
5129 @opindex static-libgcc
5130 On systems that provide @file{libgcc} as a shared library, these options
5131 force the use of either the shared or static version respectively.
5132 If no shared version of @file{libgcc} was built when the compiler was
5133 configured, these options have no effect.
5134
5135 There are several situations in which an application should use the
5136 shared @file{libgcc} instead of the static version.  The most common
5137 of these is when the application wishes to throw and catch exceptions
5138 across different shared libraries.  In that case, each of the libraries
5139 as well as the application itself should use the shared @file{libgcc}.
5140
5141 Therefore, the G++ and GCJ drivers automatically add
5142 @option{-shared-libgcc} whenever you build a shared library or a main
5143 executable, because C++ and Java programs typically use exceptions, so
5144 this is the right thing to do.
5145
5146 If, instead, you use the GCC driver to create shared libraries, you may
5147 find that they will not always be linked with the shared @file{libgcc}.
5148 If GCC finds, at its configuration time, that you have a GNU linker that
5149 does not support option @option{--eh-frame-hdr}, it will link the shared
5150 version of @file{libgcc} into shared libraries by default.  Otherwise,
5151 it will take advantage of the linker and optimize away the linking with
5152 the shared version of @file{libgcc}, linking with the static version of
5153 libgcc by default.  This allows exceptions to propagate through such
5154 shared libraries, without incurring relocation costs at library load
5155 time.
5156
5157 However, if a library or main executable is supposed to throw or catch
5158 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5159 for the languages used in the program, or using the option
5160 @option{-shared-libgcc}, such that it is linked with the shared
5161 @file{libgcc}.
5162
5163 @item -symbolic
5164 @opindex symbolic
5165 Bind references to global symbols when building a shared object.  Warn
5166 about any unresolved references (unless overridden by the link editor
5167 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5168 this option.
5169
5170 @item -Xlinker @var{option}
5171 @opindex Xlinker
5172 Pass @var{option} as an option to the linker.  You can use this to
5173 supply system-specific linker options which GCC does not know how to
5174 recognize.
5175
5176 If you want to pass an option that takes an argument, you must use
5177 @option{-Xlinker} twice, once for the option and once for the argument.
5178 For example, to pass @option{-assert definitions}, you must write
5179 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5180 @option{-Xlinker "-assert definitions"}, because this passes the entire
5181 string as a single argument, which is not what the linker expects.
5182
5183 @item -Wl,@var{option}
5184 @opindex Wl
5185 Pass @var{option} as an option to the linker.  If @var{option} contains
5186 commas, it is split into multiple options at the commas.
5187
5188 @item -u @var{symbol}
5189 @opindex u
5190 Pretend the symbol @var{symbol} is undefined, to force linking of
5191 library modules to define it.  You can use @option{-u} multiple times with
5192 different symbols to force loading of additional library modules.
5193 @end table
5194
5195 @node Directory Options
5196 @section Options for Directory Search
5197 @cindex directory options
5198 @cindex options, directory search
5199 @cindex search path
5200
5201 These options specify directories to search for header files, for
5202 libraries and for parts of the compiler:
5203
5204 @table @gcctabopt
5205 @item -I@var{dir}
5206 @opindex I
5207 Add the directory @var{dir} to the head of the list of directories to be
5208 searched for header files.  This can be used to override a system header
5209 file, substituting your own version, since these directories are
5210 searched before the system header file directories.  However, you should
5211 not use this option to add directories that contain vendor-supplied
5212 system header files (use @option{-isystem} for that).  If you use more than
5213 one @option{-I} option, the directories are scanned in left-to-right
5214 order; the standard system directories come after.
5215
5216 If a standard system include directory, or a directory specified with
5217 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5218 option will be ignored.  The directory will still be searched but as a
5219 system directory at its normal position in the system include chain.
5220 This is to ensure that GCC's procedure to fix buggy system headers and
5221 the ordering for the include_next directive are not inadvertently changed.
5222 If you really need to change the search order for system directories,
5223 use the @option{-nostdinc} and/or @option{-isystem} options.
5224
5225 @item -I-
5226 @opindex I-
5227 Any directories you specify with @option{-I} options before the @option{-I-}
5228 option are searched only for the case of @samp{#include "@var{file}"};
5229 they are not searched for @samp{#include <@var{file}>}.
5230
5231 If additional directories are specified with @option{-I} options after
5232 the @option{-I-}, these directories are searched for all @samp{#include}
5233 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5234 this way.)
5235
5236 In addition, the @option{-I-} option inhibits the use of the current
5237 directory (where the current input file came from) as the first search
5238 directory for @samp{#include "@var{file}"}.  There is no way to
5239 override this effect of @option{-I-}.  With @option{-I.} you can specify
5240 searching the directory which was current when the compiler was
5241 invoked.  That is not exactly the same as what the preprocessor does
5242 by default, but it is often satisfactory.
5243
5244 @option{-I-} does not inhibit the use of the standard system directories
5245 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5246 independent.
5247
5248 @item -L@var{dir}
5249 @opindex L
5250 Add directory @var{dir} to the list of directories to be searched
5251 for @option{-l}.
5252
5253 @item -B@var{prefix}
5254 @opindex B
5255 This option specifies where to find the executables, libraries,
5256 include files, and data files of the compiler itself.
5257
5258 The compiler driver program runs one or more of the subprograms
5259 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5260 @var{prefix} as a prefix for each program it tries to run, both with and
5261 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5262
5263 For each subprogram to be run, the compiler driver first tries the
5264 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5265 was not specified, the driver tries two standard prefixes, which are
5266 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5267 those results in a file name that is found, the unmodified program
5268 name is searched for using the directories specified in your
5269 @env{PATH} environment variable.
5270
5271 The compiler will check to see if the path provided by the @option{-B}
5272 refers to a directory, and if necessary it will add a directory
5273 separator character at the end of the path.
5274
5275 @option{-B} prefixes that effectively specify directory names also apply
5276 to libraries in the linker, because the compiler translates these
5277 options into @option{-L} options for the linker.  They also apply to
5278 includes files in the preprocessor, because the compiler translates these
5279 options into @option{-isystem} options for the preprocessor.  In this case,
5280 the compiler appends @samp{include} to the prefix.
5281
5282 The run-time support file @file{libgcc.a} can also be searched for using
5283 the @option{-B} prefix, if needed.  If it is not found there, the two
5284 standard prefixes above are tried, and that is all.  The file is left
5285 out of the link if it is not found by those means.
5286
5287 Another way to specify a prefix much like the @option{-B} prefix is to use
5288 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5289 Variables}.
5290
5291 As a special kludge, if the path provided by @option{-B} is
5292 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5293 9, then it will be replaced by @file{[dir/]include}.  This is to help
5294 with boot-strapping the compiler.
5295
5296 @item -specs=@var{file}
5297 @opindex specs
5298 Process @var{file} after the compiler reads in the standard @file{specs}
5299 file, in order to override the defaults that the @file{gcc} driver
5300 program uses when determining what switches to pass to @file{cc1},
5301 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5302 @option{-specs=@var{file}} can be specified on the command line, and they
5303 are processed in order, from left to right.
5304 @end table
5305
5306 @c man end
5307
5308 @node Spec Files
5309 @section Specifying subprocesses and the switches to pass to them
5310 @cindex Spec Files
5311
5312 @command{gcc} is a driver program.  It performs its job by invoking a
5313 sequence of other programs to do the work of compiling, assembling and
5314 linking.  GCC interprets its command-line parameters and uses these to
5315 deduce which programs it should invoke, and which command-line options
5316 it ought to place on their command lines.  This behavior is controlled
5317 by @dfn{spec strings}.  In most cases there is one spec string for each
5318 program that GCC can invoke, but a few programs have multiple spec
5319 strings to control their behavior.  The spec strings built into GCC can
5320 be overridden by using the @option{-specs=} command-line switch to specify
5321 a spec file.
5322
5323 @dfn{Spec files} are plaintext files that are used to construct spec
5324 strings.  They consist of a sequence of directives separated by blank
5325 lines.  The type of directive is determined by the first non-whitespace
5326 character on the line and it can be one of the following:
5327
5328 @table @code
5329 @item %@var{command}
5330 Issues a @var{command} to the spec file processor.  The commands that can
5331 appear here are:
5332
5333 @table @code
5334 @item %include <@var{file}>
5335 @cindex %include
5336 Search for @var{file} and insert its text at the current point in the
5337 specs file.
5338
5339 @item %include_noerr <@var{file}>
5340 @cindex %include_noerr
5341 Just like @samp{%include}, but do not generate an error message if the include
5342 file cannot be found.
5343
5344 @item %rename @var{old_name} @var{new_name}
5345 @cindex %rename
5346 Rename the spec string @var{old_name} to @var{new_name}.
5347
5348 @end table
5349
5350 @item *[@var{spec_name}]:
5351 This tells the compiler to create, override or delete the named spec
5352 string.  All lines after this directive up to the next directive or
5353 blank line are considered to be the text for the spec string.  If this
5354 results in an empty string then the spec will be deleted.  (Or, if the
5355 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5356 does not currently exist a new spec will be created.  If the spec does
5357 exist then its contents will be overridden by the text of this
5358 directive, unless the first character of that text is the @samp{+}
5359 character, in which case the text will be appended to the spec.
5360
5361 @item [@var{suffix}]:
5362 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5363 and up to the next directive or blank line are considered to make up the
5364 spec string for the indicated suffix.  When the compiler encounters an
5365 input file with the named suffix, it will processes the spec string in
5366 order to work out how to compile that file.  For example:
5367
5368 @smallexample
5369 .ZZ:
5370 z-compile -input %i
5371 @end smallexample
5372
5373 This says that any input file whose name ends in @samp{.ZZ} should be
5374 passed to the program @samp{z-compile}, which should be invoked with the
5375 command-line switch @option{-input} and with the result of performing the
5376 @samp{%i} substitution.  (See below.)
5377
5378 As an alternative to providing a spec string, the text that follows a
5379 suffix directive can be one of the following:
5380
5381 @table @code
5382 @item @@@var{language}
5383 This says that the suffix is an alias for a known @var{language}.  This is
5384 similar to using the @option{-x} command-line switch to GCC to specify a
5385 language explicitly.  For example:
5386
5387 @smallexample
5388 .ZZ:
5389 @@c++
5390 @end smallexample
5391
5392 Says that .ZZ files are, in fact, C++ source files.
5393
5394 @item #@var{name}
5395 This causes an error messages saying:
5396
5397 @smallexample
5398 @var{name} compiler not installed on this system.
5399 @end smallexample
5400 @end table
5401
5402 GCC already has an extensive list of suffixes built into it.
5403 This directive will add an entry to the end of the list of suffixes, but
5404 since the list is searched from the end backwards, it is effectively
5405 possible to override earlier entries using this technique.
5406
5407 @end table
5408
5409 GCC has the following spec strings built into it.  Spec files can
5410 override these strings or create their own.  Note that individual
5411 targets can also add their own spec strings to this list.
5412
5413 @smallexample
5414 asm          Options to pass to the assembler
5415 asm_final    Options to pass to the assembler post-processor
5416 cpp          Options to pass to the C preprocessor
5417 cc1          Options to pass to the C compiler
5418 cc1plus      Options to pass to the C++ compiler
5419 endfile      Object files to include at the end of the link
5420 link         Options to pass to the linker
5421 lib          Libraries to include on the command line to the linker
5422 libgcc       Decides which GCC support library to pass to the linker
5423 linker       Sets the name of the linker
5424 predefines   Defines to be passed to the C preprocessor
5425 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5426              by default
5427 startfile    Object files to include at the start of the link
5428 @end smallexample
5429
5430 Here is a small example of a spec file:
5431
5432 @smallexample
5433 %rename lib                 old_lib
5434
5435 *lib:
5436 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5437 @end smallexample
5438
5439 This example renames the spec called @samp{lib} to @samp{old_lib} and
5440 then overrides the previous definition of @samp{lib} with a new one.
5441 The new definition adds in some extra command-line options before
5442 including the text of the old definition.
5443
5444 @dfn{Spec strings} are a list of command-line options to be passed to their
5445 corresponding program.  In addition, the spec strings can contain
5446 @samp{%}-prefixed sequences to substitute variable text or to
5447 conditionally insert text into the command line.  Using these constructs
5448 it is possible to generate quite complex command lines.
5449
5450 Here is a table of all defined @samp{%}-sequences for spec
5451 strings.  Note that spaces are not generated automatically around the
5452 results of expanding these sequences.  Therefore you can concatenate them
5453 together or combine them with constant text in a single argument.
5454
5455 @table @code
5456 @item %%
5457 Substitute one @samp{%} into the program name or argument.
5458
5459 @item %i
5460 Substitute the name of the input file being processed.
5461
5462 @item %b
5463 Substitute the basename of the input file being processed.
5464 This is the substring up to (and not including) the last period
5465 and not including the directory.
5466
5467 @item %B
5468 This is the same as @samp{%b}, but include the file suffix (text after
5469 the last period).
5470
5471 @item %d
5472 Marks the argument containing or following the @samp{%d} as a
5473 temporary file name, so that that file will be deleted if GCC exits
5474 successfully.  Unlike @samp{%g}, this contributes no text to the
5475 argument.
5476
5477 @item %g@var{suffix}
5478 Substitute a file name that has suffix @var{suffix} and is chosen
5479 once per compilation, and mark the argument in the same way as
5480 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5481 name is now chosen in a way that is hard to predict even when previously
5482 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5483 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5484 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5485 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5486 was simply substituted with a file name chosen once per compilation,
5487 without regard to any appended suffix (which was therefore treated
5488 just like ordinary text), making such attacks more likely to succeed.
5489
5490 @item %u@var{suffix}
5491 Like @samp{%g}, but generates a new temporary file name even if
5492 @samp{%u@var{suffix}} was already seen.
5493
5494 @item %U@var{suffix}
5495 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5496 new one if there is no such last file name.  In the absence of any
5497 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5498 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5499 would involve the generation of two distinct file names, one
5500 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5501 simply substituted with a file name chosen for the previous @samp{%u},
5502 without regard to any appended suffix.
5503
5504 @item %j@var{suffix}
5505 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5506 writable, and if save-temps is off; otherwise, substitute the name
5507 of a temporary file, just like @samp{%u}.  This temporary file is not
5508 meant for communication between processes, but rather as a junk
5509 disposal mechanism.
5510
5511 @item %|@var{suffix}
5512 @itemx %m@var{suffix}
5513 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5514 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5515 all.  These are the two most common ways to instruct a program that it
5516 should read from standard input or write to standard output.  If you
5517 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5518 construct: see for example @file{f/lang-specs.h}.
5519
5520 @item %.@var{SUFFIX}
5521 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5522 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5523 terminated by the next space or %.
5524
5525 @item %w
5526 Marks the argument containing or following the @samp{%w} as the
5527 designated output file of this compilation.  This puts the argument
5528 into the sequence of arguments that @samp{%o} will substitute later.
5529
5530 @item %o
5531 Substitutes the names of all the output files, with spaces
5532 automatically placed around them.  You should write spaces
5533 around the @samp{%o} as well or the results are undefined.
5534 @samp{%o} is for use in the specs for running the linker.
5535 Input files whose names have no recognized suffix are not compiled
5536 at all, but they are included among the output files, so they will
5537 be linked.
5538
5539 @item %O
5540 Substitutes the suffix for object files.  Note that this is
5541 handled specially when it immediately follows @samp{%g, %u, or %U},
5542 because of the need for those to form complete file names.  The
5543 handling is such that @samp{%O} is treated exactly as if it had already
5544 been substituted, except that @samp{%g, %u, and %U} do not currently
5545 support additional @var{suffix} characters following @samp{%O} as they would
5546 following, for example, @samp{.o}.
5547
5548 @item %p
5549 Substitutes the standard macro predefinitions for the
5550 current target machine.  Use this when running @code{cpp}.
5551
5552 @item %P
5553 Like @samp{%p}, but puts @samp{__} before and after the name of each
5554 predefined macro, except for macros that start with @samp{__} or with
5555 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5556 C@.
5557
5558 @item %I
5559 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5560 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5561 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5562 as necessary.
5563
5564 @item %s
5565 Current argument is the name of a library or startup file of some sort.
5566 Search for that file in a standard list of directories and substitute
5567 the full name found.
5568
5569 @item %e@var{str}
5570 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5571 Use this when inconsistent options are detected.
5572
5573 @item %(@var{name})
5574 Substitute the contents of spec string @var{name} at this point.
5575
5576 @item %[@var{name}]
5577 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5578
5579 @item %x@{@var{option}@}
5580 Accumulate an option for @samp{%X}.
5581
5582 @item %X
5583 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5584 spec string.
5585
5586 @item %Y
5587 Output the accumulated assembler options specified by @option{-Wa}.
5588
5589 @item %Z
5590 Output the accumulated preprocessor options specified by @option{-Wp}.
5591
5592 @item %a
5593 Process the @code{asm} spec.  This is used to compute the
5594 switches to be passed to the assembler.
5595
5596 @item %A
5597 Process the @code{asm_final} spec.  This is a spec string for
5598 passing switches to an assembler post-processor, if such a program is
5599 needed.
5600
5601 @item %l
5602 Process the @code{link} spec.  This is the spec for computing the
5603 command line passed to the linker.  Typically it will make use of the
5604 @samp{%L %G %S %D and %E} sequences.
5605
5606 @item %D
5607 Dump out a @option{-L} option for each directory that GCC believes might
5608 contain startup files.  If the target supports multilibs then the
5609 current multilib directory will be prepended to each of these paths.
5610
5611 @item %M
5612 Output the multilib directory with directory separators replaced with
5613 @samp{_}.  If multilib directories are not set, or the multilib directory is
5614 @file{.} then this option emits nothing.
5615
5616 @item %L
5617 Process the @code{lib} spec.  This is a spec string for deciding which
5618 libraries should be included on the command line to the linker.
5619
5620 @item %G
5621 Process the @code{libgcc} spec.  This is a spec string for deciding
5622 which GCC support library should be included on the command line to the linker.
5623
5624 @item %S
5625 Process the @code{startfile} spec.  This is a spec for deciding which
5626 object files should be the first ones passed to the linker.  Typically
5627 this might be a file named @file{crt0.o}.
5628
5629 @item %E
5630 Process the @code{endfile} spec.  This is a spec string that specifies
5631 the last object files that will be passed to the linker.
5632
5633 @item %C
5634 Process the @code{cpp} spec.  This is used to construct the arguments
5635 to be passed to the C preprocessor.
5636
5637 @item %c
5638 Process the @code{signed_char} spec.  This is intended to be used
5639 to tell cpp whether a char is signed.  It typically has the definition:
5640 @smallexample
5641 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5642 @end smallexample
5643
5644 @item %1
5645 Process the @code{cc1} spec.  This is used to construct the options to be
5646 passed to the actual C compiler (@samp{cc1}).
5647
5648 @item %2
5649 Process the @code{cc1plus} spec.  This is used to construct the options to be
5650 passed to the actual C++ compiler (@samp{cc1plus}).
5651
5652 @item %*
5653 Substitute the variable part of a matched option.  See below.
5654 Note that each comma in the substituted string is replaced by
5655 a single space.
5656
5657 @item %<@code{S}
5658 Remove all occurrences of @code{-S} from the command line.  Note---this
5659 command is position dependent.  @samp{%} commands in the spec string
5660 before this one will see @code{-S}, @samp{%} commands in the spec string
5661 after this one will not.
5662
5663 @item %:@var{function}(@var{args})
5664 Call the named function @var{function}, passing it @var{args}.
5665 @var{args} is first processed as a nested spec string, then split
5666 into an argument vector in the usual fashion.  The function returns
5667 a string which is processed as if it had appeared literally as part
5668 of the current spec.
5669
5670 The following built-in spec functions are provided:
5671
5672 @table @code
5673 @item @code{if-exists}
5674 The @code{if-exists} spec function takes one argument, an absolute
5675 pathname to a file.  If the file exists, @code{if-exists} returns the
5676 pathname.  Here is a small example of its usage:
5677
5678 @smallexample
5679 *startfile:
5680 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5681 @end smallexample
5682
5683 @item @code{if-exists-else}
5684 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5685 spec function, except that it takes two arguments.  The first argument is
5686 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5687 returns the pathname.  If it does not exist, it returns the second argument.
5688 This way, @code{if-exists-else} can be used to select one file or another,
5689 based on the existence of the first.  Here is a small example of its usage:
5690
5691 @smallexample 
5692 *startfile:
5693 crt0%O%s %:if-exists(crti%O%s) \
5694 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5695 @end smallexample
5696 @end table 
5697
5698 @item %@{@code{S}@}
5699 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5700 If that switch was not specified, this substitutes nothing.  Note that
5701 the leading dash is omitted when specifying this option, and it is
5702 automatically inserted if the substitution is performed.  Thus the spec
5703 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5704 and would output the command line option @option{-foo}.
5705
5706 @item %W@{@code{S}@}
5707 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5708 deleted on failure.
5709
5710 @item %@{@code{S}*@}
5711 Substitutes all the switches specified to GCC whose names start
5712 with @code{-S}, but which also take an argument.  This is used for
5713 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5714 GCC considers @option{-o foo} as being
5715 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5716 text, including the space.  Thus two arguments would be generated.
5717
5718 @item %@{@code{S}*&@code{T}*@}
5719 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5720 (the order of @code{S} and @code{T} in the spec is not significant).
5721 There can be any number of ampersand-separated variables; for each the
5722 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5723
5724 @item %@{@code{S}:@code{X}@}
5725 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5726
5727 @item %@{!@code{S}:@code{X}@}
5728 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5729
5730 @item %@{@code{S}*:@code{X}@}
5731 Substitutes @code{X} if one or more switches whose names start with
5732 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5733 once, no matter how many such switches appeared.  However, if @code{%*}
5734 appears somewhere in @code{X}, then @code{X} will be substituted once
5735 for each matching switch, with the @code{%*} replaced by the part of
5736 that switch that matched the @code{*}.
5737
5738 @item %@{.@code{S}:@code{X}@}
5739 Substitutes @code{X}, if processing a file with suffix @code{S}.
5740
5741 @item %@{!.@code{S}:@code{X}@}
5742 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5743
5744 @item %@{@code{S}|@code{P}:@code{X}@}
5745 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5746 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5747 although they have a stronger binding than the @samp{|}.  If @code{%*}
5748 appears in @code{X}, all of the alternatives must be starred, and only
5749 the first matching alternative is substituted.
5750
5751 For example, a spec string like this:
5752
5753 @smallexample
5754 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5755 @end smallexample
5756
5757 will output the following command-line options from the following input
5758 command-line options:
5759
5760 @smallexample
5761 fred.c        -foo -baz
5762 jim.d         -bar -boggle
5763 -d fred.c     -foo -baz -boggle
5764 -d jim.d      -bar -baz -boggle
5765 @end smallexample
5766
5767 @item %@{S:X; T:Y; :D@}
5768
5769 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5770 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5771 be as many clauses as you need.  This may be combined with @code{.}, 
5772 @code{!}, @code{|}, and @code{*} as needed.
5773
5774
5775 @end table
5776
5777 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5778 construct may contain other nested @samp{%} constructs or spaces, or
5779 even newlines.  They are processed as usual, as described above.
5780 Trailing white space in @code{X} is ignored.  White space may also
5781 appear anywhere on the left side of the colon in these constructs,
5782 except between @code{.} or @code{*} and the corresponding word.
5783
5784 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5785 handled specifically in these constructs.  If another value of
5786 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5787 @option{-W} switch is found later in the command line, the earlier
5788 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5789 just one letter, which passes all matching options.
5790
5791 The character @samp{|} at the beginning of the predicate text is used to
5792 indicate that a command should be piped to the following command, but
5793 only if @option{-pipe} is specified.
5794
5795 It is built into GCC which switches take arguments and which do not.
5796 (You might think it would be useful to generalize this to allow each
5797 compiler's spec to say which switches take arguments.  But this cannot
5798 be done in a consistent fashion.  GCC cannot even decide which input
5799 files have been specified without knowing which switches take arguments,
5800 and it must know which input files to compile in order to tell which
5801 compilers to run).
5802
5803 GCC also knows implicitly that arguments starting in @option{-l} are to be
5804 treated as compiler output files, and passed to the linker in their
5805 proper position among the other output files.
5806
5807 @c man begin OPTIONS
5808
5809 @node Target Options
5810 @section Specifying Target Machine and Compiler Version
5811 @cindex target options
5812 @cindex cross compiling
5813 @cindex specifying machine version
5814 @cindex specifying compiler version and target machine
5815 @cindex compiler version, specifying
5816 @cindex target machine, specifying
5817
5818 The usual way to run GCC is to run the executable called @file{gcc}, or
5819 @file{<machine>-gcc} when cross-compiling, or
5820 @file{<machine>-gcc-<version>} to run a version other than the one that
5821 was installed last.  Sometimes this is inconvenient, so GCC provides
5822 options that will switch to another cross-compiler or version.
5823
5824 @table @gcctabopt
5825 @item -b @var{machine}
5826 @opindex b
5827 The argument @var{machine} specifies the target machine for compilation.
5828
5829 The value to use for @var{machine} is the same as was specified as the
5830 machine type when configuring GCC as a cross-compiler.  For
5831 example, if a cross-compiler was configured with @samp{configure
5832 i386v}, meaning to compile for an 80386 running System V, then you
5833 would specify @option{-b i386v} to run that cross compiler.
5834
5835 @item -V @var{version}
5836 @opindex V
5837 The argument @var{version} specifies which version of GCC to run.
5838 This is useful when multiple versions are installed.  For example,
5839 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5840 @end table
5841
5842 The @option{-V} and @option{-b} options work by running the
5843 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5844 use them if you can just run that directly.
5845
5846 @node Submodel Options
5847 @section Hardware Models and Configurations
5848 @cindex submodel options
5849 @cindex specifying hardware config
5850 @cindex hardware models and configurations, specifying
5851 @cindex machine dependent options
5852
5853 Earlier we discussed the standard option @option{-b} which chooses among
5854 different installed compilers for completely different target
5855 machines, such as VAX vs.@: 68000 vs.@: 80386.
5856
5857 In addition, each of these target machine types can have its own
5858 special options, starting with @samp{-m}, to choose among various
5859 hardware models or configurations---for example, 68010 vs 68020,
5860 floating coprocessor or none.  A single installed version of the
5861 compiler can compile for any model or configuration, according to the
5862 options specified.
5863
5864 Some configurations of the compiler also support additional special
5865 options, usually for compatibility with other compilers on the same
5866 platform.
5867
5868 These options are defined by the macro @code{TARGET_SWITCHES} in the
5869 machine description.  The default for the options is also defined by
5870 that macro, which enables you to change the defaults.
5871
5872 @menu
5873 * M680x0 Options::
5874 * M68hc1x Options::
5875 * VAX Options::
5876 * SPARC Options::
5877 * ARM Options::
5878 * MN10200 Options::
5879 * MN10300 Options::
5880 * M32R/D Options::
5881 * M88K Options::
5882 * RS/6000 and PowerPC Options::
5883 * Darwin Options::
5884 * RT Options::
5885 * MIPS Options::
5886 * i386 and x86-64 Options::
5887 * HPPA Options::
5888 * Intel 960 Options::
5889 * DEC Alpha Options::
5890 * DEC Alpha/VMS Options::
5891 * H8/300 Options::
5892 * SH Options::
5893 * System V Options::
5894 * TMS320C3x/C4x Options::
5895 * V850 Options::
5896 * ARC Options::
5897 * NS32K Options::
5898 * AVR Options::
5899 * MCore Options::
5900 * IA-64 Options::
5901 * D30V Options::
5902 * S/390 and zSeries Options::
5903 * CRIS Options::
5904 * MMIX Options::
5905 * PDP-11 Options::
5906 * Xstormy16 Options::
5907 * Xtensa Options::
5908 * FRV Options::
5909 @end menu
5910
5911 @node M680x0 Options
5912 @subsection M680x0 Options
5913 @cindex M680x0 options
5914
5915 These are the @samp{-m} options defined for the 68000 series.  The default
5916 values for these options depends on which style of 68000 was selected when
5917 the compiler was configured; the defaults for the most common choices are
5918 given below.
5919
5920 @table @gcctabopt
5921 @item -m68000
5922 @itemx -mc68000
5923 @opindex m68000
5924 @opindex mc68000
5925 Generate output for a 68000.  This is the default
5926 when the compiler is configured for 68000-based systems.
5927
5928 Use this option for microcontrollers with a 68000 or EC000 core,
5929 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5930
5931 @item -m68020
5932 @itemx -mc68020
5933 @opindex m68020
5934 @opindex mc68020
5935 Generate output for a 68020.  This is the default
5936 when the compiler is configured for 68020-based systems.
5937
5938 @item -m68881
5939 @opindex m68881
5940 Generate output containing 68881 instructions for floating point.
5941 This is the default for most 68020 systems unless @option{--nfp} was
5942 specified when the compiler was configured.
5943
5944 @item -m68030
5945 @opindex m68030
5946 Generate output for a 68030.  This is the default when the compiler is
5947 configured for 68030-based systems.
5948
5949 @item -m68040
5950 @opindex m68040
5951 Generate output for a 68040.  This is the default when the compiler is
5952 configured for 68040-based systems.
5953
5954 This option inhibits the use of 68881/68882 instructions that have to be
5955 emulated by software on the 68040.  Use this option if your 68040 does not
5956 have code to emulate those instructions.
5957
5958 @item -m68060
5959 @opindex m68060
5960 Generate output for a 68060.  This is the default when the compiler is
5961 configured for 68060-based systems.
5962
5963 This option inhibits the use of 68020 and 68881/68882 instructions that
5964 have to be emulated by software on the 68060.  Use this option if your 68060
5965 does not have code to emulate those instructions.
5966
5967 @item -mcpu32
5968 @opindex mcpu32
5969 Generate output for a CPU32.  This is the default
5970 when the compiler is configured for CPU32-based systems.
5971
5972 Use this option for microcontrollers with a
5973 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5974 68336, 68340, 68341, 68349 and 68360.
5975
5976 @item -m5200
5977 @opindex m5200
5978 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5979 when the compiler is configured for 520X-based systems.
5980
5981 Use this option for microcontroller with a 5200 core, including
5982 the MCF5202, MCF5203, MCF5204 and MCF5202.
5983
5984
5985 @item -m68020-40
5986 @opindex m68020-40
5987 Generate output for a 68040, without using any of the new instructions.
5988 This results in code which can run relatively efficiently on either a
5989 68020/68881 or a 68030 or a 68040.  The generated code does use the
5990 68881 instructions that are emulated on the 68040.
5991
5992 @item -m68020-60
5993 @opindex m68020-60
5994 Generate output for a 68060, without using any of the new instructions.
5995 This results in code which can run relatively efficiently on either a
5996 68020/68881 or a 68030 or a 68040.  The generated code does use the
5997 68881 instructions that are emulated on the 68060.
5998
5999 @item -msoft-float
6000 @opindex msoft-float
6001 Generate output containing library calls for floating point.
6002 @strong{Warning:} the requisite libraries are not available for all m68k
6003 targets.  Normally the facilities of the machine's usual C compiler are
6004 used, but this can't be done directly in cross-compilation.  You must
6005 make your own arrangements to provide suitable library functions for
6006 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
6007 @samp{m68k-*-coff} do provide software floating point support.
6008
6009 @item -mshort
6010 @opindex mshort
6011 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6012
6013 @item -mnobitfield
6014 @opindex mnobitfield
6015 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
6016 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
6017
6018 @item -mbitfield
6019 @opindex mbitfield
6020 Do use the bit-field instructions.  The @option{-m68020} option implies
6021 @option{-mbitfield}.  This is the default if you use a configuration
6022 designed for a 68020.
6023
6024 @item -mrtd
6025 @opindex mrtd
6026 Use a different function-calling convention, in which functions
6027 that take a fixed number of arguments return with the @code{rtd}
6028 instruction, which pops their arguments while returning.  This
6029 saves one instruction in the caller since there is no need to pop
6030 the arguments there.
6031
6032 This calling convention is incompatible with the one normally
6033 used on Unix, so you cannot use it if you need to call libraries
6034 compiled with the Unix compiler.
6035
6036 Also, you must provide function prototypes for all functions that
6037 take variable numbers of arguments (including @code{printf});
6038 otherwise incorrect code will be generated for calls to those
6039 functions.
6040
6041 In addition, seriously incorrect code will result if you call a
6042 function with too many arguments.  (Normally, extra arguments are
6043 harmlessly ignored.)
6044
6045 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6046 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6047
6048 @item -malign-int
6049 @itemx -mno-align-int
6050 @opindex malign-int
6051 @opindex mno-align-int
6052 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6053 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6054 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6055 Aligning variables on 32-bit boundaries produces code that runs somewhat
6056 faster on processors with 32-bit busses at the expense of more memory.
6057
6058 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6059 align structures containing the above types  differently than
6060 most published application binary interface specifications for the m68k.
6061
6062 @item -mpcrel
6063 @opindex mpcrel
6064 Use the pc-relative addressing mode of the 68000 directly, instead of
6065 using a global offset table.  At present, this option implies @option{-fpic},
6066 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6067 not presently supported with @option{-mpcrel}, though this could be supported for
6068 68020 and higher processors.
6069
6070 @item -mno-strict-align
6071 @itemx -mstrict-align
6072 @opindex mno-strict-align
6073 @opindex mstrict-align
6074 Do not (do) assume that unaligned memory references will be handled by
6075 the system.
6076
6077 @end table
6078
6079 @node M68hc1x Options
6080 @subsection M68hc1x Options
6081 @cindex M68hc1x options
6082
6083 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6084 microcontrollers.  The default values for these options depends on
6085 which style of microcontroller was selected when the compiler was configured;
6086 the defaults for the most common choices are given below.
6087
6088 @table @gcctabopt
6089 @item -m6811
6090 @itemx -m68hc11
6091 @opindex m6811
6092 @opindex m68hc11
6093 Generate output for a 68HC11.  This is the default
6094 when the compiler is configured for 68HC11-based systems.
6095
6096 @item -m6812
6097 @itemx -m68hc12
6098 @opindex m6812
6099 @opindex m68hc12
6100 Generate output for a 68HC12.  This is the default
6101 when the compiler is configured for 68HC12-based systems.
6102
6103 @item -m68S12
6104 @itemx -m68hcs12
6105 @opindex m68S12
6106 @opindex m68hcs12
6107 Generate output for a 68HCS12.  
6108
6109 @item -mauto-incdec
6110 @opindex mauto-incdec
6111 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6112 addressing modes.
6113
6114 @item -minmax
6115 @itemx -nominmax
6116 @opindex minmax
6117 @opindex mnominmax
6118 Enable the use of 68HC12 min and max instructions.
6119
6120 @item -mlong-calls
6121 @itemx -mno-long-calls
6122 @opindex mlong-calls
6123 @opindex mno-long-calls
6124 Treat all calls as being far away (near).  If calls are assumed to be
6125 far away, the compiler will use the @code{call} instruction to
6126 call a function and the @code{rtc} instruction for returning.
6127
6128 @item -mshort
6129 @opindex mshort
6130 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6131
6132 @item -msoft-reg-count=@var{count}
6133 @opindex msoft-reg-count
6134 Specify the number of pseudo-soft registers which are used for the
6135 code generation.  The maximum number is 32.  Using more pseudo-soft
6136 register may or may not result in better code depending on the program.
6137 The default is 4 for 68HC11 and 2 for 68HC12.
6138
6139 @end table
6140
6141 @node VAX Options
6142 @subsection VAX Options
6143 @cindex VAX options
6144
6145 These @samp{-m} options are defined for the VAX:
6146
6147 @table @gcctabopt
6148 @item -munix
6149 @opindex munix
6150 Do not output certain jump instructions (@code{aobleq} and so on)
6151 that the Unix assembler for the VAX cannot handle across long
6152 ranges.
6153
6154 @item -mgnu
6155 @opindex mgnu
6156 Do output those jump instructions, on the assumption that you
6157 will assemble with the GNU assembler.
6158
6159 @item -mg
6160 @opindex mg
6161 Output code for g-format floating point numbers instead of d-format.
6162 @end table
6163
6164 @node SPARC Options
6165 @subsection SPARC Options
6166 @cindex SPARC options
6167
6168 These @samp{-m} switches are supported on the SPARC:
6169
6170 @table @gcctabopt
6171 @item -mno-app-regs
6172 @itemx -mapp-regs
6173 @opindex mno-app-regs
6174 @opindex mapp-regs
6175 Specify @option{-mapp-regs} to generate output using the global registers
6176 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6177 is the default.
6178
6179 To be fully SVR4 ABI compliant at the cost of some performance loss,
6180 specify @option{-mno-app-regs}.  You should compile libraries and system
6181 software with this option.
6182
6183 @item -mfpu
6184 @itemx -mhard-float
6185 @opindex mfpu
6186 @opindex mhard-float
6187 Generate output containing floating point instructions.  This is the
6188 default.
6189
6190 @item -mno-fpu
6191 @itemx -msoft-float
6192 @opindex mno-fpu
6193 @opindex msoft-float
6194 Generate output containing library calls for floating point.
6195 @strong{Warning:} the requisite libraries are not available for all SPARC
6196 targets.  Normally the facilities of the machine's usual C compiler are
6197 used, but this cannot be done directly in cross-compilation.  You must make
6198 your own arrangements to provide suitable library functions for
6199 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6200 @samp{sparclite-*-*} do provide software floating point support.
6201
6202 @option{-msoft-float} changes the calling convention in the output file;
6203 therefore, it is only useful if you compile @emph{all} of a program with
6204 this option.  In particular, you need to compile @file{libgcc.a}, the
6205 library that comes with GCC, with @option{-msoft-float} in order for
6206 this to work.
6207
6208 @item -mhard-quad-float
6209 @opindex mhard-quad-float
6210 Generate output containing quad-word (long double) floating point
6211 instructions.
6212
6213 @item -msoft-quad-float
6214 @opindex msoft-quad-float
6215 Generate output containing library calls for quad-word (long double)
6216 floating point instructions.  The functions called are those specified
6217 in the SPARC ABI@.  This is the default.
6218
6219 As of this writing, there are no sparc implementations that have hardware
6220 support for the quad-word floating point instructions.  They all invoke
6221 a trap handler for one of these instructions, and then the trap handler
6222 emulates the effect of the instruction.  Because of the trap handler overhead,
6223 this is much slower than calling the ABI library routines.  Thus the
6224 @option{-msoft-quad-float} option is the default.
6225
6226 @item -mno-flat
6227 @itemx -mflat
6228 @opindex mno-flat
6229 @opindex mflat
6230 With @option{-mflat}, the compiler does not generate save/restore instructions
6231 and will use a ``flat'' or single register window calling convention.
6232 This model uses %i7 as the frame pointer and is compatible with the normal
6233 register window model.  Code from either may be intermixed.
6234 The local registers and the input registers (0--5) are still treated as
6235 ``call saved'' registers and will be saved on the stack as necessary.
6236
6237 With @option{-mno-flat} (the default), the compiler emits save/restore
6238 instructions (except for leaf functions) and is the normal mode of operation.
6239
6240 @item -mno-unaligned-doubles
6241 @itemx -munaligned-doubles
6242 @opindex mno-unaligned-doubles
6243 @opindex munaligned-doubles
6244 Assume that doubles have 8 byte alignment.  This is the default.
6245
6246 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6247 alignment only if they are contained in another type, or if they have an
6248 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6249 Specifying this option avoids some rare compatibility problems with code
6250 generated by other compilers.  It is not the default because it results
6251 in a performance loss, especially for floating point code.
6252
6253 @item -mno-faster-structs
6254 @itemx -mfaster-structs
6255 @opindex mno-faster-structs
6256 @opindex mfaster-structs
6257 With @option{-mfaster-structs}, the compiler assumes that structures
6258 should have 8 byte alignment.  This enables the use of pairs of
6259 @code{ldd} and @code{std} instructions for copies in structure
6260 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6261 However, the use of this changed alignment directly violates the SPARC
6262 ABI@.  Thus, it's intended only for use on targets where the developer
6263 acknowledges that their resulting code will not be directly in line with
6264 the rules of the ABI@.
6265
6266 @item -mimpure-text
6267 @opindex mimpure-text
6268 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6269 the compiler to not pass @option{-z text} to the linker when linking a
6270 shared object.  Using this option, you can link position-dependent
6271 code into a shared object.  
6272
6273 @option{-mimpure-text} suppresses the ``relocations remain against
6274 allocatable but non-writable sections'' linker error message.
6275 However, the necessary relocations will trigger copy-on-write, and the
6276 shared object is not actually shared across processes.  Instead of
6277 using @option{-mimpure-text}, you should compile all source code with
6278 @option{-fpic} or @option{-fPIC}.
6279
6280 This option is only available on SunOS and Solaris.
6281
6282 @item -mv8
6283 @itemx -msparclite
6284 @opindex mv8
6285 @opindex msparclite
6286 These two options select variations on the SPARC architecture.
6287
6288 By default (unless specifically configured for the Fujitsu SPARClite),
6289 GCC generates code for the v7 variant of the SPARC architecture.
6290
6291 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6292 code is that the compiler emits the integer multiply and integer
6293 divide instructions which exist in SPARC v8 but not in SPARC v7.
6294
6295 @option{-msparclite} will give you SPARClite code.  This adds the integer
6296 multiply, integer divide step and scan (@code{ffs}) instructions which
6297 exist in SPARClite but not in SPARC v7.
6298
6299 These options are deprecated and will be deleted in a future GCC release.
6300 They have been replaced with @option{-mcpu=xxx}.
6301
6302 @item -mcypress
6303 @itemx -msupersparc
6304 @opindex mcypress
6305 @opindex msupersparc
6306 These two options select the processor for which the code is optimized.
6307
6308 With @option{-mcypress} (the default), the compiler optimizes code for the
6309 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6310 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6311
6312 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6313 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6314 of the full SPARC v8 instruction set.
6315
6316 These options are deprecated and will be deleted in a future GCC release.
6317 They have been replaced with @option{-mcpu=xxx}.
6318
6319 @item -mcpu=@var{cpu_type}
6320 @opindex mcpu
6321 Set the instruction set, register set, and instruction scheduling parameters
6322 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6323 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6324 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6325 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6326 @samp{ultrasparc3}.
6327
6328 Default instruction scheduling parameters are used for values that select
6329 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6330 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6331
6332 Here is a list of each supported architecture and their supported
6333 implementations.
6334
6335 @smallexample
6336     v7:             cypress
6337     v8:             supersparc, hypersparc
6338     sparclite:      f930, f934, sparclite86x
6339     sparclet:       tsc701
6340     v9:             ultrasparc, ultrasparc3
6341 @end smallexample
6342
6343 @item -mtune=@var{cpu_type}
6344 @opindex mtune
6345 Set the instruction scheduling parameters for machine type
6346 @var{cpu_type}, but do not set the instruction set or register set that the
6347 option @option{-mcpu=@var{cpu_type}} would.
6348
6349 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6350 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6351 that select a particular cpu implementation.  Those are @samp{cypress},
6352 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6353 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6354 @samp{ultrasparc3}.
6355
6356 @end table
6357
6358 These @samp{-m} switches are supported in addition to the above
6359 on the SPARCLET processor.
6360
6361 @table @gcctabopt
6362 @item -mlittle-endian
6363 @opindex mlittle-endian
6364 Generate code for a processor running in little-endian mode.
6365
6366 @item -mlive-g0
6367 @opindex mlive-g0
6368 Treat register @code{%g0} as a normal register.
6369 GCC will continue to clobber it as necessary but will not assume
6370 it always reads as 0.
6371
6372 @item -mbroken-saverestore
6373 @opindex mbroken-saverestore
6374 Generate code that does not use non-trivial forms of the @code{save} and
6375 @code{restore} instructions.  Early versions of the SPARCLET processor do
6376 not correctly handle @code{save} and @code{restore} instructions used with
6377 arguments.  They correctly handle them used without arguments.  A @code{save}
6378 instruction used without arguments increments the current window pointer
6379 but does not allocate a new stack frame.  It is assumed that the window
6380 overflow trap handler will properly handle this case as will interrupt
6381 handlers.
6382 @end table
6383
6384 These @samp{-m} switches are supported in addition to the above
6385 on SPARC V9 processors in 64-bit environments.
6386
6387 @table @gcctabopt
6388 @item -mlittle-endian
6389 @opindex mlittle-endian
6390 Generate code for a processor running in little-endian mode. It is only
6391 available for a few configurations and most notably not on Solaris.
6392
6393 @item -m32
6394 @itemx -m64
6395 @opindex m32
6396 @opindex m64
6397 Generate code for a 32-bit or 64-bit environment.
6398 The 32-bit environment sets int, long and pointer to 32 bits.
6399 The 64-bit environment sets int to 32 bits and long and pointer
6400 to 64 bits.
6401
6402 @item -mcmodel=medlow
6403 @opindex mcmodel=medlow
6404 Generate code for the Medium/Low code model: the program must be linked
6405 in the low 32 bits of the address space.  Pointers are 64 bits.
6406 Programs can be statically or dynamically linked.
6407
6408 @item -mcmodel=medmid
6409 @opindex mcmodel=medmid
6410 Generate code for the Medium/Middle code model: the program must be linked
6411 in the low 44 bits of the address space, the text segment must be less than
6412 2G bytes, and data segment must be within 2G of the text segment.
6413 Pointers are 64 bits.
6414
6415 @item -mcmodel=medany
6416 @opindex mcmodel=medany
6417 Generate code for the Medium/Anywhere code model: the program may be linked
6418 anywhere in the address space, the text segment must be less than
6419 2G bytes, and data segment must be within 2G of the text segment.
6420 Pointers are 64 bits.
6421
6422 @item -mcmodel=embmedany
6423 @opindex mcmodel=embmedany
6424 Generate code for the Medium/Anywhere code model for embedded systems:
6425 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6426 (determined at link time).  Register %g4 points to the base of the
6427 data segment.  Pointers are still 64 bits.
6428 Programs are statically linked, PIC is not supported.
6429
6430 @item -mstack-bias
6431 @itemx -mno-stack-bias
6432 @opindex mstack-bias
6433 @opindex mno-stack-bias
6434 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6435 frame pointer if present, are offset by @minus{}2047 which must be added back
6436 when making stack frame references.
6437 Otherwise, assume no such offset is present.
6438 @end table
6439
6440 @node ARM Options
6441 @subsection ARM Options
6442 @cindex ARM options
6443
6444 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6445 architectures:
6446
6447 @table @gcctabopt
6448 @item -mapcs-frame
6449 @opindex mapcs-frame
6450 Generate a stack frame that is compliant with the ARM Procedure Call
6451 Standard for all functions, even if this is not strictly necessary for
6452 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6453 with this option will cause the stack frames not to be generated for
6454 leaf functions.  The default is @option{-mno-apcs-frame}.
6455
6456 @item -mapcs
6457 @opindex mapcs
6458 This is a synonym for @option{-mapcs-frame}.
6459
6460 @item -mapcs-26
6461 @opindex mapcs-26
6462 Generate code for a processor running with a 26-bit program counter,
6463 and conforming to the function calling standards for the APCS 26-bit
6464 option.  This option replaces the @option{-m2} and @option{-m3} options
6465 of previous releases of the compiler.
6466
6467 @item -mapcs-32
6468 @opindex mapcs-32
6469 Generate code for a processor running with a 32-bit program counter,
6470 and conforming to the function calling standards for the APCS 32-bit
6471 option.  This option replaces the @option{-m6} option of previous releases
6472 of the compiler.
6473
6474 @ignore
6475 @c not currently implemented
6476 @item -mapcs-stack-check
6477 @opindex mapcs-stack-check
6478 Generate code to check the amount of stack space available upon entry to
6479 every function (that actually uses some stack space).  If there is
6480 insufficient space available then either the function
6481 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6482 called, depending upon the amount of stack space required.  The run time
6483 system is required to provide these functions.  The default is
6484 @option{-mno-apcs-stack-check}, since this produces smaller code.
6485
6486 @c not currently implemented
6487 @item -mapcs-float
6488 @opindex mapcs-float
6489 Pass floating point arguments using the float point registers.  This is
6490 one of the variants of the APCS@.  This option is recommended if the
6491 target hardware has a floating point unit or if a lot of floating point
6492 arithmetic is going to be performed by the code.  The default is
6493 @option{-mno-apcs-float}, since integer only code is slightly increased in
6494 size if @option{-mapcs-float} is used.
6495
6496 @c not currently implemented
6497 @item -mapcs-reentrant
6498 @opindex mapcs-reentrant
6499 Generate reentrant, position independent code.  The default is
6500 @option{-mno-apcs-reentrant}.
6501 @end ignore
6502
6503 @item -mthumb-interwork
6504 @opindex mthumb-interwork
6505 Generate code which supports calling between the ARM and Thumb
6506 instruction sets.  Without this option the two instruction sets cannot
6507 be reliably used inside one program.  The default is
6508 @option{-mno-thumb-interwork}, since slightly larger code is generated
6509 when @option{-mthumb-interwork} is specified.
6510
6511 @item -mno-sched-prolog
6512 @opindex mno-sched-prolog
6513 Prevent the reordering of instructions in the function prolog, or the
6514 merging of those instruction with the instructions in the function's
6515 body.  This means that all functions will start with a recognizable set
6516 of instructions (or in fact one of a choice from a small set of
6517 different function prologues), and this information can be used to
6518 locate the start if functions inside an executable piece of code.  The
6519 default is @option{-msched-prolog}.
6520
6521 @item -mhard-float
6522 @opindex mhard-float
6523 Generate output containing floating point instructions.  This is the
6524 default.
6525
6526 @item -msoft-float
6527 @opindex msoft-float
6528 Generate output containing library calls for floating point.
6529 @strong{Warning:} the requisite libraries are not available for all ARM
6530 targets.  Normally the facilities of the machine's usual C compiler are
6531 used, but this cannot be done directly in cross-compilation.  You must make
6532 your own arrangements to provide suitable library functions for
6533 cross-compilation.
6534
6535 @option{-msoft-float} changes the calling convention in the output file;
6536 therefore, it is only useful if you compile @emph{all} of a program with
6537 this option.  In particular, you need to compile @file{libgcc.a}, the
6538 library that comes with GCC, with @option{-msoft-float} in order for
6539 this to work.
6540
6541 @item -mlittle-endian
6542 @opindex mlittle-endian
6543 Generate code for a processor running in little-endian mode.  This is
6544 the default for all standard configurations.
6545
6546 @item -mbig-endian
6547 @opindex mbig-endian
6548 Generate code for a processor running in big-endian mode; the default is
6549 to compile code for a little-endian processor.
6550
6551 @item -mwords-little-endian
6552 @opindex mwords-little-endian
6553 This option only applies when generating code for big-endian processors.
6554 Generate code for a little-endian word order but a big-endian byte
6555 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6556 option should only be used if you require compatibility with code for
6557 big-endian ARM processors generated by versions of the compiler prior to
6558 2.8.
6559
6560 @item -malignment-traps
6561 @opindex malignment-traps
6562 Generate code that will not trap if the MMU has alignment traps enabled.
6563 On ARM architectures prior to ARMv4, there were no instructions to
6564 access half-word objects stored in memory.  However, when reading from
6565 memory a feature of the ARM architecture allows a word load to be used,
6566 even if the address is unaligned, and the processor core will rotate the
6567 data as it is being loaded.  This option tells the compiler that such
6568 misaligned accesses will cause a MMU trap and that it should instead
6569 synthesize the access as a series of byte accesses.  The compiler can
6570 still use word accesses to load half-word data if it knows that the
6571 address is aligned to a word boundary.
6572
6573 This option is ignored when compiling for ARM architecture 4 or later,
6574 since these processors have instructions to directly access half-word
6575 objects in memory.
6576
6577 @item -mno-alignment-traps
6578 @opindex mno-alignment-traps
6579 Generate code that assumes that the MMU will not trap unaligned
6580 accesses.  This produces better code when the target instruction set
6581 does not have half-word memory operations (i.e.@: implementations prior to
6582 ARMv4).
6583
6584 Note that you cannot use this option to access unaligned word objects,
6585 since the processor will only fetch one 32-bit aligned object from
6586 memory.
6587
6588 The default setting for most targets is @option{-mno-alignment-traps}, since
6589 this produces better code when there are no half-word memory
6590 instructions available.
6591
6592 @item -mshort-load-bytes
6593 @itemx -mno-short-load-words
6594 @opindex mshort-load-bytes
6595 @opindex mno-short-load-words
6596 These are deprecated aliases for @option{-malignment-traps}.
6597
6598 @item -mno-short-load-bytes
6599 @itemx -mshort-load-words
6600 @opindex mno-short-load-bytes
6601 @opindex mshort-load-words
6602 This are deprecated aliases for @option{-mno-alignment-traps}.
6603
6604 @item -mcpu=@var{name}
6605 @opindex mcpu
6606 This specifies the name of the target ARM processor.  GCC uses this name
6607 to determine what kind of instructions it can emit when generating
6608 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6609 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6610 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6611 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6612 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6613 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6614 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6615 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6616 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6617 @samp{arm1020t}, @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
6618
6619 @itemx -mtune=@var{name}
6620 @opindex mtune
6621 This option is very similar to the @option{-mcpu=} option, except that
6622 instead of specifying the actual target processor type, and hence
6623 restricting which instructions can be used, it specifies that GCC should
6624 tune the performance of the code as if the target were of the type
6625 specified in this option, but still choosing the instructions that it
6626 will generate based on the cpu specified by a @option{-mcpu=} option.
6627 For some ARM implementations better performance can be obtained by using
6628 this option.
6629
6630 @item -march=@var{name}
6631 @opindex march
6632 This specifies the name of the target ARM architecture.  GCC uses this
6633 name to determine what kind of instructions it can emit when generating
6634 assembly code.  This option can be used in conjunction with or instead
6635 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6636 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6637 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{iwmmxt}, @samp{ep9312}.
6638
6639 @item -mfpe=@var{number}
6640 @itemx -mfp=@var{number}
6641 @opindex mfpe
6642 @opindex mfp
6643 This specifies the version of the floating point emulation available on
6644 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6645 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6646
6647 @item -mstructure-size-boundary=@var{n}
6648 @opindex mstructure-size-boundary
6649 The size of all structures and unions will be rounded up to a multiple
6650 of the number of bits set by this option.  Permissible values are 8 and
6651 32.  The default value varies for different toolchains.  For the COFF
6652 targeted toolchain the default value is 8.  Specifying the larger number
6653 can produce faster, more efficient code, but can also increase the size
6654 of the program.  The two values are potentially incompatible.  Code
6655 compiled with one value cannot necessarily expect to work with code or
6656 libraries compiled with the other value, if they exchange information
6657 using structures or unions.
6658
6659 @item -mabort-on-noreturn
6660 @opindex mabort-on-noreturn
6661 Generate a call to the function @code{abort} at the end of a
6662 @code{noreturn} function.  It will be executed if the function tries to
6663 return.
6664
6665 @item -mlong-calls
6666 @itemx -mno-long-calls
6667 @opindex mlong-calls
6668 @opindex mno-long-calls
6669 Tells the compiler to perform function calls by first loading the
6670 address of the function into a register and then performing a subroutine
6671 call on this register.  This switch is needed if the target function
6672 will lie outside of the 64 megabyte addressing range of the offset based
6673 version of subroutine call instruction.
6674
6675 Even if this switch is enabled, not all function calls will be turned
6676 into long calls.  The heuristic is that static functions, functions
6677 which have the @samp{short-call} attribute, functions that are inside
6678 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6679 definitions have already been compiled within the current compilation
6680 unit, will not be turned into long calls.  The exception to this rule is
6681 that weak function definitions, functions with the @samp{long-call}
6682 attribute or the @samp{section} attribute, and functions that are within
6683 the scope of a @samp{#pragma long_calls} directive, will always be
6684 turned into long calls.
6685
6686 This feature is not enabled by default.  Specifying
6687 @option{-mno-long-calls} will restore the default behavior, as will
6688 placing the function calls within the scope of a @samp{#pragma
6689 long_calls_off} directive.  Note these switches have no effect on how
6690 the compiler generates code to handle function calls via function
6691 pointers.
6692
6693 @item -mnop-fun-dllimport
6694 @opindex mnop-fun-dllimport
6695 Disable support for the @code{dllimport} attribute.
6696
6697 @item -msingle-pic-base
6698 @opindex msingle-pic-base
6699 Treat the register used for PIC addressing as read-only, rather than
6700 loading it in the prologue for each function.  The run-time system is
6701 responsible for initializing this register with an appropriate value
6702 before execution begins.
6703
6704 @item -mpic-register=@var{reg}
6705 @opindex mpic-register
6706 Specify the register to be used for PIC addressing.  The default is R10
6707 unless stack-checking is enabled, when R9 is used.
6708
6709 @item -mcirrus-fix-invalid-insns
6710 @opindex mcirrus-fix-invalid-insns
6711 @opindex mno-cirrus-fix-invalid-insns
6712 Insert NOPs into the instruction stream to in order to work around
6713 problems with invalid Maverick instruction combinations.  This option
6714 is only valid if the @option{-mcpu=ep9312} option has been used to
6715 enable generation of instructions for the Cirrus Maverick floating
6716 point co-processor.  This option is not enabled by default, since the
6717 problem is only present in older Maverick implementations.  The default
6718 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6719 switch.
6720
6721 @item -mpoke-function-name
6722 @opindex mpoke-function-name
6723 Write the name of each function into the text section, directly
6724 preceding the function prologue.  The generated code is similar to this:
6725
6726 @smallexample
6727      t0
6728          .ascii "arm_poke_function_name", 0
6729          .align
6730      t1
6731          .word 0xff000000 + (t1 - t0)
6732      arm_poke_function_name
6733          mov     ip, sp
6734          stmfd   sp!, @{fp, ip, lr, pc@}
6735          sub     fp, ip, #4
6736 @end smallexample
6737
6738 When performing a stack backtrace, code can inspect the value of
6739 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6740 location @code{pc - 12} and the top 8 bits are set, then we know that
6741 there is a function name embedded immediately preceding this location
6742 and has length @code{((pc[-3]) & 0xff000000)}.
6743
6744 @item -mthumb
6745 @opindex mthumb
6746 Generate code for the 16-bit Thumb instruction set.  The default is to
6747 use the 32-bit ARM instruction set.
6748
6749 @item -mtpcs-frame
6750 @opindex mtpcs-frame
6751 Generate a stack frame that is compliant with the Thumb Procedure Call
6752 Standard for all non-leaf functions.  (A leaf function is one that does
6753 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6754
6755 @item -mtpcs-leaf-frame
6756 @opindex mtpcs-leaf-frame
6757 Generate a stack frame that is compliant with the Thumb Procedure Call
6758 Standard for all leaf functions.  (A leaf function is one that does
6759 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6760
6761 @item -mcallee-super-interworking
6762 @opindex mcallee-super-interworking
6763 Gives all externally visible functions in the file being compiled an ARM
6764 instruction set header which switches to Thumb mode before executing the
6765 rest of the function.  This allows these functions to be called from
6766 non-interworking code.
6767
6768 @item -mcaller-super-interworking
6769 @opindex mcaller-super-interworking
6770 Allows calls via function pointers (including virtual functions) to
6771 execute correctly regardless of whether the target code has been
6772 compiled for interworking or not.  There is a small overhead in the cost
6773 of executing a function pointer if this option is enabled.
6774
6775 @end table
6776
6777 @node MN10200 Options
6778 @subsection MN10200 Options
6779 @cindex MN10200 options
6780
6781 These @option{-m} options are defined for Matsushita MN10200 architectures:
6782 @table @gcctabopt
6783
6784 @item -mrelax
6785 @opindex mrelax
6786 Indicate to the linker that it should perform a relaxation optimization pass
6787 to shorten branches, calls and absolute memory addresses.  This option only
6788 has an effect when used on the command line for the final link step.
6789
6790 This option makes symbolic debugging impossible.
6791 @end table
6792
6793 @node MN10300 Options
6794 @subsection MN10300 Options
6795 @cindex MN10300 options
6796
6797 These @option{-m} options are defined for Matsushita MN10300 architectures:
6798
6799 @table @gcctabopt
6800 @item -mmult-bug
6801 @opindex mmult-bug
6802 Generate code to avoid bugs in the multiply instructions for the MN10300
6803 processors.  This is the default.
6804
6805 @item -mno-mult-bug
6806 @opindex mno-mult-bug
6807 Do not generate code to avoid bugs in the multiply instructions for the
6808 MN10300 processors.
6809
6810 @item -mam33
6811 @opindex mam33
6812 Generate code which uses features specific to the AM33 processor.
6813
6814 @item -mno-am33
6815 @opindex mno-am33
6816 Do not generate code which uses features specific to the AM33 processor.  This
6817 is the default.
6818
6819 @item -mno-crt0
6820 @opindex mno-crt0
6821 Do not link in the C run-time initialization object file.
6822
6823 @item -mrelax
6824 @opindex mrelax
6825 Indicate to the linker that it should perform a relaxation optimization pass
6826 to shorten branches, calls and absolute memory addresses.  This option only
6827 has an effect when used on the command line for the final link step.
6828
6829 This option makes symbolic debugging impossible.
6830 @end table
6831
6832
6833 @node M32R/D Options
6834 @subsection M32R/D Options
6835 @cindex M32R/D options
6836
6837 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6838
6839 @table @gcctabopt
6840 @item -m32rx
6841 @opindex m32rx
6842 Generate code for the M32R/X@.
6843
6844 @item -m32r
6845 @opindex m32r
6846 Generate code for the M32R@.  This is the default.
6847
6848 @item -mcode-model=small
6849 @opindex mcode-model=small
6850 Assume all objects live in the lower 16MB of memory (so that their addresses
6851 can be loaded with the @code{ld24} instruction), and assume all subroutines
6852 are reachable with the @code{bl} instruction.
6853 This is the default.
6854
6855 The addressability of a particular object can be set with the
6856 @code{model} attribute.
6857
6858 @item -mcode-model=medium
6859 @opindex mcode-model=medium
6860 Assume objects may be anywhere in the 32-bit address space (the compiler
6861 will generate @code{seth/add3} instructions to load their addresses), and
6862 assume all subroutines are reachable with the @code{bl} instruction.
6863
6864 @item -mcode-model=large
6865 @opindex mcode-model=large
6866 Assume objects may be anywhere in the 32-bit address space (the compiler
6867 will generate @code{seth/add3} instructions to load their addresses), and
6868 assume subroutines may not be reachable with the @code{bl} instruction
6869 (the compiler will generate the much slower @code{seth/add3/jl}
6870 instruction sequence).
6871
6872 @item -msdata=none
6873 @opindex msdata=none
6874 Disable use of the small data area.  Variables will be put into
6875 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6876 @code{section} attribute has been specified).
6877 This is the default.
6878
6879 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6880 Objects may be explicitly put in the small data area with the
6881 @code{section} attribute using one of these sections.
6882
6883 @item -msdata=sdata
6884 @opindex msdata=sdata
6885 Put small global and static data in the small data area, but do not
6886 generate special code to reference them.
6887
6888 @item -msdata=use
6889 @opindex msdata=use
6890 Put small global and static data in the small data area, and generate
6891 special instructions to reference them.
6892
6893 @item -G @var{num}
6894 @opindex G
6895 @cindex smaller data references
6896 Put global and static objects less than or equal to @var{num} bytes
6897 into the small data or bss sections instead of the normal data or bss
6898 sections.  The default value of @var{num} is 8.
6899 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6900 for this option to have any effect.
6901
6902 All modules should be compiled with the same @option{-G @var{num}} value.
6903 Compiling with different values of @var{num} may or may not work; if it
6904 doesn't the linker will give an error message---incorrect code will not be
6905 generated.
6906
6907 @end table
6908
6909 @node M88K Options
6910 @subsection M88K Options
6911 @cindex M88k options
6912
6913 These @samp{-m} options are defined for Motorola 88k architectures:
6914
6915 @table @gcctabopt
6916 @item -m88000
6917 @opindex m88000
6918 Generate code that works well on both the m88100 and the
6919 m88110.
6920
6921 @item -m88100
6922 @opindex m88100
6923 Generate code that works best for the m88100, but that also
6924 runs on the m88110.
6925
6926 @item -m88110
6927 @opindex m88110
6928 Generate code that works best for the m88110, and may not run
6929 on the m88100.
6930
6931 @item -mbig-pic
6932 @opindex mbig-pic
6933 Obsolete option to be removed from the next revision.
6934 Use @option{-fPIC}.
6935
6936 @item -midentify-revision
6937 @opindex midentify-revision
6938 @cindex identifying source, compiler (88k)
6939 Include an @code{ident} directive in the assembler output recording the
6940 source file name, compiler name and version, timestamp, and compilation
6941 flags used.
6942
6943 @item -mno-underscores
6944 @opindex mno-underscores
6945 @cindex underscores, avoiding (88k)
6946 In assembler output, emit symbol names without adding an underscore
6947 character at the beginning of each name.  The default is to use an
6948 underscore as prefix on each name.
6949
6950 @item -mocs-debug-info
6951 @itemx -mno-ocs-debug-info
6952 @opindex mocs-debug-info
6953 @opindex mno-ocs-debug-info
6954 @cindex OCS (88k)
6955 @cindex debugging, 88k OCS
6956 Include (or omit) additional debugging information (about registers used
6957 in each stack frame) as specified in the 88open Object Compatibility
6958 Standard, ``OCS''@.  This extra information allows debugging of code that
6959 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6960 SVr3.2 is to include this information; other 88k configurations omit this
6961 information by default.
6962
6963 @item -mocs-frame-position
6964 @opindex mocs-frame-position
6965 @cindex register positions in frame (88k)
6966 When emitting COFF debugging information for automatic variables and
6967 parameters stored on the stack, use the offset from the canonical frame
6968 address, which is the stack pointer (register 31) on entry to the
6969 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6970 @option{-mocs-frame-position}; other 88k configurations have the default
6971 @option{-mno-ocs-frame-position}.
6972
6973 @item -mno-ocs-frame-position
6974 @opindex mno-ocs-frame-position
6975 @cindex register positions in frame (88k)
6976 When emitting COFF debugging information for automatic variables and
6977 parameters stored on the stack, use the offset from the frame pointer
6978 register (register 30).  When this option is in effect, the frame
6979 pointer is not eliminated when debugging information is selected by the
6980 -g switch.
6981
6982 @item -moptimize-arg-area
6983 @opindex moptimize-arg-area
6984 @cindex arguments in frame (88k)
6985 Save space by reorganizing the stack frame.  This option generates code
6986 that does not agree with the 88open specifications, but uses less
6987 memory.
6988
6989 @itemx -mno-optimize-arg-area
6990 @opindex mno-optimize-arg-area
6991 Do not reorganize the stack frame to save space.  This is the default.
6992 The generated conforms to the specification, but uses more memory.
6993
6994 @item -mshort-data-@var{num}
6995 @opindex mshort-data
6996 @cindex smaller data references (88k)
6997 @cindex r0-relative references (88k)
6998 Generate smaller data references by making them relative to @code{r0},
6999 which allows loading a value using a single instruction (rather than the
7000 usual two).  You control which data references are affected by
7001 specifying @var{num} with this option.  For example, if you specify
7002 @option{-mshort-data-512}, then the data references affected are those
7003 involving displacements of less than 512 bytes.
7004 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
7005 than 64k.
7006
7007 @item -mserialize-volatile
7008 @opindex mserialize-volatile
7009 @itemx -mno-serialize-volatile
7010 @opindex mno-serialize-volatile
7011 @cindex sequential consistency on 88k
7012 Do, or don't, generate code to guarantee sequential consistency
7013 of volatile memory references.  By default, consistency is
7014 guaranteed.
7015
7016 The order of memory references made by the MC88110 processor does
7017 not always match the order of the instructions requesting those
7018 references.  In particular, a load instruction may execute before
7019 a preceding store instruction.  Such reordering violates
7020 sequential consistency of volatile memory references, when there
7021 are multiple processors.   When consistency must be guaranteed,
7022 GCC generates special instructions, as needed, to force
7023 execution in the proper order.
7024
7025 The MC88100 processor does not reorder memory references and so
7026 always provides sequential consistency.  However, by default, GCC
7027 generates the special instructions to guarantee consistency
7028 even when you use @option{-m88100}, so that the code may be run on an
7029 MC88110 processor.  If you intend to run your code only on the
7030 MC88100 processor, you may use @option{-mno-serialize-volatile}.
7031
7032 The extra code generated to guarantee consistency may affect the
7033 performance of your application.  If you know that you can safely
7034 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
7035
7036 @item -msvr4
7037 @itemx -msvr3
7038 @opindex msvr4
7039 @opindex msvr3
7040 @cindex assembler syntax, 88k
7041 @cindex SVr4
7042 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
7043 related to System V release 4 (SVr4).  This controls the following:
7044
7045 @enumerate
7046 @item
7047 Which variant of the assembler syntax to emit.
7048 @item
7049 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
7050 that is used on System V release 4.
7051 @item
7052 @option{-msvr4} makes GCC issue additional declaration directives used in
7053 SVr4.
7054 @end enumerate
7055
7056 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
7057 @option{-msvr3} is the default for all other m88k configurations.
7058
7059 @item -mversion-03.00
7060 @opindex mversion-03.00
7061 This option is obsolete, and is ignored.
7062 @c ??? which asm syntax better for GAS?  option there too?
7063
7064 @item -mno-check-zero-division
7065 @itemx -mcheck-zero-division
7066 @opindex mno-check-zero-division
7067 @opindex mcheck-zero-division
7068 @cindex zero division on 88k
7069 Do, or don't, generate code to guarantee that integer division by
7070 zero will be detected.  By default, detection is guaranteed.
7071
7072 Some models of the MC88100 processor fail to trap upon integer
7073 division by zero under certain conditions.  By default, when
7074 compiling code that might be run on such a processor, GCC
7075 generates code that explicitly checks for zero-valued divisors
7076 and traps with exception number 503 when one is detected.  Use of
7077 @option{-mno-check-zero-division} suppresses such checking for code
7078 generated to run on an MC88100 processor.
7079
7080 GCC assumes that the MC88110 processor correctly detects all instances
7081 of integer division by zero.  When @option{-m88110} is specified, no
7082 explicit checks for zero-valued divisors are generated, and both
7083 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
7084 ignored.
7085
7086 @item -muse-div-instruction
7087 @opindex muse-div-instruction
7088 @cindex divide instruction, 88k
7089 Use the div instruction for signed integer division on the
7090 MC88100 processor.  By default, the div instruction is not used.
7091
7092 On the MC88100 processor the signed integer division instruction
7093 div) traps to the operating system on a negative operand.  The
7094 operating system transparently completes the operation, but at a
7095 large cost in execution time.  By default, when compiling code
7096 that might be run on an MC88100 processor, GCC emulates signed
7097 integer division using the unsigned integer division instruction
7098 divu), thereby avoiding the large penalty of a trap to the
7099 operating system.  Such emulation has its own, smaller, execution
7100 cost in both time and space.  To the extent that your code's
7101 important signed integer division operations are performed on two
7102 nonnegative operands, it may be desirable to use the div
7103 instruction directly.
7104
7105 On the MC88110 processor the div instruction (also known as the
7106 divs instruction) processes negative operands without trapping to
7107 the operating system.  When @option{-m88110} is specified,
7108 @option{-muse-div-instruction} is ignored, and the div instruction is used
7109 for signed integer division.
7110
7111 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
7112 particular, the behavior of such a division with and without
7113 @option{-muse-div-instruction} may differ.
7114
7115 @item -mtrap-large-shift
7116 @itemx -mhandle-large-shift
7117 @opindex mtrap-large-shift
7118 @opindex mhandle-large-shift
7119 @cindex bit shift overflow (88k)
7120 @cindex large bit shifts (88k)
7121 Include code to detect bit-shifts of more than 31 bits; respectively,
7122 trap such shifts or emit code to handle them properly.  By default GCC
7123 makes no special provision for large bit shifts.
7124
7125 @item -mwarn-passed-structs
7126 @opindex mwarn-passed-structs
7127 @cindex structure passing (88k)
7128 Warn when a function passes a struct as an argument or result.
7129 Structure-passing conventions have changed during the evolution of the C
7130 language, and are often the source of portability problems.  By default,
7131 GCC issues no such warning.
7132 @end table
7133
7134 @c break page here to avoid unsightly interparagraph stretch.
7135 @c -zw, 2001-8-17
7136 @page
7137
7138 @node RS/6000 and PowerPC Options
7139 @subsection IBM RS/6000 and PowerPC Options
7140 @cindex RS/6000 and PowerPC Options
7141 @cindex IBM RS/6000 and PowerPC Options
7142
7143 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
7144 @table @gcctabopt
7145 @item -mpower
7146 @itemx -mno-power
7147 @itemx -mpower2
7148 @itemx -mno-power2
7149 @itemx -mpowerpc
7150 @itemx -mno-powerpc
7151 @itemx -mpowerpc-gpopt
7152 @itemx -mno-powerpc-gpopt
7153 @itemx -mpowerpc-gfxopt
7154 @itemx -mno-powerpc-gfxopt
7155 @itemx -mpowerpc64
7156 @itemx -mno-powerpc64
7157 @opindex mpower
7158 @opindex mno-power
7159 @opindex mpower2
7160 @opindex mno-power2
7161 @opindex mpowerpc
7162 @opindex mno-powerpc
7163 @opindex mpowerpc-gpopt
7164 @opindex mno-powerpc-gpopt
7165 @opindex mpowerpc-gfxopt
7166 @opindex mno-powerpc-gfxopt
7167 @opindex mpowerpc64
7168 @opindex mno-powerpc64
7169 GCC supports two related instruction set architectures for the
7170 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
7171 instructions supported by the @samp{rios} chip set used in the original
7172 RS/6000 systems and the @dfn{PowerPC} instruction set is the
7173 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
7174 the IBM 4xx microprocessors.
7175
7176 Neither architecture is a subset of the other.  However there is a
7177 large common subset of instructions supported by both.  An MQ
7178 register is included in processors supporting the POWER architecture.
7179
7180 You use these options to specify which instructions are available on the
7181 processor you are using.  The default value of these options is
7182 determined when configuring GCC@.  Specifying the
7183 @option{-mcpu=@var{cpu_type}} overrides the specification of these
7184 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
7185 rather than the options listed above.
7186
7187 The @option{-mpower} option allows GCC to generate instructions that
7188 are found only in the POWER architecture and to use the MQ register.
7189 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7190 to generate instructions that are present in the POWER2 architecture but
7191 not the original POWER architecture.
7192
7193 The @option{-mpowerpc} option allows GCC to generate instructions that
7194 are found only in the 32-bit subset of the PowerPC architecture.
7195 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7196 GCC to use the optional PowerPC architecture instructions in the
7197 General Purpose group, including floating-point square root.  Specifying
7198 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7199 use the optional PowerPC architecture instructions in the Graphics
7200 group, including floating-point select.
7201
7202 The @option{-mpowerpc64} option allows GCC to generate the additional
7203 64-bit instructions that are found in the full PowerPC64 architecture
7204 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7205 @option{-mno-powerpc64}.
7206
7207 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7208 will use only the instructions in the common subset of both
7209 architectures plus some special AIX common-mode calls, and will not use
7210 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7211 permits GCC to use any instruction from either architecture and to
7212 allow use of the MQ register; specify this for the Motorola MPC601.
7213
7214 @item -mnew-mnemonics
7215 @itemx -mold-mnemonics
7216 @opindex mnew-mnemonics
7217 @opindex mold-mnemonics
7218 Select which mnemonics to use in the generated assembler code.  With
7219 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7220 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7221 assembler mnemonics defined for the POWER architecture.  Instructions
7222 defined in only one architecture have only one mnemonic; GCC uses that
7223 mnemonic irrespective of which of these options is specified.
7224
7225 GCC defaults to the mnemonics appropriate for the architecture in
7226 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7227 value of these option.  Unless you are building a cross-compiler, you
7228 should normally not specify either @option{-mnew-mnemonics} or
7229 @option{-mold-mnemonics}, but should instead accept the default.
7230
7231 @item -mcpu=@var{cpu_type}
7232 @opindex mcpu
7233 Set architecture type, register usage, choice of mnemonics, and
7234 instruction scheduling parameters for machine type @var{cpu_type}.
7235 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
7236 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
7237 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
7238 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
7239 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
7240 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
7241
7242 @option{-mcpu=common} selects a completely generic processor.  Code
7243 generated under this option will run on any POWER or PowerPC processor.
7244 GCC will use only the instructions in the common subset of both
7245 architectures, and will not use the MQ register.  GCC assumes a generic
7246 processor model for scheduling purposes.
7247
7248 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7249 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7250 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7251 types, with an appropriate, generic processor model assumed for
7252 scheduling purposes.
7253
7254 The other options specify a specific processor.  Code generated under
7255 those options will run best on that processor, and may not run at all on
7256 others.
7257
7258 The @option{-mcpu} options automatically enable or disable other
7259 @option{-m} options as follows:
7260
7261 @table @samp
7262 @item common
7263 @option{-mno-power}, @option{-mno-powerpc}
7264
7265 @item power
7266 @itemx power2
7267 @itemx rios1
7268 @itemx rios2
7269 @itemx rsc
7270 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7271
7272 @item powerpc
7273 @itemx rs64a
7274 @itemx 602
7275 @itemx 603
7276 @itemx 603e
7277 @itemx 604
7278 @itemx 620
7279 @itemx 630
7280 @itemx 740
7281 @itemx 7400
7282 @itemx 7450
7283 @itemx 750
7284 @itemx 505
7285 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7286
7287 @item 601
7288 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7289
7290 @item 403
7291 @itemx 821
7292 @itemx 860
7293 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7294 @end table
7295
7296 @item -mtune=@var{cpu_type}
7297 @opindex mtune
7298 Set the instruction scheduling parameters for machine type
7299 @var{cpu_type}, but do not set the architecture type, register usage, or
7300 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7301 values for @var{cpu_type} are used for @option{-mtune} as for
7302 @option{-mcpu}.  If both are specified, the code generated will use the
7303 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7304 scheduling parameters set by @option{-mtune}.
7305
7306 @item -maltivec
7307 @itemx -mno-altivec
7308 @opindex maltivec
7309 @opindex mno-altivec
7310 These switches enable or disable the use of built-in functions that
7311 allow access to the AltiVec instruction set.  You may also need to set
7312 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7313 enhancements.
7314
7315 @item -mabi=spe
7316 @opindex mabi=spe
7317 Extend the current ABI with SPE ABI extensions.  This does not change
7318 the default ABI, instead it adds the SPE ABI extensions to the current
7319 ABI@.
7320
7321 @item -mabi=no-spe
7322 @opindex mabi=no-spe
7323 Disable Booke SPE ABI extensions for the current ABI.
7324
7325 @item -misel=@var{yes/no}
7326 @itemx -misel
7327 @opindex misel
7328 This switch enables or disables the generation of ISEL instructions.
7329
7330 @item -mspe=@var{yes/no}
7331 @itemx -mspe
7332 @opindex mspe
7333 This switch enables or disables the generation of SPE simd
7334 instructions.
7335
7336 @item -mfloat-gprs=@var{yes/no}
7337 @itemx -mfloat-gprs
7338 @opindex mfloat-gprs
7339 This switch enables or disables the generation of floating point
7340 operations on the general purpose registers for architectures that
7341 support it.  This option is currently only available on the MPC8540.
7342
7343 @item -mfull-toc
7344 @itemx -mno-fp-in-toc
7345 @itemx -mno-sum-in-toc
7346 @itemx -mminimal-toc
7347 @opindex mfull-toc
7348 @opindex mno-fp-in-toc
7349 @opindex mno-sum-in-toc
7350 @opindex mminimal-toc
7351 Modify generation of the TOC (Table Of Contents), which is created for
7352 every executable file.  The @option{-mfull-toc} option is selected by
7353 default.  In that case, GCC will allocate at least one TOC entry for
7354 each unique non-automatic variable reference in your program.  GCC
7355 will also place floating-point constants in the TOC@.  However, only
7356 16,384 entries are available in the TOC@.
7357
7358 If you receive a linker error message that saying you have overflowed
7359 the available TOC space, you can reduce the amount of TOC space used
7360 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7361 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7362 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7363 generate code to calculate the sum of an address and a constant at
7364 run-time instead of putting that sum into the TOC@.  You may specify one
7365 or both of these options.  Each causes GCC to produce very slightly
7366 slower and larger code at the expense of conserving TOC space.
7367
7368 If you still run out of space in the TOC even when you specify both of
7369 these options, specify @option{-mminimal-toc} instead.  This option causes
7370 GCC to make only one TOC entry for every file.  When you specify this
7371 option, GCC will produce code that is slower and larger but which
7372 uses extremely little TOC space.  You may wish to use this option
7373 only on files that contain less frequently executed code.
7374
7375 @item -maix64
7376 @itemx -maix32
7377 @opindex maix64
7378 @opindex maix32
7379 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7380 @code{long} type, and the infrastructure needed to support them.
7381 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7382 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7383 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7384
7385 @item -mxl-call
7386 @itemx -mno-xl-call
7387 @opindex mxl-call
7388 @opindex mno-xl-call
7389 On AIX, pass floating-point arguments to prototyped functions beyond the
7390 register save area (RSA) on the stack in addition to argument FPRs.  The
7391 AIX calling convention was extended but not initially documented to
7392 handle an obscure K&R C case of calling a function that takes the
7393 address of its arguments with fewer arguments than declared.  AIX XL
7394 compilers access floating point arguments which do not fit in the
7395 RSA from the stack when a subroutine is compiled without
7396 optimization.  Because always storing floating-point arguments on the
7397 stack is inefficient and rarely needed, this option is not enabled by
7398 default and only is necessary when calling subroutines compiled by AIX
7399 XL compilers without optimization.
7400
7401 @item -mpe
7402 @opindex mpe
7403 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7404 application written to use message passing with special startup code to
7405 enable the application to run.  The system must have PE installed in the
7406 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7407 must be overridden with the @option{-specs=} option to specify the
7408 appropriate directory location.  The Parallel Environment does not
7409 support threads, so the @option{-mpe} option and the @option{-pthread}
7410 option are incompatible.
7411
7412 @item -malign-natural
7413 @itemx -malign-power
7414 @opindex malign-natural
7415 @opindex malign-power
7416 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7417 @option{-malign-natural} overrides the ABI-defined alignment of larger
7418 types, such as floating-point doubles, on their natural size-based boundary.
7419 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7420 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7421
7422 @item -msoft-float
7423 @itemx -mhard-float
7424 @opindex msoft-float
7425 @opindex mhard-float
7426 Generate code that does not use (uses) the floating-point register set.
7427 Software floating point emulation is provided if you use the
7428 @option{-msoft-float} option, and pass the option to GCC when linking.
7429
7430 @item -mmultiple
7431 @itemx -mno-multiple
7432 @opindex mmultiple
7433 @opindex mno-multiple
7434 Generate code that uses (does not use) the load multiple word
7435 instructions and the store multiple word instructions.  These
7436 instructions are generated by default on POWER systems, and not
7437 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7438 endian PowerPC systems, since those instructions do not work when the
7439 processor is in little endian mode.  The exceptions are PPC740 and
7440 PPC750 which permit the instructions usage in little endian mode.
7441
7442 @item -mstring
7443 @itemx -mno-string
7444 @opindex mstring
7445 @opindex mno-string
7446 Generate code that uses (does not use) the load string instructions
7447 and the store string word instructions to save multiple registers and
7448 do small block moves.  These instructions are generated by default on
7449 POWER systems, and not generated on PowerPC systems.  Do not use
7450 @option{-mstring} on little endian PowerPC systems, since those
7451 instructions do not work when the processor is in little endian mode.
7452 The exceptions are PPC740 and PPC750 which permit the instructions
7453 usage in little endian mode.
7454
7455 @item -mupdate
7456 @itemx -mno-update
7457 @opindex mupdate
7458 @opindex mno-update
7459 Generate code that uses (does not use) the load or store instructions
7460 that update the base register to the address of the calculated memory
7461 location.  These instructions are generated by default.  If you use
7462 @option{-mno-update}, there is a small window between the time that the
7463 stack pointer is updated and the address of the previous frame is
7464 stored, which means code that walks the stack frame across interrupts or
7465 signals may get corrupted data.
7466
7467 @item -mfused-madd
7468 @itemx -mno-fused-madd
7469 @opindex mfused-madd
7470 @opindex mno-fused-madd
7471 Generate code that uses (does not use) the floating point multiply and
7472 accumulate instructions.  These instructions are generated by default if
7473 hardware floating is used.
7474
7475 @item -mno-bit-align
7476 @itemx -mbit-align
7477 @opindex mno-bit-align
7478 @opindex mbit-align
7479 On System V.4 and embedded PowerPC systems do not (do) force structures
7480 and unions that contain bit-fields to be aligned to the base type of the
7481 bit-field.
7482
7483 For example, by default a structure containing nothing but 8
7484 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7485 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7486 the structure would be aligned to a 1 byte boundary and be one byte in
7487 size.
7488
7489 @item -mno-strict-align
7490 @itemx -mstrict-align
7491 @opindex mno-strict-align
7492 @opindex mstrict-align
7493 On System V.4 and embedded PowerPC systems do not (do) assume that
7494 unaligned memory references will be handled by the system.
7495
7496 @item -mrelocatable
7497 @itemx -mno-relocatable
7498 @opindex mrelocatable
7499 @opindex mno-relocatable
7500 On embedded PowerPC systems generate code that allows (does not allow)
7501 the program to be relocated to a different address at runtime.  If you
7502 use @option{-mrelocatable} on any module, all objects linked together must
7503 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7504
7505 @item -mrelocatable-lib
7506 @itemx -mno-relocatable-lib
7507 @opindex mrelocatable-lib
7508 @opindex mno-relocatable-lib
7509 On embedded PowerPC systems generate code that allows (does not allow)
7510 the program to be relocated to a different address at runtime.  Modules
7511 compiled with @option{-mrelocatable-lib} can be linked with either modules
7512 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7513 with modules compiled with the @option{-mrelocatable} options.
7514
7515 @item -mno-toc
7516 @itemx -mtoc
7517 @opindex mno-toc
7518 @opindex mtoc
7519 On System V.4 and embedded PowerPC systems do not (do) assume that
7520 register 2 contains a pointer to a global area pointing to the addresses
7521 used in the program.
7522
7523 @item -mlittle
7524 @itemx -mlittle-endian
7525 @opindex mlittle
7526 @opindex mlittle-endian
7527 On System V.4 and embedded PowerPC systems compile code for the
7528 processor in little endian mode.  The @option{-mlittle-endian} option is
7529 the same as @option{-mlittle}.
7530
7531 @item -mbig
7532 @itemx -mbig-endian
7533 @opindex mbig
7534 @opindex mbig-endian
7535 On System V.4 and embedded PowerPC systems compile code for the
7536 processor in big endian mode.  The @option{-mbig-endian} option is
7537 the same as @option{-mbig}.
7538
7539 @item -mdynamic-no-pic
7540 @opindex mdynamic-no-pic
7541 On Darwin and Mac OS X systems, compile code so that it is not
7542 relocatable, but that its external references are relocatable.  The
7543 resulting code is suitable for applications, but not shared
7544 libraries.
7545
7546 @item -mprioritize-restricted-insns=@var{priority}
7547 @opindex mprioritize-restricted-insns
7548 This option controls the priority that is assigned to 
7549 dispatch-slot restricted instructions during the second scheduling 
7550 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign 
7551 @var{no/highest/second-highest} priority to dispatch slot restricted 
7552 instructions.
7553
7554 @item -msched-costly-dep=@var{dependence_type}
7555 @opindex msched-costly-dep
7556 This option controls which dependences are considered costly
7557 by the target during instruction scheduling.  The argument
7558 @var{dependence_type} takes one of the following values:
7559 @var{no}: no dependence is costly, 
7560 @var{all}: all dependences are costly, 
7561 @var{true_store_to_load}: a true dependence from store to load is costly,
7562 @var{store_to_load}: any dependence from store to load is costly,
7563 @var{number}: any dependence which latency >= @var{number} is costly.
7564  
7565 @item -mcall-sysv
7566 @opindex mcall-sysv
7567 On System V.4 and embedded PowerPC systems compile code using calling
7568 conventions that adheres to the March 1995 draft of the System V
7569 Application Binary Interface, PowerPC processor supplement.  This is the
7570 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7571
7572 @item -mcall-sysv-eabi
7573 @opindex mcall-sysv-eabi
7574 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7575
7576 @item -mcall-sysv-noeabi
7577 @opindex mcall-sysv-noeabi
7578 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7579
7580 @item -mcall-solaris
7581 @opindex mcall-solaris
7582 On System V.4 and embedded PowerPC systems compile code for the Solaris
7583 operating system.
7584
7585 @item -mcall-linux
7586 @opindex mcall-linux
7587 On System V.4 and embedded PowerPC systems compile code for the
7588 Linux-based GNU system.
7589
7590 @item -mcall-gnu
7591 @opindex mcall-gnu
7592 On System V.4 and embedded PowerPC systems compile code for the
7593 Hurd-based GNU system.
7594
7595 @item -mcall-netbsd
7596 @opindex mcall-netbsd
7597 On System V.4 and embedded PowerPC systems compile code for the
7598 NetBSD operating system.
7599
7600 @item -maix-struct-return
7601 @opindex maix-struct-return
7602 Return all structures in memory (as specified by the AIX ABI)@.
7603
7604 @item -msvr4-struct-return
7605 @opindex msvr4-struct-return
7606 Return structures smaller than 8 bytes in registers (as specified by the
7607 SVR4 ABI)@.
7608
7609 @item -mabi=altivec
7610 @opindex mabi=altivec
7611 Extend the current ABI with AltiVec ABI extensions.  This does not
7612 change the default ABI, instead it adds the AltiVec ABI extensions to
7613 the current ABI@.
7614
7615 @item -mabi=no-altivec
7616 @opindex mabi=no-altivec
7617 Disable AltiVec ABI extensions for the current ABI.
7618
7619 @item -mprototype
7620 @itemx -mno-prototype
7621 @opindex mprototype
7622 @opindex mno-prototype
7623 On System V.4 and embedded PowerPC systems assume that all calls to
7624 variable argument functions are properly prototyped.  Otherwise, the
7625 compiler must insert an instruction before every non prototyped call to
7626 set or clear bit 6 of the condition code register (@var{CR}) to
7627 indicate whether floating point values were passed in the floating point
7628 registers in case the function takes a variable arguments.  With
7629 @option{-mprototype}, only calls to prototyped variable argument functions
7630 will set or clear the bit.
7631
7632 @item -msim
7633 @opindex msim
7634 On embedded PowerPC systems, assume that the startup module is called
7635 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7636 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7637 configurations.
7638
7639 @item -mmvme
7640 @opindex mmvme
7641 On embedded PowerPC systems, assume that the startup module is called
7642 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7643 @file{libc.a}.
7644
7645 @item -mads
7646 @opindex mads
7647 On embedded PowerPC systems, assume that the startup module is called
7648 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7649 @file{libc.a}.
7650
7651 @item -myellowknife
7652 @opindex myellowknife
7653 On embedded PowerPC systems, assume that the startup module is called
7654 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7655 @file{libc.a}.
7656
7657 @item -mvxworks
7658 @opindex mvxworks
7659 On System V.4 and embedded PowerPC systems, specify that you are
7660 compiling for a VxWorks system.
7661
7662 @item -mwindiss
7663 @opindex mwindiss
7664 Specify that you are compiling for the WindISS simulation environment.
7665
7666 @item -memb
7667 @opindex memb
7668 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7669 header to indicate that @samp{eabi} extended relocations are used.
7670
7671 @item -meabi
7672 @itemx -mno-eabi
7673 @opindex meabi
7674 @opindex mno-eabi
7675 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7676 Embedded Applications Binary Interface (eabi) which is a set of
7677 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7678 means that the stack is aligned to an 8 byte boundary, a function
7679 @code{__eabi} is called to from @code{main} to set up the eabi
7680 environment, and the @option{-msdata} option can use both @code{r2} and
7681 @code{r13} to point to two separate small data areas.  Selecting
7682 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7683 do not call an initialization function from @code{main}, and the
7684 @option{-msdata} option will only use @code{r13} to point to a single
7685 small data area.  The @option{-meabi} option is on by default if you
7686 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7687
7688 @item -msdata=eabi
7689 @opindex msdata=eabi
7690 On System V.4 and embedded PowerPC systems, put small initialized
7691 @code{const} global and static data in the @samp{.sdata2} section, which
7692 is pointed to by register @code{r2}.  Put small initialized
7693 non-@code{const} global and static data in the @samp{.sdata} section,
7694 which is pointed to by register @code{r13}.  Put small uninitialized
7695 global and static data in the @samp{.sbss} section, which is adjacent to
7696 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7697 incompatible with the @option{-mrelocatable} option.  The
7698 @option{-msdata=eabi} option also sets the @option{-memb} option.
7699
7700 @item -msdata=sysv
7701 @opindex msdata=sysv
7702 On System V.4 and embedded PowerPC systems, put small global and static
7703 data in the @samp{.sdata} section, which is pointed to by register
7704 @code{r13}.  Put small uninitialized global and static data in the
7705 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7706 The @option{-msdata=sysv} option is incompatible with the
7707 @option{-mrelocatable} option.
7708
7709 @item -msdata=default
7710 @itemx -msdata
7711 @opindex msdata=default
7712 @opindex msdata
7713 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7714 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7715 same as @option{-msdata=sysv}.
7716
7717 @item -msdata-data
7718 @opindex msdata-data
7719 On System V.4 and embedded PowerPC systems, put small global and static
7720 data in the @samp{.sdata} section.  Put small uninitialized global and
7721 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7722 to address small data however.  This is the default behavior unless
7723 other @option{-msdata} options are used.
7724
7725 @item -msdata=none
7726 @itemx -mno-sdata
7727 @opindex msdata=none
7728 @opindex mno-sdata
7729 On embedded PowerPC systems, put all initialized global and static data
7730 in the @samp{.data} section, and all uninitialized data in the
7731 @samp{.bss} section.
7732
7733 @item -G @var{num}
7734 @opindex G
7735 @cindex smaller data references (PowerPC)
7736 @cindex .sdata/.sdata2 references (PowerPC)
7737 On embedded PowerPC systems, put global and static items less than or
7738 equal to @var{num} bytes into the small data or bss sections instead of
7739 the normal data or bss section.  By default, @var{num} is 8.  The
7740 @option{-G @var{num}} switch is also passed to the linker.
7741 All modules should be compiled with the same @option{-G @var{num}} value.
7742
7743 @item -mregnames
7744 @itemx -mno-regnames
7745 @opindex mregnames
7746 @opindex mno-regnames
7747 On System V.4 and embedded PowerPC systems do (do not) emit register
7748 names in the assembly language output using symbolic forms.
7749
7750 @item -mlongcall
7751 @itemx -mno-longcall
7752 @opindex mlongcall
7753 @opindex mno-longcall
7754 Default to making all function calls via pointers, so that functions
7755 which reside further than 64 megabytes (67,108,864 bytes) from the
7756 current location can be called.  This setting can be overridden by the
7757 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7758
7759 Some linkers are capable of detecting out-of-range calls and generating
7760 glue code on the fly.  On these systems, long calls are unnecessary and
7761 generate slower code.  As of this writing, the AIX linker can do this,
7762 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7763 to the GNU linker for 32-bit PowerPC systems as well.
7764
7765 In the future, we may cause GCC to ignore all longcall specifications
7766 when the linker is known to generate glue.
7767
7768 @item -pthread
7769 @opindex pthread
7770 Adds support for multithreading with the @dfn{pthreads} library.
7771 This option sets flags for both the preprocessor and linker.
7772
7773 @end table
7774
7775 @node Darwin Options
7776 @subsection Darwin Options
7777 @cindex Darwin options
7778
7779 These options are defined for all architectures running the Darwin operating
7780 system.  They are useful for compatibility with other Mac OS compilers.
7781
7782 @table @gcctabopt
7783 @item -all_load    
7784 @opindex all_load   
7785 Loads all members of static archive libraries.
7786 See man ld(1) for more information.
7787
7788 @item -arch_errors_fatal
7789 @opindex arch_errors_fatal
7790 Cause the errors having to do with files that have the wrong architecture
7791 to be fatal.
7792
7793 @item -bind_at_load
7794 @opindex bind_at_load
7795 Causes the output file to be marked such that the dynamic linker will
7796 bind all undefined references when the file is loaded or launched.
7797
7798 @item -bundle     
7799 @opindex bundle
7800 Produce a Mach-o bundle format file.
7801 See man ld(1) for more information.
7802
7803 @item -bundle_loader @var{executable}
7804 @opindex bundle_loader
7805 This specifies the @var{executable} that will be loading the build
7806 output file being linked. See man ld(1) for more information.
7807
7808 @item -allowable_client  @var{client_name}
7809 @item -arch_only
7810
7811 @item -client_name       
7812 @item -compatibility_version
7813 @item -current_version    
7814 @item -dependency-file
7815 @item -dylib_file    
7816 @item -dylinker_install_name
7817 @item -dynamic
7818 @item -dynamiclib   
7819 @item -exported_symbols_list  
7820 @item -filelist
7821 @item -flat_namespace   
7822 @item -force_cpusubtype_ALL
7823 @item -force_flat_namespace   
7824 @item -headerpad_max_install_names
7825 @item -image_base  
7826 @item -init
7827 @item -install_name
7828 @item -keep_private_externs
7829 @item -multi_module
7830 @item -multiply_defined      
7831 @item -multiply_defined_unused      
7832 @item -noall_load  
7833 @item -nofixprebinding
7834 @item -nomultidefs
7835 @item -noprebind     
7836 @item -noseglinkedit
7837 @item -pagezero_size    
7838 @item -prebind
7839 @item -prebind_all_twolevel_modules
7840 @item -private_bundle
7841 @item -read_only_relocs
7842 @item -sectalign  
7843 @item -sectobjectsymbols    
7844 @item -whyload
7845 @item -seg1addr 
7846 @item -sectcreate
7847 @item -sectobjectsymbols
7848 @item -sectorder
7849 @item -seg_addr_table
7850 @item -seg_addr_table_filename
7851 @item -seglinkedit
7852 @item -segprot   
7853 @item -segs_read_only_addr
7854 @item -segs_read_write_addr
7855 @item -single_module   
7856 @item -static
7857 @item -sub_library
7858 @item -sub_umbrella 
7859 @item -twolevel_namespace
7860 @item -umbrella
7861 @item -undefined
7862 @item -unexported_symbols_list
7863 @item -weak_reference_mismatches
7864 @item -whatsloaded  
7865
7866 @opindex allowable_client
7867 @opindex arch_only    
7868 @opindex client_name
7869 @opindex compatibility_version
7870 @opindex current_version
7871 @opindex dependency-file
7872 @opindex dylib_file
7873 @opindex dylinker_install_name
7874 @opindex dynamic
7875 @opindex dynamiclib
7876 @opindex exported_symbols_list
7877 @opindex filelist  
7878 @opindex flat_namespace    
7879 @opindex force_cpusubtype_ALL
7880 @opindex force_flat_namespace
7881 @opindex headerpad_max_install_names
7882 @opindex image_base
7883 @opindex init     
7884 @opindex install_name
7885 @opindex keep_private_externs
7886 @opindex multi_module   
7887 @opindex multiply_defined
7888 @opindex multiply_defined_unused   
7889 @opindex noall_load  
7890 @opindex nofixprebinding
7891 @opindex nomultidefs   
7892 @opindex noprebind
7893 @opindex noseglinkedit      
7894 @opindex pagezero_size
7895 @opindex prebind
7896 @opindex prebind_all_twolevel_modules
7897 @opindex private_bundle 
7898 @opindex read_only_relocs
7899 @opindex sectalign   
7900 @opindex sectobjectsymbols    
7901 @opindex whyload  
7902 @opindex seg1addr
7903 @opindex sectcreate       
7904 @opindex sectobjectsymbols 
7905 @opindex sectorder     
7906 @opindex seg_addr_table
7907 @opindex seg_addr_table_filename
7908 @opindex seglinkedit
7909 @opindex segprot
7910 @opindex segs_read_only_addr
7911 @opindex segs_read_write_addr
7912 @opindex single_module
7913 @opindex static
7914 @opindex sub_library
7915 @opindex sub_umbrella
7916 @opindex twolevel_namespace
7917 @opindex umbrella
7918 @opindex undefined
7919 @opindex unexported_symbols_list
7920 @opindex weak_reference_mismatches
7921 @opindex whatsloaded
7922
7923 This options are available for Darwin linker. Darwin linker man page
7924 describes them in detail.
7925 @end table
7926
7927
7928 @node RT Options
7929 @subsection IBM RT Options
7930 @cindex RT options
7931 @cindex IBM RT options
7932
7933 These @samp{-m} options are defined for the IBM RT PC:
7934
7935 @table @gcctabopt
7936 @item -min-line-mul
7937 @opindex min-line-mul
7938 Use an in-line code sequence for integer multiplies.  This is the
7939 default.
7940
7941 @item -mcall-lib-mul
7942 @opindex mcall-lib-mul
7943 Call @code{lmul$$} for integer multiples.
7944
7945 @item -mfull-fp-blocks
7946 @opindex mfull-fp-blocks
7947 Generate full-size floating point data blocks, including the minimum
7948 amount of scratch space recommended by IBM@.  This is the default.
7949
7950 @item -mminimum-fp-blocks
7951 @opindex mminimum-fp-blocks
7952 Do not include extra scratch space in floating point data blocks.  This
7953 results in smaller code, but slower execution, since scratch space must
7954 be allocated dynamically.
7955
7956 @cindex @file{stdarg.h} and RT PC
7957 @item -mfp-arg-in-fpregs
7958 @opindex mfp-arg-in-fpregs
7959 Use a calling sequence incompatible with the IBM calling convention in
7960 which floating point arguments are passed in floating point registers.
7961 Note that @code{stdarg.h} will not work with floating point operands
7962 if this option is specified.
7963
7964 @item -mfp-arg-in-gregs
7965 @opindex mfp-arg-in-gregs
7966 Use the normal calling convention for floating point arguments.  This is
7967 the default.
7968
7969 @item -mhc-struct-return
7970 @opindex mhc-struct-return
7971 Return structures of more than one word in memory, rather than in a
7972 register.  This provides compatibility with the MetaWare HighC (hc)
7973 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7974 with the Portable C Compiler (pcc).
7975
7976 @item -mnohc-struct-return
7977 @opindex mnohc-struct-return
7978 Return some structures of more than one word in registers, when
7979 convenient.  This is the default.  For compatibility with the
7980 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7981 option @option{-mhc-struct-return}.
7982 @end table
7983
7984 @node MIPS Options
7985 @subsection MIPS Options
7986 @cindex MIPS options
7987
7988 These @samp{-m} options are defined for the MIPS family of computers:
7989
7990 @table @gcctabopt
7991
7992 @item -march=@var{arch}
7993 @opindex march
7994 Generate code that will run on @var{arch}, which can be the name of a
7995 generic MIPS ISA, or the name of a particular processor.
7996 The ISA names are:
7997 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7998 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7999 The processor names are:
8000 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
8001 @samp{m4k},
8002 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
8003 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
8004 @samp{rm9000},
8005 @samp{orion},
8006 @samp{sb1},
8007 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
8008 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
8009 The special value @samp{from-abi} selects the
8010 most compatible architecture for the selected ABI (that is,
8011 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
8012
8013 In processor names, a final @samp{000} can be abbreviated as @samp{k}
8014 (for example, @samp{-march=r2k}).  Prefixes are optional, and
8015 @samp{vr} may be written @samp{r}.
8016
8017 GCC defines two macros based on the value of this option.  The first
8018 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
8019 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
8020 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
8021 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
8022 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
8023
8024 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
8025 above.  In other words, it will have the full prefix and will not
8026 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
8027 the macro names the resolved architecture (either @samp{"mips1"} or
8028 @samp{"mips3"}).  It names the default architecture when no
8029 @option{-march} option is given.
8030
8031 @item -mtune=@var{arch}
8032 @opindex mtune
8033 Optimize for @var{arch}.  Among other things, this option controls
8034 the way instructions are scheduled, and the perceived cost of arithmetic
8035 operations.  The list of @var{arch} values is the same as for
8036 @option{-march}.
8037
8038 When this option is not used, GCC will optimize for the processor
8039 specified by @option{-march}.  By using @option{-march} and
8040 @option{-mtune} together, it is possible to generate code that will
8041 run on a family of processors, but optimize the code for one
8042 particular member of that family.
8043
8044 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
8045 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
8046 @samp{-march} ones described above.
8047
8048 @item -mips1
8049 @opindex mips1
8050 Equivalent to @samp{-march=mips1}.
8051
8052 @item -mips2
8053 @opindex mips2
8054 Equivalent to @samp{-march=mips2}.
8055
8056 @item -mips3
8057 @opindex mips3
8058 Equivalent to @samp{-march=mips3}.
8059
8060 @item -mips4
8061 @opindex mips4
8062 Equivalent to @samp{-march=mips4}.
8063
8064 @item -mips32
8065 @opindex mips32
8066 Equivalent to @samp{-march=mips32}.
8067
8068 @item -mips32r2
8069 @opindex mips32r2
8070 Equivalent to @samp{-march=mips32r2}.
8071
8072 @item -mips64
8073 @opindex mips64
8074 Equivalent to @samp{-march=mips64}.
8075
8076 @item -mfused-madd
8077 @itemx -mno-fused-madd
8078 @opindex mfused-madd
8079 @opindex mno-fused-madd
8080 Generate code that uses (does not use) the floating point multiply and
8081 accumulate instructions, when they are available.  These instructions
8082 are generated by default if they are available, but this may be
8083 undesirable if the extra precision causes problems or on certain chips
8084 in the mode where denormals are rounded to zero where denormals
8085 generated by multiply and accumulate instructions cause exceptions
8086 anyway.
8087
8088 @item -mfp32
8089 @opindex mfp32
8090 Assume that floating point registers are 32 bits wide.
8091
8092 @item -mfp64
8093 @opindex mfp64
8094 Assume that floating point registers are 64 bits wide.
8095
8096 @item -mgp32
8097 @opindex mgp32
8098 Assume that general purpose registers are 32 bits wide.
8099
8100 @item -mgp64
8101 @opindex mgp64
8102 Assume that general purpose registers are 64 bits wide.
8103
8104 @item -mint64
8105 @opindex mint64
8106 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
8107 explanation of the default, and the width of pointers.
8108
8109 @item -mlong64
8110 @opindex mlong64
8111 Force long types to be 64 bits wide.  See @option{-mlong32} for an
8112 explanation of the default, and the width of pointers.
8113
8114 @item -mlong32
8115 @opindex mlong32
8116 Force long, int, and pointer types to be 32 bits wide.
8117
8118 The default size of ints, longs and pointers depends on the ABI@.  All
8119 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
8120 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
8121 are the same size as longs, or the same size as integer registers,
8122 whichever is smaller.
8123
8124 @item -mabi=32
8125 @itemx -mabi=o64
8126 @itemx -mabi=n32
8127 @itemx -mabi=64
8128 @itemx -mabi=eabi
8129 @itemx -mabi=meabi
8130 @opindex mabi=32
8131 @opindex mabi=o64
8132 @opindex mabi=n32
8133 @opindex mabi=64
8134 @opindex mabi=eabi
8135 @opindex mabi=meabi
8136 Generate code for the given ABI@.
8137
8138 Note that there are two embedded ABIs: @option{-mabi=eabi}
8139 selects the one defined by Cygnus while @option{-meabi=meabi}
8140 selects the one defined by MIPS@.  Both these ABIs have
8141 32-bit and 64-bit variants.  Normally, GCC will generate
8142 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 -mabi-fake-default
8146 @opindex mabi-fake-default
8147 You don't want to know what this option does.  No, really.  I mean
8148 it.  Move on to the next option.
8149
8150 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
8151 wants the default set of options to get the root of the multilib tree,
8152 and the shared library SONAMEs without any multilib-indicating
8153 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
8154 we want to default to the N32 ABI, while still being binary-compatible
8155 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
8156 binary-compatible means shared libraries should have the same SONAMEs,
8157 and libraries should live in the same location.  Having O32 libraries
8158 in a sub-directory named say @file{o32} is not acceptable.
8159
8160 So we trick GCC into believing that O32 is the default ABI, except
8161 that we override the default with some internal command-line
8162 processing magic.  Problem is, if we stopped at that, and you then
8163 created a multilib-aware package that used the output of @command{gcc
8164 -print-multi-lib} to decide which multilibs to build, and how, and
8165 you'd find yourself in an awkward situation when you found out that
8166 some of the options listed ended up mapping to the same multilib, and
8167 none of your libraries was actually built for the multilib that
8168 @option{-print-multi-lib} claims to be the default.  So we added this
8169 option that disables the default switcher, falling back to GCC's
8170 original notion of the default library.  Confused yet?
8171
8172 For short: don't ever use this option, unless you find it in the list
8173 of additional options to be used when building for multilibs, in the
8174 output of @option{gcc -print-multi-lib}.
8175
8176 @item -mmips-as
8177 @opindex mmips-as
8178 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
8179 add normal debug information.  This is the default for all
8180 platforms except for the OSF/1 reference platform, using the OSF/rose
8181 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
8182 switches are used, the @file{mips-tfile} program will encapsulate the
8183 stabs within MIPS ECOFF@.
8184
8185 @item -mgas
8186 @opindex mgas
8187 Generate code for the GNU assembler.  This is the default on the OSF/1
8188 reference platform, using the OSF/rose object format.  Also, this is
8189 the default if the configure option @option{--with-gnu-as} is used.
8190
8191 @item -msplit-addresses
8192 @itemx -mno-split-addresses
8193 @opindex msplit-addresses
8194 @opindex mno-split-addresses
8195 Generate code to load the high and low parts of address constants separately.
8196 This allows GCC to optimize away redundant loads of the high order
8197 bits of addresses.  This optimization requires GNU as and GNU ld.
8198 This optimization is enabled by default for some embedded targets where
8199 GNU as and GNU ld are standard.
8200
8201 @item -mrnames
8202 @itemx -mno-rnames
8203 @opindex mrnames
8204 @opindex mno-rnames
8205 The @option{-mrnames} switch says to output code using the MIPS software
8206 names for the registers, instead of the hardware names (ie, @var{a0}
8207 instead of @var{$4}).  The only known assembler that supports this option
8208 is the Algorithmics assembler.
8209
8210 @item -mmemcpy
8211 @itemx -mno-memcpy
8212 @opindex mmemcpy
8213 @opindex mno-memcpy
8214 The @option{-mmemcpy} switch makes all block moves call the appropriate
8215 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
8216 generating inline code.
8217
8218 @item -mmips-tfile
8219 @itemx -mno-mips-tfile
8220 @opindex mmips-tfile
8221 @opindex mno-mips-tfile
8222 The @option{-mno-mips-tfile} switch causes the compiler not
8223 postprocess the object file with the @file{mips-tfile} program,
8224 after the MIPS assembler has generated it to add debug support.  If
8225 @file{mips-tfile} is not run, then no local variables will be
8226 available to the debugger.  In addition, @file{stage2} and
8227 @file{stage3} objects will have the temporary file names passed to the
8228 assembler embedded in the object file, which means the objects will
8229 not compare the same.  The @option{-mno-mips-tfile} switch should only
8230 be used when there are bugs in the @file{mips-tfile} program that
8231 prevents compilation.
8232
8233 @item -msoft-float
8234 @opindex msoft-float
8235 Generate output containing library calls for floating point.
8236 @strong{Warning:} the requisite libraries are not part of GCC@.
8237 Normally the facilities of the machine's usual C compiler are used, but
8238 this can't be done directly in cross-compilation.  You must make your
8239 own arrangements to provide suitable library functions for
8240 cross-compilation.
8241
8242 @item -mhard-float
8243 @opindex mhard-float
8244 Generate output containing floating point instructions.  This is the
8245 default if you use the unmodified sources.
8246
8247 @item -mabicalls
8248 @itemx -mno-abicalls
8249 @opindex mabicalls
8250 @opindex mno-abicalls
8251 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8252 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8253 position independent code.
8254
8255 @item -mxgot
8256 @itemx -mno-xgot
8257 @opindex mxgot
8258 @opindex mno-xgot
8259 Lift (or do not lift) the usual restrictions on the size of the global
8260 offset table.
8261
8262 GCC normally uses a single instruction to load values from the GOT.
8263 While this is relatively efficient, it will only work if the GOT
8264 is smaller than about 64k.  Anything larger will cause the linker
8265 to report an error such as:
8266
8267 @cindex relocation truncated to fit (MIPS)
8268 @smallexample
8269 relocation truncated to fit: R_MIPS_GOT16 foobar
8270 @end smallexample
8271
8272 If this happens, you should recompile your code with @option{-mxgot}.
8273 It should then work with very large GOTs, although it will also be
8274 less efficient, since it will take three instructions to fetch the
8275 value of a global symbol.
8276
8277 Note that some linkers can create multiple GOTs.  If you have such a
8278 linker, you should only need to use @option{-mxgot} when a single object
8279 file accesses more than 64k's worth of GOT entries.  Very few do.
8280
8281 These options have no effect unless GCC is generating position
8282 independent code.
8283
8284 @item -mlong-calls
8285 @itemx -mno-long-calls
8286 @opindex mlong-calls
8287 @opindex mno-long-calls
8288 Do all calls with the @samp{JALR} instruction, which requires
8289 loading up a function's address into a register before the call.
8290 You need to use this switch, if you call outside of the current
8291 512 megabyte segment to functions that are not through pointers.
8292
8293 @item -membedded-pic
8294 @itemx -mno-embedded-pic
8295 @opindex membedded-pic
8296 @opindex mno-embedded-pic
8297 Generate PIC code suitable for some embedded systems.  All calls are
8298 made using PC relative address, and all data is addressed using the $gp
8299 register.  No more than 65536 bytes of global data may be used.  This
8300 requires GNU as and GNU ld which do most of the work.  This currently
8301 only works on targets which use ECOFF; it does not work with ELF@.
8302
8303 @item -membedded-data
8304 @itemx -mno-embedded-data
8305 @opindex membedded-data
8306 @opindex mno-embedded-data
8307 Allocate variables to the read-only data section first if possible, then
8308 next in the small data section if possible, otherwise in data.  This gives
8309 slightly slower code than the default, but reduces the amount of RAM required
8310 when executing, and thus may be preferred for some embedded systems.
8311
8312 @item -muninit-const-in-rodata
8313 @itemx -mno-uninit-const-in-rodata
8314 @opindex muninit-const-in-rodata
8315 @opindex mno-uninit-const-in-rodata
8316 When used together with @option{-membedded-data}, it will always store uninitialized
8317 const variables in the read-only data section.
8318
8319 @item -msingle-float
8320 @itemx -mdouble-float
8321 @opindex msingle-float
8322 @opindex mdouble-float
8323 The @option{-msingle-float} switch tells gcc to assume that the floating
8324 point coprocessor only supports single precision operations, as on the
8325 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8326 double precision operations.  This is the default.
8327
8328 @item -mmad
8329 @itemx -mno-mad
8330 @opindex mmad
8331 @opindex mno-mad
8332 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8333 as on the @samp{r4650} chip.
8334
8335 @item -m4650
8336 @opindex m4650
8337 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8338 @option{-mcpu=r4650}.
8339
8340 @item -mips16
8341 @itemx -mno-mips16
8342 @opindex mips16
8343 @opindex mno-mips16
8344 Enable 16-bit instructions.
8345
8346 @item -EL
8347 @opindex EL
8348 Compile code for the processor in little endian mode.
8349 The requisite libraries are assumed to exist.
8350
8351 @item -EB
8352 @opindex EB
8353 Compile code for the processor in big endian mode.
8354 The requisite libraries are assumed to exist.
8355
8356 @item -G @var{num}
8357 @opindex G
8358 @cindex smaller data references (MIPS)
8359 @cindex gp-relative references (MIPS)
8360 Put global and static items less than or equal to @var{num} bytes into
8361 the small data or bss sections instead of the normal data or bss
8362 section.  This allows the assembler to emit one word memory reference
8363 instructions based on the global pointer (@var{gp} or @var{$28}),
8364 instead of the normal two words used.  By default, @var{num} is 8 when
8365 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8366 @option{-G @var{num}} switch is also passed to the assembler and linker.
8367 All modules should be compiled with the same @option{-G @var{num}}
8368 value.
8369
8370 @item -nocpp
8371 @opindex nocpp
8372 Tell the MIPS assembler to not run its preprocessor over user
8373 assembler files (with a @samp{.s} suffix) when assembling them.
8374
8375 @item -mfix7000
8376 @opindex mfix7000
8377 Pass an option to gas which will cause nops to be inserted if
8378 the read of the destination register of an mfhi or mflo instruction
8379 occurs in the following two instructions.
8380
8381 @item -mfix-sb1
8382 @itemx -mno-fix-sb1
8383 @opindex mfix-sb1
8384 Work around certain SB-1 CPU core errata.
8385 (This flag currently works around the SB-1 revision 2
8386 ``F1'' and ``F2'' floating point errata.)
8387
8388 @item -no-crt0
8389 @opindex no-crt0
8390 Do not include the default crt0.
8391
8392 @item -mflush-func=@var{func}
8393 @itemx -mno-flush-func
8394 @opindex mflush-func
8395 Specifies the function to call to flush the I and D caches, or to not
8396 call any such function.  If called, the function must take the same
8397 arguments as the common @code{_flush_func()}, that is, the address of the
8398 memory range for which the cache is being flushed, the size of the
8399 memory range, and the number 3 (to flush both caches).  The default
8400 depends on the target gcc was configured for, but commonly is either
8401 @samp{_flush_func} or @samp{__cpu_flush}.
8402
8403 @item -mbranch-likely
8404 @itemx -mno-branch-likely
8405 @opindex mbranch-likely
8406 @opindex mno-branch-likely
8407 Enable or disable use of Branch Likely instructions, regardless of the
8408 default for the selected architecture.  By default, Branch Likely
8409 instructions may be generated if they are supported by the selected
8410 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8411 and processors which implement those architectures; for those, Branch
8412 Likely instructions will not be generated by default because the MIPS32
8413 and MIPS64 architectures specifically deprecate their use.
8414 @end table
8415
8416 @node i386 and x86-64 Options
8417 @subsection Intel 386 and AMD x86-64 Options
8418 @cindex i386 Options
8419 @cindex x86-64 Options
8420 @cindex Intel 386 Options
8421 @cindex AMD x86-64 Options
8422
8423 These @samp{-m} options are defined for the i386 and x86-64 family of
8424 computers:
8425
8426 @table @gcctabopt
8427 @item -mtune=@var{cpu-type}
8428 @opindex mtune
8429 Tune to @var{cpu-type} everything applicable about the generated code, except
8430 for the ABI and the set of available instructions.  The choices for
8431 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8432 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8433 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8434 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8435 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8436 and @samp{c3-2}.
8437
8438 While picking a specific @var{cpu-type} will schedule things appropriately
8439 for that particular chip, the compiler will not generate any code that
8440 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8441 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8442 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8443 AMD chips as opposed to the Intel ones.
8444
8445 @item -march=@var{cpu-type}
8446 @opindex march
8447 Generate instructions for the machine type @var{cpu-type}.  The choices
8448 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8449 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8450
8451 @item -mcpu=@var{cpu-type}
8452 @opindex mcpu
8453 A deprecated synonym for @option{-mtune}.
8454
8455 @item -m386
8456 @itemx -m486
8457 @itemx -mpentium
8458 @itemx -mpentiumpro
8459 @opindex m386
8460 @opindex m486
8461 @opindex mpentium
8462 @opindex mpentiumpro
8463 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8464 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8465 These synonyms are deprecated.
8466
8467 @item -mfpmath=@var{unit}
8468 @opindex march
8469 generate floating point arithmetics for selected unit @var{unit}.  the choices
8470 for @var{unit} are:
8471
8472 @table @samp
8473 @item 387
8474 Use the standard 387 floating point coprocessor present majority of chips and
8475 emulated otherwise.  Code compiled with this option will run almost everywhere.
8476 The temporary results are computed in 80bit precision instead of precision
8477 specified by the type resulting in slightly different results compared to most
8478 of other chips. See @option{-ffloat-store} for more detailed description.
8479
8480 This is the default choice for i386 compiler.
8481
8482 @item sse
8483 Use scalar floating point instructions present in the SSE instruction set.
8484 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8485 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8486 instruction set supports only single precision arithmetics, thus the double and
8487 extended precision arithmetics is still done using 387.  Later version, present
8488 only in Pentium4 and the future AMD x86-64 chips supports double precision
8489 arithmetics too.
8490
8491 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8492 @option{-msse2} switches to enable SSE extensions and make this option
8493 effective.  For x86-64 compiler, these extensions are enabled by default.
8494
8495 The resulting code should be considerably faster in majority of cases and avoid
8496 the numerical instability problems of 387 code, but may break some existing
8497 code that expects temporaries to be 80bit.
8498
8499 This is the default choice for x86-64 compiler.
8500
8501 @item pni
8502 Use all SSE extensions enabled by @option{-msse2} as well as the new
8503 SSE extensions in Prescott New Instructions. @option{-mpni} also
8504 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8505 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8506 @code{mwait}. 
8507
8508 @item sse,387
8509 Attempt to utilize both instruction sets at once.  This effectively double the
8510 amount of available registers and on chips with separate execution units for
8511 387 and SSE the execution resources too.  Use this option with care, as it is
8512 still experimental, because gcc register allocator does not model separate
8513 functional units well resulting in instable performance.
8514 @end table
8515
8516 @item -masm=@var{dialect}
8517 @opindex masm=@var{dialect}
8518 Output asm instructions using selected @var{dialect}. Supported choices are
8519 @samp{intel} or @samp{att} (the default one).
8520
8521 @item -mieee-fp
8522 @itemx -mno-ieee-fp
8523 @opindex mieee-fp
8524 @opindex mno-ieee-fp
8525 Control whether or not the compiler uses IEEE floating point
8526 comparisons.  These handle correctly the case where the result of a
8527 comparison is unordered.
8528
8529 @item -msoft-float
8530 @opindex msoft-float
8531 Generate output containing library calls for floating point.
8532 @strong{Warning:} the requisite libraries are not part of GCC@.
8533 Normally the facilities of the machine's usual C compiler are used, but
8534 this can't be done directly in cross-compilation.  You must make your
8535 own arrangements to provide suitable library functions for
8536 cross-compilation.
8537
8538 On machines where a function returns floating point results in the 80387
8539 register stack, some floating point opcodes may be emitted even if
8540 @option{-msoft-float} is used.
8541
8542 @item -mno-fp-ret-in-387
8543 @opindex mno-fp-ret-in-387
8544 Do not use the FPU registers for return values of functions.
8545
8546 The usual calling convention has functions return values of types
8547 @code{float} and @code{double} in an FPU register, even if there
8548 is no FPU@.  The idea is that the operating system should emulate
8549 an FPU@.
8550
8551 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8552 in ordinary CPU registers instead.
8553
8554 @item -mno-fancy-math-387
8555 @opindex mno-fancy-math-387
8556 Some 387 emulators do not support the @code{sin}, @code{cos} and
8557 @code{sqrt} instructions for the 387.  Specify this option to avoid
8558 generating those instructions.  This option is the default on FreeBSD,
8559 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8560 indicates that the target cpu will always have an FPU and so the
8561 instruction will not need emulation.  As of revision 2.6.1, these
8562 instructions are not generated unless you also use the
8563 @option{-funsafe-math-optimizations} switch.
8564
8565 @item -malign-double
8566 @itemx -mno-align-double
8567 @opindex malign-double
8568 @opindex mno-align-double
8569 Control whether GCC aligns @code{double}, @code{long double}, and
8570 @code{long long} variables on a two word boundary or a one word
8571 boundary.  Aligning @code{double} variables on a two word boundary will
8572 produce code that runs somewhat faster on a @samp{Pentium} at the
8573 expense of more memory.
8574
8575 @strong{Warning:} if you use the @option{-malign-double} switch,
8576 structures containing the above types will be aligned differently than
8577 the published application binary interface specifications for the 386
8578 and will not be binary compatible with structures in code compiled
8579 without that switch.
8580
8581 @item -m96bit-long-double
8582 @item -m128bit-long-double
8583 @opindex m96bit-long-double
8584 @opindex m128bit-long-double
8585 These switches control the size of @code{long double} type. The i386 
8586 application binary interface specifies the size to be 96 bits, 
8587 so @option{-m96bit-long-double} is the default in 32 bit mode.
8588
8589 Modern architectures (Pentium and newer) would prefer @code{long double}
8590 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8591 conforming to the ABI, this would not be possible.  So specifying a 
8592 @option{-m128bit-long-double} will align @code{long double}
8593 to a 16 byte boundary by padding the @code{long double} with an additional
8594 32 bit zero. 
8595
8596 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8597 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8598  
8599 Notice that neither of these options enable any extra precision over the x87
8600 standard of 80 bits for a @code{long double}. 
8601
8602 @strong{Warning:} if you override the default value for your target ABI, the
8603 structures and arrays containing @code{long double} will change their size as
8604 well as function calling convention for function taking @code{long double}
8605 will be modified.  Hence they will not be binary compatible with arrays or
8606 structures in code compiled without that switch.
8607
8608
8609 @item -msvr3-shlib
8610 @itemx -mno-svr3-shlib
8611 @opindex msvr3-shlib
8612 @opindex mno-svr3-shlib
8613 Control whether GCC places uninitialized local variables into the
8614 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8615 into @code{bss}.  These options are meaningful only on System V Release 3.
8616
8617 @item -mrtd
8618 @opindex mrtd
8619 Use a different function-calling convention, in which functions that
8620 take a fixed number of arguments return with the @code{ret} @var{num}
8621 instruction, which pops their arguments while returning.  This saves one
8622 instruction in the caller since there is no need to pop the arguments
8623 there.
8624
8625 You can specify that an individual function is called with this calling
8626 sequence with the function attribute @samp{stdcall}.  You can also
8627 override the @option{-mrtd} option by using the function attribute
8628 @samp{cdecl}.  @xref{Function Attributes}.
8629
8630 @strong{Warning:} this calling convention is incompatible with the one
8631 normally used on Unix, so you cannot use it if you need to call
8632 libraries compiled with the Unix compiler.
8633
8634 Also, you must provide function prototypes for all functions that
8635 take variable numbers of arguments (including @code{printf});
8636 otherwise incorrect code will be generated for calls to those
8637 functions.
8638
8639 In addition, seriously incorrect code will result if you call a
8640 function with too many arguments.  (Normally, extra arguments are
8641 harmlessly ignored.)
8642
8643 @item -mregparm=@var{num}
8644 @opindex mregparm
8645 Control how many registers are used to pass integer arguments.  By
8646 default, no registers are used to pass arguments, and at most 3
8647 registers can be used.  You can control this behavior for a specific
8648 function by using the function attribute @samp{regparm}.
8649 @xref{Function Attributes}.
8650
8651 @strong{Warning:} if you use this switch, and
8652 @var{num} is nonzero, then you must build all modules with the same
8653 value, including any libraries.  This includes the system libraries and
8654 startup modules.
8655
8656 @item -mpreferred-stack-boundary=@var{num}
8657 @opindex mpreferred-stack-boundary
8658 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8659 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8660 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8661 size (@option{-Os}), in which case the default is the minimum correct
8662 alignment (4 bytes for x86, and 8 bytes for x86-64).
8663
8664 On Pentium and PentiumPro, @code{double} and @code{long double} values
8665 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8666 suffer significant run time performance penalties.  On Pentium III, the
8667 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8668 penalties if it is not 16 byte aligned.
8669
8670 To ensure proper alignment of this values on the stack, the stack boundary
8671 must be as aligned as that required by any value stored on the stack.
8672 Further, every function must be generated such that it keeps the stack
8673 aligned.  Thus calling a function compiled with a higher preferred
8674 stack boundary from a function compiled with a lower preferred stack
8675 boundary will most likely misalign the stack.  It is recommended that
8676 libraries that use callbacks always use the default setting.
8677
8678 This extra alignment does consume extra stack space, and generally
8679 increases code size.  Code that is sensitive to stack space usage, such
8680 as embedded systems and operating system kernels, may want to reduce the
8681 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8682
8683 @item -mmmx
8684 @itemx -mno-mmx
8685 @item -msse
8686 @itemx -mno-sse
8687 @item -msse2
8688 @itemx -mno-sse2
8689 @item -mpni
8690 @itemx -mno-pni
8691 @item -m3dnow
8692 @itemx -mno-3dnow
8693 @opindex mmmx
8694 @opindex mno-mmx
8695 @opindex msse
8696 @opindex mno-sse
8697 @opindex m3dnow
8698 @opindex mno-3dnow
8699 These switches enable or disable the use of built-in functions that allow
8700 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8701
8702 @xref{X86 Built-in Functions}, for details of the functions enabled
8703 and disabled by these switches.
8704
8705 To have SSE/SSE2 instructions generated automatically from floating-point
8706 code, see @option{-mfpmath=sse}.
8707
8708 @item -mpush-args
8709 @itemx -mno-push-args
8710 @opindex mpush-args
8711 @opindex mno-push-args
8712 Use PUSH operations to store outgoing parameters.  This method is shorter
8713 and usually equally fast as method using SUB/MOV operations and is enabled
8714 by default.  In some cases disabling it may improve performance because of
8715 improved scheduling and reduced dependencies.
8716
8717 @item -maccumulate-outgoing-args
8718 @opindex maccumulate-outgoing-args
8719 If enabled, the maximum amount of space required for outgoing arguments will be
8720 computed in the function prologue.  This is faster on most modern CPUs
8721 because of reduced dependencies, improved scheduling and reduced stack usage
8722 when preferred stack boundary is not equal to 2.  The drawback is a notable
8723 increase in code size.  This switch implies @option{-mno-push-args}.
8724
8725 @item -mthreads
8726 @opindex mthreads
8727 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8728 on thread-safe exception handling must compile and link all code with the
8729 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8730 @option{-D_MT}; when linking, it links in a special thread helper library
8731 @option{-lmingwthrd} which cleans up per thread exception handling data.
8732
8733 @item -mno-align-stringops
8734 @opindex mno-align-stringops
8735 Do not align destination of inlined string operations.  This switch reduces
8736 code size and improves performance in case the destination is already aligned,
8737 but gcc don't know about it.
8738
8739 @item -minline-all-stringops
8740 @opindex minline-all-stringops
8741 By default GCC inlines string operations only when destination is known to be
8742 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8743 size, but may improve performance of code that depends on fast memcpy, strlen
8744 and memset for short lengths.
8745
8746 @item -momit-leaf-frame-pointer
8747 @opindex momit-leaf-frame-pointer
8748 Don't keep the frame pointer in a register for leaf functions.  This
8749 avoids the instructions to save, set up and restore frame pointers and
8750 makes an extra register available in leaf functions.  The option
8751 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8752 which might make debugging harder.
8753
8754 @item -mtls-direct-seg-refs
8755 @itemx -mno-tls-direct-seg-refs
8756 @opindex mtls-direct-seg-refs
8757 Controls whether TLS variables may be accessed with offsets from the
8758 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8759 or whether the thread base pointer must be added.  Whether or not this
8760 is legal depends on the operating system, and whether it maps the
8761 segment to cover the entire TLS area.
8762
8763 For systems that use GNU libc, the default is on.
8764 @end table
8765
8766 These @samp{-m} switches are supported in addition to the above
8767 on AMD x86-64 processors in 64-bit environments.
8768
8769 @table @gcctabopt
8770 @item -m32
8771 @itemx -m64
8772 @opindex m32
8773 @opindex m64
8774 Generate code for a 32-bit or 64-bit environment.
8775 The 32-bit environment sets int, long and pointer to 32 bits and
8776 generates code that runs on any i386 system.
8777 The 64-bit environment sets int to 32 bits and long and pointer
8778 to 64 bits and generates code for AMD's x86-64 architecture.
8779
8780 @item -mno-red-zone
8781 @opindex no-red-zone
8782 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8783 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8784 stack pointer that will not be modified by signal or interrupt handlers
8785 and therefore can be used for temporary data without adjusting the stack
8786 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8787
8788 @item -mcmodel=small
8789 @opindex mcmodel=small
8790 Generate code for the small code model: the program and its symbols must
8791 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8792 Programs can be statically or dynamically linked.  This is the default
8793 code model.
8794
8795 @item -mcmodel=kernel
8796 @opindex mcmodel=kernel
8797 Generate code for the kernel code model.  The kernel runs in the
8798 negative 2 GB of the address space.
8799 This model has to be used for Linux kernel code.
8800
8801 @item -mcmodel=medium
8802 @opindex mcmodel=medium
8803 Generate code for the medium model: The program is linked in the lower 2
8804 GB of the address space but symbols can be located anywhere in the
8805 address space.  Programs can be statically or dynamically linked, but
8806 building of shared libraries are not supported with the medium model.
8807
8808 @item -mcmodel=large
8809 @opindex mcmodel=large
8810 Generate code for the large model: This model makes no assumptions
8811 about addresses and sizes of sections.  Currently GCC does not implement
8812 this model.
8813 @end table
8814
8815 @node HPPA Options
8816 @subsection HPPA Options
8817 @cindex HPPA Options
8818
8819 These @samp{-m} options are defined for the HPPA family of computers:
8820
8821 @table @gcctabopt
8822 @item -march=@var{architecture-type}
8823 @opindex march
8824 Generate code for the specified architecture.  The choices for
8825 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8826 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8827 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8828 architecture option for your machine.  Code compiled for lower numbered
8829 architectures will run on higher numbered architectures, but not the
8830 other way around.
8831
8832 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8833 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8834 support.
8835
8836 @item -mpa-risc-1-0
8837 @itemx -mpa-risc-1-1
8838 @itemx -mpa-risc-2-0
8839 @opindex mpa-risc-1-0
8840 @opindex mpa-risc-1-1
8841 @opindex mpa-risc-2-0
8842 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8843
8844 @item -mbig-switch
8845 @opindex mbig-switch
8846 Generate code suitable for big switch tables.  Use this option only if
8847 the assembler/linker complain about out of range branches within a switch
8848 table.
8849
8850 @item -mjump-in-delay
8851 @opindex mjump-in-delay
8852 Fill delay slots of function calls with unconditional jump instructions
8853 by modifying the return pointer for the function call to be the target
8854 of the conditional jump.
8855
8856 @item -mdisable-fpregs
8857 @opindex mdisable-fpregs
8858 Prevent floating point registers from being used in any manner.  This is
8859 necessary for compiling kernels which perform lazy context switching of
8860 floating point registers.  If you use this option and attempt to perform
8861 floating point operations, the compiler will abort.
8862
8863 @item -mdisable-indexing
8864 @opindex mdisable-indexing
8865 Prevent the compiler from using indexing address modes.  This avoids some
8866 rather obscure problems when compiling MIG generated code under MACH@.
8867
8868 @item -mno-space-regs
8869 @opindex mno-space-regs
8870 Generate code that assumes the target has no space registers.  This allows
8871 GCC to generate faster indirect calls and use unscaled index address modes.
8872
8873 Such code is suitable for level 0 PA systems and kernels.
8874
8875 @item -mfast-indirect-calls
8876 @opindex mfast-indirect-calls
8877 Generate code that assumes calls never cross space boundaries.  This
8878 allows GCC to emit code which performs faster indirect calls.
8879
8880 This option will not work in the presence of shared libraries or nested
8881 functions.
8882
8883 @item -mlong-load-store
8884 @opindex mlong-load-store
8885 Generate 3-instruction load and store sequences as sometimes required by
8886 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8887 the HP compilers.
8888
8889 @item -mportable-runtime
8890 @opindex mportable-runtime
8891 Use the portable calling conventions proposed by HP for ELF systems.
8892
8893 @item -mgas
8894 @opindex mgas
8895 Enable the use of assembler directives only GAS understands.
8896
8897 @item -mschedule=@var{cpu-type}
8898 @opindex mschedule
8899 Schedule code according to the constraints for the machine type
8900 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8901 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8902 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8903 proper scheduling option for your machine.  The default scheduling is
8904 @samp{8000}.
8905
8906 @item -mlinker-opt
8907 @opindex mlinker-opt
8908 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8909 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8910 linkers in which they give bogus error messages when linking some programs.
8911
8912 @item -msoft-float
8913 @opindex msoft-float
8914 Generate output containing library calls for floating point.
8915 @strong{Warning:} the requisite libraries are not available for all HPPA
8916 targets.  Normally the facilities of the machine's usual C compiler are
8917 used, but this cannot be done directly in cross-compilation.  You must make
8918 your own arrangements to provide suitable library functions for
8919 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8920 does provide software floating point support.
8921
8922 @option{-msoft-float} changes the calling convention in the output file;
8923 therefore, it is only useful if you compile @emph{all} of a program with
8924 this option.  In particular, you need to compile @file{libgcc.a}, the
8925 library that comes with GCC, with @option{-msoft-float} in order for
8926 this to work.
8927
8928 @item -msio
8929 @opindex msio
8930 Generate the predefine, @code{_SIO}, for server IO.  The default is
8931 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8932 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8933 options are available under HP-UX and HI-UX.
8934
8935 @item -mgnu-ld
8936 @opindex gnu-ld
8937 Use GNU ld specific options.  This passes @option{-shared} to ld when
8938 building a shared library.  It is the default when GCC is configured,
8939 explicitly or implicitly, with the GNU linker.  This option does not
8940 have any affect on which ld is called, it only changes what parameters
8941 are passed to that ld.  The ld that is called is determined by the
8942 @option{--with-ld} configure option, gcc's program search path, and
8943 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8944 using @samp{which `gcc -print-prog-name=ld`}.
8945
8946 @item -mhp-ld
8947 @opindex hp-ld
8948 Use HP ld specific options.  This passes @option{-b} to ld when building
8949 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8950 links.  It is the default when GCC is configured, explicitly or
8951 implicitly, with the HP linker.  This option does not have any affect on
8952 which ld is called, it only changes what parameters are passed to that
8953 ld.  The ld that is called is determined by the @option{--with-ld}
8954 configure option, gcc's program search path, and finally by the user's
8955 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8956 `gcc -print-prog-name=ld`}.
8957
8958 @item -mlong-calls
8959 @opindex mno-long-calls
8960 Generate code that uses long call sequences.  This ensures that a call
8961 is always able to reach linker generated stubs.  The default is to generate
8962 long calls only when the distance from the call site to the beginning
8963 of the function or translation unit, as the case may be, exceeds a
8964 predefined limit set by the branch type being used.  The limits for
8965 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8966 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8967 240,000 bytes.
8968
8969 Distances are measured from the beginning of functions when using the
8970 @option{-ffunction-sections} option, or when using the @option{-mgas}
8971 and @option{-mno-portable-runtime} options together under HP-UX with
8972 the SOM linker.
8973
8974 It is normally not desirable to use this option as it will degrade
8975 performance.  However, it may be useful in large applications,
8976 particularly when partial linking is used to build the application.
8977
8978 The types of long calls used depends on the capabilities of the
8979 assembler and linker, and the type of code being generated.  The
8980 impact on systems that support long absolute calls, and long pic
8981 symbol-difference or pc-relative calls should be relatively small.
8982 However, an indirect call is used on 32-bit ELF systems in pic code
8983 and it is quite long.
8984
8985 @item -nolibdld
8986 @opindex nolibdld
8987 Suppress the generation of link options to search libdld.sl when the
8988 @option{-static} option is specified on HP-UX 10 and later.
8989
8990 @item -static
8991 @opindex static
8992 The HP-UX implementation of setlocale in libc has a dependency on
8993 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8994 when the @option{-static} option is specified, special link options
8995 are needed to resolve this dependency.
8996
8997 On HP-UX 10 and later, the GCC driver adds the necessary options to
8998 link with libdld.sl when the @option{-static} option is specified.
8999 This causes the resulting binary to be dynamic.  On the 64-bit port,
9000 the linkers generate dynamic binaries by default in any case.  The
9001 @option{-nolibdld} option can be used to prevent the GCC driver from
9002 adding these link options.
9003
9004 @item -threads
9005 @opindex threads
9006 Add support for multithreading with the @dfn{dce thread} library
9007 under HP-UX.  This option sets flags for both the preprocessor and
9008 linker.
9009 @end table
9010
9011 @node Intel 960 Options
9012 @subsection Intel 960 Options
9013
9014 These @samp{-m} options are defined for the Intel 960 implementations:
9015
9016 @table @gcctabopt
9017 @item -m@var{cpu-type}
9018 @opindex mka
9019 @opindex mkb
9020 @opindex mmc
9021 @opindex mca
9022 @opindex mcf
9023 @opindex msa
9024 @opindex msb
9025 Assume the defaults for the machine type @var{cpu-type} for some of
9026 the other options, including instruction scheduling, floating point
9027 support, and addressing modes.  The choices for @var{cpu-type} are
9028 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
9029 @samp{sa}, and @samp{sb}.
9030 The default is
9031 @samp{kb}.
9032
9033 @item -mnumerics
9034 @itemx -msoft-float
9035 @opindex mnumerics
9036 @opindex msoft-float
9037 The @option{-mnumerics} option indicates that the processor does support
9038 floating-point instructions.  The @option{-msoft-float} option indicates
9039 that floating-point support should not be assumed.
9040
9041 @item -mleaf-procedures
9042 @itemx -mno-leaf-procedures
9043 @opindex mleaf-procedures
9044 @opindex mno-leaf-procedures
9045 Do (or do not) attempt to alter leaf procedures to be callable with the
9046 @code{bal} instruction as well as @code{call}.  This will result in more
9047 efficient code for explicit calls when the @code{bal} instruction can be
9048 substituted by the assembler or linker, but less efficient code in other
9049 cases, such as calls via function pointers, or using a linker that doesn't
9050 support this optimization.
9051
9052 @item -mtail-call
9053 @itemx -mno-tail-call
9054 @opindex mtail-call
9055 @opindex mno-tail-call
9056 Do (or do not) make additional attempts (beyond those of the
9057 machine-independent portions of the compiler) to optimize tail-recursive
9058 calls into branches.  You may not want to do this because the detection of
9059 cases where this is not valid is not totally complete.  The default is
9060 @option{-mno-tail-call}.
9061
9062 @item -mcomplex-addr
9063 @itemx -mno-complex-addr
9064 @opindex mcomplex-addr
9065 @opindex mno-complex-addr
9066 Assume (or do not assume) that the use of a complex addressing mode is a
9067 win on this implementation of the i960.  Complex addressing modes may not
9068 be worthwhile on the K-series, but they definitely are on the C-series.
9069 The default is currently @option{-mcomplex-addr} for all processors except
9070 the CB and CC@.
9071
9072 @item -mcode-align
9073 @itemx -mno-code-align
9074 @opindex mcode-align
9075 @opindex mno-code-align
9076 Align code to 8-byte boundaries for faster fetching (or don't bother).
9077 Currently turned on by default for C-series implementations only.
9078
9079 @ignore
9080 @item -mclean-linkage
9081 @itemx -mno-clean-linkage
9082 @opindex mclean-linkage
9083 @opindex mno-clean-linkage
9084 These options are not fully implemented.
9085 @end ignore
9086
9087 @item -mic-compat
9088 @itemx -mic2.0-compat
9089 @itemx -mic3.0-compat
9090 @opindex mic-compat
9091 @opindex mic2.0-compat
9092 @opindex mic3.0-compat
9093 Enable compatibility with iC960 v2.0 or v3.0.
9094
9095 @item -masm-compat
9096 @itemx -mintel-asm
9097 @opindex masm-compat
9098 @opindex mintel-asm
9099 Enable compatibility with the iC960 assembler.
9100
9101 @item -mstrict-align
9102 @itemx -mno-strict-align
9103 @opindex mstrict-align
9104 @opindex mno-strict-align
9105 Do not permit (do permit) unaligned accesses.
9106
9107 @item -mold-align
9108 @opindex mold-align
9109 Enable structure-alignment compatibility with Intel's gcc release version
9110 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
9111
9112 @item -mlong-double-64
9113 @opindex mlong-double-64
9114 Implement type @samp{long double} as 64-bit floating point numbers.
9115 Without the option @samp{long double} is implemented by 80-bit
9116 floating point numbers.  The only reason we have it because there is
9117 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
9118 is only useful for people using soft-float targets.  Otherwise, we
9119 should recommend against use of it.
9120
9121 @end table
9122
9123 @node DEC Alpha Options
9124 @subsection DEC Alpha Options
9125
9126 These @samp{-m} options are defined for the DEC Alpha implementations:
9127
9128 @table @gcctabopt
9129 @item -mno-soft-float
9130 @itemx -msoft-float
9131 @opindex mno-soft-float
9132 @opindex msoft-float
9133 Use (do not use) the hardware floating-point instructions for
9134 floating-point operations.  When @option{-msoft-float} is specified,
9135 functions in @file{libgcc.a} will be used to perform floating-point
9136 operations.  Unless they are replaced by routines that emulate the
9137 floating-point operations, or compiled in such a way as to call such
9138 emulations routines, these routines will issue floating-point
9139 operations.   If you are compiling for an Alpha without floating-point
9140 operations, you must ensure that the library is built so as not to call
9141 them.
9142
9143 Note that Alpha implementations without floating-point operations are
9144 required to have floating-point registers.
9145
9146 @item -mfp-reg
9147 @itemx -mno-fp-regs
9148 @opindex mfp-reg
9149 @opindex mno-fp-regs
9150 Generate code that uses (does not use) the floating-point register set.
9151 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9152 register set is not used, floating point operands are passed in integer
9153 registers as if they were integers and floating-point results are passed
9154 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9155 so any function with a floating-point argument or return value called by code
9156 compiled with @option{-mno-fp-regs} must also be compiled with that
9157 option.
9158
9159 A typical use of this option is building a kernel that does not use,
9160 and hence need not save and restore, any floating-point registers.
9161
9162 @item -mieee
9163 @opindex mieee
9164 The Alpha architecture implements floating-point hardware optimized for
9165 maximum performance.  It is mostly compliant with the IEEE floating
9166 point standard.  However, for full compliance, software assistance is
9167 required.  This option generates code fully IEEE compliant code
9168 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9169 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9170 defined during compilation.  The resulting code is less efficient but is
9171 able to correctly support denormalized numbers and exceptional IEEE
9172 values such as not-a-number and plus/minus infinity.  Other Alpha
9173 compilers call this option @option{-ieee_with_no_inexact}.
9174
9175 @item -mieee-with-inexact
9176 @opindex mieee-with-inexact
9177 This is like @option{-mieee} except the generated code also maintains
9178 the IEEE @var{inexact-flag}.  Turning on this option causes the
9179 generated code to implement fully-compliant IEEE math.  In addition to
9180 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9181 macro.  On some Alpha implementations the resulting code may execute
9182 significantly slower than the code generated by default.  Since there is
9183 very little code that depends on the @var{inexact-flag}, you should
9184 normally not specify this option.  Other Alpha compilers call this
9185 option @option{-ieee_with_inexact}.
9186
9187 @item -mfp-trap-mode=@var{trap-mode}
9188 @opindex mfp-trap-mode
9189 This option controls what floating-point related traps are enabled.
9190 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9191 The trap mode can be set to one of four values:
9192
9193 @table @samp
9194 @item n
9195 This is the default (normal) setting.  The only traps that are enabled
9196 are the ones that cannot be disabled in software (e.g., division by zero
9197 trap).
9198
9199 @item u
9200 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9201 as well.
9202
9203 @item su
9204 Like @samp{su}, but the instructions are marked to be safe for software
9205 completion (see Alpha architecture manual for details).
9206
9207 @item sui
9208 Like @samp{su}, but inexact traps are enabled as well.
9209 @end table
9210
9211 @item -mfp-rounding-mode=@var{rounding-mode}
9212 @opindex mfp-rounding-mode
9213 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9214 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9215 of:
9216
9217 @table @samp
9218 @item n
9219 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9220 the nearest machine number or towards the even machine number in case
9221 of a tie.
9222
9223 @item m
9224 Round towards minus infinity.
9225
9226 @item c
9227 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9228
9229 @item d
9230 Dynamic rounding mode.  A field in the floating point control register
9231 (@var{fpcr}, see Alpha architecture reference manual) controls the
9232 rounding mode in effect.  The C library initializes this register for
9233 rounding towards plus infinity.  Thus, unless your program modifies the
9234 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9235 @end table
9236
9237 @item -mtrap-precision=@var{trap-precision}
9238 @opindex mtrap-precision
9239 In the Alpha architecture, floating point traps are imprecise.  This
9240 means without software assistance it is impossible to recover from a
9241 floating trap and program execution normally needs to be terminated.
9242 GCC can generate code that can assist operating system trap handlers
9243 in determining the exact location that caused a floating point trap.
9244 Depending on the requirements of an application, different levels of
9245 precisions can be selected:
9246
9247 @table @samp
9248 @item p
9249 Program precision.  This option is the default and means a trap handler
9250 can only identify which program caused a floating point exception.
9251
9252 @item f
9253 Function precision.  The trap handler can determine the function that
9254 caused a floating point exception.
9255
9256 @item i
9257 Instruction precision.  The trap handler can determine the exact
9258 instruction that caused a floating point exception.
9259 @end table
9260
9261 Other Alpha compilers provide the equivalent options called
9262 @option{-scope_safe} and @option{-resumption_safe}.
9263
9264 @item -mieee-conformant
9265 @opindex mieee-conformant
9266 This option marks the generated code as IEEE conformant.  You must not
9267 use this option unless you also specify @option{-mtrap-precision=i} and either
9268 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9269 is to emit the line @samp{.eflag 48} in the function prologue of the
9270 generated assembly file.  Under DEC Unix, this has the effect that
9271 IEEE-conformant math library routines will be linked in.
9272
9273 @item -mbuild-constants
9274 @opindex mbuild-constants
9275 Normally GCC examines a 32- or 64-bit integer constant to
9276 see if it can construct it from smaller constants in two or three
9277 instructions.  If it cannot, it will output the constant as a literal and
9278 generate code to load it from the data segment at runtime.
9279
9280 Use this option to require GCC to construct @emph{all} integer constants
9281 using code, even if it takes more instructions (the maximum is six).
9282
9283 You would typically use this option to build a shared library dynamic
9284 loader.  Itself a shared library, it must relocate itself in memory
9285 before it can find the variables and constants in its own data segment.
9286
9287 @item -malpha-as
9288 @itemx -mgas
9289 @opindex malpha-as
9290 @opindex mgas
9291 Select whether to generate code to be assembled by the vendor-supplied
9292 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9293
9294 @item -mbwx
9295 @itemx -mno-bwx
9296 @itemx -mcix
9297 @itemx -mno-cix
9298 @itemx -mfix
9299 @itemx -mno-fix
9300 @itemx -mmax
9301 @itemx -mno-max
9302 @opindex mbwx
9303 @opindex mno-bwx
9304 @opindex mcix
9305 @opindex mno-cix
9306 @opindex mfix
9307 @opindex mno-fix
9308 @opindex mmax
9309 @opindex mno-max
9310 Indicate whether GCC should generate code to use the optional BWX,
9311 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9312 sets supported by the CPU type specified via @option{-mcpu=} option or that
9313 of the CPU on which GCC was built if none was specified.
9314
9315 @item -mfloat-vax
9316 @itemx -mfloat-ieee
9317 @opindex mfloat-vax
9318 @opindex mfloat-ieee
9319 Generate code that uses (does not use) VAX F and G floating point
9320 arithmetic instead of IEEE single and double precision.
9321
9322 @item -mexplicit-relocs
9323 @itemx -mno-explicit-relocs
9324 @opindex mexplicit-relocs
9325 @opindex mno-explicit-relocs
9326 Older Alpha assemblers provided no way to generate symbol relocations
9327 except via assembler macros.  Use of these macros does not allow
9328 optimal instruction scheduling.  GNU binutils as of version 2.12
9329 supports a new syntax that allows the compiler to explicitly mark
9330 which relocations should apply to which instructions.  This option
9331 is mostly useful for debugging, as GCC detects the capabilities of
9332 the assembler when it is built and sets the default accordingly.
9333
9334 @item -msmall-data
9335 @itemx -mlarge-data
9336 @opindex msmall-data
9337 @opindex mlarge-data
9338 When @option{-mexplicit-relocs} is in effect, static data is
9339 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9340 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9341 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9342 16-bit relocations off of the @code{$gp} register.  This limits the
9343 size of the small data area to 64KB, but allows the variables to be
9344 directly accessed via a single instruction.
9345
9346 The default is @option{-mlarge-data}.  With this option the data area
9347 is limited to just below 2GB.  Programs that require more than 2GB of
9348 data must use @code{malloc} or @code{mmap} to allocate the data in the
9349 heap instead of in the program's data segment.
9350
9351 When generating code for shared libraries, @option{-fpic} implies
9352 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9353
9354 @item -msmall-text
9355 @itemx -mlarge-text
9356 @opindex msmall-text
9357 @opindex mlarge-text
9358 When @option{-msmall-text} is used, the compiler assumes that the
9359 code of the entire program (or shared library) fits in 4MB, and is
9360 thus reachable with a branch instruction.  When @option{-msmall-data}
9361 is used, the compiler can assume that all local symbols share the
9362 same @code{$gp} value, and thus reduce the number of instructions
9363 required for a function call from 4 to 1.
9364
9365 The default is @option{-mlarge-text}.
9366
9367 @item -mcpu=@var{cpu_type}
9368 @opindex mcpu
9369 Set the instruction set and instruction scheduling parameters for
9370 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9371 style name or the corresponding chip number.  GCC supports scheduling
9372 parameters for the EV4, EV5 and EV6 family of processors and will
9373 choose the default values for the instruction set from the processor
9374 you specify.  If you do not specify a processor type, GCC will default
9375 to the processor on which the compiler was built.
9376
9377 Supported values for @var{cpu_type} are
9378
9379 @table @samp
9380 @item ev4
9381 @item ev45
9382 @itemx 21064
9383 Schedules as an EV4 and has no instruction set extensions.
9384
9385 @item ev5
9386 @itemx 21164
9387 Schedules as an EV5 and has no instruction set extensions.
9388
9389 @item ev56
9390 @itemx 21164a
9391 Schedules as an EV5 and supports the BWX extension.
9392
9393 @item pca56
9394 @itemx 21164pc
9395 @itemx 21164PC
9396 Schedules as an EV5 and supports the BWX and MAX extensions.
9397
9398 @item ev6
9399 @itemx 21264
9400 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9401
9402 @item ev67
9403 @item 21264a
9404 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9405 @end table
9406
9407 @item -mtune=@var{cpu_type}
9408 @opindex mtune
9409 Set only the instruction scheduling parameters for machine type
9410 @var{cpu_type}.  The instruction set is not changed.
9411
9412 @item -mmemory-latency=@var{time}
9413 @opindex mmemory-latency
9414 Sets the latency the scheduler should assume for typical memory
9415 references as seen by the application.  This number is highly
9416 dependent on the memory access patterns used by the application
9417 and the size of the external cache on the machine.
9418
9419 Valid options for @var{time} are
9420
9421 @table @samp
9422 @item @var{number}
9423 A decimal number representing clock cycles.
9424
9425 @item L1
9426 @itemx L2
9427 @itemx L3
9428 @itemx main
9429 The compiler contains estimates of the number of clock cycles for
9430 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9431 (also called Dcache, Scache, and Bcache), as well as to main memory.
9432 Note that L3 is only valid for EV5.
9433
9434 @end table
9435 @end table
9436
9437 @node DEC Alpha/VMS Options
9438 @subsection DEC Alpha/VMS Options
9439
9440 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9441
9442 @table @gcctabopt
9443 @item -mvms-return-codes
9444 @opindex mvms-return-codes
9445 Return VMS condition codes from main.  The default is to return POSIX
9446 style condition (e.g.@ error) codes.
9447 @end table
9448
9449 @node H8/300 Options
9450 @subsection H8/300 Options
9451
9452 These @samp{-m} options are defined for the H8/300 implementations:
9453
9454 @table @gcctabopt
9455 @item -mrelax
9456 @opindex mrelax
9457 Shorten some address references at link time, when possible; uses the
9458 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9459 ld.info, Using ld}, for a fuller description.
9460
9461 @item -mh
9462 @opindex mh
9463 Generate code for the H8/300H@.
9464
9465 @item -ms
9466 @opindex ms
9467 Generate code for the H8S@.
9468
9469 @item -mn
9470 @opindex mn
9471 Generate code for the H8S and H8/300H in the normal mode.  This switch
9472 must be used either with -mh or -ms.
9473
9474 @item -ms2600
9475 @opindex ms2600
9476 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9477
9478 @item -mint32
9479 @opindex mint32
9480 Make @code{int} data 32 bits by default.
9481
9482 @item -malign-300
9483 @opindex malign-300
9484 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9485 The default for the H8/300H and H8S is to align longs and floats on 4
9486 byte boundaries.
9487 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9488 This option has no effect on the H8/300.
9489 @end table
9490
9491 @node SH Options
9492 @subsection SH Options
9493
9494 These @samp{-m} options are defined for the SH implementations:
9495
9496 @table @gcctabopt
9497 @item -m1
9498 @opindex m1
9499 Generate code for the SH1.
9500
9501 @item -m2
9502 @opindex m2
9503 Generate code for the SH2.
9504
9505 @item -m2e
9506 Generate code for the SH2e.
9507
9508 @item -m3
9509 @opindex m3
9510 Generate code for the SH3.
9511
9512 @item -m3e
9513 @opindex m3e
9514 Generate code for the SH3e.
9515
9516 @item -m4-nofpu
9517 @opindex m4-nofpu
9518 Generate code for the SH4 without a floating-point unit.
9519
9520 @item -m4-single-only
9521 @opindex m4-single-only
9522 Generate code for the SH4 with a floating-point unit that only
9523 supports single-precision arithmetic.
9524
9525 @item -m4-single
9526 @opindex m4-single
9527 Generate code for the SH4 assuming the floating-point unit is in
9528 single-precision mode by default.
9529
9530 @item -m4
9531 @opindex m4
9532 Generate code for the SH4.
9533
9534 @item -mb
9535 @opindex mb
9536 Compile code for the processor in big endian mode.
9537
9538 @item -ml
9539 @opindex ml
9540 Compile code for the processor in little endian mode.
9541
9542 @item -mdalign
9543 @opindex mdalign
9544 Align doubles at 64-bit boundaries.  Note that this changes the calling
9545 conventions, and thus some functions from the standard C library will
9546 not work unless you recompile it first with @option{-mdalign}.
9547
9548 @item -mrelax
9549 @opindex mrelax
9550 Shorten some address references at link time, when possible; uses the
9551 linker option @option{-relax}.
9552
9553 @item -mbigtable
9554 @opindex mbigtable
9555 Use 32-bit offsets in @code{switch} tables.  The default is to use
9556 16-bit offsets.
9557
9558 @item -mfmovd
9559 @opindex mfmovd
9560 Enable the use of the instruction @code{fmovd}.
9561
9562 @item -mhitachi
9563 @opindex mhitachi
9564 Comply with the calling conventions defined by Renesas.
9565
9566 @item -mnomacsave
9567 @opindex mnomacsave
9568 Mark the @code{MAC} register as call-clobbered, even if
9569 @option{-mhitachi} is given.
9570
9571 @item -mieee
9572 @opindex mieee
9573 Increase IEEE-compliance of floating-point code.
9574
9575 @item -misize
9576 @opindex misize
9577 Dump instruction size and location in the assembly code.
9578
9579 @item -mpadstruct
9580 @opindex mpadstruct
9581 This option is deprecated.  It pads structures to multiple of 4 bytes,
9582 which is incompatible with the SH ABI@.
9583
9584 @item -mspace
9585 @opindex mspace
9586 Optimize for space instead of speed.  Implied by @option{-Os}.
9587
9588 @item -mprefergot
9589 @opindex mprefergot
9590 When generating position-independent code, emit function calls using
9591 the Global Offset Table instead of the Procedure Linkage Table.
9592
9593 @item -musermode
9594 @opindex musermode
9595 Generate a library function call to invalidate instruction cache
9596 entries, after fixing up a trampoline.  This library function call
9597 doesn't assume it can write to the whole memory address space.  This
9598 is the default when the target is @code{sh-*-linux*}.
9599 @end table
9600
9601 @node System V Options
9602 @subsection Options for System V
9603
9604 These additional options are available on System V Release 4 for
9605 compatibility with other compilers on those systems:
9606
9607 @table @gcctabopt
9608 @item -G
9609 @opindex G
9610 Create a shared object.
9611 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9612
9613 @item -Qy
9614 @opindex Qy
9615 Identify the versions of each tool used by the compiler, in a
9616 @code{.ident} assembler directive in the output.
9617
9618 @item -Qn
9619 @opindex Qn
9620 Refrain from adding @code{.ident} directives to the output file (this is
9621 the default).
9622
9623 @item -YP,@var{dirs}
9624 @opindex YP
9625 Search the directories @var{dirs}, and no others, for libraries
9626 specified with @option{-l}.
9627
9628 @item -Ym,@var{dir}
9629 @opindex Ym
9630 Look in the directory @var{dir} to find the M4 preprocessor.
9631 The assembler uses this option.
9632 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9633 @c the generic assembler that comes with Solaris takes just -Ym.
9634 @end table
9635
9636 @node TMS320C3x/C4x Options
9637 @subsection TMS320C3x/C4x Options
9638 @cindex TMS320C3x/C4x Options
9639
9640 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9641
9642 @table @gcctabopt
9643
9644 @item -mcpu=@var{cpu_type}
9645 @opindex mcpu
9646 Set the instruction set, register set, and instruction scheduling
9647 parameters for machine type @var{cpu_type}.  Supported values for
9648 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9649 @samp{c44}.  The default is @samp{c40} to generate code for the
9650 TMS320C40.
9651
9652 @item -mbig-memory
9653 @item -mbig
9654 @itemx -msmall-memory
9655 @itemx -msmall
9656 @opindex mbig-memory
9657 @opindex mbig
9658 @opindex msmall-memory
9659 @opindex msmall
9660 Generates code for the big or small memory model.  The small memory
9661 model assumed that all data fits into one 64K word page.  At run-time
9662 the data page (DP) register must be set to point to the 64K page
9663 containing the .bss and .data program sections.  The big memory model is
9664 the default and requires reloading of the DP register for every direct
9665 memory access.
9666
9667 @item -mbk
9668 @itemx -mno-bk
9669 @opindex mbk
9670 @opindex mno-bk
9671 Allow (disallow) allocation of general integer operands into the block
9672 count register BK@.
9673
9674 @item -mdb
9675 @itemx -mno-db
9676 @opindex mdb
9677 @opindex mno-db
9678 Enable (disable) generation of code using decrement and branch,
9679 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9680 on the safe side, this is disabled for the C3x, since the maximum
9681 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9682 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9683 that it can utilize the decrement and branch instruction, but will give
9684 up if there is more than one memory reference in the loop.  Thus a loop
9685 where the loop counter is decremented can generate slightly more
9686 efficient code, in cases where the RPTB instruction cannot be utilized.
9687
9688 @item -mdp-isr-reload
9689 @itemx -mparanoid
9690 @opindex mdp-isr-reload
9691 @opindex mparanoid
9692 Force the DP register to be saved on entry to an interrupt service
9693 routine (ISR), reloaded to point to the data section, and restored on
9694 exit from the ISR@.  This should not be required unless someone has
9695 violated the small memory model by modifying the DP register, say within
9696 an object library.
9697
9698 @item -mmpyi
9699 @itemx -mno-mpyi
9700 @opindex mmpyi
9701 @opindex mno-mpyi
9702 For the C3x use the 24-bit MPYI instruction for integer multiplies
9703 instead of a library call to guarantee 32-bit results.  Note that if one
9704 of the operands is a constant, then the multiplication will be performed
9705 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9706 then squaring operations are performed inline instead of a library call.
9707
9708 @item -mfast-fix
9709 @itemx -mno-fast-fix
9710 @opindex mfast-fix
9711 @opindex mno-fast-fix
9712 The C3x/C4x FIX instruction to convert a floating point value to an
9713 integer value chooses the nearest integer less than or equal to the
9714 floating point value rather than to the nearest integer.  Thus if the
9715 floating point number is negative, the result will be incorrectly
9716 truncated an additional code is necessary to detect and correct this
9717 case.  This option can be used to disable generation of the additional
9718 code required to correct the result.
9719
9720 @item -mrptb
9721 @itemx -mno-rptb
9722 @opindex mrptb
9723 @opindex mno-rptb
9724 Enable (disable) generation of repeat block sequences using the RPTB
9725 instruction for zero overhead looping.  The RPTB construct is only used
9726 for innermost loops that do not call functions or jump across the loop
9727 boundaries.  There is no advantage having nested RPTB loops due to the
9728 overhead required to save and restore the RC, RS, and RE registers.
9729 This is enabled by default with @option{-O2}.
9730
9731 @item -mrpts=@var{count}
9732 @itemx -mno-rpts
9733 @opindex mrpts
9734 @opindex mno-rpts
9735 Enable (disable) the use of the single instruction repeat instruction
9736 RPTS@.  If a repeat block contains a single instruction, and the loop
9737 count can be guaranteed to be less than the value @var{count}, GCC will
9738 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9739 then a RPTS will be emitted even if the loop count cannot be determined
9740 at compile time.  Note that the repeated instruction following RPTS does
9741 not have to be reloaded from memory each iteration, thus freeing up the
9742 CPU buses for operands.  However, since interrupts are blocked by this
9743 instruction, it is disabled by default.
9744
9745 @item -mloop-unsigned
9746 @itemx -mno-loop-unsigned
9747 @opindex mloop-unsigned
9748 @opindex mno-loop-unsigned
9749 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9750 is @math{2^{31} + 1} since these instructions test if the iteration count is
9751 negative to terminate the loop.  If the iteration count is unsigned
9752 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9753 exceeded.  This switch allows an unsigned iteration count.
9754
9755 @item -mti
9756 @opindex mti
9757 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9758 with.  This also enforces compatibility with the API employed by the TI
9759 C3x C compiler.  For example, long doubles are passed as structures
9760 rather than in floating point registers.
9761
9762 @item -mregparm
9763 @itemx -mmemparm
9764 @opindex mregparm
9765 @opindex mmemparm
9766 Generate code that uses registers (stack) for passing arguments to functions.
9767 By default, arguments are passed in registers where possible rather
9768 than by pushing arguments on to the stack.
9769
9770 @item -mparallel-insns
9771 @itemx -mno-parallel-insns
9772 @opindex mparallel-insns
9773 @opindex mno-parallel-insns
9774 Allow the generation of parallel instructions.  This is enabled by
9775 default with @option{-O2}.
9776
9777 @item -mparallel-mpy
9778 @itemx -mno-parallel-mpy
9779 @opindex mparallel-mpy
9780 @opindex mno-parallel-mpy
9781 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9782 provided @option{-mparallel-insns} is also specified.  These instructions have
9783 tight register constraints which can pessimize the code generation
9784 of large functions.
9785
9786 @end table
9787
9788 @node V850 Options
9789 @subsection V850 Options
9790 @cindex V850 Options
9791
9792 These @samp{-m} options are defined for V850 implementations:
9793
9794 @table @gcctabopt
9795 @item -mlong-calls
9796 @itemx -mno-long-calls
9797 @opindex mlong-calls
9798 @opindex mno-long-calls
9799 Treat all calls as being far away (near).  If calls are assumed to be
9800 far away, the compiler will always load the functions address up into a
9801 register, and call indirect through the pointer.
9802
9803 @item -mno-ep
9804 @itemx -mep
9805 @opindex mno-ep
9806 @opindex mep
9807 Do not optimize (do optimize) basic blocks that use the same index
9808 pointer 4 or more times to copy pointer into the @code{ep} register, and
9809 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9810 option is on by default if you optimize.
9811
9812 @item -mno-prolog-function
9813 @itemx -mprolog-function
9814 @opindex mno-prolog-function
9815 @opindex mprolog-function
9816 Do not use (do use) external functions to save and restore registers
9817 at the prologue and epilogue of a function.  The external functions
9818 are slower, but use less code space if more than one function saves
9819 the same number of registers.  The @option{-mprolog-function} option
9820 is on by default if you optimize.
9821
9822 @item -mspace
9823 @opindex mspace
9824 Try to make the code as small as possible.  At present, this just turns
9825 on the @option{-mep} and @option{-mprolog-function} options.
9826
9827 @item -mtda=@var{n}
9828 @opindex mtda
9829 Put static or global variables whose size is @var{n} bytes or less into
9830 the tiny data area that register @code{ep} points to.  The tiny data
9831 area can hold up to 256 bytes in total (128 bytes for byte references).
9832
9833 @item -msda=@var{n}
9834 @opindex msda
9835 Put static or global variables whose size is @var{n} bytes or less into
9836 the small data area that register @code{gp} points to.  The small data
9837 area can hold up to 64 kilobytes.
9838
9839 @item -mzda=@var{n}
9840 @opindex mzda
9841 Put static or global variables whose size is @var{n} bytes or less into
9842 the first 32 kilobytes of memory.
9843
9844 @item -mv850
9845 @opindex mv850
9846 Specify that the target processor is the V850.
9847
9848 @item -mbig-switch
9849 @opindex mbig-switch
9850 Generate code suitable for big switch tables.  Use this option only if
9851 the assembler/linker complain about out of range branches within a switch
9852 table.
9853
9854 @item -mapp-regs
9855 @opindex mapp-regs
9856 This option will cause r2 and r5 to be used in the code generated by
9857 the compiler.  This setting is the default.
9858
9859 @item -mno-app-regs
9860 @opindex mno-app-regs
9861 This option will cause r2 and r5 to be treated as fixed registers.
9862   
9863 @item -mv850e1
9864 @opindex mv850e1
9865 Specify that the target processor is the V850E1.  The preprocessor
9866 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9867 this option is used.
9868
9869 @item -mv850e
9870 @opindex mv850e
9871 Specify that the target processor is the V850E.  The preprocessor
9872 constant @samp{__v850e__} will be defined if this option is used.
9873
9874 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9875 are defined then a default target processor will be chosen and the
9876 relevant @samp{__v850*__} preprocessor constant will be defined.
9877
9878 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9879 defined, regardless of which processor variant is the target.
9880
9881 @item -mdisable-callt
9882 @opindex mdisable-callt
9883 This option will suppress generation of the CALLT instruction for the
9884 v850e and v850e1 flavors of the v850 architecture.  The default is
9885 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9886
9887 @end table
9888
9889 @node ARC Options
9890 @subsection ARC Options
9891 @cindex ARC Options
9892
9893 These options are defined for ARC implementations:
9894
9895 @table @gcctabopt
9896 @item -EL
9897 @opindex EL
9898 Compile code for little endian mode.  This is the default.
9899
9900 @item -EB
9901 @opindex EB
9902 Compile code for big endian mode.
9903
9904 @item -mmangle-cpu
9905 @opindex mmangle-cpu
9906 Prepend the name of the cpu to all public symbol names.
9907 In multiple-processor systems, there are many ARC variants with different
9908 instruction and register set characteristics.  This flag prevents code
9909 compiled for one cpu to be linked with code compiled for another.
9910 No facility exists for handling variants that are ``almost identical''.
9911 This is an all or nothing option.
9912
9913 @item -mcpu=@var{cpu}
9914 @opindex mcpu
9915 Compile code for ARC variant @var{cpu}.
9916 Which variants are supported depend on the configuration.
9917 All variants support @option{-mcpu=base}, this is the default.
9918
9919 @item -mtext=@var{text-section}
9920 @itemx -mdata=@var{data-section}
9921 @itemx -mrodata=@var{readonly-data-section}
9922 @opindex mtext
9923 @opindex mdata
9924 @opindex mrodata
9925 Put functions, data, and readonly data in @var{text-section},
9926 @var{data-section}, and @var{readonly-data-section} respectively
9927 by default.  This can be overridden with the @code{section} attribute.
9928 @xref{Variable Attributes}.
9929
9930 @end table
9931
9932 @node NS32K Options
9933 @subsection NS32K Options
9934 @cindex NS32K options
9935
9936 These are the @samp{-m} options defined for the 32000 series.  The default
9937 values for these options depends on which style of 32000 was selected when
9938 the compiler was configured; the defaults for the most common choices are
9939 given below.
9940
9941 @table @gcctabopt
9942 @item -m32032
9943 @itemx -m32032
9944 @opindex m32032
9945 @opindex m32032
9946 Generate output for a 32032.  This is the default
9947 when the compiler is configured for 32032 and 32016 based systems.
9948
9949 @item -m32332
9950 @itemx -m32332
9951 @opindex m32332
9952 @opindex m32332
9953 Generate output for a 32332.  This is the default
9954 when the compiler is configured for 32332-based systems.
9955
9956 @item -m32532
9957 @itemx -m32532
9958 @opindex m32532
9959 @opindex m32532
9960 Generate output for a 32532.  This is the default
9961 when the compiler is configured for 32532-based systems.
9962
9963 @item -m32081
9964 @opindex m32081
9965 Generate output containing 32081 instructions for floating point.
9966 This is the default for all systems.
9967
9968 @item -m32381
9969 @opindex m32381
9970 Generate output containing 32381 instructions for floating point.  This
9971 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9972 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9973
9974 @item -mmulti-add
9975 @opindex mmulti-add
9976 Try and generate multiply-add floating point instructions @code{polyF}
9977 and @code{dotF}.  This option is only available if the @option{-m32381}
9978 option is in effect.  Using these instructions requires changes to
9979 register allocation which generally has a negative impact on
9980 performance.  This option should only be enabled when compiling code
9981 particularly likely to make heavy use of multiply-add instructions.
9982
9983 @item -mnomulti-add
9984 @opindex mnomulti-add
9985 Do not try and generate multiply-add floating point instructions
9986 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9987
9988 @item -msoft-float
9989 @opindex msoft-float
9990 Generate output containing library calls for floating point.
9991 @strong{Warning:} the requisite libraries may not be available.
9992
9993 @item -mieee-compare
9994 @itemx -mno-ieee-compare
9995 @opindex mieee-compare
9996 @opindex mno-ieee-compare
9997 Control whether or not the compiler uses IEEE floating point
9998 comparisons.  These handle correctly the case where the result of a
9999 comparison is unordered.
10000 @strong{Warning:} the requisite kernel support may not be available.
10001
10002 @item -mnobitfield
10003 @opindex mnobitfield
10004 Do not use the bit-field instructions.  On some machines it is faster to
10005 use shifting and masking operations.  This is the default for the pc532.
10006
10007 @item -mbitfield
10008 @opindex mbitfield
10009 Do use the bit-field instructions.  This is the default for all platforms
10010 except the pc532.
10011
10012 @item -mrtd
10013 @opindex mrtd
10014 Use a different function-calling convention, in which functions
10015 that take a fixed number of arguments return pop their
10016 arguments on return with the @code{ret} instruction.
10017
10018 This calling convention is incompatible with the one normally
10019 used on Unix, so you cannot use it if you need to call libraries
10020 compiled with the Unix compiler.
10021
10022 Also, you must provide function prototypes for all functions that
10023 take variable numbers of arguments (including @code{printf});
10024 otherwise incorrect code will be generated for calls to those
10025 functions.
10026
10027 In addition, seriously incorrect code will result if you call a
10028 function with too many arguments.  (Normally, extra arguments are
10029 harmlessly ignored.)
10030
10031 This option takes its name from the 680x0 @code{rtd} instruction.
10032
10033
10034 @item -mregparam
10035 @opindex mregparam
10036 Use a different function-calling convention where the first two arguments
10037 are passed in registers.
10038
10039 This calling convention is incompatible with the one normally
10040 used on Unix, so you cannot use it if you need to call libraries
10041 compiled with the Unix compiler.
10042
10043 @item -mnoregparam
10044 @opindex mnoregparam
10045 Do not pass any arguments in registers.  This is the default for all
10046 targets.
10047
10048 @item -msb
10049 @opindex msb
10050 It is OK to use the sb as an index register which is always loaded with
10051 zero.  This is the default for the pc532-netbsd target.
10052
10053 @item -mnosb
10054 @opindex mnosb
10055 The sb register is not available for use or has not been initialized to
10056 zero by the run time system.  This is the default for all targets except
10057 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10058 @option{-fpic} is set.
10059
10060 @item -mhimem
10061 @opindex mhimem
10062 Many ns32000 series addressing modes use displacements of up to 512MB@.
10063 If an address is above 512MB then displacements from zero can not be used.
10064 This option causes code to be generated which can be loaded above 512MB@.
10065 This may be useful for operating systems or ROM code.
10066
10067 @item -mnohimem
10068 @opindex mnohimem
10069 Assume code will be loaded in the first 512MB of virtual address space.
10070 This is the default for all platforms.
10071
10072
10073 @end table
10074
10075 @node AVR Options
10076 @subsection AVR Options
10077 @cindex AVR Options
10078
10079 These options are defined for AVR implementations:
10080
10081 @table @gcctabopt
10082 @item -mmcu=@var{mcu}
10083 @opindex mmcu
10084 Specify ATMEL AVR instruction set or MCU type.
10085
10086 Instruction set avr1 is for the minimal AVR core, not supported by the C
10087 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10088 attiny11, attiny12, attiny15, attiny28).
10089
10090 Instruction set avr2 (default) is for the classic AVR core with up to
10091 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10092 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10093 at90c8534, at90s8535).
10094
10095 Instruction set avr3 is for the classic AVR core with up to 128K program
10096 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10097
10098 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10099 memory space (MCU types: atmega8, atmega83, atmega85).
10100
10101 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10102 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10103 atmega64, atmega128, at43usb355, at94k).
10104
10105 @item -msize
10106 @opindex msize
10107 Output instruction sizes to the asm file.
10108
10109 @item -minit-stack=@var{N}
10110 @opindex minit-stack
10111 Specify the initial stack address, which may be a symbol or numeric value,
10112 @samp{__stack} is the default.
10113
10114 @item -mno-interrupts
10115 @opindex mno-interrupts
10116 Generated code is not compatible with hardware interrupts.
10117 Code size will be smaller.
10118
10119 @item -mcall-prologues
10120 @opindex mcall-prologues
10121 Functions prologues/epilogues expanded as call to appropriate
10122 subroutines.  Code size will be smaller.
10123
10124 @item -mno-tablejump
10125 @opindex mno-tablejump
10126 Do not generate tablejump insns which sometimes increase code size.
10127
10128 @item -mtiny-stack
10129 @opindex mtiny-stack
10130 Change only the low 8 bits of the stack pointer.
10131 @end table
10132
10133 @node MCore Options
10134 @subsection MCore Options
10135 @cindex MCore options
10136
10137 These are the @samp{-m} options defined for the Motorola M*Core
10138 processors.
10139
10140 @table @gcctabopt
10141
10142 @item -mhardlit
10143 @itemx -mno-hardlit
10144 @opindex mhardlit
10145 @opindex mno-hardlit
10146 Inline constants into the code stream if it can be done in two
10147 instructions or less.
10148
10149 @item -mdiv
10150 @itemx -mno-div
10151 @opindex mdiv
10152 @opindex mno-div
10153 Use the divide instruction.  (Enabled by default).
10154
10155 @item -mrelax-immediate
10156 @itemx -mno-relax-immediate
10157 @opindex mrelax-immediate
10158 @opindex mno-relax-immediate
10159 Allow arbitrary sized immediates in bit operations.
10160
10161 @item -mwide-bitfields
10162 @itemx -mno-wide-bitfields
10163 @opindex mwide-bitfields
10164 @opindex mno-wide-bitfields
10165 Always treat bit-fields as int-sized.
10166
10167 @item -m4byte-functions
10168 @itemx -mno-4byte-functions
10169 @opindex m4byte-functions
10170 @opindex mno-4byte-functions
10171 Force all functions to be aligned to a four byte boundary.
10172
10173 @item -mcallgraph-data
10174 @itemx -mno-callgraph-data
10175 @opindex mcallgraph-data
10176 @opindex mno-callgraph-data
10177 Emit callgraph information.
10178
10179 @item -mslow-bytes
10180 @itemx -mno-slow-bytes
10181 @opindex mslow-bytes
10182 @opindex mno-slow-bytes
10183 Prefer word access when reading byte quantities.
10184
10185 @item -mlittle-endian
10186 @itemx -mbig-endian
10187 @opindex mlittle-endian
10188 @opindex mbig-endian
10189 Generate code for a little endian target.
10190
10191 @item -m210
10192 @itemx -m340
10193 @opindex m210
10194 @opindex m340
10195 Generate code for the 210 processor.
10196 @end table
10197
10198 @node IA-64 Options
10199 @subsection IA-64 Options
10200 @cindex IA-64 Options
10201
10202 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10203
10204 @table @gcctabopt
10205 @item -mbig-endian
10206 @opindex mbig-endian
10207 Generate code for a big endian target.  This is the default for HP-UX@.
10208
10209 @item -mlittle-endian
10210 @opindex mlittle-endian
10211 Generate code for a little endian target.  This is the default for AIX5
10212 and Linux.
10213
10214 @item -mgnu-as
10215 @itemx -mno-gnu-as
10216 @opindex mgnu-as
10217 @opindex mno-gnu-as
10218 Generate (or don't) code for the GNU assembler.  This is the default.
10219 @c Also, this is the default if the configure option @option{--with-gnu-as}
10220 @c is used.
10221
10222 @item -mgnu-ld
10223 @itemx -mno-gnu-ld
10224 @opindex mgnu-ld
10225 @opindex mno-gnu-ld
10226 Generate (or don't) code for the GNU linker.  This is the default.
10227 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10228 @c is used.
10229
10230 @item -mno-pic
10231 @opindex mno-pic
10232 Generate code that does not use a global pointer register.  The result
10233 is not position independent code, and violates the IA-64 ABI@.
10234
10235 @item -mvolatile-asm-stop
10236 @itemx -mno-volatile-asm-stop
10237 @opindex mvolatile-asm-stop
10238 @opindex mno-volatile-asm-stop
10239 Generate (or don't) a stop bit immediately before and after volatile asm
10240 statements.
10241
10242 @item -mb-step
10243 @opindex mb-step
10244 Generate code that works around Itanium B step errata.
10245
10246 @item -mregister-names
10247 @itemx -mno-register-names
10248 @opindex mregister-names
10249 @opindex mno-register-names
10250 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10251 the stacked registers.  This may make assembler output more readable.
10252
10253 @item -mno-sdata
10254 @itemx -msdata
10255 @opindex mno-sdata
10256 @opindex msdata
10257 Disable (or enable) optimizations that use the small data section.  This may
10258 be useful for working around optimizer bugs.
10259
10260 @item -mconstant-gp
10261 @opindex mconstant-gp
10262 Generate code that uses a single constant global pointer value.  This is
10263 useful when compiling kernel code.
10264
10265 @item -mauto-pic
10266 @opindex mauto-pic
10267 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10268 This is useful when compiling firmware code.
10269
10270 @item -minline-float-divide-min-latency
10271 @opindex minline-float-divide-min-latency
10272 Generate code for inline divides of floating point values
10273 using the minimum latency algorithm.
10274
10275 @item -minline-float-divide-max-throughput
10276 @opindex minline-float-divide-max-throughput
10277 Generate code for inline divides of floating point values
10278 using the maximum throughput algorithm.
10279
10280 @item -minline-int-divide-min-latency
10281 @opindex minline-int-divide-min-latency
10282 Generate code for inline divides of integer values
10283 using the minimum latency algorithm.
10284
10285 @item -minline-int-divide-max-throughput
10286 @opindex minline-int-divide-max-throughput
10287 Generate code for inline divides of integer values
10288 using the maximum throughput algorithm.
10289
10290 @item -mno-dwarf2-asm
10291 @itemx -mdwarf2-asm
10292 @opindex mno-dwarf2-asm
10293 @opindex mdwarf2-asm
10294 Don't (or do) generate assembler code for the DWARF2 line number debugging
10295 info.  This may be useful when not using the GNU assembler.
10296
10297 @item -mfixed-range=@var{register-range}
10298 @opindex mfixed-range
10299 Generate code treating the given register range as fixed registers.
10300 A fixed register is one that the register allocator can not use.  This is
10301 useful when compiling kernel code.  A register range is specified as
10302 two registers separated by a dash.  Multiple register ranges can be
10303 specified separated by a comma.
10304
10305 @item -mearly-stop-bits
10306 @itemx -mno-early-stop-bits
10307 @opindex mearly-stop-bits
10308 @opindex mno-early-stop-bits
10309 Allow stop bits to be placed earlier than immediately preceding the
10310 instruction that triggered the stop bit.  This can improve instruction
10311 scheduling, but does not always do so.
10312 @end table
10313
10314 @node D30V Options
10315 @subsection D30V Options
10316 @cindex D30V Options
10317
10318 These @samp{-m} options are defined for D30V implementations:
10319
10320 @table @gcctabopt
10321 @item -mextmem
10322 @opindex mextmem
10323 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10324 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10325 memory, which starts at location @code{0x80000000}.
10326
10327 @item -mextmemory
10328 @opindex mextmemory
10329 Same as the @option{-mextmem} switch.
10330
10331 @item -monchip
10332 @opindex monchip
10333 Link the @samp{.text} section into onchip text memory, which starts at
10334 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10335 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10336 into onchip data memory, which starts at location @code{0x20000000}.
10337
10338 @item -mno-asm-optimize
10339 @itemx -masm-optimize
10340 @opindex mno-asm-optimize
10341 @opindex masm-optimize
10342 Disable (enable) passing @option{-O} to the assembler when optimizing.
10343 The assembler uses the @option{-O} option to automatically parallelize
10344 adjacent short instructions where possible.
10345
10346 @item -mbranch-cost=@var{n}
10347 @opindex mbranch-cost
10348 Increase the internal costs of branches to @var{n}.  Higher costs means
10349 that the compiler will issue more instructions to avoid doing a branch.
10350 The default is 2.
10351
10352 @item -mcond-exec=@var{n}
10353 @opindex mcond-exec
10354 Specify the maximum number of conditionally executed instructions that
10355 replace a branch.  The default is 4.
10356 @end table
10357
10358 @node S/390 and zSeries Options
10359 @subsection S/390 and zSeries Options
10360 @cindex S/390 and zSeries Options
10361
10362 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10363
10364 @table @gcctabopt
10365 @item -mhard-float
10366 @itemx -msoft-float
10367 @opindex mhard-float
10368 @opindex msoft-float
10369 Use (do not use) the hardware floating-point instructions and registers
10370 for floating-point operations.  When @option{-msoft-float} is specified,
10371 functions in @file{libgcc.a} will be used to perform floating-point
10372 operations.  When @option{-mhard-float} is specified, the compiler
10373 generates IEEE floating-point instructions.  This is the default.
10374
10375 @item -mbackchain
10376 @itemx -mno-backchain
10377 @opindex mbackchain
10378 @opindex mno-backchain
10379 Generate (or do not generate) code which maintains an explicit
10380 backchain within the stack frame that points to the caller's frame.
10381 This is currently needed to allow debugging.  The default is to
10382 generate the backchain.
10383
10384 @item -msmall-exec
10385 @itemx -mno-small-exec
10386 @opindex msmall-exec
10387 @opindex mno-small-exec
10388 Generate (or do not generate) code using the @code{bras} instruction
10389 to do subroutine calls.
10390 This only works reliably if the total executable size does not
10391 exceed 64k.  The default is to use the @code{basr} instruction instead,
10392 which does not have this limitation.
10393
10394 @item -m64
10395 @itemx -m31
10396 @opindex m64
10397 @opindex m31
10398 When @option{-m31} is specified, generate code compliant to the
10399 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10400 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10401 particular to generate 64-bit instructions.  For the @samp{s390}
10402 targets, the default is @option{-m31}, while the @samp{s390x}
10403 targets default to @option{-m64}.
10404
10405 @item -mzarch
10406 @itemx -mesa
10407 @opindex mzarch
10408 @opindex mesa
10409 When @option{-mzarch} is specified, generate code using the 
10410 instructions available on z/Architecture. 
10411 When @option{-mesa} is specified, generate code using the 
10412 instructions available on ESA/390. Note that @option{-mesa} is
10413 not possible with @option{-m64}.
10414 When generating code compliant to the Linux for S/390 ABI,
10415 the default is @option{-mesa}.  When generating code compliant
10416 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10417
10418 @item -mmvcle
10419 @itemx -mno-mvcle
10420 @opindex mmvcle
10421 @opindex mno-mvcle
10422 Generate (or do not generate) code using the @code{mvcle} instruction
10423 to perform block moves.  When @option{-mno-mvcle} is specified,
10424 use a @code{mvc} loop instead.  This is the default.
10425
10426 @item -mdebug
10427 @itemx -mno-debug
10428 @opindex mdebug
10429 @opindex mno-debug
10430 Print (or do not print) additional debug information when compiling.
10431 The default is to not print debug information.
10432
10433 @item -march=@var{cpu-type}
10434 @opindex march
10435 Generate code that will run on @var{cpu-type}, which is the name of a system
10436 representing a certain processor type. Possible values for
10437 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10438 When generating code using the instructions available on z/Architecture,
10439 the default is @option{-march=z900}.  Otherwise, the default is
10440 @option{-march=g5}.
10441
10442 @item -mtune=@var{cpu-type}
10443 @opindex mtune
10444 Tune to @var{cpu-type} everything applicable about the generated code,
10445 except for the ABI and the set of available instructions.
10446 The list of @var{cpu-type} values is the same as for @option{-march}.
10447 The default is the value used for @option{-march}.
10448
10449 @item -mfused-madd
10450 @itemx -mno-fused-madd
10451 @opindex mfused-madd
10452 @opindex mno-fused-madd
10453 Generate code that uses (does not use) the floating point multiply and
10454 accumulate instructions.  These instructions are generated by default if
10455 hardware floating point is used.
10456 @end table
10457
10458 @node CRIS Options
10459 @subsection CRIS Options
10460 @cindex CRIS Options
10461
10462 These options are defined specifically for the CRIS ports.
10463
10464 @table @gcctabopt
10465 @item -march=@var{architecture-type}
10466 @itemx -mcpu=@var{architecture-type}
10467 @opindex march
10468 @opindex mcpu
10469 Generate code for the specified architecture.  The choices for
10470 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10471 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10472 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10473 @samp{v10}.
10474
10475 @item -mtune=@var{architecture-type}
10476 @opindex mtune
10477 Tune to @var{architecture-type} everything applicable about the generated
10478 code, except for the ABI and the set of available instructions.  The
10479 choices for @var{architecture-type} are the same as for
10480 @option{-march=@var{architecture-type}}.
10481
10482 @item -mmax-stack-frame=@var{n}
10483 @opindex mmax-stack-frame
10484 Warn when the stack frame of a function exceeds @var{n} bytes.
10485
10486 @item -melinux-stacksize=@var{n}
10487 @opindex melinux-stacksize
10488 Only available with the @samp{cris-axis-aout} target.  Arranges for
10489 indications in the program to the kernel loader that the stack of the
10490 program should be set to @var{n} bytes.
10491
10492 @item -metrax4
10493 @itemx -metrax100
10494 @opindex metrax4
10495 @opindex metrax100
10496 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10497 @option{-march=v3} and @option{-march=v8} respectively.
10498
10499 @item -mpdebug
10500 @opindex mpdebug
10501 Enable CRIS-specific verbose debug-related information in the assembly
10502 code.  This option also has the effect to turn off the @samp{#NO_APP}
10503 formatted-code indicator to the assembler at the beginning of the
10504 assembly file.
10505
10506 @item -mcc-init
10507 @opindex mcc-init
10508 Do not use condition-code results from previous instruction; always emit
10509 compare and test instructions before use of condition codes.
10510
10511 @item -mno-side-effects
10512 @opindex mno-side-effects
10513 Do not emit instructions with side-effects in addressing modes other than
10514 post-increment.
10515
10516 @item -mstack-align
10517 @itemx -mno-stack-align
10518 @itemx -mdata-align
10519 @itemx -mno-data-align
10520 @itemx -mconst-align
10521 @itemx -mno-const-align
10522 @opindex mstack-align
10523 @opindex mno-stack-align
10524 @opindex mdata-align
10525 @opindex mno-data-align
10526 @opindex mconst-align
10527 @opindex mno-const-align
10528 These options (no-options) arranges (eliminate arrangements) for the
10529 stack-frame, individual data and constants to be aligned for the maximum
10530 single data access size for the chosen CPU model.  The default is to
10531 arrange for 32-bit alignment.  ABI details such as structure layout are
10532 not affected by these options.
10533
10534 @item -m32-bit
10535 @itemx -m16-bit
10536 @itemx -m8-bit
10537 @opindex m32-bit
10538 @opindex m16-bit
10539 @opindex m8-bit
10540 Similar to the stack- data- and const-align options above, these options
10541 arrange for stack-frame, writable data and constants to all be 32-bit,
10542 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10543
10544 @item -mno-prologue-epilogue
10545 @itemx -mprologue-epilogue
10546 @opindex mno-prologue-epilogue
10547 @opindex mprologue-epilogue
10548 With @option{-mno-prologue-epilogue}, the normal function prologue and
10549 epilogue that sets up the stack-frame are omitted and no return
10550 instructions or return sequences are generated in the code.  Use this
10551 option only together with visual inspection of the compiled code: no
10552 warnings or errors are generated when call-saved registers must be saved,
10553 or storage for local variable needs to be allocated.
10554
10555 @item -mno-gotplt
10556 @itemx -mgotplt
10557 @opindex mno-gotplt
10558 @opindex mgotplt
10559 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10560 instruction sequences that load addresses for functions from the PLT part
10561 of the GOT rather than (traditional on other architectures) calls to the
10562 PLT.  The default is @option{-mgotplt}.
10563
10564 @item -maout
10565 @opindex maout
10566 Legacy no-op option only recognized with the cris-axis-aout target.
10567
10568 @item -melf
10569 @opindex melf
10570 Legacy no-op option only recognized with the cris-axis-elf and
10571 cris-axis-linux-gnu targets.
10572
10573 @item -melinux
10574 @opindex melinux
10575 Only recognized with the cris-axis-aout target, where it selects a
10576 GNU/linux-like multilib, include files and instruction set for
10577 @option{-march=v8}.
10578
10579 @item -mlinux
10580 @opindex mlinux
10581 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10582
10583 @item -sim
10584 @opindex sim
10585 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10586 to link with input-output functions from a simulator library.  Code,
10587 initialized data and zero-initialized data are allocated consecutively.
10588
10589 @item -sim2
10590 @opindex sim2
10591 Like @option{-sim}, but pass linker options to locate initialized data at
10592 0x40000000 and zero-initialized data at 0x80000000.
10593 @end table
10594
10595 @node MMIX Options
10596 @subsection MMIX Options
10597 @cindex MMIX Options
10598
10599 These options are defined for the MMIX:
10600
10601 @table @gcctabopt
10602 @item -mlibfuncs
10603 @itemx -mno-libfuncs
10604 @opindex mlibfuncs
10605 @opindex mno-libfuncs
10606 Specify that intrinsic library functions are being compiled, passing all
10607 values in registers, no matter the size.
10608
10609 @item -mepsilon
10610 @itemx -mno-epsilon
10611 @opindex mepsilon
10612 @opindex mno-epsilon
10613 Generate floating-point comparison instructions that compare with respect
10614 to the @code{rE} epsilon register.
10615
10616 @item -mabi=mmixware
10617 @itemx -mabi=gnu
10618 @opindex mabi-mmixware
10619 @opindex mabi=gnu
10620 Generate code that passes function parameters and return values that (in
10621 the called function) are seen as registers @code{$0} and up, as opposed to
10622 the GNU ABI which uses global registers @code{$231} and up.
10623
10624 @item -mzero-extend
10625 @itemx -mno-zero-extend
10626 @opindex mzero-extend
10627 @opindex mno-zero-extend
10628 When reading data from memory in sizes shorter than 64 bits, use (do not
10629 use) zero-extending load instructions by default, rather than
10630 sign-extending ones.
10631
10632 @item -mknuthdiv
10633 @itemx -mno-knuthdiv
10634 @opindex mknuthdiv
10635 @opindex mno-knuthdiv
10636 Make the result of a division yielding a remainder have the same sign as
10637 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10638 remainder follows the sign of the dividend.  Both methods are
10639 arithmetically valid, the latter being almost exclusively used.
10640
10641 @item -mtoplevel-symbols
10642 @itemx -mno-toplevel-symbols
10643 @opindex mtoplevel-symbols
10644 @opindex mno-toplevel-symbols
10645 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10646 code can be used with the @code{PREFIX} assembly directive.
10647
10648 @item -melf
10649 @opindex melf
10650 Generate an executable in the ELF format, rather than the default
10651 @samp{mmo} format used by the @command{mmix} simulator.
10652
10653 @item -mbranch-predict
10654 @itemx -mno-branch-predict
10655 @opindex mbranch-predict
10656 @opindex mno-branch-predict
10657 Use (do not use) the probable-branch instructions, when static branch
10658 prediction indicates a probable branch.
10659
10660 @item -mbase-addresses
10661 @itemx -mno-base-addresses
10662 @opindex mbase-addresses
10663 @opindex mno-base-addresses
10664 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10665 base address automatically generates a request (handled by the assembler
10666 and the linker) for a constant to be set up in a global register.  The
10667 register is used for one or more base address requests within the range 0
10668 to 255 from the value held in the register.  The generally leads to short
10669 and fast code, but the number of different data items that can be
10670 addressed is limited.  This means that a program that uses lots of static
10671 data may require @option{-mno-base-addresses}.
10672
10673 @item -msingle-exit
10674 @itemx -mno-single-exit
10675 @opindex msingle-exit
10676 @opindex mno-single-exit
10677 Force (do not force) generated code to have a single exit point in each
10678 function.
10679 @end table
10680
10681 @node PDP-11 Options
10682 @subsection PDP-11 Options
10683 @cindex PDP-11 Options
10684
10685 These options are defined for the PDP-11:
10686
10687 @table @gcctabopt
10688 @item -mfpu
10689 @opindex mfpu
10690 Use hardware FPP floating point.  This is the default.  (FIS floating
10691 point on the PDP-11/40 is not supported.)
10692
10693 @item -msoft-float
10694 @opindex msoft-float
10695 Do not use hardware floating point.
10696
10697 @item -mac0
10698 @opindex mac0
10699 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10700
10701 @item -mno-ac0
10702 @opindex mno-ac0
10703 Return floating-point results in memory.  This is the default.
10704
10705 @item -m40
10706 @opindex m40
10707 Generate code for a PDP-11/40.
10708
10709 @item -m45
10710 @opindex m45
10711 Generate code for a PDP-11/45.  This is the default.
10712
10713 @item -m10
10714 @opindex m10
10715 Generate code for a PDP-11/10.
10716
10717 @item -mbcopy-builtin
10718 @opindex bcopy-builtin
10719 Use inline @code{movstrhi} patterns for copying memory.  This is the
10720 default.
10721
10722 @item -mbcopy
10723 @opindex mbcopy
10724 Do not use inline @code{movstrhi} patterns for copying memory.
10725
10726 @item -mint16
10727 @itemx -mno-int32
10728 @opindex mint16
10729 @opindex mno-int32
10730 Use 16-bit @code{int}.  This is the default.
10731
10732 @item -mint32
10733 @itemx -mno-int16
10734 @opindex mint32
10735 @opindex mno-int16
10736 Use 32-bit @code{int}.
10737
10738 @item -mfloat64
10739 @itemx -mno-float32
10740 @opindex mfloat64
10741 @opindex mno-float32
10742 Use 64-bit @code{float}.  This is the default.
10743
10744 @item -mfloat32
10745 @item -mno-float64
10746 @opindex mfloat32
10747 @opindex mno-float64
10748 Use 32-bit @code{float}.
10749
10750 @item -mabshi
10751 @opindex mabshi
10752 Use @code{abshi2} pattern.  This is the default.
10753
10754 @item -mno-abshi
10755 @opindex mno-abshi
10756 Do not use @code{abshi2} pattern.
10757
10758 @item -mbranch-expensive
10759 @opindex mbranch-expensive
10760 Pretend that branches are expensive.  This is for experimenting with
10761 code generation only.
10762
10763 @item -mbranch-cheap
10764 @opindex mbranch-cheap
10765 Do not pretend that branches are expensive.  This is the default.
10766
10767 @item -msplit
10768 @opindex msplit
10769 Generate code for a system with split I&D.
10770
10771 @item -mno-split
10772 @opindex mno-split
10773 Generate code for a system without split I&D.  This is the default.
10774
10775 @item -munix-asm
10776 @opindex munix-asm
10777 Use Unix assembler syntax.  This is the default when configured for
10778 @samp{pdp11-*-bsd}.
10779
10780 @item -mdec-asm
10781 @opindex mdec-asm
10782 Use DEC assembler syntax.  This is the default when configured for any
10783 PDP-11 target other than @samp{pdp11-*-bsd}.
10784 @end table
10785
10786 @node Xstormy16 Options
10787 @subsection Xstormy16 Options
10788 @cindex Xstormy16 Options
10789
10790 These options are defined for Xstormy16:
10791
10792 @table @gcctabopt
10793 @item -msim
10794 @opindex msim
10795 Choose startup files and linker script suitable for the simulator.
10796 @end table
10797
10798 @node FRV Options
10799 @subsection FRV Options
10800 @cindex FRV Options
10801
10802 @table @gcctabopt
10803 @item -mgpr-32
10804 @opindex mgpr-32
10805
10806 Only use the first 32 general purpose registers.
10807
10808 @item -mgpr-64
10809 @opindex mgpr-64
10810
10811 Use all 64 general purpose registers.
10812
10813 @item -mfpr-32
10814 @opindex mfpr-32
10815
10816 Use only the first 32 floating point registers.
10817
10818 @item -mfpr-64
10819 @opindex mfpr-64
10820
10821 Use all 64 floating point registers
10822
10823 @item -mhard-float
10824 @opindex mhard-float
10825
10826 Use hardware instructions for floating point operations.
10827
10828 @item -msoft-float
10829 @opindex msoft-float
10830
10831 Use library routines for floating point operations.
10832
10833 @item -malloc-cc
10834 @opindex malloc-cc
10835
10836 Dynamically allocate condition code registers.
10837
10838 @item -mfixed-cc
10839 @opindex mfixed-cc
10840
10841 Do not try to dynamically allocate condition code registers, only
10842 use @code{icc0} and @code{fcc0}.
10843
10844 @item -mdword
10845 @opindex mdword
10846
10847 Change ABI to use double word insns.
10848
10849 @item -mno-dword
10850 @opindex mno-dword
10851
10852 Do not use double word instructions.
10853
10854 @item -mdouble
10855 @opindex mdouble
10856
10857 Use floating point double instructions.
10858
10859 @item -mno-double
10860 @opindex mno-double
10861
10862 Do not use floating point double instructions.
10863
10864 @item -mmedia
10865 @opindex mmedia
10866
10867 Use media instructions.
10868
10869 @item -mno-media
10870 @opindex mno-media
10871
10872 Do not use media instructions.
10873
10874 @item -mmuladd
10875 @opindex mmuladd
10876
10877 Use multiply and add/subtract instructions.
10878
10879 @item -mno-muladd
10880 @opindex mno-muladd
10881
10882 Do not use multiply and add/subtract instructions.
10883
10884 @item -mlibrary-pic
10885 @opindex mlibrary-pic
10886
10887 Enable PIC support for building libraries
10888
10889 @item -macc-4
10890 @opindex macc-4
10891
10892 Use only the first four media accumulator registers.
10893
10894 @item -macc-8
10895 @opindex macc-8
10896
10897 Use all eight media accumulator registers.
10898
10899 @item -mpack
10900 @opindex mpack
10901
10902 Pack VLIW instructions.
10903
10904 @item -mno-pack
10905 @opindex mno-pack
10906
10907 Do not pack VLIW instructions.
10908
10909 @item -mno-eflags
10910 @opindex mno-eflags
10911
10912 Do not mark ABI switches in e_flags.
10913
10914 @item -mcond-move
10915 @opindex mcond-move
10916
10917 Enable the use of conditional-move instructions (default).
10918
10919 This switch is mainly for debugging the compiler and will likely be removed
10920 in a future version.
10921
10922 @item -mno-cond-move
10923 @opindex mno-cond-move
10924
10925 Disable the use of conditional-move instructions.
10926
10927 This switch is mainly for debugging the compiler and will likely be removed
10928 in a future version.
10929
10930 @item -mscc
10931 @opindex mscc
10932
10933 Enable the use of conditional set instructions (default).
10934
10935 This switch is mainly for debugging the compiler and will likely be removed
10936 in a future version.
10937
10938 @item -mno-scc
10939 @opindex mno-scc
10940
10941 Disable the use of conditional set instructions.
10942
10943 This switch is mainly for debugging the compiler and will likely be removed
10944 in a future version.
10945
10946 @item -mcond-exec
10947 @opindex mcond-exec
10948
10949 Enable the use of conditional execution (default).
10950
10951 This switch is mainly for debugging the compiler and will likely be removed
10952 in a future version.
10953
10954 @item -mno-cond-exec
10955 @opindex mno-cond-exec
10956
10957 Disable the use of conditional execution.
10958
10959 This switch is mainly for debugging the compiler and will likely be removed
10960 in a future version.
10961
10962 @item -mvliw-branch
10963 @opindex mvliw-branch
10964
10965 Run a pass to pack branches into VLIW instructions (default).
10966
10967 This switch is mainly for debugging the compiler and will likely be removed
10968 in a future version.
10969
10970 @item -mno-vliw-branch
10971 @opindex mno-vliw-branch
10972
10973 Do not run a pass to pack branches into VLIW instructions.
10974
10975 This switch is mainly for debugging the compiler and will likely be removed
10976 in a future version.
10977
10978 @item -mmulti-cond-exec
10979 @opindex mmulti-cond-exec
10980
10981 Enable optimization of @code{&&} and @code{||} in conditional execution
10982 (default).
10983
10984 This switch is mainly for debugging the compiler and will likely be removed
10985 in a future version.
10986
10987 @item -mno-multi-cond-exec
10988 @opindex mno-multi-cond-exec
10989
10990 Disable optimization of @code{&&} and @code{||} in conditional execution.
10991
10992 This switch is mainly for debugging the compiler and will likely be removed
10993 in a future version.
10994
10995 @item -mnested-cond-exec
10996 @opindex mnested-cond-exec
10997
10998 Enable nested conditional execution optimizations (default).
10999
11000 This switch is mainly for debugging the compiler and will likely be removed
11001 in a future version.
11002
11003 @item -mno-nested-cond-exec
11004 @opindex mno-nested-cond-exec
11005
11006 Disable nested conditional execution optimizations.
11007
11008 This switch is mainly for debugging the compiler and will likely be removed
11009 in a future version.
11010
11011 @item -mtomcat-stats
11012 @opindex mtomcat-stats
11013
11014 Cause gas to print out tomcat statistics.
11015
11016 @item -mcpu=@var{cpu}
11017 @opindex mcpu
11018
11019 Select the processor type for which to generate code.  Possible values are
11020 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
11021 @samp{frv}.
11022
11023 @end table
11024
11025 @node Xtensa Options
11026 @subsection Xtensa Options
11027 @cindex Xtensa Options
11028
11029 These options are supported for Xtensa targets:
11030
11031 @table @gcctabopt
11032 @item -mconst16
11033 @itemx -mno-const16
11034 @opindex mconst16
11035 @opindex mno-const16
11036 Enable or disable use of @code{CONST16} instructions for loading
11037 constant values.  The @code{CONST16} instruction is currently not a
11038 standard option from Tensilica.  When enabled, @code{CONST16}
11039 instructions are always used in place of the standard @code{L32R}
11040 instructions.  The use of @code{CONST16} is enabled by default only if
11041 the @code{L32R} instruction is not available.
11042
11043 @item -mfused-madd
11044 @itemx -mno-fused-madd
11045 @opindex mfused-madd
11046 @opindex mno-fused-madd
11047 Enable or disable use of fused multiply/add and multiply/subtract
11048 instructions in the floating-point option.  This has no effect if the
11049 floating-point option is not also enabled.  Disabling fused multiply/add
11050 and multiply/subtract instructions forces the compiler to use separate
11051 instructions for the multiply and add/subtract operations.  This may be
11052 desirable in some cases where strict IEEE 754-compliant results are
11053 required: the fused multiply add/subtract instructions do not round the
11054 intermediate result, thereby producing results with @emph{more} bits of
11055 precision than specified by the IEEE standard.  Disabling fused multiply
11056 add/subtract instructions also ensures that the program output is not
11057 sensitive to the compiler's ability to combine multiply and add/subtract
11058 operations.
11059
11060 @item -mtext-section-literals
11061 @itemx -mno-text-section-literals
11062 @opindex mtext-section-literals
11063 @opindex mno-text-section-literals
11064 Control the treatment of literal pools.  The default is
11065 @option{-mno-text-section-literals}, which places literals in a separate
11066 section in the output file.  This allows the literal pool to be placed
11067 in a data RAM/ROM, and it also allows the linker to combine literal
11068 pools from separate object files to remove redundant literals and
11069 improve code size.  With @option{-mtext-section-literals}, the literals
11070 are interspersed in the text section in order to keep them as close as
11071 possible to their references.  This may be necessary for large assembly
11072 files.
11073
11074 @item -mtarget-align
11075 @itemx -mno-target-align
11076 @opindex mtarget-align
11077 @opindex mno-target-align
11078 When this option is enabled, GCC instructs the assembler to
11079 automatically align instructions to reduce branch penalties at the
11080 expense of some code density.  The assembler attempts to widen density
11081 instructions to align branch targets and the instructions following call
11082 instructions.  If there are not enough preceding safe density
11083 instructions to align a target, no widening will be performed.  The
11084 default is @option{-mtarget-align}.  These options do not affect the
11085 treatment of auto-aligned instructions like @code{LOOP}, which the
11086 assembler will always align, either by widening density instructions or
11087 by inserting no-op instructions.
11088
11089 @item -mlongcalls
11090 @itemx -mno-longcalls
11091 @opindex mlongcalls
11092 @opindex mno-longcalls
11093 When this option is enabled, GCC instructs the assembler to translate
11094 direct calls to indirect calls unless it can determine that the target
11095 of a direct call is in the range allowed by the call instruction.  This
11096 translation typically occurs for calls to functions in other source
11097 files.  Specifically, the assembler translates a direct @code{CALL}
11098 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11099 The default is @option{-mno-longcalls}.  This option should be used in
11100 programs where the call target can potentially be out of range.  This
11101 option is implemented in the assembler, not the compiler, so the
11102 assembly code generated by GCC will still show direct call
11103 instructions---look at the disassembled object code to see the actual
11104 instructions.  Note that the assembler will use an indirect call for
11105 every cross-file call, not just those that really will be out of range.
11106 @end table
11107
11108 @node Code Gen Options
11109 @section Options for Code Generation Conventions
11110 @cindex code generation conventions
11111 @cindex options, code generation
11112 @cindex run-time options
11113
11114 These machine-independent options control the interface conventions
11115 used in code generation.
11116
11117 Most of them have both positive and negative forms; the negative form
11118 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11119 one of the forms is listed---the one which is not the default.  You
11120 can figure out the other form by either removing @samp{no-} or adding
11121 it.
11122
11123 @table @gcctabopt
11124 @item -fbounds-check
11125 @opindex fbounds-check
11126 For front-ends that support it, generate additional code to check that
11127 indices used to access arrays are within the declared range.  This is
11128 currently only supported by the Java and Fortran 77 front-ends, where
11129 this option defaults to true and false respectively.
11130
11131 @item -ftrapv
11132 @opindex ftrapv
11133 This option generates traps for signed overflow on addition, subtraction,
11134 multiplication operations.
11135
11136 @item -fwrapv
11137 @opindex fwrapv
11138 This option instructs the compiler to assume that signed arithmetic
11139 overflow of addition, subtraction and multiplication wraps around
11140 using twos-complement representation.  This flag enables some optimizations
11141 and disables other.  This option is enabled by default for the Java
11142 front-end, as required by the Java language specification.
11143
11144 @item -fexceptions
11145 @opindex fexceptions
11146 Enable exception handling.  Generates extra code needed to propagate
11147 exceptions.  For some targets, this implies GCC will generate frame
11148 unwind information for all functions, which can produce significant data
11149 size overhead, although it does not affect execution.  If you do not
11150 specify this option, GCC will enable it by default for languages like
11151 C++ which normally require exception handling, and disable it for
11152 languages like C that do not normally require it.  However, you may need
11153 to enable this option when compiling C code that needs to interoperate
11154 properly with exception handlers written in C++.  You may also wish to
11155 disable this option if you are compiling older C++ programs that don't
11156 use exception handling.
11157
11158 @item -fnon-call-exceptions
11159 @opindex fnon-call-exceptions
11160 Generate code that allows trapping instructions to throw exceptions.
11161 Note that this requires platform-specific runtime support that does
11162 not exist everywhere.  Moreover, it only allows @emph{trapping}
11163 instructions to throw exceptions, i.e.@: memory references or floating
11164 point instructions.  It does not allow exceptions to be thrown from
11165 arbitrary signal handlers such as @code{SIGALRM}.
11166
11167 @item -funwind-tables
11168 @opindex funwind-tables
11169 Similar to @option{-fexceptions}, except that it will just generate any needed
11170 static data, but will not affect the generated code in any other way.
11171 You will normally not enable this option; instead, a language processor
11172 that needs this handling would enable it on your behalf.
11173
11174 @item -fasynchronous-unwind-tables
11175 @opindex funwind-tables
11176 Generate unwind table in dwarf2 format, if supported by target machine.  The
11177 table is exact at each instruction boundary, so it can be used for stack
11178 unwinding from asynchronous events (such as debugger or garbage collector).
11179
11180 @item -fpcc-struct-return
11181 @opindex fpcc-struct-return
11182 Return ``short'' @code{struct} and @code{union} values in memory like
11183 longer ones, rather than in registers.  This convention is less
11184 efficient, but it has the advantage of allowing intercallability between
11185 GCC-compiled files and files compiled with other compilers, particularly
11186 the Portable C Compiler (pcc).
11187
11188 The precise convention for returning structures in memory depends
11189 on the target configuration macros.
11190
11191 Short structures and unions are those whose size and alignment match
11192 that of some integer type.
11193
11194 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11195 switch is not binary compatible with code compiled with the
11196 @option{-freg-struct-return} switch.
11197 Use it to conform to a non-default application binary interface.
11198
11199 @item -freg-struct-return
11200 @opindex freg-struct-return
11201 Return @code{struct} and @code{union} values in registers when possible.
11202 This is more efficient for small structures than
11203 @option{-fpcc-struct-return}.
11204
11205 If you specify neither @option{-fpcc-struct-return} nor
11206 @option{-freg-struct-return}, GCC defaults to whichever convention is
11207 standard for the target.  If there is no standard convention, GCC
11208 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11209 the principal compiler.  In those cases, we can choose the standard, and
11210 we chose the more efficient register return alternative.
11211
11212 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11213 switch is not binary compatible with code compiled with the
11214 @option{-fpcc-struct-return} switch.
11215 Use it to conform to a non-default application binary interface.
11216
11217 @item -fshort-enums
11218 @opindex fshort-enums
11219 Allocate to an @code{enum} type only as many bytes as it needs for the
11220 declared range of possible values.  Specifically, the @code{enum} type
11221 will be equivalent to the smallest integer type which has enough room.
11222
11223 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11224 code that is not binary compatible with code generated without that switch.
11225 Use it to conform to a non-default application binary interface.
11226
11227 @item -fshort-double
11228 @opindex fshort-double
11229 Use the same size for @code{double} as for @code{float}.
11230
11231 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11232 code that is not binary compatible with code generated without that switch.
11233 Use it to conform to a non-default application binary interface.
11234
11235 @item -fshort-wchar
11236 @opindex fshort-wchar
11237 Override the underlying type for @samp{wchar_t} to be @samp{short
11238 unsigned int} instead of the default for the target.  This option is
11239 useful for building programs to run under WINE@.
11240
11241 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11242 code that is not binary compatible with code generated without that switch.
11243 Use it to conform to a non-default application binary interface.
11244
11245 @item -fshared-data
11246 @opindex fshared-data
11247 Requests that the data and non-@code{const} variables of this
11248 compilation be shared data rather than private data.  The distinction
11249 makes sense only on certain operating systems, where shared data is
11250 shared between processes running the same program, while private data
11251 exists in one copy per process.
11252
11253 @item -fno-common
11254 @opindex fno-common
11255 In C, allocate even uninitialized global variables in the data section of the
11256 object file, rather than generating them as common blocks.  This has the
11257 effect that if the same variable is declared (without @code{extern}) in
11258 two different compilations, you will get an error when you link them.
11259 The only reason this might be useful is if you wish to verify that the
11260 program will work on other systems which always work this way.
11261
11262 @item -fno-ident
11263 @opindex fno-ident
11264 Ignore the @samp{#ident} directive.
11265
11266 @item -fno-gnu-linker
11267 @opindex fno-gnu-linker
11268 Do not output global initializations (such as C++ constructors and
11269 destructors) in the form used by the GNU linker (on systems where the GNU
11270 linker is the standard method of handling them).  Use this option when
11271 you want to use a non-GNU linker, which also requires using the
11272 @command{collect2} program to make sure the system linker includes
11273 constructors and destructors.  (@command{collect2} is included in the GCC
11274 distribution.)  For systems which @emph{must} use @command{collect2}, the
11275 compiler driver @command{gcc} is configured to do this automatically.
11276
11277 @item -finhibit-size-directive
11278 @opindex finhibit-size-directive
11279 Don't output a @code{.size} assembler directive, or anything else that
11280 would cause trouble if the function is split in the middle, and the
11281 two halves are placed at locations far apart in memory.  This option is
11282 used when compiling @file{crtstuff.c}; you should not need to use it
11283 for anything else.
11284
11285 @item -fverbose-asm
11286 @opindex fverbose-asm
11287 Put extra commentary information in the generated assembly code to
11288 make it more readable.  This option is generally only of use to those
11289 who actually need to read the generated assembly code (perhaps while
11290 debugging the compiler itself).
11291
11292 @option{-fno-verbose-asm}, the default, causes the
11293 extra information to be omitted and is useful when comparing two assembler
11294 files.
11295
11296 @item -fpic
11297 @opindex fpic
11298 @cindex global offset table
11299 @cindex PIC
11300 Generate position-independent code (PIC) suitable for use in a shared
11301 library, if supported for the target machine.  Such code accesses all
11302 constant addresses through a global offset table (GOT)@.  The dynamic
11303 loader resolves the GOT entries when the program starts (the dynamic
11304 loader is not part of GCC; it is part of the operating system).  If
11305 the GOT size for the linked executable exceeds a machine-specific
11306 maximum size, you get an error message from the linker indicating that
11307 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11308 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11309 on the m68k and RS/6000.  The 386 has no such limit.)
11310
11311 Position-independent code requires special support, and therefore works
11312 only on certain machines.  For the 386, GCC supports PIC for System V
11313 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11314 position-independent.
11315
11316 @item -fPIC
11317 @opindex fPIC
11318 If supported for the target machine, emit position-independent code,
11319 suitable for dynamic linking and avoiding any limit on the size of the
11320 global offset table.  This option makes a difference on the m68k, m88k,
11321 and the SPARC.
11322
11323 Position-independent code requires special support, and therefore works
11324 only on certain machines.
11325
11326 @item -fpie
11327 @itemx -fPIE
11328 @opindex fpie
11329 @opindex fPIE
11330 These options are similar to @option{-fpic} and @option{-fPIC}, but
11331 generated position independent code can be only linked into executables.
11332 Usually these options are used when @option{-pie} GCC option will be
11333 used during linking.
11334
11335 @item -ffixed-@var{reg}
11336 @opindex ffixed
11337 Treat the register named @var{reg} as a fixed register; generated code
11338 should never refer to it (except perhaps as a stack pointer, frame
11339 pointer or in some other fixed role).
11340
11341 @var{reg} must be the name of a register.  The register names accepted
11342 are machine-specific and are defined in the @code{REGISTER_NAMES}
11343 macro in the machine description macro file.
11344
11345 This flag does not have a negative form, because it specifies a
11346 three-way choice.
11347
11348 @item -fcall-used-@var{reg}
11349 @opindex fcall-used
11350 Treat the register named @var{reg} as an allocable register that is
11351 clobbered by function calls.  It may be allocated for temporaries or
11352 variables that do not live across a call.  Functions compiled this way
11353 will not save and restore the register @var{reg}.
11354
11355 It is an error to used this flag with the frame pointer or stack pointer.
11356 Use of this flag for other registers that have fixed pervasive roles in
11357 the machine's execution model will produce disastrous results.
11358
11359 This flag does not have a negative form, because it specifies a
11360 three-way choice.
11361
11362 @item -fcall-saved-@var{reg}
11363 @opindex fcall-saved
11364 Treat the register named @var{reg} as an allocable register saved by
11365 functions.  It may be allocated even for temporaries or variables that
11366 live across a call.  Functions compiled this way will save and restore
11367 the register @var{reg} if they use it.
11368
11369 It is an error to used this flag with the frame pointer or stack pointer.
11370 Use of this flag for other registers that have fixed pervasive roles in
11371 the machine's execution model will produce disastrous results.
11372
11373 A different sort of disaster will result from the use of this flag for
11374 a register in which function values may be returned.
11375
11376 This flag does not have a negative form, because it specifies a
11377 three-way choice.
11378
11379 @item -fpack-struct
11380 @opindex fpack-struct
11381 Pack all structure members together without holes.
11382
11383 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11384 code that is not binary compatible with code generated without that switch.
11385 Additionally, it makes the code suboptimal.
11386 Use it to conform to a non-default application binary interface.
11387
11388 @item -finstrument-functions
11389 @opindex finstrument-functions
11390 Generate instrumentation calls for entry and exit to functions.  Just
11391 after function entry and just before function exit, the following
11392 profiling functions will be called with the address of the current
11393 function and its call site.  (On some platforms,
11394 @code{__builtin_return_address} does not work beyond the current
11395 function, so the call site information may not be available to the
11396 profiling functions otherwise.)
11397
11398 @example
11399 void __cyg_profile_func_enter (void *this_fn,
11400                                void *call_site);
11401 void __cyg_profile_func_exit  (void *this_fn,
11402                                void *call_site);
11403 @end example
11404
11405 The first argument is the address of the start of the current function,
11406 which may be looked up exactly in the symbol table.
11407
11408 This instrumentation is also done for functions expanded inline in other
11409 functions.  The profiling calls will indicate where, conceptually, the
11410 inline function is entered and exited.  This means that addressable
11411 versions of such functions must be available.  If all your uses of a
11412 function are expanded inline, this may mean an additional expansion of
11413 code size.  If you use @samp{extern inline} in your C code, an
11414 addressable version of such functions must be provided.  (This is
11415 normally the case anyways, but if you get lucky and the optimizer always
11416 expands the functions inline, you might have gotten away without
11417 providing static copies.)
11418
11419 A function may be given the attribute @code{no_instrument_function}, in
11420 which case this instrumentation will not be done.  This can be used, for
11421 example, for the profiling functions listed above, high-priority
11422 interrupt routines, and any functions from which the profiling functions
11423 cannot safely be called (perhaps signal handlers, if the profiling
11424 routines generate output or allocate memory).
11425
11426 @item -fstack-check
11427 @opindex fstack-check
11428 Generate code to verify that you do not go beyond the boundary of the
11429 stack.  You should specify this flag if you are running in an
11430 environment with multiple threads, but only rarely need to specify it in
11431 a single-threaded environment since stack overflow is automatically
11432 detected on nearly all systems if there is only one stack.
11433
11434 Note that this switch does not actually cause checking to be done; the
11435 operating system must do that.  The switch causes generation of code
11436 to ensure that the operating system sees the stack being extended.
11437
11438 @item -fstack-limit-register=@var{reg}
11439 @itemx -fstack-limit-symbol=@var{sym}
11440 @itemx -fno-stack-limit
11441 @opindex fstack-limit-register
11442 @opindex fstack-limit-symbol
11443 @opindex fno-stack-limit
11444 Generate code to ensure that the stack does not grow beyond a certain value,
11445 either the value of a register or the address of a symbol.  If the stack
11446 would grow beyond the value, a signal is raised.  For most targets,
11447 the signal is raised before the stack overruns the boundary, so
11448 it is possible to catch the signal without taking special precautions.
11449
11450 For instance, if the stack starts at absolute address @samp{0x80000000}
11451 and grows downwards, you can use the flags
11452 @option{-fstack-limit-symbol=__stack_limit} and
11453 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11454 of 128KB@.  Note that this may only work with the GNU linker.
11455
11456 @cindex aliasing of parameters
11457 @cindex parameters, aliased
11458 @item -fargument-alias
11459 @itemx -fargument-noalias
11460 @itemx -fargument-noalias-global
11461 @opindex fargument-alias
11462 @opindex fargument-noalias
11463 @opindex fargument-noalias-global
11464 Specify the possible relationships among parameters and between
11465 parameters and global data.
11466
11467 @option{-fargument-alias} specifies that arguments (parameters) may
11468 alias each other and may alias global storage.@*
11469 @option{-fargument-noalias} specifies that arguments do not alias
11470 each other, but may alias global storage.@*
11471 @option{-fargument-noalias-global} specifies that arguments do not
11472 alias each other and do not alias global storage.
11473
11474 Each language will automatically use whatever option is required by
11475 the language standard.  You should not need to use these options yourself.
11476
11477 @item -fleading-underscore
11478 @opindex fleading-underscore
11479 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11480 change the way C symbols are represented in the object file.  One use
11481 is to help link with legacy assembly code.
11482
11483 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11484 generate code that is not binary compatible with code generated without that
11485 switch.  Use it to conform to a non-default application binary interface.
11486 Not all targets provide complete support for this switch.
11487
11488 @item -ftls-model=@var{model}
11489 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11490 The @var{model} argument should be one of @code{global-dynamic},
11491 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11492
11493 The default without @option{-fpic} is @code{initial-exec}; with
11494 @option{-fpic} the default is @code{global-dynamic}.
11495 @end table
11496
11497 @c man end
11498
11499 @node Environment Variables
11500 @section Environment Variables Affecting GCC
11501 @cindex environment variables
11502
11503 @c man begin ENVIRONMENT
11504 This section describes several environment variables that affect how GCC
11505 operates.  Some of them work by specifying directories or prefixes to use
11506 when searching for various kinds of files.  Some are used to specify other
11507 aspects of the compilation environment.
11508
11509 Note that you can also specify places to search using options such as
11510 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11511 take precedence over places specified using environment variables, which
11512 in turn take precedence over those specified by the configuration of GCC@.
11513 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11514 GNU Compiler Collection (GCC) Internals}.
11515
11516 @table @env
11517 @item LANG
11518 @itemx LC_CTYPE
11519 @c @itemx LC_COLLATE
11520 @itemx LC_MESSAGES
11521 @c @itemx LC_MONETARY
11522 @c @itemx LC_NUMERIC
11523 @c @itemx LC_TIME
11524 @itemx LC_ALL
11525 @findex LANG
11526 @findex LC_CTYPE
11527 @c @findex LC_COLLATE
11528 @findex LC_MESSAGES
11529 @c @findex LC_MONETARY
11530 @c @findex LC_NUMERIC
11531 @c @findex LC_TIME
11532 @findex LC_ALL
11533 @cindex locale
11534 These environment variables control the way that GCC uses
11535 localization information that allow GCC to work with different
11536 national conventions.  GCC inspects the locale categories
11537 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11538 so.  These locale categories can be set to any value supported by your
11539 installation.  A typical value is @samp{en_UK} for English in the United
11540 Kingdom.
11541
11542 The @env{LC_CTYPE} environment variable specifies character
11543 classification.  GCC uses it to determine the character boundaries in
11544 a string; this is needed for some multibyte encodings that contain quote
11545 and escape characters that would otherwise be interpreted as a string
11546 end or escape.
11547
11548 The @env{LC_MESSAGES} environment variable specifies the language to
11549 use in diagnostic messages.
11550
11551 If the @env{LC_ALL} environment variable is set, it overrides the value
11552 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11553 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11554 environment variable.  If none of these variables are set, GCC
11555 defaults to traditional C English behavior.
11556
11557 @item TMPDIR
11558 @findex TMPDIR
11559 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11560 files.  GCC uses temporary files to hold the output of one stage of
11561 compilation which is to be used as input to the next stage: for example,
11562 the output of the preprocessor, which is the input to the compiler
11563 proper.
11564
11565 @item GCC_EXEC_PREFIX
11566 @findex GCC_EXEC_PREFIX
11567 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11568 names of the subprograms executed by the compiler.  No slash is added
11569 when this prefix is combined with the name of a subprogram, but you can
11570 specify a prefix that ends with a slash if you wish.
11571
11572 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11573 an appropriate prefix to use based on the pathname it was invoked with.
11574
11575 If GCC cannot find the subprogram using the specified prefix, it
11576 tries looking in the usual places for the subprogram.
11577
11578 The default value of @env{GCC_EXEC_PREFIX} is
11579 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11580 of @code{prefix} when you ran the @file{configure} script.
11581
11582 Other prefixes specified with @option{-B} take precedence over this prefix.
11583
11584 This prefix is also used for finding files such as @file{crt0.o} that are
11585 used for linking.
11586
11587 In addition, the prefix is used in an unusual way in finding the
11588 directories to search for header files.  For each of the standard
11589 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11590 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11591 replacing that beginning with the specified prefix to produce an
11592 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11593 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11594 These alternate directories are searched first; the standard directories
11595 come next.
11596
11597 @item COMPILER_PATH
11598 @findex COMPILER_PATH
11599 The value of @env{COMPILER_PATH} is a colon-separated list of
11600 directories, much like @env{PATH}.  GCC tries the directories thus
11601 specified when searching for subprograms, if it can't find the
11602 subprograms using @env{GCC_EXEC_PREFIX}.
11603
11604 @item LIBRARY_PATH
11605 @findex LIBRARY_PATH
11606 The value of @env{LIBRARY_PATH} is a colon-separated list of
11607 directories, much like @env{PATH}.  When configured as a native compiler,
11608 GCC tries the directories thus specified when searching for special
11609 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11610 using GCC also uses these directories when searching for ordinary
11611 libraries for the @option{-l} option (but directories specified with
11612 @option{-L} come first).
11613
11614 @item LANG
11615 @findex LANG
11616 @cindex locale definition
11617 This variable is used to pass locale information to the compiler.  One way in
11618 which this information is used is to determine the character set to be used
11619 when character literals, string literals and comments are parsed in C and C++.
11620 When the compiler is configured to allow multibyte characters,
11621 the following values for @env{LANG} are recognized:
11622
11623 @table @samp
11624 @item C-JIS
11625 Recognize JIS characters.
11626 @item C-SJIS
11627 Recognize SJIS characters.
11628 @item C-EUCJP
11629 Recognize EUCJP characters.
11630 @end table
11631
11632 If @env{LANG} is not defined, or if it has some other value, then the
11633 compiler will use mblen and mbtowc as defined by the default locale to
11634 recognize and translate multibyte characters.
11635 @end table
11636
11637 @noindent
11638 Some additional environments variables affect the behavior of the
11639 preprocessor.
11640
11641 @include cppenv.texi
11642
11643 @c man end
11644
11645 @node Precompiled Headers
11646 @section Using Precompiled Headers
11647 @cindex precompiled headers
11648 @cindex speed of compilation
11649
11650 Often large projects have many header files that are included in every
11651 source file.  The time the compiler takes to process these header files
11652 over and over again can account for nearly all of the time required to
11653 build the project.  To make builds faster, GCC allows users to
11654 `precompile' a header file; then, if builds can use the precompiled
11655 header file they will be much faster.
11656
11657 To create a precompiled header file, simply compile it as you would any
11658 other file, if necessary using the @option{-x} option to make the driver
11659 treat it as a C or C++ header file.  You will probably want to use a
11660 tool like @command{make} to keep the precompiled header up-to-date when
11661 the headers it contains change.
11662
11663 A precompiled header file will be searched for when @code{#include} is
11664 seen in the compilation.  As it searches for the included file
11665 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11666 compiler looks for a precompiled header in each directory just before it
11667 looks for the include file in that directory.  The name searched for is
11668 the name specified in the @code{#include} with @samp{.gch} appended.  If
11669 the precompiled header file can't be used, it is ignored.
11670
11671 For instance, if you have @code{#include "all.h"}, and you have
11672 @file{all.h.gch} in the same directory as @file{all.h}, then the
11673 precompiled header file will be used if possible, and the original
11674 header will be used otherwise.
11675
11676 Alternatively, you might decide to put the precompiled header file in a
11677 directory and use @option{-I} to ensure that directory is searched
11678 before (or instead of) the directory containing the original header.
11679 Then, if you want to check that the precompiled header file is always
11680 used, you can put a file of the same name as the original header in this
11681 directory containing an @code{#error} command.
11682
11683 This also works with @option{-include}.  So yet another way to use
11684 precompiled headers, good for projects not designed with precompiled
11685 header files in mind, is to simply take most of the header files used by
11686 a project, include them from another header file, precompile that header
11687 file, and @option{-include} the precompiled header.  If the header files
11688 have guards against multiple inclusion, they will be skipped because
11689 they've already been included (in the precompiled header).
11690
11691 If you need to precompile the same header file for different
11692 languages, targets, or compiler options, you can instead make a
11693 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11694 header in the directory.  (It doesn't matter what you call the files
11695 in the directory, every precompiled header in the directory will be
11696 considered.)  The first precompiled header encountered in the
11697 directory that is valid for this compilation will be used; they're
11698 searched in no particular order.
11699
11700 There are many other possibilities, limited only by your imagination,
11701 good sense, and the constraints of your build system.
11702
11703 A precompiled header file can be used only when these conditions apply:
11704
11705 @itemize
11706 @item
11707 Only one precompiled header can be used in a particular compilation.
11708 @item
11709 A precompiled header can't be used once the first C token is seen.  You
11710 can have preprocessor directives before a precompiled header; you can
11711 even include a precompiled header from inside another header, so long as
11712 there are no C tokens before the @code{#include}.
11713 @item
11714 The precompiled header file must be produced for the same language as
11715 the current compilation.  You can't use a C precompiled header for a C++
11716 compilation.
11717 @item
11718 The precompiled header file must be produced by the same compiler
11719 version and configuration as the current compilation is using.
11720 The easiest way to guarantee this is to use the same compiler binary
11721 for creating and using precompiled headers.
11722 @item
11723 Any macros defined before the precompiled header (including with
11724 @option{-D}) must either be defined in the same way as when the
11725 precompiled header was generated, or must not affect the precompiled
11726 header, which usually means that the they don't appear in the
11727 precompiled header at all.
11728 @item
11729 Certain command-line options must be defined in the same way as when the
11730 precompiled header was generated.  At present, it's not clear which
11731 options are safe to change and which are not; the safest choice is to
11732 use exactly the same options when generating and using the precompiled
11733 header.
11734 @end itemize
11735
11736 For all of these but the last, the compiler will automatically ignore
11737 the precompiled header if the conditions aren't met.  For the last item,
11738 some option changes will cause the precompiled header to be rejected,
11739 but not all incompatible option combinations have yet been found.  If
11740 you find a new incompatible combination, please consider filing a bug
11741 report, see @ref{Bugs}.
11742
11743 @node Running Protoize
11744 @section Running Protoize
11745
11746 The program @code{protoize} is an optional part of GCC@.  You can use
11747 it to add prototypes to a program, thus converting the program to ISO
11748 C in one respect.  The companion program @code{unprotoize} does the
11749 reverse: it removes argument types from any prototypes that are found.
11750
11751 When you run these programs, you must specify a set of source files as
11752 command line arguments.  The conversion programs start out by compiling
11753 these files to see what functions they define.  The information gathered
11754 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11755
11756 After scanning comes actual conversion.  The specified files are all
11757 eligible to be converted; any files they include (whether sources or
11758 just headers) are eligible as well.
11759
11760 But not all the eligible files are converted.  By default,
11761 @code{protoize} and @code{unprotoize} convert only source and header
11762 files in the current directory.  You can specify additional directories
11763 whose files should be converted with the @option{-d @var{directory}}
11764 option.  You can also specify particular files to exclude with the
11765 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11766 directory name matches one of the specified directory names, and its
11767 name within the directory has not been excluded.
11768
11769 Basic conversion with @code{protoize} consists of rewriting most
11770 function definitions and function declarations to specify the types of
11771 the arguments.  The only ones not rewritten are those for varargs
11772 functions.
11773
11774 @code{protoize} optionally inserts prototype declarations at the
11775 beginning of the source file, to make them available for any calls that
11776 precede the function's definition.  Or it can insert prototype
11777 declarations with block scope in the blocks where undeclared functions
11778 are called.
11779
11780 Basic conversion with @code{unprotoize} consists of rewriting most
11781 function declarations to remove any argument types, and rewriting
11782 function definitions to the old-style pre-ISO form.
11783
11784 Both conversion programs print a warning for any function declaration or
11785 definition that they can't convert.  You can suppress these warnings
11786 with @option{-q}.
11787
11788 The output from @code{protoize} or @code{unprotoize} replaces the
11789 original source file.  The original file is renamed to a name ending
11790 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11791 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11792 for DOS) file already exists, then the source file is simply discarded.
11793
11794 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11795 scan the program and collect information about the functions it uses.
11796 So neither of these programs will work until GCC is installed.
11797
11798 Here is a table of the options you can use with @code{protoize} and
11799 @code{unprotoize}.  Each option works with both programs unless
11800 otherwise stated.
11801
11802 @table @code
11803 @item -B @var{directory}
11804 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11805 usual directory (normally @file{/usr/local/lib}).  This file contains
11806 prototype information about standard system functions.  This option
11807 applies only to @code{protoize}.
11808
11809 @item -c @var{compilation-options}
11810 Use @var{compilation-options} as the options when running @command{gcc} to
11811 produce the @samp{.X} files.  The special option @option{-aux-info} is
11812 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11813
11814 Note that the compilation options must be given as a single argument to
11815 @code{protoize} or @code{unprotoize}.  If you want to specify several
11816 @command{gcc} options, you must quote the entire set of compilation options
11817 to make them a single word in the shell.
11818
11819 There are certain @command{gcc} arguments that you cannot use, because they
11820 would produce the wrong kind of output.  These include @option{-g},
11821 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11822 the @var{compilation-options}, they are ignored.
11823
11824 @item -C
11825 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11826 systems) instead of @samp{.c}.  This is convenient if you are converting
11827 a C program to C++.  This option applies only to @code{protoize}.
11828
11829 @item -g
11830 Add explicit global declarations.  This means inserting explicit
11831 declarations at the beginning of each source file for each function
11832 that is called in the file and was not declared.  These declarations
11833 precede the first function definition that contains a call to an
11834 undeclared function.  This option applies only to @code{protoize}.
11835
11836 @item -i @var{string}
11837 Indent old-style parameter declarations with the string @var{string}.
11838 This option applies only to @code{protoize}.
11839
11840 @code{unprotoize} converts prototyped function definitions to old-style
11841 function definitions, where the arguments are declared between the
11842 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11843 uses five spaces as the indentation.  If you want to indent with just
11844 one space instead, use @option{-i " "}.
11845
11846 @item -k
11847 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11848 is finished.
11849
11850 @item -l
11851 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11852 a prototype declaration for each function in each block which calls the
11853 function without any declaration.  This option applies only to
11854 @code{protoize}.
11855
11856 @item -n
11857 Make no real changes.  This mode just prints information about the conversions
11858 that would have been done without @option{-n}.
11859
11860 @item -N
11861 Make no @samp{.save} files.  The original files are simply deleted.
11862 Use this option with caution.
11863
11864 @item -p @var{program}
11865 Use the program @var{program} as the compiler.  Normally, the name
11866 @file{gcc} is used.
11867
11868 @item -q
11869 Work quietly.  Most warnings are suppressed.
11870
11871 @item -v
11872 Print the version number, just like @option{-v} for @command{gcc}.
11873 @end table
11874
11875 If you need special compiler options to compile one of your program's
11876 source files, then you should generate that file's @samp{.X} file
11877 specially, by running @command{gcc} on that source file with the
11878 appropriate options and the option @option{-aux-info}.  Then run
11879 @code{protoize} on the entire set of files.  @code{protoize} will use
11880 the existing @samp{.X} file because it is newer than the source file.
11881 For example:
11882
11883 @example
11884 gcc -Dfoo=bar file1.c -aux-info file1.X
11885 protoize *.c
11886 @end example
11887
11888 @noindent
11889 You need to include the special files along with the rest in the
11890 @code{protoize} command, even though their @samp{.X} files already
11891 exist, because otherwise they won't get converted.
11892
11893 @xref{Protoize Caveats}, for more information on how to use
11894 @code{protoize} successfully.