2003-07-31 Andreas Tobler <a.tobler@schweiz.ch>
[official-gcc.git] / gcc / doc / invoke.texi
blobada9e3d7d06100ea948c73e8bfcaa2e16c19f404
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.
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.
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.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
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{}
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
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
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.
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.
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.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
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}}.
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.
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.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
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
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
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}
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}
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}
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
198 -Wno-protocol  -Wselector -Wundeclared-selector}
200 @item Language Independent Options
201 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
202 @gccoptlist{-fmessage-length=@var{n}  @gol
203 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
205 @item Warning Options
206 @xref{Warning Options,,Options to Request or Suppress Warnings}.
207 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
208 -w  -Wextra  -Wall  -Waggregate-return @gol
209 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
210 -Wconversion  -Wno-deprecated-declarations @gol
211 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
212 -Wfloat-equal  -Wformat  -Wformat=2 @gol
213 -Wformat-nonliteral  -Wformat-security @gol
214 -Wimplicit  -Wimplicit-int  @gol
215 -Wimplicit-function-declaration @gol
216 -Werror-implicit-function-declaration @gol
217 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
218 -Wno-invalid-offsetof @gol
219 -Wlarger-than-@var{len}  -Wlong-long @gol
220 -Wmain  -Wmissing-braces @gol
221 -Wmissing-format-attribute  -Wmissing-noreturn @gol
222 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
223 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
224 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
225 -Wreturn-type  -Wsequence-point  -Wshadow @gol
226 -Wsign-compare  -Wstrict-aliasing @gol
227 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
228 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
229 -Wunknown-pragmas  -Wunreachable-code @gol
230 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
231 -Wunused-value  -Wunused-variable  -Wwrite-strings}
233 @item C-only Warning Options
234 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
235 -Wmissing-prototypes  -Wnested-externs @gol
236 -Wstrict-prototypes  -Wtraditional @gol
237 -Wdeclaration-after-statement}
239 @item Debugging Options
240 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
241 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
242 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
243 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
244 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
245 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
246 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
247 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
248 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
249 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
250 -ftest-coverage  -ftime-report @gol
251 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
252 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
253 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
254 -print-multi-directory  -print-multi-lib @gol
255 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
256 -save-temps  -time}
258 @item Optimization Options
259 @xref{Optimize Options,,Options that Control Optimization}.
260 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
261 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
262 -fbranch-probabilities -fprofile-values -fbranch-target-load-optimize @gol
263 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
264 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
265 -fdelayed-branch  -fdelete-null-pointer-checks @gol
266 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
267 -fforce-addr  -fforce-mem  -ffunction-sections @gol
268 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
269 -fif-conversion  -fif-conversion2 @gol
270 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
271 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
272 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
273 -fno-default-inline  -fno-defer-pop @gol
274 -fno-function-cse  -fno-guess-branch-probability @gol
275 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
276 -funsafe-math-optimizations  -ffinite-math-only @gol
277 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
278 -fomit-frame-pointer  -foptimize-register-move @gol
279 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
280 -freduce-all-givs  -fregmove  -frename-registers @gol
281 -freorder-blocks  -freorder-functions @gol
282 -frerun-cse-after-loop  -frerun-loop-opt @gol
283 -fschedule-insns  -fschedule-insns2 @gol
284 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
285 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
286 -fsched2-use-traces  -fsignaling-nans @gol
287 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
288 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
289 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
290 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
291 --param @var{name}=@var{value}
292 -O  -O0  -O1  -O2  -O3  -Os}
294 @item Preprocessor Options
295 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
296 @gccoptlist{-A@var{question}=@var{answer} @gol
297 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
298 -C  -dD  -dI  -dM  -dN @gol
299 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
300 -idirafter @var{dir} @gol
301 -include @var{file}  -imacros @var{file} @gol
302 -iprefix @var{file}  -iwithprefix @var{dir} @gol
303 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
304 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
305 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
306 -Xpreprocessor @var{option}}
308 @item Assembler Option
309 @xref{Assembler Options,,Passing Options to the Assembler}.
310 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
312 @item Linker Options
313 @xref{Link Options,,Options for Linking}.
314 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
315 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
316 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
317 -Wl,@var{option}  -Xlinker @var{option} @gol
318 -u @var{symbol}}
320 @item Directory Options
321 @xref{Directory Options,,Options for Directory Search}.
322 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
324 @item Target Options
325 @c I wrote this xref this way to avoid overfull hbox. -- rms
326 @xref{Target Options}.
327 @gccoptlist{-V @var{version}  -b @var{machine}}
329 @item Machine Dependent Options
330 @xref{Submodel Options,,Hardware Models and Configurations}.
332 @emph{M680x0 Options}
333 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
334 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
335 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
336 -malign-int  -mstrict-align}
338 @emph{M68hc1x Options}
339 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
340 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
341 -msoft-reg-count=@var{count}}
343 @emph{VAX Options}
344 @gccoptlist{-mg  -mgnu  -munix}
346 @emph{SPARC Options}
347 @gccoptlist{-mcpu=@var{cpu-type} @gol
348 -mtune=@var{cpu-type} @gol
349 -mcmodel=@var{code-model} @gol
350 -m32  -m64 @gol
351 -mapp-regs  -mbroken-saverestore  -mcypress @gol
352 -mfaster-structs  -mflat @gol
353 -mfpu  -mhard-float  -mhard-quad-float @gol
354 -mimpure-text  -mlittle-endian  -mlive-g0  -mno-app-regs @gol
355 -mno-faster-structs  -mno-flat  -mno-fpu @gol
356 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
357 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
358 -msupersparc  -munaligned-doubles  -mv8}
360 @emph{ARM Options}
361 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
362 -mapcs-26  -mapcs-32 @gol
363 -mapcs-stack-check  -mno-apcs-stack-check @gol
364 -mapcs-float  -mno-apcs-float @gol
365 -mapcs-reentrant  -mno-apcs-reentrant @gol
366 -msched-prolog  -mno-sched-prolog @gol
367 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
368 -malignment-traps  -mno-alignment-traps @gol
369 -msoft-float  -mhard-float  -mfpe @gol
370 -mthumb-interwork  -mno-thumb-interwork @gol
371 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
372 -mstructure-size-boundary=@var{n} @gol
373 -mabort-on-noreturn @gol
374 -mlong-calls  -mno-long-calls @gol
375 -msingle-pic-base  -mno-single-pic-base @gol
376 -mpic-register=@var{reg} @gol
377 -mnop-fun-dllimport @gol
378 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
379 -mpoke-function-name @gol
380 -mthumb  -marm @gol
381 -mtpcs-frame  -mtpcs-leaf-frame @gol
382 -mcaller-super-interworking  -mcallee-super-interworking}
384 @emph{MN10200 Options}
385 @gccoptlist{-mrelax}
387 @emph{MN10300 Options}
388 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
389 -mam33  -mno-am33 @gol
390 -mam33-2  -mno-am33-2 @gol
391 -mno-crt0  -mrelax}
393 @emph{M32R/D Options}
394 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
395 -msdata=@var{sdata-type}  -G @var{num}}
397 @emph{M88K Options}
398 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
399 -mcheck-zero-division  -mhandle-large-shift @gol
400 -midentify-revision  -mno-check-zero-division @gol
401 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
402 -mno-optimize-arg-area  -mno-serialize-volatile @gol
403 -mno-underscores  -mocs-debug-info @gol
404 -mocs-frame-position  -moptimize-arg-area @gol
405 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
406 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
407 -mversion-03.00  -mwarn-passed-structs}
409 @emph{RS/6000 and PowerPC Options}
410 @gccoptlist{-mcpu=@var{cpu-type} @gol
411 -mtune=@var{cpu-type} @gol
412 -mpower  -mno-power  -mpower2  -mno-power2 @gol
413 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
414 -maltivec  -mno-altivec @gol
415 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
416 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
417 -mnew-mnemonics  -mold-mnemonics @gol
418 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
419 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
420 -malign-power  -malign-natural @gol
421 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
422 -mstring  -mno-string  -mupdate  -mno-update @gol
423 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
424 -mstrict-align  -mno-strict-align  -mrelocatable @gol
425 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
426 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
427 -mdynamic-no-pic @gol
428 -mcall-sysv  -mcall-netbsd @gol
429 -maix-struct-return  -msvr4-struct-return @gol
430 -mabi=altivec  -mabi=no-altivec @gol
431 -mabi=spe  -mabi=no-spe @gol
432 -misel=yes  -misel=no @gol
433 -mspe=yes  -mspe=no @gol
434 -mfloat-gprs=yes  -mfloat-gprs=no @gol
435 -mprototype  -mno-prototype @gol
436 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
437 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
439 @emph{Darwin Options}
440 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
441 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
442 -client_name  -compatibility_version  -current_version @gol
443 -dependency-file  -dylib_file  -dylinker_install_name @gol
444 -dynamic  -dynamiclib  -exported_symbols_list @gol
445 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
446 -force_flat_namespace  -headerpad_max_install_names @gol
447 -image_base  -init  -install_name  -keep_private_externs @gol
448 -multi_module  -multiply_defined  -multiply_defined_unused @gol
449 -noall_load  -nomultidefs  -noprebind  -noseglinkedit @gol
450 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
451 -private_bundle  -read_only_relocs  -sectalign @gol
452 -sectobjectsymbols  -whyload  -seg1addr @gol
453 -sectcreate  -sectobjectsymbols  -sectorder @gol
454 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
455 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
456 -single_module  -static  -sub_library  -sub_umbrella @gol
457 -twolevel_namespace  -umbrella  -undefined @gol
458 -unexported_symbols_list  -weak_reference_mismatches @gol
459 -whatsloaded}
461 @emph{RT Options}
462 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
463 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
464 -mminimum-fp-blocks  -mnohc-struct-return}
466 @emph{MIPS Options}
467 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
468 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
469 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
470 -mgas  -mgp32  -mgp64  -mhard-float  -mint64  -mips1 @gol
471 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
472 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
473 -mmips-as  -mmips-tfile  -mno-abicalls @gol
474 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
475 -mno-embedded-pic  -mno-long-calls @gol
476 -mno-memcpy  -mno-mips-tfile  -mno-rnames @gol
477 -mrnames  -msoft-float @gol
478 -m4650  -msingle-float  -mmad @gol
479 -EL  -EB  -G @var{num}  -nocpp @gol
480 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
481 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
482 -mbranch-likely -mno-branch-likely}
484 @emph{i386 and x86-64 Options}
485 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
486 -mfpmath=@var{unit} @gol
487 -masm=@var{dialect}  -mno-fancy-math-387 @gol
488 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
489 -mno-wide-multiply  -mrtd  -malign-double @gol
490 -mpreferred-stack-boundary=@var{num} @gol
491 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
492 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
493 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
494 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
495 -mno-red-zone -mno-tls-direct-seg-refs @gol
496 -mcmodel=@var{code-model} @gol
497 -m32  -m64}
499 @emph{HPPA Options}
500 @gccoptlist{-march=@var{architecture-type} @gol
501 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
502 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
503 -mjump-in-delay -mlinker-opt -mlong-calls @gol
504 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
505 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
506 -mno-jump-in-delay  -mno-long-load-store @gol
507 -mno-portable-runtime  -mno-soft-float @gol
508 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
509 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
510 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
511 -nolibdld  -static  -threads}
513 @emph{Intel 960 Options}
514 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
515 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
516 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
517 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
518 -mno-complex-addr  -mno-leaf-procedures @gol
519 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
520 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
521 -mtail-call}
523 @emph{DEC Alpha Options}
524 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
525 -mieee  -mieee-with-inexact  -mieee-conformant @gol
526 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
527 -mtrap-precision=@var{mode}  -mbuild-constants @gol
528 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
529 -mbwx  -mmax  -mfix  -mcix @gol
530 -mfloat-vax  -mfloat-ieee @gol
531 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
532 -msmall-text  -mlarge-text @gol
533 -mmemory-latency=@var{time}}
535 @emph{DEC Alpha/VMS Options}
536 @gccoptlist{-mvms-return-codes}
538 @emph{H8/300 Options}
539 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
541 @emph{SH Options}
542 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
543 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
544 -m5-64media  -m5-64media-nofpu @gol
545 -m5-32media  -m5-32media-nofpu @gol
546 -m5-compact  -m5-compact-nofpu @gol
547 -mb  -ml  -mdalign  -mrelax @gol
548 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
549 -mieee  -misize  -mpadstruct  -mspace @gol
550 -mprefergot  -musermode}
552 @emph{System V Options}
553 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
555 @emph{ARC Options}
556 @gccoptlist{-EB  -EL @gol
557 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
558 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
560 @emph{TMS320C3x/C4x Options}
561 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
562 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
563 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
564 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
566 @emph{V850 Options}
567 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
568 -mprolog-function  -mno-prolog-function  -mspace @gol
569 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
570 -mapp-regs  -mno-app-regs @gol
571 -mdisable-callt  -mno-disable-callt @gol
572 -mv850e @gol
573 -mv850  -mbig-switch}
575 @emph{NS32K Options}
576 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
577 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
578 -mregparam  -mnoregparam  -msb  -mnosb @gol
579 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
581 @emph{AVR Options}
582 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
583 -mcall-prologues  -mno-tablejump  -mtiny-stack}
585 @emph{MCore Options}
586 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
587 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
588 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
589 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
590 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
592 @emph{MMIX Options}
593 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
594 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
595 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
596 -mno-base-addresses  -msingle-exit  -mno-single-exit}
598 @emph{IA-64 Options}
599 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
600 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
601 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
602 -minline-float-divide-max-throughput @gol
603 -minline-int-divide-min-latency @gol
604 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
605 -mfixed-range=@var{register-range}}
607 @emph{D30V Options}
608 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
609 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
611 @emph{S/390 and zSeries Options}
612 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
613 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
614 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
615 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
617 @emph{CRIS Options}
618 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
619 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
620 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
621 -mstack-align  -mdata-align  -mconst-align @gol
622 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
623 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
625 @emph{PDP-11 Options}
626 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
627 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
628 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
629 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
630 -mbranch-expensive  -mbranch-cheap @gol
631 -msplit  -mno-split  -munix-asm  -mdec-asm}
633 @emph{Xstormy16 Options}
634 @gccoptlist{-msim}
636 @emph{Xtensa Options}
637 @gccoptlist{-mbig-endian  -mlittle-endian @gol
638 -mdensity  -mno-density @gol
639 -mconst16 -mno-const16 @gol
640 -mabs -mno-abs @gol
641 -maddx -mno-addx @gol
642 -mmac16  -mno-mac16 @gol
643 -mmul16  -mno-mul16 @gol
644 -mmul32  -mno-mul32 @gol
645 -mnsa  -mno-nsa @gol
646 -mminmax  -mno-minmax @gol
647 -msext  -mno-sext @gol
648 -mbooleans  -mno-booleans @gol
649 -mhard-float  -msoft-float @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}
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}}
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
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
710 @node Overall Options
711 @section Options Controlling the Kind of Output
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.
721 @cindex file name suffix
722 For any given input file, the file name suffix determines what kind of
723 compilation is done:
725 @table @gcctabopt
726 @item @var{file}.c
727 C source code which must be preprocessed.
729 @item @var{file}.i
730 C source code which should not be preprocessed.
732 @item @var{file}.ii
733 C++ source code which should not be preprocessed.
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.
739 @item @var{file}.mi
740 Objective-C source code which should not be preprocessed.
742 @item @var{file}.h
743 C or C++ header file to be turned into a precompiled header.
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@.
756 @item @var{file}.hh
757 @itemx @var{file}.H
758 C++ header file to be turned into a precompiled header.
760 @item @var{file}.f
761 @itemx @var{file}.for
762 @itemx @var{file}.FOR
763 Fortran source code which should not be preprocessed.
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).
771 @item @var{file}.r
772 Fortran source code which must be preprocessed with a RATFOR
773 preprocessor (not included with GCC)@.
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.
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
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}.
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}.
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
801 @item @var{file}.s
802 Assembler code.
804 @item @var{file}.S
805 Assembler code which must be preprocessed.
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
812 @opindex x
813 You can specify the input language explicitly with the @option{-x} option:
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
827 f77  f77-cpp-input  ratfor
828 java
829 treelang
830 @end example
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).
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
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.
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.
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}.
862 Unrecognized input files, not requiring compilation or assembly, are
863 ignored.
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.
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}.
874 Input files that don't require compilation are ignored.
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.
882 Input files which don't require preprocessing are ignored.
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.
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.
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.
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.
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.
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.
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.
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.
934 @item --version
935 @opindex version
936 Display the version number and copyrights of the invoked GCC.
937 @end table
939 @node Invoking G++
940 @section Compiling C++ Programs
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}).
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++}.
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.
974 @node C Dialect Options
975 @section Options Controlling C Dialect
976 @cindex dialect options
977 @cindex language dialect options
978 @cindex options, dialect
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:
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++.
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.
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}.
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}.
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.
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.
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
1030 @table @samp
1031 @item c89
1032 @itemx iso9899:1990
1033 ISO C90 (same as @option{-ansi}).
1035 @item iso9899:199409
1036 ISO C90 as modified in amendment 1.
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.
1046 @item gnu89
1047 Default, ISO C90 plus GNU extensions (including some C99 features).
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.
1054 @item c++98
1055 The 1998 ISO C++ standard plus amendments.
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
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.
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.
1072 @xref{Standards,,Language Standards Supported by GCC}, for details of
1073 these standard versions.
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@.
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.
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}.
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.
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.
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.
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:
1133 @smallexample
1134 #define abs(n)          __builtin_abs ((n))
1135 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1136 @end smallexample
1138 @item -fhosted
1139 @opindex fhosted
1140 @cindex hosted environment
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}.
1148 @item -ffreestanding
1149 @opindex ffreestanding
1150 @cindex hosted environment
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}.
1158 @xref{Standards,,Language Standards Supported by GCC}, for details of
1159 freestanding and hosted environments.
1161 @item -fms-extensions
1162 @opindex fms-extensions
1163 Accept some non-standard constructs used in Microsoft header files.
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}.
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)
1178 The semantics of this option will change if "cc1", "cc1plus", and
1179 "cc1obj" are merged.
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.
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++.
1198 @item -funsigned-char
1199 @opindex funsigned-char
1200 Let the type @code{char} be unsigned, like @code{unsigned char}.
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.
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.
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.
1217 @item -fsigned-char
1218 @opindex fsigned-char
1219 Let the type @code{char} be signed, like @code{signed char}.
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}.
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.
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.
1244 Writing into string constants is a very bad idea; ``constants'' should
1245 be constant.
1246 @end table
1248 @node C++ Dialect Options
1249 @section Options Controlling C++ Dialect
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:
1259 @example
1260 g++ -g -frepo -O -c firstClass.C
1261 @end example
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@.
1268 Here is a list of options that are @emph{only} for compiling C++ programs:
1270 @table @gcctabopt
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.
1280 The default is version 1.
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.
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)}.
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.
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.
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}.
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 *}.
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.
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.
1337 @item -fexternal-templates
1338 @opindex fexternal-templates
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.
1345 This option is deprecated.
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.
1353 This option is deprecated.
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++.
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.
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}.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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}.
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++.
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
1474 In addition, these optimization, warning, and code generation options
1475 have meanings only for C++ programs:
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.
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.
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.
1498 The known incompatibilities at this point include:
1500 @itemize @bullet
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:
1506 @smallexample
1507 struct A @{ virtual void f(); int f1 : 1; @};
1508 struct B : public A @{ int f2 : 1; @};
1509 @end smallexample
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.
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:
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
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.
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:
1540 @smallexample
1541 union U @{ int i : 4096; @};
1542 @end smallexample
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}.
1548 @item
1549 Empty classes can be placed at incorrect offsets.  For example:
1551 @smallexample
1552 struct A @{@};
1554 struct B @{
1555   A a;
1556   virtual void f ();
1559 struct C : public B, public A @{@};
1560 @end smallexample
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.
1567 @item
1568 Names of template functions whose types involve @code{typename} or
1569 template template parameters can be mangled incorrectly.
1571 @smallexample
1572 template <typename Q>
1573 void f(typename Q::X) @{@}
1575 template <template <typename> class Q>
1576 void f(typename Q<int>::X) @{@}
1577 @end smallexample
1579 @noindent
1580 Instantiations of these templates may be mangled incorrectly.
1582 @end itemize
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.
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}.
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:
1603 @smallexample
1604 struct A @{
1605   int i;
1606   int j;
1607   A(): j (0), i (1) @{ @}
1609 @end smallexample
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
1616 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
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:
1624 @itemize @bullet
1625 @item
1626 Item 11:  Define a copy constructor and an assignment operator for classes
1627 with dynamically allocated memory.
1629 @item
1630 Item 12:  Prefer initialization to assignment in constructors.
1632 @item
1633 Item 14:  Make destructors virtual in base classes.
1635 @item
1636 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1638 @item
1639 Item 23:  Don't try to return a reference when you must return an object.
1641 @end itemize
1643 Also warn about violations of the following style guidelines from 
1644 Scott Meyers' @cite{More Effective C++} book:
1646 @itemize @bullet
1647 @item
1648 Item 6:  Distinguish between prefix and postfix forms of increment and
1649 decrement operators.
1651 @item
1652 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1654 @end itemize
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.
1660 @item -Wno-deprecated @r{(C++ only)}
1661 @opindex Wno-deprecated
1662 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
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.
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.
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:
1694 @smallexample
1695 struct A @{
1696   virtual void f();
1699 struct B: public A @{
1700   void f(int);
1702 @end smallexample
1704 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1705 like:
1707 @smallexample
1708 B* b;
1709 b->f();
1710 @end smallexample
1712 will fail to compile.
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.
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.
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:
1733 @smallexample
1734 struct A @{
1735   operator int ();
1736   A& operator = (int);
1739 main ()
1741   A a,b;
1742   a = b;
1744 @end smallexample
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
1750 @node Objective-C Dialect Options
1751 @section Options Controlling Objective-C Dialect
1753 @cindex compiler options, Objective-C
1754 @cindex Objective-C options, command line
1755 @cindex options, Objective-C
1756 This section describes the command-line options that are only meaningful
1757 for Objective-C programs, but you can also use most of the GNU compiler
1758 options regardless of what language your program is in.  For example,
1759 you might compile a file @code{some_class.m} like this:
1761 @example
1762 gcc -g -fgnu-runtime -O -c some_class.m
1763 @end example
1765 @noindent
1766 In this example, @option{-fgnu-runtime} is an option meant only for
1767 Objective-C programs; you can use the other options with any language
1768 supported by GCC@.
1770 Here is a list of options that are @emph{only} for compiling Objective-C
1771 programs:
1773 @table @gcctabopt
1774 @item -fconstant-string-class=@var{class-name}
1775 @opindex fconstant-string-class
1776 Use @var{class-name} as the name of the class to instantiate for each
1777 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1778 class name is @code{NXConstantString}.
1780 @item -fgnu-runtime
1781 @opindex fgnu-runtime
1782 Generate object code compatible with the standard GNU Objective-C
1783 runtime.  This is the default for most types of systems.
1785 @item -fnext-runtime
1786 @opindex fnext-runtime
1787 Generate output compatible with the NeXT runtime.  This is the default
1788 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1789 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1790 used.
1792 @item -gen-decls
1793 @opindex gen-decls
1794 Dump interface declarations for all classes seen in the source file to a
1795 file named @file{@var{sourcename}.decl}.
1797 @item -Wno-protocol
1798 @opindex Wno-protocol
1799 If a class is declared to implement a protocol, a warning is issued for
1800 every method in the protocol that is not implemented by the class.  The
1801 default behavior is to issue a warning for every method not explicitly
1802 implemented in the class, even if a method implementation is inherited
1803 from the superclass.  If you use the @code{-Wno-protocol} option, then
1804 methods inherited from the superclass are considered to be implemented,
1805 and no warning is issued for them.
1807 @item -Wselector
1808 @opindex Wselector
1809 Warn if multiple methods of different types for the same selector are
1810 found during compilation.  The check is performed on the list of methods
1811 in the final stage of compilation.  Additionally, a check is performed
1812 for each selector appearing in a @code{@@selector(@dots{})}
1813 expression, and a corresponding method for that selector has been found
1814 during compilation.  Because these checks scan the method table only at
1815 the end of compilation, these warnings are not produced if the final
1816 stage of compilation is not reached, for example because an error is
1817 found during compilation, or because the @code{-fsyntax-only} option is
1818 being used.
1820 @item -Wundeclared-selector
1821 @opindex Wundeclared-selector
1822 Warn if a @code{@@selector(@dots{})} expression referring to an
1823 undeclared selector is found.  A selector is considered undeclared if no
1824 method with that name has been declared before the 
1825 @code{@@selector(@dots{})} expression, either explicitly in an
1826 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1827 an @code{@@implementation} section.  This option always performs its
1828 checks as soon as a @code{@@selector(@dots{})} expression is found,
1829 while @code{-Wselector} only performs its checks in the final stage of
1830 compilation.  This also enforces the coding style convention
1831 that methods and selectors must be declared before being used.
1833 @c not documented because only avail via -Wp
1834 @c @item -print-objc-runtime-info
1836 @end table
1838 @node Language Independent Options
1839 @section Options to Control Diagnostic Messages Formatting
1840 @cindex options to control diagnostics formatting
1841 @cindex diagnostic messages
1842 @cindex message formatting
1844 Traditionally, diagnostic messages have been formatted irrespective of
1845 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1846 below can be used to control the diagnostic messages formatting
1847 algorithm, e.g.@: how many characters per line, how often source location
1848 information should be reported.  Right now, only the C++ front end can
1849 honor these options.  However it is expected, in the near future, that
1850 the remaining front ends would be able to digest them correctly.
1852 @table @gcctabopt
1853 @item -fmessage-length=@var{n}
1854 @opindex fmessage-length
1855 Try to format error messages so that they fit on lines of about @var{n}
1856 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1857 the front ends supported by GCC@.  If @var{n} is zero, then no
1858 line-wrapping will be done; each error message will appear on a single
1859 line.
1861 @opindex fdiagnostics-show-location
1862 @item -fdiagnostics-show-location=once
1863 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1864 reporter to emit @emph{once} source location information; that is, in
1865 case the message is too long to fit on a single physical line and has to
1866 be wrapped, the source location won't be emitted (as prefix) again,
1867 over and over, in subsequent continuation lines.  This is the default
1868 behavior.
1870 @item -fdiagnostics-show-location=every-line
1871 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1872 messages reporter to emit the same source location information (as
1873 prefix) for physical lines that result from the process of breaking
1874 a message which is too long to fit on a single line.
1876 @end table
1878 @node Warning Options
1879 @section Options to Request or Suppress Warnings
1880 @cindex options to control warnings
1881 @cindex warning messages
1882 @cindex messages, warning
1883 @cindex suppressing warnings
1885 Warnings are diagnostic messages that report constructions which
1886 are not inherently erroneous but which are risky or suggest there
1887 may have been an error.
1889 You can request many specific warnings with options beginning @samp{-W},
1890 for example @option{-Wimplicit} to request warnings on implicit
1891 declarations.  Each of these specific warning options also has a
1892 negative form beginning @samp{-Wno-} to turn off warnings;
1893 for example, @option{-Wno-implicit}.  This manual lists only one of the
1894 two forms, whichever is not the default.
1896 The following options control the amount and kinds of warnings produced
1897 by GCC; for further, language-specific options also refer to
1898 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1900 @table @gcctabopt
1901 @cindex syntax checking
1902 @item -fsyntax-only
1903 @opindex fsyntax-only
1904 Check the code for syntax errors, but don't do anything beyond that.
1906 @item -pedantic
1907 @opindex pedantic
1908 Issue all the warnings demanded by strict ISO C and ISO C++;
1909 reject all programs that use forbidden extensions, and some other
1910 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1911 version of the ISO C standard specified by any @option{-std} option used.
1913 Valid ISO C and ISO C++ programs should compile properly with or without
1914 this option (though a rare few will require @option{-ansi} or a
1915 @option{-std} option specifying the required version of ISO C)@.  However,
1916 without this option, certain GNU extensions and traditional C and C++
1917 features are supported as well.  With this option, they are rejected.
1919 @option{-pedantic} does not cause warning messages for use of the
1920 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1921 warnings are also disabled in the expression that follows
1922 @code{__extension__}.  However, only system header files should use
1923 these escape routes; application programs should avoid them.
1924 @xref{Alternate Keywords}.
1926 Some users try to use @option{-pedantic} to check programs for strict ISO
1927 C conformance.  They soon find that it does not do quite what they want:
1928 it finds some non-ISO practices, but not all---only those for which
1929 ISO C @emph{requires} a diagnostic, and some others for which
1930 diagnostics have been added.
1932 A feature to report any failure to conform to ISO C might be useful in
1933 some instances, but would require considerable additional work and would
1934 be quite different from @option{-pedantic}.  We don't have plans to
1935 support such a feature in the near future.
1937 Where the standard specified with @option{-std} represents a GNU
1938 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1939 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1940 extended dialect is based.  Warnings from @option{-pedantic} are given
1941 where they are required by the base standard.  (It would not make sense
1942 for such warnings to be given only for features not in the specified GNU
1943 C dialect, since by definition the GNU dialects of C include all
1944 features the compiler supports with the given option, and there would be
1945 nothing to warn about.)
1947 @item -pedantic-errors
1948 @opindex pedantic-errors
1949 Like @option{-pedantic}, except that errors are produced rather than
1950 warnings.
1952 @item -w
1953 @opindex w
1954 Inhibit all warning messages.
1956 @item -Wno-import
1957 @opindex Wno-import
1958 Inhibit warning messages about the use of @samp{#import}.
1960 @item -Wchar-subscripts
1961 @opindex Wchar-subscripts
1962 Warn if an array subscript has type @code{char}.  This is a common cause
1963 of error, as programmers often forget that this type is signed on some
1964 machines.
1966 @item -Wcomment
1967 @opindex Wcomment
1968 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1969 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1971 @item -Wformat
1972 @opindex Wformat
1973 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1974 the arguments supplied have types appropriate to the format string
1975 specified, and that the conversions specified in the format string make
1976 sense.  This includes standard functions, and others specified by format
1977 attributes (@pxref{Function Attributes}), in the @code{printf},
1978 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1979 not in the C standard) families.
1981 The formats are checked against the format features supported by GNU
1982 libc version 2.2.  These include all ISO C90 and C99 features, as well
1983 as features from the Single Unix Specification and some BSD and GNU
1984 extensions.  Other library implementations may not support all these
1985 features; GCC does not support warning about features that go beyond a
1986 particular library's limitations.  However, if @option{-pedantic} is used
1987 with @option{-Wformat}, warnings will be given about format features not
1988 in the selected standard version (but not for @code{strfmon} formats,
1989 since those are not in any version of the C standard).  @xref{C Dialect
1990 Options,,Options Controlling C Dialect}.
1992 Since @option{-Wformat} also checks for null format arguments for
1993 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
1995 @option{-Wformat} is included in @option{-Wall}.  For more control over some
1996 aspects of format checking, the options @option{-Wno-format-y2k},
1997 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
1998 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
1999 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2001 @item -Wno-format-y2k
2002 @opindex Wno-format-y2k
2003 If @option{-Wformat} is specified, do not warn about @code{strftime}
2004 formats which may yield only a two-digit year.
2006 @item -Wno-format-extra-args
2007 @opindex Wno-format-extra-args
2008 If @option{-Wformat} is specified, do not warn about excess arguments to a
2009 @code{printf} or @code{scanf} format function.  The C standard specifies
2010 that such arguments are ignored.
2012 Where the unused arguments lie between used arguments that are
2013 specified with @samp{$} operand number specifications, normally
2014 warnings are still given, since the implementation could not know what
2015 type to pass to @code{va_arg} to skip the unused arguments.  However,
2016 in the case of @code{scanf} formats, this option will suppress the
2017 warning if the unused arguments are all pointers, since the Single
2018 Unix Specification says that such unused arguments are allowed.
2020 @item -Wno-format-zero-length
2021 @opindex Wno-format-zero-length
2022 If @option{-Wformat} is specified, do not warn about zero-length formats.
2023 The C standard specifies that zero-length formats are allowed.
2025 @item -Wformat-nonliteral
2026 @opindex Wformat-nonliteral
2027 If @option{-Wformat} is specified, also warn if the format string is not a
2028 string literal and so cannot be checked, unless the format function
2029 takes its format arguments as a @code{va_list}.
2031 @item -Wformat-security
2032 @opindex Wformat-security
2033 If @option{-Wformat} is specified, also warn about uses of format
2034 functions that represent possible security problems.  At present, this
2035 warns about calls to @code{printf} and @code{scanf} functions where the
2036 format string is not a string literal and there are no format arguments,
2037 as in @code{printf (foo);}.  This may be a security hole if the format
2038 string came from untrusted input and contains @samp{%n}.  (This is
2039 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2040 in future warnings may be added to @option{-Wformat-security} that are not
2041 included in @option{-Wformat-nonliteral}.)
2043 @item -Wformat=2
2044 @opindex Wformat=2
2045 Enable @option{-Wformat} plus format checks not included in
2046 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2047 -Wformat-nonliteral -Wformat-security}.
2049 @item -Wnonnull
2050 @opindex Wnonnull
2051 Enable warning about passing a null pointer for arguments marked as
2052 requiring a non-null value by the @code{nonnull} function attribute.
2054 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2055 can be disabled with the @option{-Wno-nonnull} option.
2057 @item -Wimplicit-int
2058 @opindex Wimplicit-int
2059 Warn when a declaration does not specify a type.
2061 @item -Wimplicit-function-declaration
2062 @itemx -Werror-implicit-function-declaration
2063 @opindex Wimplicit-function-declaration
2064 @opindex Werror-implicit-function-declaration
2065 Give a warning (or error) whenever a function is used before being
2066 declared.
2068 @item -Wimplicit
2069 @opindex Wimplicit
2070 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2072 @item -Wmain
2073 @opindex Wmain
2074 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2075 function with external linkage, returning int, taking either zero
2076 arguments, two, or three arguments of appropriate types.
2078 @item -Wmissing-braces
2079 @opindex Wmissing-braces
2080 Warn if an aggregate or union initializer is not fully bracketed.  In
2081 the following example, the initializer for @samp{a} is not fully
2082 bracketed, but that for @samp{b} is fully bracketed.
2084 @smallexample
2085 int a[2][2] = @{ 0, 1, 2, 3 @};
2086 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2087 @end smallexample
2089 @item -Wparentheses
2090 @opindex Wparentheses
2091 Warn if parentheses are omitted in certain contexts, such
2092 as when there is an assignment in a context where a truth value
2093 is expected, or when operators are nested whose precedence people
2094 often get confused about.
2096 Also warn about constructions where there may be confusion to which
2097 @code{if} statement an @code{else} branch belongs.  Here is an example of
2098 such a case:
2100 @smallexample
2101 @group
2103   if (a)
2104     if (b)
2105       foo ();
2106   else
2107     bar ();
2109 @end group
2110 @end smallexample
2112 In C, every @code{else} branch belongs to the innermost possible @code{if}
2113 statement, which in this example is @code{if (b)}.  This is often not
2114 what the programmer expected, as illustrated in the above example by
2115 indentation the programmer chose.  When there is the potential for this
2116 confusion, GCC will issue a warning when this flag is specified.
2117 To eliminate the warning, add explicit braces around the innermost
2118 @code{if} statement so there is no way the @code{else} could belong to
2119 the enclosing @code{if}.  The resulting code would look like this:
2121 @smallexample
2122 @group
2124   if (a)
2125     @{
2126       if (b)
2127         foo ();
2128       else
2129         bar ();
2130     @}
2132 @end group
2133 @end smallexample
2135 @item -Wsequence-point
2136 @opindex Wsequence-point
2137 Warn about code that may have undefined semantics because of violations
2138 of sequence point rules in the C standard.
2140 The C standard defines the order in which expressions in a C program are
2141 evaluated in terms of @dfn{sequence points}, which represent a partial
2142 ordering between the execution of parts of the program: those executed
2143 before the sequence point, and those executed after it.  These occur
2144 after the evaluation of a full expression (one which is not part of a
2145 larger expression), after the evaluation of the first operand of a
2146 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2147 function is called (but after the evaluation of its arguments and the
2148 expression denoting the called function), and in certain other places.
2149 Other than as expressed by the sequence point rules, the order of
2150 evaluation of subexpressions of an expression is not specified.  All
2151 these rules describe only a partial order rather than a total order,
2152 since, for example, if two functions are called within one expression
2153 with no sequence point between them, the order in which the functions
2154 are called is not specified.  However, the standards committee have
2155 ruled that function calls do not overlap.
2157 It is not specified when between sequence points modifications to the
2158 values of objects take effect.  Programs whose behavior depends on this
2159 have undefined behavior; the C standard specifies that ``Between the
2160 previous and next sequence point an object shall have its stored value
2161 modified at most once by the evaluation of an expression.  Furthermore,
2162 the prior value shall be read only to determine the value to be
2163 stored.''.  If a program breaks these rules, the results on any
2164 particular implementation are entirely unpredictable.
2166 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2167 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2168 diagnosed by this option, and it may give an occasional false positive
2169 result, but in general it has been found fairly effective at detecting
2170 this sort of problem in programs.
2172 The present implementation of this option only works for C programs.  A
2173 future implementation may also work for C++ programs.
2175 The C standard is worded confusingly, therefore there is some debate
2176 over the precise meaning of the sequence point rules in subtle cases.
2177 Links to discussions of the problem, including proposed formal
2178 definitions, may be found on our readings page, at
2179 @w{@uref{http://gcc.gnu.org/readings.html}}.
2181 @item -Wreturn-type
2182 @opindex Wreturn-type
2183 Warn whenever a function is defined with a return-type that defaults to
2184 @code{int}.  Also warn about any @code{return} statement with no
2185 return-value in a function whose return-type is not @code{void}.
2187 For C++, a function without return type always produces a diagnostic
2188 message, even when @option{-Wno-return-type} is specified.  The only
2189 exceptions are @samp{main} and functions defined in system headers.
2191 @item -Wswitch
2192 @opindex Wswitch
2193 Warn whenever a @code{switch} statement has an index of enumeral type
2194 and lacks a @code{case} for one or more of the named codes of that
2195 enumeration.  (The presence of a @code{default} label prevents this
2196 warning.)  @code{case} labels outside the enumeration range also
2197 provoke warnings when this option is used.
2199 @item -Wswitch-default
2200 @opindex Wswitch-switch
2201 Warn whenever a @code{switch} statement does not have a @code{default}
2202 case.
2204 @item -Wswitch-enum
2205 @opindex Wswitch-enum
2206 Warn whenever a @code{switch} statement has an index of enumeral type
2207 and lacks a @code{case} for one or more of the named codes of that
2208 enumeration.  @code{case} labels outside the enumeration range also
2209 provoke warnings when this option is used.
2211 @item -Wtrigraphs
2212 @opindex Wtrigraphs
2213 Warn if any trigraphs are encountered that might change the meaning of
2214 the program (trigraphs within comments are not warned about).
2216 @item -Wunused-function
2217 @opindex Wunused-function
2218 Warn whenever a static function is declared but not defined or a
2219 non\-inline static function is unused.
2221 @item -Wunused-label
2222 @opindex Wunused-label
2223 Warn whenever a label is declared but not used.
2225 To suppress this warning use the @samp{unused} attribute
2226 (@pxref{Variable Attributes}).
2228 @item -Wunused-parameter
2229 @opindex Wunused-parameter
2230 Warn whenever a function parameter is unused aside from its declaration.
2232 To suppress this warning use the @samp{unused} attribute
2233 (@pxref{Variable Attributes}).
2235 @item -Wunused-variable
2236 @opindex Wunused-variable
2237 Warn whenever a local variable or non-constant static variable is unused
2238 aside from its declaration
2240 To suppress this warning use the @samp{unused} attribute
2241 (@pxref{Variable Attributes}).
2243 @item -Wunused-value
2244 @opindex Wunused-value
2245 Warn whenever a statement computes a result that is explicitly not used.
2247 To suppress this warning cast the expression to @samp{void}.
2249 @item -Wunused
2250 @opindex Wunused
2251 All the above @option{-Wunused} options combined.
2253 In order to get a warning about an unused function parameter, you must
2254 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2255 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2257 @item -Wuninitialized
2258 @opindex Wuninitialized
2259 Warn if an automatic variable is used without first being initialized or
2260 if a variable may be clobbered by a @code{setjmp} call.
2262 These warnings are possible only in optimizing compilation,
2263 because they require data flow information that is computed only
2264 when optimizing.  If you don't specify @option{-O}, you simply won't
2265 get these warnings.
2267 These warnings occur only for variables that are candidates for
2268 register allocation.  Therefore, they do not occur for a variable that
2269 is declared @code{volatile}, or whose address is taken, or whose size
2270 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2271 structures, unions or arrays, even when they are in registers.
2273 Note that there may be no warning about a variable that is used only
2274 to compute a value that itself is never used, because such
2275 computations may be deleted by data flow analysis before the warnings
2276 are printed.
2278 These warnings are made optional because GCC is not smart
2279 enough to see all the reasons why the code might be correct
2280 despite appearing to have an error.  Here is one example of how
2281 this can happen:
2283 @smallexample
2284 @group
2286   int x;
2287   switch (y)
2288     @{
2289     case 1: x = 1;
2290       break;
2291     case 2: x = 4;
2292       break;
2293     case 3: x = 5;
2294     @}
2295   foo (x);
2297 @end group
2298 @end smallexample
2300 @noindent
2301 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2302 always initialized, but GCC doesn't know this.  Here is
2303 another common case:
2305 @smallexample
2307   int save_y;
2308   if (change_y) save_y = y, y = new_y;
2309   @dots{}
2310   if (change_y) y = save_y;
2312 @end smallexample
2314 @noindent
2315 This has no bug because @code{save_y} is used only if it is set.
2317 @cindex @code{longjmp} warnings
2318 This option also warns when a non-volatile automatic variable might be
2319 changed by a call to @code{longjmp}.  These warnings as well are possible
2320 only in optimizing compilation.
2322 The compiler sees only the calls to @code{setjmp}.  It cannot know
2323 where @code{longjmp} will be called; in fact, a signal handler could
2324 call it at any point in the code.  As a result, you may get a warning
2325 even when there is in fact no problem because @code{longjmp} cannot
2326 in fact be called at the place which would cause a problem.
2328 Some spurious warnings can be avoided if you declare all the functions
2329 you use that never return as @code{noreturn}.  @xref{Function
2330 Attributes}.
2332 @item -Wunknown-pragmas
2333 @opindex Wunknown-pragmas
2334 @cindex warning for unknown pragmas
2335 @cindex unknown pragmas, warning
2336 @cindex pragmas, warning of unknown
2337 Warn when a #pragma directive is encountered which is not understood by
2338 GCC@.  If this command line option is used, warnings will even be issued
2339 for unknown pragmas in system header files.  This is not the case if
2340 the warnings were only enabled by the @option{-Wall} command line option.
2342 @item -Wstrict-aliasing
2343 @opindex Wstrict-aliasing
2344 This option is only active when @option{-fstrict-aliasing} is active.
2345 It warns about code which might break the strict aliasing rules that the
2346 compiler is using for optimization. The warning does not catch all
2347 cases, but does attempt to catch the more common pitfalls. It is
2348 included in @option{-Wall}.
2350 @item -Wall
2351 @opindex Wall
2352 All of the above @samp{-W} options combined.  This enables all the
2353 warnings about constructions that some users consider questionable, and
2354 that are easy to avoid (or modify to prevent the warning), even in
2355 conjunction with macros.  This also enables some language-specific
2356 warnings described in @ref{C++ Dialect Options} and
2357 @ref{Objective-C Dialect Options}.
2358 @end table
2360 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2361 Some of them warn about constructions that users generally do not
2362 consider questionable, but which occasionally you might wish to check
2363 for; others warn about constructions that are necessary or hard to avoid
2364 in some cases, and there is no simple way to modify the code to suppress
2365 the warning.
2367 @table @gcctabopt
2368 @item -Wextra
2369 @opindex W
2370 @opindex Wextra
2371 (This option used to be called @option{-W}.  The older name is still
2372 supported, but the newer name is more descriptive.)  Print extra warning
2373 messages for these events:
2375 @itemize @bullet
2376 @item
2377 A function can return either with or without a value.  (Falling
2378 off the end of the function body is considered returning without
2379 a value.)  For example, this function would evoke such a
2380 warning:
2382 @smallexample
2383 @group
2384 foo (a)
2386   if (a > 0)
2387     return a;
2389 @end group
2390 @end smallexample
2392 @item
2393 An expression-statement or the left-hand side of a comma expression
2394 contains no side effects.
2395 To suppress the warning, cast the unused expression to void.
2396 For example, an expression such as @samp{x[i,j]} will cause a warning,
2397 but @samp{x[(void)i,j]} will not.
2399 @item
2400 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2402 @item
2403 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2404 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2405 that of ordinary mathematical notation.
2407 @item
2408 Storage-class specifiers like @code{static} are not the first things in
2409 a declaration.  According to the C Standard, this usage is obsolescent.
2411 @item
2412 The return type of a function has a type qualifier such as @code{const}.
2413 Such a type qualifier has no effect, since the value returned by a
2414 function is not an lvalue.  (But don't warn about the GNU extension of
2415 @code{volatile void} return types.  That extension will be warned about
2416 if @option{-pedantic} is specified.)
2418 @item
2419 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2420 arguments.
2422 @item
2423 A comparison between signed and unsigned values could produce an
2424 incorrect result when the signed value is converted to unsigned.
2425 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2427 @item
2428 An aggregate has an initializer which does not initialize all members.
2429 For example, the following code would cause such a warning, because
2430 @code{x.h} would be implicitly initialized to zero:
2432 @smallexample
2433 struct s @{ int f, g, h; @};
2434 struct s x = @{ 3, 4 @};
2435 @end smallexample
2437 @item
2438 A function parameter is declared without a type specifier in K&R-style
2439 functions:
2441 @smallexample
2442 void foo(bar) @{ @}
2443 @end smallexample
2445 @item
2446 An empty body occurs in an @samp{if} or @samp{else} statement.
2448 @item
2449 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2450 @samp{>}, or @samp{>=}.
2452 @item
2453 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2455 @item
2456 Any of several floating-point events that often indicate errors, such as
2457 overflow, underflow, loss of precision, etc.
2459 @item @r{(C++ only)}
2460 An enumerator and a non-enumerator both appear in a conditional expression.
2462 @item @r{(C++ only)}
2463 A non-static reference or non-static @samp{const} member appears in a
2464 class without constructors.
2466 @item @r{(C++ only)}
2467 Ambiguous virtual bases.
2469 @item @r{(C++ only)}
2470 Subscripting an array which has been declared @samp{register}.
2472 @item @r{(C++ only)}
2473 Taking the address of a variable which has been declared @samp{register}.
2475 @item @r{(C++ only)}
2476 A base class is not initialized in a derived class' copy constructor.
2477 @end itemize
2479 @item -Wno-div-by-zero
2480 @opindex Wno-div-by-zero
2481 @opindex Wdiv-by-zero
2482 Do not warn about compile-time integer division by zero.  Floating point
2483 division by zero is not warned about, as it can be a legitimate way of
2484 obtaining infinities and NaNs.
2486 @item -Wsystem-headers
2487 @opindex Wsystem-headers
2488 @cindex warnings from system headers
2489 @cindex system headers, warnings from
2490 Print warning messages for constructs found in system header files.
2491 Warnings from system headers are normally suppressed, on the assumption
2492 that they usually do not indicate real problems and would only make the
2493 compiler output harder to read.  Using this command line option tells
2494 GCC to emit warnings from system headers as if they occurred in user
2495 code.  However, note that using @option{-Wall} in conjunction with this
2496 option will @emph{not} warn about unknown pragmas in system
2497 headers---for that, @option{-Wunknown-pragmas} must also be used.
2499 @item -Wfloat-equal
2500 @opindex Wfloat-equal
2501 Warn if floating point values are used in equality comparisons.
2503 The idea behind this is that sometimes it is convenient (for the
2504 programmer) to consider floating-point values as approximations to
2505 infinitely precise real numbers.  If you are doing this, then you need
2506 to compute (by analyzing the code, or in some other way) the maximum or
2507 likely maximum error that the computation introduces, and allow for it
2508 when performing comparisons (and when producing output, but that's a
2509 different problem).  In particular, instead of testing for equality, you
2510 would check to see whether the two values have ranges that overlap; and
2511 this is done with the relational operators, so equality comparisons are
2512 probably mistaken.
2514 @item -Wtraditional @r{(C only)}
2515 @opindex Wtraditional
2516 Warn about certain constructs that behave differently in traditional and
2517 ISO C@.  Also warn about ISO C constructs that have no traditional C
2518 equivalent, and/or problematic constructs which should be avoided.
2520 @itemize @bullet
2521 @item
2522 Macro parameters that appear within string literals in the macro body.
2523 In traditional C macro replacement takes place within string literals,
2524 but does not in ISO C@.
2526 @item
2527 In traditional C, some preprocessor directives did not exist.
2528 Traditional preprocessors would only consider a line to be a directive
2529 if the @samp{#} appeared in column 1 on the line.  Therefore
2530 @option{-Wtraditional} warns about directives that traditional C
2531 understands but would ignore because the @samp{#} does not appear as the
2532 first character on the line.  It also suggests you hide directives like
2533 @samp{#pragma} not understood by traditional C by indenting them.  Some
2534 traditional implementations would not recognize @samp{#elif}, so it
2535 suggests avoiding it altogether.
2537 @item
2538 A function-like macro that appears without arguments.
2540 @item
2541 The unary plus operator.
2543 @item
2544 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2545 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2546 constants.)  Note, these suffixes appear in macros defined in the system
2547 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2548 Use of these macros in user code might normally lead to spurious
2549 warnings, however gcc's integrated preprocessor has enough context to
2550 avoid warning in these cases.
2552 @item
2553 A function declared external in one block and then used after the end of
2554 the block.
2556 @item
2557 A @code{switch} statement has an operand of type @code{long}.
2559 @item
2560 A non-@code{static} function declaration follows a @code{static} one.
2561 This construct is not accepted by some traditional C compilers.
2563 @item
2564 The ISO type of an integer constant has a different width or
2565 signedness from its traditional type.  This warning is only issued if
2566 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2567 typically represent bit patterns, are not warned about.
2569 @item
2570 Usage of ISO string concatenation is detected.
2572 @item
2573 Initialization of automatic aggregates.
2575 @item
2576 Identifier conflicts with labels.  Traditional C lacks a separate
2577 namespace for labels.
2579 @item
2580 Initialization of unions.  If the initializer is zero, the warning is
2581 omitted.  This is done under the assumption that the zero initializer in
2582 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2583 initializer warnings and relies on default initialization to zero in the
2584 traditional C case.
2586 @item
2587 Conversions by prototypes between fixed/floating point values and vice
2588 versa.  The absence of these prototypes when compiling with traditional
2589 C would cause serious problems.  This is a subset of the possible
2590 conversion warnings, for the full set use @option{-Wconversion}.
2592 @item
2593 Use of ISO C style function definitions.  This warning intentionally is
2594 @emph{not} issued for prototype declarations or variadic functions
2595 because these ISO C features will appear in your code when using
2596 libiberty's traditional C compatibility macros, @code{PARAMS} and
2597 @code{VPARAMS}.  This warning is also bypassed for nested functions
2598 because that feature is already a gcc extension and thus not relevant to
2599 traditional C compatibility.
2600 @end itemize
2602 @item -Wdeclaration-after-statement @r{(C only)}
2603 @opindex Wdeclaration-after-statement
2604 Warn when a declaration is found after a statement in a block.  This
2605 construct, known from C++, was introduced with ISO C99 and is by default
2606 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2607 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2609 @item -Wundef
2610 @opindex Wundef
2611 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2613 @item -Wendif-labels
2614 @opindex Wendif-labels
2615 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2617 @item -Wshadow
2618 @opindex Wshadow
2619 Warn whenever a local variable shadows another local variable, parameter or
2620 global variable or whenever a built-in function is shadowed.
2622 @item -Wlarger-than-@var{len}
2623 @opindex Wlarger-than
2624 Warn whenever an object of larger than @var{len} bytes is defined.
2626 @item -Wpointer-arith
2627 @opindex Wpointer-arith
2628 Warn about anything that depends on the ``size of'' a function type or
2629 of @code{void}.  GNU C assigns these types a size of 1, for
2630 convenience in calculations with @code{void *} pointers and pointers
2631 to functions.
2633 @item -Wbad-function-cast @r{(C only)}
2634 @opindex Wbad-function-cast
2635 Warn whenever a function call is cast to a non-matching type.
2636 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2638 @item -Wcast-qual
2639 @opindex Wcast-qual
2640 Warn whenever a pointer is cast so as to remove a type qualifier from
2641 the target type.  For example, warn if a @code{const char *} is cast
2642 to an ordinary @code{char *}.
2644 @item -Wcast-align
2645 @opindex Wcast-align
2646 Warn whenever a pointer is cast such that the required alignment of the
2647 target is increased.  For example, warn if a @code{char *} is cast to
2648 an @code{int *} on machines where integers can only be accessed at
2649 two- or four-byte boundaries.
2651 @item -Wwrite-strings
2652 @opindex Wwrite-strings
2653 When compiling C, give string constants the type @code{const
2654 char[@var{length}]} so that
2655 copying the address of one into a non-@code{const} @code{char *}
2656 pointer will get a warning; when compiling C++, warn about the
2657 deprecated conversion from string constants to @code{char *}.
2658 These warnings will help you find at
2659 compile time code that can try to write into a string constant, but
2660 only if you have been very careful about using @code{const} in
2661 declarations and prototypes.  Otherwise, it will just be a nuisance;
2662 this is why we did not make @option{-Wall} request these warnings.
2664 @item -Wconversion
2665 @opindex Wconversion
2666 Warn if a prototype causes a type conversion that is different from what
2667 would happen to the same argument in the absence of a prototype.  This
2668 includes conversions of fixed point to floating and vice versa, and
2669 conversions changing the width or signedness of a fixed point argument
2670 except when the same as the default promotion.
2672 Also, warn if a negative integer constant expression is implicitly
2673 converted to an unsigned type.  For example, warn about the assignment
2674 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2675 casts like @code{(unsigned) -1}.
2677 @item -Wsign-compare
2678 @opindex Wsign-compare
2679 @cindex warning for comparison of signed and unsigned values
2680 @cindex comparison of signed and unsigned values, warning
2681 @cindex signed and unsigned values, comparison warning
2682 Warn when a comparison between signed and unsigned values could produce
2683 an incorrect result when the signed value is converted to unsigned.
2684 This warning is also enabled by @option{-Wextra}; to get the other warnings
2685 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2687 @item -Waggregate-return
2688 @opindex Waggregate-return
2689 Warn if any functions that return structures or unions are defined or
2690 called.  (In languages where you can return an array, this also elicits
2691 a warning.)
2693 @item -Wstrict-prototypes @r{(C only)}
2694 @opindex Wstrict-prototypes
2695 Warn if a function is declared or defined without specifying the
2696 argument types.  (An old-style function definition is permitted without
2697 a warning if preceded by a declaration which specifies the argument
2698 types.)
2700 @item -Wmissing-prototypes @r{(C only)}
2701 @opindex Wmissing-prototypes
2702 Warn if a global function is defined without a previous prototype
2703 declaration.  This warning is issued even if the definition itself
2704 provides a prototype.  The aim is to detect global functions that fail
2705 to be declared in header files.
2707 @item -Wmissing-declarations @r{(C only)}
2708 @opindex Wmissing-declarations
2709 Warn if a global function is defined without a previous declaration.
2710 Do so even if the definition itself provides a prototype.
2711 Use this option to detect global functions that are not declared in
2712 header files.
2714 @item -Wmissing-noreturn
2715 @opindex Wmissing-noreturn
2716 Warn about functions which might be candidates for attribute @code{noreturn}.
2717 Note these are only possible candidates, not absolute ones.  Care should
2718 be taken to manually verify functions actually do not ever return before
2719 adding the @code{noreturn} attribute, otherwise subtle code generation
2720 bugs could be introduced.  You will not get a warning for @code{main} in
2721 hosted C environments.
2723 @item -Wmissing-format-attribute
2724 @opindex Wmissing-format-attribute
2725 @opindex Wformat
2726 If @option{-Wformat} is enabled, also warn about functions which might be
2727 candidates for @code{format} attributes.  Note these are only possible
2728 candidates, not absolute ones.  GCC will guess that @code{format}
2729 attributes might be appropriate for any function that calls a function
2730 like @code{vprintf} or @code{vscanf}, but this might not always be the
2731 case, and some functions for which @code{format} attributes are
2732 appropriate may not be detected.  This option has no effect unless
2733 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2735 @item -Wno-multichar
2736 @opindex Wno-multichar
2737 @opindex Wmultichar
2738 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2739 Usually they indicate a typo in the user's code, as they have
2740 implementation-defined values, and should not be used in portable code.
2742 @item -Wno-deprecated-declarations
2743 @opindex Wno-deprecated-declarations
2744 Do not warn about uses of functions, variables, and types marked as
2745 deprecated by using the @code{deprecated} attribute.
2746 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2747 @pxref{Type Attributes}.)
2749 @item -Wpacked
2750 @opindex Wpacked
2751 Warn if a structure is given the packed attribute, but the packed
2752 attribute has no effect on the layout or size of the structure.
2753 Such structures may be mis-aligned for little benefit.  For
2754 instance, in this code, the variable @code{f.x} in @code{struct bar}
2755 will be misaligned even though @code{struct bar} does not itself
2756 have the packed attribute:
2758 @smallexample
2759 @group
2760 struct foo @{
2761   int x;
2762   char a, b, c, d;
2763 @} __attribute__((packed));
2764 struct bar @{
2765   char z;
2766   struct foo f;
2768 @end group
2769 @end smallexample
2771 @item -Wpadded
2772 @opindex Wpadded
2773 Warn if padding is included in a structure, either to align an element
2774 of the structure or to align the whole structure.  Sometimes when this
2775 happens it is possible to rearrange the fields of the structure to
2776 reduce the padding and so make the structure smaller.
2778 @item -Wredundant-decls
2779 @opindex Wredundant-decls
2780 Warn if anything is declared more than once in the same scope, even in
2781 cases where multiple declaration is valid and changes nothing.
2783 @item -Wnested-externs @r{(C only)}
2784 @opindex Wnested-externs
2785 Warn if an @code{extern} declaration is encountered within a function.
2787 @item -Wunreachable-code
2788 @opindex Wunreachable-code
2789 Warn if the compiler detects that code will never be executed.
2791 This option is intended to warn when the compiler detects that at
2792 least a whole line of source code will never be executed, because
2793 some condition is never satisfied or because it is after a
2794 procedure that never returns.
2796 It is possible for this option to produce a warning even though there
2797 are circumstances under which part of the affected line can be executed,
2798 so care should be taken when removing apparently-unreachable code.
2800 For instance, when a function is inlined, a warning may mean that the
2801 line is unreachable in only one inlined copy of the function.
2803 This option is not made part of @option{-Wall} because in a debugging
2804 version of a program there is often substantial code which checks
2805 correct functioning of the program and is, hopefully, unreachable
2806 because the program does work.  Another common use of unreachable
2807 code is to provide behavior which is selectable at compile-time.
2809 @item -Winline
2810 @opindex Winline
2811 Warn if a function can not be inlined and it was declared as inline.
2812 Even with this option, the compiler will not warn about failures to
2813 inline functions declared in system headers.  
2815 The compiler uses a variety of heuristics to determine whether or not
2816 to inline a function.  For example, the compiler takes into account
2817 the size of the function being inlined and the the amount of inlining
2818 that has already been done in the current function.  Therefore,
2819 seemingly insignificant changes in the source program can cause the
2820 warnings produced by @option{-Winline} to appear or disappear.
2822 @item -Wno-invalid-offsetof @r{(C++ only)}
2823 @opindex Wno-invalid-offsetof
2824 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2825 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2826 to a non-POD type is undefined.  In existing C++ implementations,
2827 however, @samp{offsetof} typically gives meaningful results even when
2828 applied to certain kinds of non-POD types. (Such as a simple
2829 @samp{struct} that fails to be a POD type only by virtue of having a
2830 constructor.)  This flag is for users who are aware that they are
2831 writing nonportable code and who have deliberately chosen to ignore the
2832 warning about it.
2834 The restrictions on @samp{offsetof} may be relaxed in a future version
2835 of the C++ standard.
2837 @item -Winvalid-pch
2838 @opindex Winvalid-pch
2839 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2840 the search path but can't be used.
2842 @item -Wlong-long
2843 @opindex Wlong-long
2844 @opindex Wno-long-long
2845 Warn if @samp{long long} type is used.  This is default.  To inhibit
2846 the warning messages, use @option{-Wno-long-long}.  Flags
2847 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2848 only when @option{-pedantic} flag is used.
2850 @item -Wdisabled-optimization
2851 @opindex Wdisabled-optimization
2852 Warn if a requested optimization pass is disabled.  This warning does
2853 not generally indicate that there is anything wrong with your code; it
2854 merely indicates that GCC's optimizers were unable to handle the code
2855 effectively.  Often, the problem is that your code is too big or too
2856 complex; GCC will refuse to optimize programs when the optimization
2857 itself is likely to take inordinate amounts of time.
2859 @item -Werror
2860 @opindex Werror
2861 Make all warnings into errors.
2862 @end table
2864 @node Debugging Options
2865 @section Options for Debugging Your Program or GCC
2866 @cindex options, debugging
2867 @cindex debugging information options
2869 GCC has various special options that are used for debugging
2870 either your program or GCC:
2872 @table @gcctabopt
2873 @item -g
2874 @opindex g
2875 Produce debugging information in the operating system's native format
2876 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2877 information.
2879 On most systems that use stabs format, @option{-g} enables use of extra
2880 debugging information that only GDB can use; this extra information
2881 makes debugging work better in GDB but will probably make other debuggers
2882 crash or
2883 refuse to read the program.  If you want to control for certain whether
2884 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2885 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2886 or @option{-gvms} (see below).
2888 Unlike most other C compilers, GCC allows you to use @option{-g} with
2889 @option{-O}.  The shortcuts taken by optimized code may occasionally
2890 produce surprising results: some variables you declared may not exist
2891 at all; flow of control may briefly move where you did not expect it;
2892 some statements may not be executed because they compute constant
2893 results or their values were already at hand; some statements may
2894 execute in different places because they were moved out of loops.
2896 Nevertheless it proves possible to debug optimized output.  This makes
2897 it reasonable to use the optimizer for programs that might have bugs.
2899 The following options are useful when GCC is generated with the
2900 capability for more than one debugging format.
2902 @item -ggdb
2903 @opindex ggdb
2904 Produce debugging information for use by GDB@.  This means to use the
2905 most expressive format available (DWARF 2, stabs, or the native format
2906 if neither of those are supported), including GDB extensions if at all
2907 possible.
2909 @item -gstabs
2910 @opindex gstabs
2911 Produce debugging information in stabs format (if that is supported),
2912 without GDB extensions.  This is the format used by DBX on most BSD
2913 systems.  On MIPS, Alpha and System V Release 4 systems this option
2914 produces stabs debugging output which is not understood by DBX or SDB@.
2915 On System V Release 4 systems this option requires the GNU assembler.
2917 @item -feliminate-unused-debug-symbols
2918 @opindex feliminate-unused-debug-symbols
2919 Produce debugging information in stabs format (if that is supported),
2920 for only symbols that are actually used.
2922 @item -gstabs+
2923 @opindex gstabs+
2924 Produce debugging information in stabs format (if that is supported),
2925 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2926 use of these extensions is likely to make other debuggers crash or
2927 refuse to read the program.
2929 @item -gcoff
2930 @opindex gcoff
2931 Produce debugging information in COFF format (if that is supported).
2932 This is the format used by SDB on most System V systems prior to
2933 System V Release 4.
2935 @item -gxcoff
2936 @opindex gxcoff
2937 Produce debugging information in XCOFF format (if that is supported).
2938 This is the format used by the DBX debugger on IBM RS/6000 systems.
2940 @item -gxcoff+
2941 @opindex gxcoff+
2942 Produce debugging information in XCOFF format (if that is supported),
2943 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2944 use of these extensions is likely to make other debuggers crash or
2945 refuse to read the program, and may cause assemblers other than the GNU
2946 assembler (GAS) to fail with an error.
2948 @item -gdwarf
2949 @opindex gdwarf
2950 Produce debugging information in DWARF version 1 format (if that is
2951 supported).  This is the format used by SDB on most System V Release 4
2952 systems.
2954 This option is deprecated.
2956 @item -gdwarf+
2957 @opindex gdwarf+
2958 Produce debugging information in DWARF version 1 format (if that is
2959 supported), using GNU extensions understood only by the GNU debugger
2960 (GDB)@.  The use of these extensions is likely to make other debuggers
2961 crash or refuse to read the program.
2963 This option is deprecated.
2965 @item -gdwarf-2
2966 @opindex gdwarf-2
2967 Produce debugging information in DWARF version 2 format (if that is
2968 supported).  This is the format used by DBX on IRIX 6.
2970 @item -gvms
2971 @opindex gvms
2972 Produce debugging information in VMS debug format (if that is
2973 supported).  This is the format used by DEBUG on VMS systems.
2975 @item -g@var{level}
2976 @itemx -ggdb@var{level}
2977 @itemx -gstabs@var{level}
2978 @itemx -gcoff@var{level}
2979 @itemx -gxcoff@var{level}
2980 @itemx -gvms@var{level}
2981 Request debugging information and also use @var{level} to specify how
2982 much information.  The default level is 2.
2984 Level 1 produces minimal information, enough for making backtraces in
2985 parts of the program that you don't plan to debug.  This includes
2986 descriptions of functions and external variables, but no information
2987 about local variables and no line numbers.
2989 Level 3 includes extra information, such as all the macro definitions
2990 present in the program.  Some debuggers support macro expansion when
2991 you use @option{-g3}.
2993 Note that in order to avoid confusion between DWARF1 debug level 2,
2994 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2995 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2996 option to change the debug level for DWARF1 or DWARF2.
2998 @item -feliminate-dwarf2-dups
2999 @opindex feliminate-dwarf2-dups
3000 Compress DWARF2 debugging information by eliminating duplicated
3001 information about each symbol.  This option only makes sense when
3002 generating DWARF2 debugging information with @option{-gdwarf-2}.
3004 @cindex @command{prof}
3005 @item -p
3006 @opindex p
3007 Generate extra code to write profile information suitable for the
3008 analysis program @command{prof}.  You must use this option when compiling
3009 the source files you want data about, and you must also use it when
3010 linking.
3012 @cindex @command{gprof}
3013 @item -pg
3014 @opindex pg
3015 Generate extra code to write profile information suitable for the
3016 analysis program @command{gprof}.  You must use this option when compiling
3017 the source files you want data about, and you must also use it when
3018 linking.
3020 @item -Q
3021 @opindex Q
3022 Makes the compiler print out each function name as it is compiled, and
3023 print some statistics about each pass when it finishes.
3025 @item -ftime-report
3026 @opindex ftime-report
3027 Makes the compiler print some statistics about the time consumed by each
3028 pass when it finishes.
3030 @item -fmem-report
3031 @opindex fmem-report
3032 Makes the compiler print some statistics about permanent memory
3033 allocation when it finishes.
3035 @item -fprofile-arcs
3036 @opindex fprofile-arcs
3037 Add code so that program flow @dfn{arcs} are instrumented.  During
3038 execution the program records how many times each branch and call is
3039 executed and how many times it is taken or returns.  When the compiled
3040 program exits it saves this data to a file called
3041 @file{@var{auxname}.gcda} for each source file. The data may be used for
3042 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3043 test coverage analysis (@option{-ftest-coverage}). Each object file's
3044 @var{auxname} is generated from the name of the output file, if
3045 explicitly specified and it is not the final executable, otherwise it is
3046 the basename of the source file. In both cases any suffix is removed
3047 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3048 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3050 @itemize
3052 @item
3053 Compile the source files with @option{-fprofile-arcs} plus optimization
3054 and code generation options. For test coverage analysis, use the
3055 additional @option{-ftest-coverage} option. You do not need to profile
3056 every source file in a program.
3058 @item
3059 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3060 (the latter implies the former).
3062 @item
3063 Run the program on a representative workload to generate the arc profile
3064 information. This may be repeated any number of times. You can run
3065 concurrent instances of your program, and provided that the file system
3066 supports locking, the data files will be correctly updated. Also
3067 @code{fork} calls are detected and correctly handled (double counting
3068 will not happen).
3070 @item
3071 For profile-directed optimizations, compile the source files again with
3072 the same optimization and code generation options plus
3073 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3074 Control Optimization}).
3076 @item
3077 For test coverage analysis, use @command{gcov} to produce human readable
3078 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3079 @command{gcov} documentation for further information.
3081 @end itemize
3083 With @option{-fprofile-arcs}, for each function of your program GCC
3084 creates a program flow graph, then finds a spanning tree for the graph.
3085 Only arcs that are not on the spanning tree have to be instrumented: the
3086 compiler adds code to count the number of times that these arcs are
3087 executed.  When an arc is the only exit or only entrance to a block, the
3088 instrumentation code can be added to the block; otherwise, a new basic
3089 block must be created to hold the instrumentation code.
3091 @need 2000
3092 @item -ftest-coverage
3093 @opindex ftest-coverage
3094 Produce a notes file that the @command{gcov} code-coverage utility
3095 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3096 show program coverage. Each source file's note file is called
3097 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3098 above for a description of @var{auxname} and instructions on how to
3099 generate test coverage data. Coverage data will match the source files
3100 more closely, if you do not optimize.
3102 @item -d@var{letters}
3103 @opindex d
3104 Says to make debugging dumps during compilation at times specified by
3105 @var{letters}.  This is used for debugging the compiler.  The file names
3106 for most of the dumps are made by appending a pass number and a word to
3107 the @var{dumpname}. @var{dumpname} is generated from the name of the
3108 output file, if explicitly specified and it is not an executable,
3109 otherwise it is the basename of the source file. In both cases any
3110 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3111 Here are the possible letters for use in @var{letters}, and their
3112 meanings:
3114 @table @samp
3115 @item A
3116 @opindex dA
3117 Annotate the assembler output with miscellaneous debugging information.
3118 @item b
3119 @opindex db
3120 Dump after computing branch probabilities, to @file{@var{file}.16.bp}.
3121 @item B
3122 @opindex dB
3123 Dump after block reordering, to @file{@var{file}.32.bbro}.
3124 @item c
3125 @opindex dc
3126 Dump after instruction combination, to the file @file{@var{file}.22.combine}.
3127 @item C
3128 @opindex dC
3129 Dump after the first if conversion, to the file @file{@var{file}.17.ce1}.
3130 Also dump after the second if conversion, to the file @file{@var{file}.23.ce2}.
3131 @item d
3132 @opindex dd
3133 Dump after branch target load optimization, to to @file{@var{file}.34.btl}.
3134 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3135 @item D
3136 @opindex dD
3137 Dump all macro definitions, at the end of preprocessing, in addition to
3138 normal output.
3139 @item e
3140 @opindex de
3141 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
3142 @file{@var{file}.010.ussa}.
3143 @item E
3144 @opindex dE
3145 Dump after the second if conversion, to @file{@var{file}.33.ce3}.
3146 @item f
3147 @opindex df
3148 Dump after control and data flow analysis, to @file{@var{file}.15.cfg}.
3149 Also dump after life analysis, to @file{@var{file}.21.life}.
3150 @item F
3151 @opindex dF
3152 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.11.addressof}.
3153 @item g
3154 @opindex dg
3155 Dump after global register allocation, to @file{@var{file}.27.greg}.
3156 @item G
3157 @opindex dG
3158 Dump after GCSE, to @file{@var{file}.12.gcse}.
3159 Also dump after jump bypassing and control flow optimizations, to
3160 @file{@var{file}.14.bypass}.
3161 @item h
3162 @opindex dh
3163 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3164 @item i
3165 @opindex di
3166 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3167 @item j
3168 @opindex dj
3169 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3170 @item k
3171 @opindex dk
3172 Dump after conversion from registers to stack, to @file{@var{file}.36.stack}.
3173 @item l
3174 @opindex dl
3175 Dump after local register allocation, to @file{@var{file}.26.lreg}.
3176 @item L
3177 @opindex dL
3178 Dump after loop optimization passes, to @file{@var{file}.13.loop} and
3179 @file{@var{file}.19.loop2}.
3180 @item M
3181 @opindex dM
3182 Dump after performing the machine dependent reorganization pass, to
3183 @file{@var{file}.37.mach}.
3184 @item n
3185 @opindex dn
3186 Dump after register renumbering, to @file{@var{file}.31.rnreg}.
3187 @item N
3188 @opindex dN
3189 Dump after the register move pass, to @file{@var{file}.24.regmove}.
3190 @item o
3191 @opindex do
3192 Dump after post-reload optimizations, to @file{@var{file}.28.postreload}.
3193 @item r
3194 @opindex dr
3195 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3196 @item R
3197 @opindex dR
3198 Dump after the second scheduling pass, to @file{@var{file}.35.sched2}.
3199 @item s
3200 @opindex ds
3201 Dump after CSE (including the jump optimization that sometimes follows
3202 CSE), to @file{@var{file}.019.cse}.
3203 @item S
3204 @opindex dS
3205 Dump after the first scheduling pass, to @file{@var{file}.25.sched}.
3206 @item t
3207 @opindex dt
3208 Dump after the second CSE pass (including the jump optimization that
3209 sometimes follows CSE), to @file{@var{file}.20.cse2}.
3210 @item T
3211 @opindex dT
3212 Dump after running tracer, to @file{@var{file}.18.tracer}.
3213 @item u
3214 @opindex du
3215 Dump after null pointer elimination pass to @file{@var{file}.018.null}.
3216 @item U
3217 @opindex dU
3218 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3219 @item w
3220 @opindex dw
3221 Dump after the second flow pass, to @file{@var{file}.29.flow2}.
3222 @item W
3223 @opindex dW
3224 Dump after SSA conditional constant propagation, to
3225 @file{@var{file}.06.ssaccp}.
3226 @item X
3227 @opindex dX
3228 Dump after SSA dead code elimination, to @file{@var{file}.07.ssadce}.
3229 @item z
3230 @opindex dz
3231 Dump after the peephole pass, to @file{@var{file}.30.peephole2}.
3232 @item a
3233 @opindex da
3234 Produce all the dumps listed above.
3235 @item H
3236 @opindex dH
3237 Produce a core dump whenever an error occurs.
3238 @item m
3239 @opindex dm
3240 Print statistics on memory usage, at the end of the run, to
3241 standard error.
3242 @item p
3243 @opindex dp
3244 Annotate the assembler output with a comment indicating which
3245 pattern and alternative was used.  The length of each instruction is
3246 also printed.
3247 @item P
3248 @opindex dP
3249 Dump the RTL in the assembler output as a comment before each instruction.
3250 Also turns on @option{-dp} annotation.
3251 @item v
3252 @opindex dv
3253 For each of the other indicated dump files (except for
3254 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3255 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3256 @item x
3257 @opindex dx
3258 Just generate RTL for a function instead of compiling it.  Usually used
3259 with @samp{r}.
3260 @item y
3261 @opindex dy
3262 Dump debugging information during parsing, to standard error.
3263 @end table
3265 @item -fdump-unnumbered
3266 @opindex fdump-unnumbered
3267 When doing debugging dumps (see @option{-d} option above), suppress instruction
3268 numbers and line number note output.  This makes it more feasible to
3269 use diff on debugging dumps for compiler invocations with different
3270 options, in particular with and without @option{-g}.
3272 @item -fdump-translation-unit @r{(C and C++ only)}
3273 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3274 @opindex fdump-translation-unit
3275 Dump a representation of the tree structure for the entire translation
3276 unit to a file.  The file name is made by appending @file{.tu} to the
3277 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3278 controls the details of the dump as described for the
3279 @option{-fdump-tree} options.
3281 @item -fdump-class-hierarchy @r{(C++ only)}
3282 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3283 @opindex fdump-class-hierarchy
3284 Dump a representation of each class's hierarchy and virtual function
3285 table layout to a file.  The file name is made by appending @file{.class}
3286 to the source file name.  If the @samp{-@var{options}} form is used,
3287 @var{options} controls the details of the dump as described for the
3288 @option{-fdump-tree} options.
3290 @item -fdump-tree-@var{switch} @r{(C++ only)}
3291 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3292 @opindex fdump-tree
3293 Control the dumping at various stages of processing the intermediate
3294 language tree to a file.  The file name is generated by appending a switch
3295 specific suffix to the source file name.  If the @samp{-@var{options}}
3296 form is used, @var{options} is a list of @samp{-} separated options that
3297 control the details of the dump. Not all options are applicable to all
3298 dumps, those which are not meaningful will be ignored. The following
3299 options are available
3301 @table @samp
3302 @item address
3303 Print the address of each node.  Usually this is not meaningful as it
3304 changes according to the environment and source file. Its primary use
3305 is for tying up a dump file with a debug environment.
3306 @item slim
3307 Inhibit dumping of members of a scope or body of a function merely
3308 because that scope has been reached. Only dump such items when they
3309 are directly reachable by some other path.
3310 @item all
3311 Turn on all options.
3312 @end table
3314 The following tree dumps are possible:
3315 @table @samp
3316 @item original
3317 Dump before any tree based optimization, to @file{@var{file}.original}.
3318 @item optimized
3319 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3320 @item inlined
3321 Dump after function inlining, to @file{@var{file}.inlined}.
3322 @end table
3324 @item -frandom-seed=@var{string}
3325 @opindex frandom-string
3326 This option provides a seed that GCC uses when it would otherwise use
3327 random numbers.  It is used to generate certain symbol names
3328 that have to be different in every compiled file. It is also used to
3329 place unique stamps in coverage data files and the object files that
3330 produce them. You can use the @option{-frandom-seed} option to produce
3331 reproducibly identical object files.
3333 The @var{string} should be different for every file you compile.
3335 @item -fsched-verbose=@var{n}
3336 @opindex fsched-verbose
3337 On targets that use instruction scheduling, this option controls the
3338 amount of debugging output the scheduler prints.  This information is
3339 written to standard error, unless @option{-dS} or @option{-dR} is
3340 specified, in which case it is output to the usual dump
3341 listing file, @file{.sched} or @file{.sched2} respectively.  However
3342 for @var{n} greater than nine, the output is always printed to standard
3343 error.
3345 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3346 same information as @option{-dRS}.  For @var{n} greater than one, it
3347 also output basic block probabilities, detailed ready list information
3348 and unit/insn info.  For @var{n} greater than two, it includes RTL
3349 at abort point, control-flow and regions info.  And for @var{n} over
3350 four, @option{-fsched-verbose} also includes dependence info.
3352 @item -save-temps
3353 @opindex save-temps
3354 Store the usual ``temporary'' intermediate files permanently; place them
3355 in the current directory and name them based on the source file.  Thus,
3356 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3357 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3358 preprocessed @file{foo.i} output file even though the compiler now
3359 normally uses an integrated preprocessor.
3361 @item -time
3362 @opindex time
3363 Report the CPU time taken by each subprocess in the compilation
3364 sequence.  For C source files, this is the compiler proper and assembler
3365 (plus the linker if linking is done).  The output looks like this:
3367 @smallexample
3368 # cc1 0.12 0.01
3369 # as 0.00 0.01
3370 @end smallexample
3372 The first number on each line is the ``user time,'' that is time spent
3373 executing the program itself.  The second number is ``system time,''
3374 time spent executing operating system routines on behalf of the program.
3375 Both numbers are in seconds.
3377 @item -print-file-name=@var{library}
3378 @opindex print-file-name
3379 Print the full absolute name of the library file @var{library} that
3380 would be used when linking---and don't do anything else.  With this
3381 option, GCC does not compile or link anything; it just prints the
3382 file name.
3384 @item -print-multi-directory
3385 @opindex print-multi-directory
3386 Print the directory name corresponding to the multilib selected by any
3387 other switches present in the command line.  This directory is supposed
3388 to exist in @env{GCC_EXEC_PREFIX}.
3390 @item -print-multi-lib
3391 @opindex print-multi-lib
3392 Print the mapping from multilib directory names to compiler switches
3393 that enable them.  The directory name is separated from the switches by
3394 @samp{;}, and each switch starts with an @samp{@@} instead of the
3395 @samp{-}, without spaces between multiple switches.  This is supposed to
3396 ease shell-processing.
3398 @item -print-prog-name=@var{program}
3399 @opindex print-prog-name
3400 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3402 @item -print-libgcc-file-name
3403 @opindex print-libgcc-file-name
3404 Same as @option{-print-file-name=libgcc.a}.
3406 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3407 but you do want to link with @file{libgcc.a}.  You can do
3409 @example
3410 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3411 @end example
3413 @item -print-search-dirs
3414 @opindex print-search-dirs
3415 Print the name of the configured installation directory and a list of
3416 program and library directories gcc will search---and don't do anything else.
3418 This is useful when gcc prints the error message
3419 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3420 To resolve this you either need to put @file{cpp0} and the other compiler
3421 components where gcc expects to find them, or you can set the environment
3422 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3423 Don't forget the trailing '/'.
3424 @xref{Environment Variables}.
3426 @item -dumpmachine
3427 @opindex dumpmachine
3428 Print the compiler's target machine (for example,
3429 @samp{i686-pc-linux-gnu})---and don't do anything else.
3431 @item -dumpversion
3432 @opindex dumpversion
3433 Print the compiler version (for example, @samp{3.0})---and don't do
3434 anything else.
3436 @item -dumpspecs
3437 @opindex dumpspecs
3438 Print the compiler's built-in specs---and don't do anything else.  (This
3439 is used when GCC itself is being built.)  @xref{Spec Files}.
3441 @item -feliminate-unused-debug-types
3442 @opindex feliminate-unused-debug-types
3443 Normally, when producing DWARF2 output, GCC will emit debugging
3444 information for all types declared in a compilation
3445 unit, regardless of whether or not they are actually used
3446 in that compilation unit.  Sometimes this is useful, such as
3447 if, in the debugger, you want to cast a value to a type that is
3448 not actually used in your program (but is declared).  More often,
3449 however, this results in a significant amount of wasted space.
3450 With this option, GCC will avoid producing debug symbol output
3451 for types that are nowhere used in the source file being compiled.
3452 @end table
3454 @node Optimize Options
3455 @section Options That Control Optimization
3456 @cindex optimize options
3457 @cindex options, optimization
3459 These options control various sorts of optimizations.
3461 Without any optimization option, the compiler's goal is to reduce the
3462 cost of compilation and to make debugging produce the expected
3463 results.  Statements are independent: if you stop the program with a
3464 breakpoint between statements, you can then assign a new value to any
3465 variable or change the program counter to any other statement in the
3466 function and get exactly the results you would expect from the source
3467 code.
3469 Turning on optimization flags makes the compiler attempt to improve
3470 the performance and/or code size at the expense of compilation time
3471 and possibly the ability to debug the program.
3473 The compiler performs optimisation based on the knowledge it has of
3474 the program.  Using the @option{-funit-at-a-time} flag will allow the
3475 compiler to consider information gained from later functions in the
3476 file when compiling a function.  Compiling multiple files at once to a
3477 single output file (and using @option{-funit-at-a-time}) will allow
3478 the compiler to use information gained from all of the files when
3479 compiling each of them.
3481 Not all optimizations are controlled directly by a flag.  Only
3482 optimizations that have a flag are listed.
3484 @table @gcctabopt
3485 @item -O
3486 @itemx -O1
3487 @opindex O
3488 @opindex O1
3489 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3490 more memory for a large function.
3492 With @option{-O}, the compiler tries to reduce code size and execution
3493 time, without performing any optimizations that take a great deal of
3494 compilation time.
3496 @option{-O} turns on the following optimization flags: 
3497 @gccoptlist{-fdefer-pop @gol
3498 -fmerge-constants @gol
3499 -fthread-jumps @gol
3500 -floop-optimize @gol
3501 -fcrossjumping @gol
3502 -fif-conversion @gol
3503 -fif-conversion2 @gol
3504 -fdelayed-branch @gol
3505 -fguess-branch-probability @gol
3506 -fcprop-registers}
3508 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3509 where doing so does not interfere with debugging.
3511 @item -O2
3512 @opindex O2
3513 Optimize even more.  GCC performs nearly all supported optimizations
3514 that do not involve a space-speed tradeoff.  The compiler does not
3515 perform loop unrolling or function inlining when you specify @option{-O2}.
3516 As compared to @option{-O}, this option increases both compilation time
3517 and the performance of the generated code.
3519 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3520 also turns on the following optimization flags:
3521 @gccoptlist{-fforce-mem @gol
3522 -foptimize-sibling-calls @gol
3523 -fstrength-reduce @gol
3524 -fcse-follow-jumps  -fcse-skip-blocks @gol
3525 -frerun-cse-after-loop  -frerun-loop-opt @gol
3526 -fgcse   -fgcse-lm   -fgcse-sm @gol
3527 -fdelete-null-pointer-checks @gol
3528 -fexpensive-optimizations @gol
3529 -fregmove @gol
3530 -fschedule-insns  -fschedule-insns2 @gol
3531 -fsched-interblock  -fsched-spec @gol
3532 -fcaller-saves @gol
3533 -fpeephole2 @gol
3534 -freorder-blocks  -freorder-functions @gol
3535 -fstrict-aliasing @gol
3536 -falign-functions  -falign-jumps @gol
3537 -falign-loops  -falign-labels}
3539 Please note the warning under @option{-fgcse} about
3540 invoking @option{-O2} on programs that use computed gotos.
3542 @item -O3
3543 @opindex O3
3544 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3545 @option{-O2} and also turns on the @option{-finline-functions},
3546 @option{-funit-at-a-time} and @option{-frename-registers} options.
3548 @item -O0
3549 @opindex O0
3550 Do not optimize.  This is the default.
3552 @item -Os
3553 @opindex Os
3554 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3555 do not typically increase code size.  It also performs further
3556 optimizations designed to reduce code size.
3558 @option{-Os} disables the following optimization flags:
3559 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3560 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3562 If you use multiple @option{-O} options, with or without level numbers,
3563 the last such option is the one that is effective.
3564 @end table
3566 Options of the form @option{-f@var{flag}} specify machine-independent
3567 flags.  Most flags have both positive and negative forms; the negative
3568 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3569 below, only one of the forms is listed---the one you typically will
3570 use.  You can figure out the other form by either removing @samp{no-}
3571 or adding it.
3573 The following options control specific optimizations.  They are either
3574 activated by @option{-O} options or are related to ones that are.  You
3575 can use the following flags in the rare cases when ``fine-tuning'' of
3576 optimizations to be performed is desired.
3578 @table @gcctabopt
3579 @item -fno-default-inline
3580 @opindex fno-default-inline
3581 Do not make member functions inline by default merely because they are
3582 defined inside the class scope (C++ only).  Otherwise, when you specify
3583 @w{@option{-O}}, member functions defined inside class scope are compiled
3584 inline by default; i.e., you don't need to add @samp{inline} in front of
3585 the member function name.
3587 @item -fno-defer-pop
3588 @opindex fno-defer-pop
3589 Always pop the arguments to each function call as soon as that function
3590 returns.  For machines which must pop arguments after a function call,
3591 the compiler normally lets arguments accumulate on the stack for several
3592 function calls and pops them all at once.
3594 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3596 @item -fforce-mem
3597 @opindex fforce-mem
3598 Force memory operands to be copied into registers before doing
3599 arithmetic on them.  This produces better code by making all memory
3600 references potential common subexpressions.  When they are not common
3601 subexpressions, instruction combination should eliminate the separate
3602 register-load.
3604 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3606 @item -fforce-addr
3607 @opindex fforce-addr
3608 Force memory address constants to be copied into registers before
3609 doing arithmetic on them.  This may produce better code just as
3610 @option{-fforce-mem} may.
3612 @item -fomit-frame-pointer
3613 @opindex fomit-frame-pointer
3614 Don't keep the frame pointer in a register for functions that
3615 don't need one.  This avoids the instructions to save, set up and
3616 restore frame pointers; it also makes an extra register available
3617 in many functions.  @strong{It also makes debugging impossible on
3618 some machines.}
3620 On some machines, such as the VAX, this flag has no effect, because
3621 the standard calling sequence automatically handles the frame pointer
3622 and nothing is saved by pretending it doesn't exist.  The
3623 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3624 whether a target machine supports this flag.  @xref{Registers,,Register
3625 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3627 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3629 @item -foptimize-sibling-calls
3630 @opindex foptimize-sibling-calls
3631 Optimize sibling and tail recursive calls.
3633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3635 @item -fno-inline
3636 @opindex fno-inline
3637 Don't pay attention to the @code{inline} keyword.  Normally this option
3638 is used to keep the compiler from expanding any functions inline.
3639 Note that if you are not optimizing, no functions can be expanded inline.
3641 @item -finline-functions
3642 @opindex finline-functions
3643 Integrate all simple functions into their callers.  The compiler
3644 heuristically decides which functions are simple enough to be worth
3645 integrating in this way.
3647 If all calls to a given function are integrated, and the function is
3648 declared @code{static}, then the function is normally not output as
3649 assembler code in its own right.
3651 Enabled at level @option{-O3}.
3653 @item -finline-limit=@var{n}
3654 @opindex finline-limit
3655 By default, gcc limits the size of functions that can be inlined.  This flag
3656 allows the control of this limit for functions that are explicitly marked as
3657 inline (i.e., marked with the inline keyword or defined within the class
3658 definition in c++).  @var{n} is the size of functions that can be inlined in
3659 number of pseudo instructions (not counting parameter handling).  The default
3660 value of @var{n} is 600.
3661 Increasing this value can result in more inlined code at
3662 the cost of compilation time and memory consumption.  Decreasing usually makes
3663 the compilation faster and less code will be inlined (which presumably
3664 means slower programs).  This option is particularly useful for programs that
3665 use inlining heavily such as those based on recursive templates with C++.
3667 Inlining is actually controlled by a number of parameters, which may be
3668 specified individually by using @option{--param @var{name}=@var{value}}.
3669 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3670 as follows:
3672 @table @gcctabopt
3673  @item max-inline-insns
3674   is set to @var{n}.
3675  @item max-inline-insns-single
3676   is set to @var{n}/2.
3677  @item max-inline-insns-auto
3678   is set to @var{n}/2.
3679  @item min-inline-insns
3680   is set to 130 or @var{n}/4, whichever is smaller.
3681  @item max-inline-insns-rtl
3682   is set to @var{n}.
3683 @end table
3685 Using @option{-finline-limit=600} thus results in the default settings
3686 for these parameters.  See below for a documentation of the individual
3687 parameters controlling inlining.
3689 @emph{Note:} pseudo instruction represents, in this particular context, an
3690 abstract measurement of function's size.  In no way, it represents a count
3691 of assembly instructions and as such its exact meaning might change from one
3692 release to an another.
3694 @item -fkeep-inline-functions
3695 @opindex fkeep-inline-functions
3696 Even if all calls to a given function are integrated, and the function
3697 is declared @code{static}, nevertheless output a separate run-time
3698 callable version of the function.  This switch does not affect
3699 @code{extern inline} functions.
3701 @item -fkeep-static-consts
3702 @opindex fkeep-static-consts
3703 Emit variables declared @code{static const} when optimization isn't turned
3704 on, even if the variables aren't referenced.
3706 GCC enables this option by default.  If you want to force the compiler to
3707 check if the variable was referenced, regardless of whether or not
3708 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3710 @item -fmerge-constants
3711 Attempt to merge identical constants (string constants and floating point
3712 constants) across compilation units.
3714 This option is the default for optimized compilation if the assembler and
3715 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3716 behavior.
3718 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3720 @item -fmerge-all-constants
3721 Attempt to merge identical constants and identical variables.
3723 This option implies @option{-fmerge-constants}.  In addition to
3724 @option{-fmerge-constants} this considers e.g. even constant initialized
3725 arrays or initialized constant variables with integral or floating point
3726 types.  Languages like C or C++ require each non-automatic variable to
3727 have distinct location, so using this option will result in non-conforming
3728 behavior.
3730 @item -fnew-ra
3731 @opindex fnew-ra
3732 Use a graph coloring register allocator.  Currently this option is meant
3733 for testing, so we are interested to hear about miscompilations with
3734 @option{-fnew-ra}.
3736 @item -fno-branch-count-reg
3737 @opindex fno-branch-count-reg
3738 Do not use ``decrement and branch'' instructions on a count register,
3739 but instead generate a sequence of instructions that decrement a
3740 register, compare it against zero, then branch based upon the result.
3741 This option is only meaningful on architectures that support such
3742 instructions, which include x86, PowerPC, IA-64 and S/390.
3744 The default is @option{-fbranch-count-reg}, enabled when
3745 @option{-fstrength-reduce} is enabled.
3747 @item -fno-function-cse
3748 @opindex fno-function-cse
3749 Do not put function addresses in registers; make each instruction that
3750 calls a constant function contain the function's address explicitly.
3752 This option results in less efficient code, but some strange hacks
3753 that alter the assembler output may be confused by the optimizations
3754 performed when this option is not used.
3756 The default is @option{-ffunction-cse}
3758 @item -fno-zero-initialized-in-bss
3759 @opindex fno-zero-initialized-in-bss
3760 If the target supports a BSS section, GCC by default puts variables that
3761 are initialized to zero into BSS@.  This can save space in the resulting
3762 code.
3764 This option turns off this behavior because some programs explicitly
3765 rely on variables going to the data section.  E.g., so that the
3766 resulting executable can find the beginning of that section and/or make
3767 assumptions based on that.
3769 The default is @option{-fzero-initialized-in-bss}.
3771 @item -fstrength-reduce
3772 @opindex fstrength-reduce
3773 Perform the optimizations of loop strength reduction and
3774 elimination of iteration variables.
3776 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3778 @item -fthread-jumps
3779 @opindex fthread-jumps
3780 Perform optimizations where we check to see if a jump branches to a
3781 location where another comparison subsumed by the first is found.  If
3782 so, the first branch is redirected to either the destination of the
3783 second branch or a point immediately following it, depending on whether
3784 the condition is known to be true or false.
3786 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3788 @item -fcse-follow-jumps
3789 @opindex fcse-follow-jumps
3790 In common subexpression elimination, scan through jump instructions
3791 when the target of the jump is not reached by any other path.  For
3792 example, when CSE encounters an @code{if} statement with an
3793 @code{else} clause, CSE will follow the jump when the condition
3794 tested is false.
3796 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3798 @item -fcse-skip-blocks
3799 @opindex fcse-skip-blocks
3800 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3801 follow jumps which conditionally skip over blocks.  When CSE
3802 encounters a simple @code{if} statement with no else clause,
3803 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3804 body of the @code{if}.
3806 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3808 @item -frerun-cse-after-loop
3809 @opindex frerun-cse-after-loop
3810 Re-run common subexpression elimination after loop optimizations has been
3811 performed.
3813 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3815 @item -frerun-loop-opt
3816 @opindex frerun-loop-opt
3817 Run the loop optimizer twice.
3819 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3821 @item -fgcse
3822 @opindex fgcse
3823 Perform a global common subexpression elimination pass.
3824 This pass also performs global constant and copy propagation.
3826 @emph{Note:} When compiling a program using computed gotos, a GCC
3827 extension, you may get better runtime performance if you disable
3828 the global common subexpression elimination pass by adding
3829 @option{-fno-gcse} to the command line.
3831 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3833 @item -fgcse-lm
3834 @opindex fgcse-lm
3835 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3836 attempt to move loads which are only killed by stores into themselves.  This
3837 allows a loop containing a load/store sequence to be changed to a load outside
3838 the loop, and a copy/store within the loop.
3840 Enabled by default when gcse is enabled.
3842 @item -fgcse-sm
3843 @opindex fgcse-sm
3844 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3845 subexpression elimination.  This pass will attempt to move stores out of loops.
3846 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3847 can be changed to a load before the loop and a store after the loop.
3849 Enabled by default when gcse is enabled.
3851 @item -floop-optimize
3852 @opindex floop-optimize
3853 Perform loop optimizations: move constant expressions out of loops, simplify
3854 exit test conditions and optionally do strength-reduction and loop unrolling as
3855 well.
3857 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3859 @item -fcrossjumping
3860 @opindex crossjumping
3861 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3862 resulting code may or may not perform better than without cross-jumping.
3864 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3866 @item -fif-conversion
3867 @opindex if-conversion
3868 Attempt to transform conditional jumps into branch-less equivalents.  This
3869 include use of conditional moves, min, max, set flags and abs instructions, and
3870 some tricks doable by standard arithmetics.  The use of conditional execution
3871 on chips where it is available is controlled by @code{if-conversion2}.
3873 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3875 @item -fif-conversion2
3876 @opindex if-conversion2
3877 Use conditional execution (where available) to transform conditional jumps into
3878 branch-less equivalents.
3880 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3882 @item -fdelete-null-pointer-checks
3883 @opindex fdelete-null-pointer-checks
3884 Use global dataflow analysis to identify and eliminate useless checks
3885 for null pointers.  The compiler assumes that dereferencing a null
3886 pointer would have halted the program.  If a pointer is checked after
3887 it has already been dereferenced, it cannot be null.
3889 In some environments, this assumption is not true, and programs can
3890 safely dereference null pointers.  Use
3891 @option{-fno-delete-null-pointer-checks} to disable this optimization
3892 for programs which depend on that behavior.
3894 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3896 @item -fexpensive-optimizations
3897 @opindex fexpensive-optimizations
3898 Perform a number of minor optimizations that are relatively expensive.
3900 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3902 @item -foptimize-register-move
3903 @itemx -fregmove
3904 @opindex foptimize-register-move
3905 @opindex fregmove
3906 Attempt to reassign register numbers in move instructions and as
3907 operands of other simple instructions in order to maximize the amount of
3908 register tying.  This is especially helpful on machines with two-operand
3909 instructions.
3911 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3912 optimization.
3914 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3916 @item -fdelayed-branch
3917 @opindex fdelayed-branch
3918 If supported for the target machine, attempt to reorder instructions
3919 to exploit instruction slots available after delayed branch
3920 instructions.
3922 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3924 @item -fschedule-insns
3925 @opindex fschedule-insns
3926 If supported for the target machine, attempt to reorder instructions to
3927 eliminate execution stalls due to required data being unavailable.  This
3928 helps machines that have slow floating point or memory load instructions
3929 by allowing other instructions to be issued until the result of the load
3930 or floating point instruction is required.
3932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3934 @item -fschedule-insns2
3935 @opindex fschedule-insns2
3936 Similar to @option{-fschedule-insns}, but requests an additional pass of
3937 instruction scheduling after register allocation has been done.  This is
3938 especially useful on machines with a relatively small number of
3939 registers and where memory load instructions take more than one cycle.
3941 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3943 @item -fno-sched-interblock
3944 @opindex fno-sched-interblock
3945 Don't schedule instructions across basic blocks.  This is normally
3946 enabled by default when scheduling before register allocation, i.e.@:
3947 with @option{-fschedule-insns} or at @option{-O2} or higher.
3949 @item -fno-sched-spec
3950 @opindex fno-sched-spec
3951 Don't allow speculative motion of non-load instructions.  This is normally
3952 enabled by default when scheduling before register allocation, i.e.@:
3953 with @option{-fschedule-insns} or at @option{-O2} or higher.
3955 @item -fsched-spec-load
3956 @opindex fsched-spec-load
3957 Allow speculative motion of some load instructions.  This only makes
3958 sense when scheduling before register allocation, i.e.@: with
3959 @option{-fschedule-insns} or at @option{-O2} or higher.
3961 @item -fsched-spec-load-dangerous
3962 @opindex fsched-spec-load-dangerous
3963 Allow speculative motion of more load instructions.  This only makes
3964 sense when scheduling before register allocation, i.e.@: with
3965 @option{-fschedule-insns} or at @option{-O2} or higher.
3967 @item -fsched2-use-superblocks
3968 @opindex fsched2-use-superblocks
3969 When scheduling after register allocation, do use superblock scheduling
3970 algorithm.  Superblock scheduling allows motion across basic block boundaries
3971 resulting on faster schedules.  This option is experimental, as not all machine
3972 descriptions used by GCC model the CPU closely enough to avoid unreliable
3973 results from the algorithm. 
3975 This only makes sense when scheduling after register allocation, i.e.@: with
3976 @option{-fschedule-insns2} or at @option{-O2} or higher.
3978 @item -fsched2-use-traces
3979 @opindex fsched2-use-traces
3980 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3981 allocation and additionally perform code duplication in order to increase the
3982 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3983 trace formation.
3985 This mode should produce faster but significantly longer programs.  Also
3986 without @code{-fbranch-probabilities} the traces constructed may not match the
3987 reality and hurt the performance.  This only makes
3988 sense when scheduling after register allocation, i.e.@: with
3989 @option{-fschedule-insns2} or at @option{-O2} or higher.
3991 @item -fcaller-saves
3992 @opindex fcaller-saves
3993 Enable values to be allocated in registers that will be clobbered by
3994 function calls, by emitting extra instructions to save and restore the
3995 registers around such calls.  Such allocation is done only when it
3996 seems to result in better code than would otherwise be produced.
3998 This option is always enabled by default on certain machines, usually
3999 those which have no call-preserved registers to use instead.
4001 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4003 @item -fmove-all-movables
4004 @opindex fmove-all-movables
4005 Forces all invariant computations in loops to be moved
4006 outside the loop.
4008 @item -freduce-all-givs
4009 @opindex freduce-all-givs
4010 Forces all general-induction variables in loops to be
4011 strength-reduced.
4013 @emph{Note:} When compiling programs written in Fortran,
4014 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4015 by default when you use the optimizer.
4017 These options may generate better or worse code; results are highly
4018 dependent on the structure of loops within the source code.
4020 These two options are intended to be removed someday, once
4021 they have helped determine the efficacy of various
4022 approaches to improving loop optimizations.
4024 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4025 know how use of these options affects
4026 the performance of your production code.
4027 We're very interested in code that runs @emph{slower}
4028 when these options are @emph{enabled}.
4030 @item -fno-peephole
4031 @itemx -fno-peephole2
4032 @opindex fno-peephole
4033 @opindex fno-peephole2
4034 Disable any machine-specific peephole optimizations.  The difference
4035 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4036 are implemented in the compiler; some targets use one, some use the
4037 other, a few use both.
4039 @option{-fpeephole} is enabled by default.
4040 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4042 @item -fno-guess-branch-probability
4043 @opindex fno-guess-branch-probability
4044 Do not guess branch probabilities using a randomized model.
4046 Sometimes gcc will opt to use a randomized model to guess branch
4047 probabilities, when none are available from either profiling feedback
4048 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4049 different runs of the compiler on the same program may produce different
4050 object code.
4052 In a hard real-time system, people don't want different runs of the
4053 compiler to produce code that has different behavior; minimizing
4054 non-determinism is of paramount import.  This switch allows users to
4055 reduce non-determinism, possibly at the expense of inferior
4056 optimization.
4058 The default is @option{-fguess-branch-probability} at levels
4059 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4061 @item -freorder-blocks
4062 @opindex freorder-blocks
4063 Reorder basic blocks in the compiled function in order to reduce number of
4064 taken branches and improve code locality.
4066 Enabled at levels @option{-O2}, @option{-O3}.
4068 @item -freorder-functions
4069 @opindex freorder-functions
4070 Reorder basic blocks in the compiled function in order to reduce number of
4071 taken branches and improve code locality. This is implemented by using special
4072 subsections @code{text.hot} for most frequently executed functions and
4073 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4074 the linker so object file format must support named sections and linker must
4075 place them in a reasonable way.
4077 Also profile feedback must be available in to make this option effective.  See
4078 @option{-fprofile-arcs} for details.
4080 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4082 @item -fstrict-aliasing
4083 @opindex fstrict-aliasing
4084 Allows the compiler to assume the strictest aliasing rules applicable to
4085 the language being compiled.  For C (and C++), this activates
4086 optimizations based on the type of expressions.  In particular, an
4087 object of one type is assumed never to reside at the same address as an
4088 object of a different type, unless the types are almost the same.  For
4089 example, an @code{unsigned int} can alias an @code{int}, but not a
4090 @code{void*} or a @code{double}.  A character type may alias any other
4091 type.
4093 Pay special attention to code like this:
4094 @example
4095 union a_union @{
4096   int i;
4097   double d;
4100 int f() @{
4101   a_union t;
4102   t.d = 3.0;
4103   return t.i;
4105 @end example
4106 The practice of reading from a different union member than the one most
4107 recently written to (called ``type-punning'') is common.  Even with
4108 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4109 is accessed through the union type.  So, the code above will work as
4110 expected.  However, this code might not:
4111 @example
4112 int f() @{
4113   a_union t;
4114   int* ip;
4115   t.d = 3.0;
4116   ip = &t.i;
4117   return *ip;
4119 @end example
4121 Every language that wishes to perform language-specific alias analysis
4122 should define a function that computes, given an @code{tree}
4123 node, an alias set for the node.  Nodes in different alias sets are not
4124 allowed to alias.  For an example, see the C front-end function
4125 @code{c_get_alias_set}.
4127 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4129 @item -falign-functions
4130 @itemx -falign-functions=@var{n}
4131 @opindex falign-functions
4132 Align the start of functions to the next power-of-two greater than
4133 @var{n}, skipping up to @var{n} bytes.  For instance,
4134 @option{-falign-functions=32} aligns functions to the next 32-byte
4135 boundary, but @option{-falign-functions=24} would align to the next
4136 32-byte boundary only if this can be done by skipping 23 bytes or less.
4138 @option{-fno-align-functions} and @option{-falign-functions=1} are
4139 equivalent and mean that functions will not be aligned.
4141 Some assemblers only support this flag when @var{n} is a power of two;
4142 in that case, it is rounded up.
4144 If @var{n} is not specified or is zero, use a machine-dependent default.
4146 Enabled at levels @option{-O2}, @option{-O3}.
4148 @item -falign-labels
4149 @itemx -falign-labels=@var{n}
4150 @opindex falign-labels
4151 Align all branch targets to a power-of-two boundary, skipping up to
4152 @var{n} bytes like @option{-falign-functions}.  This option can easily
4153 make code slower, because it must insert dummy operations for when the
4154 branch target is reached in the usual flow of the code.
4156 @option{-fno-align-labels} and @option{-falign-labels=1} are
4157 equivalent and mean that labels will not be aligned.
4159 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4160 are greater than this value, then their values are used instead.
4162 If @var{n} is not specified or is zero, use a machine-dependent default
4163 which is very likely to be @samp{1}, meaning no alignment.
4165 Enabled at levels @option{-O2}, @option{-O3}.
4167 @item -falign-loops
4168 @itemx -falign-loops=@var{n}
4169 @opindex falign-loops
4170 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4171 like @option{-falign-functions}.  The hope is that the loop will be
4172 executed many times, which will make up for any execution of the dummy
4173 operations.
4175 @option{-fno-align-loops} and @option{-falign-loops=1} are
4176 equivalent and mean that loops will not be aligned.
4178 If @var{n} is not specified or is zero, use a machine-dependent default.
4180 Enabled at levels @option{-O2}, @option{-O3}.
4182 @item -falign-jumps
4183 @itemx -falign-jumps=@var{n}
4184 @opindex falign-jumps
4185 Align branch targets to a power-of-two boundary, for branch targets
4186 where the targets can only be reached by jumping, skipping up to @var{n}
4187 bytes like @option{-falign-functions}.  In this case, no dummy operations
4188 need be executed.
4190 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4191 equivalent and mean that loops will not be aligned.
4193 If @var{n} is not specified or is zero, use a machine-dependent default.
4195 Enabled at levels @option{-O2}, @option{-O3}.
4197 @item -frename-registers
4198 @opindex frename-registers
4199 Attempt to avoid false dependencies in scheduled code by making use
4200 of registers left over after register allocation.  This optimization
4201 will most benefit processors with lots of registers.  It can, however,
4202 make debugging impossible, since variables will no longer stay in
4203 a ``home register''.
4205 Enabled at levels @option{-O3}.
4207 @item -fno-cprop-registers
4208 @opindex fno-cprop-registers
4209 After register allocation and post-register allocation instruction splitting,
4210 we perform a copy-propagation pass to try to reduce scheduling dependencies
4211 and occasionally eliminate the copy.
4213 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4215 @end table
4217 The following options control compiler behavior regarding floating
4218 point arithmetic.  These options trade off between speed and
4219 correctness.  All must be specifically enabled.
4221 @table @gcctabopt
4222 @item -ffloat-store
4223 @opindex ffloat-store
4224 Do not store floating point variables in registers, and inhibit other
4225 options that might change whether a floating point value is taken from a
4226 register or memory.
4228 @cindex floating point precision
4229 This option prevents undesirable excess precision on machines such as
4230 the 68000 where the floating registers (of the 68881) keep more
4231 precision than a @code{double} is supposed to have.  Similarly for the
4232 x86 architecture.  For most programs, the excess precision does only
4233 good, but a few programs rely on the precise definition of IEEE floating
4234 point.  Use @option{-ffloat-store} for such programs, after modifying
4235 them to store all pertinent intermediate computations into variables.
4237 @item -ffast-math
4238 @opindex ffast-math
4239 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4240 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4241 @option{-fno-signaling-nans}.
4243 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4245 This option should never be turned on by any @option{-O} option since
4246 it can result in incorrect output for programs which depend on
4247 an exact implementation of IEEE or ISO rules/specifications for
4248 math functions.
4250 @item -fno-math-errno
4251 @opindex fno-math-errno
4252 Do not set ERRNO after calling math functions that are executed
4253 with a single instruction, e.g., sqrt.  A program that relies on
4254 IEEE exceptions for math error handling may want to use this flag
4255 for speed while maintaining IEEE arithmetic compatibility.
4257 This option should never be turned on by any @option{-O} option since
4258 it can result in incorrect output for programs which depend on
4259 an exact implementation of IEEE or ISO rules/specifications for
4260 math functions.
4262 The default is @option{-fmath-errno}.
4264 @item -funsafe-math-optimizations
4265 @opindex funsafe-math-optimizations
4266 Allow optimizations for floating-point arithmetic that (a) assume
4267 that arguments and results are valid and (b) may violate IEEE or
4268 ANSI standards.  When used at link-time, it may include libraries
4269 or startup files that change the default FPU control word or other
4270 similar optimizations.
4272 This option should never be turned on by any @option{-O} option since
4273 it can result in incorrect output for programs which depend on
4274 an exact implementation of IEEE or ISO rules/specifications for
4275 math functions.
4277 The default is @option{-fno-unsafe-math-optimizations}.
4279 @item -ffinite-math-only
4280 @opindex ffinite-math-only
4281 Allow optimizations for floating-point arithmetic that assume
4282 that arguments and results are not NaNs or +-Infs.
4284 This option should never be turned on by any @option{-O} option since
4285 it can result in incorrect output for programs which depend on
4286 an exact implementation of IEEE or ISO rules/specifications.
4288 The default is @option{-fno-finite-math-only}.
4290 @item -fno-trapping-math
4291 @opindex fno-trapping-math
4292 Compile code assuming that floating-point operations cannot generate
4293 user-visible traps.  These traps include division by zero, overflow,
4294 underflow, inexact result and invalid operation.  This option implies
4295 @option{-fno-signaling-nans}.  Setting this option may allow faster
4296 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4298 This option should never be turned on by any @option{-O} option since
4299 it can result in incorrect output for programs which depend on
4300 an exact implementation of IEEE or ISO rules/specifications for
4301 math functions.
4303 The default is @option{-ftrapping-math}.
4305 @item -fsignaling-nans
4306 @opindex fsignaling-nans
4307 Compile code assuming that IEEE signaling NaNs may generate user-visible
4308 traps during floating-point operations.  Setting this option disables
4309 optimizations that may change the number of exceptions visible with
4310 signaling NaNs.  This option implies @option{-ftrapping-math}.
4312 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4313 be defined.
4315 The default is @option{-fno-signaling-nans}.
4317 This option is experimental and does not currently guarantee to
4318 disable all GCC optimizations that affect signaling NaN behavior.
4320 @item -fsingle-precision-constant
4321 @opindex fsingle-precision-constant
4322 Treat floating point constant as single precision constant instead of
4323 implicitly converting it to double precision constant.
4326 @end table
4328 The following options control optimizations that may improve
4329 performance, but are not enabled by any @option{-O} options.  This
4330 section includes experimental options that may produce broken code.
4332 @table @gcctabopt
4333 @item -fbranch-probabilities
4334 @opindex fbranch-probabilities
4335 After running a program compiled with @option{-fprofile-arcs}
4336 (@pxref{Debugging Options,, Options for Debugging Your Program or
4337 @command{gcc}}), you can compile it a second time using
4338 @option{-fbranch-probabilities}, to improve optimizations based on
4339 the number of times each branch was taken.  When the program
4340 compiled with @option{-fprofile-arcs} exits it saves arc execution
4341 counts to a file called @file{@var{sourcename}.gcda} for each source
4342 file  The information in this data file is very dependent on the
4343 structure of the generated code, so you must use the same source code
4344 and the same optimization options for both compilations.
4346 With @option{-fbranch-probabilities}, GCC puts a 
4347 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4348 These can be used to improve optimization.  Currently, they are only
4349 used in one place: in @file{reorg.c}, instead of guessing which path a
4350 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4351 exactly determine which path is taken more often.
4353 @item -fprofile-values
4354 @opindex fprofile-values
4355 If combined with @option{-fprofile-arcs}, it adds code so that some
4356 data about values of expressions in the program is gathered.
4358 With @option{-fbranch-probabilities}, it reads back the data gathered
4359 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4360 notes to instructions for their later usage in optimizations.
4362 @item -fnew-ra
4363 @opindex fnew-ra
4364 Use a graph coloring register allocator.  Currently this option is meant
4365 for testing, so we are interested to hear about miscompilations with
4366 @option{-fnew-ra}.
4368 @item -ftracer
4369 @opindex ftracer
4370 Perform tail duplication to enlarge superblock size. This transformation
4371 simplifies the control flow of the function allowing other optimizations to do
4372 better job.
4374 @item -funit-at-a-time
4375 @opindex funit-at-a-time
4376 Parse the whole compilation unit before starting to produce code.
4377 This allows some extra optimizations to take place but consumes more
4378 memory.
4380 @item -funroll-loops
4381 @opindex funroll-loops
4382 Unroll loops whose number of iterations can be determined at compile time or
4383 upon entry to the loop.  @option{-funroll-loops} implies
4384 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4385 (i.e. complete removal of loops with small constant number of iterations).
4386 This option makes code larger, and may or may not make it run faster.
4388 @item -funroll-all-loops
4389 @opindex funroll-all-loops
4390 Unroll all loops, even if their number of iterations is uncertain when
4391 the loop is entered.  This usually makes programs run more slowly.
4392 @option{-funroll-all-loops} implies the same options as
4393 @option{-funroll-loops}.
4395 @item -fpeel-loops
4396 @opindex fpeel-loops
4397 Peels the loops for that there is enough information that they do not
4398 roll much (from profile feedback).  It also turns on complete loop peeling
4399 (i.e. complete removal of loops with small constant number of iterations).
4401 @item -funswitch-loops
4402 @opindex funswitch-loops
4403 Move branches with loop invariant conditions out of the loop, with duplicates
4404 of the loop on both branches (modified according to result of the condition).
4406 @item -fold-unroll-loops
4407 @opindex fold-unroll-loops
4408 Unroll loops whose number of iterations can be determined at compile
4409 time or upon entry to the loop, using the old loop unroller whose loop
4410 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4411 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4412 option makes code larger, and may or may not make it run faster.
4414 @item -fold-unroll-all-loops
4415 @opindex fold-unroll-all-loops
4416 Unroll all loops, even if their number of iterations is uncertain when
4417 the loop is entered. This is done using the old loop unroller whose loop
4418 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4419 @option{-fold-unroll-all-loops} implies the same options as
4420 @option{-fold-unroll-loops}.
4422 @item -funswitch-loops
4423 @opindex funswitch-loops
4424 Move branches with loop invariant conditions out of the loop, with duplicates
4425 of the loop on both branches (modified according to result of the condition).
4427 @item -funswitch-loops
4428 @opindex funswitch-loops
4429 Move branches with loop invariant conditions out of the loop, with duplicates
4430 of the loop on both branches (modified according to result of the condition).
4432 @item -fprefetch-loop-arrays
4433 @opindex fprefetch-loop-arrays
4434 If supported by the target machine, generate instructions to prefetch
4435 memory to improve the performance of loops that access large arrays.
4437 Disabled at level @option{-Os}.
4439 @item -ffunction-sections
4440 @itemx -fdata-sections
4441 @opindex ffunction-sections
4442 @opindex fdata-sections
4443 Place each function or data item into its own section in the output
4444 file if the target supports arbitrary sections.  The name of the
4445 function or the name of the data item determines the section's name
4446 in the output file.
4448 Use these options on systems where the linker can perform optimizations
4449 to improve locality of reference in the instruction space.  Most systems
4450 using the ELF object format and SPARC processors running Solaris 2 have
4451 linkers with such optimizations.  AIX may have these optimizations in
4452 the future.
4454 Only use these options when there are significant benefits from doing
4455 so.  When you specify these options, the assembler and linker will
4456 create larger object and executable files and will also be slower.
4457 You will not be able to use @code{gprof} on all systems if you
4458 specify this option and you may have problems with debugging if
4459 you specify both this option and @option{-g}.
4461 @item -fssa
4462 @opindex fssa
4463 Perform optimizations in static single assignment form.  Each function's
4464 flow graph is translated into SSA form, optimizations are performed, and
4465 the flow graph is translated back from SSA form.  Users should not
4466 specify this option, since it is not yet ready for production use.
4468 @item -fssa-ccp
4469 @opindex fssa-ccp
4470 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4471 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4473 @item -fssa-dce
4474 @opindex fssa-dce
4475 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4476 Like @option{-fssa}, this is an experimental feature.
4478 @item -fbranch-target-load-optimize
4479 @opindex fbranch-target-load-optimize
4480 Perform branch target register load optimization before prologue / epilogue
4481 threading.
4482 The use of target registers can typically be exposed only during reload,
4483 thus hoisting loads out of loops and doing inter-block scheduling needs
4484 a separate optimization pass.
4486 @item -fbranch-target-load-optimize2
4487 @opindex fbranch-target-load-optimize2
4488 Perform branch target register load optimization after prologue / epilogue
4489 threading.
4494 @item --param @var{name}=@var{value}
4495 @opindex param
4496 In some places, GCC uses various constants to control the amount of
4497 optimization that is done.  For example, GCC will not inline functions
4498 that contain more that a certain number of instructions.  You can
4499 control some of these constants on the command-line using the
4500 @option{--param} option.
4502 In each case, the @var{value} is an integer.  The allowable choices for
4503 @var{name} are given in the following table:
4505 @table @gcctabopt
4506 @item max-crossjump-edges
4507 The maximum number of incoming edges to consider for crossjumping.
4508 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4509 the number of edges incoming to each block.  Increasing values mean
4510 more aggressive optimization, making the compile time increase with
4511 probably small improvement in executable size.
4513 @item max-delay-slot-insn-search
4514 The maximum number of instructions to consider when looking for an
4515 instruction to fill a delay slot.  If more than this arbitrary number of
4516 instructions is searched, the time savings from filling the delay slot
4517 will be minimal so stop searching.  Increasing values mean more
4518 aggressive optimization, making the compile time increase with probably
4519 small improvement in executable run time.
4521 @item max-delay-slot-live-search
4522 When trying to fill delay slots, the maximum number of instructions to
4523 consider when searching for a block with valid live register
4524 information.  Increasing this arbitrarily chosen value means more
4525 aggressive optimization, increasing the compile time.  This parameter
4526 should be removed when the delay slot code is rewritten to maintain the
4527 control-flow graph.
4529 @item max-gcse-memory
4530 The approximate maximum amount of memory that will be allocated in
4531 order to perform the global common subexpression elimination
4532 optimization.  If more memory than specified is required, the
4533 optimization will not be done.
4535 @item max-gcse-passes
4536 The maximum number of passes of GCSE to run.
4538 @item max-pending-list-length
4539 The maximum number of pending dependencies scheduling will allow
4540 before flushing the current state and starting over.  Large functions
4541 with few branches or calls can create excessively large lists which
4542 needlessly consume memory and resources.
4544 @item max-inline-insns-single
4545 Several parameters control the tree inliner used in gcc.
4546 This number sets the maximum number of instructions (counted in gcc's
4547 internal representation) in a single function that the tree inliner 
4548 will consider for inlining.  This only affects functions declared
4549 inline and methods implemented in a class declaration (C++).
4550 The default value is 100.
4552 @item max-inline-insns-auto
4553 When you use @option{-finline-functions} (included in @option{-O3}),
4554 a lot of functions that would otherwise not be considered for inlining
4555 by the compiler will be investigated.  To those functions, a different
4556 (more restrictive) limit compared to functions declared inline can
4557 be applied.
4558 The default value is 100.
4560 @item max-inline-insns
4561 The tree inliner does decrease the allowable size for single functions 
4562 to be inlined after we already inlined the number of instructions
4563 given here by repeated inlining.  This number should be a factor of 
4564 two or more larger than the single function limit.
4565 Higher numbers result in better runtime performance, but incur higher
4566 compile-time resource (CPU time, memory) requirements and result in
4567 larger binaries.  Very high values are not advisable, as too large
4568 binaries may adversely affect runtime performance.
4569 The default value is 200.
4571 @item max-inline-slope
4572 After exceeding the maximum number of inlined instructions by repeated
4573 inlining, a linear function is used to decrease the allowable size
4574 for single functions.  The slope of that function is the negative
4575 reciprocal of the number specified here.
4576 This parameter is ignored when @option{-funit-at-a-time} is used.
4577 The default value is 32.
4579 @item min-inline-insns
4580 The repeated inlining is throttled more and more by the linear function
4581 after exceeding the limit.  To avoid too much throttling, a minimum for
4582 this function is specified here to allow repeated inlining for very small
4583 functions even when a lot of repeated inlining already has been done.
4584 This parameter is ignored when @option{-funit-at-a-time} is used.
4585 The default value is 10.
4587 @item large-function-insns
4588 The limit specifying really large functions.  For functions greater than this
4589 limit inlining is constrained by @option{--param large-function-growth}.
4590 This parameter is usefull primarily to avoid extreme compilation time caused by non-linear
4591 algorithms used by the backend.
4592 This parameter is ignored when @option{-funit-at-a-time} is not used.
4593 The default value is 30000.
4595 @item large-function-growth
4596 Specifies maximal growth of large functtion caused by inlining in percents.
4597 This parameter is ignored when @option{-funit-at-a-time} is not used.
4598 The default value is 200.
4600 @item inline-unit-growth
4601 Specifies maximal overall growth of the compilation unit caused by inlining.
4602 This parameter is ignored when @option{-funit-at-a-time} is not used.
4603 The default value is 150.
4605 @item max-inline-insns-rtl
4606 For languages that use the RTL inliner (this happens at a later stage
4607 than tree inlining), you can set the maximum allowable size (counted 
4608 in RTL instructions) for the RTL inliner with this parameter.
4609 The default value is 600.
4612 @item max-unrolled-insns
4613 The maximum number of instructions that a loop should have if that loop
4614 is unrolled, and if the loop is unrolled, it determines how many times
4615 the loop code is unrolled.
4617 @item max-average-unrolled-insns
4618 The maximum number of instructions biased by probabilities of their execution
4619 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4620 it determines how many times the loop code is unrolled.
4622 @item max-unroll-times
4623 The maximum number of unrollings of a single loop.
4625 @item max-peeled-insns
4626 The maximum number of instructions that a loop should have if that loop
4627 is peeled, and if the loop is peeled, it determines how many times
4628 the loop code is peeled.
4630 @item max-peel-times
4631 The maximum number of peelings of a single loop.
4633 @item max-completely-peeled-insns
4634 The maximum number of insns of a completely peeled loop.
4636 @item max-completely-peel-times
4637 The maximum number of iterations of a loop to be suitable for complete peeling.
4639 @item max-unswitch-insns
4640 The maximum number of insns of an unswitched loop.
4642 @item max-unswitch-level
4643 The maximum number of branches unswitched in a single loop.
4645 @item hot-bb-count-fraction
4646 Select fraction of the maximal count of repetitions of basic block in program
4647 given basic block needs to have to be considered hot.
4649 @item hot-bb-frequency-fraction
4650 Select fraction of the maximal frequency of executions of basic block in
4651 function given basic block needs to have to be considered hot
4653 @item tracer-dynamic-coverage
4654 @itemx tracer-dynamic-coverage-feedback
4656 This value is used to limit superblock formation once the given percentage of
4657 executed instructions is covered.  This limits unnecessary code size
4658 expansion.
4660 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4661 feedback is available.  The real profiles (as opposed to statically estimated
4662 ones) are much less balanced allowing the threshold to be larger value.
4664 @item tracer-max-code-growth
4665 Stop tail duplication once code growth has reached given percentage.  This is
4666 rather hokey argument, as most of the duplicates will be eliminated later in
4667 cross jumping, so it may be set to much higher values than is the desired code
4668 growth.
4670 @item tracer-min-branch-ratio
4672 Stop reverse growth when the reverse probability of best edge is less than this
4673 threshold (in percent).
4675 @item tracer-min-branch-ratio
4676 @itemx tracer-min-branch-ratio-feedback
4678 Stop forward growth if the best edge do have probability lower than this
4679 threshold.
4681 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4682 compilation for profile feedback and one for compilation without.  The value
4683 for compilation with profile feedback needs to be more conservative (higher) in
4684 order to make tracer effective.
4686 @item max-cse-path-length
4688 Maximum number of basic blocks on path that cse considers.
4690 @item ggc-min-expand
4692 GCC uses a garbage collector to manage its own memory allocation.  This
4693 parameter specifies the minimum percentage by which the garbage
4694 collector's heap should be allowed to expand between collections.
4695 Tuning this may improve compilation speed; it has no effect on code
4696 generation.
4698 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4699 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4700 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4701 GCC is not able to calculate RAM on a particular platform, the lower
4702 bound of 30% is used.  Setting this parameter and
4703 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4704 every opportunity.  This is extremely slow, but can be useful for
4705 debugging.
4707 @item ggc-min-heapsize
4709 Minimum size of the garbage collector's heap before it begins bothering
4710 to collect garbage.  The first collection occurs after the heap expands
4711 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4712 tuning this may improve compilation speed, and has no effect on code
4713 generation.
4715 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4716 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4717 available, the notion of "RAM" is the smallest of actual RAM,
4718 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4719 RAM on a particular platform, the lower bound is used.  Setting this
4720 parameter very large effectively disables garbage collection.  Setting
4721 this parameter and @option{ggc-min-expand} to zero causes a full
4722 collection to occur at every opportunity.
4724 @item reorder-blocks-duplicate
4725 @itemx reorder-blocks-duplicate-feedback
4727 Used by basic block reordering pass to decide whether to use unconditional
4728 branch or duplicate the code on its destination.  Code is duplicated when its
4729 estimated size is smaller than this value multiplied by the estimated size of
4730 unconditional jump in the hot spots of the program.
4732 The @option{reorder-block-duplicate-feedback} is used only when profile
4733 feedback is available and may be set to higher values than
4734 @option{reorder-block-duplicate} since information about the hot spots is more
4735 accurate.
4736 @end table
4737 @end table
4739 @node Preprocessor Options
4740 @section Options Controlling the Preprocessor
4741 @cindex preprocessor options
4742 @cindex options, preprocessor
4744 These options control the C preprocessor, which is run on each C source
4745 file before actual compilation.
4747 If you use the @option{-E} option, nothing is done except preprocessing.
4748 Some of these options make sense only together with @option{-E} because
4749 they cause the preprocessor output to be unsuitable for actual
4750 compilation.
4752 @table @gcctabopt
4753 @opindex Wp
4754 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4755 and pass @var{option} directly through to the preprocessor.  If
4756 @var{option} contains commas, it is split into multiple options at the
4757 commas.  However, many options are modified, translated or interpreted
4758 by the compiler driver before being passed to the preprocessor, and
4759 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4760 interface is undocumented and subject to change, so whenever possible
4761 you should avoid using @option{-Wp} and let the driver handle the
4762 options instead.
4764 @item -Xpreprocessor @var{option}
4765 @opindex preprocessor
4766 Pass @var{option} as an option to the preprocessor.  You can use this to
4767 supply system-specific preprocessor options which GCC does not know how to
4768 recognize.
4770 If you want to pass an option that takes an argument, you must use
4771 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4772 @end table
4774 @include cppopts.texi
4776 @node Assembler Options
4777 @section Passing Options to the Assembler
4779 @c prevent bad page break with this line
4780 You can pass options to the assembler.
4782 @table @gcctabopt
4783 @item -Wa,@var{option}
4784 @opindex Wa
4785 Pass @var{option} as an option to the assembler.  If @var{option}
4786 contains commas, it is split into multiple options at the commas.
4788 @item -Xassembler @var{option}
4789 @opindex Xassembler
4790 Pass @var{option} as an option to the assembler.  You can use this to
4791 supply system-specific assembler options which GCC does not know how to
4792 recognize.
4794 If you want to pass an option that takes an argument, you must use
4795 @option{-Xassembler} twice, once for the option and once for the argument.
4797 @end table
4799 @node Link Options
4800 @section Options for Linking
4801 @cindex link options
4802 @cindex options, linking
4804 These options come into play when the compiler links object files into
4805 an executable output file.  They are meaningless if the compiler is
4806 not doing a link step.
4808 @table @gcctabopt
4809 @cindex file names
4810 @item @var{object-file-name}
4811 A file name that does not end in a special recognized suffix is
4812 considered to name an object file or library.  (Object files are
4813 distinguished from libraries by the linker according to the file
4814 contents.)  If linking is done, these object files are used as input
4815 to the linker.
4817 @item -c
4818 @itemx -S
4819 @itemx -E
4820 @opindex c
4821 @opindex S
4822 @opindex E
4823 If any of these options is used, then the linker is not run, and
4824 object file names should not be used as arguments.  @xref{Overall
4825 Options}.
4827 @cindex Libraries
4828 @item -l@var{library}
4829 @itemx -l @var{library}
4830 @opindex l
4831 Search the library named @var{library} when linking.  (The second
4832 alternative with the library as a separate argument is only for
4833 POSIX compliance and is not recommended.)
4835 It makes a difference where in the command you write this option; the
4836 linker searches and processes libraries and object files in the order they
4837 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4838 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4839 to functions in @samp{z}, those functions may not be loaded.
4841 The linker searches a standard list of directories for the library,
4842 which is actually a file named @file{lib@var{library}.a}.  The linker
4843 then uses this file as if it had been specified precisely by name.
4845 The directories searched include several standard system directories
4846 plus any that you specify with @option{-L}.
4848 Normally the files found this way are library files---archive files
4849 whose members are object files.  The linker handles an archive file by
4850 scanning through it for members which define symbols that have so far
4851 been referenced but not defined.  But if the file that is found is an
4852 ordinary object file, it is linked in the usual fashion.  The only
4853 difference between using an @option{-l} option and specifying a file name
4854 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4855 and searches several directories.
4857 @item -lobjc
4858 @opindex lobjc
4859 You need this special case of the @option{-l} option in order to
4860 link an Objective-C program.
4862 @item -nostartfiles
4863 @opindex nostartfiles
4864 Do not use the standard system startup files when linking.
4865 The standard system libraries are used normally, unless @option{-nostdlib}
4866 or @option{-nodefaultlibs} is used.
4868 @item -nodefaultlibs
4869 @opindex nodefaultlibs
4870 Do not use the standard system libraries when linking.
4871 Only the libraries you specify will be passed to the linker.
4872 The standard startup files are used normally, unless @option{-nostartfiles}
4873 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4874 for System V (and ISO C) environments or to bcopy and bzero for
4875 BSD environments.  These entries are usually resolved by entries in
4876 libc.  These entry points should be supplied through some other
4877 mechanism when this option is specified.
4879 @item -nostdlib
4880 @opindex nostdlib
4881 Do not use the standard system startup files or libraries when linking.
4882 No startup files and only the libraries you specify will be passed to
4883 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4884 for System V (and ISO C) environments or to bcopy and bzero for
4885 BSD environments.  These entries are usually resolved by entries in
4886 libc.  These entry points should be supplied through some other
4887 mechanism when this option is specified.
4889 @cindex @option{-lgcc}, use with @option{-nostdlib}
4890 @cindex @option{-nostdlib} and unresolved references
4891 @cindex unresolved references and @option{-nostdlib}
4892 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4893 @cindex @option{-nodefaultlibs} and unresolved references
4894 @cindex unresolved references and @option{-nodefaultlibs}
4895 One of the standard libraries bypassed by @option{-nostdlib} and
4896 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4897 that GCC uses to overcome shortcomings of particular machines, or special
4898 needs for some languages.
4899 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4900 Collection (GCC) Internals},
4901 for more discussion of @file{libgcc.a}.)
4902 In most cases, you need @file{libgcc.a} even when you want to avoid
4903 other standard libraries.  In other words, when you specify @option{-nostdlib}
4904 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4905 This ensures that you have no unresolved references to internal GCC
4906 library subroutines.  (For example, @samp{__main}, used to ensure C++
4907 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4908 GNU Compiler Collection (GCC) Internals}.)
4910 @item -pie
4911 @opindex pie
4912 Produce a position independent executable on targets which support it.
4913 For predictable results, you must also specify the same set of options
4914 that were used to generate code (@option{-fpie}, @option{-fPIE},
4915 or model suboptions) when you specify this option.
4917 @item -s
4918 @opindex s
4919 Remove all symbol table and relocation information from the executable.
4921 @item -static
4922 @opindex static
4923 On systems that support dynamic linking, this prevents linking with the shared
4924 libraries.  On other systems, this option has no effect.
4926 @item -shared
4927 @opindex shared
4928 Produce a shared object which can then be linked with other objects to
4929 form an executable.  Not all systems support this option.  For predictable
4930 results, you must also specify the same set of options that were used to
4931 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4932 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4933 needs to build supplementary stub code for constructors to work.  On
4934 multi-libbed systems, @samp{gcc -shared} must select the correct support
4935 libraries to link against.  Failing to supply the correct flags may lead
4936 to subtle defects.  Supplying them in cases where they are not necessary
4937 is innocuous.}
4939 @item -shared-libgcc
4940 @itemx -static-libgcc
4941 @opindex shared-libgcc
4942 @opindex static-libgcc
4943 On systems that provide @file{libgcc} as a shared library, these options
4944 force the use of either the shared or static version respectively.
4945 If no shared version of @file{libgcc} was built when the compiler was
4946 configured, these options have no effect.
4948 There are several situations in which an application should use the
4949 shared @file{libgcc} instead of the static version.  The most common
4950 of these is when the application wishes to throw and catch exceptions
4951 across different shared libraries.  In that case, each of the libraries
4952 as well as the application itself should use the shared @file{libgcc}.
4954 Therefore, the G++ and GCJ drivers automatically add
4955 @option{-shared-libgcc} whenever you build a shared library or a main
4956 executable, because C++ and Java programs typically use exceptions, so
4957 this is the right thing to do.
4959 If, instead, you use the GCC driver to create shared libraries, you may
4960 find that they will not always be linked with the shared @file{libgcc}.
4961 If GCC finds, at its configuration time, that you have a GNU linker that
4962 does not support option @option{--eh-frame-hdr}, it will link the shared
4963 version of @file{libgcc} into shared libraries by default.  Otherwise,
4964 it will take advantage of the linker and optimize away the linking with
4965 the shared version of @file{libgcc}, linking with the static version of
4966 libgcc by default.  This allows exceptions to propagate through such
4967 shared libraries, without incurring relocation costs at library load
4968 time.
4970 However, if a library or main executable is supposed to throw or catch
4971 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4972 for the languages used in the program, or using the option
4973 @option{-shared-libgcc}, such that it is linked with the shared
4974 @file{libgcc}.
4976 @item -symbolic
4977 @opindex symbolic
4978 Bind references to global symbols when building a shared object.  Warn
4979 about any unresolved references (unless overridden by the link editor
4980 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4981 this option.
4983 @item -Xlinker @var{option}
4984 @opindex Xlinker
4985 Pass @var{option} as an option to the linker.  You can use this to
4986 supply system-specific linker options which GCC does not know how to
4987 recognize.
4989 If you want to pass an option that takes an argument, you must use
4990 @option{-Xlinker} twice, once for the option and once for the argument.
4991 For example, to pass @option{-assert definitions}, you must write
4992 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4993 @option{-Xlinker "-assert definitions"}, because this passes the entire
4994 string as a single argument, which is not what the linker expects.
4996 @item -Wl,@var{option}
4997 @opindex Wl
4998 Pass @var{option} as an option to the linker.  If @var{option} contains
4999 commas, it is split into multiple options at the commas.
5001 @item -u @var{symbol}
5002 @opindex u
5003 Pretend the symbol @var{symbol} is undefined, to force linking of
5004 library modules to define it.  You can use @option{-u} multiple times with
5005 different symbols to force loading of additional library modules.
5006 @end table
5008 @node Directory Options
5009 @section Options for Directory Search
5010 @cindex directory options
5011 @cindex options, directory search
5012 @cindex search path
5014 These options specify directories to search for header files, for
5015 libraries and for parts of the compiler:
5017 @table @gcctabopt
5018 @item -I@var{dir}
5019 @opindex I
5020 Add the directory @var{dir} to the head of the list of directories to be
5021 searched for header files.  This can be used to override a system header
5022 file, substituting your own version, since these directories are
5023 searched before the system header file directories.  However, you should
5024 not use this option to add directories that contain vendor-supplied
5025 system header files (use @option{-isystem} for that).  If you use more than
5026 one @option{-I} option, the directories are scanned in left-to-right
5027 order; the standard system directories come after.
5029 If a standard system include directory, or a directory specified with
5030 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5031 option will be ignored.  The directory will still be searched but as a
5032 system directory at its normal position in the system include chain.
5033 This is to ensure that GCC's procedure to fix buggy system headers and
5034 the ordering for the include_next directive are not inadvertently changed.
5035 If you really need to change the search order for system directories,
5036 use the @option{-nostdinc} and/or @option{-isystem} options.
5038 @item -I-
5039 @opindex I-
5040 Any directories you specify with @option{-I} options before the @option{-I-}
5041 option are searched only for the case of @samp{#include "@var{file}"};
5042 they are not searched for @samp{#include <@var{file}>}.
5044 If additional directories are specified with @option{-I} options after
5045 the @option{-I-}, these directories are searched for all @samp{#include}
5046 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5047 this way.)
5049 In addition, the @option{-I-} option inhibits the use of the current
5050 directory (where the current input file came from) as the first search
5051 directory for @samp{#include "@var{file}"}.  There is no way to
5052 override this effect of @option{-I-}.  With @option{-I.} you can specify
5053 searching the directory which was current when the compiler was
5054 invoked.  That is not exactly the same as what the preprocessor does
5055 by default, but it is often satisfactory.
5057 @option{-I-} does not inhibit the use of the standard system directories
5058 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5059 independent.
5061 @item -L@var{dir}
5062 @opindex L
5063 Add directory @var{dir} to the list of directories to be searched
5064 for @option{-l}.
5066 @item -B@var{prefix}
5067 @opindex B
5068 This option specifies where to find the executables, libraries,
5069 include files, and data files of the compiler itself.
5071 The compiler driver program runs one or more of the subprograms
5072 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5073 @var{prefix} as a prefix for each program it tries to run, both with and
5074 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5076 For each subprogram to be run, the compiler driver first tries the
5077 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5078 was not specified, the driver tries two standard prefixes, which are
5079 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
5080 those results in a file name that is found, the unmodified program
5081 name is searched for using the directories specified in your
5082 @env{PATH} environment variable.
5084 The compiler will check to see if the path provided by the @option{-B}
5085 refers to a directory, and if necessary it will add a directory
5086 separator character at the end of the path.
5088 @option{-B} prefixes that effectively specify directory names also apply
5089 to libraries in the linker, because the compiler translates these
5090 options into @option{-L} options for the linker.  They also apply to
5091 includes files in the preprocessor, because the compiler translates these
5092 options into @option{-isystem} options for the preprocessor.  In this case,
5093 the compiler appends @samp{include} to the prefix.
5095 The run-time support file @file{libgcc.a} can also be searched for using
5096 the @option{-B} prefix, if needed.  If it is not found there, the two
5097 standard prefixes above are tried, and that is all.  The file is left
5098 out of the link if it is not found by those means.
5100 Another way to specify a prefix much like the @option{-B} prefix is to use
5101 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5102 Variables}.
5104 As a special kludge, if the path provided by @option{-B} is
5105 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5106 9, then it will be replaced by @file{[dir/]include}.  This is to help
5107 with boot-strapping the compiler.
5109 @item -specs=@var{file}
5110 @opindex specs
5111 Process @var{file} after the compiler reads in the standard @file{specs}
5112 file, in order to override the defaults that the @file{gcc} driver
5113 program uses when determining what switches to pass to @file{cc1},
5114 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5115 @option{-specs=@var{file}} can be specified on the command line, and they
5116 are processed in order, from left to right.
5117 @end table
5119 @c man end
5121 @node Spec Files
5122 @section Specifying subprocesses and the switches to pass to them
5123 @cindex Spec Files
5125 @command{gcc} is a driver program.  It performs its job by invoking a
5126 sequence of other programs to do the work of compiling, assembling and
5127 linking.  GCC interprets its command-line parameters and uses these to
5128 deduce which programs it should invoke, and which command-line options
5129 it ought to place on their command lines.  This behavior is controlled
5130 by @dfn{spec strings}.  In most cases there is one spec string for each
5131 program that GCC can invoke, but a few programs have multiple spec
5132 strings to control their behavior.  The spec strings built into GCC can
5133 be overridden by using the @option{-specs=} command-line switch to specify
5134 a spec file.
5136 @dfn{Spec files} are plaintext files that are used to construct spec
5137 strings.  They consist of a sequence of directives separated by blank
5138 lines.  The type of directive is determined by the first non-whitespace
5139 character on the line and it can be one of the following:
5141 @table @code
5142 @item %@var{command}
5143 Issues a @var{command} to the spec file processor.  The commands that can
5144 appear here are:
5146 @table @code
5147 @item %include <@var{file}>
5148 @cindex %include
5149 Search for @var{file} and insert its text at the current point in the
5150 specs file.
5152 @item %include_noerr <@var{file}>
5153 @cindex %include_noerr
5154 Just like @samp{%include}, but do not generate an error message if the include
5155 file cannot be found.
5157 @item %rename @var{old_name} @var{new_name}
5158 @cindex %rename
5159 Rename the spec string @var{old_name} to @var{new_name}.
5161 @end table
5163 @item *[@var{spec_name}]:
5164 This tells the compiler to create, override or delete the named spec
5165 string.  All lines after this directive up to the next directive or
5166 blank line are considered to be the text for the spec string.  If this
5167 results in an empty string then the spec will be deleted.  (Or, if the
5168 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5169 does not currently exist a new spec will be created.  If the spec does
5170 exist then its contents will be overridden by the text of this
5171 directive, unless the first character of that text is the @samp{+}
5172 character, in which case the text will be appended to the spec.
5174 @item [@var{suffix}]:
5175 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5176 and up to the next directive or blank line are considered to make up the
5177 spec string for the indicated suffix.  When the compiler encounters an
5178 input file with the named suffix, it will processes the spec string in
5179 order to work out how to compile that file.  For example:
5181 @smallexample
5182 .ZZ:
5183 z-compile -input %i
5184 @end smallexample
5186 This says that any input file whose name ends in @samp{.ZZ} should be
5187 passed to the program @samp{z-compile}, which should be invoked with the
5188 command-line switch @option{-input} and with the result of performing the
5189 @samp{%i} substitution.  (See below.)
5191 As an alternative to providing a spec string, the text that follows a
5192 suffix directive can be one of the following:
5194 @table @code
5195 @item @@@var{language}
5196 This says that the suffix is an alias for a known @var{language}.  This is
5197 similar to using the @option{-x} command-line switch to GCC to specify a
5198 language explicitly.  For example:
5200 @smallexample
5201 .ZZ:
5202 @@c++
5203 @end smallexample
5205 Says that .ZZ files are, in fact, C++ source files.
5207 @item #@var{name}
5208 This causes an error messages saying:
5210 @smallexample
5211 @var{name} compiler not installed on this system.
5212 @end smallexample
5213 @end table
5215 GCC already has an extensive list of suffixes built into it.
5216 This directive will add an entry to the end of the list of suffixes, but
5217 since the list is searched from the end backwards, it is effectively
5218 possible to override earlier entries using this technique.
5220 @end table
5222 GCC has the following spec strings built into it.  Spec files can
5223 override these strings or create their own.  Note that individual
5224 targets can also add their own spec strings to this list.
5226 @smallexample
5227 asm          Options to pass to the assembler
5228 asm_final    Options to pass to the assembler post-processor
5229 cpp          Options to pass to the C preprocessor
5230 cc1          Options to pass to the C compiler
5231 cc1plus      Options to pass to the C++ compiler
5232 endfile      Object files to include at the end of the link
5233 link         Options to pass to the linker
5234 lib          Libraries to include on the command line to the linker
5235 libgcc       Decides which GCC support library to pass to the linker
5236 linker       Sets the name of the linker
5237 predefines   Defines to be passed to the C preprocessor
5238 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5239              by default
5240 startfile    Object files to include at the start of the link
5241 @end smallexample
5243 Here is a small example of a spec file:
5245 @smallexample
5246 %rename lib                 old_lib
5248 *lib:
5249 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5250 @end smallexample
5252 This example renames the spec called @samp{lib} to @samp{old_lib} and
5253 then overrides the previous definition of @samp{lib} with a new one.
5254 The new definition adds in some extra command-line options before
5255 including the text of the old definition.
5257 @dfn{Spec strings} are a list of command-line options to be passed to their
5258 corresponding program.  In addition, the spec strings can contain
5259 @samp{%}-prefixed sequences to substitute variable text or to
5260 conditionally insert text into the command line.  Using these constructs
5261 it is possible to generate quite complex command lines.
5263 Here is a table of all defined @samp{%}-sequences for spec
5264 strings.  Note that spaces are not generated automatically around the
5265 results of expanding these sequences.  Therefore you can concatenate them
5266 together or combine them with constant text in a single argument.
5268 @table @code
5269 @item %%
5270 Substitute one @samp{%} into the program name or argument.
5272 @item %i
5273 Substitute the name of the input file being processed.
5275 @item %b
5276 Substitute the basename of the input file being processed.
5277 This is the substring up to (and not including) the last period
5278 and not including the directory.
5280 @item %B
5281 This is the same as @samp{%b}, but include the file suffix (text after
5282 the last period).
5284 @item %d
5285 Marks the argument containing or following the @samp{%d} as a
5286 temporary file name, so that that file will be deleted if GCC exits
5287 successfully.  Unlike @samp{%g}, this contributes no text to the
5288 argument.
5290 @item %g@var{suffix}
5291 Substitute a file name that has suffix @var{suffix} and is chosen
5292 once per compilation, and mark the argument in the same way as
5293 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5294 name is now chosen in a way that is hard to predict even when previously
5295 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5296 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5297 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5298 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5299 was simply substituted with a file name chosen once per compilation,
5300 without regard to any appended suffix (which was therefore treated
5301 just like ordinary text), making such attacks more likely to succeed.
5303 @item %u@var{suffix}
5304 Like @samp{%g}, but generates a new temporary file name even if
5305 @samp{%u@var{suffix}} was already seen.
5307 @item %U@var{suffix}
5308 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5309 new one if there is no such last file name.  In the absence of any
5310 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5311 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5312 would involve the generation of two distinct file names, one
5313 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5314 simply substituted with a file name chosen for the previous @samp{%u},
5315 without regard to any appended suffix.
5317 @item %j@var{suffix}
5318 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5319 writable, and if save-temps is off; otherwise, substitute the name
5320 of a temporary file, just like @samp{%u}.  This temporary file is not
5321 meant for communication between processes, but rather as a junk
5322 disposal mechanism.
5324 @item %|@var{suffix}
5325 @itemx %m@var{suffix}
5326 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5327 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5328 all.  These are the two most common ways to instruct a program that it
5329 should read from standard input or write to standard output.  If you
5330 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5331 construct: see for example @file{f/lang-specs.h}.
5333 @item %.@var{SUFFIX}
5334 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5335 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5336 terminated by the next space or %.
5338 @item %w
5339 Marks the argument containing or following the @samp{%w} as the
5340 designated output file of this compilation.  This puts the argument
5341 into the sequence of arguments that @samp{%o} will substitute later.
5343 @item %o
5344 Substitutes the names of all the output files, with spaces
5345 automatically placed around them.  You should write spaces
5346 around the @samp{%o} as well or the results are undefined.
5347 @samp{%o} is for use in the specs for running the linker.
5348 Input files whose names have no recognized suffix are not compiled
5349 at all, but they are included among the output files, so they will
5350 be linked.
5352 @item %O
5353 Substitutes the suffix for object files.  Note that this is
5354 handled specially when it immediately follows @samp{%g, %u, or %U},
5355 because of the need for those to form complete file names.  The
5356 handling is such that @samp{%O} is treated exactly as if it had already
5357 been substituted, except that @samp{%g, %u, and %U} do not currently
5358 support additional @var{suffix} characters following @samp{%O} as they would
5359 following, for example, @samp{.o}.
5361 @item %p
5362 Substitutes the standard macro predefinitions for the
5363 current target machine.  Use this when running @code{cpp}.
5365 @item %P
5366 Like @samp{%p}, but puts @samp{__} before and after the name of each
5367 predefined macro, except for macros that start with @samp{__} or with
5368 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5371 @item %I
5372 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5373 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5374 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5375 as necessary.
5377 @item %s
5378 Current argument is the name of a library or startup file of some sort.
5379 Search for that file in a standard list of directories and substitute
5380 the full name found.
5382 @item %e@var{str}
5383 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5384 Use this when inconsistent options are detected.
5386 @item %(@var{name})
5387 Substitute the contents of spec string @var{name} at this point.
5389 @item %[@var{name}]
5390 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5392 @item %x@{@var{option}@}
5393 Accumulate an option for @samp{%X}.
5395 @item %X
5396 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5397 spec string.
5399 @item %Y
5400 Output the accumulated assembler options specified by @option{-Wa}.
5402 @item %Z
5403 Output the accumulated preprocessor options specified by @option{-Wp}.
5405 @item %a
5406 Process the @code{asm} spec.  This is used to compute the
5407 switches to be passed to the assembler.
5409 @item %A
5410 Process the @code{asm_final} spec.  This is a spec string for
5411 passing switches to an assembler post-processor, if such a program is
5412 needed.
5414 @item %l
5415 Process the @code{link} spec.  This is the spec for computing the
5416 command line passed to the linker.  Typically it will make use of the
5417 @samp{%L %G %S %D and %E} sequences.
5419 @item %D
5420 Dump out a @option{-L} option for each directory that GCC believes might
5421 contain startup files.  If the target supports multilibs then the
5422 current multilib directory will be prepended to each of these paths.
5424 @item %M
5425 Output the multilib directory with directory separators replaced with
5426 @samp{_}.  If multilib directories are not set, or the multilib directory is
5427 @file{.} then this option emits nothing.
5429 @item %L
5430 Process the @code{lib} spec.  This is a spec string for deciding which
5431 libraries should be included on the command line to the linker.
5433 @item %G
5434 Process the @code{libgcc} spec.  This is a spec string for deciding
5435 which GCC support library should be included on the command line to the linker.
5437 @item %S
5438 Process the @code{startfile} spec.  This is a spec for deciding which
5439 object files should be the first ones passed to the linker.  Typically
5440 this might be a file named @file{crt0.o}.
5442 @item %E
5443 Process the @code{endfile} spec.  This is a spec string that specifies
5444 the last object files that will be passed to the linker.
5446 @item %C
5447 Process the @code{cpp} spec.  This is used to construct the arguments
5448 to be passed to the C preprocessor.
5450 @item %c
5451 Process the @code{signed_char} spec.  This is intended to be used
5452 to tell cpp whether a char is signed.  It typically has the definition:
5453 @smallexample
5454 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5455 @end smallexample
5457 @item %1
5458 Process the @code{cc1} spec.  This is used to construct the options to be
5459 passed to the actual C compiler (@samp{cc1}).
5461 @item %2
5462 Process the @code{cc1plus} spec.  This is used to construct the options to be
5463 passed to the actual C++ compiler (@samp{cc1plus}).
5465 @item %*
5466 Substitute the variable part of a matched option.  See below.
5467 Note that each comma in the substituted string is replaced by
5468 a single space.
5470 @item %<@code{S}
5471 Remove all occurrences of @code{-S} from the command line.  Note---this
5472 command is position dependent.  @samp{%} commands in the spec string
5473 before this one will see @code{-S}, @samp{%} commands in the spec string
5474 after this one will not.
5476 @item %:@var{function}(@var{args})
5477 Call the named function @var{function}, passing it @var{args}.
5478 @var{args} is first processed as a nested spec string, then split
5479 into an argument vector in the usual fashion.  The function returns
5480 a string which is processed as if it had appeared literally as part
5481 of the current spec.
5483 The following built-in spec functions are provided:
5485 @table @code
5486 @item @code{if-exists}
5487 The @code{if-exists} spec function takes one argument, an absolute
5488 pathname to a file.  If the file exists, @code{if-exists} returns the
5489 pathname.  Here is a small example of its usage:
5491 @smallexample
5492 *startfile:
5493 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5494 @end smallexample
5496 @item @code{if-exists-else}
5497 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5498 spec function, except that it takes two arguments.  The first argument is
5499 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5500 returns the pathname.  If it does not exist, it returns the second argument.
5501 This way, @code{if-exists-else} can be used to select one file or another,
5502 based on the existence of the first.  Here is a small example of its usage:
5504 @smallexample 
5505 *startfile:
5506 crt0%O%s %:if-exists(crti%O%s) \
5507 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5508 @end smallexample
5509 @end table 
5511 @item %@{@code{S}@}
5512 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5513 If that switch was not specified, this substitutes nothing.  Note that
5514 the leading dash is omitted when specifying this option, and it is
5515 automatically inserted if the substitution is performed.  Thus the spec
5516 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5517 and would output the command line option @option{-foo}.
5519 @item %W@{@code{S}@}
5520 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5521 deleted on failure.
5523 @item %@{@code{S}*@}
5524 Substitutes all the switches specified to GCC whose names start
5525 with @code{-S}, but which also take an argument.  This is used for
5526 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5527 GCC considers @option{-o foo} as being
5528 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5529 text, including the space.  Thus two arguments would be generated.
5531 @item %@{@code{S}*&@code{T}*@}
5532 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5533 (the order of @code{S} and @code{T} in the spec is not significant).
5534 There can be any number of ampersand-separated variables; for each the
5535 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5537 @item %@{@code{S}:@code{X}@}
5538 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5540 @item %@{!@code{S}:@code{X}@}
5541 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5543 @item %@{@code{S}*:@code{X}@}
5544 Substitutes @code{X} if one or more switches whose names start with
5545 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5546 once, no matter how many such switches appeared.  However, if @code{%*}
5547 appears somewhere in @code{X}, then @code{X} will be substituted once
5548 for each matching switch, with the @code{%*} replaced by the part of
5549 that switch that matched the @code{*}.
5551 @item %@{.@code{S}:@code{X}@}
5552 Substitutes @code{X}, if processing a file with suffix @code{S}.
5554 @item %@{!.@code{S}:@code{X}@}
5555 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5557 @item %@{@code{S}|@code{P}:@code{X}@}
5558 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5559 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5560 although they have a stronger binding than the @samp{|}.  If @code{%*}
5561 appears in @code{X}, all of the alternatives must be starred, and only
5562 the first matching alternative is substituted.
5564 For example, a spec string like this:
5566 @smallexample
5567 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5568 @end smallexample
5570 will output the following command-line options from the following input
5571 command-line options:
5573 @smallexample
5574 fred.c        -foo -baz
5575 jim.d         -bar -boggle
5576 -d fred.c     -foo -baz -boggle
5577 -d jim.d      -bar -baz -boggle
5578 @end smallexample
5580 @item %@{S:X; T:Y; :D@}
5582 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5583 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5584 be as many clauses as you need.  This may be combined with @code{.}, 
5585 @code{!}, @code{|}, and @code{*} as needed.
5588 @end table
5590 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5591 construct may contain other nested @samp{%} constructs or spaces, or
5592 even newlines.  They are processed as usual, as described above.
5593 Trailing white space in @code{X} is ignored.  White space may also
5594 appear anywhere on the left side of the colon in these constructs,
5595 except between @code{.} or @code{*} and the corresponding word.
5597 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5598 handled specifically in these constructs.  If another value of
5599 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5600 @option{-W} switch is found later in the command line, the earlier
5601 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5602 just one letter, which passes all matching options.
5604 The character @samp{|} at the beginning of the predicate text is used to
5605 indicate that a command should be piped to the following command, but
5606 only if @option{-pipe} is specified.
5608 It is built into GCC which switches take arguments and which do not.
5609 (You might think it would be useful to generalize this to allow each
5610 compiler's spec to say which switches take arguments.  But this cannot
5611 be done in a consistent fashion.  GCC cannot even decide which input
5612 files have been specified without knowing which switches take arguments,
5613 and it must know which input files to compile in order to tell which
5614 compilers to run).
5616 GCC also knows implicitly that arguments starting in @option{-l} are to be
5617 treated as compiler output files, and passed to the linker in their
5618 proper position among the other output files.
5620 @c man begin OPTIONS
5622 @node Target Options
5623 @section Specifying Target Machine and Compiler Version
5624 @cindex target options
5625 @cindex cross compiling
5626 @cindex specifying machine version
5627 @cindex specifying compiler version and target machine
5628 @cindex compiler version, specifying
5629 @cindex target machine, specifying
5631 The usual way to run GCC is to run the executable called @file{gcc}, or
5632 @file{<machine>-gcc} when cross-compiling, or
5633 @file{<machine>-gcc-<version>} to run a version other than the one that
5634 was installed last.  Sometimes this is inconvenient, so GCC provides
5635 options that will switch to another cross-compiler or version.
5637 @table @gcctabopt
5638 @item -b @var{machine}
5639 @opindex b
5640 The argument @var{machine} specifies the target machine for compilation.
5642 The value to use for @var{machine} is the same as was specified as the
5643 machine type when configuring GCC as a cross-compiler.  For
5644 example, if a cross-compiler was configured with @samp{configure
5645 i386v}, meaning to compile for an 80386 running System V, then you
5646 would specify @option{-b i386v} to run that cross compiler.
5648 @item -V @var{version}
5649 @opindex V
5650 The argument @var{version} specifies which version of GCC to run.
5651 This is useful when multiple versions are installed.  For example,
5652 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5653 @end table
5655 The @option{-V} and @option{-b} options work by running the
5656 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5657 use them if you can just run that directly.
5659 @node Submodel Options
5660 @section Hardware Models and Configurations
5661 @cindex submodel options
5662 @cindex specifying hardware config
5663 @cindex hardware models and configurations, specifying
5664 @cindex machine dependent options
5666 Earlier we discussed the standard option @option{-b} which chooses among
5667 different installed compilers for completely different target
5668 machines, such as VAX vs.@: 68000 vs.@: 80386.
5670 In addition, each of these target machine types can have its own
5671 special options, starting with @samp{-m}, to choose among various
5672 hardware models or configurations---for example, 68010 vs 68020,
5673 floating coprocessor or none.  A single installed version of the
5674 compiler can compile for any model or configuration, according to the
5675 options specified.
5677 Some configurations of the compiler also support additional special
5678 options, usually for compatibility with other compilers on the same
5679 platform.
5681 These options are defined by the macro @code{TARGET_SWITCHES} in the
5682 machine description.  The default for the options is also defined by
5683 that macro, which enables you to change the defaults.
5685 @menu
5686 * M680x0 Options::
5687 * M68hc1x Options::
5688 * VAX Options::
5689 * SPARC Options::
5690 * ARM Options::
5691 * MN10200 Options::
5692 * MN10300 Options::
5693 * M32R/D Options::
5694 * M88K Options::
5695 * RS/6000 and PowerPC Options::
5696 * Darwin Options::
5697 * RT Options::
5698 * MIPS Options::
5699 * i386 and x86-64 Options::
5700 * HPPA Options::
5701 * Intel 960 Options::
5702 * DEC Alpha Options::
5703 * DEC Alpha/VMS Options::
5704 * H8/300 Options::
5705 * SH Options::
5706 * System V Options::
5707 * TMS320C3x/C4x Options::
5708 * V850 Options::
5709 * ARC Options::
5710 * NS32K Options::
5711 * AVR Options::
5712 * MCore Options::
5713 * IA-64 Options::
5714 * D30V Options::
5715 * S/390 and zSeries Options::
5716 * CRIS Options::
5717 * MMIX Options::
5718 * PDP-11 Options::
5719 * Xstormy16 Options::
5720 * Xtensa Options::
5721 * FRV Options::
5722 @end menu
5724 @node M680x0 Options
5725 @subsection M680x0 Options
5726 @cindex M680x0 options
5728 These are the @samp{-m} options defined for the 68000 series.  The default
5729 values for these options depends on which style of 68000 was selected when
5730 the compiler was configured; the defaults for the most common choices are
5731 given below.
5733 @table @gcctabopt
5734 @item -m68000
5735 @itemx -mc68000
5736 @opindex m68000
5737 @opindex mc68000
5738 Generate output for a 68000.  This is the default
5739 when the compiler is configured for 68000-based systems.
5741 Use this option for microcontrollers with a 68000 or EC000 core,
5742 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5744 @item -m68020
5745 @itemx -mc68020
5746 @opindex m68020
5747 @opindex mc68020
5748 Generate output for a 68020.  This is the default
5749 when the compiler is configured for 68020-based systems.
5751 @item -m68881
5752 @opindex m68881
5753 Generate output containing 68881 instructions for floating point.
5754 This is the default for most 68020 systems unless @option{--nfp} was
5755 specified when the compiler was configured.
5757 @item -m68030
5758 @opindex m68030
5759 Generate output for a 68030.  This is the default when the compiler is
5760 configured for 68030-based systems.
5762 @item -m68040
5763 @opindex m68040
5764 Generate output for a 68040.  This is the default when the compiler is
5765 configured for 68040-based systems.
5767 This option inhibits the use of 68881/68882 instructions that have to be
5768 emulated by software on the 68040.  Use this option if your 68040 does not
5769 have code to emulate those instructions.
5771 @item -m68060
5772 @opindex m68060
5773 Generate output for a 68060.  This is the default when the compiler is
5774 configured for 68060-based systems.
5776 This option inhibits the use of 68020 and 68881/68882 instructions that
5777 have to be emulated by software on the 68060.  Use this option if your 68060
5778 does not have code to emulate those instructions.
5780 @item -mcpu32
5781 @opindex mcpu32
5782 Generate output for a CPU32.  This is the default
5783 when the compiler is configured for CPU32-based systems.
5785 Use this option for microcontrollers with a
5786 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5787 68336, 68340, 68341, 68349 and 68360.
5789 @item -m5200
5790 @opindex m5200
5791 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5792 when the compiler is configured for 520X-based systems.
5794 Use this option for microcontroller with a 5200 core, including
5795 the MCF5202, MCF5203, MCF5204 and MCF5202.
5798 @item -m68020-40
5799 @opindex m68020-40
5800 Generate output for a 68040, without using any of the new instructions.
5801 This results in code which can run relatively efficiently on either a
5802 68020/68881 or a 68030 or a 68040.  The generated code does use the
5803 68881 instructions that are emulated on the 68040.
5805 @item -m68020-60
5806 @opindex m68020-60
5807 Generate output for a 68060, without using any of the new instructions.
5808 This results in code which can run relatively efficiently on either a
5809 68020/68881 or a 68030 or a 68040.  The generated code does use the
5810 68881 instructions that are emulated on the 68060.
5812 @item -msoft-float
5813 @opindex msoft-float
5814 Generate output containing library calls for floating point.
5815 @strong{Warning:} the requisite libraries are not available for all m68k
5816 targets.  Normally the facilities of the machine's usual C compiler are
5817 used, but this can't be done directly in cross-compilation.  You must
5818 make your own arrangements to provide suitable library functions for
5819 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5820 @samp{m68k-*-coff} do provide software floating point support.
5822 @item -mshort
5823 @opindex mshort
5824 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5826 @item -mnobitfield
5827 @opindex mnobitfield
5828 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5829 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5831 @item -mbitfield
5832 @opindex mbitfield
5833 Do use the bit-field instructions.  The @option{-m68020} option implies
5834 @option{-mbitfield}.  This is the default if you use a configuration
5835 designed for a 68020.
5837 @item -mrtd
5838 @opindex mrtd
5839 Use a different function-calling convention, in which functions
5840 that take a fixed number of arguments return with the @code{rtd}
5841 instruction, which pops their arguments while returning.  This
5842 saves one instruction in the caller since there is no need to pop
5843 the arguments there.
5845 This calling convention is incompatible with the one normally
5846 used on Unix, so you cannot use it if you need to call libraries
5847 compiled with the Unix compiler.
5849 Also, you must provide function prototypes for all functions that
5850 take variable numbers of arguments (including @code{printf});
5851 otherwise incorrect code will be generated for calls to those
5852 functions.
5854 In addition, seriously incorrect code will result if you call a
5855 function with too many arguments.  (Normally, extra arguments are
5856 harmlessly ignored.)
5858 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5859 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5861 @item -malign-int
5862 @itemx -mno-align-int
5863 @opindex malign-int
5864 @opindex mno-align-int
5865 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5866 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5867 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5868 Aligning variables on 32-bit boundaries produces code that runs somewhat
5869 faster on processors with 32-bit busses at the expense of more memory.
5871 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5872 align structures containing the above types  differently than
5873 most published application binary interface specifications for the m68k.
5875 @item -mpcrel
5876 @opindex mpcrel
5877 Use the pc-relative addressing mode of the 68000 directly, instead of
5878 using a global offset table.  At present, this option implies @option{-fpic},
5879 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5880 not presently supported with @option{-mpcrel}, though this could be supported for
5881 68020 and higher processors.
5883 @item -mno-strict-align
5884 @itemx -mstrict-align
5885 @opindex mno-strict-align
5886 @opindex mstrict-align
5887 Do not (do) assume that unaligned memory references will be handled by
5888 the system.
5890 @end table
5892 @node M68hc1x Options
5893 @subsection M68hc1x Options
5894 @cindex M68hc1x options
5896 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5897 microcontrollers.  The default values for these options depends on
5898 which style of microcontroller was selected when the compiler was configured;
5899 the defaults for the most common choices are given below.
5901 @table @gcctabopt
5902 @item -m6811
5903 @itemx -m68hc11
5904 @opindex m6811
5905 @opindex m68hc11
5906 Generate output for a 68HC11.  This is the default
5907 when the compiler is configured for 68HC11-based systems.
5909 @item -m6812
5910 @itemx -m68hc12
5911 @opindex m6812
5912 @opindex m68hc12
5913 Generate output for a 68HC12.  This is the default
5914 when the compiler is configured for 68HC12-based systems.
5916 @item -m68S12
5917 @itemx -m68hcs12
5918 @opindex m68S12
5919 @opindex m68hcs12
5920 Generate output for a 68HCS12.  
5922 @item -mauto-incdec
5923 @opindex mauto-incdec
5924 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5925 addressing modes.
5927 @item -minmax
5928 @itemx -nominmax
5929 @opindex minmax
5930 @opindex mnominmax
5931 Enable the use of 68HC12 min and max instructions.
5933 @item -mlong-calls
5934 @itemx -mno-long-calls
5935 @opindex mlong-calls
5936 @opindex mno-long-calls
5937 Treat all calls as being far away (near).  If calls are assumed to be
5938 far away, the compiler will use the @code{call} instruction to
5939 call a function and the @code{rtc} instruction for returning.
5941 @item -mshort
5942 @opindex mshort
5943 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5945 @item -msoft-reg-count=@var{count}
5946 @opindex msoft-reg-count
5947 Specify the number of pseudo-soft registers which are used for the
5948 code generation.  The maximum number is 32.  Using more pseudo-soft
5949 register may or may not result in better code depending on the program.
5950 The default is 4 for 68HC11 and 2 for 68HC12.
5952 @end table
5954 @node VAX Options
5955 @subsection VAX Options
5956 @cindex VAX options
5958 These @samp{-m} options are defined for the VAX:
5960 @table @gcctabopt
5961 @item -munix
5962 @opindex munix
5963 Do not output certain jump instructions (@code{aobleq} and so on)
5964 that the Unix assembler for the VAX cannot handle across long
5965 ranges.
5967 @item -mgnu
5968 @opindex mgnu
5969 Do output those jump instructions, on the assumption that you
5970 will assemble with the GNU assembler.
5972 @item -mg
5973 @opindex mg
5974 Output code for g-format floating point numbers instead of d-format.
5975 @end table
5977 @node SPARC Options
5978 @subsection SPARC Options
5979 @cindex SPARC options
5981 These @samp{-m} switches are supported on the SPARC:
5983 @table @gcctabopt
5984 @item -mno-app-regs
5985 @itemx -mapp-regs
5986 @opindex mno-app-regs
5987 @opindex mapp-regs
5988 Specify @option{-mapp-regs} to generate output using the global registers
5989 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5990 is the default.
5992 To be fully SVR4 ABI compliant at the cost of some performance loss,
5993 specify @option{-mno-app-regs}.  You should compile libraries and system
5994 software with this option.
5996 @item -mfpu
5997 @itemx -mhard-float
5998 @opindex mfpu
5999 @opindex mhard-float
6000 Generate output containing floating point instructions.  This is the
6001 default.
6003 @item -mno-fpu
6004 @itemx -msoft-float
6005 @opindex mno-fpu
6006 @opindex msoft-float
6007 Generate output containing library calls for floating point.
6008 @strong{Warning:} the requisite libraries are not available for all SPARC
6009 targets.  Normally the facilities of the machine's usual C compiler are
6010 used, but this cannot be done directly in cross-compilation.  You must make
6011 your own arrangements to provide suitable library functions for
6012 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6013 @samp{sparclite-*-*} do provide software floating point support.
6015 @option{-msoft-float} changes the calling convention in the output file;
6016 therefore, it is only useful if you compile @emph{all} of a program with
6017 this option.  In particular, you need to compile @file{libgcc.a}, the
6018 library that comes with GCC, with @option{-msoft-float} in order for
6019 this to work.
6021 @item -mhard-quad-float
6022 @opindex mhard-quad-float
6023 Generate output containing quad-word (long double) floating point
6024 instructions.
6026 @item -msoft-quad-float
6027 @opindex msoft-quad-float
6028 Generate output containing library calls for quad-word (long double)
6029 floating point instructions.  The functions called are those specified
6030 in the SPARC ABI@.  This is the default.
6032 As of this writing, there are no sparc implementations that have hardware
6033 support for the quad-word floating point instructions.  They all invoke
6034 a trap handler for one of these instructions, and then the trap handler
6035 emulates the effect of the instruction.  Because of the trap handler overhead,
6036 this is much slower than calling the ABI library routines.  Thus the
6037 @option{-msoft-quad-float} option is the default.
6039 @item -mno-flat
6040 @itemx -mflat
6041 @opindex mno-flat
6042 @opindex mflat
6043 With @option{-mflat}, the compiler does not generate save/restore instructions
6044 and will use a ``flat'' or single register window calling convention.
6045 This model uses %i7 as the frame pointer and is compatible with the normal
6046 register window model.  Code from either may be intermixed.
6047 The local registers and the input registers (0--5) are still treated as
6048 ``call saved'' registers and will be saved on the stack as necessary.
6050 With @option{-mno-flat} (the default), the compiler emits save/restore
6051 instructions (except for leaf functions) and is the normal mode of operation.
6053 @item -mno-unaligned-doubles
6054 @itemx -munaligned-doubles
6055 @opindex mno-unaligned-doubles
6056 @opindex munaligned-doubles
6057 Assume that doubles have 8 byte alignment.  This is the default.
6059 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6060 alignment only if they are contained in another type, or if they have an
6061 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6062 Specifying this option avoids some rare compatibility problems with code
6063 generated by other compilers.  It is not the default because it results
6064 in a performance loss, especially for floating point code.
6066 @item -mno-faster-structs
6067 @itemx -mfaster-structs
6068 @opindex mno-faster-structs
6069 @opindex mfaster-structs
6070 With @option{-mfaster-structs}, the compiler assumes that structures
6071 should have 8 byte alignment.  This enables the use of pairs of
6072 @code{ldd} and @code{std} instructions for copies in structure
6073 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6074 However, the use of this changed alignment directly violates the SPARC
6075 ABI@.  Thus, it's intended only for use on targets where the developer
6076 acknowledges that their resulting code will not be directly in line with
6077 the rules of the ABI@.
6079 @item -mimpure-text
6080 @opindex mimpure-text
6081 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6082 the compiler to not pass @option{-z text} to the linker when linking a
6083 shared object.  Using this option, you can link position-dependent
6084 code into a shared object.  
6086 @option{-mimpure-text} suppresses the ``relocations remain against
6087 allocatable but non-writable sections'' linker error message.
6088 However, the necessary relocations will trigger copy-on-write, and the
6089 shared object is not actually shared across processes.  Instead of
6090 using @option{-mimpure-text}, you should compile all source code with
6091 @option{-fpic} or @option{-fPIC}.
6093 This option is only available on SunOS and Solaris.
6095 @item -mv8
6096 @itemx -msparclite
6097 @opindex mv8
6098 @opindex msparclite
6099 These two options select variations on the SPARC architecture.
6101 By default (unless specifically configured for the Fujitsu SPARClite),
6102 GCC generates code for the v7 variant of the SPARC architecture.
6104 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6105 code is that the compiler emits the integer multiply and integer
6106 divide instructions which exist in SPARC v8 but not in SPARC v7.
6108 @option{-msparclite} will give you SPARClite code.  This adds the integer
6109 multiply, integer divide step and scan (@code{ffs}) instructions which
6110 exist in SPARClite but not in SPARC v7.
6112 These options are deprecated and will be deleted in a future GCC release.
6113 They have been replaced with @option{-mcpu=xxx}.
6115 @item -mcypress
6116 @itemx -msupersparc
6117 @opindex mcypress
6118 @opindex msupersparc
6119 These two options select the processor for which the code is optimized.
6121 With @option{-mcypress} (the default), the compiler optimizes code for the
6122 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6123 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6125 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6126 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6127 of the full SPARC v8 instruction set.
6129 These options are deprecated and will be deleted in a future GCC release.
6130 They have been replaced with @option{-mcpu=xxx}.
6132 @item -mcpu=@var{cpu_type}
6133 @opindex mcpu
6134 Set the instruction set, register set, and instruction scheduling parameters
6135 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6136 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6137 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6138 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6139 @samp{ultrasparc3}.
6141 Default instruction scheduling parameters are used for values that select
6142 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6143 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6145 Here is a list of each supported architecture and their supported
6146 implementations.
6148 @smallexample
6149     v7:             cypress
6150     v8:             supersparc, hypersparc
6151     sparclite:      f930, f934, sparclite86x
6152     sparclet:       tsc701
6153     v9:             ultrasparc, ultrasparc3
6154 @end smallexample
6156 @item -mtune=@var{cpu_type}
6157 @opindex mtune
6158 Set the instruction scheduling parameters for machine type
6159 @var{cpu_type}, but do not set the instruction set or register set that the
6160 option @option{-mcpu=@var{cpu_type}} would.
6162 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6163 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6164 that select a particular cpu implementation.  Those are @samp{cypress},
6165 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6166 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6167 @samp{ultrasparc3}.
6169 @end table
6171 These @samp{-m} switches are supported in addition to the above
6172 on the SPARCLET processor.
6174 @table @gcctabopt
6175 @item -mlittle-endian
6176 @opindex mlittle-endian
6177 Generate code for a processor running in little-endian mode.
6179 @item -mlive-g0
6180 @opindex mlive-g0
6181 Treat register @code{%g0} as a normal register.
6182 GCC will continue to clobber it as necessary but will not assume
6183 it always reads as 0.
6185 @item -mbroken-saverestore
6186 @opindex mbroken-saverestore
6187 Generate code that does not use non-trivial forms of the @code{save} and
6188 @code{restore} instructions.  Early versions of the SPARCLET processor do
6189 not correctly handle @code{save} and @code{restore} instructions used with
6190 arguments.  They correctly handle them used without arguments.  A @code{save}
6191 instruction used without arguments increments the current window pointer
6192 but does not allocate a new stack frame.  It is assumed that the window
6193 overflow trap handler will properly handle this case as will interrupt
6194 handlers.
6195 @end table
6197 These @samp{-m} switches are supported in addition to the above
6198 on SPARC V9 processors in 64-bit environments.
6200 @table @gcctabopt
6201 @item -mlittle-endian
6202 @opindex mlittle-endian
6203 Generate code for a processor running in little-endian mode. It is only
6204 available for a few configurations and most notably not on Solaris.
6206 @item -m32
6207 @itemx -m64
6208 @opindex m32
6209 @opindex m64
6210 Generate code for a 32-bit or 64-bit environment.
6211 The 32-bit environment sets int, long and pointer to 32 bits.
6212 The 64-bit environment sets int to 32 bits and long and pointer
6213 to 64 bits.
6215 @item -mcmodel=medlow
6216 @opindex mcmodel=medlow
6217 Generate code for the Medium/Low code model: the program must be linked
6218 in the low 32 bits of the address space.  Pointers are 64 bits.
6219 Programs can be statically or dynamically linked.
6221 @item -mcmodel=medmid
6222 @opindex mcmodel=medmid
6223 Generate code for the Medium/Middle code model: the program must be linked
6224 in the low 44 bits of the address space, the text segment must be less than
6225 2G bytes, and data segment must be within 2G of the text segment.
6226 Pointers are 64 bits.
6228 @item -mcmodel=medany
6229 @opindex mcmodel=medany
6230 Generate code for the Medium/Anywhere code model: the program may be linked
6231 anywhere in the address space, the text segment must be less than
6232 2G bytes, and data segment must be within 2G of the text segment.
6233 Pointers are 64 bits.
6235 @item -mcmodel=embmedany
6236 @opindex mcmodel=embmedany
6237 Generate code for the Medium/Anywhere code model for embedded systems:
6238 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6239 (determined at link time).  Register %g4 points to the base of the
6240 data segment.  Pointers are still 64 bits.
6241 Programs are statically linked, PIC is not supported.
6243 @item -mstack-bias
6244 @itemx -mno-stack-bias
6245 @opindex mstack-bias
6246 @opindex mno-stack-bias
6247 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6248 frame pointer if present, are offset by @minus{}2047 which must be added back
6249 when making stack frame references.
6250 Otherwise, assume no such offset is present.
6251 @end table
6253 @node ARM Options
6254 @subsection ARM Options
6255 @cindex ARM options
6257 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6258 architectures:
6260 @table @gcctabopt
6261 @item -mapcs-frame
6262 @opindex mapcs-frame
6263 Generate a stack frame that is compliant with the ARM Procedure Call
6264 Standard for all functions, even if this is not strictly necessary for
6265 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6266 with this option will cause the stack frames not to be generated for
6267 leaf functions.  The default is @option{-mno-apcs-frame}.
6269 @item -mapcs
6270 @opindex mapcs
6271 This is a synonym for @option{-mapcs-frame}.
6273 @item -mapcs-26
6274 @opindex mapcs-26
6275 Generate code for a processor running with a 26-bit program counter,
6276 and conforming to the function calling standards for the APCS 26-bit
6277 option.  This option replaces the @option{-m2} and @option{-m3} options
6278 of previous releases of the compiler.
6280 @item -mapcs-32
6281 @opindex mapcs-32
6282 Generate code for a processor running with a 32-bit program counter,
6283 and conforming to the function calling standards for the APCS 32-bit
6284 option.  This option replaces the @option{-m6} option of previous releases
6285 of the compiler.
6287 @ignore
6288 @c not currently implemented
6289 @item -mapcs-stack-check
6290 @opindex mapcs-stack-check
6291 Generate code to check the amount of stack space available upon entry to
6292 every function (that actually uses some stack space).  If there is
6293 insufficient space available then either the function
6294 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6295 called, depending upon the amount of stack space required.  The run time
6296 system is required to provide these functions.  The default is
6297 @option{-mno-apcs-stack-check}, since this produces smaller code.
6299 @c not currently implemented
6300 @item -mapcs-float
6301 @opindex mapcs-float
6302 Pass floating point arguments using the float point registers.  This is
6303 one of the variants of the APCS@.  This option is recommended if the
6304 target hardware has a floating point unit or if a lot of floating point
6305 arithmetic is going to be performed by the code.  The default is
6306 @option{-mno-apcs-float}, since integer only code is slightly increased in
6307 size if @option{-mapcs-float} is used.
6309 @c not currently implemented
6310 @item -mapcs-reentrant
6311 @opindex mapcs-reentrant
6312 Generate reentrant, position independent code.  The default is
6313 @option{-mno-apcs-reentrant}.
6314 @end ignore
6316 @item -mthumb-interwork
6317 @opindex mthumb-interwork
6318 Generate code which supports calling between the ARM and Thumb
6319 instruction sets.  Without this option the two instruction sets cannot
6320 be reliably used inside one program.  The default is
6321 @option{-mno-thumb-interwork}, since slightly larger code is generated
6322 when @option{-mthumb-interwork} is specified.
6324 @item -mno-sched-prolog
6325 @opindex mno-sched-prolog
6326 Prevent the reordering of instructions in the function prolog, or the
6327 merging of those instruction with the instructions in the function's
6328 body.  This means that all functions will start with a recognizable set
6329 of instructions (or in fact one of a choice from a small set of
6330 different function prologues), and this information can be used to
6331 locate the start if functions inside an executable piece of code.  The
6332 default is @option{-msched-prolog}.
6334 @item -mhard-float
6335 @opindex mhard-float
6336 Generate output containing floating point instructions.  This is the
6337 default.
6339 @item -msoft-float
6340 @opindex msoft-float
6341 Generate output containing library calls for floating point.
6342 @strong{Warning:} the requisite libraries are not available for all ARM
6343 targets.  Normally the facilities of the machine's usual C compiler are
6344 used, but this cannot be done directly in cross-compilation.  You must make
6345 your own arrangements to provide suitable library functions for
6346 cross-compilation.
6348 @option{-msoft-float} changes the calling convention in the output file;
6349 therefore, it is only useful if you compile @emph{all} of a program with
6350 this option.  In particular, you need to compile @file{libgcc.a}, the
6351 library that comes with GCC, with @option{-msoft-float} in order for
6352 this to work.
6354 @item -mlittle-endian
6355 @opindex mlittle-endian
6356 Generate code for a processor running in little-endian mode.  This is
6357 the default for all standard configurations.
6359 @item -mbig-endian
6360 @opindex mbig-endian
6361 Generate code for a processor running in big-endian mode; the default is
6362 to compile code for a little-endian processor.
6364 @item -mwords-little-endian
6365 @opindex mwords-little-endian
6366 This option only applies when generating code for big-endian processors.
6367 Generate code for a little-endian word order but a big-endian byte
6368 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6369 option should only be used if you require compatibility with code for
6370 big-endian ARM processors generated by versions of the compiler prior to
6371 2.8.
6373 @item -malignment-traps
6374 @opindex malignment-traps
6375 Generate code that will not trap if the MMU has alignment traps enabled.
6376 On ARM architectures prior to ARMv4, there were no instructions to
6377 access half-word objects stored in memory.  However, when reading from
6378 memory a feature of the ARM architecture allows a word load to be used,
6379 even if the address is unaligned, and the processor core will rotate the
6380 data as it is being loaded.  This option tells the compiler that such
6381 misaligned accesses will cause a MMU trap and that it should instead
6382 synthesize the access as a series of byte accesses.  The compiler can
6383 still use word accesses to load half-word data if it knows that the
6384 address is aligned to a word boundary.
6386 This option is ignored when compiling for ARM architecture 4 or later,
6387 since these processors have instructions to directly access half-word
6388 objects in memory.
6390 @item -mno-alignment-traps
6391 @opindex mno-alignment-traps
6392 Generate code that assumes that the MMU will not trap unaligned
6393 accesses.  This produces better code when the target instruction set
6394 does not have half-word memory operations (i.e.@: implementations prior to
6395 ARMv4).
6397 Note that you cannot use this option to access unaligned word objects,
6398 since the processor will only fetch one 32-bit aligned object from
6399 memory.
6401 The default setting for most targets is @option{-mno-alignment-traps}, since
6402 this produces better code when there are no half-word memory
6403 instructions available.
6405 @item -mshort-load-bytes
6406 @itemx -mno-short-load-words
6407 @opindex mshort-load-bytes
6408 @opindex mno-short-load-words
6409 These are deprecated aliases for @option{-malignment-traps}.
6411 @item -mno-short-load-bytes
6412 @itemx -mshort-load-words
6413 @opindex mno-short-load-bytes
6414 @opindex mshort-load-words
6415 This are deprecated aliases for @option{-mno-alignment-traps}.
6417 @item -mcpu=@var{name}
6418 @opindex mcpu
6419 This specifies the name of the target ARM processor.  GCC uses this name
6420 to determine what kind of instructions it can emit when generating
6421 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6422 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6423 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6424 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6425 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6426 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6427 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6428 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6429 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6430 @samp{arm1020t}, @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
6432 @itemx -mtune=@var{name}
6433 @opindex mtune
6434 This option is very similar to the @option{-mcpu=} option, except that
6435 instead of specifying the actual target processor type, and hence
6436 restricting which instructions can be used, it specifies that GCC should
6437 tune the performance of the code as if the target were of the type
6438 specified in this option, but still choosing the instructions that it
6439 will generate based on the cpu specified by a @option{-mcpu=} option.
6440 For some ARM implementations better performance can be obtained by using
6441 this option.
6443 @item -march=@var{name}
6444 @opindex march
6445 This specifies the name of the target ARM architecture.  GCC uses this
6446 name to determine what kind of instructions it can emit when generating
6447 assembly code.  This option can be used in conjunction with or instead
6448 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6449 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6450 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{iwmmxt}, @samp{ep9312}.
6452 @item -mfpe=@var{number}
6453 @itemx -mfp=@var{number}
6454 @opindex mfpe
6455 @opindex mfp
6456 This specifies the version of the floating point emulation available on
6457 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6458 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6460 @item -mstructure-size-boundary=@var{n}
6461 @opindex mstructure-size-boundary
6462 The size of all structures and unions will be rounded up to a multiple
6463 of the number of bits set by this option.  Permissible values are 8 and
6464 32.  The default value varies for different toolchains.  For the COFF
6465 targeted toolchain the default value is 8.  Specifying the larger number
6466 can produce faster, more efficient code, but can also increase the size
6467 of the program.  The two values are potentially incompatible.  Code
6468 compiled with one value cannot necessarily expect to work with code or
6469 libraries compiled with the other value, if they exchange information
6470 using structures or unions.
6472 @item -mabort-on-noreturn
6473 @opindex mabort-on-noreturn
6474 Generate a call to the function @code{abort} at the end of a
6475 @code{noreturn} function.  It will be executed if the function tries to
6476 return.
6478 @item -mlong-calls
6479 @itemx -mno-long-calls
6480 @opindex mlong-calls
6481 @opindex mno-long-calls
6482 Tells the compiler to perform function calls by first loading the
6483 address of the function into a register and then performing a subroutine
6484 call on this register.  This switch is needed if the target function
6485 will lie outside of the 64 megabyte addressing range of the offset based
6486 version of subroutine call instruction.
6488 Even if this switch is enabled, not all function calls will be turned
6489 into long calls.  The heuristic is that static functions, functions
6490 which have the @samp{short-call} attribute, functions that are inside
6491 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6492 definitions have already been compiled within the current compilation
6493 unit, will not be turned into long calls.  The exception to this rule is
6494 that weak function definitions, functions with the @samp{long-call}
6495 attribute or the @samp{section} attribute, and functions that are within
6496 the scope of a @samp{#pragma long_calls} directive, will always be
6497 turned into long calls.
6499 This feature is not enabled by default.  Specifying
6500 @option{-mno-long-calls} will restore the default behavior, as will
6501 placing the function calls within the scope of a @samp{#pragma
6502 long_calls_off} directive.  Note these switches have no effect on how
6503 the compiler generates code to handle function calls via function
6504 pointers.
6506 @item -mnop-fun-dllimport
6507 @opindex mnop-fun-dllimport
6508 Disable support for the @code{dllimport} attribute.
6510 @item -msingle-pic-base
6511 @opindex msingle-pic-base
6512 Treat the register used for PIC addressing as read-only, rather than
6513 loading it in the prologue for each function.  The run-time system is
6514 responsible for initializing this register with an appropriate value
6515 before execution begins.
6517 @item -mpic-register=@var{reg}
6518 @opindex mpic-register
6519 Specify the register to be used for PIC addressing.  The default is R10
6520 unless stack-checking is enabled, when R9 is used.
6522 @item -mcirrus-fix-invalid-insns
6523 @opindex mcirrus-fix-invalid-insns
6524 @opindex mno-cirrus-fix-invalid-insns
6525 Insert NOPs into the instruction stream to in order to work around
6526 problems with invalid Maverick instruction combinations.  This option
6527 is only valid if the @option{-mcpu=ep9312} option has been used to
6528 enable generation of instructions for the Cirrus Maverick floating
6529 point co-processor.  This option is not enabled by default, since the
6530 problem is only present in older Maverick implementations.  The default
6531 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6532 switch.
6534 @item -mpoke-function-name
6535 @opindex mpoke-function-name
6536 Write the name of each function into the text section, directly
6537 preceding the function prologue.  The generated code is similar to this:
6539 @smallexample
6540      t0
6541          .ascii "arm_poke_function_name", 0
6542          .align
6543      t1
6544          .word 0xff000000 + (t1 - t0)
6545      arm_poke_function_name
6546          mov     ip, sp
6547          stmfd   sp!, @{fp, ip, lr, pc@}
6548          sub     fp, ip, #4
6549 @end smallexample
6551 When performing a stack backtrace, code can inspect the value of
6552 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6553 location @code{pc - 12} and the top 8 bits are set, then we know that
6554 there is a function name embedded immediately preceding this location
6555 and has length @code{((pc[-3]) & 0xff000000)}.
6557 @item -mthumb
6558 @opindex mthumb
6559 Generate code for the 16-bit Thumb instruction set.  The default is to
6560 use the 32-bit ARM instruction set.
6562 @item -mtpcs-frame
6563 @opindex mtpcs-frame
6564 Generate a stack frame that is compliant with the Thumb Procedure Call
6565 Standard for all non-leaf functions.  (A leaf function is one that does
6566 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6568 @item -mtpcs-leaf-frame
6569 @opindex mtpcs-leaf-frame
6570 Generate a stack frame that is compliant with the Thumb Procedure Call
6571 Standard for all leaf functions.  (A leaf function is one that does
6572 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6574 @item -mcallee-super-interworking
6575 @opindex mcallee-super-interworking
6576 Gives all externally visible functions in the file being compiled an ARM
6577 instruction set header which switches to Thumb mode before executing the
6578 rest of the function.  This allows these functions to be called from
6579 non-interworking code.
6581 @item -mcaller-super-interworking
6582 @opindex mcaller-super-interworking
6583 Allows calls via function pointers (including virtual functions) to
6584 execute correctly regardless of whether the target code has been
6585 compiled for interworking or not.  There is a small overhead in the cost
6586 of executing a function pointer if this option is enabled.
6588 @end table
6590 @node MN10200 Options
6591 @subsection MN10200 Options
6592 @cindex MN10200 options
6594 These @option{-m} options are defined for Matsushita MN10200 architectures:
6595 @table @gcctabopt
6597 @item -mrelax
6598 @opindex mrelax
6599 Indicate to the linker that it should perform a relaxation optimization pass
6600 to shorten branches, calls and absolute memory addresses.  This option only
6601 has an effect when used on the command line for the final link step.
6603 This option makes symbolic debugging impossible.
6604 @end table
6606 @node MN10300 Options
6607 @subsection MN10300 Options
6608 @cindex MN10300 options
6610 These @option{-m} options are defined for Matsushita MN10300 architectures:
6612 @table @gcctabopt
6613 @item -mmult-bug
6614 @opindex mmult-bug
6615 Generate code to avoid bugs in the multiply instructions for the MN10300
6616 processors.  This is the default.
6618 @item -mno-mult-bug
6619 @opindex mno-mult-bug
6620 Do not generate code to avoid bugs in the multiply instructions for the
6621 MN10300 processors.
6623 @item -mam33
6624 @opindex mam33
6625 Generate code which uses features specific to the AM33 processor.
6627 @item -mno-am33
6628 @opindex mno-am33
6629 Do not generate code which uses features specific to the AM33 processor.  This
6630 is the default.
6632 @item -mno-crt0
6633 @opindex mno-crt0
6634 Do not link in the C run-time initialization object file.
6636 @item -mrelax
6637 @opindex mrelax
6638 Indicate to the linker that it should perform a relaxation optimization pass
6639 to shorten branches, calls and absolute memory addresses.  This option only
6640 has an effect when used on the command line for the final link step.
6642 This option makes symbolic debugging impossible.
6643 @end table
6646 @node M32R/D Options
6647 @subsection M32R/D Options
6648 @cindex M32R/D options
6650 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6652 @table @gcctabopt
6653 @item -m32rx
6654 @opindex m32rx
6655 Generate code for the M32R/X@.
6657 @item -m32r
6658 @opindex m32r
6659 Generate code for the M32R@.  This is the default.
6661 @item -mcode-model=small
6662 @opindex mcode-model=small
6663 Assume all objects live in the lower 16MB of memory (so that their addresses
6664 can be loaded with the @code{ld24} instruction), and assume all subroutines
6665 are reachable with the @code{bl} instruction.
6666 This is the default.
6668 The addressability of a particular object can be set with the
6669 @code{model} attribute.
6671 @item -mcode-model=medium
6672 @opindex mcode-model=medium
6673 Assume objects may be anywhere in the 32-bit address space (the compiler
6674 will generate @code{seth/add3} instructions to load their addresses), and
6675 assume all subroutines are reachable with the @code{bl} instruction.
6677 @item -mcode-model=large
6678 @opindex mcode-model=large
6679 Assume objects may be anywhere in the 32-bit address space (the compiler
6680 will generate @code{seth/add3} instructions to load their addresses), and
6681 assume subroutines may not be reachable with the @code{bl} instruction
6682 (the compiler will generate the much slower @code{seth/add3/jl}
6683 instruction sequence).
6685 @item -msdata=none
6686 @opindex msdata=none
6687 Disable use of the small data area.  Variables will be put into
6688 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6689 @code{section} attribute has been specified).
6690 This is the default.
6692 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6693 Objects may be explicitly put in the small data area with the
6694 @code{section} attribute using one of these sections.
6696 @item -msdata=sdata
6697 @opindex msdata=sdata
6698 Put small global and static data in the small data area, but do not
6699 generate special code to reference them.
6701 @item -msdata=use
6702 @opindex msdata=use
6703 Put small global and static data in the small data area, and generate
6704 special instructions to reference them.
6706 @item -G @var{num}
6707 @opindex G
6708 @cindex smaller data references
6709 Put global and static objects less than or equal to @var{num} bytes
6710 into the small data or bss sections instead of the normal data or bss
6711 sections.  The default value of @var{num} is 8.
6712 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6713 for this option to have any effect.
6715 All modules should be compiled with the same @option{-G @var{num}} value.
6716 Compiling with different values of @var{num} may or may not work; if it
6717 doesn't the linker will give an error message---incorrect code will not be
6718 generated.
6720 @end table
6722 @node M88K Options
6723 @subsection M88K Options
6724 @cindex M88k options
6726 These @samp{-m} options are defined for Motorola 88k architectures:
6728 @table @gcctabopt
6729 @item -m88000
6730 @opindex m88000
6731 Generate code that works well on both the m88100 and the
6732 m88110.
6734 @item -m88100
6735 @opindex m88100
6736 Generate code that works best for the m88100, but that also
6737 runs on the m88110.
6739 @item -m88110
6740 @opindex m88110
6741 Generate code that works best for the m88110, and may not run
6742 on the m88100.
6744 @item -mbig-pic
6745 @opindex mbig-pic
6746 Obsolete option to be removed from the next revision.
6747 Use @option{-fPIC}.
6749 @item -midentify-revision
6750 @opindex midentify-revision
6751 @cindex identifying source, compiler (88k)
6752 Include an @code{ident} directive in the assembler output recording the
6753 source file name, compiler name and version, timestamp, and compilation
6754 flags used.
6756 @item -mno-underscores
6757 @opindex mno-underscores
6758 @cindex underscores, avoiding (88k)
6759 In assembler output, emit symbol names without adding an underscore
6760 character at the beginning of each name.  The default is to use an
6761 underscore as prefix on each name.
6763 @item -mocs-debug-info
6764 @itemx -mno-ocs-debug-info
6765 @opindex mocs-debug-info
6766 @opindex mno-ocs-debug-info
6767 @cindex OCS (88k)
6768 @cindex debugging, 88k OCS
6769 Include (or omit) additional debugging information (about registers used
6770 in each stack frame) as specified in the 88open Object Compatibility
6771 Standard, ``OCS''@.  This extra information allows debugging of code that
6772 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6773 SVr3.2 is to include this information; other 88k configurations omit this
6774 information by default.
6776 @item -mocs-frame-position
6777 @opindex mocs-frame-position
6778 @cindex register positions in frame (88k)
6779 When emitting COFF debugging information for automatic variables and
6780 parameters stored on the stack, use the offset from the canonical frame
6781 address, which is the stack pointer (register 31) on entry to the
6782 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6783 @option{-mocs-frame-position}; other 88k configurations have the default
6784 @option{-mno-ocs-frame-position}.
6786 @item -mno-ocs-frame-position
6787 @opindex mno-ocs-frame-position
6788 @cindex register positions in frame (88k)
6789 When emitting COFF debugging information for automatic variables and
6790 parameters stored on the stack, use the offset from the frame pointer
6791 register (register 30).  When this option is in effect, the frame
6792 pointer is not eliminated when debugging information is selected by the
6793 -g switch.
6795 @item -moptimize-arg-area
6796 @opindex moptimize-arg-area
6797 @cindex arguments in frame (88k)
6798 Save space by reorganizing the stack frame.  This option generates code
6799 that does not agree with the 88open specifications, but uses less
6800 memory.
6802 @itemx -mno-optimize-arg-area
6803 @opindex mno-optimize-arg-area
6804 Do not reorganize the stack frame to save space.  This is the default.
6805 The generated conforms to the specification, but uses more memory.
6807 @item -mshort-data-@var{num}
6808 @opindex mshort-data
6809 @cindex smaller data references (88k)
6810 @cindex r0-relative references (88k)
6811 Generate smaller data references by making them relative to @code{r0},
6812 which allows loading a value using a single instruction (rather than the
6813 usual two).  You control which data references are affected by
6814 specifying @var{num} with this option.  For example, if you specify
6815 @option{-mshort-data-512}, then the data references affected are those
6816 involving displacements of less than 512 bytes.
6817 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6818 than 64k.
6820 @item -mserialize-volatile
6821 @opindex mserialize-volatile
6822 @itemx -mno-serialize-volatile
6823 @opindex mno-serialize-volatile
6824 @cindex sequential consistency on 88k
6825 Do, or don't, generate code to guarantee sequential consistency
6826 of volatile memory references.  By default, consistency is
6827 guaranteed.
6829 The order of memory references made by the MC88110 processor does
6830 not always match the order of the instructions requesting those
6831 references.  In particular, a load instruction may execute before
6832 a preceding store instruction.  Such reordering violates
6833 sequential consistency of volatile memory references, when there
6834 are multiple processors.   When consistency must be guaranteed,
6835 GCC generates special instructions, as needed, to force
6836 execution in the proper order.
6838 The MC88100 processor does not reorder memory references and so
6839 always provides sequential consistency.  However, by default, GCC
6840 generates the special instructions to guarantee consistency
6841 even when you use @option{-m88100}, so that the code may be run on an
6842 MC88110 processor.  If you intend to run your code only on the
6843 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6845 The extra code generated to guarantee consistency may affect the
6846 performance of your application.  If you know that you can safely
6847 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6849 @item -msvr4
6850 @itemx -msvr3
6851 @opindex msvr4
6852 @opindex msvr3
6853 @cindex assembler syntax, 88k
6854 @cindex SVr4
6855 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6856 related to System V release 4 (SVr4).  This controls the following:
6858 @enumerate
6859 @item
6860 Which variant of the assembler syntax to emit.
6861 @item
6862 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6863 that is used on System V release 4.
6864 @item
6865 @option{-msvr4} makes GCC issue additional declaration directives used in
6866 SVr4.
6867 @end enumerate
6869 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6870 @option{-msvr3} is the default for all other m88k configurations.
6872 @item -mversion-03.00
6873 @opindex mversion-03.00
6874 This option is obsolete, and is ignored.
6875 @c ??? which asm syntax better for GAS?  option there too?
6877 @item -mno-check-zero-division
6878 @itemx -mcheck-zero-division
6879 @opindex mno-check-zero-division
6880 @opindex mcheck-zero-division
6881 @cindex zero division on 88k
6882 Do, or don't, generate code to guarantee that integer division by
6883 zero will be detected.  By default, detection is guaranteed.
6885 Some models of the MC88100 processor fail to trap upon integer
6886 division by zero under certain conditions.  By default, when
6887 compiling code that might be run on such a processor, GCC
6888 generates code that explicitly checks for zero-valued divisors
6889 and traps with exception number 503 when one is detected.  Use of
6890 @option{-mno-check-zero-division} suppresses such checking for code
6891 generated to run on an MC88100 processor.
6893 GCC assumes that the MC88110 processor correctly detects all instances
6894 of integer division by zero.  When @option{-m88110} is specified, no
6895 explicit checks for zero-valued divisors are generated, and both
6896 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6897 ignored.
6899 @item -muse-div-instruction
6900 @opindex muse-div-instruction
6901 @cindex divide instruction, 88k
6902 Use the div instruction for signed integer division on the
6903 MC88100 processor.  By default, the div instruction is not used.
6905 On the MC88100 processor the signed integer division instruction
6906 div) traps to the operating system on a negative operand.  The
6907 operating system transparently completes the operation, but at a
6908 large cost in execution time.  By default, when compiling code
6909 that might be run on an MC88100 processor, GCC emulates signed
6910 integer division using the unsigned integer division instruction
6911 divu), thereby avoiding the large penalty of a trap to the
6912 operating system.  Such emulation has its own, smaller, execution
6913 cost in both time and space.  To the extent that your code's
6914 important signed integer division operations are performed on two
6915 nonnegative operands, it may be desirable to use the div
6916 instruction directly.
6918 On the MC88110 processor the div instruction (also known as the
6919 divs instruction) processes negative operands without trapping to
6920 the operating system.  When @option{-m88110} is specified,
6921 @option{-muse-div-instruction} is ignored, and the div instruction is used
6922 for signed integer division.
6924 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6925 particular, the behavior of such a division with and without
6926 @option{-muse-div-instruction} may differ.
6928 @item -mtrap-large-shift
6929 @itemx -mhandle-large-shift
6930 @opindex mtrap-large-shift
6931 @opindex mhandle-large-shift
6932 @cindex bit shift overflow (88k)
6933 @cindex large bit shifts (88k)
6934 Include code to detect bit-shifts of more than 31 bits; respectively,
6935 trap such shifts or emit code to handle them properly.  By default GCC
6936 makes no special provision for large bit shifts.
6938 @item -mwarn-passed-structs
6939 @opindex mwarn-passed-structs
6940 @cindex structure passing (88k)
6941 Warn when a function passes a struct as an argument or result.
6942 Structure-passing conventions have changed during the evolution of the C
6943 language, and are often the source of portability problems.  By default,
6944 GCC issues no such warning.
6945 @end table
6947 @c break page here to avoid unsightly interparagraph stretch.
6948 @c -zw, 2001-8-17
6949 @page
6951 @node RS/6000 and PowerPC Options
6952 @subsection IBM RS/6000 and PowerPC Options
6953 @cindex RS/6000 and PowerPC Options
6954 @cindex IBM RS/6000 and PowerPC Options
6956 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6957 @table @gcctabopt
6958 @item -mpower
6959 @itemx -mno-power
6960 @itemx -mpower2
6961 @itemx -mno-power2
6962 @itemx -mpowerpc
6963 @itemx -mno-powerpc
6964 @itemx -mpowerpc-gpopt
6965 @itemx -mno-powerpc-gpopt
6966 @itemx -mpowerpc-gfxopt
6967 @itemx -mno-powerpc-gfxopt
6968 @itemx -mpowerpc64
6969 @itemx -mno-powerpc64
6970 @opindex mpower
6971 @opindex mno-power
6972 @opindex mpower2
6973 @opindex mno-power2
6974 @opindex mpowerpc
6975 @opindex mno-powerpc
6976 @opindex mpowerpc-gpopt
6977 @opindex mno-powerpc-gpopt
6978 @opindex mpowerpc-gfxopt
6979 @opindex mno-powerpc-gfxopt
6980 @opindex mpowerpc64
6981 @opindex mno-powerpc64
6982 GCC supports two related instruction set architectures for the
6983 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6984 instructions supported by the @samp{rios} chip set used in the original
6985 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6986 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6987 the IBM 4xx microprocessors.
6989 Neither architecture is a subset of the other.  However there is a
6990 large common subset of instructions supported by both.  An MQ
6991 register is included in processors supporting the POWER architecture.
6993 You use these options to specify which instructions are available on the
6994 processor you are using.  The default value of these options is
6995 determined when configuring GCC@.  Specifying the
6996 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6997 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6998 rather than the options listed above.
7000 The @option{-mpower} option allows GCC to generate instructions that
7001 are found only in the POWER architecture and to use the MQ register.
7002 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7003 to generate instructions that are present in the POWER2 architecture but
7004 not the original POWER architecture.
7006 The @option{-mpowerpc} option allows GCC to generate instructions that
7007 are found only in the 32-bit subset of the PowerPC architecture.
7008 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7009 GCC to use the optional PowerPC architecture instructions in the
7010 General Purpose group, including floating-point square root.  Specifying
7011 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7012 use the optional PowerPC architecture instructions in the Graphics
7013 group, including floating-point select.
7015 The @option{-mpowerpc64} option allows GCC to generate the additional
7016 64-bit instructions that are found in the full PowerPC64 architecture
7017 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7018 @option{-mno-powerpc64}.
7020 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7021 will use only the instructions in the common subset of both
7022 architectures plus some special AIX common-mode calls, and will not use
7023 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7024 permits GCC to use any instruction from either architecture and to
7025 allow use of the MQ register; specify this for the Motorola MPC601.
7027 @item -mnew-mnemonics
7028 @itemx -mold-mnemonics
7029 @opindex mnew-mnemonics
7030 @opindex mold-mnemonics
7031 Select which mnemonics to use in the generated assembler code.  With
7032 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7033 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7034 assembler mnemonics defined for the POWER architecture.  Instructions
7035 defined in only one architecture have only one mnemonic; GCC uses that
7036 mnemonic irrespective of which of these options is specified.
7038 GCC defaults to the mnemonics appropriate for the architecture in
7039 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7040 value of these option.  Unless you are building a cross-compiler, you
7041 should normally not specify either @option{-mnew-mnemonics} or
7042 @option{-mold-mnemonics}, but should instead accept the default.
7044 @item -mcpu=@var{cpu_type}
7045 @opindex mcpu
7046 Set architecture type, register usage, choice of mnemonics, and
7047 instruction scheduling parameters for machine type @var{cpu_type}.
7048 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
7049 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
7050 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
7051 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
7052 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
7053 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
7055 @option{-mcpu=common} selects a completely generic processor.  Code
7056 generated under this option will run on any POWER or PowerPC processor.
7057 GCC will use only the instructions in the common subset of both
7058 architectures, and will not use the MQ register.  GCC assumes a generic
7059 processor model for scheduling purposes.
7061 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7062 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7063 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7064 types, with an appropriate, generic processor model assumed for
7065 scheduling purposes.
7067 The other options specify a specific processor.  Code generated under
7068 those options will run best on that processor, and may not run at all on
7069 others.
7071 The @option{-mcpu} options automatically enable or disable other
7072 @option{-m} options as follows:
7074 @table @samp
7075 @item common
7076 @option{-mno-power}, @option{-mno-powerpc}
7078 @item power
7079 @itemx power2
7080 @itemx rios1
7081 @itemx rios2
7082 @itemx rsc
7083 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7085 @item powerpc
7086 @itemx rs64a
7087 @itemx 602
7088 @itemx 603
7089 @itemx 603e
7090 @itemx 604
7091 @itemx 620
7092 @itemx 630
7093 @itemx 740
7094 @itemx 7400
7095 @itemx 7450
7096 @itemx 750
7097 @itemx 505
7098 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7100 @item 601
7101 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7103 @item 403
7104 @itemx 821
7105 @itemx 860
7106 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7107 @end table
7109 @item -mtune=@var{cpu_type}
7110 @opindex mtune
7111 Set the instruction scheduling parameters for machine type
7112 @var{cpu_type}, but do not set the architecture type, register usage, or
7113 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7114 values for @var{cpu_type} are used for @option{-mtune} as for
7115 @option{-mcpu}.  If both are specified, the code generated will use the
7116 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7117 scheduling parameters set by @option{-mtune}.
7119 @item -maltivec
7120 @itemx -mno-altivec
7121 @opindex maltivec
7122 @opindex mno-altivec
7123 These switches enable or disable the use of built-in functions that
7124 allow access to the AltiVec instruction set.  You may also need to set
7125 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7126 enhancements.
7128 @item -mabi=spe
7129 @opindex mabi=spe
7130 Extend the current ABI with SPE ABI extensions.  This does not change
7131 the default ABI, instead it adds the SPE ABI extensions to the current
7132 ABI@.
7134 @item -mabi=no-spe
7135 @opindex mabi=no-spe
7136 Disable Booke SPE ABI extensions for the current ABI.
7138 @item -misel=@var{yes/no}
7139 @itemx -misel
7140 @opindex misel
7141 This switch enables or disables the generation of ISEL instructions.
7143 @item -mspe=@var{yes/no}
7144 @itemx -mspe
7145 @opindex mspe
7146 This switch enables or disables the generation of SPE simd
7147 instructions.
7149 @item -mfloat-gprs=@var{yes/no}
7150 @itemx -mfloat-gprs
7151 @opindex mfloat-gprs
7152 This switch enables or disables the generation of floating point
7153 operations on the general purpose registers for architectures that
7154 support it.  This option is currently only available on the MPC8540.
7156 @item -mfull-toc
7157 @itemx -mno-fp-in-toc
7158 @itemx -mno-sum-in-toc
7159 @itemx -mminimal-toc
7160 @opindex mfull-toc
7161 @opindex mno-fp-in-toc
7162 @opindex mno-sum-in-toc
7163 @opindex mminimal-toc
7164 Modify generation of the TOC (Table Of Contents), which is created for
7165 every executable file.  The @option{-mfull-toc} option is selected by
7166 default.  In that case, GCC will allocate at least one TOC entry for
7167 each unique non-automatic variable reference in your program.  GCC
7168 will also place floating-point constants in the TOC@.  However, only
7169 16,384 entries are available in the TOC@.
7171 If you receive a linker error message that saying you have overflowed
7172 the available TOC space, you can reduce the amount of TOC space used
7173 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7174 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7175 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7176 generate code to calculate the sum of an address and a constant at
7177 run-time instead of putting that sum into the TOC@.  You may specify one
7178 or both of these options.  Each causes GCC to produce very slightly
7179 slower and larger code at the expense of conserving TOC space.
7181 If you still run out of space in the TOC even when you specify both of
7182 these options, specify @option{-mminimal-toc} instead.  This option causes
7183 GCC to make only one TOC entry for every file.  When you specify this
7184 option, GCC will produce code that is slower and larger but which
7185 uses extremely little TOC space.  You may wish to use this option
7186 only on files that contain less frequently executed code.
7188 @item -maix64
7189 @itemx -maix32
7190 @opindex maix64
7191 @opindex maix32
7192 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7193 @code{long} type, and the infrastructure needed to support them.
7194 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7195 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7196 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7198 @item -mxl-call
7199 @itemx -mno-xl-call
7200 @opindex mxl-call
7201 @opindex mno-xl-call
7202 On AIX, pass floating-point arguments to prototyped functions beyond the
7203 register save area (RSA) on the stack in addition to argument FPRs.  The
7204 AIX calling convention was extended but not initially documented to
7205 handle an obscure K&R C case of calling a function that takes the
7206 address of its arguments with fewer arguments than declared.  AIX XL
7207 compilers access floating point arguments which do not fit in the
7208 RSA from the stack when a subroutine is compiled without
7209 optimization.  Because always storing floating-point arguments on the
7210 stack is inefficient and rarely needed, this option is not enabled by
7211 default and only is necessary when calling subroutines compiled by AIX
7212 XL compilers without optimization.
7214 @item -mpe
7215 @opindex mpe
7216 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7217 application written to use message passing with special startup code to
7218 enable the application to run.  The system must have PE installed in the
7219 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7220 must be overridden with the @option{-specs=} option to specify the
7221 appropriate directory location.  The Parallel Environment does not
7222 support threads, so the @option{-mpe} option and the @option{-pthread}
7223 option are incompatible.
7225 @item -malign-natural
7226 @itemx -malign-power
7227 @opindex malign-natural
7228 @opindex malign-power
7229 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7230 @option{-malign-natural} overrides the ABI-defined alignment of larger
7231 types, such as floating-point doubles, on their natural size-based boundary.
7232 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7233 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7235 @item -msoft-float
7236 @itemx -mhard-float
7237 @opindex msoft-float
7238 @opindex mhard-float
7239 Generate code that does not use (uses) the floating-point register set.
7240 Software floating point emulation is provided if you use the
7241 @option{-msoft-float} option, and pass the option to GCC when linking.
7243 @item -mmultiple
7244 @itemx -mno-multiple
7245 @opindex mmultiple
7246 @opindex mno-multiple
7247 Generate code that uses (does not use) the load multiple word
7248 instructions and the store multiple word instructions.  These
7249 instructions are generated by default on POWER systems, and not
7250 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7251 endian PowerPC systems, since those instructions do not work when the
7252 processor is in little endian mode.  The exceptions are PPC740 and
7253 PPC750 which permit the instructions usage in little endian mode.
7255 @item -mstring
7256 @itemx -mno-string
7257 @opindex mstring
7258 @opindex mno-string
7259 Generate code that uses (does not use) the load string instructions
7260 and the store string word instructions to save multiple registers and
7261 do small block moves.  These instructions are generated by default on
7262 POWER systems, and not generated on PowerPC systems.  Do not use
7263 @option{-mstring} on little endian PowerPC systems, since those
7264 instructions do not work when the processor is in little endian mode.
7265 The exceptions are PPC740 and PPC750 which permit the instructions
7266 usage in little endian mode.
7268 @item -mupdate
7269 @itemx -mno-update
7270 @opindex mupdate
7271 @opindex mno-update
7272 Generate code that uses (does not use) the load or store instructions
7273 that update the base register to the address of the calculated memory
7274 location.  These instructions are generated by default.  If you use
7275 @option{-mno-update}, there is a small window between the time that the
7276 stack pointer is updated and the address of the previous frame is
7277 stored, which means code that walks the stack frame across interrupts or
7278 signals may get corrupted data.
7280 @item -mfused-madd
7281 @itemx -mno-fused-madd
7282 @opindex mfused-madd
7283 @opindex mno-fused-madd
7284 Generate code that uses (does not use) the floating point multiply and
7285 accumulate instructions.  These instructions are generated by default if
7286 hardware floating is used.
7288 @item -mno-bit-align
7289 @itemx -mbit-align
7290 @opindex mno-bit-align
7291 @opindex mbit-align
7292 On System V.4 and embedded PowerPC systems do not (do) force structures
7293 and unions that contain bit-fields to be aligned to the base type of the
7294 bit-field.
7296 For example, by default a structure containing nothing but 8
7297 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7298 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7299 the structure would be aligned to a 1 byte boundary and be one byte in
7300 size.
7302 @item -mno-strict-align
7303 @itemx -mstrict-align
7304 @opindex mno-strict-align
7305 @opindex mstrict-align
7306 On System V.4 and embedded PowerPC systems do not (do) assume that
7307 unaligned memory references will be handled by the system.
7309 @item -mrelocatable
7310 @itemx -mno-relocatable
7311 @opindex mrelocatable
7312 @opindex mno-relocatable
7313 On embedded PowerPC systems generate code that allows (does not allow)
7314 the program to be relocated to a different address at runtime.  If you
7315 use @option{-mrelocatable} on any module, all objects linked together must
7316 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7318 @item -mrelocatable-lib
7319 @itemx -mno-relocatable-lib
7320 @opindex mrelocatable-lib
7321 @opindex mno-relocatable-lib
7322 On embedded PowerPC systems generate code that allows (does not allow)
7323 the program to be relocated to a different address at runtime.  Modules
7324 compiled with @option{-mrelocatable-lib} can be linked with either modules
7325 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7326 with modules compiled with the @option{-mrelocatable} options.
7328 @item -mno-toc
7329 @itemx -mtoc
7330 @opindex mno-toc
7331 @opindex mtoc
7332 On System V.4 and embedded PowerPC systems do not (do) assume that
7333 register 2 contains a pointer to a global area pointing to the addresses
7334 used in the program.
7336 @item -mlittle
7337 @itemx -mlittle-endian
7338 @opindex mlittle
7339 @opindex mlittle-endian
7340 On System V.4 and embedded PowerPC systems compile code for the
7341 processor in little endian mode.  The @option{-mlittle-endian} option is
7342 the same as @option{-mlittle}.
7344 @item -mbig
7345 @itemx -mbig-endian
7346 @opindex mbig
7347 @opindex mbig-endian
7348 On System V.4 and embedded PowerPC systems compile code for the
7349 processor in big endian mode.  The @option{-mbig-endian} option is
7350 the same as @option{-mbig}.
7352 @item -mdynamic-no-pic
7353 @opindex mdynamic-no-pic
7354 On Darwin and Mac OS X systems, compile code so that it is not
7355 relocatable, but that its external references are relocatable.  The
7356 resulting code is suitable for applications, but not shared
7357 libraries.
7359 @item -mcall-sysv
7360 @opindex mcall-sysv
7361 On System V.4 and embedded PowerPC systems compile code using calling
7362 conventions that adheres to the March 1995 draft of the System V
7363 Application Binary Interface, PowerPC processor supplement.  This is the
7364 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7366 @item -mcall-sysv-eabi
7367 @opindex mcall-sysv-eabi
7368 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7370 @item -mcall-sysv-noeabi
7371 @opindex mcall-sysv-noeabi
7372 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7374 @item -mcall-solaris
7375 @opindex mcall-solaris
7376 On System V.4 and embedded PowerPC systems compile code for the Solaris
7377 operating system.
7379 @item -mcall-linux
7380 @opindex mcall-linux
7381 On System V.4 and embedded PowerPC systems compile code for the
7382 Linux-based GNU system.
7384 @item -mcall-gnu
7385 @opindex mcall-gnu
7386 On System V.4 and embedded PowerPC systems compile code for the
7387 Hurd-based GNU system.
7389 @item -mcall-netbsd
7390 @opindex mcall-netbsd
7391 On System V.4 and embedded PowerPC systems compile code for the
7392 NetBSD operating system.
7394 @item -maix-struct-return
7395 @opindex maix-struct-return
7396 Return all structures in memory (as specified by the AIX ABI)@.
7398 @item -msvr4-struct-return
7399 @opindex msvr4-struct-return
7400 Return structures smaller than 8 bytes in registers (as specified by the
7401 SVR4 ABI)@.
7403 @item -mabi=altivec
7404 @opindex mabi=altivec
7405 Extend the current ABI with AltiVec ABI extensions.  This does not
7406 change the default ABI, instead it adds the AltiVec ABI extensions to
7407 the current ABI@.
7409 @item -mabi=no-altivec
7410 @opindex mabi=no-altivec
7411 Disable AltiVec ABI extensions for the current ABI.
7413 @item -mprototype
7414 @itemx -mno-prototype
7415 @opindex mprototype
7416 @opindex mno-prototype
7417 On System V.4 and embedded PowerPC systems assume that all calls to
7418 variable argument functions are properly prototyped.  Otherwise, the
7419 compiler must insert an instruction before every non prototyped call to
7420 set or clear bit 6 of the condition code register (@var{CR}) to
7421 indicate whether floating point values were passed in the floating point
7422 registers in case the function takes a variable arguments.  With
7423 @option{-mprototype}, only calls to prototyped variable argument functions
7424 will set or clear the bit.
7426 @item -msim
7427 @opindex msim
7428 On embedded PowerPC systems, assume that the startup module is called
7429 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7430 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7431 configurations.
7433 @item -mmvme
7434 @opindex mmvme
7435 On embedded PowerPC systems, assume that the startup module is called
7436 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7437 @file{libc.a}.
7439 @item -mads
7440 @opindex mads
7441 On embedded PowerPC systems, assume that the startup module is called
7442 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7443 @file{libc.a}.
7445 @item -myellowknife
7446 @opindex myellowknife
7447 On embedded PowerPC systems, assume that the startup module is called
7448 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7449 @file{libc.a}.
7451 @item -mvxworks
7452 @opindex mvxworks
7453 On System V.4 and embedded PowerPC systems, specify that you are
7454 compiling for a VxWorks system.
7456 @item -mwindiss
7457 @opindex mwindiss
7458 Specify that you are compiling for the WindISS simulation environment.
7460 @item -memb
7461 @opindex memb
7462 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7463 header to indicate that @samp{eabi} extended relocations are used.
7465 @item -meabi
7466 @itemx -mno-eabi
7467 @opindex meabi
7468 @opindex mno-eabi
7469 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7470 Embedded Applications Binary Interface (eabi) which is a set of
7471 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7472 means that the stack is aligned to an 8 byte boundary, a function
7473 @code{__eabi} is called to from @code{main} to set up the eabi
7474 environment, and the @option{-msdata} option can use both @code{r2} and
7475 @code{r13} to point to two separate small data areas.  Selecting
7476 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7477 do not call an initialization function from @code{main}, and the
7478 @option{-msdata} option will only use @code{r13} to point to a single
7479 small data area.  The @option{-meabi} option is on by default if you
7480 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7482 @item -msdata=eabi
7483 @opindex msdata=eabi
7484 On System V.4 and embedded PowerPC systems, put small initialized
7485 @code{const} global and static data in the @samp{.sdata2} section, which
7486 is pointed to by register @code{r2}.  Put small initialized
7487 non-@code{const} global and static data in the @samp{.sdata} section,
7488 which is pointed to by register @code{r13}.  Put small uninitialized
7489 global and static data in the @samp{.sbss} section, which is adjacent to
7490 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7491 incompatible with the @option{-mrelocatable} option.  The
7492 @option{-msdata=eabi} option also sets the @option{-memb} option.
7494 @item -msdata=sysv
7495 @opindex msdata=sysv
7496 On System V.4 and embedded PowerPC systems, put small global and static
7497 data in the @samp{.sdata} section, which is pointed to by register
7498 @code{r13}.  Put small uninitialized global and static data in the
7499 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7500 The @option{-msdata=sysv} option is incompatible with the
7501 @option{-mrelocatable} option.
7503 @item -msdata=default
7504 @itemx -msdata
7505 @opindex msdata=default
7506 @opindex msdata
7507 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7508 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7509 same as @option{-msdata=sysv}.
7511 @item -msdata-data
7512 @opindex msdata-data
7513 On System V.4 and embedded PowerPC systems, put small global and static
7514 data in the @samp{.sdata} section.  Put small uninitialized global and
7515 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7516 to address small data however.  This is the default behavior unless
7517 other @option{-msdata} options are used.
7519 @item -msdata=none
7520 @itemx -mno-sdata
7521 @opindex msdata=none
7522 @opindex mno-sdata
7523 On embedded PowerPC systems, put all initialized global and static data
7524 in the @samp{.data} section, and all uninitialized data in the
7525 @samp{.bss} section.
7527 @item -G @var{num}
7528 @opindex G
7529 @cindex smaller data references (PowerPC)
7530 @cindex .sdata/.sdata2 references (PowerPC)
7531 On embedded PowerPC systems, put global and static items less than or
7532 equal to @var{num} bytes into the small data or bss sections instead of
7533 the normal data or bss section.  By default, @var{num} is 8.  The
7534 @option{-G @var{num}} switch is also passed to the linker.
7535 All modules should be compiled with the same @option{-G @var{num}} value.
7537 @item -mregnames
7538 @itemx -mno-regnames
7539 @opindex mregnames
7540 @opindex mno-regnames
7541 On System V.4 and embedded PowerPC systems do (do not) emit register
7542 names in the assembly language output using symbolic forms.
7544 @item -mlongcall
7545 @itemx -mno-longcall
7546 @opindex mlongcall
7547 @opindex mno-longcall
7548 Default to making all function calls via pointers, so that functions
7549 which reside further than 64 megabytes (67,108,864 bytes) from the
7550 current location can be called.  This setting can be overridden by the
7551 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7553 Some linkers are capable of detecting out-of-range calls and generating
7554 glue code on the fly.  On these systems, long calls are unnecessary and
7555 generate slower code.  As of this writing, the AIX linker can do this,
7556 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7557 to the GNU linker for 32-bit PowerPC systems as well.
7559 In the future, we may cause GCC to ignore all longcall specifications
7560 when the linker is known to generate glue.
7562 @item -pthread
7563 @opindex pthread
7564 Adds support for multithreading with the @dfn{pthreads} library.
7565 This option sets flags for both the preprocessor and linker.
7567 @end table
7569 @node Darwin Options
7570 @subsection Darwin Options
7571 @cindex Darwin options
7573 These options are defined for all architectures running the Darwin operating
7574 system.  They are useful for compatibility with other Mac OS compilers.
7576 @table @gcctabopt
7577 @item -all_load    
7578 @opindex all_load   
7579 Loads all members of static archive libraries.
7580 See man ld(1) for more information.
7582 @item -arch_errors_fatal
7583 @opindex arch_errors_fatal
7584 Cause the errors having to do with files that have the wrong architecture
7585 to be fatal.
7587 @item -bind_at_load
7588 @opindex bind_at_load
7589 Causes the output file to be marked such that the dynamic linker will
7590 bind all undefined references when the file is loaded or launched.
7592 @item -bundle     
7593 @opindex bundle
7594 Produce a Mach-o bundle format file.
7595 See man ld(1) for more information.
7597 @item -bundle_loader @var{executable}
7598 @opindex bundle_loader
7599 This specifies the @var{executable} that will be loading the build
7600 output file being linked. See man ld(1) for more information.
7602 @item -allowable_client  @var{client_name}
7603 @item -arch_only
7605 @item -client_name       
7606 @item -compatibility_version
7607 @item -current_version    
7608 @item -dependency-file
7609 @item -dylib_file    
7610 @item -dylinker_install_name
7611 @item -dynamic
7612 @item -dynamiclib   
7613 @item -exported_symbols_list  
7614 @item -filelist
7615 @item -flat_namespace   
7616 @item -force_cpusubtype_ALL
7617 @item -force_flat_namespace   
7618 @item -headerpad_max_install_names
7619 @item -image_base  
7620 @item -init
7621 @item -install_name
7622 @item -keep_private_externs
7623 @item -multi_module
7624 @item -multiply_defined      
7625 @item -multiply_defined_unused      
7626 @item -noall_load  
7627 @item -nomultidefs
7628 @item -noprebind     
7629 @item -noseglinkedit
7630 @item -pagezero_size    
7631 @item -prebind
7632 @item -prebind_all_twolevel_modules
7633 @item -private_bundle
7634 @item -read_only_relocs
7635 @item -sectalign  
7636 @item -sectobjectsymbols    
7637 @item -whyload
7638 @item -seg1addr 
7639 @item -sectcreate
7640 @item -sectobjectsymbols
7641 @item -sectorder
7642 @item -seg_addr_table
7643 @item -seg_addr_table_filename
7644 @item -seglinkedit
7645 @item -segprot   
7646 @item -segs_read_only_addr
7647 @item -segs_read_write_addr
7648 @item -single_module   
7649 @item -static
7650 @item -sub_library
7651 @item -sub_umbrella 
7652 @item -twolevel_namespace
7653 @item -umbrella
7654 @item -undefined
7655 @item -unexported_symbols_list
7656 @item -weak_reference_mismatches
7657 @item -whatsloaded  
7659 @opindex allowable_client
7660 @opindex arch_only    
7661 @opindex client_name
7662 @opindex compatibility_version
7663 @opindex current_version
7664 @opindex dependency-file
7665 @opindex dylib_file
7666 @opindex dylinker_install_name
7667 @opindex dynamic
7668 @opindex dynamiclib
7669 @opindex exported_symbols_list
7670 @opindex filelist  
7671 @opindex flat_namespace    
7672 @opindex force_cpusubtype_ALL
7673 @opindex force_flat_namespace
7674 @opindex headerpad_max_install_names
7675 @opindex image_base
7676 @opindex init     
7677 @opindex install_name
7678 @opindex keep_private_externs
7679 @opindex multi_module   
7680 @opindex multiply_defined
7681 @opindex multiply_defined_unused   
7682 @opindex noall_load  
7683 @opindex nomultidefs   
7684 @opindex noprebind
7685 @opindex noseglinkedit      
7686 @opindex pagezero_size
7687 @opindex prebind
7688 @opindex prebind_all_twolevel_modules
7689 @opindex private_bundle 
7690 @opindex read_only_relocs
7691 @opindex sectalign   
7692 @opindex sectobjectsymbols    
7693 @opindex whyload  
7694 @opindex seg1addr
7695 @opindex sectcreate       
7696 @opindex sectobjectsymbols 
7697 @opindex sectorder     
7698 @opindex seg_addr_table
7699 @opindex seg_addr_table_filename
7700 @opindex seglinkedit
7701 @opindex segprot
7702 @opindex segs_read_only_addr
7703 @opindex segs_read_write_addr
7704 @opindex single_module
7705 @opindex static
7706 @opindex sub_library
7707 @opindex sub_umbrella
7708 @opindex twolevel_namespace
7709 @opindex umbrella
7710 @opindex undefined
7711 @opindex unexported_symbols_list
7712 @opindex weak_reference_mismatches
7713 @opindex whatsloaded
7715 This options are available for Darwin linker. Darwin linker man page
7716 describes them in detail.
7717 @end table
7720 @node RT Options
7721 @subsection IBM RT Options
7722 @cindex RT options
7723 @cindex IBM RT options
7725 These @samp{-m} options are defined for the IBM RT PC:
7727 @table @gcctabopt
7728 @item -min-line-mul
7729 @opindex min-line-mul
7730 Use an in-line code sequence for integer multiplies.  This is the
7731 default.
7733 @item -mcall-lib-mul
7734 @opindex mcall-lib-mul
7735 Call @code{lmul$$} for integer multiples.
7737 @item -mfull-fp-blocks
7738 @opindex mfull-fp-blocks
7739 Generate full-size floating point data blocks, including the minimum
7740 amount of scratch space recommended by IBM@.  This is the default.
7742 @item -mminimum-fp-blocks
7743 @opindex mminimum-fp-blocks
7744 Do not include extra scratch space in floating point data blocks.  This
7745 results in smaller code, but slower execution, since scratch space must
7746 be allocated dynamically.
7748 @cindex @file{stdarg.h} and RT PC
7749 @item -mfp-arg-in-fpregs
7750 @opindex mfp-arg-in-fpregs
7751 Use a calling sequence incompatible with the IBM calling convention in
7752 which floating point arguments are passed in floating point registers.
7753 Note that @code{stdarg.h} will not work with floating point operands
7754 if this option is specified.
7756 @item -mfp-arg-in-gregs
7757 @opindex mfp-arg-in-gregs
7758 Use the normal calling convention for floating point arguments.  This is
7759 the default.
7761 @item -mhc-struct-return
7762 @opindex mhc-struct-return
7763 Return structures of more than one word in memory, rather than in a
7764 register.  This provides compatibility with the MetaWare HighC (hc)
7765 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7766 with the Portable C Compiler (pcc).
7768 @item -mnohc-struct-return
7769 @opindex mnohc-struct-return
7770 Return some structures of more than one word in registers, when
7771 convenient.  This is the default.  For compatibility with the
7772 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7773 option @option{-mhc-struct-return}.
7774 @end table
7776 @node MIPS Options
7777 @subsection MIPS Options
7778 @cindex MIPS options
7780 These @samp{-m} options are defined for the MIPS family of computers:
7782 @table @gcctabopt
7784 @item -march=@var{arch}
7785 @opindex march
7786 Generate code that will run on @var{arch}, which can be the name of a
7787 generic MIPS ISA, or the name of a particular processor.
7788 The ISA names are:
7789 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7790 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7791 The processor names are:
7792 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7793 @samp{m4k},
7794 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7795 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7796 @samp{rm9000},
7797 @samp{orion},
7798 @samp{sb1},
7799 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7800 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7801 The special value @samp{from-abi} selects the
7802 most compatible architecture for the selected ABI (that is,
7803 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7805 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7806 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7807 @samp{vr} may be written @samp{r}.
7809 GCC defines two macros based on the value of this option.  The first
7810 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7811 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7812 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7813 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7814 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7816 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7817 above.  In other words, it will have the full prefix and will not
7818 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7819 the macro names the resolved architecture (either @samp{"mips1"} or
7820 @samp{"mips3"}).  It names the default architecture when no
7821 @option{-march} option is given.
7823 @item -mtune=@var{arch}
7824 @opindex mtune
7825 Optimize for @var{arch}.  Among other things, this option controls
7826 the way instructions are scheduled, and the perceived cost of arithmetic
7827 operations.  The list of @var{arch} values is the same as for
7828 @option{-march}.
7830 When this option is not used, GCC will optimize for the processor
7831 specified by @option{-march}.  By using @option{-march} and
7832 @option{-mtune} together, it is possible to generate code that will
7833 run on a family of processors, but optimize the code for one
7834 particular member of that family.
7836 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7837 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7838 @samp{-march} ones described above.
7840 @item -mips1
7841 @opindex mips1
7842 Equivalent to @samp{-march=mips1}.
7844 @item -mips2
7845 @opindex mips2
7846 Equivalent to @samp{-march=mips2}.
7848 @item -mips3
7849 @opindex mips3
7850 Equivalent to @samp{-march=mips3}.
7852 @item -mips4
7853 @opindex mips4
7854 Equivalent to @samp{-march=mips4}.
7856 @item -mips32
7857 @opindex mips32
7858 Equivalent to @samp{-march=mips32}.
7860 @item -mips32r2
7861 @opindex mips32r2
7862 Equivalent to @samp{-march=mips32r2}.
7864 @item -mips64
7865 @opindex mips64
7866 Equivalent to @samp{-march=mips64}.
7868 @item -mfused-madd
7869 @itemx -mno-fused-madd
7870 @opindex mfused-madd
7871 @opindex mno-fused-madd
7872 Generate code that uses (does not use) the floating point multiply and
7873 accumulate instructions, when they are available.  These instructions
7874 are generated by default if they are available, but this may be
7875 undesirable if the extra precision causes problems or on certain chips
7876 in the mode where denormals are rounded to zero where denormals
7877 generated by multiply and accumulate instructions cause exceptions
7878 anyway.
7880 @item -mfp32
7881 @opindex mfp32
7882 Assume that floating point registers are 32 bits wide.
7884 @item -mfp64
7885 @opindex mfp64
7886 Assume that floating point registers are 64 bits wide.
7888 @item -mgp32
7889 @opindex mgp32
7890 Assume that general purpose registers are 32 bits wide.
7892 @item -mgp64
7893 @opindex mgp64
7894 Assume that general purpose registers are 64 bits wide.
7896 @item -mint64
7897 @opindex mint64
7898 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7899 explanation of the default, and the width of pointers.
7901 @item -mlong64
7902 @opindex mlong64
7903 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7904 explanation of the default, and the width of pointers.
7906 @item -mlong32
7907 @opindex mlong32
7908 Force long, int, and pointer types to be 32 bits wide.
7910 The default size of ints, longs and pointers depends on the ABI@.  All
7911 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7912 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7913 are the same size as longs, or the same size as integer registers,
7914 whichever is smaller.
7916 @item -mabi=32
7917 @itemx -mabi=o64
7918 @itemx -mabi=n32
7919 @itemx -mabi=64
7920 @itemx -mabi=eabi
7921 @itemx -mabi=meabi
7922 @opindex mabi=32
7923 @opindex mabi=o64
7924 @opindex mabi=n32
7925 @opindex mabi=64
7926 @opindex mabi=eabi
7927 @opindex mabi=meabi
7928 Generate code for the given ABI@.
7930 Note that there are two embedded ABIs: @option{-mabi=eabi}
7931 selects the one defined by Cygnus while @option{-meabi=meabi}
7932 selects the one defined by MIPS@.  Both these ABIs have
7933 32-bit and 64-bit variants.  Normally, GCC will generate
7934 64-bit code when you select a 64-bit architecture, but you
7935 can use @option{-mgp32} to get 32-bit code instead.
7937 @item -mabi-fake-default
7938 @opindex mabi-fake-default
7939 You don't want to know what this option does.  No, really.  I mean
7940 it.  Move on to the next option.
7942 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7943 wants the default set of options to get the root of the multilib tree,
7944 and the shared library SONAMEs without any multilib-indicating
7945 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7946 we want to default to the N32 ABI, while still being binary-compatible
7947 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7948 binary-compatible means shared libraries should have the same SONAMEs,
7949 and libraries should live in the same location.  Having O32 libraries
7950 in a sub-directory named say @file{o32} is not acceptable.
7952 So we trick GCC into believing that O32 is the default ABI, except
7953 that we override the default with some internal command-line
7954 processing magic.  Problem is, if we stopped at that, and you then
7955 created a multilib-aware package that used the output of @command{gcc
7956 -print-multi-lib} to decide which multilibs to build, and how, and
7957 you'd find yourself in an awkward situation when you found out that
7958 some of the options listed ended up mapping to the same multilib, and
7959 none of your libraries was actually built for the multilib that
7960 @option{-print-multi-lib} claims to be the default.  So we added this
7961 option that disables the default switcher, falling back to GCC's
7962 original notion of the default library.  Confused yet?
7964 For short: don't ever use this option, unless you find it in the list
7965 of additional options to be used when building for multilibs, in the
7966 output of @option{gcc -print-multi-lib}.
7968 @item -mmips-as
7969 @opindex mmips-as
7970 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7971 add normal debug information.  This is the default for all
7972 platforms except for the OSF/1 reference platform, using the OSF/rose
7973 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7974 switches are used, the @file{mips-tfile} program will encapsulate the
7975 stabs within MIPS ECOFF@.
7977 @item -mgas
7978 @opindex mgas
7979 Generate code for the GNU assembler.  This is the default on the OSF/1
7980 reference platform, using the OSF/rose object format.  Also, this is
7981 the default if the configure option @option{--with-gnu-as} is used.
7983 @item -msplit-addresses
7984 @itemx -mno-split-addresses
7985 @opindex msplit-addresses
7986 @opindex mno-split-addresses
7987 Generate code to load the high and low parts of address constants separately.
7988 This allows GCC to optimize away redundant loads of the high order
7989 bits of addresses.  This optimization requires GNU as and GNU ld.
7990 This optimization is enabled by default for some embedded targets where
7991 GNU as and GNU ld are standard.
7993 @item -mrnames
7994 @itemx -mno-rnames
7995 @opindex mrnames
7996 @opindex mno-rnames
7997 The @option{-mrnames} switch says to output code using the MIPS software
7998 names for the registers, instead of the hardware names (ie, @var{a0}
7999 instead of @var{$4}).  The only known assembler that supports this option
8000 is the Algorithmics assembler.
8002 @item -mmemcpy
8003 @itemx -mno-memcpy
8004 @opindex mmemcpy
8005 @opindex mno-memcpy
8006 The @option{-mmemcpy} switch makes all block moves call the appropriate
8007 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
8008 generating inline code.
8010 @item -mmips-tfile
8011 @itemx -mno-mips-tfile
8012 @opindex mmips-tfile
8013 @opindex mno-mips-tfile
8014 The @option{-mno-mips-tfile} switch causes the compiler not
8015 postprocess the object file with the @file{mips-tfile} program,
8016 after the MIPS assembler has generated it to add debug support.  If
8017 @file{mips-tfile} is not run, then no local variables will be
8018 available to the debugger.  In addition, @file{stage2} and
8019 @file{stage3} objects will have the temporary file names passed to the
8020 assembler embedded in the object file, which means the objects will
8021 not compare the same.  The @option{-mno-mips-tfile} switch should only
8022 be used when there are bugs in the @file{mips-tfile} program that
8023 prevents compilation.
8025 @item -msoft-float
8026 @opindex msoft-float
8027 Generate output containing library calls for floating point.
8028 @strong{Warning:} the requisite libraries are not part of GCC@.
8029 Normally the facilities of the machine's usual C compiler are used, but
8030 this can't be done directly in cross-compilation.  You must make your
8031 own arrangements to provide suitable library functions for
8032 cross-compilation.
8034 @item -mhard-float
8035 @opindex mhard-float
8036 Generate output containing floating point instructions.  This is the
8037 default if you use the unmodified sources.
8039 @item -mabicalls
8040 @itemx -mno-abicalls
8041 @opindex mabicalls
8042 @opindex mno-abicalls
8043 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8044 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8045 position independent code.
8047 @item -mlong-calls
8048 @itemx -mno-long-calls
8049 @opindex mlong-calls
8050 @opindex mno-long-calls
8051 Do all calls with the @samp{JALR} instruction, which requires
8052 loading up a function's address into a register before the call.
8053 You need to use this switch, if you call outside of the current
8054 512 megabyte segment to functions that are not through pointers.
8056 @item -membedded-pic
8057 @itemx -mno-embedded-pic
8058 @opindex membedded-pic
8059 @opindex mno-embedded-pic
8060 Generate PIC code suitable for some embedded systems.  All calls are
8061 made using PC relative address, and all data is addressed using the $gp
8062 register.  No more than 65536 bytes of global data may be used.  This
8063 requires GNU as and GNU ld which do most of the work.  This currently
8064 only works on targets which use ECOFF; it does not work with ELF@.
8066 @item -membedded-data
8067 @itemx -mno-embedded-data
8068 @opindex membedded-data
8069 @opindex mno-embedded-data
8070 Allocate variables to the read-only data section first if possible, then
8071 next in the small data section if possible, otherwise in data.  This gives
8072 slightly slower code than the default, but reduces the amount of RAM required
8073 when executing, and thus may be preferred for some embedded systems.
8075 @item -muninit-const-in-rodata
8076 @itemx -mno-uninit-const-in-rodata
8077 @opindex muninit-const-in-rodata
8078 @opindex mno-uninit-const-in-rodata
8079 When used together with @option{-membedded-data}, it will always store uninitialized
8080 const variables in the read-only data section.
8082 @item -msingle-float
8083 @itemx -mdouble-float
8084 @opindex msingle-float
8085 @opindex mdouble-float
8086 The @option{-msingle-float} switch tells gcc to assume that the floating
8087 point coprocessor only supports single precision operations, as on the
8088 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8089 double precision operations.  This is the default.
8091 @item -mmad
8092 @itemx -mno-mad
8093 @opindex mmad
8094 @opindex mno-mad
8095 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8096 as on the @samp{r4650} chip.
8098 @item -m4650
8099 @opindex m4650
8100 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8101 @option{-mcpu=r4650}.
8103 @item -mips16
8104 @itemx -mno-mips16
8105 @opindex mips16
8106 @opindex mno-mips16
8107 Enable 16-bit instructions.
8109 @item -mentry
8110 @opindex mentry
8111 Use the entry and exit pseudo ops.  This option can only be used with
8112 @option{-mips16}.
8114 @item -EL
8115 @opindex EL
8116 Compile code for the processor in little endian mode.
8117 The requisite libraries are assumed to exist.
8119 @item -EB
8120 @opindex EB
8121 Compile code for the processor in big endian mode.
8122 The requisite libraries are assumed to exist.
8124 @item -G @var{num}
8125 @opindex G
8126 @cindex smaller data references (MIPS)
8127 @cindex gp-relative references (MIPS)
8128 Put global and static items less than or equal to @var{num} bytes into
8129 the small data or bss sections instead of the normal data or bss
8130 section.  This allows the assembler to emit one word memory reference
8131 instructions based on the global pointer (@var{gp} or @var{$28}),
8132 instead of the normal two words used.  By default, @var{num} is 8 when
8133 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8134 @option{-G @var{num}} switch is also passed to the assembler and linker.
8135 All modules should be compiled with the same @option{-G @var{num}}
8136 value.
8138 @item -nocpp
8139 @opindex nocpp
8140 Tell the MIPS assembler to not run its preprocessor over user
8141 assembler files (with a @samp{.s} suffix) when assembling them.
8143 @item -mfix7000
8144 @opindex mfix7000
8145 Pass an option to gas which will cause nops to be inserted if
8146 the read of the destination register of an mfhi or mflo instruction
8147 occurs in the following two instructions.
8149 @item -no-crt0
8150 @opindex no-crt0
8151 Do not include the default crt0.
8153 @item -mflush-func=@var{func}
8154 @itemx -mno-flush-func
8155 @opindex mflush-func
8156 Specifies the function to call to flush the I and D caches, or to not
8157 call any such function.  If called, the function must take the same
8158 arguments as the common @code{_flush_func()}, that is, the address of the
8159 memory range for which the cache is being flushed, the size of the
8160 memory range, and the number 3 (to flush both caches).  The default
8161 depends on the target gcc was configured for, but commonly is either
8162 @samp{_flush_func} or @samp{__cpu_flush}.
8164 @item -mbranch-likely
8165 @itemx -mno-branch-likely
8166 @opindex mbranch-likely
8167 @opindex mno-branch-likely
8168 Enable or disable use of Branch Likely instructions, regardless of the
8169 default for the selected architecture.  By default, Branch Likely
8170 instructions may be generated if they are supported by the selected
8171 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8172 and processors which implement those architectures; for those, Branch
8173 Likely instructions will not be generated by default because the MIPS32
8174 and MIPS64 architectures specifically deprecate their use.
8175 @end table
8177 @node i386 and x86-64 Options
8178 @subsection Intel 386 and AMD x86-64 Options
8179 @cindex i386 Options
8180 @cindex x86-64 Options
8181 @cindex Intel 386 Options
8182 @cindex AMD x86-64 Options
8184 These @samp{-m} options are defined for the i386 and x86-64 family of
8185 computers:
8187 @table @gcctabopt
8188 @item -mtune=@var{cpu-type}
8189 @opindex mtune
8190 Tune to @var{cpu-type} everything applicable about the generated code, except
8191 for the ABI and the set of available instructions.  The choices for
8192 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8193 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8194 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8195 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8196 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8197 and @samp{c3-2}.
8199 While picking a specific @var{cpu-type} will schedule things appropriately
8200 for that particular chip, the compiler will not generate any code that
8201 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8202 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8203 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8204 AMD chips as opposed to the Intel ones.
8206 @item -march=@var{cpu-type}
8207 @opindex march
8208 Generate instructions for the machine type @var{cpu-type}.  The choices
8209 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8210 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8212 @item -mcpu=@var{cpu-type}
8213 @opindex mcpu
8214 A deprecated synonym for @option{-mtune}.
8216 @item -m386
8217 @itemx -m486
8218 @itemx -mpentium
8219 @itemx -mpentiumpro
8220 @opindex m386
8221 @opindex m486
8222 @opindex mpentium
8223 @opindex mpentiumpro
8224 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8225 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8226 These synonyms are deprecated.
8228 @item -mfpmath=@var{unit}
8229 @opindex march
8230 generate floating point arithmetics for selected unit @var{unit}.  the choices
8231 for @var{unit} are:
8233 @table @samp
8234 @item 387
8235 Use the standard 387 floating point coprocessor present majority of chips and
8236 emulated otherwise.  Code compiled with this option will run almost everywhere.
8237 The temporary results are computed in 80bit precision instead of precision
8238 specified by the type resulting in slightly different results compared to most
8239 of other chips. See @option{-ffloat-store} for more detailed description.
8241 This is the default choice for i386 compiler.
8243 @item sse
8244 Use scalar floating point instructions present in the SSE instruction set.
8245 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8246 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8247 instruction set supports only single precision arithmetics, thus the double and
8248 extended precision arithmetics is still done using 387.  Later version, present
8249 only in Pentium4 and the future AMD x86-64 chips supports double precision
8250 arithmetics too.
8252 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8253 @option{-msse2} switches to enable SSE extensions and make this option
8254 effective.  For x86-64 compiler, these extensions are enabled by default.
8256 The resulting code should be considerably faster in majority of cases and avoid
8257 the numerical instability problems of 387 code, but may break some existing
8258 code that expects temporaries to be 80bit.
8260 This is the default choice for x86-64 compiler.
8262 @item pni
8263 Use all SSE extensions enabled by @option{-msse2} as well as the new
8264 SSE extensions in Prescott New Instructions. @option{-mpni} also
8265 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8266 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8267 @code{mwait}. 
8269 @item sse,387
8270 Attempt to utilize both instruction sets at once.  This effectively double the
8271 amount of available registers and on chips with separate execution units for
8272 387 and SSE the execution resources too.  Use this option with care, as it is
8273 still experimental, because gcc register allocator does not model separate
8274 functional units well resulting in instable performance.
8275 @end table
8277 @item -masm=@var{dialect}
8278 @opindex masm=@var{dialect}
8279 Output asm instructions using selected @var{dialect}. Supported choices are
8280 @samp{intel} or @samp{att} (the default one).
8282 @item -mieee-fp
8283 @itemx -mno-ieee-fp
8284 @opindex mieee-fp
8285 @opindex mno-ieee-fp
8286 Control whether or not the compiler uses IEEE floating point
8287 comparisons.  These handle correctly the case where the result of a
8288 comparison is unordered.
8290 @item -msoft-float
8291 @opindex msoft-float
8292 Generate output containing library calls for floating point.
8293 @strong{Warning:} the requisite libraries are not part of GCC@.
8294 Normally the facilities of the machine's usual C compiler are used, but
8295 this can't be done directly in cross-compilation.  You must make your
8296 own arrangements to provide suitable library functions for
8297 cross-compilation.
8299 On machines where a function returns floating point results in the 80387
8300 register stack, some floating point opcodes may be emitted even if
8301 @option{-msoft-float} is used.
8303 @item -mno-fp-ret-in-387
8304 @opindex mno-fp-ret-in-387
8305 Do not use the FPU registers for return values of functions.
8307 The usual calling convention has functions return values of types
8308 @code{float} and @code{double} in an FPU register, even if there
8309 is no FPU@.  The idea is that the operating system should emulate
8310 an FPU@.
8312 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8313 in ordinary CPU registers instead.
8315 @item -mno-fancy-math-387
8316 @opindex mno-fancy-math-387
8317 Some 387 emulators do not support the @code{sin}, @code{cos} and
8318 @code{sqrt} instructions for the 387.  Specify this option to avoid
8319 generating those instructions.  This option is the default on FreeBSD,
8320 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8321 indicates that the target cpu will always have an FPU and so the
8322 instruction will not need emulation.  As of revision 2.6.1, these
8323 instructions are not generated unless you also use the
8324 @option{-funsafe-math-optimizations} switch.
8326 @item -malign-double
8327 @itemx -mno-align-double
8328 @opindex malign-double
8329 @opindex mno-align-double
8330 Control whether GCC aligns @code{double}, @code{long double}, and
8331 @code{long long} variables on a two word boundary or a one word
8332 boundary.  Aligning @code{double} variables on a two word boundary will
8333 produce code that runs somewhat faster on a @samp{Pentium} at the
8334 expense of more memory.
8336 @strong{Warning:} if you use the @option{-malign-double} switch,
8337 structures containing the above types will be aligned differently than
8338 the published application binary interface specifications for the 386
8339 and will not be binary compatible with structures in code compiled
8340 without that switch.
8342 @item -m96bit-long-double
8343 @item -m128bit-long-double
8344 @opindex m96bit-long-double
8345 @opindex m128bit-long-double
8346 These switches control the size of @code{long double} type. The i386 
8347 application binary interface specifies the size to be 96 bits, 
8348 so @option{-m96bit-long-double} is the default in 32 bit mode.
8350 Modern architectures (Pentium and newer) would prefer @code{long double}
8351 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8352 conforming to the ABI, this would not be possible.  So specifying a 
8353 @option{-m128bit-long-double} will align @code{long double}
8354 to a 16 byte boundary by padding the @code{long double} with an additional
8355 32 bit zero. 
8357 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8358 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8360 Notice that neither of these options enable any extra precision over the x87
8361 standard of 80 bits for a @code{long double}. 
8363 @strong{Warning:} if you override the default value for your target ABI, the
8364 structures and arrays containing @code{long double} will change their size as
8365 well as function calling convention for function taking @code{long double}
8366 will be modified.  Hence they will not be binary compatible with arrays or
8367 structures in code compiled without that switch.
8370 @item -msvr3-shlib
8371 @itemx -mno-svr3-shlib
8372 @opindex msvr3-shlib
8373 @opindex mno-svr3-shlib
8374 Control whether GCC places uninitialized local variables into the
8375 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8376 into @code{bss}.  These options are meaningful only on System V Release 3.
8378 @item -mrtd
8379 @opindex mrtd
8380 Use a different function-calling convention, in which functions that
8381 take a fixed number of arguments return with the @code{ret} @var{num}
8382 instruction, which pops their arguments while returning.  This saves one
8383 instruction in the caller since there is no need to pop the arguments
8384 there.
8386 You can specify that an individual function is called with this calling
8387 sequence with the function attribute @samp{stdcall}.  You can also
8388 override the @option{-mrtd} option by using the function attribute
8389 @samp{cdecl}.  @xref{Function Attributes}.
8391 @strong{Warning:} this calling convention is incompatible with the one
8392 normally used on Unix, so you cannot use it if you need to call
8393 libraries compiled with the Unix compiler.
8395 Also, you must provide function prototypes for all functions that
8396 take variable numbers of arguments (including @code{printf});
8397 otherwise incorrect code will be generated for calls to those
8398 functions.
8400 In addition, seriously incorrect code will result if you call a
8401 function with too many arguments.  (Normally, extra arguments are
8402 harmlessly ignored.)
8404 @item -mregparm=@var{num}
8405 @opindex mregparm
8406 Control how many registers are used to pass integer arguments.  By
8407 default, no registers are used to pass arguments, and at most 3
8408 registers can be used.  You can control this behavior for a specific
8409 function by using the function attribute @samp{regparm}.
8410 @xref{Function Attributes}.
8412 @strong{Warning:} if you use this switch, and
8413 @var{num} is nonzero, then you must build all modules with the same
8414 value, including any libraries.  This includes the system libraries and
8415 startup modules.
8417 @item -mpreferred-stack-boundary=@var{num}
8418 @opindex mpreferred-stack-boundary
8419 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8420 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8421 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8422 size (@option{-Os}), in which case the default is the minimum correct
8423 alignment (4 bytes for x86, and 8 bytes for x86-64).
8425 On Pentium and PentiumPro, @code{double} and @code{long double} values
8426 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8427 suffer significant run time performance penalties.  On Pentium III, the
8428 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8429 penalties if it is not 16 byte aligned.
8431 To ensure proper alignment of this values on the stack, the stack boundary
8432 must be as aligned as that required by any value stored on the stack.
8433 Further, every function must be generated such that it keeps the stack
8434 aligned.  Thus calling a function compiled with a higher preferred
8435 stack boundary from a function compiled with a lower preferred stack
8436 boundary will most likely misalign the stack.  It is recommended that
8437 libraries that use callbacks always use the default setting.
8439 This extra alignment does consume extra stack space, and generally
8440 increases code size.  Code that is sensitive to stack space usage, such
8441 as embedded systems and operating system kernels, may want to reduce the
8442 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8444 @item -mmmx
8445 @itemx -mno-mmx
8446 @item -msse
8447 @itemx -mno-sse
8448 @item -msse2
8449 @itemx -mno-sse2
8450 @item -mpni
8451 @itemx -mno-pni
8452 @item -m3dnow
8453 @itemx -mno-3dnow
8454 @opindex mmmx
8455 @opindex mno-mmx
8456 @opindex msse
8457 @opindex mno-sse
8458 @opindex m3dnow
8459 @opindex mno-3dnow
8460 These switches enable or disable the use of built-in functions that allow
8461 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8463 @xref{X86 Built-in Functions}, for details of the functions enabled
8464 and disabled by these switches.
8466 To have SSE/SSE2 instructions generated automatically from floating-point
8467 code, see @option{-mfpmath=sse}.
8469 @item -mpush-args
8470 @itemx -mno-push-args
8471 @opindex mpush-args
8472 @opindex mno-push-args
8473 Use PUSH operations to store outgoing parameters.  This method is shorter
8474 and usually equally fast as method using SUB/MOV operations and is enabled
8475 by default.  In some cases disabling it may improve performance because of
8476 improved scheduling and reduced dependencies.
8478 @item -maccumulate-outgoing-args
8479 @opindex maccumulate-outgoing-args
8480 If enabled, the maximum amount of space required for outgoing arguments will be
8481 computed in the function prologue.  This is faster on most modern CPUs
8482 because of reduced dependencies, improved scheduling and reduced stack usage
8483 when preferred stack boundary is not equal to 2.  The drawback is a notable
8484 increase in code size.  This switch implies @option{-mno-push-args}.
8486 @item -mthreads
8487 @opindex mthreads
8488 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8489 on thread-safe exception handling must compile and link all code with the
8490 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8491 @option{-D_MT}; when linking, it links in a special thread helper library
8492 @option{-lmingwthrd} which cleans up per thread exception handling data.
8494 @item -mno-align-stringops
8495 @opindex mno-align-stringops
8496 Do not align destination of inlined string operations.  This switch reduces
8497 code size and improves performance in case the destination is already aligned,
8498 but gcc don't know about it.
8500 @item -minline-all-stringops
8501 @opindex minline-all-stringops
8502 By default GCC inlines string operations only when destination is known to be
8503 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8504 size, but may improve performance of code that depends on fast memcpy, strlen
8505 and memset for short lengths.
8507 @item -momit-leaf-frame-pointer
8508 @opindex momit-leaf-frame-pointer
8509 Don't keep the frame pointer in a register for leaf functions.  This
8510 avoids the instructions to save, set up and restore frame pointers and
8511 makes an extra register available in leaf functions.  The option
8512 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8513 which might make debugging harder.
8515 @item -mtls-direct-seg-refs
8516 @itemx -mno-tls-direct-seg-refs
8517 @opindex mtls-direct-seg-refs
8518 Controls whether TLS variables may be accessed with offsets from the
8519 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8520 or whether the thread base pointer must be added.  Whether or not this
8521 is legal depends on the operating system, and whether it maps the
8522 segment to cover the entire TLS area.
8524 For systems that use GNU libc, the default is on.
8525 @end table
8527 These @samp{-m} switches are supported in addition to the above
8528 on AMD x86-64 processors in 64-bit environments.
8530 @table @gcctabopt
8531 @item -m32
8532 @itemx -m64
8533 @opindex m32
8534 @opindex m64
8535 Generate code for a 32-bit or 64-bit environment.
8536 The 32-bit environment sets int, long and pointer to 32 bits and
8537 generates code that runs on any i386 system.
8538 The 64-bit environment sets int to 32 bits and long and pointer
8539 to 64 bits and generates code for AMD's x86-64 architecture.
8541 @item -mno-red-zone
8542 @opindex no-red-zone
8543 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8544 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8545 stack pointer that will not be modified by signal or interrupt handlers
8546 and therefore can be used for temporary data without adjusting the stack
8547 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8549 @item -mcmodel=small
8550 @opindex mcmodel=small
8551 Generate code for the small code model: the program and its symbols must
8552 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8553 Programs can be statically or dynamically linked.  This is the default
8554 code model.
8556 @item -mcmodel=kernel
8557 @opindex mcmodel=kernel
8558 Generate code for the kernel code model.  The kernel runs in the
8559 negative 2 GB of the address space.
8560 This model has to be used for Linux kernel code.
8562 @item -mcmodel=medium
8563 @opindex mcmodel=medium
8564 Generate code for the medium model: The program is linked in the lower 2
8565 GB of the address space but symbols can be located anywhere in the
8566 address space.  Programs can be statically or dynamically linked, but
8567 building of shared libraries are not supported with the medium model.
8569 @item -mcmodel=large
8570 @opindex mcmodel=large
8571 Generate code for the large model: This model makes no assumptions
8572 about addresses and sizes of sections.  Currently GCC does not implement
8573 this model.
8574 @end table
8576 @node HPPA Options
8577 @subsection HPPA Options
8578 @cindex HPPA Options
8580 These @samp{-m} options are defined for the HPPA family of computers:
8582 @table @gcctabopt
8583 @item -march=@var{architecture-type}
8584 @opindex march
8585 Generate code for the specified architecture.  The choices for
8586 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8587 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8588 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8589 architecture option for your machine.  Code compiled for lower numbered
8590 architectures will run on higher numbered architectures, but not the
8591 other way around.
8593 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8594 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8595 support.
8597 @item -mpa-risc-1-0
8598 @itemx -mpa-risc-1-1
8599 @itemx -mpa-risc-2-0
8600 @opindex mpa-risc-1-0
8601 @opindex mpa-risc-1-1
8602 @opindex mpa-risc-2-0
8603 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8605 @item -mbig-switch
8606 @opindex mbig-switch
8607 Generate code suitable for big switch tables.  Use this option only if
8608 the assembler/linker complain about out of range branches within a switch
8609 table.
8611 @item -mjump-in-delay
8612 @opindex mjump-in-delay
8613 Fill delay slots of function calls with unconditional jump instructions
8614 by modifying the return pointer for the function call to be the target
8615 of the conditional jump.
8617 @item -mdisable-fpregs
8618 @opindex mdisable-fpregs
8619 Prevent floating point registers from being used in any manner.  This is
8620 necessary for compiling kernels which perform lazy context switching of
8621 floating point registers.  If you use this option and attempt to perform
8622 floating point operations, the compiler will abort.
8624 @item -mdisable-indexing
8625 @opindex mdisable-indexing
8626 Prevent the compiler from using indexing address modes.  This avoids some
8627 rather obscure problems when compiling MIG generated code under MACH@.
8629 @item -mno-space-regs
8630 @opindex mno-space-regs
8631 Generate code that assumes the target has no space registers.  This allows
8632 GCC to generate faster indirect calls and use unscaled index address modes.
8634 Such code is suitable for level 0 PA systems and kernels.
8636 @item -mfast-indirect-calls
8637 @opindex mfast-indirect-calls
8638 Generate code that assumes calls never cross space boundaries.  This
8639 allows GCC to emit code which performs faster indirect calls.
8641 This option will not work in the presence of shared libraries or nested
8642 functions.
8644 @item -mlong-load-store
8645 @opindex mlong-load-store
8646 Generate 3-instruction load and store sequences as sometimes required by
8647 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8648 the HP compilers.
8650 @item -mportable-runtime
8651 @opindex mportable-runtime
8652 Use the portable calling conventions proposed by HP for ELF systems.
8654 @item -mgas
8655 @opindex mgas
8656 Enable the use of assembler directives only GAS understands.
8658 @item -mschedule=@var{cpu-type}
8659 @opindex mschedule
8660 Schedule code according to the constraints for the machine type
8661 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8662 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8663 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8664 proper scheduling option for your machine.  The default scheduling is
8665 @samp{8000}.
8667 @item -mlinker-opt
8668 @opindex mlinker-opt
8669 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8670 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8671 linkers in which they give bogus error messages when linking some programs.
8673 @item -msoft-float
8674 @opindex msoft-float
8675 Generate output containing library calls for floating point.
8676 @strong{Warning:} the requisite libraries are not available for all HPPA
8677 targets.  Normally the facilities of the machine's usual C compiler are
8678 used, but this cannot be done directly in cross-compilation.  You must make
8679 your own arrangements to provide suitable library functions for
8680 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8681 does provide software floating point support.
8683 @option{-msoft-float} changes the calling convention in the output file;
8684 therefore, it is only useful if you compile @emph{all} of a program with
8685 this option.  In particular, you need to compile @file{libgcc.a}, the
8686 library that comes with GCC, with @option{-msoft-float} in order for
8687 this to work.
8689 @item -msio
8690 @opindex msio
8691 Generate the predefine, @code{_SIO}, for server IO.  The default is
8692 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8693 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8694 options are available under HP-UX and HI-UX.
8696 @item -mgnu-ld
8697 @opindex gnu-ld
8698 Use GNU ld specific options.  This passes @option{-shared} to ld when
8699 building a shared library.  It is the default when GCC is configured,
8700 explicitly or implicitly, with the GNU linker.  This option does not
8701 have any affect on which ld is called, it only changes what parameters
8702 are passed to that ld.  The ld that is called is determined by the
8703 @option{--with-ld} configure option, gcc's program search path, and
8704 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8705 using @samp{which `gcc -print-prog-name=ld`}.
8707 @item -mhp-ld
8708 @opindex hp-ld
8709 Use HP ld specific options.  This passes @option{-b} to ld when building
8710 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8711 links.  It is the default when GCC is configured, explicitly or
8712 implicitly, with the HP linker.  This option does not have any affect on
8713 which ld is called, it only changes what parameters are passed to that
8714 ld.  The ld that is called is determined by the @option{--with-ld}
8715 configure option, gcc's program search path, and finally by the user's
8716 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8717 `gcc -print-prog-name=ld`}.
8719 @item -mlong-calls
8720 @opindex mno-long-calls
8721 Generate code that uses long call sequences.  This ensures that a call
8722 is always able to reach linker generated stubs.  The default is to generate
8723 long calls only when the distance from the call site to the beginning
8724 of the function or translation unit, as the case may be, exceeds a
8725 predefined limit set by the branch type being used.  The limits for
8726 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8727 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8728 240,000 bytes.
8730 Distances are measured from the beginning of functions when using the
8731 @option{-ffunction-sections} option, or when using the @option{-mgas}
8732 and @option{-mno-portable-runtime} options together under HP-UX with
8733 the SOM linker.
8735 It is normally not desirable to use this option as it will degrade
8736 performance.  However, it may be useful in large applications,
8737 particularly when partial linking is used to build the application.
8739 The types of long calls used depends on the capabilities of the
8740 assembler and linker, and the type of code being generated.  The
8741 impact on systems that support long absolute calls, and long pic
8742 symbol-difference or pc-relative calls should be relatively small.
8743 However, an indirect call is used on 32-bit ELF systems in pic code
8744 and it is quite long.
8746 @item -nolibdld
8747 @opindex nolibdld
8748 Suppress the generation of link options to search libdld.sl when the
8749 @option{-static} option is specified on HP-UX 10 and later.
8751 @item -static
8752 @opindex static
8753 The HP-UX implementation of setlocale in libc has a dependency on
8754 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8755 when the @option{-static} option is specified, special link options
8756 are needed to resolve this dependency.
8758 On HP-UX 10 and later, the GCC driver adds the necessary options to
8759 link with libdld.sl when the @option{-static} option is specified.
8760 This causes the resulting binary to be dynamic.  On the 64-bit port,
8761 the linkers generate dynamic binaries by default in any case.  The
8762 @option{-nolibdld} option can be used to prevent the GCC driver from
8763 adding these link options.
8765 @item -threads
8766 @opindex threads
8767 Add support for multithreading with the @dfn{dce thread} library
8768 under HP-UX.  This option sets flags for both the preprocessor and
8769 linker.
8770 @end table
8772 @node Intel 960 Options
8773 @subsection Intel 960 Options
8775 These @samp{-m} options are defined for the Intel 960 implementations:
8777 @table @gcctabopt
8778 @item -m@var{cpu-type}
8779 @opindex mka
8780 @opindex mkb
8781 @opindex mmc
8782 @opindex mca
8783 @opindex mcf
8784 @opindex msa
8785 @opindex msb
8786 Assume the defaults for the machine type @var{cpu-type} for some of
8787 the other options, including instruction scheduling, floating point
8788 support, and addressing modes.  The choices for @var{cpu-type} are
8789 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8790 @samp{sa}, and @samp{sb}.
8791 The default is
8792 @samp{kb}.
8794 @item -mnumerics
8795 @itemx -msoft-float
8796 @opindex mnumerics
8797 @opindex msoft-float
8798 The @option{-mnumerics} option indicates that the processor does support
8799 floating-point instructions.  The @option{-msoft-float} option indicates
8800 that floating-point support should not be assumed.
8802 @item -mleaf-procedures
8803 @itemx -mno-leaf-procedures
8804 @opindex mleaf-procedures
8805 @opindex mno-leaf-procedures
8806 Do (or do not) attempt to alter leaf procedures to be callable with the
8807 @code{bal} instruction as well as @code{call}.  This will result in more
8808 efficient code for explicit calls when the @code{bal} instruction can be
8809 substituted by the assembler or linker, but less efficient code in other
8810 cases, such as calls via function pointers, or using a linker that doesn't
8811 support this optimization.
8813 @item -mtail-call
8814 @itemx -mno-tail-call
8815 @opindex mtail-call
8816 @opindex mno-tail-call
8817 Do (or do not) make additional attempts (beyond those of the
8818 machine-independent portions of the compiler) to optimize tail-recursive
8819 calls into branches.  You may not want to do this because the detection of
8820 cases where this is not valid is not totally complete.  The default is
8821 @option{-mno-tail-call}.
8823 @item -mcomplex-addr
8824 @itemx -mno-complex-addr
8825 @opindex mcomplex-addr
8826 @opindex mno-complex-addr
8827 Assume (or do not assume) that the use of a complex addressing mode is a
8828 win on this implementation of the i960.  Complex addressing modes may not
8829 be worthwhile on the K-series, but they definitely are on the C-series.
8830 The default is currently @option{-mcomplex-addr} for all processors except
8831 the CB and CC@.
8833 @item -mcode-align
8834 @itemx -mno-code-align
8835 @opindex mcode-align
8836 @opindex mno-code-align
8837 Align code to 8-byte boundaries for faster fetching (or don't bother).
8838 Currently turned on by default for C-series implementations only.
8840 @ignore
8841 @item -mclean-linkage
8842 @itemx -mno-clean-linkage
8843 @opindex mclean-linkage
8844 @opindex mno-clean-linkage
8845 These options are not fully implemented.
8846 @end ignore
8848 @item -mic-compat
8849 @itemx -mic2.0-compat
8850 @itemx -mic3.0-compat
8851 @opindex mic-compat
8852 @opindex mic2.0-compat
8853 @opindex mic3.0-compat
8854 Enable compatibility with iC960 v2.0 or v3.0.
8856 @item -masm-compat
8857 @itemx -mintel-asm
8858 @opindex masm-compat
8859 @opindex mintel-asm
8860 Enable compatibility with the iC960 assembler.
8862 @item -mstrict-align
8863 @itemx -mno-strict-align
8864 @opindex mstrict-align
8865 @opindex mno-strict-align
8866 Do not permit (do permit) unaligned accesses.
8868 @item -mold-align
8869 @opindex mold-align
8870 Enable structure-alignment compatibility with Intel's gcc release version
8871 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8873 @item -mlong-double-64
8874 @opindex mlong-double-64
8875 Implement type @samp{long double} as 64-bit floating point numbers.
8876 Without the option @samp{long double} is implemented by 80-bit
8877 floating point numbers.  The only reason we have it because there is
8878 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8879 is only useful for people using soft-float targets.  Otherwise, we
8880 should recommend against use of it.
8882 @end table
8884 @node DEC Alpha Options
8885 @subsection DEC Alpha Options
8887 These @samp{-m} options are defined for the DEC Alpha implementations:
8889 @table @gcctabopt
8890 @item -mno-soft-float
8891 @itemx -msoft-float
8892 @opindex mno-soft-float
8893 @opindex msoft-float
8894 Use (do not use) the hardware floating-point instructions for
8895 floating-point operations.  When @option{-msoft-float} is specified,
8896 functions in @file{libgcc.a} will be used to perform floating-point
8897 operations.  Unless they are replaced by routines that emulate the
8898 floating-point operations, or compiled in such a way as to call such
8899 emulations routines, these routines will issue floating-point
8900 operations.   If you are compiling for an Alpha without floating-point
8901 operations, you must ensure that the library is built so as not to call
8902 them.
8904 Note that Alpha implementations without floating-point operations are
8905 required to have floating-point registers.
8907 @item -mfp-reg
8908 @itemx -mno-fp-regs
8909 @opindex mfp-reg
8910 @opindex mno-fp-regs
8911 Generate code that uses (does not use) the floating-point register set.
8912 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8913 register set is not used, floating point operands are passed in integer
8914 registers as if they were integers and floating-point results are passed
8915 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8916 so any function with a floating-point argument or return value called by code
8917 compiled with @option{-mno-fp-regs} must also be compiled with that
8918 option.
8920 A typical use of this option is building a kernel that does not use,
8921 and hence need not save and restore, any floating-point registers.
8923 @item -mieee
8924 @opindex mieee
8925 The Alpha architecture implements floating-point hardware optimized for
8926 maximum performance.  It is mostly compliant with the IEEE floating
8927 point standard.  However, for full compliance, software assistance is
8928 required.  This option generates code fully IEEE compliant code
8929 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8930 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8931 defined during compilation.  The resulting code is less efficient but is
8932 able to correctly support denormalized numbers and exceptional IEEE
8933 values such as not-a-number and plus/minus infinity.  Other Alpha
8934 compilers call this option @option{-ieee_with_no_inexact}.
8936 @item -mieee-with-inexact
8937 @opindex mieee-with-inexact
8938 This is like @option{-mieee} except the generated code also maintains
8939 the IEEE @var{inexact-flag}.  Turning on this option causes the
8940 generated code to implement fully-compliant IEEE math.  In addition to
8941 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8942 macro.  On some Alpha implementations the resulting code may execute
8943 significantly slower than the code generated by default.  Since there is
8944 very little code that depends on the @var{inexact-flag}, you should
8945 normally not specify this option.  Other Alpha compilers call this
8946 option @option{-ieee_with_inexact}.
8948 @item -mfp-trap-mode=@var{trap-mode}
8949 @opindex mfp-trap-mode
8950 This option controls what floating-point related traps are enabled.
8951 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8952 The trap mode can be set to one of four values:
8954 @table @samp
8955 @item n
8956 This is the default (normal) setting.  The only traps that are enabled
8957 are the ones that cannot be disabled in software (e.g., division by zero
8958 trap).
8960 @item u
8961 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8962 as well.
8964 @item su
8965 Like @samp{su}, but the instructions are marked to be safe for software
8966 completion (see Alpha architecture manual for details).
8968 @item sui
8969 Like @samp{su}, but inexact traps are enabled as well.
8970 @end table
8972 @item -mfp-rounding-mode=@var{rounding-mode}
8973 @opindex mfp-rounding-mode
8974 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8975 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8978 @table @samp
8979 @item n
8980 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8981 the nearest machine number or towards the even machine number in case
8982 of a tie.
8984 @item m
8985 Round towards minus infinity.
8987 @item c
8988 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8990 @item d
8991 Dynamic rounding mode.  A field in the floating point control register
8992 (@var{fpcr}, see Alpha architecture reference manual) controls the
8993 rounding mode in effect.  The C library initializes this register for
8994 rounding towards plus infinity.  Thus, unless your program modifies the
8995 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8996 @end table
8998 @item -mtrap-precision=@var{trap-precision}
8999 @opindex mtrap-precision
9000 In the Alpha architecture, floating point traps are imprecise.  This
9001 means without software assistance it is impossible to recover from a
9002 floating trap and program execution normally needs to be terminated.
9003 GCC can generate code that can assist operating system trap handlers
9004 in determining the exact location that caused a floating point trap.
9005 Depending on the requirements of an application, different levels of
9006 precisions can be selected:
9008 @table @samp
9009 @item p
9010 Program precision.  This option is the default and means a trap handler
9011 can only identify which program caused a floating point exception.
9013 @item f
9014 Function precision.  The trap handler can determine the function that
9015 caused a floating point exception.
9017 @item i
9018 Instruction precision.  The trap handler can determine the exact
9019 instruction that caused a floating point exception.
9020 @end table
9022 Other Alpha compilers provide the equivalent options called
9023 @option{-scope_safe} and @option{-resumption_safe}.
9025 @item -mieee-conformant
9026 @opindex mieee-conformant
9027 This option marks the generated code as IEEE conformant.  You must not
9028 use this option unless you also specify @option{-mtrap-precision=i} and either
9029 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9030 is to emit the line @samp{.eflag 48} in the function prologue of the
9031 generated assembly file.  Under DEC Unix, this has the effect that
9032 IEEE-conformant math library routines will be linked in.
9034 @item -mbuild-constants
9035 @opindex mbuild-constants
9036 Normally GCC examines a 32- or 64-bit integer constant to
9037 see if it can construct it from smaller constants in two or three
9038 instructions.  If it cannot, it will output the constant as a literal and
9039 generate code to load it from the data segment at runtime.
9041 Use this option to require GCC to construct @emph{all} integer constants
9042 using code, even if it takes more instructions (the maximum is six).
9044 You would typically use this option to build a shared library dynamic
9045 loader.  Itself a shared library, it must relocate itself in memory
9046 before it can find the variables and constants in its own data segment.
9048 @item -malpha-as
9049 @itemx -mgas
9050 @opindex malpha-as
9051 @opindex mgas
9052 Select whether to generate code to be assembled by the vendor-supplied
9053 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9055 @item -mbwx
9056 @itemx -mno-bwx
9057 @itemx -mcix
9058 @itemx -mno-cix
9059 @itemx -mfix
9060 @itemx -mno-fix
9061 @itemx -mmax
9062 @itemx -mno-max
9063 @opindex mbwx
9064 @opindex mno-bwx
9065 @opindex mcix
9066 @opindex mno-cix
9067 @opindex mfix
9068 @opindex mno-fix
9069 @opindex mmax
9070 @opindex mno-max
9071 Indicate whether GCC should generate code to use the optional BWX,
9072 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9073 sets supported by the CPU type specified via @option{-mcpu=} option or that
9074 of the CPU on which GCC was built if none was specified.
9076 @item -mfloat-vax
9077 @itemx -mfloat-ieee
9078 @opindex mfloat-vax
9079 @opindex mfloat-ieee
9080 Generate code that uses (does not use) VAX F and G floating point
9081 arithmetic instead of IEEE single and double precision.
9083 @item -mexplicit-relocs
9084 @itemx -mno-explicit-relocs
9085 @opindex mexplicit-relocs
9086 @opindex mno-explicit-relocs
9087 Older Alpha assemblers provided no way to generate symbol relocations
9088 except via assembler macros.  Use of these macros does not allow
9089 optimal instruction scheduling.  GNU binutils as of version 2.12
9090 supports a new syntax that allows the compiler to explicitly mark
9091 which relocations should apply to which instructions.  This option
9092 is mostly useful for debugging, as GCC detects the capabilities of
9093 the assembler when it is built and sets the default accordingly.
9095 @item -msmall-data
9096 @itemx -mlarge-data
9097 @opindex msmall-data
9098 @opindex mlarge-data
9099 When @option{-mexplicit-relocs} is in effect, static data is
9100 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9101 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9102 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9103 16-bit relocations off of the @code{$gp} register.  This limits the
9104 size of the small data area to 64KB, but allows the variables to be
9105 directly accessed via a single instruction.
9107 The default is @option{-mlarge-data}.  With this option the data area
9108 is limited to just below 2GB.  Programs that require more than 2GB of
9109 data must use @code{malloc} or @code{mmap} to allocate the data in the
9110 heap instead of in the program's data segment.
9112 When generating code for shared libraries, @option{-fpic} implies
9113 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9115 @item -msmall-text
9116 @itemx -mlarge-text
9117 @opindex msmall-text
9118 @opindex mlarge-text
9119 When @option{-msmall-text} is used, the compiler assumes that the
9120 code of the entire program (or shared library) fits in 4MB, and is
9121 thus reachable with a branch instruction.  When @option{-msmall-data}
9122 is used, the compiler can assume that all local symbols share the
9123 same @code{$gp} value, and thus reduce the number of instructions
9124 required for a function call from 4 to 1.
9126 The default is @option{-mlarge-text}.
9128 @item -mcpu=@var{cpu_type}
9129 @opindex mcpu
9130 Set the instruction set and instruction scheduling parameters for
9131 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9132 style name or the corresponding chip number.  GCC supports scheduling
9133 parameters for the EV4, EV5 and EV6 family of processors and will
9134 choose the default values for the instruction set from the processor
9135 you specify.  If you do not specify a processor type, GCC will default
9136 to the processor on which the compiler was built.
9138 Supported values for @var{cpu_type} are
9140 @table @samp
9141 @item ev4
9142 @item ev45
9143 @itemx 21064
9144 Schedules as an EV4 and has no instruction set extensions.
9146 @item ev5
9147 @itemx 21164
9148 Schedules as an EV5 and has no instruction set extensions.
9150 @item ev56
9151 @itemx 21164a
9152 Schedules as an EV5 and supports the BWX extension.
9154 @item pca56
9155 @itemx 21164pc
9156 @itemx 21164PC
9157 Schedules as an EV5 and supports the BWX and MAX extensions.
9159 @item ev6
9160 @itemx 21264
9161 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9163 @item ev67
9164 @item 21264a
9165 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9166 @end table
9168 @item -mtune=@var{cpu_type}
9169 @opindex mtune
9170 Set only the instruction scheduling parameters for machine type
9171 @var{cpu_type}.  The instruction set is not changed.
9173 @item -mmemory-latency=@var{time}
9174 @opindex mmemory-latency
9175 Sets the latency the scheduler should assume for typical memory
9176 references as seen by the application.  This number is highly
9177 dependent on the memory access patterns used by the application
9178 and the size of the external cache on the machine.
9180 Valid options for @var{time} are
9182 @table @samp
9183 @item @var{number}
9184 A decimal number representing clock cycles.
9186 @item L1
9187 @itemx L2
9188 @itemx L3
9189 @itemx main
9190 The compiler contains estimates of the number of clock cycles for
9191 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9192 (also called Dcache, Scache, and Bcache), as well as to main memory.
9193 Note that L3 is only valid for EV5.
9195 @end table
9196 @end table
9198 @node DEC Alpha/VMS Options
9199 @subsection DEC Alpha/VMS Options
9201 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9203 @table @gcctabopt
9204 @item -mvms-return-codes
9205 @opindex mvms-return-codes
9206 Return VMS condition codes from main.  The default is to return POSIX
9207 style condition (e.g.@ error) codes.
9208 @end table
9210 @node H8/300 Options
9211 @subsection H8/300 Options
9213 These @samp{-m} options are defined for the H8/300 implementations:
9215 @table @gcctabopt
9216 @item -mrelax
9217 @opindex mrelax
9218 Shorten some address references at link time, when possible; uses the
9219 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9220 ld.info, Using ld}, for a fuller description.
9222 @item -mh
9223 @opindex mh
9224 Generate code for the H8/300H@.
9226 @item -ms
9227 @opindex ms
9228 Generate code for the H8S@.
9230 @item -mn
9231 @opindex mn
9232 Generate code for the H8S and H8/300H in the normal mode.  This switch
9233 must be used either with -mh or -ms.
9235 @item -ms2600
9236 @opindex ms2600
9237 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9239 @item -mint32
9240 @opindex mint32
9241 Make @code{int} data 32 bits by default.
9243 @item -malign-300
9244 @opindex malign-300
9245 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9246 The default for the H8/300H and H8S is to align longs and floats on 4
9247 byte boundaries.
9248 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9249 This option has no effect on the H8/300.
9250 @end table
9252 @node SH Options
9253 @subsection SH Options
9255 These @samp{-m} options are defined for the SH implementations:
9257 @table @gcctabopt
9258 @item -m1
9259 @opindex m1
9260 Generate code for the SH1.
9262 @item -m2
9263 @opindex m2
9264 Generate code for the SH2.
9266 @item -m2e
9267 Generate code for the SH2e.
9269 @item -m3
9270 @opindex m3
9271 Generate code for the SH3.
9273 @item -m3e
9274 @opindex m3e
9275 Generate code for the SH3e.
9277 @item -m4-nofpu
9278 @opindex m4-nofpu
9279 Generate code for the SH4 without a floating-point unit.
9281 @item -m4-single-only
9282 @opindex m4-single-only
9283 Generate code for the SH4 with a floating-point unit that only
9284 supports single-precision arithmetic.
9286 @item -m4-single
9287 @opindex m4-single
9288 Generate code for the SH4 assuming the floating-point unit is in
9289 single-precision mode by default.
9291 @item -m4
9292 @opindex m4
9293 Generate code for the SH4.
9295 @item -mb
9296 @opindex mb
9297 Compile code for the processor in big endian mode.
9299 @item -ml
9300 @opindex ml
9301 Compile code for the processor in little endian mode.
9303 @item -mdalign
9304 @opindex mdalign
9305 Align doubles at 64-bit boundaries.  Note that this changes the calling
9306 conventions, and thus some functions from the standard C library will
9307 not work unless you recompile it first with @option{-mdalign}.
9309 @item -mrelax
9310 @opindex mrelax
9311 Shorten some address references at link time, when possible; uses the
9312 linker option @option{-relax}.
9314 @item -mbigtable
9315 @opindex mbigtable
9316 Use 32-bit offsets in @code{switch} tables.  The default is to use
9317 16-bit offsets.
9319 @item -mfmovd
9320 @opindex mfmovd
9321 Enable the use of the instruction @code{fmovd}.
9323 @item -mhitachi
9324 @opindex mhitachi
9325 Comply with the calling conventions defined by Renesas.
9327 @item -mnomacsave
9328 @opindex mnomacsave
9329 Mark the @code{MAC} register as call-clobbered, even if
9330 @option{-mhitachi} is given.
9332 @item -mieee
9333 @opindex mieee
9334 Increase IEEE-compliance of floating-point code.
9336 @item -misize
9337 @opindex misize
9338 Dump instruction size and location in the assembly code.
9340 @item -mpadstruct
9341 @opindex mpadstruct
9342 This option is deprecated.  It pads structures to multiple of 4 bytes,
9343 which is incompatible with the SH ABI@.
9345 @item -mspace
9346 @opindex mspace
9347 Optimize for space instead of speed.  Implied by @option{-Os}.
9349 @item -mprefergot
9350 @opindex mprefergot
9351 When generating position-independent code, emit function calls using
9352 the Global Offset Table instead of the Procedure Linkage Table.
9354 @item -musermode
9355 @opindex musermode
9356 Generate a library function call to invalidate instruction cache
9357 entries, after fixing up a trampoline.  This library function call
9358 doesn't assume it can write to the whole memory address space.  This
9359 is the default when the target is @code{sh-*-linux*}.
9360 @end table
9362 @node System V Options
9363 @subsection Options for System V
9365 These additional options are available on System V Release 4 for
9366 compatibility with other compilers on those systems:
9368 @table @gcctabopt
9369 @item -G
9370 @opindex G
9371 Create a shared object.
9372 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9374 @item -Qy
9375 @opindex Qy
9376 Identify the versions of each tool used by the compiler, in a
9377 @code{.ident} assembler directive in the output.
9379 @item -Qn
9380 @opindex Qn
9381 Refrain from adding @code{.ident} directives to the output file (this is
9382 the default).
9384 @item -YP,@var{dirs}
9385 @opindex YP
9386 Search the directories @var{dirs}, and no others, for libraries
9387 specified with @option{-l}.
9389 @item -Ym,@var{dir}
9390 @opindex Ym
9391 Look in the directory @var{dir} to find the M4 preprocessor.
9392 The assembler uses this option.
9393 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9394 @c the generic assembler that comes with Solaris takes just -Ym.
9395 @end table
9397 @node TMS320C3x/C4x Options
9398 @subsection TMS320C3x/C4x Options
9399 @cindex TMS320C3x/C4x Options
9401 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9403 @table @gcctabopt
9405 @item -mcpu=@var{cpu_type}
9406 @opindex mcpu
9407 Set the instruction set, register set, and instruction scheduling
9408 parameters for machine type @var{cpu_type}.  Supported values for
9409 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9410 @samp{c44}.  The default is @samp{c40} to generate code for the
9411 TMS320C40.
9413 @item -mbig-memory
9414 @item -mbig
9415 @itemx -msmall-memory
9416 @itemx -msmall
9417 @opindex mbig-memory
9418 @opindex mbig
9419 @opindex msmall-memory
9420 @opindex msmall
9421 Generates code for the big or small memory model.  The small memory
9422 model assumed that all data fits into one 64K word page.  At run-time
9423 the data page (DP) register must be set to point to the 64K page
9424 containing the .bss and .data program sections.  The big memory model is
9425 the default and requires reloading of the DP register for every direct
9426 memory access.
9428 @item -mbk
9429 @itemx -mno-bk
9430 @opindex mbk
9431 @opindex mno-bk
9432 Allow (disallow) allocation of general integer operands into the block
9433 count register BK@.
9435 @item -mdb
9436 @itemx -mno-db
9437 @opindex mdb
9438 @opindex mno-db
9439 Enable (disable) generation of code using decrement and branch,
9440 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9441 on the safe side, this is disabled for the C3x, since the maximum
9442 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9443 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9444 that it can utilize the decrement and branch instruction, but will give
9445 up if there is more than one memory reference in the loop.  Thus a loop
9446 where the loop counter is decremented can generate slightly more
9447 efficient code, in cases where the RPTB instruction cannot be utilized.
9449 @item -mdp-isr-reload
9450 @itemx -mparanoid
9451 @opindex mdp-isr-reload
9452 @opindex mparanoid
9453 Force the DP register to be saved on entry to an interrupt service
9454 routine (ISR), reloaded to point to the data section, and restored on
9455 exit from the ISR@.  This should not be required unless someone has
9456 violated the small memory model by modifying the DP register, say within
9457 an object library.
9459 @item -mmpyi
9460 @itemx -mno-mpyi
9461 @opindex mmpyi
9462 @opindex mno-mpyi
9463 For the C3x use the 24-bit MPYI instruction for integer multiplies
9464 instead of a library call to guarantee 32-bit results.  Note that if one
9465 of the operands is a constant, then the multiplication will be performed
9466 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9467 then squaring operations are performed inline instead of a library call.
9469 @item -mfast-fix
9470 @itemx -mno-fast-fix
9471 @opindex mfast-fix
9472 @opindex mno-fast-fix
9473 The C3x/C4x FIX instruction to convert a floating point value to an
9474 integer value chooses the nearest integer less than or equal to the
9475 floating point value rather than to the nearest integer.  Thus if the
9476 floating point number is negative, the result will be incorrectly
9477 truncated an additional code is necessary to detect and correct this
9478 case.  This option can be used to disable generation of the additional
9479 code required to correct the result.
9481 @item -mrptb
9482 @itemx -mno-rptb
9483 @opindex mrptb
9484 @opindex mno-rptb
9485 Enable (disable) generation of repeat block sequences using the RPTB
9486 instruction for zero overhead looping.  The RPTB construct is only used
9487 for innermost loops that do not call functions or jump across the loop
9488 boundaries.  There is no advantage having nested RPTB loops due to the
9489 overhead required to save and restore the RC, RS, and RE registers.
9490 This is enabled by default with @option{-O2}.
9492 @item -mrpts=@var{count}
9493 @itemx -mno-rpts
9494 @opindex mrpts
9495 @opindex mno-rpts
9496 Enable (disable) the use of the single instruction repeat instruction
9497 RPTS@.  If a repeat block contains a single instruction, and the loop
9498 count can be guaranteed to be less than the value @var{count}, GCC will
9499 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9500 then a RPTS will be emitted even if the loop count cannot be determined
9501 at compile time.  Note that the repeated instruction following RPTS does
9502 not have to be reloaded from memory each iteration, thus freeing up the
9503 CPU buses for operands.  However, since interrupts are blocked by this
9504 instruction, it is disabled by default.
9506 @item -mloop-unsigned
9507 @itemx -mno-loop-unsigned
9508 @opindex mloop-unsigned
9509 @opindex mno-loop-unsigned
9510 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9511 is @math{2^{31} + 1} since these instructions test if the iteration count is
9512 negative to terminate the loop.  If the iteration count is unsigned
9513 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9514 exceeded.  This switch allows an unsigned iteration count.
9516 @item -mti
9517 @opindex mti
9518 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9519 with.  This also enforces compatibility with the API employed by the TI
9520 C3x C compiler.  For example, long doubles are passed as structures
9521 rather than in floating point registers.
9523 @item -mregparm
9524 @itemx -mmemparm
9525 @opindex mregparm
9526 @opindex mmemparm
9527 Generate code that uses registers (stack) for passing arguments to functions.
9528 By default, arguments are passed in registers where possible rather
9529 than by pushing arguments on to the stack.
9531 @item -mparallel-insns
9532 @itemx -mno-parallel-insns
9533 @opindex mparallel-insns
9534 @opindex mno-parallel-insns
9535 Allow the generation of parallel instructions.  This is enabled by
9536 default with @option{-O2}.
9538 @item -mparallel-mpy
9539 @itemx -mno-parallel-mpy
9540 @opindex mparallel-mpy
9541 @opindex mno-parallel-mpy
9542 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9543 provided @option{-mparallel-insns} is also specified.  These instructions have
9544 tight register constraints which can pessimize the code generation
9545 of large functions.
9547 @end table
9549 @node V850 Options
9550 @subsection V850 Options
9551 @cindex V850 Options
9553 These @samp{-m} options are defined for V850 implementations:
9555 @table @gcctabopt
9556 @item -mlong-calls
9557 @itemx -mno-long-calls
9558 @opindex mlong-calls
9559 @opindex mno-long-calls
9560 Treat all calls as being far away (near).  If calls are assumed to be
9561 far away, the compiler will always load the functions address up into a
9562 register, and call indirect through the pointer.
9564 @item -mno-ep
9565 @itemx -mep
9566 @opindex mno-ep
9567 @opindex mep
9568 Do not optimize (do optimize) basic blocks that use the same index
9569 pointer 4 or more times to copy pointer into the @code{ep} register, and
9570 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9571 option is on by default if you optimize.
9573 @item -mno-prolog-function
9574 @itemx -mprolog-function
9575 @opindex mno-prolog-function
9576 @opindex mprolog-function
9577 Do not use (do use) external functions to save and restore registers
9578 at the prologue and epilogue of a function.  The external functions
9579 are slower, but use less code space if more than one function saves
9580 the same number of registers.  The @option{-mprolog-function} option
9581 is on by default if you optimize.
9583 @item -mspace
9584 @opindex mspace
9585 Try to make the code as small as possible.  At present, this just turns
9586 on the @option{-mep} and @option{-mprolog-function} options.
9588 @item -mtda=@var{n}
9589 @opindex mtda
9590 Put static or global variables whose size is @var{n} bytes or less into
9591 the tiny data area that register @code{ep} points to.  The tiny data
9592 area can hold up to 256 bytes in total (128 bytes for byte references).
9594 @item -msda=@var{n}
9595 @opindex msda
9596 Put static or global variables whose size is @var{n} bytes or less into
9597 the small data area that register @code{gp} points to.  The small data
9598 area can hold up to 64 kilobytes.
9600 @item -mzda=@var{n}
9601 @opindex mzda
9602 Put static or global variables whose size is @var{n} bytes or less into
9603 the first 32 kilobytes of memory.
9605 @item -mv850
9606 @opindex mv850
9607 Specify that the target processor is the V850.
9609 @item -mbig-switch
9610 @opindex mbig-switch
9611 Generate code suitable for big switch tables.  Use this option only if
9612 the assembler/linker complain about out of range branches within a switch
9613 table.
9615 @item -mapp-regs
9616 @opindex mapp-regs
9617 This option will cause r2 and r5 to be used in the code generated by
9618 the compiler.  This setting is the default.
9620 @item -mno-app-regs
9621 @opindex mno-app-regs
9622 This option will cause r2 and r5 to be treated as fixed registers.
9623   
9624 @item -mv850e
9625 @opindex mv850e
9626 Specify that the target processor is the V850E.  The preprocessor
9627 constant @samp{__v850e__} will be defined if this option is used.
9629 If neither @option{-mv850} nor @option{-mv850e} are defined
9630 then a default target processor will be chosen and the relevant
9631 @samp{__v850*__} preprocessor constant will be defined.
9633 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9634 defined, regardless of which processor variant is the target.
9636 @item -mdisable-callt
9637 @opindex mdisable-callt
9638 This option will suppress generation of the CALLT instruction for the
9639 v850e flavors of the v850 architecture.  The default is
9640 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9642 @end table
9644 @node ARC Options
9645 @subsection ARC Options
9646 @cindex ARC Options
9648 These options are defined for ARC implementations:
9650 @table @gcctabopt
9651 @item -EL
9652 @opindex EL
9653 Compile code for little endian mode.  This is the default.
9655 @item -EB
9656 @opindex EB
9657 Compile code for big endian mode.
9659 @item -mmangle-cpu
9660 @opindex mmangle-cpu
9661 Prepend the name of the cpu to all public symbol names.
9662 In multiple-processor systems, there are many ARC variants with different
9663 instruction and register set characteristics.  This flag prevents code
9664 compiled for one cpu to be linked with code compiled for another.
9665 No facility exists for handling variants that are ``almost identical''.
9666 This is an all or nothing option.
9668 @item -mcpu=@var{cpu}
9669 @opindex mcpu
9670 Compile code for ARC variant @var{cpu}.
9671 Which variants are supported depend on the configuration.
9672 All variants support @option{-mcpu=base}, this is the default.
9674 @item -mtext=@var{text-section}
9675 @itemx -mdata=@var{data-section}
9676 @itemx -mrodata=@var{readonly-data-section}
9677 @opindex mtext
9678 @opindex mdata
9679 @opindex mrodata
9680 Put functions, data, and readonly data in @var{text-section},
9681 @var{data-section}, and @var{readonly-data-section} respectively
9682 by default.  This can be overridden with the @code{section} attribute.
9683 @xref{Variable Attributes}.
9685 @end table
9687 @node NS32K Options
9688 @subsection NS32K Options
9689 @cindex NS32K options
9691 These are the @samp{-m} options defined for the 32000 series.  The default
9692 values for these options depends on which style of 32000 was selected when
9693 the compiler was configured; the defaults for the most common choices are
9694 given below.
9696 @table @gcctabopt
9697 @item -m32032
9698 @itemx -m32032
9699 @opindex m32032
9700 @opindex m32032
9701 Generate output for a 32032.  This is the default
9702 when the compiler is configured for 32032 and 32016 based systems.
9704 @item -m32332
9705 @itemx -m32332
9706 @opindex m32332
9707 @opindex m32332
9708 Generate output for a 32332.  This is the default
9709 when the compiler is configured for 32332-based systems.
9711 @item -m32532
9712 @itemx -m32532
9713 @opindex m32532
9714 @opindex m32532
9715 Generate output for a 32532.  This is the default
9716 when the compiler is configured for 32532-based systems.
9718 @item -m32081
9719 @opindex m32081
9720 Generate output containing 32081 instructions for floating point.
9721 This is the default for all systems.
9723 @item -m32381
9724 @opindex m32381
9725 Generate output containing 32381 instructions for floating point.  This
9726 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9727 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9729 @item -mmulti-add
9730 @opindex mmulti-add
9731 Try and generate multiply-add floating point instructions @code{polyF}
9732 and @code{dotF}.  This option is only available if the @option{-m32381}
9733 option is in effect.  Using these instructions requires changes to
9734 register allocation which generally has a negative impact on
9735 performance.  This option should only be enabled when compiling code
9736 particularly likely to make heavy use of multiply-add instructions.
9738 @item -mnomulti-add
9739 @opindex mnomulti-add
9740 Do not try and generate multiply-add floating point instructions
9741 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9743 @item -msoft-float
9744 @opindex msoft-float
9745 Generate output containing library calls for floating point.
9746 @strong{Warning:} the requisite libraries may not be available.
9748 @item -mieee-compare
9749 @itemx -mno-ieee-compare
9750 @opindex mieee-compare
9751 @opindex mno-ieee-compare
9752 Control whether or not the compiler uses IEEE floating point
9753 comparisons.  These handle correctly the case where the result of a
9754 comparison is unordered.
9755 @strong{Warning:} the requisite kernel support may not be available.
9757 @item -mnobitfield
9758 @opindex mnobitfield
9759 Do not use the bit-field instructions.  On some machines it is faster to
9760 use shifting and masking operations.  This is the default for the pc532.
9762 @item -mbitfield
9763 @opindex mbitfield
9764 Do use the bit-field instructions.  This is the default for all platforms
9765 except the pc532.
9767 @item -mrtd
9768 @opindex mrtd
9769 Use a different function-calling convention, in which functions
9770 that take a fixed number of arguments return pop their
9771 arguments on return with the @code{ret} instruction.
9773 This calling convention is incompatible with the one normally
9774 used on Unix, so you cannot use it if you need to call libraries
9775 compiled with the Unix compiler.
9777 Also, you must provide function prototypes for all functions that
9778 take variable numbers of arguments (including @code{printf});
9779 otherwise incorrect code will be generated for calls to those
9780 functions.
9782 In addition, seriously incorrect code will result if you call a
9783 function with too many arguments.  (Normally, extra arguments are
9784 harmlessly ignored.)
9786 This option takes its name from the 680x0 @code{rtd} instruction.
9789 @item -mregparam
9790 @opindex mregparam
9791 Use a different function-calling convention where the first two arguments
9792 are passed in registers.
9794 This calling convention is incompatible with the one normally
9795 used on Unix, so you cannot use it if you need to call libraries
9796 compiled with the Unix compiler.
9798 @item -mnoregparam
9799 @opindex mnoregparam
9800 Do not pass any arguments in registers.  This is the default for all
9801 targets.
9803 @item -msb
9804 @opindex msb
9805 It is OK to use the sb as an index register which is always loaded with
9806 zero.  This is the default for the pc532-netbsd target.
9808 @item -mnosb
9809 @opindex mnosb
9810 The sb register is not available for use or has not been initialized to
9811 zero by the run time system.  This is the default for all targets except
9812 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9813 @option{-fpic} is set.
9815 @item -mhimem
9816 @opindex mhimem
9817 Many ns32000 series addressing modes use displacements of up to 512MB@.
9818 If an address is above 512MB then displacements from zero can not be used.
9819 This option causes code to be generated which can be loaded above 512MB@.
9820 This may be useful for operating systems or ROM code.
9822 @item -mnohimem
9823 @opindex mnohimem
9824 Assume code will be loaded in the first 512MB of virtual address space.
9825 This is the default for all platforms.
9828 @end table
9830 @node AVR Options
9831 @subsection AVR Options
9832 @cindex AVR Options
9834 These options are defined for AVR implementations:
9836 @table @gcctabopt
9837 @item -mmcu=@var{mcu}
9838 @opindex mmcu
9839 Specify ATMEL AVR instruction set or MCU type.
9841 Instruction set avr1 is for the minimal AVR core, not supported by the C
9842 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9843 attiny11, attiny12, attiny15, attiny28).
9845 Instruction set avr2 (default) is for the classic AVR core with up to
9846 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9847 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9848 at90c8534, at90s8535).
9850 Instruction set avr3 is for the classic AVR core with up to 128K program
9851 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9853 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9854 memory space (MCU types: atmega8, atmega83, atmega85).
9856 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9857 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9858 atmega64, atmega128, at43usb355, at94k).
9860 @item -msize
9861 @opindex msize
9862 Output instruction sizes to the asm file.
9864 @item -minit-stack=@var{N}
9865 @opindex minit-stack
9866 Specify the initial stack address, which may be a symbol or numeric value,
9867 @samp{__stack} is the default.
9869 @item -mno-interrupts
9870 @opindex mno-interrupts
9871 Generated code is not compatible with hardware interrupts.
9872 Code size will be smaller.
9874 @item -mcall-prologues
9875 @opindex mcall-prologues
9876 Functions prologues/epilogues expanded as call to appropriate
9877 subroutines.  Code size will be smaller.
9879 @item -mno-tablejump
9880 @opindex mno-tablejump
9881 Do not generate tablejump insns which sometimes increase code size.
9883 @item -mtiny-stack
9884 @opindex mtiny-stack
9885 Change only the low 8 bits of the stack pointer.
9886 @end table
9888 @node MCore Options
9889 @subsection MCore Options
9890 @cindex MCore options
9892 These are the @samp{-m} options defined for the Motorola M*Core
9893 processors.
9895 @table @gcctabopt
9897 @item -mhardlit
9898 @itemx -mno-hardlit
9899 @opindex mhardlit
9900 @opindex mno-hardlit
9901 Inline constants into the code stream if it can be done in two
9902 instructions or less.
9904 @item -mdiv
9905 @itemx -mno-div
9906 @opindex mdiv
9907 @opindex mno-div
9908 Use the divide instruction.  (Enabled by default).
9910 @item -mrelax-immediate
9911 @itemx -mno-relax-immediate
9912 @opindex mrelax-immediate
9913 @opindex mno-relax-immediate
9914 Allow arbitrary sized immediates in bit operations.
9916 @item -mwide-bitfields
9917 @itemx -mno-wide-bitfields
9918 @opindex mwide-bitfields
9919 @opindex mno-wide-bitfields
9920 Always treat bit-fields as int-sized.
9922 @item -m4byte-functions
9923 @itemx -mno-4byte-functions
9924 @opindex m4byte-functions
9925 @opindex mno-4byte-functions
9926 Force all functions to be aligned to a four byte boundary.
9928 @item -mcallgraph-data
9929 @itemx -mno-callgraph-data
9930 @opindex mcallgraph-data
9931 @opindex mno-callgraph-data
9932 Emit callgraph information.
9934 @item -mslow-bytes
9935 @itemx -mno-slow-bytes
9936 @opindex mslow-bytes
9937 @opindex mno-slow-bytes
9938 Prefer word access when reading byte quantities.
9940 @item -mlittle-endian
9941 @itemx -mbig-endian
9942 @opindex mlittle-endian
9943 @opindex mbig-endian
9944 Generate code for a little endian target.
9946 @item -m210
9947 @itemx -m340
9948 @opindex m210
9949 @opindex m340
9950 Generate code for the 210 processor.
9951 @end table
9953 @node IA-64 Options
9954 @subsection IA-64 Options
9955 @cindex IA-64 Options
9957 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9959 @table @gcctabopt
9960 @item -mbig-endian
9961 @opindex mbig-endian
9962 Generate code for a big endian target.  This is the default for HP-UX@.
9964 @item -mlittle-endian
9965 @opindex mlittle-endian
9966 Generate code for a little endian target.  This is the default for AIX5
9967 and Linux.
9969 @item -mgnu-as
9970 @itemx -mno-gnu-as
9971 @opindex mgnu-as
9972 @opindex mno-gnu-as
9973 Generate (or don't) code for the GNU assembler.  This is the default.
9974 @c Also, this is the default if the configure option @option{--with-gnu-as}
9975 @c is used.
9977 @item -mgnu-ld
9978 @itemx -mno-gnu-ld
9979 @opindex mgnu-ld
9980 @opindex mno-gnu-ld
9981 Generate (or don't) code for the GNU linker.  This is the default.
9982 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9983 @c is used.
9985 @item -mno-pic
9986 @opindex mno-pic
9987 Generate code that does not use a global pointer register.  The result
9988 is not position independent code, and violates the IA-64 ABI@.
9990 @item -mvolatile-asm-stop
9991 @itemx -mno-volatile-asm-stop
9992 @opindex mvolatile-asm-stop
9993 @opindex mno-volatile-asm-stop
9994 Generate (or don't) a stop bit immediately before and after volatile asm
9995 statements.
9997 @item -mb-step
9998 @opindex mb-step
9999 Generate code that works around Itanium B step errata.
10001 @item -mregister-names
10002 @itemx -mno-register-names
10003 @opindex mregister-names
10004 @opindex mno-register-names
10005 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10006 the stacked registers.  This may make assembler output more readable.
10008 @item -mno-sdata
10009 @itemx -msdata
10010 @opindex mno-sdata
10011 @opindex msdata
10012 Disable (or enable) optimizations that use the small data section.  This may
10013 be useful for working around optimizer bugs.
10015 @item -mconstant-gp
10016 @opindex mconstant-gp
10017 Generate code that uses a single constant global pointer value.  This is
10018 useful when compiling kernel code.
10020 @item -mauto-pic
10021 @opindex mauto-pic
10022 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10023 This is useful when compiling firmware code.
10025 @item -minline-float-divide-min-latency
10026 @opindex minline-float-divide-min-latency
10027 Generate code for inline divides of floating point values
10028 using the minimum latency algorithm.
10030 @item -minline-float-divide-max-throughput
10031 @opindex minline-float-divide-max-throughput
10032 Generate code for inline divides of floating point values
10033 using the maximum throughput algorithm.
10035 @item -minline-int-divide-min-latency
10036 @opindex minline-int-divide-min-latency
10037 Generate code for inline divides of integer values
10038 using the minimum latency algorithm.
10040 @item -minline-int-divide-max-throughput
10041 @opindex minline-int-divide-max-throughput
10042 Generate code for inline divides of integer values
10043 using the maximum throughput algorithm.
10045 @item -mno-dwarf2-asm
10046 @itemx -mdwarf2-asm
10047 @opindex mno-dwarf2-asm
10048 @opindex mdwarf2-asm
10049 Don't (or do) generate assembler code for the DWARF2 line number debugging
10050 info.  This may be useful when not using the GNU assembler.
10052 @item -mfixed-range=@var{register-range}
10053 @opindex mfixed-range
10054 Generate code treating the given register range as fixed registers.
10055 A fixed register is one that the register allocator can not use.  This is
10056 useful when compiling kernel code.  A register range is specified as
10057 two registers separated by a dash.  Multiple register ranges can be
10058 specified separated by a comma.
10060 @item -mearly-stop-bits
10061 @itemx -mno-early-stop-bits
10062 @opindex mearly-stop-bits
10063 @opindex mno-early-stop-bits
10064 Allow stop bits to be placed earlier than immediately preceding the
10065 instruction that triggered the stop bit.  This can improve instruction
10066 scheduling, but does not always do so.
10067 @end table
10069 @node D30V Options
10070 @subsection D30V Options
10071 @cindex D30V Options
10073 These @samp{-m} options are defined for D30V implementations:
10075 @table @gcctabopt
10076 @item -mextmem
10077 @opindex mextmem
10078 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10079 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10080 memory, which starts at location @code{0x80000000}.
10082 @item -mextmemory
10083 @opindex mextmemory
10084 Same as the @option{-mextmem} switch.
10086 @item -monchip
10087 @opindex monchip
10088 Link the @samp{.text} section into onchip text memory, which starts at
10089 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10090 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10091 into onchip data memory, which starts at location @code{0x20000000}.
10093 @item -mno-asm-optimize
10094 @itemx -masm-optimize
10095 @opindex mno-asm-optimize
10096 @opindex masm-optimize
10097 Disable (enable) passing @option{-O} to the assembler when optimizing.
10098 The assembler uses the @option{-O} option to automatically parallelize
10099 adjacent short instructions where possible.
10101 @item -mbranch-cost=@var{n}
10102 @opindex mbranch-cost
10103 Increase the internal costs of branches to @var{n}.  Higher costs means
10104 that the compiler will issue more instructions to avoid doing a branch.
10105 The default is 2.
10107 @item -mcond-exec=@var{n}
10108 @opindex mcond-exec
10109 Specify the maximum number of conditionally executed instructions that
10110 replace a branch.  The default is 4.
10111 @end table
10113 @node S/390 and zSeries Options
10114 @subsection S/390 and zSeries Options
10115 @cindex S/390 and zSeries Options
10117 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10119 @table @gcctabopt
10120 @item -mhard-float
10121 @itemx -msoft-float
10122 @opindex mhard-float
10123 @opindex msoft-float
10124 Use (do not use) the hardware floating-point instructions and registers
10125 for floating-point operations.  When @option{-msoft-float} is specified,
10126 functions in @file{libgcc.a} will be used to perform floating-point
10127 operations.  When @option{-mhard-float} is specified, the compiler
10128 generates IEEE floating-point instructions.  This is the default.
10130 @item -mbackchain
10131 @itemx -mno-backchain
10132 @opindex mbackchain
10133 @opindex mno-backchain
10134 Generate (or do not generate) code which maintains an explicit
10135 backchain within the stack frame that points to the caller's frame.
10136 This is currently needed to allow debugging.  The default is to
10137 generate the backchain.
10139 @item -msmall-exec
10140 @itemx -mno-small-exec
10141 @opindex msmall-exec
10142 @opindex mno-small-exec
10143 Generate (or do not generate) code using the @code{bras} instruction
10144 to do subroutine calls.
10145 This only works reliably if the total executable size does not
10146 exceed 64k.  The default is to use the @code{basr} instruction instead,
10147 which does not have this limitation.
10149 @item -m64
10150 @itemx -m31
10151 @opindex m64
10152 @opindex m31
10153 When @option{-m31} is specified, generate code compliant to the
10154 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10155 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10156 particular to generate 64-bit instructions.  For the @samp{s390}
10157 targets, the default is @option{-m31}, while the @samp{s390x}
10158 targets default to @option{-m64}.
10160 @item -mzarch
10161 @itemx -mesa
10162 @opindex mzarch
10163 @opindex mesa
10164 When @option{-mzarch} is specified, generate code using the 
10165 instructions available on z/Architecture. 
10166 When @option{-mesa} is specified, generate code using the 
10167 instructions available on ESA/390. Note that @option{-mesa} is
10168 not possible with @option{-m64}.
10169 When generating code compliant to the Linux for S/390 ABI,
10170 the default is @option{-mesa}.  When generating code compliant
10171 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10173 @item -mmvcle
10174 @itemx -mno-mvcle
10175 @opindex mmvcle
10176 @opindex mno-mvcle
10177 Generate (or do not generate) code using the @code{mvcle} instruction
10178 to perform block moves.  When @option{-mno-mvcle} is specified,
10179 use a @code{mvc} loop instead.  This is the default.
10181 @item -mdebug
10182 @itemx -mno-debug
10183 @opindex mdebug
10184 @opindex mno-debug
10185 Print (or do not print) additional debug information when compiling.
10186 The default is to not print debug information.
10188 @item -march=@var{cpu-type}
10189 @opindex march
10190 Generate code that will run on @var{cpu-type}, which is the name of a system
10191 representing a certain processor type. Possible values for
10192 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10193 When generating code using the instructions available on z/Architecture,
10194 the default is @option{-march=z900}.  Otherwise, the default is
10195 @option{-march=g5}.
10197 @item -mtune=@var{cpu-type}
10198 @opindex mtune
10199 Tune to @var{cpu-type} everything applicable about the generated code,
10200 except for the ABI and the set of available instructions.
10201 The list of @var{cpu-type} values is the same as for @option{-march}.
10202 The default is the value used for @option{-march}.
10204 @end table
10206 @node CRIS Options
10207 @subsection CRIS Options
10208 @cindex CRIS Options
10210 These options are defined specifically for the CRIS ports.
10212 @table @gcctabopt
10213 @item -march=@var{architecture-type}
10214 @itemx -mcpu=@var{architecture-type}
10215 @opindex march
10216 @opindex mcpu
10217 Generate code for the specified architecture.  The choices for
10218 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10219 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10220 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10221 @samp{v10}.
10223 @item -mtune=@var{architecture-type}
10224 @opindex mtune
10225 Tune to @var{architecture-type} everything applicable about the generated
10226 code, except for the ABI and the set of available instructions.  The
10227 choices for @var{architecture-type} are the same as for
10228 @option{-march=@var{architecture-type}}.
10230 @item -mmax-stack-frame=@var{n}
10231 @opindex mmax-stack-frame
10232 Warn when the stack frame of a function exceeds @var{n} bytes.
10234 @item -melinux-stacksize=@var{n}
10235 @opindex melinux-stacksize
10236 Only available with the @samp{cris-axis-aout} target.  Arranges for
10237 indications in the program to the kernel loader that the stack of the
10238 program should be set to @var{n} bytes.
10240 @item -metrax4
10241 @itemx -metrax100
10242 @opindex metrax4
10243 @opindex metrax100
10244 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10245 @option{-march=v3} and @option{-march=v8} respectively.
10247 @item -mpdebug
10248 @opindex mpdebug
10249 Enable CRIS-specific verbose debug-related information in the assembly
10250 code.  This option also has the effect to turn off the @samp{#NO_APP}
10251 formatted-code indicator to the assembler at the beginning of the
10252 assembly file.
10254 @item -mcc-init
10255 @opindex mcc-init
10256 Do not use condition-code results from previous instruction; always emit
10257 compare and test instructions before use of condition codes.
10259 @item -mno-side-effects
10260 @opindex mno-side-effects
10261 Do not emit instructions with side-effects in addressing modes other than
10262 post-increment.
10264 @item -mstack-align
10265 @itemx -mno-stack-align
10266 @itemx -mdata-align
10267 @itemx -mno-data-align
10268 @itemx -mconst-align
10269 @itemx -mno-const-align
10270 @opindex mstack-align
10271 @opindex mno-stack-align
10272 @opindex mdata-align
10273 @opindex mno-data-align
10274 @opindex mconst-align
10275 @opindex mno-const-align
10276 These options (no-options) arranges (eliminate arrangements) for the
10277 stack-frame, individual data and constants to be aligned for the maximum
10278 single data access size for the chosen CPU model.  The default is to
10279 arrange for 32-bit alignment.  ABI details such as structure layout are
10280 not affected by these options.
10282 @item -m32-bit
10283 @itemx -m16-bit
10284 @itemx -m8-bit
10285 @opindex m32-bit
10286 @opindex m16-bit
10287 @opindex m8-bit
10288 Similar to the stack- data- and const-align options above, these options
10289 arrange for stack-frame, writable data and constants to all be 32-bit,
10290 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10292 @item -mno-prologue-epilogue
10293 @itemx -mprologue-epilogue
10294 @opindex mno-prologue-epilogue
10295 @opindex mprologue-epilogue
10296 With @option{-mno-prologue-epilogue}, the normal function prologue and
10297 epilogue that sets up the stack-frame are omitted and no return
10298 instructions or return sequences are generated in the code.  Use this
10299 option only together with visual inspection of the compiled code: no
10300 warnings or errors are generated when call-saved registers must be saved,
10301 or storage for local variable needs to be allocated.
10303 @item -mno-gotplt
10304 @itemx -mgotplt
10305 @opindex mno-gotplt
10306 @opindex mgotplt
10307 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10308 instruction sequences that load addresses for functions from the PLT part
10309 of the GOT rather than (traditional on other architectures) calls to the
10310 PLT.  The default is @option{-mgotplt}.
10312 @item -maout
10313 @opindex maout
10314 Legacy no-op option only recognized with the cris-axis-aout target.
10316 @item -melf
10317 @opindex melf
10318 Legacy no-op option only recognized with the cris-axis-elf and
10319 cris-axis-linux-gnu targets.
10321 @item -melinux
10322 @opindex melinux
10323 Only recognized with the cris-axis-aout target, where it selects a
10324 GNU/linux-like multilib, include files and instruction set for
10325 @option{-march=v8}.
10327 @item -mlinux
10328 @opindex mlinux
10329 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10331 @item -sim
10332 @opindex sim
10333 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10334 to link with input-output functions from a simulator library.  Code,
10335 initialized data and zero-initialized data are allocated consecutively.
10337 @item -sim2
10338 @opindex sim2
10339 Like @option{-sim}, but pass linker options to locate initialized data at
10340 0x40000000 and zero-initialized data at 0x80000000.
10341 @end table
10343 @node MMIX Options
10344 @subsection MMIX Options
10345 @cindex MMIX Options
10347 These options are defined for the MMIX:
10349 @table @gcctabopt
10350 @item -mlibfuncs
10351 @itemx -mno-libfuncs
10352 @opindex mlibfuncs
10353 @opindex mno-libfuncs
10354 Specify that intrinsic library functions are being compiled, passing all
10355 values in registers, no matter the size.
10357 @item -mepsilon
10358 @itemx -mno-epsilon
10359 @opindex mepsilon
10360 @opindex mno-epsilon
10361 Generate floating-point comparison instructions that compare with respect
10362 to the @code{rE} epsilon register.
10364 @item -mabi=mmixware
10365 @itemx -mabi=gnu
10366 @opindex mabi-mmixware
10367 @opindex mabi=gnu
10368 Generate code that passes function parameters and return values that (in
10369 the called function) are seen as registers @code{$0} and up, as opposed to
10370 the GNU ABI which uses global registers @code{$231} and up.
10372 @item -mzero-extend
10373 @itemx -mno-zero-extend
10374 @opindex mzero-extend
10375 @opindex mno-zero-extend
10376 When reading data from memory in sizes shorter than 64 bits, use (do not
10377 use) zero-extending load instructions by default, rather than
10378 sign-extending ones.
10380 @item -mknuthdiv
10381 @itemx -mno-knuthdiv
10382 @opindex mknuthdiv
10383 @opindex mno-knuthdiv
10384 Make the result of a division yielding a remainder have the same sign as
10385 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10386 remainder follows the sign of the dividend.  Both methods are
10387 arithmetically valid, the latter being almost exclusively used.
10389 @item -mtoplevel-symbols
10390 @itemx -mno-toplevel-symbols
10391 @opindex mtoplevel-symbols
10392 @opindex mno-toplevel-symbols
10393 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10394 code can be used with the @code{PREFIX} assembly directive.
10396 @item -melf
10397 @opindex melf
10398 Generate an executable in the ELF format, rather than the default
10399 @samp{mmo} format used by the @command{mmix} simulator.
10401 @item -mbranch-predict
10402 @itemx -mno-branch-predict
10403 @opindex mbranch-predict
10404 @opindex mno-branch-predict
10405 Use (do not use) the probable-branch instructions, when static branch
10406 prediction indicates a probable branch.
10408 @item -mbase-addresses
10409 @itemx -mno-base-addresses
10410 @opindex mbase-addresses
10411 @opindex mno-base-addresses
10412 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10413 base address automatically generates a request (handled by the assembler
10414 and the linker) for a constant to be set up in a global register.  The
10415 register is used for one or more base address requests within the range 0
10416 to 255 from the value held in the register.  The generally leads to short
10417 and fast code, but the number of different data items that can be
10418 addressed is limited.  This means that a program that uses lots of static
10419 data may require @option{-mno-base-addresses}.
10421 @item -msingle-exit
10422 @itemx -mno-single-exit
10423 @opindex msingle-exit
10424 @opindex mno-single-exit
10425 Force (do not force) generated code to have a single exit point in each
10426 function.
10427 @end table
10429 @node PDP-11 Options
10430 @subsection PDP-11 Options
10431 @cindex PDP-11 Options
10433 These options are defined for the PDP-11:
10435 @table @gcctabopt
10436 @item -mfpu
10437 @opindex mfpu
10438 Use hardware FPP floating point.  This is the default.  (FIS floating
10439 point on the PDP-11/40 is not supported.)
10441 @item -msoft-float
10442 @opindex msoft-float
10443 Do not use hardware floating point.
10445 @item -mac0
10446 @opindex mac0
10447 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10449 @item -mno-ac0
10450 @opindex mno-ac0
10451 Return floating-point results in memory.  This is the default.
10453 @item -m40
10454 @opindex m40
10455 Generate code for a PDP-11/40.
10457 @item -m45
10458 @opindex m45
10459 Generate code for a PDP-11/45.  This is the default.
10461 @item -m10
10462 @opindex m10
10463 Generate code for a PDP-11/10.
10465 @item -mbcopy-builtin
10466 @opindex bcopy-builtin
10467 Use inline @code{movstrhi} patterns for copying memory.  This is the
10468 default.
10470 @item -mbcopy
10471 @opindex mbcopy
10472 Do not use inline @code{movstrhi} patterns for copying memory.
10474 @item -mint16
10475 @itemx -mno-int32
10476 @opindex mint16
10477 @opindex mno-int32
10478 Use 16-bit @code{int}.  This is the default.
10480 @item -mint32
10481 @itemx -mno-int16
10482 @opindex mint32
10483 @opindex mno-int16
10484 Use 32-bit @code{int}.
10486 @item -mfloat64
10487 @itemx -mno-float32
10488 @opindex mfloat64
10489 @opindex mno-float32
10490 Use 64-bit @code{float}.  This is the default.
10492 @item -mfloat32
10493 @item -mno-float64
10494 @opindex mfloat32
10495 @opindex mno-float64
10496 Use 32-bit @code{float}.
10498 @item -mabshi
10499 @opindex mabshi
10500 Use @code{abshi2} pattern.  This is the default.
10502 @item -mno-abshi
10503 @opindex mno-abshi
10504 Do not use @code{abshi2} pattern.
10506 @item -mbranch-expensive
10507 @opindex mbranch-expensive
10508 Pretend that branches are expensive.  This is for experimenting with
10509 code generation only.
10511 @item -mbranch-cheap
10512 @opindex mbranch-cheap
10513 Do not pretend that branches are expensive.  This is the default.
10515 @item -msplit
10516 @opindex msplit
10517 Generate code for a system with split I&D.
10519 @item -mno-split
10520 @opindex mno-split
10521 Generate code for a system without split I&D.  This is the default.
10523 @item -munix-asm
10524 @opindex munix-asm
10525 Use Unix assembler syntax.  This is the default when configured for
10526 @samp{pdp11-*-bsd}.
10528 @item -mdec-asm
10529 @opindex mdec-asm
10530 Use DEC assembler syntax.  This is the default when configured for any
10531 PDP-11 target other than @samp{pdp11-*-bsd}.
10532 @end table
10534 @node Xstormy16 Options
10535 @subsection Xstormy16 Options
10536 @cindex Xstormy16 Options
10538 These options are defined for Xstormy16:
10540 @table @gcctabopt
10541 @item -msim
10542 @opindex msim
10543 Choose startup files and linker script suitable for the simulator.
10544 @end table
10546 @node FRV Options
10547 @subsection FRV Options
10548 @cindex FRV Options
10550 @table @gcctabopt
10551 @item -mgpr-32
10552 @opindex mgpr-32
10554 Only use the first 32 general purpose registers.
10556 @item -mgpr-64
10557 @opindex mgpr-64
10559 Use all 64 general purpose registers.
10561 @item -mfpr-32
10562 @opindex mfpr-32
10564 Use only the first 32 floating point registers.
10566 @item -mfpr-64
10567 @opindex mfpr-64
10569 Use all 64 floating point registers
10571 @item -mhard-float
10572 @opindex mhard-float
10574 Use hardware instructions for floating point operations.
10576 @item -msoft-float
10577 @opindex msoft-float
10579 Use library routines for floating point operations.
10581 @item -malloc-cc
10582 @opindex malloc-cc
10584 Dynamically allocate condition code registers.
10586 @item -mfixed-cc
10587 @opindex mfixed-cc
10589 Do not try to dynamically allocate condition code registers, only
10590 use @code{icc0} and @code{fcc0}.
10592 @item -mdword
10593 @opindex mdword
10595 Change ABI to use double word insns.
10597 @item -mno-dword
10598 @opindex mno-dword
10600 Do not use double word instructions.
10602 @item -mdouble
10603 @opindex mdouble
10605 Use floating point double instructions.
10607 @item -mno-double
10608 @opindex mno-double
10610 Do not use floating point double instructions.
10612 @item -mmedia
10613 @opindex mmedia
10615 Use media instructions.
10617 @item -mno-media
10618 @opindex mno-media
10620 Do not use media instructions.
10622 @item -mmuladd
10623 @opindex mmuladd
10625 Use multiply and add/subtract instructions.
10627 @item -mno-muladd
10628 @opindex mno-muladd
10630 Do not use multiply and add/subtract instructions.
10632 @item -mlibrary-pic
10633 @opindex mlibrary-pic
10635 Enable PIC support for building libraries
10637 @item -macc-4
10638 @opindex macc-4
10640 Use only the first four media accumulator registers.
10642 @item -macc-8
10643 @opindex macc-8
10645 Use all eight media accumulator registers.
10647 @item -mpack
10648 @opindex mpack
10650 Pack VLIW instructions.
10652 @item -mno-pack
10653 @opindex mno-pack
10655 Do not pack VLIW instructions.
10657 @item -mno-eflags
10658 @opindex mno-eflags
10660 Do not mark ABI switches in e_flags.
10662 @item -mcond-move
10663 @opindex mcond-move
10665 Enable the use of conditional-move instructions (default).
10667 This switch is mainly for debugging the compiler and will likely be removed
10668 in a future version.
10670 @item -mno-cond-move
10671 @opindex mno-cond-move
10673 Disable the use of conditional-move instructions.
10675 This switch is mainly for debugging the compiler and will likely be removed
10676 in a future version.
10678 @item -mscc
10679 @opindex mscc
10681 Enable the use of conditional set instructions (default).
10683 This switch is mainly for debugging the compiler and will likely be removed
10684 in a future version.
10686 @item -mno-scc
10687 @opindex mno-scc
10689 Disable the use of conditional set instructions.
10691 This switch is mainly for debugging the compiler and will likely be removed
10692 in a future version.
10694 @item -mcond-exec
10695 @opindex mcond-exec
10697 Enable the use of conditional execution (default).
10699 This switch is mainly for debugging the compiler and will likely be removed
10700 in a future version.
10702 @item -mno-cond-exec
10703 @opindex mno-cond-exec
10705 Disable the use of conditional execution.
10707 This switch is mainly for debugging the compiler and will likely be removed
10708 in a future version.
10710 @item -mvliw-branch
10711 @opindex mvliw-branch
10713 Run a pass to pack branches into VLIW instructions (default).
10715 This switch is mainly for debugging the compiler and will likely be removed
10716 in a future version.
10718 @item -mno-vliw-branch
10719 @opindex mno-vliw-branch
10721 Do not run a pass to pack branches into VLIW instructions.
10723 This switch is mainly for debugging the compiler and will likely be removed
10724 in a future version.
10726 @item -mmulti-cond-exec
10727 @opindex mmulti-cond-exec
10729 Enable optimization of @code{&&} and @code{||} in conditional execution
10730 (default).
10732 This switch is mainly for debugging the compiler and will likely be removed
10733 in a future version.
10735 @item -mno-multi-cond-exec
10736 @opindex mno-multi-cond-exec
10738 Disable optimization of @code{&&} and @code{||} in conditional execution.
10740 This switch is mainly for debugging the compiler and will likely be removed
10741 in a future version.
10743 @item -mnested-cond-exec
10744 @opindex mnested-cond-exec
10746 Enable nested conditional execution optimizations (default).
10748 This switch is mainly for debugging the compiler and will likely be removed
10749 in a future version.
10751 @item -mno-nested-cond-exec
10752 @opindex mno-nested-cond-exec
10754 Disable nested conditional execution optimizations.
10756 This switch is mainly for debugging the compiler and will likely be removed
10757 in a future version.
10759 @item -mtomcat-stats
10760 @opindex mtomcat-stats
10762 Cause gas to print out tomcat statistics.
10764 @item -mcpu=@var{cpu}
10765 @opindex mcpu
10767 Select the processor type for which to generate code.  Possible values are
10768 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10769 @samp{frv}.
10771 @end table
10773 @node Xtensa Options
10774 @subsection Xtensa Options
10775 @cindex Xtensa Options
10777 The Xtensa architecture is designed to support many different
10778 configurations.  The compiler's default options can be set to match a
10779 particular Xtensa configuration by copying a configuration file into the
10780 GCC sources when building GCC@.  The options below may be used to
10781 override the default options.
10783 @table @gcctabopt
10784 @item -mbig-endian
10785 @itemx -mlittle-endian
10786 @opindex mbig-endian
10787 @opindex mlittle-endian
10788 Specify big-endian or little-endian byte ordering for the target Xtensa
10789 processor.
10791 @item -mdensity
10792 @itemx -mno-density
10793 @opindex mdensity
10794 @opindex mno-density
10795 Enable or disable use of the optional Xtensa code density instructions.
10797 @item -mconst16
10798 @itemx -mno-const16
10799 @opindex mconst16
10800 @opindex mno-const16
10801 Enable or disable use of @code{CONST16} instructions for loading
10802 constant values.  The @code{CONST16} instruction is currently not a
10803 standard option from Tensilica.  When enabled, @code{CONST16}
10804 instructions are always used in place of the standard @code{L32R}
10805 instructions.  The use of @code{CONST16} is enabled by default only if
10806 the @code{L32R} instruction is not available.
10808 @item -mabs
10809 @itemx -mno-abs
10810 @opindex mabs
10811 @opindex mno-abs
10812 Enable or disable use of the Xtensa @code{ABS} instruction for absolute
10813 value operations.
10815 @item -maddx
10816 @itemx -mno-addx
10817 @opindex maddx
10818 @opindex mno-addx
10819 Enable or disable use of the Xtensa @code{ADDX} and @code{SUBX}
10820 instructions.
10822 @item -mmac16
10823 @itemx -mno-mac16
10824 @opindex mmac16
10825 @opindex mno-mac16
10826 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10827 will generate MAC16 instructions from standard C code, with the
10828 limitation that it will use neither the MR register file nor any
10829 instruction that operates on the MR registers.  When this option is
10830 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10831 combination of core instructions and library calls, depending on whether
10832 any other multiplier options are enabled.
10834 @item -mmul16
10835 @itemx -mno-mul16
10836 @opindex mmul16
10837 @opindex mno-mul16
10838 Enable or disable use of the 16-bit integer multiplier option.  When
10839 enabled, the compiler will generate 16-bit multiply instructions for
10840 multiplications of 16 bits or smaller in standard C code.  When this
10841 option is disabled, the compiler will either use 32-bit multiply or
10842 MAC16 instructions if they are available or generate library calls to
10843 perform the multiply operations using shifts and adds.
10845 @item -mmul32
10846 @itemx -mno-mul32
10847 @opindex mmul32
10848 @opindex mno-mul32
10849 Enable or disable use of the 32-bit integer multiplier option.  When
10850 enabled, the compiler will generate 32-bit multiply instructions for
10851 multiplications of 32 bits or smaller in standard C code.  When this
10852 option is disabled, the compiler will generate library calls to perform
10853 the multiply operations using either shifts and adds or 16-bit multiply
10854 instructions if they are available.
10856 @item -mnsa
10857 @itemx -mno-nsa
10858 @opindex mnsa
10859 @opindex mno-nsa
10860 Enable or disable use of the optional normalization shift amount
10861 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10863 @item -mminmax
10864 @itemx -mno-minmax
10865 @opindex mminmax
10866 @opindex mno-minmax
10867 Enable or disable use of the optional minimum and maximum value
10868 instructions.
10870 @item -msext
10871 @itemx -mno-sext
10872 @opindex msext
10873 @opindex mno-sext
10874 Enable or disable use of the optional sign extend (@code{SEXT})
10875 instruction.
10877 @item -mbooleans
10878 @itemx -mno-booleans
10879 @opindex mbooleans
10880 @opindex mno-booleans
10881 Enable or disable support for the boolean register file used by Xtensa
10882 coprocessors.  This is not typically useful by itself but may be
10883 required for other options that make use of the boolean registers (e.g.,
10884 the floating-point option).
10886 @item -mhard-float
10887 @itemx -msoft-float
10888 @opindex mhard-float
10889 @opindex msoft-float
10890 Enable or disable use of the floating-point option.  When enabled, GCC
10891 generates floating-point instructions for 32-bit @code{float}
10892 operations.  When this option is disabled, GCC generates library calls
10893 to emulate 32-bit floating-point operations using integer instructions.
10894 Regardless of this option, 64-bit @code{double} operations are always
10895 emulated with calls to library functions.
10897 @item -mfused-madd
10898 @itemx -mno-fused-madd
10899 @opindex mfused-madd
10900 @opindex mno-fused-madd
10901 Enable or disable use of fused multiply/add and multiply/subtract
10902 instructions in the floating-point option.  This has no effect if the
10903 floating-point option is not also enabled.  Disabling fused multiply/add
10904 and multiply/subtract instructions forces the compiler to use separate
10905 instructions for the multiply and add/subtract operations.  This may be
10906 desirable in some cases where strict IEEE 754-compliant results are
10907 required: the fused multiply add/subtract instructions do not round the
10908 intermediate result, thereby producing results with @emph{more} bits of
10909 precision than specified by the IEEE standard.  Disabling fused multiply
10910 add/subtract instructions also ensures that the program output is not
10911 sensitive to the compiler's ability to combine multiply and add/subtract
10912 operations.
10914 @item -mtext-section-literals
10915 @itemx -mno-text-section-literals
10916 @opindex mtext-section-literals
10917 @opindex mno-text-section-literals
10918 Control the treatment of literal pools.  The default is
10919 @option{-mno-text-section-literals}, which places literals in a separate
10920 section in the output file.  This allows the literal pool to be placed
10921 in a data RAM/ROM, and it also allows the linker to combine literal
10922 pools from separate object files to remove redundant literals and
10923 improve code size.  With @option{-mtext-section-literals}, the literals
10924 are interspersed in the text section in order to keep them as close as
10925 possible to their references.  This may be necessary for large assembly
10926 files.
10928 @item -mtarget-align
10929 @itemx -mno-target-align
10930 @opindex mtarget-align
10931 @opindex mno-target-align
10932 When this option is enabled, GCC instructs the assembler to
10933 automatically align instructions to reduce branch penalties at the
10934 expense of some code density.  The assembler attempts to widen density
10935 instructions to align branch targets and the instructions following call
10936 instructions.  If there are not enough preceding safe density
10937 instructions to align a target, no widening will be performed.  The
10938 default is @option{-mtarget-align}.  These options do not affect the
10939 treatment of auto-aligned instructions like @code{LOOP}, which the
10940 assembler will always align, either by widening density instructions or
10941 by inserting no-op instructions.
10943 @item -mlongcalls
10944 @itemx -mno-longcalls
10945 @opindex mlongcalls
10946 @opindex mno-longcalls
10947 When this option is enabled, GCC instructs the assembler to translate
10948 direct calls to indirect calls unless it can determine that the target
10949 of a direct call is in the range allowed by the call instruction.  This
10950 translation typically occurs for calls to functions in other source
10951 files.  Specifically, the assembler translates a direct @code{CALL}
10952 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10953 The default is @option{-mno-longcalls}.  This option should be used in
10954 programs where the call target can potentially be out of range.  This
10955 option is implemented in the assembler, not the compiler, so the
10956 assembly code generated by GCC will still show direct call
10957 instructions---look at the disassembled object code to see the actual
10958 instructions.  Note that the assembler will use an indirect call for
10959 every cross-file call, not just those that really will be out of range.
10960 @end table
10962 @node Code Gen Options
10963 @section Options for Code Generation Conventions
10964 @cindex code generation conventions
10965 @cindex options, code generation
10966 @cindex run-time options
10968 These machine-independent options control the interface conventions
10969 used in code generation.
10971 Most of them have both positive and negative forms; the negative form
10972 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10973 one of the forms is listed---the one which is not the default.  You
10974 can figure out the other form by either removing @samp{no-} or adding
10977 @table @gcctabopt
10978 @item -fbounds-check
10979 @opindex fbounds-check
10980 For front-ends that support it, generate additional code to check that
10981 indices used to access arrays are within the declared range.  This is
10982 currently only supported by the Java and Fortran 77 front-ends, where
10983 this option defaults to true and false respectively.
10985 @item -ftrapv
10986 @opindex ftrapv
10987 This option generates traps for signed overflow on addition, subtraction,
10988 multiplication operations.
10990 @item -fwrapv
10991 @opindex fwrapv
10992 This option instructs the compiler to assume that signed arithmetic
10993 overflow of addition, subtraction and multiplication wraps around
10994 using twos-complement representation.  This flag enables some optimizations
10995 and disables other.  This option is enabled by default for the Java
10996 front-end, as required by the Java language specification.
10998 @item -fexceptions
10999 @opindex fexceptions
11000 Enable exception handling.  Generates extra code needed to propagate
11001 exceptions.  For some targets, this implies GCC will generate frame
11002 unwind information for all functions, which can produce significant data
11003 size overhead, although it does not affect execution.  If you do not
11004 specify this option, GCC will enable it by default for languages like
11005 C++ which normally require exception handling, and disable it for
11006 languages like C that do not normally require it.  However, you may need
11007 to enable this option when compiling C code that needs to interoperate
11008 properly with exception handlers written in C++.  You may also wish to
11009 disable this option if you are compiling older C++ programs that don't
11010 use exception handling.
11012 @item -fnon-call-exceptions
11013 @opindex fnon-call-exceptions
11014 Generate code that allows trapping instructions to throw exceptions.
11015 Note that this requires platform-specific runtime support that does
11016 not exist everywhere.  Moreover, it only allows @emph{trapping}
11017 instructions to throw exceptions, i.e.@: memory references or floating
11018 point instructions.  It does not allow exceptions to be thrown from
11019 arbitrary signal handlers such as @code{SIGALRM}.
11021 @item -funwind-tables
11022 @opindex funwind-tables
11023 Similar to @option{-fexceptions}, except that it will just generate any needed
11024 static data, but will not affect the generated code in any other way.
11025 You will normally not enable this option; instead, a language processor
11026 that needs this handling would enable it on your behalf.
11028 @item -fasynchronous-unwind-tables
11029 @opindex funwind-tables
11030 Generate unwind table in dwarf2 format, if supported by target machine.  The
11031 table is exact at each instruction boundary, so it can be used for stack
11032 unwinding from asynchronous events (such as debugger or garbage collector).
11034 @item -fpcc-struct-return
11035 @opindex fpcc-struct-return
11036 Return ``short'' @code{struct} and @code{union} values in memory like
11037 longer ones, rather than in registers.  This convention is less
11038 efficient, but it has the advantage of allowing intercallability between
11039 GCC-compiled files and files compiled with other compilers, particularly
11040 the Portable C Compiler (pcc).
11042 The precise convention for returning structures in memory depends
11043 on the target configuration macros.
11045 Short structures and unions are those whose size and alignment match
11046 that of some integer type.
11048 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11049 switch is not binary compatible with code compiled with the
11050 @option{-freg-struct-return} switch.
11051 Use it to conform to a non-default application binary interface.
11053 @item -freg-struct-return
11054 @opindex freg-struct-return
11055 Return @code{struct} and @code{union} values in registers when possible.
11056 This is more efficient for small structures than
11057 @option{-fpcc-struct-return}.
11059 If you specify neither @option{-fpcc-struct-return} nor
11060 @option{-freg-struct-return}, GCC defaults to whichever convention is
11061 standard for the target.  If there is no standard convention, GCC
11062 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11063 the principal compiler.  In those cases, we can choose the standard, and
11064 we chose the more efficient register return alternative.
11066 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11067 switch is not binary compatible with code compiled with the
11068 @option{-fpcc-struct-return} switch.
11069 Use it to conform to a non-default application binary interface.
11071 @item -fshort-enums
11072 @opindex fshort-enums
11073 Allocate to an @code{enum} type only as many bytes as it needs for the
11074 declared range of possible values.  Specifically, the @code{enum} type
11075 will be equivalent to the smallest integer type which has enough room.
11077 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11078 code that is not binary compatible with code generated without that switch.
11079 Use it to conform to a non-default application binary interface.
11081 @item -fshort-double
11082 @opindex fshort-double
11083 Use the same size for @code{double} as for @code{float}.
11085 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11086 code that is not binary compatible with code generated without that switch.
11087 Use it to conform to a non-default application binary interface.
11089 @item -fshort-wchar
11090 @opindex fshort-wchar
11091 Override the underlying type for @samp{wchar_t} to be @samp{short
11092 unsigned int} instead of the default for the target.  This option is
11093 useful for building programs to run under WINE@.
11095 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11096 code that is not binary compatible with code generated without that switch.
11097 Use it to conform to a non-default application binary interface.
11099 @item -fshared-data
11100 @opindex fshared-data
11101 Requests that the data and non-@code{const} variables of this
11102 compilation be shared data rather than private data.  The distinction
11103 makes sense only on certain operating systems, where shared data is
11104 shared between processes running the same program, while private data
11105 exists in one copy per process.
11107 @item -fno-common
11108 @opindex fno-common
11109 In C, allocate even uninitialized global variables in the data section of the
11110 object file, rather than generating them as common blocks.  This has the
11111 effect that if the same variable is declared (without @code{extern}) in
11112 two different compilations, you will get an error when you link them.
11113 The only reason this might be useful is if you wish to verify that the
11114 program will work on other systems which always work this way.
11116 @item -fno-ident
11117 @opindex fno-ident
11118 Ignore the @samp{#ident} directive.
11120 @item -fno-gnu-linker
11121 @opindex fno-gnu-linker
11122 Do not output global initializations (such as C++ constructors and
11123 destructors) in the form used by the GNU linker (on systems where the GNU
11124 linker is the standard method of handling them).  Use this option when
11125 you want to use a non-GNU linker, which also requires using the
11126 @command{collect2} program to make sure the system linker includes
11127 constructors and destructors.  (@command{collect2} is included in the GCC
11128 distribution.)  For systems which @emph{must} use @command{collect2}, the
11129 compiler driver @command{gcc} is configured to do this automatically.
11131 @item -finhibit-size-directive
11132 @opindex finhibit-size-directive
11133 Don't output a @code{.size} assembler directive, or anything else that
11134 would cause trouble if the function is split in the middle, and the
11135 two halves are placed at locations far apart in memory.  This option is
11136 used when compiling @file{crtstuff.c}; you should not need to use it
11137 for anything else.
11139 @item -fverbose-asm
11140 @opindex fverbose-asm
11141 Put extra commentary information in the generated assembly code to
11142 make it more readable.  This option is generally only of use to those
11143 who actually need to read the generated assembly code (perhaps while
11144 debugging the compiler itself).
11146 @option{-fno-verbose-asm}, the default, causes the
11147 extra information to be omitted and is useful when comparing two assembler
11148 files.
11150 @item -fpic
11151 @opindex fpic
11152 @cindex global offset table
11153 @cindex PIC
11154 Generate position-independent code (PIC) suitable for use in a shared
11155 library, if supported for the target machine.  Such code accesses all
11156 constant addresses through a global offset table (GOT)@.  The dynamic
11157 loader resolves the GOT entries when the program starts (the dynamic
11158 loader is not part of GCC; it is part of the operating system).  If
11159 the GOT size for the linked executable exceeds a machine-specific
11160 maximum size, you get an error message from the linker indicating that
11161 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11162 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11163 on the m68k and RS/6000.  The 386 has no such limit.)
11165 Position-independent code requires special support, and therefore works
11166 only on certain machines.  For the 386, GCC supports PIC for System V
11167 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11168 position-independent.
11170 @item -fPIC
11171 @opindex fPIC
11172 If supported for the target machine, emit position-independent code,
11173 suitable for dynamic linking and avoiding any limit on the size of the
11174 global offset table.  This option makes a difference on the m68k, m88k,
11175 and the SPARC.
11177 Position-independent code requires special support, and therefore works
11178 only on certain machines.
11180 @item -fpie
11181 @itemx -fPIE
11182 @opindex fpie
11183 @opindex fPIE
11184 These options are similar to @option{-fpic} and @option{-fPIC}, but
11185 generated position independent code can be only linked into executables.
11186 Usually these options are used when @option{-pie} GCC option will be
11187 used during linking.
11189 @item -ffixed-@var{reg}
11190 @opindex ffixed
11191 Treat the register named @var{reg} as a fixed register; generated code
11192 should never refer to it (except perhaps as a stack pointer, frame
11193 pointer or in some other fixed role).
11195 @var{reg} must be the name of a register.  The register names accepted
11196 are machine-specific and are defined in the @code{REGISTER_NAMES}
11197 macro in the machine description macro file.
11199 This flag does not have a negative form, because it specifies a
11200 three-way choice.
11202 @item -fcall-used-@var{reg}
11203 @opindex fcall-used
11204 Treat the register named @var{reg} as an allocable register that is
11205 clobbered by function calls.  It may be allocated for temporaries or
11206 variables that do not live across a call.  Functions compiled this way
11207 will not save and restore the register @var{reg}.
11209 It is an error to used this flag with the frame pointer or stack pointer.
11210 Use of this flag for other registers that have fixed pervasive roles in
11211 the machine's execution model will produce disastrous results.
11213 This flag does not have a negative form, because it specifies a
11214 three-way choice.
11216 @item -fcall-saved-@var{reg}
11217 @opindex fcall-saved
11218 Treat the register named @var{reg} as an allocable register saved by
11219 functions.  It may be allocated even for temporaries or variables that
11220 live across a call.  Functions compiled this way will save and restore
11221 the register @var{reg} if they use it.
11223 It is an error to used this flag with the frame pointer or stack pointer.
11224 Use of this flag for other registers that have fixed pervasive roles in
11225 the machine's execution model will produce disastrous results.
11227 A different sort of disaster will result from the use of this flag for
11228 a register in which function values may be returned.
11230 This flag does not have a negative form, because it specifies a
11231 three-way choice.
11233 @item -fpack-struct
11234 @opindex fpack-struct
11235 Pack all structure members together without holes.
11237 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11238 code that is not binary compatible with code generated without that switch.
11239 Additionally, it makes the code suboptimal.
11240 Use it to conform to a non-default application binary interface.
11242 @item -finstrument-functions
11243 @opindex finstrument-functions
11244 Generate instrumentation calls for entry and exit to functions.  Just
11245 after function entry and just before function exit, the following
11246 profiling functions will be called with the address of the current
11247 function and its call site.  (On some platforms,
11248 @code{__builtin_return_address} does not work beyond the current
11249 function, so the call site information may not be available to the
11250 profiling functions otherwise.)
11252 @example
11253 void __cyg_profile_func_enter (void *this_fn,
11254                                void *call_site);
11255 void __cyg_profile_func_exit  (void *this_fn,
11256                                void *call_site);
11257 @end example
11259 The first argument is the address of the start of the current function,
11260 which may be looked up exactly in the symbol table.
11262 This instrumentation is also done for functions expanded inline in other
11263 functions.  The profiling calls will indicate where, conceptually, the
11264 inline function is entered and exited.  This means that addressable
11265 versions of such functions must be available.  If all your uses of a
11266 function are expanded inline, this may mean an additional expansion of
11267 code size.  If you use @samp{extern inline} in your C code, an
11268 addressable version of such functions must be provided.  (This is
11269 normally the case anyways, but if you get lucky and the optimizer always
11270 expands the functions inline, you might have gotten away without
11271 providing static copies.)
11273 A function may be given the attribute @code{no_instrument_function}, in
11274 which case this instrumentation will not be done.  This can be used, for
11275 example, for the profiling functions listed above, high-priority
11276 interrupt routines, and any functions from which the profiling functions
11277 cannot safely be called (perhaps signal handlers, if the profiling
11278 routines generate output or allocate memory).
11280 @item -fstack-check
11281 @opindex fstack-check
11282 Generate code to verify that you do not go beyond the boundary of the
11283 stack.  You should specify this flag if you are running in an
11284 environment with multiple threads, but only rarely need to specify it in
11285 a single-threaded environment since stack overflow is automatically
11286 detected on nearly all systems if there is only one stack.
11288 Note that this switch does not actually cause checking to be done; the
11289 operating system must do that.  The switch causes generation of code
11290 to ensure that the operating system sees the stack being extended.
11292 @item -fstack-limit-register=@var{reg}
11293 @itemx -fstack-limit-symbol=@var{sym}
11294 @itemx -fno-stack-limit
11295 @opindex fstack-limit-register
11296 @opindex fstack-limit-symbol
11297 @opindex fno-stack-limit
11298 Generate code to ensure that the stack does not grow beyond a certain value,
11299 either the value of a register or the address of a symbol.  If the stack
11300 would grow beyond the value, a signal is raised.  For most targets,
11301 the signal is raised before the stack overruns the boundary, so
11302 it is possible to catch the signal without taking special precautions.
11304 For instance, if the stack starts at absolute address @samp{0x80000000}
11305 and grows downwards, you can use the flags
11306 @option{-fstack-limit-symbol=__stack_limit} and
11307 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11308 of 128KB@.  Note that this may only work with the GNU linker.
11310 @cindex aliasing of parameters
11311 @cindex parameters, aliased
11312 @item -fargument-alias
11313 @itemx -fargument-noalias
11314 @itemx -fargument-noalias-global
11315 @opindex fargument-alias
11316 @opindex fargument-noalias
11317 @opindex fargument-noalias-global
11318 Specify the possible relationships among parameters and between
11319 parameters and global data.
11321 @option{-fargument-alias} specifies that arguments (parameters) may
11322 alias each other and may alias global storage.@*
11323 @option{-fargument-noalias} specifies that arguments do not alias
11324 each other, but may alias global storage.@*
11325 @option{-fargument-noalias-global} specifies that arguments do not
11326 alias each other and do not alias global storage.
11328 Each language will automatically use whatever option is required by
11329 the language standard.  You should not need to use these options yourself.
11331 @item -fleading-underscore
11332 @opindex fleading-underscore
11333 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11334 change the way C symbols are represented in the object file.  One use
11335 is to help link with legacy assembly code.
11337 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11338 generate code that is not binary compatible with code generated without that
11339 switch.  Use it to conform to a non-default application binary interface.
11340 Not all targets provide complete support for this switch.
11342 @item -ftls-model=@var{model}
11343 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11344 The @var{model} argument should be one of @code{global-dynamic},
11345 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11347 The default without @option{-fpic} is @code{initial-exec}; with
11348 @option{-fpic} the default is @code{global-dynamic}.
11349 @end table
11351 @c man end
11353 @node Environment Variables
11354 @section Environment Variables Affecting GCC
11355 @cindex environment variables
11357 @c man begin ENVIRONMENT
11358 This section describes several environment variables that affect how GCC
11359 operates.  Some of them work by specifying directories or prefixes to use
11360 when searching for various kinds of files.  Some are used to specify other
11361 aspects of the compilation environment.
11363 Note that you can also specify places to search using options such as
11364 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11365 take precedence over places specified using environment variables, which
11366 in turn take precedence over those specified by the configuration of GCC@.
11367 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11368 GNU Compiler Collection (GCC) Internals}.
11370 @table @env
11371 @item LANG
11372 @itemx LC_CTYPE
11373 @c @itemx LC_COLLATE
11374 @itemx LC_MESSAGES
11375 @c @itemx LC_MONETARY
11376 @c @itemx LC_NUMERIC
11377 @c @itemx LC_TIME
11378 @itemx LC_ALL
11379 @findex LANG
11380 @findex LC_CTYPE
11381 @c @findex LC_COLLATE
11382 @findex LC_MESSAGES
11383 @c @findex LC_MONETARY
11384 @c @findex LC_NUMERIC
11385 @c @findex LC_TIME
11386 @findex LC_ALL
11387 @cindex locale
11388 These environment variables control the way that GCC uses
11389 localization information that allow GCC to work with different
11390 national conventions.  GCC inspects the locale categories
11391 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11392 so.  These locale categories can be set to any value supported by your
11393 installation.  A typical value is @samp{en_UK} for English in the United
11394 Kingdom.
11396 The @env{LC_CTYPE} environment variable specifies character
11397 classification.  GCC uses it to determine the character boundaries in
11398 a string; this is needed for some multibyte encodings that contain quote
11399 and escape characters that would otherwise be interpreted as a string
11400 end or escape.
11402 The @env{LC_MESSAGES} environment variable specifies the language to
11403 use in diagnostic messages.
11405 If the @env{LC_ALL} environment variable is set, it overrides the value
11406 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11407 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11408 environment variable.  If none of these variables are set, GCC
11409 defaults to traditional C English behavior.
11411 @item TMPDIR
11412 @findex TMPDIR
11413 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11414 files.  GCC uses temporary files to hold the output of one stage of
11415 compilation which is to be used as input to the next stage: for example,
11416 the output of the preprocessor, which is the input to the compiler
11417 proper.
11419 @item GCC_EXEC_PREFIX
11420 @findex GCC_EXEC_PREFIX
11421 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11422 names of the subprograms executed by the compiler.  No slash is added
11423 when this prefix is combined with the name of a subprogram, but you can
11424 specify a prefix that ends with a slash if you wish.
11426 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11427 an appropriate prefix to use based on the pathname it was invoked with.
11429 If GCC cannot find the subprogram using the specified prefix, it
11430 tries looking in the usual places for the subprogram.
11432 The default value of @env{GCC_EXEC_PREFIX} is
11433 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11434 of @code{prefix} when you ran the @file{configure} script.
11436 Other prefixes specified with @option{-B} take precedence over this prefix.
11438 This prefix is also used for finding files such as @file{crt0.o} that are
11439 used for linking.
11441 In addition, the prefix is used in an unusual way in finding the
11442 directories to search for header files.  For each of the standard
11443 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11444 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11445 replacing that beginning with the specified prefix to produce an
11446 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11447 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11448 These alternate directories are searched first; the standard directories
11449 come next.
11451 @item COMPILER_PATH
11452 @findex COMPILER_PATH
11453 The value of @env{COMPILER_PATH} is a colon-separated list of
11454 directories, much like @env{PATH}.  GCC tries the directories thus
11455 specified when searching for subprograms, if it can't find the
11456 subprograms using @env{GCC_EXEC_PREFIX}.
11458 @item LIBRARY_PATH
11459 @findex LIBRARY_PATH
11460 The value of @env{LIBRARY_PATH} is a colon-separated list of
11461 directories, much like @env{PATH}.  When configured as a native compiler,
11462 GCC tries the directories thus specified when searching for special
11463 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11464 using GCC also uses these directories when searching for ordinary
11465 libraries for the @option{-l} option (but directories specified with
11466 @option{-L} come first).
11468 @item LANG
11469 @findex LANG
11470 @cindex locale definition
11471 This variable is used to pass locale information to the compiler.  One way in
11472 which this information is used is to determine the character set to be used
11473 when character literals, string literals and comments are parsed in C and C++.
11474 When the compiler is configured to allow multibyte characters,
11475 the following values for @env{LANG} are recognized:
11477 @table @samp
11478 @item C-JIS
11479 Recognize JIS characters.
11480 @item C-SJIS
11481 Recognize SJIS characters.
11482 @item C-EUCJP
11483 Recognize EUCJP characters.
11484 @end table
11486 If @env{LANG} is not defined, or if it has some other value, then the
11487 compiler will use mblen and mbtowc as defined by the default locale to
11488 recognize and translate multibyte characters.
11489 @end table
11491 @noindent
11492 Some additional environments variables affect the behavior of the
11493 preprocessor.
11495 @include cppenv.texi
11497 @c man end
11499 @node Precompiled Headers
11500 @section Using Precompiled Headers
11501 @cindex precompiled headers
11502 @cindex speed of compilation
11504 Often large projects have many header files that are included in every
11505 source file.  The time the compiler takes to process these header files
11506 over and over again can account for nearly all of the time required to
11507 build the project.  To make builds faster, GCC allows users to
11508 `precompile' a header file; then, if builds can use the precompiled
11509 header file they will be much faster.
11511 To create a precompiled header file, simply compile it as you would any
11512 other file, if necessary using the @option{-x} option to make the driver
11513 treat it as a C or C++ header file.  You will probably want to use a
11514 tool like @command{make} to keep the precompiled header up-to-date when
11515 the headers it contains change.
11517 A precompiled header file will be searched for when @code{#include} is
11518 seen in the compilation.  As it searches for the included file
11519 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11520 compiler looks for a precompiled header in each directory just before it
11521 looks for the include file in that directory.  The name searched for is
11522 the name specified in the @code{#include} with @samp{.gch} appended.  If
11523 the precompiled header file can't be used, it is ignored.
11525 For instance, if you have @code{#include "all.h"}, and you have
11526 @file{all.h.gch} in the same directory as @file{all.h}, then the
11527 precompiled header file will be used if possible, and the original
11528 header will be used otherwise.
11530 Alternatively, you might decide to put the precompiled header file in a
11531 directory and use @option{-I} to ensure that directory is searched
11532 before (or instead of) the directory containing the original header.
11533 Then, if you want to check that the precompiled header file is always
11534 used, you can put a file of the same name as the original header in this
11535 directory containing an @code{#error} command.
11537 This also works with @option{-include}.  So yet another way to use
11538 precompiled headers, good for projects not designed with precompiled
11539 header files in mind, is to simply take most of the header files used by
11540 a project, include them from another header file, precompile that header
11541 file, and @option{-include} the precompiled header.  If the header files
11542 have guards against multiple inclusion, they will be skipped because
11543 they've already been included (in the precompiled header).
11545 If you need to precompile the same header file for different
11546 languages, targets, or compiler options, you can instead make a
11547 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11548 header in the directory.  (It doesn't matter what you call the files
11549 in the directory, every precompiled header in the directory will be
11550 considered.)  The first precompiled header encountered in the
11551 directory that is valid for this compilation will be used; they're
11552 searched in no particular order.
11554 There are many other possibilities, limited only by your imagination,
11555 good sense, and the constraints of your build system.
11557 A precompiled header file can be used only when these conditions apply:
11559 @itemize
11560 @item
11561 Only one precompiled header can be used in a particular compilation.
11562 @item
11563 A precompiled header can't be used once the first C token is seen.  You
11564 can have preprocessor directives before a precompiled header; you can
11565 even include a precompiled header from inside another header, so long as
11566 there are no C tokens before the @code{#include}.
11567 @item
11568 The precompiled header file must be produced for the same language as
11569 the current compilation.  You can't use a C precompiled header for a C++
11570 compilation.
11571 @item
11572 The precompiled header file must be produced by the same compiler
11573 version and configuration as the current compilation is using.
11574 The easiest way to guarantee this is to use the same compiler binary
11575 for creating and using precompiled headers.
11576 @item
11577 Any macros defined before the precompiled header (including with
11578 @option{-D}) must either be defined in the same way as when the
11579 precompiled header was generated, or must not affect the precompiled
11580 header, which usually means that the they don't appear in the
11581 precompiled header at all.
11582 @item
11583 Certain command-line options must be defined in the same way as when the
11584 precompiled header was generated.  At present, it's not clear which
11585 options are safe to change and which are not; the safest choice is to
11586 use exactly the same options when generating and using the precompiled
11587 header.
11588 @end itemize
11590 For all of these but the last, the compiler will automatically ignore
11591 the precompiled header if the conditions aren't met.  For the last item,
11592 some option changes will cause the precompiled header to be rejected,
11593 but not all incompatible option combinations have yet been found.  If
11594 you find a new incompatible combination, please consider filing a bug
11595 report, see @ref{Bugs}.
11597 @node Running Protoize
11598 @section Running Protoize
11600 The program @code{protoize} is an optional part of GCC@.  You can use
11601 it to add prototypes to a program, thus converting the program to ISO
11602 C in one respect.  The companion program @code{unprotoize} does the
11603 reverse: it removes argument types from any prototypes that are found.
11605 When you run these programs, you must specify a set of source files as
11606 command line arguments.  The conversion programs start out by compiling
11607 these files to see what functions they define.  The information gathered
11608 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11610 After scanning comes actual conversion.  The specified files are all
11611 eligible to be converted; any files they include (whether sources or
11612 just headers) are eligible as well.
11614 But not all the eligible files are converted.  By default,
11615 @code{protoize} and @code{unprotoize} convert only source and header
11616 files in the current directory.  You can specify additional directories
11617 whose files should be converted with the @option{-d @var{directory}}
11618 option.  You can also specify particular files to exclude with the
11619 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11620 directory name matches one of the specified directory names, and its
11621 name within the directory has not been excluded.
11623 Basic conversion with @code{protoize} consists of rewriting most
11624 function definitions and function declarations to specify the types of
11625 the arguments.  The only ones not rewritten are those for varargs
11626 functions.
11628 @code{protoize} optionally inserts prototype declarations at the
11629 beginning of the source file, to make them available for any calls that
11630 precede the function's definition.  Or it can insert prototype
11631 declarations with block scope in the blocks where undeclared functions
11632 are called.
11634 Basic conversion with @code{unprotoize} consists of rewriting most
11635 function declarations to remove any argument types, and rewriting
11636 function definitions to the old-style pre-ISO form.
11638 Both conversion programs print a warning for any function declaration or
11639 definition that they can't convert.  You can suppress these warnings
11640 with @option{-q}.
11642 The output from @code{protoize} or @code{unprotoize} replaces the
11643 original source file.  The original file is renamed to a name ending
11644 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11645 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11646 for DOS) file already exists, then the source file is simply discarded.
11648 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11649 scan the program and collect information about the functions it uses.
11650 So neither of these programs will work until GCC is installed.
11652 Here is a table of the options you can use with @code{protoize} and
11653 @code{unprotoize}.  Each option works with both programs unless
11654 otherwise stated.
11656 @table @code
11657 @item -B @var{directory}
11658 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11659 usual directory (normally @file{/usr/local/lib}).  This file contains
11660 prototype information about standard system functions.  This option
11661 applies only to @code{protoize}.
11663 @item -c @var{compilation-options}
11664 Use @var{compilation-options} as the options when running @command{gcc} to
11665 produce the @samp{.X} files.  The special option @option{-aux-info} is
11666 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11668 Note that the compilation options must be given as a single argument to
11669 @code{protoize} or @code{unprotoize}.  If you want to specify several
11670 @command{gcc} options, you must quote the entire set of compilation options
11671 to make them a single word in the shell.
11673 There are certain @command{gcc} arguments that you cannot use, because they
11674 would produce the wrong kind of output.  These include @option{-g},
11675 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11676 the @var{compilation-options}, they are ignored.
11678 @item -C
11679 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11680 systems) instead of @samp{.c}.  This is convenient if you are converting
11681 a C program to C++.  This option applies only to @code{protoize}.
11683 @item -g
11684 Add explicit global declarations.  This means inserting explicit
11685 declarations at the beginning of each source file for each function
11686 that is called in the file and was not declared.  These declarations
11687 precede the first function definition that contains a call to an
11688 undeclared function.  This option applies only to @code{protoize}.
11690 @item -i @var{string}
11691 Indent old-style parameter declarations with the string @var{string}.
11692 This option applies only to @code{protoize}.
11694 @code{unprotoize} converts prototyped function definitions to old-style
11695 function definitions, where the arguments are declared between the
11696 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11697 uses five spaces as the indentation.  If you want to indent with just
11698 one space instead, use @option{-i " "}.
11700 @item -k
11701 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11702 is finished.
11704 @item -l
11705 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11706 a prototype declaration for each function in each block which calls the
11707 function without any declaration.  This option applies only to
11708 @code{protoize}.
11710 @item -n
11711 Make no real changes.  This mode just prints information about the conversions
11712 that would have been done without @option{-n}.
11714 @item -N
11715 Make no @samp{.save} files.  The original files are simply deleted.
11716 Use this option with caution.
11718 @item -p @var{program}
11719 Use the program @var{program} as the compiler.  Normally, the name
11720 @file{gcc} is used.
11722 @item -q
11723 Work quietly.  Most warnings are suppressed.
11725 @item -v
11726 Print the version number, just like @option{-v} for @command{gcc}.
11727 @end table
11729 If you need special compiler options to compile one of your program's
11730 source files, then you should generate that file's @samp{.X} file
11731 specially, by running @command{gcc} on that source file with the
11732 appropriate options and the option @option{-aux-info}.  Then run
11733 @code{protoize} on the entire set of files.  @code{protoize} will use
11734 the existing @samp{.X} file because it is newer than the source file.
11735 For example:
11737 @example
11738 gcc -Dfoo=bar file1.c -aux-info file1.X
11739 protoize *.c
11740 @end example
11742 @noindent
11743 You need to include the special files along with the rest in the
11744 @code{protoize} command, even though their @samp{.X} files already
11745 exist, because otherwise they won't get converted.
11747 @xref{Protoize Caveats}, for more information on how to use
11748 @code{protoize} successfully.