* config/xtensa/lib1funcs.asm: Avoid use of .Lfe* in .size directives.
[official-gcc.git] / gcc / doc / invoke.texi
blobfae76ab516370f3f2540c8e72d824a10fe1a461b
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  -fvtable-gc  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
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}
238 @item Debugging Options
239 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
240 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
241 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
242 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
243 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
244 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
245 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
246 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
247 -fmem-report -fprofile-arcs @gol
248 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
249 -ftest-coverage  -ftime-report @gol
250 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
251 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
252 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
253 -print-multi-directory  -print-multi-lib @gol
254 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
255 -save-temps  -time}
257 @item Optimization Options
258 @xref{Optimize Options,,Options that Control Optimization}.
259 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
260 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
261 -fbranch-probabilities  -fcaller-saves  -fcprop-registers @gol
262 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
263 -fdelayed-branch  -fdelete-null-pointer-checks @gol
264 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
265 -fforce-addr  -fforce-mem  -ffunction-sections @gol
266 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
267 -fif-conversion  -fif-conversion2 @gol
268 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
269 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
270 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
271 -fno-default-inline  -fno-defer-pop @gol
272 -fno-function-cse  -fno-guess-branch-probability @gol
273 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
274 -funsafe-math-optimizations  -ffinite-math-only @gol
275 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
276 -fomit-frame-pointer  -foptimize-register-move @gol
277 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
278 -freduce-all-givs  -fregmove  -frename-registers @gol
279 -freorder-blocks  -freorder-functions @gol
280 -frerun-cse-after-loop  -frerun-loop-opt @gol
281 -fschedule-insns  -fschedule-insns2 @gol
282 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
283 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
284 -fsched2-use-traces  -fsignaling-nans @gol
285 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
286 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
287 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
288 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
289 --param @var{name}=@var{value}
290 -O  -O0  -O1  -O2  -O3  -Os}
292 @item Preprocessor Options
293 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
294 @gccoptlist{-A@var{question}=@var{answer} @gol
295 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
296 -C  -dD  -dI  -dM  -dN @gol
297 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
298 -idirafter @var{dir} @gol
299 -include @var{file}  -imacros @var{file} @gol
300 -iprefix @var{file}  -iwithprefix @var{dir} @gol
301 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
302 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
303 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
304 -Xpreprocessor @var{option}}
306 @item Assembler Option
307 @xref{Assembler Options,,Passing Options to the Assembler}.
308 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
310 @item Linker Options
311 @xref{Link Options,,Options for Linking}.
312 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
313 -nostartfiles  -nodefaultlibs  -nostdlib @gol
314 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
315 -Wl,@var{option}  -Xlinker @var{option} @gol
316 -u @var{symbol}}
318 @item Directory Options
319 @xref{Directory Options,,Options for Directory Search}.
320 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
322 @item Target Options
323 @c I wrote this xref this way to avoid overfull hbox. -- rms
324 @xref{Target Options}.
325 @gccoptlist{-V @var{version}  -b @var{machine}}
327 @item Machine Dependent Options
328 @xref{Submodel Options,,Hardware Models and Configurations}.
330 @emph{M680x0 Options}
331 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
332 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
333 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
334 -malign-int  -mstrict-align}
336 @emph{M68hc1x Options}
337 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
338 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
339 -msoft-reg-count=@var{count}}
341 @emph{VAX Options}
342 @gccoptlist{-mg  -mgnu  -munix}
344 @emph{SPARC Options}
345 @gccoptlist{-mcpu=@var{cpu-type} @gol
346 -mtune=@var{cpu-type} @gol
347 -mcmodel=@var{code-model} @gol
348 -m32  -m64 @gol
349 -mapp-regs  -mbroken-saverestore  -mcypress @gol
350 -mfaster-structs  -mflat @gol
351 -mfpu  -mhard-float  -mhard-quad-float @gol
352 -mimpure-text  -mlive-g0  -mno-app-regs @gol
353 -mno-faster-structs  -mno-flat  -mno-fpu @gol
354 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
355 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
356 -msupersparc  -munaligned-doubles  -mv8}
358 @emph{ARM Options}
359 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
360 -mapcs-26  -mapcs-32 @gol
361 -mapcs-stack-check  -mno-apcs-stack-check @gol
362 -mapcs-float  -mno-apcs-float @gol
363 -mapcs-reentrant  -mno-apcs-reentrant @gol
364 -msched-prolog  -mno-sched-prolog @gol
365 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
366 -malignment-traps  -mno-alignment-traps @gol
367 -msoft-float  -mhard-float  -mfpe @gol
368 -mthumb-interwork  -mno-thumb-interwork @gol
369 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
370 -mstructure-size-boundary=@var{n} @gol
371 -mabort-on-noreturn @gol
372 -mlong-calls  -mno-long-calls @gol
373 -msingle-pic-base  -mno-single-pic-base @gol
374 -mpic-register=@var{reg} @gol
375 -mnop-fun-dllimport @gol
376 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
377 -mpoke-function-name @gol
378 -mthumb  -marm @gol
379 -mtpcs-frame  -mtpcs-leaf-frame @gol
380 -mcaller-super-interworking  -mcallee-super-interworking}
382 @emph{MN10200 Options}
383 @gccoptlist{-mrelax}
385 @emph{MN10300 Options}
386 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
387 -mam33  -mno-am33 @gol
388 -mno-crt0  -mrelax}
390 @emph{M32R/D Options}
391 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
392 -msdata=@var{sdata-type}  -G @var{num}}
394 @emph{M88K Options}
395 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
396 -mcheck-zero-division  -mhandle-large-shift @gol
397 -midentify-revision  -mno-check-zero-division @gol
398 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
399 -mno-optimize-arg-area  -mno-serialize-volatile @gol
400 -mno-underscores  -mocs-debug-info @gol
401 -mocs-frame-position  -moptimize-arg-area @gol
402 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
403 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
404 -mversion-03.00  -mwarn-passed-structs}
406 @emph{RS/6000 and PowerPC Options}
407 @gccoptlist{-mcpu=@var{cpu-type} @gol
408 -mtune=@var{cpu-type} @gol
409 -mpower  -mno-power  -mpower2  -mno-power2 @gol
410 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
411 -maltivec  -mno-altivec @gol
412 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
413 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
414 -mnew-mnemonics  -mold-mnemonics @gol
415 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
416 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
417 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
418 -mstring  -mno-string  -mupdate  -mno-update @gol
419 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
420 -mstrict-align  -mno-strict-align  -mrelocatable @gol
421 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
422 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
423 -mdynamic-no-pic @gol
424 -mcall-sysv  -mcall-netbsd @gol
425 -maix-struct-return  -msvr4-struct-return @gol
426 -mabi=altivec  -mabi=no-altivec @gol
427 -mabi=spe  -mabi=no-spe @gol
428 -misel=yes  -misel=no @gol
429 -mspe=yes  -mspe=no @gol
430 -mfloat-gprs=yes  -mfloat-gprs=no @gol
431 -mprototype  -mno-prototype @gol
432 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
433 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
435 @emph{Darwin Options}
436 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
437 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
438 -client_name  -compatibility_version  -current_version @gol
439 -dependency-file  -dylib_file  -dylinker_install_name @gol
440 -dynamic  -dynamiclib  -exported_symbols_list @gol
441 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
442 -force_flat_namespace  -headerpad_max_install_names @gol
443 -image_base  -init  -install_name  -keep_private_externs @gol
444 -multi_module  -multiply_defined  -multiply_defined_unused @gol
445 -noall_load  -nomultidefs  -noprebind  -noseglinkedit @gol
446 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
447 -private_bundle  -read_only_relocs  -sectalign @gol
448 -sectobjectsymbols  -whyload  -seg1addr @gol
449 -sectcreate  -sectobjectsymbols  -sectorder @gol
450 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
451 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
452 -single_module  -static  -sub_library  -sub_umbrella @gol
453 -twolevel_namespace  -umbrella  -undefined @gol
454 -unexported_symbols_list  -weak_reference_mismatches @gol
455 -whatsloaded}
457 @emph{RT Options}
458 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
459 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
460 -mminimum-fp-blocks  -mnohc-struct-return}
462 @emph{MIPS Options}
463 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
464 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
465 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
466 -mgas  -mgp32  -mgp64 @gol
467 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
468 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
469 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
470 -mmips-as  -mmips-tfile  -mno-abicalls @gol
471 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
472 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
473 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
474 -mrnames  -msoft-float @gol
475 -m4650  -msingle-float  -mmad @gol
476 -EL  -EB  -G @var{num}  -nocpp @gol
477 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
478 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
479 -mbranch-likely -mno-branch-likely}
481 @emph{i386 and x86-64 Options}
482 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
483 -mfpmath=@var{unit} @gol
484 -masm=@var{dialect}  -mno-fancy-math-387 @gol
485 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
486 -mno-wide-multiply  -mrtd  -malign-double @gol
487 -mpreferred-stack-boundary=@var{num} @gol
488 -mmmx  -msse  -msse2  -m3dnow @gol
489 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
490 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
491 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
492 -mno-red-zone @gol
493 -mcmodel=@var{code-model} @gol
494 -m32  -m64}
496 @emph{HPPA Options}
497 @gccoptlist{-march=@var{architecture-type} @gol
498 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
499 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
500 -mjump-in-delay -mlinker-opt -mlong-calls @gol
501 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
502 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
503 -mno-jump-in-delay  -mno-long-load-store @gol
504 -mno-portable-runtime  -mno-soft-float @gol
505 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
506 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
507 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
508 -nolibdld  -static  -threads}
510 @emph{Intel 960 Options}
511 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
512 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
513 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
514 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
515 -mno-complex-addr  -mno-leaf-procedures @gol
516 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
517 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
518 -mtail-call}
520 @emph{DEC Alpha Options}
521 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
522 -mieee  -mieee-with-inexact  -mieee-conformant @gol
523 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
524 -mtrap-precision=@var{mode}  -mbuild-constants @gol
525 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
526 -mbwx  -mmax  -mfix  -mcix @gol
527 -mfloat-vax  -mfloat-ieee @gol
528 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
529 -msmall-text  -mlarge-text @gol
530 -mmemory-latency=@var{time}}
532 @emph{DEC Alpha/VMS Options}
533 @gccoptlist{-mvms-return-codes}
535 @emph{H8/300 Options}
536 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
538 @emph{SH Options}
539 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
540 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
541 -m5-64media  -m5-64media-nofpu @gol
542 -m5-32media  -m5-32media-nofpu @gol
543 -m5-compact  -m5-compact-nofpu @gol
544 -mb  -ml  -mdalign  -mrelax @gol
545 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
546 -mieee  -misize  -mpadstruct  -mspace @gol
547 -mprefergot  -musermode}
549 @emph{System V Options}
550 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
552 @emph{ARC Options}
553 @gccoptlist{-EB  -EL @gol
554 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
555 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
557 @emph{TMS320C3x/C4x Options}
558 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
559 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
560 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
561 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
563 @emph{V850 Options}
564 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
565 -mprolog-function  -mno-prolog-function  -mspace @gol
566 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
567 -mapp-regs  -mno-app-regs @gol
568 -mdisable-callt  -mno-disable-callt @gol
569 -mv850e @gol
570 -mv850  -mbig-switch}
572 @emph{NS32K Options}
573 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
574 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
575 -mregparam  -mnoregparam  -msb  -mnosb @gol
576 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
578 @emph{AVR Options}
579 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
580 -mcall-prologues  -mno-tablejump  -mtiny-stack}
582 @emph{MCore Options}
583 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
584 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
585 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
586 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
587 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
589 @emph{MMIX Options}
590 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
591 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
592 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
593 -mno-base-addresses  -msingle-exit  -mno-single-exit}
595 @emph{IA-64 Options}
596 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
597 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
598 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
599 -minline-float-divide-max-throughput @gol
600 -minline-int-divide-min-latency @gol
601 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
602 -mfixed-range=@var{register-range}}
604 @emph{D30V Options}
605 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
606 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
608 @emph{S/390 and zSeries Options}
609 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
610 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
611 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
612 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
614 @emph{CRIS Options}
615 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
616 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
617 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
618 -mstack-align  -mdata-align  -mconst-align @gol
619 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
620 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
622 @emph{PDP-11 Options}
623 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
624 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
625 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
626 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
627 -mbranch-expensive  -mbranch-cheap @gol
628 -msplit  -mno-split  -munix-asm  -mdec-asm}
630 @emph{Xstormy16 Options}
631 @gccoptlist{-msim}
633 @emph{Xtensa Options}
634 @gccoptlist{-mbig-endian  -mlittle-endian @gol
635 -mdensity  -mno-density @gol
636 -mconst16 -mno-const16 @gol
637 -mabs -mno-abs @gol
638 -maddx -mno-addx @gol
639 -mmac16  -mno-mac16 @gol
640 -mmul16  -mno-mul16 @gol
641 -mmul32  -mno-mul32 @gol
642 -mnsa  -mno-nsa @gol
643 -mminmax  -mno-minmax @gol
644 -msext  -mno-sext @gol
645 -mbooleans  -mno-booleans @gol
646 -mhard-float  -msoft-float @gol
647 -mfused-madd  -mno-fused-madd @gol
648 -mserialize-volatile  -mno-serialize-volatile @gol
649 -mtext-section-literals  -mno-text-section-literals @gol
650 -mtarget-align  -mno-target-align @gol
651 -mlongcalls  -mno-longcalls}
653 @emph{FRV Options}
654 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
655 -mhard-float  -msoft-float @gol
656 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
657 -mdouble  -mno-double @gol
658 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
659 -mlibrary-pic  -macc-4 -macc-8 @gol
660 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
661 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
662 -mvliw-branch  -mno-vliw-branch @gol
663 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
664 -mno-nested-cond-exec  -mtomcat-stats @gol
665 -mcpu=@var{cpu}}
667 @item Code Generation Options
668 @xref{Code Gen Options,,Options for Code Generation Conventions}.
669 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
670 -ffixed-@var{reg}  -fexceptions @gol
671 -fnon-call-exceptions  -funwind-tables @gol
672 -fasynchronous-unwind-tables @gol
673 -finhibit-size-directive  -finstrument-functions @gol
674 -fno-common  -fno-ident  -fno-gnu-linker @gol
675 -fpcc-struct-return  -fpic  -fPIC @gol
676 -freg-struct-return  -fshared-data  -fshort-enums @gol
677 -fshort-double  -fshort-wchar @gol
678 -fverbose-asm  -fpack-struct  -fstack-check @gol
679 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
680 -fargument-alias  -fargument-noalias @gol
681 -fargument-noalias-global  -fleading-underscore @gol
682 -ftls-model=@var{model} @gol
683 -ftrapv  -fbounds-check}
684 @end table
686 @menu
687 * Overall Options::     Controlling the kind of output:
688                         an executable, object files, assembler files,
689                         or preprocessed source.
690 * C Dialect Options::   Controlling the variant of C language compiled.
691 * C++ Dialect Options:: Variations on C++.
692 * Objective-C Dialect Options:: Variations on Objective-C.
693 * Language Independent Options:: Controlling how diagnostics should be
694                         formatted.
695 * Warning Options::     How picky should the compiler be?
696 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
697 * Optimize Options::    How much optimization?
698 * Preprocessor Options:: Controlling header files and macro definitions.
699                          Also, getting dependency information for Make.
700 * Assembler Options::   Passing options to the assembler.
701 * Link Options::        Specifying libraries and so on.
702 * Directory Options::   Where to find header files and libraries.
703                         Where to find the compiler executable files.
704 * Spec Files::          How to pass switches to sub-processes.
705 * Target Options::      Running a cross-compiler, or an old version of GCC.
706 @end menu
708 @node Overall Options
709 @section Options Controlling the Kind of Output
711 Compilation can involve up to four stages: preprocessing, compilation
712 proper, assembly and linking, always in that order.  The first three
713 stages apply to an individual source file, and end by producing an
714 object file; linking combines all the object files (those newly
715 compiled, and those specified as input) into an executable file.
717 @cindex file name suffix
718 For any given input file, the file name suffix determines what kind of
719 compilation is done:
721 @table @gcctabopt
722 @item @var{file}.c
723 C source code which must be preprocessed.
725 @item @var{file}.i
726 C source code which should not be preprocessed.
728 @item @var{file}.ii
729 C++ source code which should not be preprocessed.
731 @item @var{file}.m
732 Objective-C source code.  Note that you must link with the library
733 @file{libobjc.a} to make an Objective-C program work.
735 @item @var{file}.mi
736 Objective-C source code which should not be preprocessed.
738 @item @var{file}.h
739 C or C++ header file to be turned into a precompiled header.
741 @item @var{file}.cc
742 @itemx @var{file}.cp
743 @itemx @var{file}.cxx
744 @itemx @var{file}.cpp
745 @itemx @var{file}.CPP
746 @itemx @var{file}.c++
747 @itemx @var{file}.C
748 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
749 the last two letters must both be literally @samp{x}.  Likewise,
750 @samp{.C} refers to a literal capital C@.
752 @item @var{file}.hh
753 @itemx @var{file}.H
754 C++ header file to be turned into a precompiled header.
756 @item @var{file}.f
757 @itemx @var{file}.for
758 @itemx @var{file}.FOR
759 Fortran source code which should not be preprocessed.
761 @item @var{file}.F
762 @itemx @var{file}.fpp
763 @itemx @var{file}.FPP
764 Fortran source code which must be preprocessed (with the traditional
765 preprocessor).
767 @item @var{file}.r
768 Fortran source code which must be preprocessed with a RATFOR
769 preprocessor (not included with GCC)@.
771 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
772 Using and Porting GNU Fortran}, for more details of the handling of
773 Fortran input files.
775 @c FIXME: Descriptions of Java file types.
776 @c @var{file}.java
777 @c @var{file}.class
778 @c @var{file}.zip
779 @c @var{file}.jar
781 @item @var{file}.ads
782 Ada source code file which contains a library unit declaration (a
783 declaration of a package, subprogram, or generic, or a generic
784 instantiation), or a library unit renaming declaration (a package,
785 generic, or subprogram renaming declaration).  Such files are also
786 called @dfn{specs}.
788 @itemx @var{file}.adb
789 Ada source code file containing a library unit body (a subprogram or
790 package body).  Such files are also called @dfn{bodies}.
792 @c GCC also knows about some suffixes for languages not yet included:
793 @c Pascal:
794 @c @var{file}.p
795 @c @var{file}.pas
797 @item @var{file}.s
798 Assembler code.
800 @item @var{file}.S
801 Assembler code which must be preprocessed.
803 @item @var{other}
804 An object file to be fed straight into linking.
805 Any file name with no recognized suffix is treated this way.
806 @end table
808 @opindex x
809 You can specify the input language explicitly with the @option{-x} option:
811 @table @gcctabopt
812 @item -x @var{language}
813 Specify explicitly the @var{language} for the following input files
814 (rather than letting the compiler choose a default based on the file
815 name suffix).  This option applies to all following input files until
816 the next @option{-x} option.  Possible values for @var{language} are:
817 @example
818 c  c-header  cpp-output
819 c++  c++-header  c++-cpp-output
820 objective-c  objective-c-header  objc-cpp-output
821 assembler  assembler-with-cpp
823 f77  f77-cpp-input  ratfor
824 java
825 treelang
826 @end example
828 @item -x none
829 Turn off any specification of a language, so that subsequent files are
830 handled according to their file name suffixes (as they are if @option{-x}
831 has not been used at all).
833 @item -pass-exit-codes
834 @opindex pass-exit-codes
835 Normally the @command{gcc} program will exit with the code of 1 if any
836 phase of the compiler returns a non-success return code.  If you specify
837 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
838 numerically highest error produced by any phase that returned an error
839 indication.
840 @end table
842 If you only want some of the stages of compilation, you can use
843 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
844 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
845 @command{gcc} is to stop.  Note that some combinations (for example,
846 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
848 @table @gcctabopt
849 @item -c
850 @opindex c
851 Compile or assemble the source files, but do not link.  The linking
852 stage simply is not done.  The ultimate output is in the form of an
853 object file for each source file.
855 By default, the object file name for a source file is made by replacing
856 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
858 Unrecognized input files, not requiring compilation or assembly, are
859 ignored.
861 @item -S
862 @opindex S
863 Stop after the stage of compilation proper; do not assemble.  The output
864 is in the form of an assembler code file for each non-assembler input
865 file specified.
867 By default, the assembler file name for a source file is made by
868 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
870 Input files that don't require compilation are ignored.
872 @item -E
873 @opindex E
874 Stop after the preprocessing stage; do not run the compiler proper.  The
875 output is in the form of preprocessed source code, which is sent to the
876 standard output.
878 Input files which don't require preprocessing are ignored.
880 @cindex output file option
881 @item -o @var{file}
882 @opindex o
883 Place output in file @var{file}.  This applies regardless to whatever
884 sort of output is being produced, whether it be an executable file,
885 an object file, an assembler file or preprocessed C code.
887 Since only one output file can be specified, it does not make sense to
888 use @option{-o} when compiling more than one input file, unless you are
889 producing an executable file as output.
891 If @option{-o} is not specified, the default is to put an executable file
892 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
893 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
894 all preprocessed C source on standard output.
896 @item -v
897 @opindex v
898 Print (on standard error output) the commands executed to run the stages
899 of compilation.  Also print the version number of the compiler driver
900 program and of the preprocessor and the compiler proper.
902 @item -###
903 @opindex ###
904 Like @option{-v} except the commands are not executed and all command
905 arguments are quoted.  This is useful for shell scripts to capture the
906 driver-generated command lines.
908 @item -pipe
909 @opindex pipe
910 Use pipes rather than temporary files for communication between the
911 various stages of compilation.  This fails to work on some systems where
912 the assembler is unable to read from a pipe; but the GNU assembler has
913 no trouble.
915 @item --help
916 @opindex help
917 Print (on the standard output) a description of the command line options
918 understood by @command{gcc}.  If the @option{-v} option is also specified
919 then @option{--help} will also be passed on to the various processes
920 invoked by @command{gcc}, so that they can display the command line options
921 they accept.  If the @option{-Wextra} option is also specified then command
922 line options which have no documentation associated with them will also
923 be displayed.
925 @item --target-help
926 @opindex target-help
927 Print (on the standard output) a description of target specific command
928 line options for each tool.
930 @item --version
931 @opindex version
932 Display the version number and copyrights of the invoked GCC.
933 @end table
935 @node Invoking G++
936 @section Compiling C++ Programs
938 @cindex suffixes for C++ source
939 @cindex C++ source file suffixes
940 C++ source files conventionally use one of the suffixes @samp{.C},
941 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
942 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
943 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
944 files with these names and compiles them as C++ programs even if you
945 call the compiler the same way as for compiling C programs (usually
946 with the name @command{gcc}).
948 @findex g++
949 @findex c++
950 However, C++ programs often require class libraries as well as a
951 compiler that understands the C++ language---and under some
952 circumstances, you might want to compile programs or header files from
953 standard input, or otherwise without a suffix that flags them as C++
954 programs.  You might also like to precompile a C header file with a
955 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
956 program that calls GCC with the default language set to C++, and
957 automatically specifies linking against the C++ library.  On many
958 systems, @command{g++} is also installed with the name @command{c++}.
960 @cindex invoking @command{g++}
961 When you compile C++ programs, you may specify many of the same
962 command-line options that you use for compiling programs in any
963 language; or command-line options meaningful for C and related
964 languages; or options that are meaningful only for C++ programs.
965 @xref{C Dialect Options,,Options Controlling C Dialect}, for
966 explanations of options for languages related to C@.
967 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
968 explanations of options that are meaningful only for C++ programs.
970 @node C Dialect Options
971 @section Options Controlling C Dialect
972 @cindex dialect options
973 @cindex language dialect options
974 @cindex options, dialect
976 The following options control the dialect of C (or languages derived
977 from C, such as C++ and Objective-C) that the compiler accepts:
979 @table @gcctabopt
980 @cindex ANSI support
981 @cindex ISO support
982 @item -ansi
983 @opindex ansi
984 In C mode, support all ISO C90 programs.  In C++ mode,
985 remove GNU extensions that conflict with ISO C++.
987 This turns off certain features of GCC that are incompatible with ISO
988 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
989 such as the @code{asm} and @code{typeof} keywords, and
990 predefined macros such as @code{unix} and @code{vax} that identify the
991 type of system you are using.  It also enables the undesirable and
992 rarely used ISO trigraph feature.  For the C compiler,
993 it disables recognition of C++ style @samp{//} comments as well as
994 the @code{inline} keyword.
996 The alternate keywords @code{__asm__}, @code{__extension__},
997 @code{__inline__} and @code{__typeof__} continue to work despite
998 @option{-ansi}.  You would not want to use them in an ISO C program, of
999 course, but it is useful to put them in header files that might be included
1000 in compilations done with @option{-ansi}.  Alternate predefined macros
1001 such as @code{__unix__} and @code{__vax__} are also available, with or
1002 without @option{-ansi}.
1004 The @option{-ansi} option does not cause non-ISO programs to be
1005 rejected gratuitously.  For that, @option{-pedantic} is required in
1006 addition to @option{-ansi}.  @xref{Warning Options}.
1008 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1009 option is used.  Some header files may notice this macro and refrain
1010 from declaring certain functions or defining certain macros that the
1011 ISO standard doesn't call for; this is to avoid interfering with any
1012 programs that might use these names for other things.
1014 Functions which would normally be built in but do not have semantics
1015 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1016 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1017 built-in functions provided by GCC}, for details of the functions
1018 affected.
1020 @item -std=
1021 @opindex std
1022 Determine the language standard.  This option is currently only
1023 supported when compiling C or C++.  A value for this option must be
1024 provided; possible values are
1026 @table @samp
1027 @item c89
1028 @itemx iso9899:1990
1029 ISO C90 (same as @option{-ansi}).
1031 @item iso9899:199409
1032 ISO C90 as modified in amendment 1.
1034 @item c99
1035 @itemx c9x
1036 @itemx iso9899:1999
1037 @itemx iso9899:199x
1038 ISO C99.  Note that this standard is not yet fully supported; see
1039 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1040 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1042 @item gnu89
1043 Default, ISO C90 plus GNU extensions (including some C99 features).
1045 @item gnu99
1046 @item gnu9x
1047 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1048 this will become the default.  The name @samp{gnu9x} is deprecated.
1050 @item c++98
1051 The 1998 ISO C++ standard plus amendments.
1053 @item gnu++98
1054 The same as @option{-std=c++98} plus GNU extensions.  This is the
1055 default for C++ code.
1056 @end table
1058 Even when this option is not specified, you can still use some of the
1059 features of newer standards in so far as they do not conflict with
1060 previous C standards.  For example, you may use @code{__restrict__} even
1061 when @option{-std=c99} is not specified.
1063 The @option{-std} options specifying some version of ISO C have the same
1064 effects as @option{-ansi}, except that features that were not in ISO C90
1065 but are in the specified version (for example, @samp{//} comments and
1066 the @code{inline} keyword in ISO C99) are not disabled.
1068 @xref{Standards,,Language Standards Supported by GCC}, for details of
1069 these standard versions.
1071 @item -aux-info @var{filename}
1072 @opindex aux-info
1073 Output to the given filename prototyped declarations for all functions
1074 declared and/or defined in a translation unit, including those in header
1075 files.  This option is silently ignored in any language other than C@.
1077 Besides declarations, the file indicates, in comments, the origin of
1078 each declaration (source file and line), whether the declaration was
1079 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1080 @samp{O} for old, respectively, in the first character after the line
1081 number and the colon), and whether it came from a declaration or a
1082 definition (@samp{C} or @samp{F}, respectively, in the following
1083 character).  In the case of function definitions, a K&R-style list of
1084 arguments followed by their declarations is also provided, inside
1085 comments, after the declaration.
1087 @item -fno-asm
1088 @opindex fno-asm
1089 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1090 keyword, so that code can use these words as identifiers.  You can use
1091 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1092 instead.  @option{-ansi} implies @option{-fno-asm}.
1094 In C++, this switch only affects the @code{typeof} keyword, since
1095 @code{asm} and @code{inline} are standard keywords.  You may want to
1096 use the @option{-fno-gnu-keywords} flag instead, which has the same
1097 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1098 switch only affects the @code{asm} and @code{typeof} keywords, since
1099 @code{inline} is a standard keyword in ISO C99.
1101 @item -fno-builtin
1102 @itemx -fno-builtin-@var{function}
1103 @opindex fno-builtin
1104 @cindex built-in functions
1105 Don't recognize built-in functions that do not begin with
1106 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1107 functions provided by GCC}, for details of the functions affected,
1108 including those which are not built-in functions when @option{-ansi} or
1109 @option{-std} options for strict ISO C conformance are used because they
1110 do not have an ISO standard meaning.
1112 GCC normally generates special code to handle certain built-in functions
1113 more efficiently; for instance, calls to @code{alloca} may become single
1114 instructions that adjust the stack directly, and calls to @code{memcpy}
1115 may become inline copy loops.  The resulting code is often both smaller
1116 and faster, but since the function calls no longer appear as such, you
1117 cannot set a breakpoint on those calls, nor can you change the behavior
1118 of the functions by linking with a different library.
1120 With the @option{-fno-builtin-@var{function}} option
1121 only the built-in function @var{function} is
1122 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1123 function is named this is not built-in in this version of GCC, this
1124 option is ignored.  There is no corresponding
1125 @option{-fbuiltin-@var{function}} option; if you wish to enable
1126 built-in functions selectively when using @option{-fno-builtin} or
1127 @option{-ffreestanding}, you may define macros such as:
1129 @smallexample
1130 #define abs(n)          __builtin_abs ((n))
1131 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1132 @end smallexample
1134 @item -fhosted
1135 @opindex fhosted
1136 @cindex hosted environment
1138 Assert that compilation takes place in a hosted environment.  This implies
1139 @option{-fbuiltin}.  A hosted environment is one in which the
1140 entire standard library is available, and in which @code{main} has a return
1141 type of @code{int}.  Examples are nearly everything except a kernel.
1142 This is equivalent to @option{-fno-freestanding}.
1144 @item -ffreestanding
1145 @opindex ffreestanding
1146 @cindex hosted environment
1148 Assert that compilation takes place in a freestanding environment.  This
1149 implies @option{-fno-builtin}.  A freestanding environment
1150 is one in which the standard library may not exist, and program startup may
1151 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1152 This is equivalent to @option{-fno-hosted}.
1154 @xref{Standards,,Language Standards Supported by GCC}, for details of
1155 freestanding and hosted environments.
1157 @item -fms-extensions
1158 @opindex fms-extensions
1159 Accept some non-standard constructs used in Microsoft header files.
1161 @item -trigraphs
1162 @opindex trigraphs
1163 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1164 options for strict ISO C conformance) implies @option{-trigraphs}.
1166 @item -no-integrated-cpp
1167 @opindex no-integrated-cpp
1168 Performs a compilation in two passes: preprocessing and compiling.  This
1169 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1170 @option{-B} option. The user supplied compilation step can then add in
1171 an additional preprocessing step after normal preprocessing but before
1172 compiling. The default is to use the integrated cpp (internal cpp)
1174 The semantics of this option will change if "cc1", "cc1plus", and
1175 "cc1obj" are merged.
1177 @cindex traditional C language
1178 @cindex C language, traditional
1179 @item -traditional
1180 @itemx -traditional-cpp
1181 @opindex traditional-cpp
1182 @opindex traditional
1183 Formerly, these options caused GCC to attempt to emulate a pre-standard
1184 C compiler.  They are now only supported with the @option{-E} switch.
1185 The preprocessor continues to support a pre-standard mode.  See the GNU
1186 CPP manual for details.
1188 @item -fcond-mismatch
1189 @opindex fcond-mismatch
1190 Allow conditional expressions with mismatched types in the second and
1191 third arguments.  The value of such an expression is void.  This option
1192 is not supported for C++.
1194 @item -funsigned-char
1195 @opindex funsigned-char
1196 Let the type @code{char} be unsigned, like @code{unsigned char}.
1198 Each kind of machine has a default for what @code{char} should
1199 be.  It is either like @code{unsigned char} by default or like
1200 @code{signed char} by default.
1202 Ideally, a portable program should always use @code{signed char} or
1203 @code{unsigned char} when it depends on the signedness of an object.
1204 But many programs have been written to use plain @code{char} and
1205 expect it to be signed, or expect it to be unsigned, depending on the
1206 machines they were written for.  This option, and its inverse, let you
1207 make such a program work with the opposite default.
1209 The type @code{char} is always a distinct type from each of
1210 @code{signed char} or @code{unsigned char}, even though its behavior
1211 is always just like one of those two.
1213 @item -fsigned-char
1214 @opindex fsigned-char
1215 Let the type @code{char} be signed, like @code{signed char}.
1217 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1218 the negative form of @option{-funsigned-char}.  Likewise, the option
1219 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1221 @item -fsigned-bitfields
1222 @itemx -funsigned-bitfields
1223 @itemx -fno-signed-bitfields
1224 @itemx -fno-unsigned-bitfields
1225 @opindex fsigned-bitfields
1226 @opindex funsigned-bitfields
1227 @opindex fno-signed-bitfields
1228 @opindex fno-unsigned-bitfields
1229 These options control whether a bit-field is signed or unsigned, when the
1230 declaration does not use either @code{signed} or @code{unsigned}.  By
1231 default, such a bit-field is signed, because this is consistent: the
1232 basic integer types such as @code{int} are signed types.
1234 @item -fwritable-strings
1235 @opindex fwritable-strings
1236 Store string constants in the writable data segment and don't uniquize
1237 them.  This is for compatibility with old programs which assume they can
1238 write into string constants.
1240 Writing into string constants is a very bad idea; ``constants'' should
1241 be constant.
1242 @end table
1244 @node C++ Dialect Options
1245 @section Options Controlling C++ Dialect
1247 @cindex compiler options, C++
1248 @cindex C++ options, command line
1249 @cindex options, C++
1250 This section describes the command-line options that are only meaningful
1251 for C++ programs; but you can also use most of the GNU compiler options
1252 regardless of what language your program is in.  For example, you
1253 might compile a file @code{firstClass.C} like this:
1255 @example
1256 g++ -g -frepo -O -c firstClass.C
1257 @end example
1259 @noindent
1260 In this example, only @option{-frepo} is an option meant
1261 only for C++ programs; you can use the other options with any
1262 language supported by GCC@.
1264 Here is a list of options that are @emph{only} for compiling C++ programs:
1266 @table @gcctabopt
1268 @item -fabi-version=@var{n}
1269 @opindex fabi-version
1270 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1271 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1272 version that conforms most closely to the C++ ABI specification.
1273 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1274 fixed.
1276 The default is version 1.
1278 @item -fno-access-control
1279 @opindex fno-access-control
1280 Turn off all access checking.  This switch is mainly useful for working
1281 around bugs in the access control code.
1283 @item -fcheck-new
1284 @opindex fcheck-new
1285 Check that the pointer returned by @code{operator new} is non-null
1286 before attempting to modify the storage allocated.  This check is
1287 normally unnecessary because the C++ standard specifies that
1288 @code{operator new} will only return @code{0} if it is declared
1289 @samp{throw()}, in which case the compiler will always check the
1290 return value even without this option.  In all other cases, when
1291 @code{operator new} has a non-empty exception specification, memory
1292 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1293 @samp{new (nothrow)}.
1295 @item -fconserve-space
1296 @opindex fconserve-space
1297 Put uninitialized or runtime-initialized global variables into the
1298 common segment, as C does.  This saves space in the executable at the
1299 cost of not diagnosing duplicate definitions.  If you compile with this
1300 flag and your program mysteriously crashes after @code{main()} has
1301 completed, you may have an object that is being destroyed twice because
1302 two definitions were merged.
1304 This option is no longer useful on most targets, now that support has
1305 been added for putting variables into BSS without making them common.
1307 @item -fno-const-strings
1308 @opindex fno-const-strings
1309 Give string constants type @code{char *} instead of type @code{const
1310 char *}.  By default, G++ uses type @code{const char *} as required by
1311 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1312 actually modify the value of a string constant, unless you also use
1313 @option{-fwritable-strings}.
1315 This option might be removed in a future release of G++.  For maximum
1316 portability, you should structure your code so that it works with
1317 string constants that have type @code{const char *}.
1319 @item -fno-elide-constructors
1320 @opindex fno-elide-constructors
1321 The C++ standard allows an implementation to omit creating a temporary
1322 which is only used to initialize another object of the same type.
1323 Specifying this option disables that optimization, and forces G++ to
1324 call the copy constructor in all cases.
1326 @item -fno-enforce-eh-specs
1327 @opindex fno-enforce-eh-specs
1328 Don't check for violation of exception specifications at runtime.  This
1329 option violates the C++ standard, but may be useful for reducing code
1330 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1331 will still optimize based on the exception specifications.
1333 @item -fexternal-templates
1334 @opindex fexternal-templates
1336 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1337 template instantiation; template instances are emitted or not according
1338 to the location of the template definition.  @xref{Template
1339 Instantiation}, for more information.
1341 This option is deprecated.
1343 @item -falt-external-templates
1344 @opindex falt-external-templates
1345 Similar to @option{-fexternal-templates}, but template instances are
1346 emitted or not according to the place where they are first instantiated.
1347 @xref{Template Instantiation}, for more information.
1349 This option is deprecated.
1351 @item -ffor-scope
1352 @itemx -fno-for-scope
1353 @opindex ffor-scope
1354 @opindex fno-for-scope
1355 If @option{-ffor-scope} is specified, the scope of variables declared in
1356 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1357 as specified by the C++ standard.
1358 If @option{-fno-for-scope} is specified, the scope of variables declared in
1359 a @i{for-init-statement} extends to the end of the enclosing scope,
1360 as was the case in old versions of G++, and other (traditional)
1361 implementations of C++.
1363 The default if neither flag is given to follow the standard,
1364 but to allow and give a warning for old-style code that would
1365 otherwise be invalid, or have different behavior.
1367 @item -fno-gnu-keywords
1368 @opindex fno-gnu-keywords
1369 Do not recognize @code{typeof} as a keyword, so that code can use this
1370 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1371 @option{-ansi} implies @option{-fno-gnu-keywords}.
1373 @item -fno-implicit-templates
1374 @opindex fno-implicit-templates
1375 Never emit code for non-inline templates which are instantiated
1376 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1377 @xref{Template Instantiation}, for more information.
1379 @item -fno-implicit-inline-templates
1380 @opindex fno-implicit-inline-templates
1381 Don't emit code for implicit instantiations of inline templates, either.
1382 The default is to handle inlines differently so that compiles with and
1383 without optimization will need the same set of explicit instantiations.
1385 @item -fno-implement-inlines
1386 @opindex fno-implement-inlines
1387 To save space, do not emit out-of-line copies of inline functions
1388 controlled by @samp{#pragma implementation}.  This will cause linker
1389 errors if these functions are not inlined everywhere they are called.
1391 @item -fms-extensions
1392 @opindex fms-extensions
1393 Disable pedantic warnings about constructs used in MFC, such as implicit
1394 int and getting a pointer to member function via non-standard syntax.
1396 @item -fno-nonansi-builtins
1397 @opindex fno-nonansi-builtins
1398 Disable built-in declarations of functions that are not mandated by
1399 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1400 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1402 @item -fno-operator-names
1403 @opindex fno-operator-names
1404 Do not treat the operator name keywords @code{and}, @code{bitand},
1405 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1406 synonyms as keywords.
1408 @item -fno-optional-diags
1409 @opindex fno-optional-diags
1410 Disable diagnostics that the standard says a compiler does not need to
1411 issue.  Currently, the only such diagnostic issued by G++ is the one for
1412 a name having multiple meanings within a class.
1414 @item -fpermissive
1415 @opindex fpermissive
1416 Downgrade messages about nonconformant code from errors to warnings.  By
1417 default, G++ effectively sets @option{-pedantic-errors} without
1418 @option{-pedantic}; this option reverses that.  This behavior and this
1419 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1421 @item -frepo
1422 @opindex frepo
1423 Enable automatic template instantiation at link time.  This option also
1424 implies @option{-fno-implicit-templates}.  @xref{Template
1425 Instantiation}, for more information.
1427 @item -fno-rtti
1428 @opindex fno-rtti
1429 Disable generation of information about every class with virtual
1430 functions for use by the C++ runtime type identification features
1431 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1432 of the language, you can save some space by using this flag.  Note that
1433 exception handling uses the same information, but it will generate it as
1434 needed.
1436 @item -fstats
1437 @opindex fstats
1438 Emit statistics about front-end processing at the end of the compilation.
1439 This information is generally only useful to the G++ development team.
1441 @item -ftemplate-depth-@var{n}
1442 @opindex ftemplate-depth
1443 Set the maximum instantiation depth for template classes to @var{n}.
1444 A limit on the template instantiation depth is needed to detect
1445 endless recursions during template class instantiation.  ANSI/ISO C++
1446 conforming programs must not rely on a maximum depth greater than 17.
1448 @item -fuse-cxa-atexit
1449 @opindex fuse-cxa-atexit
1450 Register destructors for objects with static storage duration with the
1451 @code{__cxa_atexit} function rather than the @code{atexit} function.
1452 This option is required for fully standards-compliant handling of static
1453 destructors, but will only work if your C library supports
1454 @code{__cxa_atexit}.
1456 @item -fvtable-gc
1457 @opindex fvtable-gc
1458 Emit special relocations for vtables and virtual function references
1459 so that the linker can identify unused virtual functions and zero out
1460 vtable slots that refer to them.  This is most useful with
1461 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1462 also discard the functions themselves.
1464 This optimization requires GNU as and GNU ld.  Not all systems support
1465 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1467 @item -fno-weak
1468 @opindex fno-weak
1469 Do not use weak symbol support, even if it is provided by the linker.
1470 By default, G++ will use weak symbols if they are available.  This
1471 option exists only for testing, and should not be used by end-users;
1472 it will result in inferior code and has no benefits.  This option may
1473 be removed in a future release of G++.
1475 @item -nostdinc++
1476 @opindex nostdinc++
1477 Do not search for header files in the standard directories specific to
1478 C++, but do still search the other standard directories.  (This option
1479 is used when building the C++ library.)
1480 @end table
1482 In addition, these optimization, warning, and code generation options
1483 have meanings only for C++ programs:
1485 @table @gcctabopt
1486 @item -fno-default-inline
1487 @opindex fno-default-inline
1488 Do not assume @samp{inline} for functions defined inside a class scope.
1489 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1490 functions will have linkage like inline functions; they just won't be
1491 inlined by default.
1493 @item -Wabi @r{(C++ only)}
1494 @opindex Wabi
1495 Warn when G++ generates code that is probably not compatible with the
1496 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1497 all such cases, there are probably some cases that are not warned about, 
1498 even though G++ is generating incompatible code.  There may also be
1499 cases where warnings are emitted even though the code that is generated
1500 will be compatible.
1502 You should rewrite your code to avoid these warnings if you are
1503 concerned about the fact that code generated by G++ may not be binary
1504 compatible with code generated by other compilers.
1506 The known incompatibilities at this point include:
1508 @itemize @bullet
1510 @item
1511 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1512 pack data into the same byte as a base class.  For example:
1514 @smallexample
1515 struct A @{ virtual void f(); int f1 : 1; @};
1516 struct B : public A @{ int f2 : 1; @};
1517 @end smallexample
1519 @noindent
1520 In this case, G++ will place @code{B::f2} into the same byte
1521 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1522 by explicitly padding @code{A} so that its size is a multiple of the
1523 byte size on your platform; that will cause G++ and other compilers to
1524 layout @code{B} identically.
1526 @item
1527 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1528 tail padding when laying out virtual bases.  For example:
1530 @smallexample
1531 struct A @{ virtual void f(); char c1; @};
1532 struct B @{ B(); char c2; @};
1533 struct C : public A, public virtual B @{@};
1534 @end smallexample
1536 @noindent
1537 In this case, G++ will not place @code{B} into the tail-padding for
1538 @code{A}; other compilers will.  You can avoid this problem by
1539 explicitly padding @code{A} so that its size is a multiple of its
1540 alignment (ignoring virtual base classes); that will cause G++ and other
1541 compilers to layout @code{C} identically.
1543 @item
1544 Incorrect handling of bit-fields with declared widths greater than that
1545 of their underlying types, when the bit-fields appear in a union.  For
1546 example:
1548 @smallexample
1549 union U @{ int i : 4096; @};
1550 @end smallexample
1552 @noindent
1553 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1554 union too small by the number of bits in an @code{int}.
1556 @item
1557 Empty classes can be placed at incorrect offsets.  For example:
1559 @smallexample
1560 struct A @{@};
1562 struct B @{
1563   A a;
1564   virtual void f ();
1567 struct C : public B, public A @{@};
1568 @end smallexample
1570 @noindent
1571 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1572 it should be placed at offset zero.  G++ mistakenly believes that the
1573 @code{A} data member of @code{B} is already at offset zero.
1575 @item
1576 Names of template functions whose types involve @code{typename} or
1577 template template parameters can be mangled incorrectly.
1579 @smallexample
1580 template <typename Q>
1581 void f(typename Q::X) @{@}
1583 template <template <typename> class Q>
1584 void f(typename Q<int>::X) @{@}
1585 @end smallexample
1587 @noindent
1588 Instantiations of these templates may be mangled incorrectly.
1590 @end itemize
1592 @item -Wctor-dtor-privacy @r{(C++ only)}
1593 @opindex Wctor-dtor-privacy
1594 Warn when a class seems unusable, because all the constructors or
1595 destructors in a class are private and the class has no friends or
1596 public static member functions.
1598 @item -Wnon-virtual-dtor @r{(C++ only)}
1599 @opindex Wnon-virtual-dtor
1600 Warn when a class declares a non-virtual destructor that should probably
1601 be virtual, because it looks like the class will be used polymorphically.
1602 This warning is enabled by @option{-Wall}.
1604 @item -Wreorder @r{(C++ only)}
1605 @opindex Wreorder
1606 @cindex reordering, warning
1607 @cindex warning for reordering of member initializers
1608 Warn when the order of member initializers given in the code does not
1609 match the order in which they must be executed.  For instance:
1611 @smallexample
1612 struct A @{
1613   int i;
1614   int j;
1615   A(): j (0), i (1) @{ @}
1617 @end smallexample
1619 Here the compiler will warn that the member initializers for @samp{i}
1620 and @samp{j} will be rearranged to match the declaration order of the
1621 members.  This warning is enabled by @option{-Wall}.
1622 @end table
1624 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1626 @table @gcctabopt
1627 @item -Weffc++ @r{(C++ only)}
1628 @opindex Weffc++
1629 Warn about violations of the following style guidelines from Scott Meyers'
1630 @cite{Effective C++} book:
1632 @itemize @bullet
1633 @item
1634 Item 11:  Define a copy constructor and an assignment operator for classes
1635 with dynamically allocated memory.
1637 @item
1638 Item 12:  Prefer initialization to assignment in constructors.
1640 @item
1641 Item 14:  Make destructors virtual in base classes.
1643 @item
1644 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1646 @item
1647 Item 23:  Don't try to return a reference when you must return an object.
1649 @end itemize
1651 and about violations of the following style guidelines from Scott Meyers'
1652 @cite{More Effective C++} book:
1654 @itemize @bullet
1655 @item
1656 Item 6:  Distinguish between prefix and postfix forms of increment and
1657 decrement operators.
1659 @item
1660 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1662 @end itemize
1664 If you use this option, you should be aware that the standard library
1665 headers do not obey all of these guidelines; you can use @samp{grep -v}
1666 to filter out those warnings.
1668 @item -Wno-deprecated @r{(C++ only)}
1669 @opindex Wno-deprecated
1670 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1672 @item -Wno-non-template-friend @r{(C++ only)}
1673 @opindex Wno-non-template-friend
1674 Disable warnings when non-templatized friend functions are declared
1675 within a template.  With the advent of explicit template specification
1676 support in G++, if the name of the friend is an unqualified-id (i.e.,
1677 @samp{friend foo(int)}), the C++ language specification demands that the
1678 friend declare or define an ordinary, nontemplate function.  (Section
1679 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1680 could be interpreted as a particular specialization of a templatized
1681 function.  Because this non-conforming behavior is no longer the default
1682 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1683 check existing code for potential trouble spots, and is on by default.
1684 This new compiler behavior can be turned off with
1685 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1686 but disables the helpful warning.
1688 @item -Wold-style-cast @r{(C++ only)}
1689 @opindex Wold-style-cast
1690 Warn if an old-style (C-style) cast to a non-void type is used within
1691 a C++ program.  The new-style casts (@samp{static_cast},
1692 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1693 unintended effects, and much easier to grep for.
1695 @item -Woverloaded-virtual @r{(C++ only)}
1696 @opindex Woverloaded-virtual
1697 @cindex overloaded virtual fn, warning
1698 @cindex warning for overloaded virtual fn
1699 Warn when a function declaration hides virtual functions from a
1700 base class.  For example, in:
1702 @smallexample
1703 struct A @{
1704   virtual void f();
1707 struct B: public A @{
1708   void f(int);
1710 @end smallexample
1712 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1713 like this:
1715 @smallexample
1716 B* b;
1717 b->f();
1718 @end smallexample
1720 will fail to compile.
1722 @item -Wno-pmf-conversions @r{(C++ only)}
1723 @opindex Wno-pmf-conversions
1724 Disable the diagnostic for converting a bound pointer to member function
1725 to a plain pointer.
1727 @item -Wsign-promo @r{(C++ only)}
1728 @opindex Wsign-promo
1729 Warn when overload resolution chooses a promotion from unsigned or
1730 enumeral type to a signed type over a conversion to an unsigned type of
1731 the same size.  Previous versions of G++ would try to preserve
1732 unsignedness, but the standard mandates the current behavior.
1734 @item -Wsynth @r{(C++ only)}
1735 @opindex Wsynth
1736 @cindex warning for synthesized methods
1737 @cindex synthesized methods, warning
1738 Warn when G++'s synthesis behavior does not match that of cfront.  For
1739 instance:
1741 @smallexample
1742 struct A @{
1743   operator int ();
1744   A& operator = (int);
1747 main ()
1749   A a,b;
1750   a = b;
1752 @end smallexample
1754 In this example, G++ will synthesize a default @samp{A& operator =
1755 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1756 @end table
1758 @node Objective-C Dialect Options
1759 @section Options Controlling Objective-C Dialect
1761 @cindex compiler options, Objective-C
1762 @cindex Objective-C options, command line
1763 @cindex options, Objective-C
1764 This section describes the command-line options that are only meaningful
1765 for Objective-C programs; but you can also use most of the GNU compiler
1766 options regardless of what language your program is in.  For example,
1767 you might compile a file @code{some_class.m} like this:
1769 @example
1770 gcc -g -fgnu-runtime -O -c some_class.m
1771 @end example
1773 @noindent
1774 In this example, only @option{-fgnu-runtime} is an option meant only for
1775 Objective-C programs; you can use the other options with any language
1776 supported by GCC@.
1778 Here is a list of options that are @emph{only} for compiling Objective-C
1779 programs:
1781 @table @gcctabopt
1782 @item -fconstant-string-class=@var{class-name}
1783 @opindex fconstant-string-class
1784 Use @var{class-name} as the name of the class to instantiate for each
1785 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1786 class name is @code{NXConstantString}.
1788 @item -fgnu-runtime
1789 @opindex fgnu-runtime
1790 Generate object code compatible with the standard GNU Objective-C
1791 runtime.  This is the default for most types of systems.
1793 @item -fnext-runtime
1794 @opindex fnext-runtime
1795 Generate output compatible with the NeXT runtime.  This is the default
1796 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1797 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1798 used.
1800 @item -gen-decls
1801 @opindex gen-decls
1802 Dump interface declarations for all classes seen in the source file to a
1803 file named @file{@var{sourcename}.decl}.
1805 @item -Wno-protocol
1806 @opindex Wno-protocol
1807 If a class is declared to implement a protocol, a warning is issued for
1808 every method in the protocol that is not implemented by the class.  The
1809 default behavior is to issue a warning for every method not explicitly
1810 implemented in the class, even if a method implementation is inherited
1811 from the superclass.  If you use the @code{-Wno-protocol} option, then
1812 methods inherited from the superclass are considered to be implemented,
1813 and no warning is issued for them.
1815 @item -Wselector
1816 @opindex Wselector
1817 Warn if multiple methods of different types for the same selector are
1818 found during compilation.  The check is performed on the list of methods
1819 in the final stage of compilation.  Additionally, a check is performed
1820 that for each selector appearing in a @code{@@selector(@dots{})}
1821 expression, a corresponding method with that selector has been found
1822 during compilation.  Because these checks scan the method table only at
1823 the end of compilation, these warnings are not produced if the final
1824 stage of compilation is not reached, for example because an error is
1825 found during compilation, or because the @code{-fsyntax-only} option is
1826 being used.
1828 @item -Wundeclared-selector
1829 @opindex Wundeclared-selector
1830 Warn if a @code{@@selector(@dots{})} expression referring to an
1831 undeclared selector is found.  A selector is considered undeclared if no
1832 method with that name has been declared (explicitly, in an
1833 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1834 an @code{@@implementation} section) before the
1835 @code{@@selector(@dots{})} expression.  This option always performs its
1836 checks as soon as a @code{@@selector(@dots{})} expression is found
1837 (while @code{-Wselector} only performs its checks in the final stage of
1838 compilation), and so additionally enforces the coding style convention
1839 that methods and selectors must be declared before being used.
1841 @c not documented because only avail via -Wp
1842 @c @item -print-objc-runtime-info
1844 @end table
1846 @node Language Independent Options
1847 @section Options to Control Diagnostic Messages Formatting
1848 @cindex options to control diagnostics formatting
1849 @cindex diagnostic messages
1850 @cindex message formatting
1852 Traditionally, diagnostic messages have been formatted irrespective of
1853 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1854 below can be used to control the diagnostic messages formatting
1855 algorithm, e.g.@: how many characters per line, how often source location
1856 information should be reported.  Right now, only the C++ front end can
1857 honor these options.  However it is expected, in the near future, that
1858 the remaining front ends would be able to digest them correctly.
1860 @table @gcctabopt
1861 @item -fmessage-length=@var{n}
1862 @opindex fmessage-length
1863 Try to format error messages so that they fit on lines of about @var{n}
1864 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1865 the front ends supported by GCC@.  If @var{n} is zero, then no
1866 line-wrapping will be done; each error message will appear on a single
1867 line.
1869 @opindex fdiagnostics-show-location
1870 @item -fdiagnostics-show-location=once
1871 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1872 reporter to emit @emph{once} source location information; that is, in
1873 case the message is too long to fit on a single physical line and has to
1874 be wrapped, the source location won't be emitted (as prefix) again,
1875 over and over, in subsequent continuation lines.  This is the default
1876 behavior.
1878 @item -fdiagnostics-show-location=every-line
1879 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1880 messages reporter to emit the same source location information (as
1881 prefix) for physical lines that result from the process of breaking
1882 a message which is too long to fit on a single line.
1884 @end table
1886 @node Warning Options
1887 @section Options to Request or Suppress Warnings
1888 @cindex options to control warnings
1889 @cindex warning messages
1890 @cindex messages, warning
1891 @cindex suppressing warnings
1893 Warnings are diagnostic messages that report constructions which
1894 are not inherently erroneous but which are risky or suggest there
1895 may have been an error.
1897 You can request many specific warnings with options beginning @samp{-W},
1898 for example @option{-Wimplicit} to request warnings on implicit
1899 declarations.  Each of these specific warning options also has a
1900 negative form beginning @samp{-Wno-} to turn off warnings;
1901 for example, @option{-Wno-implicit}.  This manual lists only one of the
1902 two forms, whichever is not the default.
1904 The following options control the amount and kinds of warnings produced
1905 by GCC; for further, language-specific options also refer to
1906 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1908 @table @gcctabopt
1909 @cindex syntax checking
1910 @item -fsyntax-only
1911 @opindex fsyntax-only
1912 Check the code for syntax errors, but don't do anything beyond that.
1914 @item -pedantic
1915 @opindex pedantic
1916 Issue all the warnings demanded by strict ISO C and ISO C++;
1917 reject all programs that use forbidden extensions, and some other
1918 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1919 version of the ISO C standard specified by any @option{-std} option used.
1921 Valid ISO C and ISO C++ programs should compile properly with or without
1922 this option (though a rare few will require @option{-ansi} or a
1923 @option{-std} option specifying the required version of ISO C)@.  However,
1924 without this option, certain GNU extensions and traditional C and C++
1925 features are supported as well.  With this option, they are rejected.
1927 @option{-pedantic} does not cause warning messages for use of the
1928 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1929 warnings are also disabled in the expression that follows
1930 @code{__extension__}.  However, only system header files should use
1931 these escape routes; application programs should avoid them.
1932 @xref{Alternate Keywords}.
1934 Some users try to use @option{-pedantic} to check programs for strict ISO
1935 C conformance.  They soon find that it does not do quite what they want:
1936 it finds some non-ISO practices, but not all---only those for which
1937 ISO C @emph{requires} a diagnostic, and some others for which
1938 diagnostics have been added.
1940 A feature to report any failure to conform to ISO C might be useful in
1941 some instances, but would require considerable additional work and would
1942 be quite different from @option{-pedantic}.  We don't have plans to
1943 support such a feature in the near future.
1945 Where the standard specified with @option{-std} represents a GNU
1946 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1947 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1948 extended dialect is based.  Warnings from @option{-pedantic} are given
1949 where they are required by the base standard.  (It would not make sense
1950 for such warnings to be given only for features not in the specified GNU
1951 C dialect, since by definition the GNU dialects of C include all
1952 features the compiler supports with the given option, and there would be
1953 nothing to warn about.)
1955 @item -pedantic-errors
1956 @opindex pedantic-errors
1957 Like @option{-pedantic}, except that errors are produced rather than
1958 warnings.
1960 @item -w
1961 @opindex w
1962 Inhibit all warning messages.
1964 @item -Wno-import
1965 @opindex Wno-import
1966 Inhibit warning messages about the use of @samp{#import}.
1968 @item -Wchar-subscripts
1969 @opindex Wchar-subscripts
1970 Warn if an array subscript has type @code{char}.  This is a common cause
1971 of error, as programmers often forget that this type is signed on some
1972 machines.
1974 @item -Wcomment
1975 @opindex Wcomment
1976 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1977 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1979 @item -Wformat
1980 @opindex Wformat
1981 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1982 the arguments supplied have types appropriate to the format string
1983 specified, and that the conversions specified in the format string make
1984 sense.  This includes standard functions, and others specified by format
1985 attributes (@pxref{Function Attributes}), in the @code{printf},
1986 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1987 not in the C standard) families.
1989 The formats are checked against the format features supported by GNU
1990 libc version 2.2.  These include all ISO C90 and C99 features, as well
1991 as features from the Single Unix Specification and some BSD and GNU
1992 extensions.  Other library implementations may not support all these
1993 features; GCC does not support warning about features that go beyond a
1994 particular library's limitations.  However, if @option{-pedantic} is used
1995 with @option{-Wformat}, warnings will be given about format features not
1996 in the selected standard version (but not for @code{strfmon} formats,
1997 since those are not in any version of the C standard).  @xref{C Dialect
1998 Options,,Options Controlling C Dialect}.
2000 Since @option{-Wformat} also checks for null format arguments for
2001 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2003 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2004 aspects of format checking, the options @option{-Wno-format-y2k},
2005 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2006 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2007 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2009 @item -Wno-format-y2k
2010 @opindex Wno-format-y2k
2011 If @option{-Wformat} is specified, do not warn about @code{strftime}
2012 formats which may yield only a two-digit year.
2014 @item -Wno-format-extra-args
2015 @opindex Wno-format-extra-args
2016 If @option{-Wformat} is specified, do not warn about excess arguments to a
2017 @code{printf} or @code{scanf} format function.  The C standard specifies
2018 that such arguments are ignored.
2020 Where the unused arguments lie between used arguments that are
2021 specified with @samp{$} operand number specifications, normally
2022 warnings are still given, since the implementation could not know what
2023 type to pass to @code{va_arg} to skip the unused arguments.  However,
2024 in the case of @code{scanf} formats, this option will suppress the
2025 warning if the unused arguments are all pointers, since the Single
2026 Unix Specification says that such unused arguments are allowed.
2028 @item -Wno-format-zero-length
2029 @opindex Wno-format-zero-length
2030 If @option{-Wformat} is specified, do not warn about zero-length formats.
2031 The C standard specifies that zero-length formats are allowed.
2033 @item -Wformat-nonliteral
2034 @opindex Wformat-nonliteral
2035 If @option{-Wformat} is specified, also warn if the format string is not a
2036 string literal and so cannot be checked, unless the format function
2037 takes its format arguments as a @code{va_list}.
2039 @item -Wformat-security
2040 @opindex Wformat-security
2041 If @option{-Wformat} is specified, also warn about uses of format
2042 functions that represent possible security problems.  At present, this
2043 warns about calls to @code{printf} and @code{scanf} functions where the
2044 format string is not a string literal and there are no format arguments,
2045 as in @code{printf (foo);}.  This may be a security hole if the format
2046 string came from untrusted input and contains @samp{%n}.  (This is
2047 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2048 in future warnings may be added to @option{-Wformat-security} that are not
2049 included in @option{-Wformat-nonliteral}.)
2051 @item -Wformat=2
2052 @opindex Wformat=2
2053 Enable @option{-Wformat} plus format checks not included in
2054 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2055 -Wformat-nonliteral -Wformat-security}.
2057 @item -Wnonnull
2058 @opindex Wnonnull
2059 Enable warning about passing a null pointer for arguments marked as
2060 requiring a non-null value by the @code{nonnull} function attribute.
2062 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2063 can be disabled with the @option{-Wno-nonnull} option.
2065 @item -Wimplicit-int
2066 @opindex Wimplicit-int
2067 Warn when a declaration does not specify a type.
2069 @item -Wimplicit-function-declaration
2070 @itemx -Werror-implicit-function-declaration
2071 @opindex Wimplicit-function-declaration
2072 @opindex Werror-implicit-function-declaration
2073 Give a warning (or error) whenever a function is used before being
2074 declared.
2076 @item -Wimplicit
2077 @opindex Wimplicit
2078 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2080 @item -Wmain
2081 @opindex Wmain
2082 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2083 function with external linkage, returning int, taking either zero
2084 arguments, two, or three arguments of appropriate types.
2086 @item -Wmissing-braces
2087 @opindex Wmissing-braces
2088 Warn if an aggregate or union initializer is not fully bracketed.  In
2089 the following example, the initializer for @samp{a} is not fully
2090 bracketed, but that for @samp{b} is fully bracketed.
2092 @smallexample
2093 int a[2][2] = @{ 0, 1, 2, 3 @};
2094 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2095 @end smallexample
2097 @item -Wparentheses
2098 @opindex Wparentheses
2099 Warn if parentheses are omitted in certain contexts, such
2100 as when there is an assignment in a context where a truth value
2101 is expected, or when operators are nested whose precedence people
2102 often get confused about.
2104 Also warn about constructions where there may be confusion to which
2105 @code{if} statement an @code{else} branch belongs.  Here is an example of
2106 such a case:
2108 @smallexample
2109 @group
2111   if (a)
2112     if (b)
2113       foo ();
2114   else
2115     bar ();
2117 @end group
2118 @end smallexample
2120 In C, every @code{else} branch belongs to the innermost possible @code{if}
2121 statement, which in this example is @code{if (b)}.  This is often not
2122 what the programmer expected, as illustrated in the above example by
2123 indentation the programmer chose.  When there is the potential for this
2124 confusion, GCC will issue a warning when this flag is specified.
2125 To eliminate the warning, add explicit braces around the innermost
2126 @code{if} statement so there is no way the @code{else} could belong to
2127 the enclosing @code{if}.  The resulting code would look like this:
2129 @smallexample
2130 @group
2132   if (a)
2133     @{
2134       if (b)
2135         foo ();
2136       else
2137         bar ();
2138     @}
2140 @end group
2141 @end smallexample
2143 @item -Wsequence-point
2144 @opindex Wsequence-point
2145 Warn about code that may have undefined semantics because of violations
2146 of sequence point rules in the C standard.
2148 The C standard defines the order in which expressions in a C program are
2149 evaluated in terms of @dfn{sequence points}, which represent a partial
2150 ordering between the execution of parts of the program: those executed
2151 before the sequence point, and those executed after it.  These occur
2152 after the evaluation of a full expression (one which is not part of a
2153 larger expression), after the evaluation of the first operand of a
2154 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2155 function is called (but after the evaluation of its arguments and the
2156 expression denoting the called function), and in certain other places.
2157 Other than as expressed by the sequence point rules, the order of
2158 evaluation of subexpressions of an expression is not specified.  All
2159 these rules describe only a partial order rather than a total order,
2160 since, for example, if two functions are called within one expression
2161 with no sequence point between them, the order in which the functions
2162 are called is not specified.  However, the standards committee have
2163 ruled that function calls do not overlap.
2165 It is not specified when between sequence points modifications to the
2166 values of objects take effect.  Programs whose behavior depends on this
2167 have undefined behavior; the C standard specifies that ``Between the
2168 previous and next sequence point an object shall have its stored value
2169 modified at most once by the evaluation of an expression.  Furthermore,
2170 the prior value shall be read only to determine the value to be
2171 stored.''.  If a program breaks these rules, the results on any
2172 particular implementation are entirely unpredictable.
2174 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2175 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2176 diagnosed by this option, and it may give an occasional false positive
2177 result, but in general it has been found fairly effective at detecting
2178 this sort of problem in programs.
2180 The present implementation of this option only works for C programs.  A
2181 future implementation may also work for C++ programs.
2183 The C standard is worded confusingly, therefore there is some debate
2184 over the precise meaning of the sequence point rules in subtle cases.
2185 Links to discussions of the problem, including proposed formal
2186 definitions, may be found on our readings page, at
2187 @w{@uref{http://gcc.gnu.org/readings.html}}.
2189 @item -Wreturn-type
2190 @opindex Wreturn-type
2191 Warn whenever a function is defined with a return-type that defaults to
2192 @code{int}.  Also warn about any @code{return} statement with no
2193 return-value in a function whose return-type is not @code{void}.
2195 For C++, a function without return type always produces a diagnostic
2196 message, even when @option{-Wno-return-type} is specified.  The only
2197 exceptions are @samp{main} and functions defined in system headers.
2199 @item -Wswitch
2200 @opindex Wswitch
2201 Warn whenever a @code{switch} statement has an index of enumeral type
2202 and lacks a @code{case} for one or more of the named codes of that
2203 enumeration.  (The presence of a @code{default} label prevents this
2204 warning.)  @code{case} labels outside the enumeration range also
2205 provoke warnings when this option is used.
2207 @item -Wswitch-default
2208 @opindex Wswitch-switch
2209 Warn whenever a @code{switch} statement does not have a @code{default}
2210 case.
2212 @item -Wswitch-enum
2213 @opindex Wswitch-enum
2214 Warn whenever a @code{switch} statement has an index of enumeral type
2215 and lacks a @code{case} for one or more of the named codes of that
2216 enumeration.  @code{case} labels outside the enumeration range also
2217 provoke warnings when this option is used.
2219 @item -Wtrigraphs
2220 @opindex Wtrigraphs
2221 Warn if any trigraphs are encountered that might change the meaning of
2222 the program (trigraphs within comments are not warned about).
2224 @item -Wunused-function
2225 @opindex Wunused-function
2226 Warn whenever a static function is declared but not defined or a
2227 non\-inline static function is unused.
2229 @item -Wunused-label
2230 @opindex Wunused-label
2231 Warn whenever a label is declared but not used.
2233 To suppress this warning use the @samp{unused} attribute
2234 (@pxref{Variable Attributes}).
2236 @item -Wunused-parameter
2237 @opindex Wunused-parameter
2238 Warn whenever a function parameter is unused aside from its declaration.
2240 To suppress this warning use the @samp{unused} attribute
2241 (@pxref{Variable Attributes}).
2243 @item -Wunused-variable
2244 @opindex Wunused-variable
2245 Warn whenever a local variable or non-constant static variable is unused
2246 aside from its declaration
2248 To suppress this warning use the @samp{unused} attribute
2249 (@pxref{Variable Attributes}).
2251 @item -Wunused-value
2252 @opindex Wunused-value
2253 Warn whenever a statement computes a result that is explicitly not used.
2255 To suppress this warning cast the expression to @samp{void}.
2257 @item -Wunused
2258 @opindex Wunused
2259 All the above @option{-Wunused} options combined.
2261 In order to get a warning about an unused function parameter, you must
2262 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2263 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2265 @item -Wuninitialized
2266 @opindex Wuninitialized
2267 Warn if an automatic variable is used without first being initialized or
2268 if a variable may be clobbered by a @code{setjmp} call.
2270 These warnings are possible only in optimizing compilation,
2271 because they require data flow information that is computed only
2272 when optimizing.  If you don't specify @option{-O}, you simply won't
2273 get these warnings.
2275 These warnings occur only for variables that are candidates for
2276 register allocation.  Therefore, they do not occur for a variable that
2277 is declared @code{volatile}, or whose address is taken, or whose size
2278 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2279 structures, unions or arrays, even when they are in registers.
2281 Note that there may be no warning about a variable that is used only
2282 to compute a value that itself is never used, because such
2283 computations may be deleted by data flow analysis before the warnings
2284 are printed.
2286 These warnings are made optional because GCC is not smart
2287 enough to see all the reasons why the code might be correct
2288 despite appearing to have an error.  Here is one example of how
2289 this can happen:
2291 @smallexample
2292 @group
2294   int x;
2295   switch (y)
2296     @{
2297     case 1: x = 1;
2298       break;
2299     case 2: x = 4;
2300       break;
2301     case 3: x = 5;
2302     @}
2303   foo (x);
2305 @end group
2306 @end smallexample
2308 @noindent
2309 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2310 always initialized, but GCC doesn't know this.  Here is
2311 another common case:
2313 @smallexample
2315   int save_y;
2316   if (change_y) save_y = y, y = new_y;
2317   @dots{}
2318   if (change_y) y = save_y;
2320 @end smallexample
2322 @noindent
2323 This has no bug because @code{save_y} is used only if it is set.
2325 @cindex @code{longjmp} warnings
2326 This option also warns when a non-volatile automatic variable might be
2327 changed by a call to @code{longjmp}.  These warnings as well are possible
2328 only in optimizing compilation.
2330 The compiler sees only the calls to @code{setjmp}.  It cannot know
2331 where @code{longjmp} will be called; in fact, a signal handler could
2332 call it at any point in the code.  As a result, you may get a warning
2333 even when there is in fact no problem because @code{longjmp} cannot
2334 in fact be called at the place which would cause a problem.
2336 Some spurious warnings can be avoided if you declare all the functions
2337 you use that never return as @code{noreturn}.  @xref{Function
2338 Attributes}.
2340 @item -Wunknown-pragmas
2341 @opindex Wunknown-pragmas
2342 @cindex warning for unknown pragmas
2343 @cindex unknown pragmas, warning
2344 @cindex pragmas, warning of unknown
2345 Warn when a #pragma directive is encountered which is not understood by
2346 GCC@.  If this command line option is used, warnings will even be issued
2347 for unknown pragmas in system header files.  This is not the case if
2348 the warnings were only enabled by the @option{-Wall} command line option.
2350 @item -Wstrict-aliasing
2351 @opindex Wstrict-aliasing
2352 This option is only active when @option{-fstrict-aliasing} is active.
2353 It warns about code which might break the strict aliasing rules that the
2354 compiler is using for optimization. The warning does not catch all
2355 cases, but does attempt to catch the more common pitfalls. It is
2356 included in @option{-Wall}.
2358 @item -Wall
2359 @opindex Wall
2360 All of the above @samp{-W} options combined.  This enables all the
2361 warnings about constructions that some users consider questionable, and
2362 that are easy to avoid (or modify to prevent the warning), even in
2363 conjunction with macros.  This also enables some language-specific
2364 warnings described in @ref{C++ Dialect Options} and
2365 @ref{Objective-C Dialect Options}.
2366 @end table
2368 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2369 Some of them warn about constructions that users generally do not
2370 consider questionable, but which occasionally you might wish to check
2371 for; others warn about constructions that are necessary or hard to avoid
2372 in some cases, and there is no simple way to modify the code to suppress
2373 the warning.
2375 @table @gcctabopt
2376 @item -Wextra
2377 @opindex W
2378 @opindex Wextra
2379 (This option used to be called @option{-W}.  The older name is still
2380 supported, but the newer name is more descriptive.)  Print extra warning
2381 messages for these events:
2383 @itemize @bullet
2384 @item
2385 A function can return either with or without a value.  (Falling
2386 off the end of the function body is considered returning without
2387 a value.)  For example, this function would evoke such a
2388 warning:
2390 @smallexample
2391 @group
2392 foo (a)
2394   if (a > 0)
2395     return a;
2397 @end group
2398 @end smallexample
2400 @item
2401 An expression-statement or the left-hand side of a comma expression
2402 contains no side effects.
2403 To suppress the warning, cast the unused expression to void.
2404 For example, an expression such as @samp{x[i,j]} will cause a warning,
2405 but @samp{x[(void)i,j]} will not.
2407 @item
2408 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2410 @item
2411 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2412 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2413 that of ordinary mathematical notation.
2415 @item
2416 Storage-class specifiers like @code{static} are not the first things in
2417 a declaration.  According to the C Standard, this usage is obsolescent.
2419 @item
2420 The return type of a function has a type qualifier such as @code{const}.
2421 Such a type qualifier has no effect, since the value returned by a
2422 function is not an lvalue.  (But don't warn about the GNU extension of
2423 @code{volatile void} return types.  That extension will be warned about
2424 if @option{-pedantic} is specified.)
2426 @item
2427 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2428 arguments.
2430 @item
2431 A comparison between signed and unsigned values could produce an
2432 incorrect result when the signed value is converted to unsigned.
2433 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2435 @item
2436 An aggregate has an initializer which does not initialize all members.
2437 For example, the following code would cause such a warning, because
2438 @code{x.h} would be implicitly initialized to zero:
2440 @smallexample
2441 struct s @{ int f, g, h; @};
2442 struct s x = @{ 3, 4 @};
2443 @end smallexample
2445 @item
2446 A function parameter is declared without a type specifier in K&R-style
2447 functions:
2449 @smallexample
2450 void foo(bar) @{ @}
2451 @end smallexample
2453 @item
2454 An empty body occurs in an @samp{if} or @samp{else} statement.
2456 @item
2457 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2458 @samp{>}, or @samp{>=}.
2460 @item
2461 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2463 @item
2464 Any of several floating-point events that often indicate errors, such as
2465 overflow, underflow, loss of precision, etc.
2467 @item @r{(C++ only)}
2468 An enumerator and a non-enumerator both appear in a conditional expression.
2470 @item @r{(C++ only)}
2471 A non-static reference or non-static @samp{const} member appears in a
2472 class without constructors.
2474 @item @r{(C++ only)}
2475 Ambiguous virtual bases.
2477 @item @r{(C++ only)}
2478 Subscripting an array which has been declared @samp{register}.
2480 @item @r{(C++ only)}
2481 Taking the address of a variable which has been declared @samp{register}.
2483 @item @r{(C++ only)}
2484 A base class is not initialized in a derived class' copy constructor.
2485 @end itemize
2487 @item -Wno-div-by-zero
2488 @opindex Wno-div-by-zero
2489 @opindex Wdiv-by-zero
2490 Do not warn about compile-time integer division by zero.  Floating point
2491 division by zero is not warned about, as it can be a legitimate way of
2492 obtaining infinities and NaNs.
2494 @item -Wsystem-headers
2495 @opindex Wsystem-headers
2496 @cindex warnings from system headers
2497 @cindex system headers, warnings from
2498 Print warning messages for constructs found in system header files.
2499 Warnings from system headers are normally suppressed, on the assumption
2500 that they usually do not indicate real problems and would only make the
2501 compiler output harder to read.  Using this command line option tells
2502 GCC to emit warnings from system headers as if they occurred in user
2503 code.  However, note that using @option{-Wall} in conjunction with this
2504 option will @emph{not} warn about unknown pragmas in system
2505 headers---for that, @option{-Wunknown-pragmas} must also be used.
2507 @item -Wfloat-equal
2508 @opindex Wfloat-equal
2509 Warn if floating point values are used in equality comparisons.
2511 The idea behind this is that sometimes it is convenient (for the
2512 programmer) to consider floating-point values as approximations to
2513 infinitely precise real numbers.  If you are doing this, then you need
2514 to compute (by analyzing the code, or in some other way) the maximum or
2515 likely maximum error that the computation introduces, and allow for it
2516 when performing comparisons (and when producing output, but that's a
2517 different problem).  In particular, instead of testing for equality, you
2518 would check to see whether the two values have ranges that overlap; and
2519 this is done with the relational operators, so equality comparisons are
2520 probably mistaken.
2522 @item -Wtraditional @r{(C only)}
2523 @opindex Wtraditional
2524 Warn about certain constructs that behave differently in traditional and
2525 ISO C@.  Also warn about ISO C constructs that have no traditional C
2526 equivalent, and/or problematic constructs which should be avoided.
2528 @itemize @bullet
2529 @item
2530 Macro parameters that appear within string literals in the macro body.
2531 In traditional C macro replacement takes place within string literals,
2532 but does not in ISO C@.
2534 @item
2535 In traditional C, some preprocessor directives did not exist.
2536 Traditional preprocessors would only consider a line to be a directive
2537 if the @samp{#} appeared in column 1 on the line.  Therefore
2538 @option{-Wtraditional} warns about directives that traditional C
2539 understands but would ignore because the @samp{#} does not appear as the
2540 first character on the line.  It also suggests you hide directives like
2541 @samp{#pragma} not understood by traditional C by indenting them.  Some
2542 traditional implementations would not recognize @samp{#elif}, so it
2543 suggests avoiding it altogether.
2545 @item
2546 A function-like macro that appears without arguments.
2548 @item
2549 The unary plus operator.
2551 @item
2552 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2553 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2554 constants.)  Note, these suffixes appear in macros defined in the system
2555 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2556 Use of these macros in user code might normally lead to spurious
2557 warnings, however gcc's integrated preprocessor has enough context to
2558 avoid warning in these cases.
2560 @item
2561 A function declared external in one block and then used after the end of
2562 the block.
2564 @item
2565 A @code{switch} statement has an operand of type @code{long}.
2567 @item
2568 A non-@code{static} function declaration follows a @code{static} one.
2569 This construct is not accepted by some traditional C compilers.
2571 @item
2572 The ISO type of an integer constant has a different width or
2573 signedness from its traditional type.  This warning is only issued if
2574 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2575 typically represent bit patterns, are not warned about.
2577 @item
2578 Usage of ISO string concatenation is detected.
2580 @item
2581 Initialization of automatic aggregates.
2583 @item
2584 Identifier conflicts with labels.  Traditional C lacks a separate
2585 namespace for labels.
2587 @item
2588 Initialization of unions.  If the initializer is zero, the warning is
2589 omitted.  This is done under the assumption that the zero initializer in
2590 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2591 initializer warnings and relies on default initialization to zero in the
2592 traditional C case.
2594 @item
2595 Conversions by prototypes between fixed/floating point values and vice
2596 versa.  The absence of these prototypes when compiling with traditional
2597 C would cause serious problems.  This is a subset of the possible
2598 conversion warnings, for the full set use @option{-Wconversion}.
2600 @item
2601 Use of ISO C style function definitions.  This warning intentionally is
2602 @emph{not} issued for prototype declarations or variadic functions
2603 because these ISO C features will appear in your code when using
2604 libiberty's traditional C compatibility macros, @code{PARAMS} and
2605 @code{VPARAMS}.  This warning is also bypassed for nested functions
2606 because that feature is already a gcc extension and thus not relevant to
2607 traditional C compatibility.
2608 @end itemize
2610 @item -Wundef
2611 @opindex Wundef
2612 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2614 @item -Wendif-labels
2615 @opindex Wendif-labels
2616 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2618 @item -Wshadow
2619 @opindex Wshadow
2620 Warn whenever a local variable shadows another local variable, parameter or
2621 global variable or whenever a built-in function is shadowed.
2623 @item -Wlarger-than-@var{len}
2624 @opindex Wlarger-than
2625 Warn whenever an object of larger than @var{len} bytes is defined.
2627 @item -Wpointer-arith
2628 @opindex Wpointer-arith
2629 Warn about anything that depends on the ``size of'' a function type or
2630 of @code{void}.  GNU C assigns these types a size of 1, for
2631 convenience in calculations with @code{void *} pointers and pointers
2632 to functions.
2634 @item -Wbad-function-cast @r{(C only)}
2635 @opindex Wbad-function-cast
2636 Warn whenever a function call is cast to a non-matching type.
2637 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2639 @item -Wcast-qual
2640 @opindex Wcast-qual
2641 Warn whenever a pointer is cast so as to remove a type qualifier from
2642 the target type.  For example, warn if a @code{const char *} is cast
2643 to an ordinary @code{char *}.
2645 @item -Wcast-align
2646 @opindex Wcast-align
2647 Warn whenever a pointer is cast such that the required alignment of the
2648 target is increased.  For example, warn if a @code{char *} is cast to
2649 an @code{int *} on machines where integers can only be accessed at
2650 two- or four-byte boundaries.
2652 @item -Wwrite-strings
2653 @opindex Wwrite-strings
2654 When compiling C, give string constants the type @code{const
2655 char[@var{length}]} so that
2656 copying the address of one into a non-@code{const} @code{char *}
2657 pointer will get a warning; when compiling C++, warn about the
2658 deprecated conversion from string constants to @code{char *}.
2659 These warnings will help you find at
2660 compile time code that can try to write into a string constant, but
2661 only if you have been very careful about using @code{const} in
2662 declarations and prototypes.  Otherwise, it will just be a nuisance;
2663 this is why we did not make @option{-Wall} request these warnings.
2665 @item -Wconversion
2666 @opindex Wconversion
2667 Warn if a prototype causes a type conversion that is different from what
2668 would happen to the same argument in the absence of a prototype.  This
2669 includes conversions of fixed point to floating and vice versa, and
2670 conversions changing the width or signedness of a fixed point argument
2671 except when the same as the default promotion.
2673 Also, warn if a negative integer constant expression is implicitly
2674 converted to an unsigned type.  For example, warn about the assignment
2675 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2676 casts like @code{(unsigned) -1}.
2678 @item -Wsign-compare
2679 @opindex Wsign-compare
2680 @cindex warning for comparison of signed and unsigned values
2681 @cindex comparison of signed and unsigned values, warning
2682 @cindex signed and unsigned values, comparison warning
2683 Warn when a comparison between signed and unsigned values could produce
2684 an incorrect result when the signed value is converted to unsigned.
2685 This warning is also enabled by @option{-Wextra}; to get the other warnings
2686 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2688 @item -Waggregate-return
2689 @opindex Waggregate-return
2690 Warn if any functions that return structures or unions are defined or
2691 called.  (In languages where you can return an array, this also elicits
2692 a warning.)
2694 @item -Wstrict-prototypes @r{(C only)}
2695 @opindex Wstrict-prototypes
2696 Warn if a function is declared or defined without specifying the
2697 argument types.  (An old-style function definition is permitted without
2698 a warning if preceded by a declaration which specifies the argument
2699 types.)
2701 @item -Wmissing-prototypes @r{(C only)}
2702 @opindex Wmissing-prototypes
2703 Warn if a global function is defined without a previous prototype
2704 declaration.  This warning is issued even if the definition itself
2705 provides a prototype.  The aim is to detect global functions that fail
2706 to be declared in header files.
2708 @item -Wmissing-declarations @r{(C only)}
2709 @opindex Wmissing-declarations
2710 Warn if a global function is defined without a previous declaration.
2711 Do so even if the definition itself provides a prototype.
2712 Use this option to detect global functions that are not declared in
2713 header files.
2715 @item -Wmissing-noreturn
2716 @opindex Wmissing-noreturn
2717 Warn about functions which might be candidates for attribute @code{noreturn}.
2718 Note these are only possible candidates, not absolute ones.  Care should
2719 be taken to manually verify functions actually do not ever return before
2720 adding the @code{noreturn} attribute, otherwise subtle code generation
2721 bugs could be introduced.  You will not get a warning for @code{main} in
2722 hosted C environments.
2724 @item -Wmissing-format-attribute
2725 @opindex Wmissing-format-attribute
2726 @opindex Wformat
2727 If @option{-Wformat} is enabled, also warn about functions which might be
2728 candidates for @code{format} attributes.  Note these are only possible
2729 candidates, not absolute ones.  GCC will guess that @code{format}
2730 attributes might be appropriate for any function that calls a function
2731 like @code{vprintf} or @code{vscanf}, but this might not always be the
2732 case, and some functions for which @code{format} attributes are
2733 appropriate may not be detected.  This option has no effect unless
2734 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2736 @item -Wno-multichar
2737 @opindex Wno-multichar
2738 @opindex Wmultichar
2739 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2740 Usually they indicate a typo in the user's code, as they have
2741 implementation-defined values, and should not be used in portable code.
2743 @item -Wno-deprecated-declarations
2744 @opindex Wno-deprecated-declarations
2745 Do not warn about uses of functions, variables, and types marked as
2746 deprecated by using the @code{deprecated} attribute.
2747 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2748 @pxref{Type Attributes}.)
2750 @item -Wpacked
2751 @opindex Wpacked
2752 Warn if a structure is given the packed attribute, but the packed
2753 attribute has no effect on the layout or size of the structure.
2754 Such structures may be mis-aligned for little benefit.  For
2755 instance, in this code, the variable @code{f.x} in @code{struct bar}
2756 will be misaligned even though @code{struct bar} does not itself
2757 have the packed attribute:
2759 @smallexample
2760 @group
2761 struct foo @{
2762   int x;
2763   char a, b, c, d;
2764 @} __attribute__((packed));
2765 struct bar @{
2766   char z;
2767   struct foo f;
2769 @end group
2770 @end smallexample
2772 @item -Wpadded
2773 @opindex Wpadded
2774 Warn if padding is included in a structure, either to align an element
2775 of the structure or to align the whole structure.  Sometimes when this
2776 happens it is possible to rearrange the fields of the structure to
2777 reduce the padding and so make the structure smaller.
2779 @item -Wredundant-decls
2780 @opindex Wredundant-decls
2781 Warn if anything is declared more than once in the same scope, even in
2782 cases where multiple declaration is valid and changes nothing.
2784 @item -Wnested-externs @r{(C only)}
2785 @opindex Wnested-externs
2786 Warn if an @code{extern} declaration is encountered within a function.
2788 @item -Wunreachable-code
2789 @opindex Wunreachable-code
2790 Warn if the compiler detects that code will never be executed.
2792 This option is intended to warn when the compiler detects that at
2793 least a whole line of source code will never be executed, because
2794 some condition is never satisfied or because it is after a
2795 procedure that never returns.
2797 It is possible for this option to produce a warning even though there
2798 are circumstances under which part of the affected line can be executed,
2799 so care should be taken when removing apparently-unreachable code.
2801 For instance, when a function is inlined, a warning may mean that the
2802 line is unreachable in only one inlined copy of the function.
2804 This option is not made part of @option{-Wall} because in a debugging
2805 version of a program there is often substantial code which checks
2806 correct functioning of the program and is, hopefully, unreachable
2807 because the program does work.  Another common use of unreachable
2808 code is to provide behavior which is selectable at compile-time.
2810 @item -Winline
2811 @opindex Winline
2812 Warn if a function can not be inlined and it was declared as inline.
2814 @item -Wno-invalid-offsetof @r{(C++ only)}
2815 @opindex Wno-invalid-offsetof
2816 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2817 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2818 to a non-POD type is undefined.  In existing C++ implementations,
2819 however, @samp{offsetof} typically gives meaningful results even when
2820 applied to certain kinds of non-POD types. (Such as a simple
2821 @samp{struct} that fails to be a POD type only by virtue of having a
2822 constructor.)  This flag is for users who are aware that they are
2823 writing nonportable code and who have deliberately chosen to ignore the
2824 warning about it.
2826 The restrictions on @samp{offsetof} may be relaxed in a future version
2827 of the C++ standard.
2829 @item -Winvalid-pch
2830 @opindex Winvalid-pch
2831 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2832 the search path but can't be used.
2834 @item -Wlong-long
2835 @opindex Wlong-long
2836 @opindex Wno-long-long
2837 Warn if @samp{long long} type is used.  This is default.  To inhibit
2838 the warning messages, use @option{-Wno-long-long}.  Flags
2839 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2840 only when @option{-pedantic} flag is used.
2842 @item -Wdisabled-optimization
2843 @opindex Wdisabled-optimization
2844 Warn if a requested optimization pass is disabled.  This warning does
2845 not generally indicate that there is anything wrong with your code; it
2846 merely indicates that GCC's optimizers were unable to handle the code
2847 effectively.  Often, the problem is that your code is too big or too
2848 complex; GCC will refuse to optimize programs when the optimization
2849 itself is likely to take inordinate amounts of time.
2851 @item -Werror
2852 @opindex Werror
2853 Make all warnings into errors.
2854 @end table
2856 @node Debugging Options
2857 @section Options for Debugging Your Program or GCC
2858 @cindex options, debugging
2859 @cindex debugging information options
2861 GCC has various special options that are used for debugging
2862 either your program or GCC:
2864 @table @gcctabopt
2865 @item -g
2866 @opindex g
2867 Produce debugging information in the operating system's native format
2868 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2869 information.
2871 On most systems that use stabs format, @option{-g} enables use of extra
2872 debugging information that only GDB can use; this extra information
2873 makes debugging work better in GDB but will probably make other debuggers
2874 crash or
2875 refuse to read the program.  If you want to control for certain whether
2876 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2877 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2878 or @option{-gvms} (see below).
2880 Unlike most other C compilers, GCC allows you to use @option{-g} with
2881 @option{-O}.  The shortcuts taken by optimized code may occasionally
2882 produce surprising results: some variables you declared may not exist
2883 at all; flow of control may briefly move where you did not expect it;
2884 some statements may not be executed because they compute constant
2885 results or their values were already at hand; some statements may
2886 execute in different places because they were moved out of loops.
2888 Nevertheless it proves possible to debug optimized output.  This makes
2889 it reasonable to use the optimizer for programs that might have bugs.
2891 The following options are useful when GCC is generated with the
2892 capability for more than one debugging format.
2894 @item -ggdb
2895 @opindex ggdb
2896 Produce debugging information for use by GDB@.  This means to use the
2897 most expressive format available (DWARF 2, stabs, or the native format
2898 if neither of those are supported), including GDB extensions if at all
2899 possible.
2901 @item -gstabs
2902 @opindex gstabs
2903 Produce debugging information in stabs format (if that is supported),
2904 without GDB extensions.  This is the format used by DBX on most BSD
2905 systems.  On MIPS, Alpha and System V Release 4 systems this option
2906 produces stabs debugging output which is not understood by DBX or SDB@.
2907 On System V Release 4 systems this option requires the GNU assembler.
2909 @item -gstabs+
2910 @opindex gstabs+
2911 Produce debugging information in stabs format (if that is supported),
2912 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2913 use of these extensions is likely to make other debuggers crash or
2914 refuse to read the program.
2916 @item -gcoff
2917 @opindex gcoff
2918 Produce debugging information in COFF format (if that is supported).
2919 This is the format used by SDB on most System V systems prior to
2920 System V Release 4.
2922 @item -gxcoff
2923 @opindex gxcoff
2924 Produce debugging information in XCOFF format (if that is supported).
2925 This is the format used by the DBX debugger on IBM RS/6000 systems.
2927 @item -gxcoff+
2928 @opindex gxcoff+
2929 Produce debugging information in XCOFF format (if that is supported),
2930 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2931 use of these extensions is likely to make other debuggers crash or
2932 refuse to read the program, and may cause assemblers other than the GNU
2933 assembler (GAS) to fail with an error.
2935 @item -gdwarf
2936 @opindex gdwarf
2937 Produce debugging information in DWARF version 1 format (if that is
2938 supported).  This is the format used by SDB on most System V Release 4
2939 systems.
2941 This option is deprecated.
2943 @item -gdwarf+
2944 @opindex gdwarf+
2945 Produce debugging information in DWARF version 1 format (if that is
2946 supported), using GNU extensions understood only by the GNU debugger
2947 (GDB)@.  The use of these extensions is likely to make other debuggers
2948 crash or refuse to read the program.
2950 This option is deprecated.
2952 @item -gdwarf-2
2953 @opindex gdwarf-2
2954 Produce debugging information in DWARF version 2 format (if that is
2955 supported).  This is the format used by DBX on IRIX 6.
2957 @item -gvms
2958 @opindex gvms
2959 Produce debugging information in VMS debug format (if that is
2960 supported).  This is the format used by DEBUG on VMS systems.
2962 @item -g@var{level}
2963 @itemx -ggdb@var{level}
2964 @itemx -gstabs@var{level}
2965 @itemx -gcoff@var{level}
2966 @itemx -gxcoff@var{level}
2967 @itemx -gvms@var{level}
2968 Request debugging information and also use @var{level} to specify how
2969 much information.  The default level is 2.
2971 Level 1 produces minimal information, enough for making backtraces in
2972 parts of the program that you don't plan to debug.  This includes
2973 descriptions of functions and external variables, but no information
2974 about local variables and no line numbers.
2976 Level 3 includes extra information, such as all the macro definitions
2977 present in the program.  Some debuggers support macro expansion when
2978 you use @option{-g3}.
2980 Note that in order to avoid confusion between DWARF1 debug level 2,
2981 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2982 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2983 option to change the debug level for DWARF1 or DWARF2.
2985 @item -feliminate-dwarf2-dups
2986 @opindex feliminate-dwarf2-dups
2987 Compress DWARF2 debugging information by eliminating duplicated
2988 information about each symbol.  This option only makes sense when
2989 generating DWARF2 debugging information with @option{-gdwarf-2}.
2991 @cindex @command{prof}
2992 @item -p
2993 @opindex p
2994 Generate extra code to write profile information suitable for the
2995 analysis program @command{prof}.  You must use this option when compiling
2996 the source files you want data about, and you must also use it when
2997 linking.
2999 @cindex @command{gprof}
3000 @item -pg
3001 @opindex pg
3002 Generate extra code to write profile information suitable for the
3003 analysis program @command{gprof}.  You must use this option when compiling
3004 the source files you want data about, and you must also use it when
3005 linking.
3007 @item -Q
3008 @opindex Q
3009 Makes the compiler print out each function name as it is compiled, and
3010 print some statistics about each pass when it finishes.
3012 @item -ftime-report
3013 @opindex ftime-report
3014 Makes the compiler print some statistics about the time consumed by each
3015 pass when it finishes.
3017 @item -fmem-report
3018 @opindex fmem-report
3019 Makes the compiler print some statistics about permanent memory
3020 allocation when it finishes.
3022 @item -fprofile-arcs
3023 @opindex fprofile-arcs
3024 Add code so that program flow @dfn{arcs} are instrumented.  During
3025 execution the program records how many times each branch and call is
3026 executed and how many times it is taken or returns.  When the compiled
3027 program exits it saves this data to a file called
3028 @file{@var{auxname}.da} for each source file. The data may be used for
3029 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3030 test coverage analysis (@option{-ftest-coverage}). Each object file's
3031 @var{auxname} is generated from the name of the output file, if
3032 explicitly specified and it is not the final executable, otherwise it is
3033 the basename of the source file. In both cases any suffix is removed
3034 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3035 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3037 @itemize
3039 @item
3040 Compile the source files with @option{-fprofile-arcs} plus optimization
3041 and code generation options. For test coverage analysis, use the
3042 additional @option{-ftest-coverage} option. You do not need to profile
3043 every source file in a program.
3045 @item
3046 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3047 (the latter implies the former).
3049 @item
3050 Run the program on a representative workload to generate the arc profile
3051 information. This may be repeated any number of times. You can run
3052 concurrent instances of your program, and provided that the file system
3053 supports locking, the data files will be correctly updated. Also
3054 @code{fork} calls are detected and correctly handled (double counting
3055 will not happen).
3057 @item
3058 For profile-directed optimizations, compile the source files again with
3059 the same optimization and code generation options plus
3060 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3061 Control Optimization}).
3063 @item
3064 For test coverage analysis, use @command{gcov} to produce human readable
3065 information from the @file{.bbg} and @file{.da} files. Refer to the
3066 @command{gcov} documentation for further information.
3068 @end itemize
3070 With @option{-fprofile-arcs}, for each function of your program GCC
3071 creates a program flow graph, then finds a spanning tree for the graph.
3072 Only arcs that are not on the spanning tree have to be instrumented: the
3073 compiler adds code to count the number of times that these arcs are
3074 executed.  When an arc is the only exit or only entrance to a block, the
3075 instrumentation code can be added to the block; otherwise, a new basic
3076 block must be created to hold the instrumentation code.
3078 @need 2000
3079 @item -ftest-coverage
3080 @opindex ftest-coverage
3081 Produce a graph file that the @command{gcov} code-coverage utility
3082 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3083 show program coverage. Each source file's data file is called
3084 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3085 above for a description of @var{auxname} and instructions on how to
3086 generate test coverage data. Coverage data will match the source files
3087 more closely, if you do not optimize.
3089 @item -d@var{letters}
3090 @opindex d
3091 Says to make debugging dumps during compilation at times specified by
3092 @var{letters}.  This is used for debugging the compiler.  The file names
3093 for most of the dumps are made by appending a pass number and a word to
3094 the @var{dumpname}. @var{dumpname} is generated from the name of the
3095 output file, if explicitly specified and it is not an executable,
3096 otherwise it is the basename of the source file. In both cases any
3097 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3098 Here are the possible letters for use in @var{letters}, and their
3099 meanings:
3101 @table @samp
3102 @item A
3103 @opindex dA
3104 Annotate the assembler output with miscellaneous debugging information.
3105 @item b
3106 @opindex db
3107 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3108 @item B
3109 @opindex dB
3110 Dump after block reordering, to @file{@var{file}.32.bbro}.
3111 @item c
3112 @opindex dc
3113 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3114 @item C
3115 @opindex dC
3116 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3117 @item d
3118 @opindex dd
3119 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3120 @item D
3121 @opindex dD
3122 Dump all macro definitions, at the end of preprocessing, in addition to
3123 normal output.
3124 @item e
3125 @opindex de
3126 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3127 @file{@var{file}.07.ussa}.
3128 @item E
3129 @opindex dE
3130 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3131 @item f
3132 @opindex df
3133 Dump after life analysis, to @file{@var{file}.18.life}.
3134 @item F
3135 @opindex dF
3136 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3137 @item g
3138 @opindex dg
3139 Dump after global register allocation, to @file{@var{file}.24.greg}.
3140 @item h
3141 @opindex dh
3142 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3143 @item k
3144 @opindex dk
3145 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3146 @item o
3147 @opindex do
3148 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3149 @item G
3150 @opindex dG
3151 Dump after GCSE, to @file{@var{file}.11.gcse}.
3152 @item i
3153 @opindex di
3154 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3155 @item j
3156 @opindex dj
3157 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3158 @item k
3159 @opindex dk
3160 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3161 @item l
3162 @opindex dl
3163 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3164 @item L
3165 @opindex dL
3166 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3167 @file{@var{file}.18.loop2}.
3168 @item M
3169 @opindex dM
3170 Dump after performing the machine dependent reorganization pass, to
3171 @file{@var{file}.33.mach}.
3172 @item n
3173 @opindex dn
3174 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3175 @item N
3176 @opindex dN
3177 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3178 @item r
3179 @opindex dr
3180 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3181 @item R
3182 @opindex dR
3183 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3184 @item s
3185 @opindex ds
3186 Dump after CSE (including the jump optimization that sometimes follows
3187 CSE), to @file{@var{file}.09.cse}.
3188 @item S
3189 @opindex dS
3190 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3191 @item t
3192 @opindex dt
3193 Dump after the second CSE pass (including the jump optimization that
3194 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3195 @item u
3196 @opindex du
3197 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3198 @item w
3199 @opindex dw
3200 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3201 @item X
3202 @opindex dX
3203 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3204 @item z
3205 @opindex dz
3206 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3207 @item a
3208 @opindex da
3209 Produce all the dumps listed above.
3210 @item H
3211 @opindex dH
3212 Produce a core dump whenever an error occurs.
3213 @item m
3214 @opindex dm
3215 Print statistics on memory usage, at the end of the run, to
3216 standard error.
3217 @item p
3218 @opindex dp
3219 Annotate the assembler output with a comment indicating which
3220 pattern and alternative was used.  The length of each instruction is
3221 also printed.
3222 @item P
3223 @opindex dP
3224 Dump the RTL in the assembler output as a comment before each instruction.
3225 Also turns on @option{-dp} annotation.
3226 @item v
3227 @opindex dv
3228 For each of the other indicated dump files (except for
3229 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3230 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3231 @item x
3232 @opindex dx
3233 Just generate RTL for a function instead of compiling it.  Usually used
3234 with @samp{r}.
3235 @item y
3236 @opindex dy
3237 Dump debugging information during parsing, to standard error.
3238 @end table
3240 @item -fdump-unnumbered
3241 @opindex fdump-unnumbered
3242 When doing debugging dumps (see @option{-d} option above), suppress instruction
3243 numbers and line number note output.  This makes it more feasible to
3244 use diff on debugging dumps for compiler invocations with different
3245 options, in particular with and without @option{-g}.
3247 @item -fdump-translation-unit @r{(C and C++ only)}
3248 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3249 @opindex fdump-translation-unit
3250 Dump a representation of the tree structure for the entire translation
3251 unit to a file.  The file name is made by appending @file{.tu} to the
3252 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3253 controls the details of the dump as described for the
3254 @option{-fdump-tree} options.
3256 @item -fdump-class-hierarchy @r{(C++ only)}
3257 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3258 @opindex fdump-class-hierarchy
3259 Dump a representation of each class's hierarchy and virtual function
3260 table layout to a file.  The file name is made by appending @file{.class}
3261 to the source file name.  If the @samp{-@var{options}} form is used,
3262 @var{options} controls the details of the dump as described for the
3263 @option{-fdump-tree} options.
3265 @item -fdump-tree-@var{switch} @r{(C++ only)}
3266 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3267 @opindex fdump-tree
3268 Control the dumping at various stages of processing the intermediate
3269 language tree to a file.  The file name is generated by appending a switch
3270 specific suffix to the source file name.  If the @samp{-@var{options}}
3271 form is used, @var{options} is a list of @samp{-} separated options that
3272 control the details of the dump. Not all options are applicable to all
3273 dumps, those which are not meaningful will be ignored. The following
3274 options are available
3276 @table @samp
3277 @item address
3278 Print the address of each node.  Usually this is not meaningful as it
3279 changes according to the environment and source file. Its primary use
3280 is for tying up a dump file with a debug environment.
3281 @item slim
3282 Inhibit dumping of members of a scope or body of a function merely
3283 because that scope has been reached. Only dump such items when they
3284 are directly reachable by some other path.
3285 @item all
3286 Turn on all options.
3287 @end table
3289 The following tree dumps are possible:
3290 @table @samp
3291 @item original
3292 Dump before any tree based optimization, to @file{@var{file}.original}.
3293 @item optimized
3294 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3295 @item inlined
3296 Dump after function inlining, to @file{@var{file}.inlined}.
3297 @end table
3299 @item -frandom-seed=@var{string}
3300 @opindex frandom-string
3301 This option provides a seed that GCC uses when it would otherwise use
3302 random numbers.  At present, this is used to generate certain symbol names
3303 that have to be different in every compiled file.
3305 The @var{string} should be different for every file you compile.
3307 @item -fsched-verbose=@var{n}
3308 @opindex fsched-verbose
3309 On targets that use instruction scheduling, this option controls the
3310 amount of debugging output the scheduler prints.  This information is
3311 written to standard error, unless @option{-dS} or @option{-dR} is
3312 specified, in which case it is output to the usual dump
3313 listing file, @file{.sched} or @file{.sched2} respectively.  However
3314 for @var{n} greater than nine, the output is always printed to standard
3315 error.
3317 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3318 same information as @option{-dRS}.  For @var{n} greater than one, it
3319 also output basic block probabilities, detailed ready list information
3320 and unit/insn info.  For @var{n} greater than two, it includes RTL
3321 at abort point, control-flow and regions info.  And for @var{n} over
3322 four, @option{-fsched-verbose} also includes dependence info.
3324 @item -save-temps
3325 @opindex save-temps
3326 Store the usual ``temporary'' intermediate files permanently; place them
3327 in the current directory and name them based on the source file.  Thus,
3328 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3329 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3330 preprocessed @file{foo.i} output file even though the compiler now
3331 normally uses an integrated preprocessor.
3333 @item -time
3334 @opindex time
3335 Report the CPU time taken by each subprocess in the compilation
3336 sequence.  For C source files, this is the compiler proper and assembler
3337 (plus the linker if linking is done).  The output looks like this:
3339 @smallexample
3340 # cc1 0.12 0.01
3341 # as 0.00 0.01
3342 @end smallexample
3344 The first number on each line is the ``user time,'' that is time spent
3345 executing the program itself.  The second number is ``system time,''
3346 time spent executing operating system routines on behalf of the program.
3347 Both numbers are in seconds.
3349 @item -print-file-name=@var{library}
3350 @opindex print-file-name
3351 Print the full absolute name of the library file @var{library} that
3352 would be used when linking---and don't do anything else.  With this
3353 option, GCC does not compile or link anything; it just prints the
3354 file name.
3356 @item -print-multi-directory
3357 @opindex print-multi-directory
3358 Print the directory name corresponding to the multilib selected by any
3359 other switches present in the command line.  This directory is supposed
3360 to exist in @env{GCC_EXEC_PREFIX}.
3362 @item -print-multi-lib
3363 @opindex print-multi-lib
3364 Print the mapping from multilib directory names to compiler switches
3365 that enable them.  The directory name is separated from the switches by
3366 @samp{;}, and each switch starts with an @samp{@@} instead of the
3367 @samp{-}, without spaces between multiple switches.  This is supposed to
3368 ease shell-processing.
3370 @item -print-prog-name=@var{program}
3371 @opindex print-prog-name
3372 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3374 @item -print-libgcc-file-name
3375 @opindex print-libgcc-file-name
3376 Same as @option{-print-file-name=libgcc.a}.
3378 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3379 but you do want to link with @file{libgcc.a}.  You can do
3381 @example
3382 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3383 @end example
3385 @item -print-search-dirs
3386 @opindex print-search-dirs
3387 Print the name of the configured installation directory and a list of
3388 program and library directories gcc will search---and don't do anything else.
3390 This is useful when gcc prints the error message
3391 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3392 To resolve this you either need to put @file{cpp0} and the other compiler
3393 components where gcc expects to find them, or you can set the environment
3394 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3395 Don't forget the trailing '/'.
3396 @xref{Environment Variables}.
3398 @item -dumpmachine
3399 @opindex dumpmachine
3400 Print the compiler's target machine (for example,
3401 @samp{i686-pc-linux-gnu})---and don't do anything else.
3403 @item -dumpversion
3404 @opindex dumpversion
3405 Print the compiler version (for example, @samp{3.0})---and don't do
3406 anything else.
3408 @item -dumpspecs
3409 @opindex dumpspecs
3410 Print the compiler's built-in specs---and don't do anything else.  (This
3411 is used when GCC itself is being built.)  @xref{Spec Files}.
3413 @item -feliminate-unused-debug-types
3414 @opindex feliminate-unused-debug-types
3415 Normally, when producing DWARF2 output, GCC will emit debugging
3416 information for all types declared in a compilation
3417 unit, regardless of whether or not they are actually used
3418 in that compilation unit.  Sometimes this is useful, such as
3419 if, in the debugger, you want to cast a value to a type that is
3420 not actually used in your program (but is declared).  More often,
3421 however, this results in a significant amount of wasted space.
3422 With this option, GCC will avoid producing debug symbol output
3423 for types that are nowhere used in the source file being compiled.
3424 @end table
3426 @node Optimize Options
3427 @section Options That Control Optimization
3428 @cindex optimize options
3429 @cindex options, optimization
3431 These options control various sorts of optimizations.
3433 Without any optimization option, the compiler's goal is to reduce the
3434 cost of compilation and to make debugging produce the expected
3435 results.  Statements are independent: if you stop the program with a
3436 breakpoint between statements, you can then assign a new value to any
3437 variable or change the program counter to any other statement in the
3438 function and get exactly the results you would expect from the source
3439 code.
3441 Turning on optimization flags makes the compiler attempt to improve
3442 the performance and/or code size at the expense of compilation time
3443 and possibly the ability to debug the program.
3445 Not all optimizations are controlled directly by a flag.  Only
3446 optimizations that have a flag are listed.
3448 @table @gcctabopt
3449 @item -O
3450 @itemx -O1
3451 @opindex O
3452 @opindex O1
3453 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3454 more memory for a large function.
3456 With @option{-O}, the compiler tries to reduce code size and execution
3457 time, without performing any optimizations that take a great deal of
3458 compilation time.
3460 @option{-O} turns on the following optimization flags: 
3461 @gccoptlist{-fdefer-pop @gol
3462 -fmerge-constants @gol
3463 -fthread-jumps @gol
3464 -floop-optimize @gol
3465 -fcrossjumping @gol
3466 -fif-conversion @gol
3467 -fif-conversion2 @gol
3468 -fdelayed-branch @gol
3469 -fguess-branch-probability @gol
3470 -fcprop-registers}
3472 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3473 where doing so does not interfere with debugging.
3475 @item -O2
3476 @opindex O2
3477 Optimize even more.  GCC performs nearly all supported optimizations
3478 that do not involve a space-speed tradeoff.  The compiler does not
3479 perform loop unrolling or function inlining when you specify @option{-O2}.
3480 As compared to @option{-O}, this option increases both compilation time
3481 and the performance of the generated code.
3483 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3484 also turns on the following optimization flags:
3485 @gccoptlist{-fforce-mem @gol
3486 -foptimize-sibling-calls @gol
3487 -fstrength-reduce @gol
3488 -fcse-follow-jumps  -fcse-skip-blocks @gol
3489 -frerun-cse-after-loop  -frerun-loop-opt @gol
3490 -fgcse   -fgcse-lm   -fgcse-sm @gol
3491 -fdelete-null-pointer-checks @gol
3492 -fexpensive-optimizations @gol
3493 -fregmove @gol
3494 -fschedule-insns  -fschedule-insns2 @gol
3495 -fsched-interblock  -fsched-spec @gol
3496 -fcaller-saves @gol
3497 -fpeephole2 @gol
3498 -freorder-blocks  -freorder-functions @gol
3499 -fstrict-aliasing @gol
3500 -falign-functions  -falign-jumps @gol
3501 -falign-loops  -falign-labels}
3503 Please note the warning under @option{-fgcse} about
3504 invoking @option{-O2} on programs that use computed gotos.
3506 @item -O3
3507 @opindex O3
3508 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3509 @option{-O2} and also turns on the @option{-finline-functions},
3510 @option{-funit-at-a-time} and @option{-frename-registers} options.
3512 @item -O0
3513 @opindex O0
3514 Do not optimize.  This is the default.
3516 @item -Os
3517 @opindex Os
3518 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3519 do not typically increase code size.  It also performs further
3520 optimizations designed to reduce code size.
3522 @option{-Os} disables the following optimization flags:
3523 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3524 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3526 If you use multiple @option{-O} options, with or without level numbers,
3527 the last such option is the one that is effective.
3528 @end table
3530 Options of the form @option{-f@var{flag}} specify machine-independent
3531 flags.  Most flags have both positive and negative forms; the negative
3532 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3533 below, only one of the forms is listed---the one you typically will
3534 use.  You can figure out the other form by either removing @samp{no-}
3535 or adding it.
3537 The following options control specific optimizations.  They are either
3538 activated by @option{-O} options or are related to ones that are.  You
3539 can use the following flags in the rare cases when ``fine-tuning'' of
3540 optimizations to be performed is desired.
3542 @table @gcctabopt
3543 @item -fno-default-inline
3544 @opindex fno-default-inline
3545 Do not make member functions inline by default merely because they are
3546 defined inside the class scope (C++ only).  Otherwise, when you specify
3547 @w{@option{-O}}, member functions defined inside class scope are compiled
3548 inline by default; i.e., you don't need to add @samp{inline} in front of
3549 the member function name.
3551 @item -fno-defer-pop
3552 @opindex fno-defer-pop
3553 Always pop the arguments to each function call as soon as that function
3554 returns.  For machines which must pop arguments after a function call,
3555 the compiler normally lets arguments accumulate on the stack for several
3556 function calls and pops them all at once.
3558 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3560 @item -fforce-mem
3561 @opindex fforce-mem
3562 Force memory operands to be copied into registers before doing
3563 arithmetic on them.  This produces better code by making all memory
3564 references potential common subexpressions.  When they are not common
3565 subexpressions, instruction combination should eliminate the separate
3566 register-load.
3568 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3570 @item -fforce-addr
3571 @opindex fforce-addr
3572 Force memory address constants to be copied into registers before
3573 doing arithmetic on them.  This may produce better code just as
3574 @option{-fforce-mem} may.
3576 @item -fomit-frame-pointer
3577 @opindex fomit-frame-pointer
3578 Don't keep the frame pointer in a register for functions that
3579 don't need one.  This avoids the instructions to save, set up and
3580 restore frame pointers; it also makes an extra register available
3581 in many functions.  @strong{It also makes debugging impossible on
3582 some machines.}
3584 On some machines, such as the VAX, this flag has no effect, because
3585 the standard calling sequence automatically handles the frame pointer
3586 and nothing is saved by pretending it doesn't exist.  The
3587 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3588 whether a target machine supports this flag.  @xref{Registers,,Register
3589 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3591 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3593 @item -foptimize-sibling-calls
3594 @opindex foptimize-sibling-calls
3595 Optimize sibling and tail recursive calls.
3597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3599 @item -fno-inline
3600 @opindex fno-inline
3601 Don't pay attention to the @code{inline} keyword.  Normally this option
3602 is used to keep the compiler from expanding any functions inline.
3603 Note that if you are not optimizing, no functions can be expanded inline.
3605 @item -finline-functions
3606 @opindex finline-functions
3607 Integrate all simple functions into their callers.  The compiler
3608 heuristically decides which functions are simple enough to be worth
3609 integrating in this way.
3611 If all calls to a given function are integrated, and the function is
3612 declared @code{static}, then the function is normally not output as
3613 assembler code in its own right.
3615 Enabled at level @option{-O3}.
3617 @item -finline-limit=@var{n}
3618 @opindex finline-limit
3619 By default, gcc limits the size of functions that can be inlined.  This flag
3620 allows the control of this limit for functions that are explicitly marked as
3621 inline (i.e., marked with the inline keyword or defined within the class
3622 definition in c++).  @var{n} is the size of functions that can be inlined in
3623 number of pseudo instructions (not counting parameter handling).  The default
3624 value of @var{n} is 600.
3625 Increasing this value can result in more inlined code at
3626 the cost of compilation time and memory consumption.  Decreasing usually makes
3627 the compilation faster and less code will be inlined (which presumably
3628 means slower programs).  This option is particularly useful for programs that
3629 use inlining heavily such as those based on recursive templates with C++.
3631 Inlining is actually controlled by a number of parameters, which may be
3632 specified individually by using @option{--param @var{name}=@var{value}}.
3633 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3634 as follows:
3636 @table @gcctabopt
3637  @item max-inline-insns
3638   is set to @var{n}.
3639  @item max-inline-insns-single
3640   is set to @var{n}/2.
3641  @item max-inline-insns-auto
3642   is set to @var{n}/2.
3643  @item min-inline-insns
3644   is set to 130 or @var{n}/4, whichever is smaller.
3645  @item max-inline-insns-rtl
3646   is set to @var{n}.
3647 @end table
3649 Using @option{-finline-limit=600} thus results in the default settings
3650 for these parameters.  See below for a documentation of the individual
3651 parameters controlling inlining.
3653 @emph{Note:} pseudo instruction represents, in this particular context, an
3654 abstract measurement of function's size.  In no way, it represents a count
3655 of assembly instructions and as such its exact meaning might change from one
3656 release to an another.
3658 @item -fkeep-inline-functions
3659 @opindex fkeep-inline-functions
3660 Even if all calls to a given function are integrated, and the function
3661 is declared @code{static}, nevertheless output a separate run-time
3662 callable version of the function.  This switch does not affect
3663 @code{extern inline} functions.
3665 @item -fkeep-static-consts
3666 @opindex fkeep-static-consts
3667 Emit variables declared @code{static const} when optimization isn't turned
3668 on, even if the variables aren't referenced.
3670 GCC enables this option by default.  If you want to force the compiler to
3671 check if the variable was referenced, regardless of whether or not
3672 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3674 @item -fmerge-constants
3675 Attempt to merge identical constants (string constants and floating point
3676 constants) across compilation units.
3678 This option is the default for optimized compilation if the assembler and
3679 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3680 behavior.
3682 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3684 @item -fmerge-all-constants
3685 Attempt to merge identical constants and identical variables.
3687 This option implies @option{-fmerge-constants}.  In addition to
3688 @option{-fmerge-constants} this considers e.g. even constant initialized
3689 arrays or initialized constant variables with integral or floating point
3690 types.  Languages like C or C++ require each non-automatic variable to
3691 have distinct location, so using this option will result in non-conforming
3692 behavior.
3694 @item -fnew-ra
3695 @opindex fnew-ra
3696 Use a graph coloring register allocator.  Currently this option is meant
3697 for testing, so we are interested to hear about miscompilations with
3698 @option{-fnew-ra}.
3700 @item -fno-branch-count-reg
3701 @opindex fno-branch-count-reg
3702 Do not use ``decrement and branch'' instructions on a count register,
3703 but instead generate a sequence of instructions that decrement a
3704 register, compare it against zero, then branch based upon the result.
3705 This option is only meaningful on architectures that support such
3706 instructions, which include x86, PowerPC, IA-64 and S/390.
3708 The default is @option{-fbranch-count-reg}, enabled when
3709 @option{-fstrength-reduce} is enabled.
3711 @item -fno-function-cse
3712 @opindex fno-function-cse
3713 Do not put function addresses in registers; make each instruction that
3714 calls a constant function contain the function's address explicitly.
3716 This option results in less efficient code, but some strange hacks
3717 that alter the assembler output may be confused by the optimizations
3718 performed when this option is not used.
3720 The default is @option{-ffunction-cse}
3722 @item -fno-zero-initialized-in-bss
3723 @opindex fno-zero-initialized-in-bss
3724 If the target supports a BSS section, GCC by default puts variables that
3725 are initialized to zero into BSS@.  This can save space in the resulting
3726 code.
3728 This option turns off this behavior because some programs explicitly
3729 rely on variables going to the data section.  E.g., so that the
3730 resulting executable can find the beginning of that section and/or make
3731 assumptions based on that.
3733 The default is @option{-fzero-initialized-in-bss}.
3735 @item -fstrength-reduce
3736 @opindex fstrength-reduce
3737 Perform the optimizations of loop strength reduction and
3738 elimination of iteration variables.
3740 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3742 @item -fthread-jumps
3743 @opindex fthread-jumps
3744 Perform optimizations where we check to see if a jump branches to a
3745 location where another comparison subsumed by the first is found.  If
3746 so, the first branch is redirected to either the destination of the
3747 second branch or a point immediately following it, depending on whether
3748 the condition is known to be true or false.
3750 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3752 @item -fcse-follow-jumps
3753 @opindex fcse-follow-jumps
3754 In common subexpression elimination, scan through jump instructions
3755 when the target of the jump is not reached by any other path.  For
3756 example, when CSE encounters an @code{if} statement with an
3757 @code{else} clause, CSE will follow the jump when the condition
3758 tested is false.
3760 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3762 @item -fcse-skip-blocks
3763 @opindex fcse-skip-blocks
3764 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3765 follow jumps which conditionally skip over blocks.  When CSE
3766 encounters a simple @code{if} statement with no else clause,
3767 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3768 body of the @code{if}.
3770 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3772 @item -frerun-cse-after-loop
3773 @opindex frerun-cse-after-loop
3774 Re-run common subexpression elimination after loop optimizations has been
3775 performed.
3777 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3779 @item -frerun-loop-opt
3780 @opindex frerun-loop-opt
3781 Run the loop optimizer twice.
3783 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3785 @item -fgcse
3786 @opindex fgcse
3787 Perform a global common subexpression elimination pass.
3788 This pass also performs global constant and copy propagation.
3790 @emph{Note:} When compiling a program using computed gotos, a GCC
3791 extension, you may get better runtime performance if you disable
3792 the global common subexpression elimination pass by adding
3793 @option{-fno-gcse} to the command line.
3795 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3797 @item -fgcse-lm
3798 @opindex fgcse-lm
3799 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3800 attempt to move loads which are only killed by stores into themselves.  This
3801 allows a loop containing a load/store sequence to be changed to a load outside
3802 the loop, and a copy/store within the loop.
3804 Enabled by default when gcse is enabled.
3806 @item -fgcse-sm
3807 @opindex fgcse-sm
3808 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3809 subexpression elimination.  This pass will attempt to move stores out of loops.
3810 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3811 can be changed to a load before the loop and a store after the loop.
3813 Enabled by default when gcse is enabled.
3815 @item -floop-optimize
3816 @opindex floop-optimize
3817 Perform loop optimizations: move constant expressions out of loops, simplify
3818 exit test conditions and optionally do strength-reduction and loop unrolling as
3819 well.
3821 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3823 @item -fcrossjumping
3824 @opindex crossjumping
3825 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3826 resulting code may or may not perform better than without cross-jumping.
3828 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3830 @item -fif-conversion
3831 @opindex if-conversion
3832 Attempt to transform conditional jumps into branch-less equivalents.  This
3833 include use of conditional moves, min, max, set flags and abs instructions, and
3834 some tricks doable by standard arithmetics.  The use of conditional execution
3835 on chips where it is available is controlled by @code{if-conversion2}.
3837 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3839 @item -fif-conversion2
3840 @opindex if-conversion2
3841 Use conditional execution (where available) to transform conditional jumps into
3842 branch-less equivalents.
3844 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3846 @item -fdelete-null-pointer-checks
3847 @opindex fdelete-null-pointer-checks
3848 Use global dataflow analysis to identify and eliminate useless checks
3849 for null pointers.  The compiler assumes that dereferencing a null
3850 pointer would have halted the program.  If a pointer is checked after
3851 it has already been dereferenced, it cannot be null.
3853 In some environments, this assumption is not true, and programs can
3854 safely dereference null pointers.  Use
3855 @option{-fno-delete-null-pointer-checks} to disable this optimization
3856 for programs which depend on that behavior.
3858 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3860 @item -fexpensive-optimizations
3861 @opindex fexpensive-optimizations
3862 Perform a number of minor optimizations that are relatively expensive.
3864 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3866 @item -foptimize-register-move
3867 @itemx -fregmove
3868 @opindex foptimize-register-move
3869 @opindex fregmove
3870 Attempt to reassign register numbers in move instructions and as
3871 operands of other simple instructions in order to maximize the amount of
3872 register tying.  This is especially helpful on machines with two-operand
3873 instructions.
3875 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3876 optimization.
3878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3880 @item -fdelayed-branch
3881 @opindex fdelayed-branch
3882 If supported for the target machine, attempt to reorder instructions
3883 to exploit instruction slots available after delayed branch
3884 instructions.
3886 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3888 @item -fschedule-insns
3889 @opindex fschedule-insns
3890 If supported for the target machine, attempt to reorder instructions to
3891 eliminate execution stalls due to required data being unavailable.  This
3892 helps machines that have slow floating point or memory load instructions
3893 by allowing other instructions to be issued until the result of the load
3894 or floating point instruction is required.
3896 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3898 @item -fschedule-insns2
3899 @opindex fschedule-insns2
3900 Similar to @option{-fschedule-insns}, but requests an additional pass of
3901 instruction scheduling after register allocation has been done.  This is
3902 especially useful on machines with a relatively small number of
3903 registers and where memory load instructions take more than one cycle.
3905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3907 @item -fno-sched-interblock
3908 @opindex fno-sched-interblock
3909 Don't schedule instructions across basic blocks.  This is normally
3910 enabled by default when scheduling before register allocation, i.e.@:
3911 with @option{-fschedule-insns} or at @option{-O2} or higher.
3913 @item -fno-sched-spec
3914 @opindex fno-sched-spec
3915 Don't allow speculative motion of non-load instructions.  This is normally
3916 enabled by default when scheduling before register allocation, i.e.@:
3917 with @option{-fschedule-insns} or at @option{-O2} or higher.
3919 @item -fsched-spec-load
3920 @opindex fsched-spec-load
3921 Allow speculative motion of some load instructions.  This only makes
3922 sense when scheduling before register allocation, i.e.@: with
3923 @option{-fschedule-insns} or at @option{-O2} or higher.
3925 @item -fsched-spec-load-dangerous
3926 @opindex fsched-spec-load-dangerous
3927 Allow speculative motion of more load instructions.  This only makes
3928 sense when scheduling before register allocation, i.e.@: with
3929 @option{-fschedule-insns} or at @option{-O2} or higher.
3931 @item -fsched2-use-superblocks
3932 @opindex fsched2-use-superblocks
3933 When schedulilng after register allocation, do use superblock scheduling
3934 algorithm.  Superblock scheduling allows motion across basic block boundaries
3935 resulting on faster schedules.  This option is experimental, as not all machine
3936 descriptions used by GCC model the CPU closely enough to avoid unreliable
3937 results from the algorithm. 
3939 This only makes sense when scheduling after register allocation, i.e.@: with
3940 @option{-fschedule-insns2} or at @option{-O2} or higher.
3942 @item -fsched2-use-traces
3943 @opindex fsched2-use-traces
3944 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3945 allocation and additionally perform code duplication in order to increase the
3946 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3947 trace formation.
3949 This mode should produce faster but significantly longer programs.  Also
3950 without @code{-fbranch-probabilities} the traces constructed may not match the
3951 reality and hurt the performance.  This only makes
3952 sense when scheduling after register allocation, i.e.@: with
3953 @option{-fschedule-insns2} or at @option{-O2} or higher.
3955 @item -fcaller-saves
3956 @opindex fcaller-saves
3957 Enable values to be allocated in registers that will be clobbered by
3958 function calls, by emitting extra instructions to save and restore the
3959 registers around such calls.  Such allocation is done only when it
3960 seems to result in better code than would otherwise be produced.
3962 This option is always enabled by default on certain machines, usually
3963 those which have no call-preserved registers to use instead.
3965 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3967 @item -fmove-all-movables
3968 @opindex fmove-all-movables
3969 Forces all invariant computations in loops to be moved
3970 outside the loop.
3972 @item -freduce-all-givs
3973 @opindex freduce-all-givs
3974 Forces all general-induction variables in loops to be
3975 strength-reduced.
3977 @emph{Note:} When compiling programs written in Fortran,
3978 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3979 by default when you use the optimizer.
3981 These options may generate better or worse code; results are highly
3982 dependent on the structure of loops within the source code.
3984 These two options are intended to be removed someday, once
3985 they have helped determine the efficacy of various
3986 approaches to improving loop optimizations.
3988 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3989 know how use of these options affects
3990 the performance of your production code.
3991 We're very interested in code that runs @emph{slower}
3992 when these options are @emph{enabled}.
3994 @item -fno-peephole
3995 @itemx -fno-peephole2
3996 @opindex fno-peephole
3997 @opindex fno-peephole2
3998 Disable any machine-specific peephole optimizations.  The difference
3999 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4000 are implemented in the compiler; some targets use one, some use the
4001 other, a few use both.
4003 @option{-fpeephole} is enabled by default.
4004 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4006 @item -fno-guess-branch-probability
4007 @opindex fno-guess-branch-probability
4008 Do not guess branch probabilities using a randomized model.
4010 Sometimes gcc will opt to use a randomized model to guess branch
4011 probabilities, when none are available from either profiling feedback
4012 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4013 different runs of the compiler on the same program may produce different
4014 object code.
4016 In a hard real-time system, people don't want different runs of the
4017 compiler to produce code that has different behavior; minimizing
4018 non-determinism is of paramount import.  This switch allows users to
4019 reduce non-determinism, possibly at the expense of inferior
4020 optimization.
4022 The default is @option{-fguess-branch-probability} at levels
4023 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4025 @item -freorder-blocks
4026 @opindex freorder-blocks
4027 Reorder basic blocks in the compiled function in order to reduce number of
4028 taken branches and improve code locality.
4030 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4032 @item -freorder-functions
4033 @opindex freorder-functions
4034 Reorder basic blocks in the compiled function in order to reduce number of
4035 taken branches and improve code locality. This is implemented by using special
4036 subsections @code{text.hot} for most frequently executed functions and
4037 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4038 the linker so object file format must support named sections and linker must
4039 place them in a reasonable way.
4041 Also profile feedback must be available in to make this option effective.  See
4042 @option{-fprofile-arcs} for details.
4044 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4046 @item -fstrict-aliasing
4047 @opindex fstrict-aliasing
4048 Allows the compiler to assume the strictest aliasing rules applicable to
4049 the language being compiled.  For C (and C++), this activates
4050 optimizations based on the type of expressions.  In particular, an
4051 object of one type is assumed never to reside at the same address as an
4052 object of a different type, unless the types are almost the same.  For
4053 example, an @code{unsigned int} can alias an @code{int}, but not a
4054 @code{void*} or a @code{double}.  A character type may alias any other
4055 type.
4057 Pay special attention to code like this:
4058 @example
4059 union a_union @{
4060   int i;
4061   double d;
4064 int f() @{
4065   a_union t;
4066   t.d = 3.0;
4067   return t.i;
4069 @end example
4070 The practice of reading from a different union member than the one most
4071 recently written to (called ``type-punning'') is common.  Even with
4072 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4073 is accessed through the union type.  So, the code above will work as
4074 expected.  However, this code might not:
4075 @example
4076 int f() @{
4077   a_union t;
4078   int* ip;
4079   t.d = 3.0;
4080   ip = &t.i;
4081   return *ip;
4083 @end example
4085 Every language that wishes to perform language-specific alias analysis
4086 should define a function that computes, given an @code{tree}
4087 node, an alias set for the node.  Nodes in different alias sets are not
4088 allowed to alias.  For an example, see the C front-end function
4089 @code{c_get_alias_set}.
4091 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4093 @item -falign-functions
4094 @itemx -falign-functions=@var{n}
4095 @opindex falign-functions
4096 Align the start of functions to the next power-of-two greater than
4097 @var{n}, skipping up to @var{n} bytes.  For instance,
4098 @option{-falign-functions=32} aligns functions to the next 32-byte
4099 boundary, but @option{-falign-functions=24} would align to the next
4100 32-byte boundary only if this can be done by skipping 23 bytes or less.
4102 @option{-fno-align-functions} and @option{-falign-functions=1} are
4103 equivalent and mean that functions will not be aligned.
4105 Some assemblers only support this flag when @var{n} is a power of two;
4106 in that case, it is rounded up.
4108 If @var{n} is not specified, use a machine-dependent default.
4110 Enabled at levels @option{-O2}, @option{-O3}.
4112 @item -falign-labels
4113 @itemx -falign-labels=@var{n}
4114 @opindex falign-labels
4115 Align all branch targets to a power-of-two boundary, skipping up to
4116 @var{n} bytes like @option{-falign-functions}.  This option can easily
4117 make code slower, because it must insert dummy operations for when the
4118 branch target is reached in the usual flow of the code.
4120 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4121 are greater than this value, then their values are used instead.
4123 If @var{n} is not specified, use a machine-dependent default which is
4124 very likely to be @samp{1}, meaning no alignment.
4126 Enabled at levels @option{-O2}, @option{-O3}.
4128 @item -falign-loops
4129 @itemx -falign-loops=@var{n}
4130 @opindex falign-loops
4131 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4132 like @option{-falign-functions}.  The hope is that the loop will be
4133 executed many times, which will make up for any execution of the dummy
4134 operations.
4136 If @var{n} is not specified, use a machine-dependent default.
4138 Enabled at levels @option{-O2}, @option{-O3}.
4140 @item -falign-jumps
4141 @itemx -falign-jumps=@var{n}
4142 @opindex falign-jumps
4143 Align branch targets to a power-of-two boundary, for branch targets
4144 where the targets can only be reached by jumping, skipping up to @var{n}
4145 bytes like @option{-falign-functions}.  In this case, no dummy operations
4146 need be executed.
4148 If @var{n} is not specified, use a machine-dependent default.
4150 Enabled at levels @option{-O2}, @option{-O3}.
4152 @item -frename-registers
4153 @opindex frename-registers
4154 Attempt to avoid false dependencies in scheduled code by making use
4155 of registers left over after register allocation.  This optimization
4156 will most benefit processors with lots of registers.  It can, however,
4157 make debugging impossible, since variables will no longer stay in
4158 a ``home register''.
4160 Enabled at levels @option{-O3}.
4162 @item -fno-cprop-registers
4163 @opindex fno-cprop-registers
4164 After register allocation and post-register allocation instruction splitting,
4165 we perform a copy-propagation pass to try to reduce scheduling dependencies
4166 and occasionally eliminate the copy.
4168 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4170 @end table
4172 The following options control compiler behavior regarding floating
4173 point arithmetic.  These options trade off between speed and
4174 correctness.  All must be specifically enabled.
4176 @table @gcctabopt
4177 @item -ffloat-store
4178 @opindex ffloat-store
4179 Do not store floating point variables in registers, and inhibit other
4180 options that might change whether a floating point value is taken from a
4181 register or memory.
4183 @cindex floating point precision
4184 This option prevents undesirable excess precision on machines such as
4185 the 68000 where the floating registers (of the 68881) keep more
4186 precision than a @code{double} is supposed to have.  Similarly for the
4187 x86 architecture.  For most programs, the excess precision does only
4188 good, but a few programs rely on the precise definition of IEEE floating
4189 point.  Use @option{-ffloat-store} for such programs, after modifying
4190 them to store all pertinent intermediate computations into variables.
4192 @item -ffast-math
4193 @opindex ffast-math
4194 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4195 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4196 @option{-fno-signaling-nans}.
4198 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4200 This option should never be turned on by any @option{-O} option since
4201 it can result in incorrect output for programs which depend on
4202 an exact implementation of IEEE or ISO rules/specifications for
4203 math functions.
4205 @item -fno-math-errno
4206 @opindex fno-math-errno
4207 Do not set ERRNO after calling math functions that are executed
4208 with a single instruction, e.g., sqrt.  A program that relies on
4209 IEEE exceptions for math error handling may want to use this flag
4210 for speed while maintaining IEEE arithmetic compatibility.
4212 This option should never be turned on by any @option{-O} option since
4213 it can result in incorrect output for programs which depend on
4214 an exact implementation of IEEE or ISO rules/specifications for
4215 math functions.
4217 The default is @option{-fmath-errno}.
4219 @item -funsafe-math-optimizations
4220 @opindex funsafe-math-optimizations
4221 Allow optimizations for floating-point arithmetic that (a) assume
4222 that arguments and results are valid and (b) may violate IEEE or
4223 ANSI standards.  When used at link-time, it may include libraries
4224 or startup files that change the default FPU control word or other
4225 similar optimizations.
4227 This option should never be turned on by any @option{-O} option since
4228 it can result in incorrect output for programs which depend on
4229 an exact implementation of IEEE or ISO rules/specifications for
4230 math functions.
4232 The default is @option{-fno-unsafe-math-optimizations}.
4234 @item -ffinite-math-only
4235 @opindex ffinite-math-only
4236 Allow optimizations for floating-point arithmetic that assume
4237 that arguments and results are not NaNs or +-Infs.
4239 This option should never be turned on by any @option{-O} option since
4240 it can result in incorrect output for programs which depend on
4241 an exact implementation of IEEE or ISO rules/specifications.
4243 The default is @option{-fno-finite-math-only}.
4245 @item -fno-trapping-math
4246 @opindex fno-trapping-math
4247 Compile code assuming that floating-point operations cannot generate
4248 user-visible traps.  These traps include division by zero, overflow,
4249 underflow, inexact result and invalid operation.  This option implies
4250 @option{-fno-signaling-nans}.  Setting this option may allow faster
4251 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4253 This option should never be turned on by any @option{-O} option since
4254 it can result in incorrect output for programs which depend on
4255 an exact implementation of IEEE or ISO rules/specifications for
4256 math functions.
4258 The default is @option{-ftrapping-math}.
4260 @item -fsignaling-nans
4261 @opindex fsignaling-nans
4262 Compile code assuming that IEEE signaling NaNs may generate user-visible
4263 traps during floating-point operations.  Setting this option disables
4264 optimizations that may change the number of exceptions visible with
4265 signaling NaNs.  This option implies @option{-ftrapping-math}.
4267 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4268 be defined.
4270 The default is @option{-fno-signaling-nans}.
4272 This option is experimental and does not currently guarantee to
4273 disable all GCC optimizations that affect signaling NaN behavior.
4275 @item -fsingle-precision-constant
4276 @opindex fsingle-precision-constant
4277 Treat floating point constant as single precision constant instead of
4278 implicitly converting it to double precision constant.
4281 @end table
4283 The following options control optimizations that may improve
4284 performance, but are not enabled by any @option{-O} options.  This
4285 section includes experimental options that may produce broken code.
4287 @table @gcctabopt
4288 @item -fbranch-probabilities
4289 @opindex fbranch-probabilities
4290 After running a program compiled with @option{-fprofile-arcs}
4291 (@pxref{Debugging Options,, Options for Debugging Your Program or
4292 @command{gcc}}), you can compile it a second time using
4293 @option{-fbranch-probabilities}, to improve optimizations based on
4294 the number of times each branch was taken.  When the program
4295 compiled with @option{-fprofile-arcs} exits it saves arc execution
4296 counts to a file called @file{@var{sourcename}.da} for each source
4297 file  The information in this data file is very dependent on the
4298 structure of the generated code, so you must use the same source code
4299 and the same optimization options for both compilations.
4301 With @option{-fbranch-probabilities}, GCC puts a 
4302 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4303 These can be used to improve optimization.  Currently, they are only
4304 used in one place: in @file{reorg.c}, instead of guessing which path a
4305 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4306 exactly determine which path is taken more often.
4308 @item -fnew-ra
4309 @opindex fnew-ra
4310 Use a graph coloring register allocator.  Currently this option is meant
4311 for testing, so we are interested to hear about miscompilations with
4312 @option{-fnew-ra}.
4314 @item -ftracer
4315 @opindex ftracer
4316 Perform tail duplication to enlarge superblock size. This transformation
4317 simplifies the control flow of the function allowing other optimizations to do
4318 better job.
4320 @item -funit-at-a-time
4321 @opindex funit-at-a-time
4322 Parse the whole compilation unit before starting to produce code.  This allows some
4323 extra optimizations to take place but consumes more memory.
4325 @item -funroll-loops
4326 @opindex funroll-loops
4327 Unroll loops whose number of iterations can be determined at compile time or
4328 upon entry to the loop.  @option{-funroll-loops} implies
4329 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4330 (i.e. complete removal of loops with small constant number of iterations).
4331 This option makes code larger, and may or may not make it run faster.
4333 @item -funroll-all-loops
4334 @opindex funroll-all-loops
4335 Unroll all loops, even if their number of iterations is uncertain when
4336 the loop is entered.  This usually makes programs run more slowly.
4337 @option{-funroll-all-loops} implies the same options as
4338 @option{-funroll-loops}.
4340 @item -fpeel-loops
4341 @opindex fpeel-loops
4342 Peels the loops for that there is enough information that they do not
4343 roll much (from profile feedback).  It also turns on complete loop peeling
4344 (i.e. complete removal of loops with small constant number of iterations).
4346 @item -funswitch-loops
4347 @opindex funswitch-loops
4348 Move branches with loop invariant conditions out of the loop, with duplicates
4349 of the loop on both branches (modified according to result of the condition).
4351 @item -fold-unroll-loops
4352 @opindex fold-unroll-loops
4353 Unroll loops whose number of iterations can be determined at compile
4354 time or upon entry to the loop, using the old loop unroller whose loop
4355 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4356 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4357 option makes code larger, and may or may not make it run faster.
4359 @item -fold-unroll-all-loops
4360 @opindex fold-unroll-all-loops
4361 Unroll all loops, even if their number of iterations is uncertain when
4362 the loop is entered. This is done using the old loop unroller whose loop
4363 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4364 @option{-fold-unroll-all-loops} implies the same options as
4365 @option{-fold-unroll-loops}.
4367 @item -funswitch-loops
4368 @opindex funswitch-loops
4369 Move branches with loop invariant conditions out of the loop, with duplicates
4370 of the loop on both branches (modified according to result of the condition).
4372 @item -funswitch-loops
4373 @opindex funswitch-loops
4374 Move branches with loop invariant conditions out of the loop, with duplicates
4375 of the loop on both branches (modified according to result of the condition).
4377 @item -fprefetch-loop-arrays
4378 @opindex fprefetch-loop-arrays
4379 If supported by the target machine, generate instructions to prefetch
4380 memory to improve the performance of loops that access large arrays.
4382 Disabled at level @option{-Os}.
4384 @item -ffunction-sections
4385 @itemx -fdata-sections
4386 @opindex ffunction-sections
4387 @opindex fdata-sections
4388 Place each function or data item into its own section in the output
4389 file if the target supports arbitrary sections.  The name of the
4390 function or the name of the data item determines the section's name
4391 in the output file.
4393 Use these options on systems where the linker can perform optimizations
4394 to improve locality of reference in the instruction space.  Most systems
4395 using the ELF object format and SPARC processors running Solaris 2 have
4396 linkers with such optimizations.  AIX may have these optimizations in
4397 the future.
4399 Only use these options when there are significant benefits from doing
4400 so.  When you specify these options, the assembler and linker will
4401 create larger object and executable files and will also be slower.
4402 You will not be able to use @code{gprof} on all systems if you
4403 specify this option and you may have problems with debugging if
4404 you specify both this option and @option{-g}.
4406 @item -fssa
4407 @opindex fssa
4408 Perform optimizations in static single assignment form.  Each function's
4409 flow graph is translated into SSA form, optimizations are performed, and
4410 the flow graph is translated back from SSA form.  Users should not
4411 specify this option, since it is not yet ready for production use.
4413 @item -fssa-ccp
4414 @opindex fssa-ccp
4415 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4416 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4418 @item -fssa-dce
4419 @opindex fssa-dce
4420 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4421 Like @option{-fssa}, this is an experimental feature.
4426 @item --param @var{name}=@var{value}
4427 @opindex param
4428 In some places, GCC uses various constants to control the amount of
4429 optimization that is done.  For example, GCC will not inline functions
4430 that contain more that a certain number of instructions.  You can
4431 control some of these constants on the command-line using the
4432 @option{--param} option.
4434 In each case, the @var{value} is an integer.  The allowable choices for
4435 @var{name} are given in the following table:
4437 @table @gcctabopt
4438 @item max-crossjump-edges
4439 The maximum number of incoming edges to consider for crossjumping.
4440 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4441 the number of edges incoming to each block.  Increasing values mean
4442 more aggressive optimization, making the compile time increase with
4443 probably small improvement in executable size.
4445 @item max-delay-slot-insn-search
4446 The maximum number of instructions to consider when looking for an
4447 instruction to fill a delay slot.  If more than this arbitrary number of
4448 instructions is searched, the time savings from filling the delay slot
4449 will be minimal so stop searching.  Increasing values mean more
4450 aggressive optimization, making the compile time increase with probably
4451 small improvement in executable run time.
4453 @item max-delay-slot-live-search
4454 When trying to fill delay slots, the maximum number of instructions to
4455 consider when searching for a block with valid live register
4456 information.  Increasing this arbitrarily chosen value means more
4457 aggressive optimization, increasing the compile time.  This parameter
4458 should be removed when the delay slot code is rewritten to maintain the
4459 control-flow graph.
4461 @item max-gcse-memory
4462 The approximate maximum amount of memory that will be allocated in
4463 order to perform the global common subexpression elimination
4464 optimization.  If more memory than specified is required, the
4465 optimization will not be done.
4467 @item max-gcse-passes
4468 The maximum number of passes of GCSE to run.
4470 @item max-pending-list-length
4471 The maximum number of pending dependencies scheduling will allow
4472 before flushing the current state and starting over.  Large functions
4473 with few branches or calls can create excessively large lists which
4474 needlessly consume memory and resources.
4476 @item max-inline-insns-single
4477 Several parameters control the tree inliner used in gcc.
4478 This number sets the maximum number of instructions (counted in gcc's
4479 internal representation) in a single function that the tree inliner 
4480 will consider for inlining.  This only affects functions declared
4481 inline and methods implemented in a class declaration (C++).
4482 The default value is 300.
4484 @item max-inline-insns-auto
4485 When you use @option{-finline-functions} (included in @option{-O3}),
4486 a lot of functions that would otherwise not be considered for inlining
4487 by the compiler will be investigated.  To those functions, a different
4488 (more restrictive) limit compared to functions declared inline can
4489 be applied.
4490 The default value is 300.
4492 @item max-inline-insns
4493 The tree inliner does decrease the allowable size for single functions 
4494 to be inlined after we already inlined the number of instructions
4495 given here by repeated inlining.  This number should be a factor of 
4496 two or more larger than the single function limit.
4497 Higher numbers result in better runtime performance, but incur higher
4498 compile-time resource (CPU time, memory) requirements and result in
4499 larger binaries.  Very high values are not advisable, as too large
4500 binaries may adversely affect runtime performance.
4501 The default value is 600.
4503 @item max-inline-slope
4504 After exceeding the maximum number of inlined instructions by repeated
4505 inlining, a linear function is used to decrease the allowable size
4506 for single functions.  The slope of that function is the negative
4507 reciprocal of the number specified here.
4508 The default value is 32.
4510 @item min-inline-insns
4511 The repeated inlining is throttled more and more by the linear function
4512 after exceeding the limit.  To avoid too much throttling, a minimum for
4513 this function is specified here to allow repeated inlining for very small
4514 functions even when a lot of repeated inlining already has been done.
4515 The default value is 130.
4517 @item max-inline-insns-rtl
4518 For languages that use the RTL inliner (this happens at a later stage
4519 than tree inlining), you can set the maximum allowable size (counted 
4520 in RTL instructions) for the RTL inliner with this parameter.
4521 The default value is 600.
4524 @item max-unrolled-insns
4525 The maximum number of instructions that a loop should have if that loop
4526 is unrolled, and if the loop is unrolled, it determines how many times
4527 the loop code is unrolled.
4529 @item max-average-unrolled-insns
4530 The maximum number of instructions biased by probabilities of their execution
4531 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4532 it determines how many times the loop code is unrolled.
4534 @item max-unroll-times
4535 The maximum number of unrollings of a single loop.
4537 @item max-peeled-insns
4538 The maximum number of instructions that a loop should have if that loop
4539 is peeled, and if the loop is peeled, it determines how many times
4540 the loop code is peeled.
4542 @item max-peel-times
4543 The maximum number of peelings of a single loop.
4545 @item max-completely-peeled-insns
4546 The maximum number of insns of a completely peeled loop.
4548 @item max-completely-peel-times
4549 The maximum number of iterations of a loop to be suitable for complete peeling.
4551 @item max-unswitch-insns
4552 The maximum number of insns of an unswitched loop.
4554 @item max-unswitch-level
4555 The maximum number of branches unswitched in a single loop.
4557 @item hot-bb-count-fraction
4558 Select fraction of the maximal count of repetitions of basic block in program
4559 given basic block needs to have to be considered hot.
4561 @item hot-bb-frequency-fraction
4562 Select fraction of the maximal frequency of executions of basic block in
4563 function given basic block needs to have to be considered hot
4565 @item tracer-dynamic-coverage
4566 @itemx tracer-dynamic-coverage-feedback
4568 This value is used to limit superblock formation once the given percentage of
4569 executed instructions is covered.  This limits unnecessary code size
4570 expansion.
4572 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4573 feedback is available.  The real profiles (as opposed to statically estimated
4574 ones) are much less balanced allowing the threshold to be larger value.
4576 @item tracer-max-code-growth
4577 Stop tail duplication once code growth has reached given percentage.  This is
4578 rather hokey argument, as most of the duplicates will be eliminated later in
4579 cross jumping, so it may be set to much higher values than is the desired code
4580 growth.
4582 @item tracer-min-branch-ratio
4584 Stop reverse growth when the reverse probability of best edge is less than this
4585 threshold (in percent).
4587 @item tracer-min-branch-ratio
4588 @itemx tracer-min-branch-ratio-feedback
4590 Stop forward growth if the best edge do have probability lower than this
4591 threshold.
4593 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4594 compilation for profile feedback and one for compilation without.  The value
4595 for compilation with profile feedback needs to be more conservative (higher) in
4596 order to make tracer effective.
4598 @item ggc-min-expand
4600 GCC uses a garbage collector to manage its own memory allocation.  This
4601 parameter specifies the minimum percentage by which the garbage
4602 collector's heap should be allowed to expand between collections.
4603 Tuning this may improve compilation speed; it has no effect on code
4604 generation.
4606 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4607 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4608 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4609 GCC is not able to calculate RAM on a particular platform, the lower
4610 bound of 30% is used.  Setting this parameter and
4611 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4612 every opportunity.  This is extremely slow, but can be useful for
4613 debugging.
4615 @item ggc-min-heapsize
4617 Minimum size of the garbage collector's heap before it begins bothering
4618 to collect garbage.  The first collection occurs after the heap expands
4619 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4620 tuning this may improve compilation speed, and has no effect on code
4621 generation.
4623 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4624 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4625 available, the notion of "RAM" is the smallest of actual RAM,
4626 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4627 RAM on a particular platform, the lower bound is used.  Setting this
4628 parameter very large effectively disables garbage collection.  Setting
4629 this parameter and @option{ggc-min-expand} to zero causes a full
4630 collection to occur at every opportunity.
4632 @item reorder-blocks-duplicate
4633 @itemx reorder-blocks-duplicate-feedback
4635 Used by basic block reordering pass to decide whether to use uncondtional
4636 branch or duplicate the code on it's destination.  Code is duplicated when it's
4637 estimated size is smaller than this value multiplied by the estimated size of
4638 unconditinal jump in the hot spots of the program.
4640 The @option{reorder-block-duplicate-feedback} is used only when profile
4641 feedback is available and may be set to higher values than
4642 @option{reorder-block-duplicate} since information about the hot spots is more
4643 accurate.
4644 @end table
4645 @end table
4647 @node Preprocessor Options
4648 @section Options Controlling the Preprocessor
4649 @cindex preprocessor options
4650 @cindex options, preprocessor
4652 These options control the C preprocessor, which is run on each C source
4653 file before actual compilation.
4655 If you use the @option{-E} option, nothing is done except preprocessing.
4656 Some of these options make sense only together with @option{-E} because
4657 they cause the preprocessor output to be unsuitable for actual
4658 compilation.
4660 @table @gcctabopt
4661 @opindex Wp
4662 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4663 and pass @var{option} directly through to the preprocessor.  If
4664 @var{option} contains commas, it is split into multiple options at the
4665 commas.  However, many options are modified, translated or interpreted
4666 by the compiler driver before being passed to the preprocessor, and
4667 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4668 interface is undocumented and subject to change, so whenever possible
4669 you should avoid using @option{-Wp} and let the driver handle the
4670 options instead.
4672 @item -Xpreprocessor @var{option}
4673 @opindex preprocessor
4674 Pass @var{option} as an option to the preprocessor.  You can use this to
4675 supply system-specific preprocessor options which GCC does not know how to
4676 recognize.
4678 If you want to pass an option that takes an argument, you must use
4679 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4680 @end table
4682 @include cppopts.texi
4684 @node Assembler Options
4685 @section Passing Options to the Assembler
4687 @c prevent bad page break with this line
4688 You can pass options to the assembler.
4690 @table @gcctabopt
4691 @item -Wa,@var{option}
4692 @opindex Wa
4693 Pass @var{option} as an option to the assembler.  If @var{option}
4694 contains commas, it is split into multiple options at the commas.
4696 @item -Xassembler @var{option}
4697 @opindex Xassembler
4698 Pass @var{option} as an option to the assembler.  You can use this to
4699 supply system-specific assembler options which GCC does not know how to
4700 recognize.
4702 If you want to pass an option that takes an argument, you must use
4703 @option{-Xassembler} twice, once for the option and once for the argument.
4705 @end table
4707 @node Link Options
4708 @section Options for Linking
4709 @cindex link options
4710 @cindex options, linking
4712 These options come into play when the compiler links object files into
4713 an executable output file.  They are meaningless if the compiler is
4714 not doing a link step.
4716 @table @gcctabopt
4717 @cindex file names
4718 @item @var{object-file-name}
4719 A file name that does not end in a special recognized suffix is
4720 considered to name an object file or library.  (Object files are
4721 distinguished from libraries by the linker according to the file
4722 contents.)  If linking is done, these object files are used as input
4723 to the linker.
4725 @item -c
4726 @itemx -S
4727 @itemx -E
4728 @opindex c
4729 @opindex S
4730 @opindex E
4731 If any of these options is used, then the linker is not run, and
4732 object file names should not be used as arguments.  @xref{Overall
4733 Options}.
4735 @cindex Libraries
4736 @item -l@var{library}
4737 @itemx -l @var{library}
4738 @opindex l
4739 Search the library named @var{library} when linking.  (The second
4740 alternative with the library as a separate argument is only for
4741 POSIX compliance and is not recommended.)
4743 It makes a difference where in the command you write this option; the
4744 linker searches and processes libraries and object files in the order they
4745 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4746 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4747 to functions in @samp{z}, those functions may not be loaded.
4749 The linker searches a standard list of directories for the library,
4750 which is actually a file named @file{lib@var{library}.a}.  The linker
4751 then uses this file as if it had been specified precisely by name.
4753 The directories searched include several standard system directories
4754 plus any that you specify with @option{-L}.
4756 Normally the files found this way are library files---archive files
4757 whose members are object files.  The linker handles an archive file by
4758 scanning through it for members which define symbols that have so far
4759 been referenced but not defined.  But if the file that is found is an
4760 ordinary object file, it is linked in the usual fashion.  The only
4761 difference between using an @option{-l} option and specifying a file name
4762 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4763 and searches several directories.
4765 @item -lobjc
4766 @opindex lobjc
4767 You need this special case of the @option{-l} option in order to
4768 link an Objective-C program.
4770 @item -nostartfiles
4771 @opindex nostartfiles
4772 Do not use the standard system startup files when linking.
4773 The standard system libraries are used normally, unless @option{-nostdlib}
4774 or @option{-nodefaultlibs} is used.
4776 @item -nodefaultlibs
4777 @opindex nodefaultlibs
4778 Do not use the standard system libraries when linking.
4779 Only the libraries you specify will be passed to the linker.
4780 The standard startup files are used normally, unless @option{-nostartfiles}
4781 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4782 for System V (and ISO C) environments or to bcopy and bzero for
4783 BSD environments.  These entries are usually resolved by entries in
4784 libc.  These entry points should be supplied through some other
4785 mechanism when this option is specified.
4787 @item -nostdlib
4788 @opindex nostdlib
4789 Do not use the standard system startup files or libraries when linking.
4790 No startup files and only the libraries you specify will be passed to
4791 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4792 for System V (and ISO C) environments or to bcopy and bzero for
4793 BSD environments.  These entries are usually resolved by entries in
4794 libc.  These entry points should be supplied through some other
4795 mechanism when this option is specified.
4797 @cindex @option{-lgcc}, use with @option{-nostdlib}
4798 @cindex @option{-nostdlib} and unresolved references
4799 @cindex unresolved references and @option{-nostdlib}
4800 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4801 @cindex @option{-nodefaultlibs} and unresolved references
4802 @cindex unresolved references and @option{-nodefaultlibs}
4803 One of the standard libraries bypassed by @option{-nostdlib} and
4804 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4805 that GCC uses to overcome shortcomings of particular machines, or special
4806 needs for some languages.
4807 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4808 Collection (GCC) Internals},
4809 for more discussion of @file{libgcc.a}.)
4810 In most cases, you need @file{libgcc.a} even when you want to avoid
4811 other standard libraries.  In other words, when you specify @option{-nostdlib}
4812 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4813 This ensures that you have no unresolved references to internal GCC
4814 library subroutines.  (For example, @samp{__main}, used to ensure C++
4815 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4816 GNU Compiler Collection (GCC) Internals}.)
4818 @item -s
4819 @opindex s
4820 Remove all symbol table and relocation information from the executable.
4822 @item -static
4823 @opindex static
4824 On systems that support dynamic linking, this prevents linking with the shared
4825 libraries.  On other systems, this option has no effect.
4827 @item -shared
4828 @opindex shared
4829 Produce a shared object which can then be linked with other objects to
4830 form an executable.  Not all systems support this option.  For predictable
4831 results, you must also specify the same set of options that were used to
4832 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4833 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4834 needs to build supplementary stub code for constructors to work.  On
4835 multi-libbed systems, @samp{gcc -shared} must select the correct support
4836 libraries to link against.  Failing to supply the correct flags may lead
4837 to subtle defects.  Supplying them in cases where they are not necessary
4838 is innocuous.}
4840 @item -shared-libgcc
4841 @itemx -static-libgcc
4842 @opindex shared-libgcc
4843 @opindex static-libgcc
4844 On systems that provide @file{libgcc} as a shared library, these options
4845 force the use of either the shared or static version respectively.
4846 If no shared version of @file{libgcc} was built when the compiler was
4847 configured, these options have no effect.
4849 There are several situations in which an application should use the
4850 shared @file{libgcc} instead of the static version.  The most common
4851 of these is when the application wishes to throw and catch exceptions
4852 across different shared libraries.  In that case, each of the libraries
4853 as well as the application itself should use the shared @file{libgcc}.
4855 Therefore, the G++ and GCJ drivers automatically add
4856 @option{-shared-libgcc} whenever you build a shared library or a main
4857 executable, because C++ and Java programs typically use exceptions, so
4858 this is the right thing to do.
4860 If, instead, you use the GCC driver to create shared libraries, you may
4861 find that they will not always be linked with the shared @file{libgcc}.
4862 If GCC finds, at its configuration time, that you have a GNU linker that
4863 does not support option @option{--eh-frame-hdr}, it will link the shared
4864 version of @file{libgcc} into shared libraries by default.  Otherwise,
4865 it will take advantage of the linker and optimize away the linking with
4866 the shared version of @file{libgcc}, linking with the static version of
4867 libgcc by default.  This allows exceptions to propagate through such
4868 shared libraries, without incurring relocation costs at library load
4869 time.
4871 However, if a library or main executable is supposed to throw or catch
4872 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4873 for the languages used in the program, or using the option
4874 @option{-shared-libgcc}, such that it is linked with the shared
4875 @file{libgcc}.
4877 @item -symbolic
4878 @opindex symbolic
4879 Bind references to global symbols when building a shared object.  Warn
4880 about any unresolved references (unless overridden by the link editor
4881 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4882 this option.
4884 @item -Xlinker @var{option}
4885 @opindex Xlinker
4886 Pass @var{option} as an option to the linker.  You can use this to
4887 supply system-specific linker options which GCC does not know how to
4888 recognize.
4890 If you want to pass an option that takes an argument, you must use
4891 @option{-Xlinker} twice, once for the option and once for the argument.
4892 For example, to pass @option{-assert definitions}, you must write
4893 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4894 @option{-Xlinker "-assert definitions"}, because this passes the entire
4895 string as a single argument, which is not what the linker expects.
4897 @item -Wl,@var{option}
4898 @opindex Wl
4899 Pass @var{option} as an option to the linker.  If @var{option} contains
4900 commas, it is split into multiple options at the commas.
4902 @item -u @var{symbol}
4903 @opindex u
4904 Pretend the symbol @var{symbol} is undefined, to force linking of
4905 library modules to define it.  You can use @option{-u} multiple times with
4906 different symbols to force loading of additional library modules.
4907 @end table
4909 @node Directory Options
4910 @section Options for Directory Search
4911 @cindex directory options
4912 @cindex options, directory search
4913 @cindex search path
4915 These options specify directories to search for header files, for
4916 libraries and for parts of the compiler:
4918 @table @gcctabopt
4919 @item -I@var{dir}
4920 @opindex I
4921 Add the directory @var{dir} to the head of the list of directories to be
4922 searched for header files.  This can be used to override a system header
4923 file, substituting your own version, since these directories are
4924 searched before the system header file directories.  However, you should
4925 not use this option to add directories that contain vendor-supplied
4926 system header files (use @option{-isystem} for that).  If you use more than
4927 one @option{-I} option, the directories are scanned in left-to-right
4928 order; the standard system directories come after.
4930 If a standard system include directory, or a directory specified with
4931 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4932 option will be ignored.  The directory will still be searched but as a
4933 system directory at its normal position in the system include chain.
4934 This is to ensure that GCC's procedure to fix buggy system headers and
4935 the ordering for the include_next directive are not inadvertently changed.
4936 If you really need to change the search order for system directories,
4937 use the @option{-nostdinc} and/or @option{-isystem} options.
4939 @item -I-
4940 @opindex I-
4941 Any directories you specify with @option{-I} options before the @option{-I-}
4942 option are searched only for the case of @samp{#include "@var{file}"};
4943 they are not searched for @samp{#include <@var{file}>}.
4945 If additional directories are specified with @option{-I} options after
4946 the @option{-I-}, these directories are searched for all @samp{#include}
4947 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4948 this way.)
4950 In addition, the @option{-I-} option inhibits the use of the current
4951 directory (where the current input file came from) as the first search
4952 directory for @samp{#include "@var{file}"}.  There is no way to
4953 override this effect of @option{-I-}.  With @option{-I.} you can specify
4954 searching the directory which was current when the compiler was
4955 invoked.  That is not exactly the same as what the preprocessor does
4956 by default, but it is often satisfactory.
4958 @option{-I-} does not inhibit the use of the standard system directories
4959 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4960 independent.
4962 @item -L@var{dir}
4963 @opindex L
4964 Add directory @var{dir} to the list of directories to be searched
4965 for @option{-l}.
4967 @item -B@var{prefix}
4968 @opindex B
4969 This option specifies where to find the executables, libraries,
4970 include files, and data files of the compiler itself.
4972 The compiler driver program runs one or more of the subprograms
4973 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4974 @var{prefix} as a prefix for each program it tries to run, both with and
4975 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4977 For each subprogram to be run, the compiler driver first tries the
4978 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4979 was not specified, the driver tries two standard prefixes, which are
4980 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4981 those results in a file name that is found, the unmodified program
4982 name is searched for using the directories specified in your
4983 @env{PATH} environment variable.
4985 The compiler will check to see if the path provided by the @option{-B}
4986 refers to a directory, and if necessary it will add a directory
4987 separator character at the end of the path.
4989 @option{-B} prefixes that effectively specify directory names also apply
4990 to libraries in the linker, because the compiler translates these
4991 options into @option{-L} options for the linker.  They also apply to
4992 includes files in the preprocessor, because the compiler translates these
4993 options into @option{-isystem} options for the preprocessor.  In this case,
4994 the compiler appends @samp{include} to the prefix.
4996 The run-time support file @file{libgcc.a} can also be searched for using
4997 the @option{-B} prefix, if needed.  If it is not found there, the two
4998 standard prefixes above are tried, and that is all.  The file is left
4999 out of the link if it is not found by those means.
5001 Another way to specify a prefix much like the @option{-B} prefix is to use
5002 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5003 Variables}.
5005 As a special kludge, if the path provided by @option{-B} is
5006 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5007 9, then it will be replaced by @file{[dir/]include}.  This is to help
5008 with boot-strapping the compiler.
5010 @item -specs=@var{file}
5011 @opindex specs
5012 Process @var{file} after the compiler reads in the standard @file{specs}
5013 file, in order to override the defaults that the @file{gcc} driver
5014 program uses when determining what switches to pass to @file{cc1},
5015 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5016 @option{-specs=@var{file}} can be specified on the command line, and they
5017 are processed in order, from left to right.
5018 @end table
5020 @c man end
5022 @node Spec Files
5023 @section Specifying subprocesses and the switches to pass to them
5024 @cindex Spec Files
5026 @command{gcc} is a driver program.  It performs its job by invoking a
5027 sequence of other programs to do the work of compiling, assembling and
5028 linking.  GCC interprets its command-line parameters and uses these to
5029 deduce which programs it should invoke, and which command-line options
5030 it ought to place on their command lines.  This behavior is controlled
5031 by @dfn{spec strings}.  In most cases there is one spec string for each
5032 program that GCC can invoke, but a few programs have multiple spec
5033 strings to control their behavior.  The spec strings built into GCC can
5034 be overridden by using the @option{-specs=} command-line switch to specify
5035 a spec file.
5037 @dfn{Spec files} are plaintext files that are used to construct spec
5038 strings.  They consist of a sequence of directives separated by blank
5039 lines.  The type of directive is determined by the first non-whitespace
5040 character on the line and it can be one of the following:
5042 @table @code
5043 @item %@var{command}
5044 Issues a @var{command} to the spec file processor.  The commands that can
5045 appear here are:
5047 @table @code
5048 @item %include <@var{file}>
5049 @cindex %include
5050 Search for @var{file} and insert its text at the current point in the
5051 specs file.
5053 @item %include_noerr <@var{file}>
5054 @cindex %include_noerr
5055 Just like @samp{%include}, but do not generate an error message if the include
5056 file cannot be found.
5058 @item %rename @var{old_name} @var{new_name}
5059 @cindex %rename
5060 Rename the spec string @var{old_name} to @var{new_name}.
5062 @end table
5064 @item *[@var{spec_name}]:
5065 This tells the compiler to create, override or delete the named spec
5066 string.  All lines after this directive up to the next directive or
5067 blank line are considered to be the text for the spec string.  If this
5068 results in an empty string then the spec will be deleted.  (Or, if the
5069 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5070 does not currently exist a new spec will be created.  If the spec does
5071 exist then its contents will be overridden by the text of this
5072 directive, unless the first character of that text is the @samp{+}
5073 character, in which case the text will be appended to the spec.
5075 @item [@var{suffix}]:
5076 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5077 and up to the next directive or blank line are considered to make up the
5078 spec string for the indicated suffix.  When the compiler encounters an
5079 input file with the named suffix, it will processes the spec string in
5080 order to work out how to compile that file.  For example:
5082 @smallexample
5083 .ZZ:
5084 z-compile -input %i
5085 @end smallexample
5087 This says that any input file whose name ends in @samp{.ZZ} should be
5088 passed to the program @samp{z-compile}, which should be invoked with the
5089 command-line switch @option{-input} and with the result of performing the
5090 @samp{%i} substitution.  (See below.)
5092 As an alternative to providing a spec string, the text that follows a
5093 suffix directive can be one of the following:
5095 @table @code
5096 @item @@@var{language}
5097 This says that the suffix is an alias for a known @var{language}.  This is
5098 similar to using the @option{-x} command-line switch to GCC to specify a
5099 language explicitly.  For example:
5101 @smallexample
5102 .ZZ:
5103 @@c++
5104 @end smallexample
5106 Says that .ZZ files are, in fact, C++ source files.
5108 @item #@var{name}
5109 This causes an error messages saying:
5111 @smallexample
5112 @var{name} compiler not installed on this system.
5113 @end smallexample
5114 @end table
5116 GCC already has an extensive list of suffixes built into it.
5117 This directive will add an entry to the end of the list of suffixes, but
5118 since the list is searched from the end backwards, it is effectively
5119 possible to override earlier entries using this technique.
5121 @end table
5123 GCC has the following spec strings built into it.  Spec files can
5124 override these strings or create their own.  Note that individual
5125 targets can also add their own spec strings to this list.
5127 @smallexample
5128 asm          Options to pass to the assembler
5129 asm_final    Options to pass to the assembler post-processor
5130 cpp          Options to pass to the C preprocessor
5131 cc1          Options to pass to the C compiler
5132 cc1plus      Options to pass to the C++ compiler
5133 endfile      Object files to include at the end of the link
5134 link         Options to pass to the linker
5135 lib          Libraries to include on the command line to the linker
5136 libgcc       Decides which GCC support library to pass to the linker
5137 linker       Sets the name of the linker
5138 predefines   Defines to be passed to the C preprocessor
5139 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5140              by default
5141 startfile    Object files to include at the start of the link
5142 @end smallexample
5144 Here is a small example of a spec file:
5146 @smallexample
5147 %rename lib                 old_lib
5149 *lib:
5150 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5151 @end smallexample
5153 This example renames the spec called @samp{lib} to @samp{old_lib} and
5154 then overrides the previous definition of @samp{lib} with a new one.
5155 The new definition adds in some extra command-line options before
5156 including the text of the old definition.
5158 @dfn{Spec strings} are a list of command-line options to be passed to their
5159 corresponding program.  In addition, the spec strings can contain
5160 @samp{%}-prefixed sequences to substitute variable text or to
5161 conditionally insert text into the command line.  Using these constructs
5162 it is possible to generate quite complex command lines.
5164 Here is a table of all defined @samp{%}-sequences for spec
5165 strings.  Note that spaces are not generated automatically around the
5166 results of expanding these sequences.  Therefore you can concatenate them
5167 together or combine them with constant text in a single argument.
5169 @table @code
5170 @item %%
5171 Substitute one @samp{%} into the program name or argument.
5173 @item %i
5174 Substitute the name of the input file being processed.
5176 @item %b
5177 Substitute the basename of the input file being processed.
5178 This is the substring up to (and not including) the last period
5179 and not including the directory.
5181 @item %B
5182 This is the same as @samp{%b}, but include the file suffix (text after
5183 the last period).
5185 @item %d
5186 Marks the argument containing or following the @samp{%d} as a
5187 temporary file name, so that that file will be deleted if GCC exits
5188 successfully.  Unlike @samp{%g}, this contributes no text to the
5189 argument.
5191 @item %g@var{suffix}
5192 Substitute a file name that has suffix @var{suffix} and is chosen
5193 once per compilation, and mark the argument in the same way as
5194 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5195 name is now chosen in a way that is hard to predict even when previously
5196 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5197 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5198 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5199 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5200 was simply substituted with a file name chosen once per compilation,
5201 without regard to any appended suffix (which was therefore treated
5202 just like ordinary text), making such attacks more likely to succeed.
5204 @item %u@var{suffix}
5205 Like @samp{%g}, but generates a new temporary file name even if
5206 @samp{%u@var{suffix}} was already seen.
5208 @item %U@var{suffix}
5209 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5210 new one if there is no such last file name.  In the absence of any
5211 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5212 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5213 would involve the generation of two distinct file names, one
5214 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5215 simply substituted with a file name chosen for the previous @samp{%u},
5216 without regard to any appended suffix.
5218 @item %j@var{suffix}
5219 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5220 writable, and if save-temps is off; otherwise, substitute the name
5221 of a temporary file, just like @samp{%u}.  This temporary file is not
5222 meant for communication between processes, but rather as a junk
5223 disposal mechanism.
5225 @item %|@var{suffix}
5226 @itemx %m@var{suffix}
5227 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5228 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5229 all.  These are the two most common ways to instruct a program that it
5230 should read from standard input or write to standard output.  If you
5231 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5232 construct: see for example @file{f/lang-specs.h}.
5234 @item %.@var{SUFFIX}
5235 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5236 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5237 terminated by the next space or %.
5239 @item %w
5240 Marks the argument containing or following the @samp{%w} as the
5241 designated output file of this compilation.  This puts the argument
5242 into the sequence of arguments that @samp{%o} will substitute later.
5244 @item %o
5245 Substitutes the names of all the output files, with spaces
5246 automatically placed around them.  You should write spaces
5247 around the @samp{%o} as well or the results are undefined.
5248 @samp{%o} is for use in the specs for running the linker.
5249 Input files whose names have no recognized suffix are not compiled
5250 at all, but they are included among the output files, so they will
5251 be linked.
5253 @item %O
5254 Substitutes the suffix for object files.  Note that this is
5255 handled specially when it immediately follows @samp{%g, %u, or %U},
5256 because of the need for those to form complete file names.  The
5257 handling is such that @samp{%O} is treated exactly as if it had already
5258 been substituted, except that @samp{%g, %u, and %U} do not currently
5259 support additional @var{suffix} characters following @samp{%O} as they would
5260 following, for example, @samp{.o}.
5262 @item %p
5263 Substitutes the standard macro predefinitions for the
5264 current target machine.  Use this when running @code{cpp}.
5266 @item %P
5267 Like @samp{%p}, but puts @samp{__} before and after the name of each
5268 predefined macro, except for macros that start with @samp{__} or with
5269 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5272 @item %I
5273 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5274 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5275 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5276 as necessary.
5278 @item %s
5279 Current argument is the name of a library or startup file of some sort.
5280 Search for that file in a standard list of directories and substitute
5281 the full name found.
5283 @item %e@var{str}
5284 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5285 Use this when inconsistent options are detected.
5287 @item %(@var{name})
5288 Substitute the contents of spec string @var{name} at this point.
5290 @item %[@var{name}]
5291 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5293 @item %x@{@var{option}@}
5294 Accumulate an option for @samp{%X}.
5296 @item %X
5297 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5298 spec string.
5300 @item %Y
5301 Output the accumulated assembler options specified by @option{-Wa}.
5303 @item %Z
5304 Output the accumulated preprocessor options specified by @option{-Wp}.
5306 @item %a
5307 Process the @code{asm} spec.  This is used to compute the
5308 switches to be passed to the assembler.
5310 @item %A
5311 Process the @code{asm_final} spec.  This is a spec string for
5312 passing switches to an assembler post-processor, if such a program is
5313 needed.
5315 @item %l
5316 Process the @code{link} spec.  This is the spec for computing the
5317 command line passed to the linker.  Typically it will make use of the
5318 @samp{%L %G %S %D and %E} sequences.
5320 @item %D
5321 Dump out a @option{-L} option for each directory that GCC believes might
5322 contain startup files.  If the target supports multilibs then the
5323 current multilib directory will be prepended to each of these paths.
5325 @item %M
5326 Output the multilib directory with directory separators replaced with
5327 @samp{_}.  If multilib directories are not set, or the multilib directory is
5328 @file{.} then this option emits nothing.
5330 @item %L
5331 Process the @code{lib} spec.  This is a spec string for deciding which
5332 libraries should be included on the command line to the linker.
5334 @item %G
5335 Process the @code{libgcc} spec.  This is a spec string for deciding
5336 which GCC support library should be included on the command line to the linker.
5338 @item %S
5339 Process the @code{startfile} spec.  This is a spec for deciding which
5340 object files should be the first ones passed to the linker.  Typically
5341 this might be a file named @file{crt0.o}.
5343 @item %E
5344 Process the @code{endfile} spec.  This is a spec string that specifies
5345 the last object files that will be passed to the linker.
5347 @item %C
5348 Process the @code{cpp} spec.  This is used to construct the arguments
5349 to be passed to the C preprocessor.
5351 @item %c
5352 Process the @code{signed_char} spec.  This is intended to be used
5353 to tell cpp whether a char is signed.  It typically has the definition:
5354 @smallexample
5355 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5356 @end smallexample
5358 @item %1
5359 Process the @code{cc1} spec.  This is used to construct the options to be
5360 passed to the actual C compiler (@samp{cc1}).
5362 @item %2
5363 Process the @code{cc1plus} spec.  This is used to construct the options to be
5364 passed to the actual C++ compiler (@samp{cc1plus}).
5366 @item %*
5367 Substitute the variable part of a matched option.  See below.
5368 Note that each comma in the substituted string is replaced by
5369 a single space.
5371 @item %<@code{S}
5372 Remove all occurrences of @code{-S} from the command line.  Note---this
5373 command is position dependent.  @samp{%} commands in the spec string
5374 before this one will see @code{-S}, @samp{%} commands in the spec string
5375 after this one will not.
5377 @item %:@var{function}(@var{args})
5378 Call the named function @var{function}, passing it @var{args}.
5379 @var{args} is first processed as a nested spec string, then split
5380 into an argument vector in the usual fashion.  The function returns
5381 a string which is processed as if it had appeared literally as part
5382 of the current spec.
5384 The following built-in spec functions are provided:
5386 @table @code
5387 @item @code{if-exists}
5388 The @code{if-exists} spec function takes one argument, an absolute
5389 pathname to a file.  If the file exists, @code{if-exists} returns the
5390 pathname.  Here is a small example of its usage:
5392 @smallexample
5393 *startfile:
5394 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5395 @end smallexample
5397 @item @code{if-exists-else}
5398 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5399 spec function, except that it takes two arguments.  The first argument is
5400 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5401 returns the pathname.  If it does not exist, it returns the second argument.
5402 This way, @code{if-exists-else} can be used to select one file or another,
5403 based on the existence of the first.  Here is a small example of its usage:
5405 @smallexample 
5406 *startfile:
5407 crt0%O%s %:if-exists(crti%O%s) \
5408 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5409 @end smallexample
5410 @end table 
5412 @item %@{@code{S}@}
5413 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5414 If that switch was not specified, this substitutes nothing.  Note that
5415 the leading dash is omitted when specifying this option, and it is
5416 automatically inserted if the substitution is performed.  Thus the spec
5417 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5418 and would output the command line option @option{-foo}.
5420 @item %W@{@code{S}@}
5421 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5422 deleted on failure.
5424 @item %@{@code{S}*@}
5425 Substitutes all the switches specified to GCC whose names start
5426 with @code{-S}, but which also take an argument.  This is used for
5427 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5428 GCC considers @option{-o foo} as being
5429 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5430 text, including the space.  Thus two arguments would be generated.
5432 @item %@{@code{S}*&@code{T}*@}
5433 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5434 (the order of @code{S} and @code{T} in the spec is not significant).
5435 There can be any number of ampersand-separated variables; for each the
5436 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5438 @item %@{@code{S}:@code{X}@}
5439 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5441 @item %@{!@code{S}:@code{X}@}
5442 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5444 @item %@{@code{S}*:@code{X}@}
5445 Substitutes @code{X} if one or more switches whose names start with
5446 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5447 once, no matter how many such switches appeared.  However, if @code{%*}
5448 appears somewhere in @code{X}, then @code{X} will be substituted once
5449 for each matching switch, with the @code{%*} replaced by the part of
5450 that switch that matched the @code{*}.
5452 @item %@{.@code{S}:@code{X}@}
5453 Substitutes @code{X}, if processing a file with suffix @code{S}.
5455 @item %@{!.@code{S}:@code{X}@}
5456 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5458 @item %@{@code{S}|@code{P}:@code{X}@}
5459 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5460 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5461 although they have a stronger binding than the @samp{|}.  If @code{%*}
5462 appears in @code{X}, all of the alternatives must be starred, and only
5463 the first matching alternative is substituted.
5465 For example, a spec string like this:
5467 @smallexample
5468 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5469 @end smallexample
5471 will output the following command-line options from the following input
5472 command-line options:
5474 @smallexample
5475 fred.c        -foo -baz
5476 jim.d         -bar -boggle
5477 -d fred.c     -foo -baz -boggle
5478 -d jim.d      -bar -baz -boggle
5479 @end smallexample
5481 @item %@{S:X; T:Y; :D@}
5483 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5484 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5485 be as many clauses as you need.  This may be combined with @code{.}, 
5486 @code{!}, @code{|}, and @code{*} as needed.
5489 @end table
5491 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5492 construct may contain other nested @samp{%} constructs or spaces, or
5493 even newlines.  They are processed as usual, as described above.
5494 Trailing white space in @code{X} is ignored.  White space may also
5495 appear anywhere on the left side of the colon in these constructs,
5496 except between @code{.} or @code{*} and the corresponding word.
5498 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5499 handled specifically in these constructs.  If another value of
5500 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5501 @option{-W} switch is found later in the command line, the earlier
5502 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5503 just one letter, which passes all matching options.
5505 The character @samp{|} at the beginning of the predicate text is used to
5506 indicate that a command should be piped to the following command, but
5507 only if @option{-pipe} is specified.
5509 It is built into GCC which switches take arguments and which do not.
5510 (You might think it would be useful to generalize this to allow each
5511 compiler's spec to say which switches take arguments.  But this cannot
5512 be done in a consistent fashion.  GCC cannot even decide which input
5513 files have been specified without knowing which switches take arguments,
5514 and it must know which input files to compile in order to tell which
5515 compilers to run).
5517 GCC also knows implicitly that arguments starting in @option{-l} are to be
5518 treated as compiler output files, and passed to the linker in their
5519 proper position among the other output files.
5521 @c man begin OPTIONS
5523 @node Target Options
5524 @section Specifying Target Machine and Compiler Version
5525 @cindex target options
5526 @cindex cross compiling
5527 @cindex specifying machine version
5528 @cindex specifying compiler version and target machine
5529 @cindex compiler version, specifying
5530 @cindex target machine, specifying
5532 The usual way to run GCC is to run the executable called @file{gcc}, or
5533 @file{<machine>-gcc} when cross-compiling, or
5534 @file{<machine>-gcc-<version>} to run a version other than the one that
5535 was installed last.  Sometimes this is inconvenient, so GCC provides
5536 options that will switch to another cross-compiler or version.
5538 @table @gcctabopt
5539 @item -b @var{machine}
5540 @opindex b
5541 The argument @var{machine} specifies the target machine for compilation.
5543 The value to use for @var{machine} is the same as was specified as the
5544 machine type when configuring GCC as a cross-compiler.  For
5545 example, if a cross-compiler was configured with @samp{configure
5546 i386v}, meaning to compile for an 80386 running System V, then you
5547 would specify @option{-b i386v} to run that cross compiler.
5549 @item -V @var{version}
5550 @opindex V
5551 The argument @var{version} specifies which version of GCC to run.
5552 This is useful when multiple versions are installed.  For example,
5553 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5554 @end table
5556 The @option{-V} and @option{-b} options work by running the
5557 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5558 use them if you can just run that directly.
5560 @node Submodel Options
5561 @section Hardware Models and Configurations
5562 @cindex submodel options
5563 @cindex specifying hardware config
5564 @cindex hardware models and configurations, specifying
5565 @cindex machine dependent options
5567 Earlier we discussed the standard option @option{-b} which chooses among
5568 different installed compilers for completely different target
5569 machines, such as VAX vs.@: 68000 vs.@: 80386.
5571 In addition, each of these target machine types can have its own
5572 special options, starting with @samp{-m}, to choose among various
5573 hardware models or configurations---for example, 68010 vs 68020,
5574 floating coprocessor or none.  A single installed version of the
5575 compiler can compile for any model or configuration, according to the
5576 options specified.
5578 Some configurations of the compiler also support additional special
5579 options, usually for compatibility with other compilers on the same
5580 platform.
5582 These options are defined by the macro @code{TARGET_SWITCHES} in the
5583 machine description.  The default for the options is also defined by
5584 that macro, which enables you to change the defaults.
5586 @menu
5587 * M680x0 Options::
5588 * M68hc1x Options::
5589 * VAX Options::
5590 * SPARC Options::
5591 * ARM Options::
5592 * MN10200 Options::
5593 * MN10300 Options::
5594 * M32R/D Options::
5595 * M88K Options::
5596 * RS/6000 and PowerPC Options::
5597 * Darwin Options::
5598 * RT Options::
5599 * MIPS Options::
5600 * i386 and x86-64 Options::
5601 * HPPA Options::
5602 * Intel 960 Options::
5603 * DEC Alpha Options::
5604 * DEC Alpha/VMS Options::
5605 * H8/300 Options::
5606 * SH Options::
5607 * System V Options::
5608 * TMS320C3x/C4x Options::
5609 * V850 Options::
5610 * ARC Options::
5611 * NS32K Options::
5612 * AVR Options::
5613 * MCore Options::
5614 * IA-64 Options::
5615 * D30V Options::
5616 * S/390 and zSeries Options::
5617 * CRIS Options::
5618 * MMIX Options::
5619 * PDP-11 Options::
5620 * Xstormy16 Options::
5621 * Xtensa Options::
5622 * FRV Options::
5623 @end menu
5625 @node M680x0 Options
5626 @subsection M680x0 Options
5627 @cindex M680x0 options
5629 These are the @samp{-m} options defined for the 68000 series.  The default
5630 values for these options depends on which style of 68000 was selected when
5631 the compiler was configured; the defaults for the most common choices are
5632 given below.
5634 @table @gcctabopt
5635 @item -m68000
5636 @itemx -mc68000
5637 @opindex m68000
5638 @opindex mc68000
5639 Generate output for a 68000.  This is the default
5640 when the compiler is configured for 68000-based systems.
5642 Use this option for microcontrollers with a 68000 or EC000 core,
5643 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5645 @item -m68020
5646 @itemx -mc68020
5647 @opindex m68020
5648 @opindex mc68020
5649 Generate output for a 68020.  This is the default
5650 when the compiler is configured for 68020-based systems.
5652 @item -m68881
5653 @opindex m68881
5654 Generate output containing 68881 instructions for floating point.
5655 This is the default for most 68020 systems unless @option{--nfp} was
5656 specified when the compiler was configured.
5658 @item -m68030
5659 @opindex m68030
5660 Generate output for a 68030.  This is the default when the compiler is
5661 configured for 68030-based systems.
5663 @item -m68040
5664 @opindex m68040
5665 Generate output for a 68040.  This is the default when the compiler is
5666 configured for 68040-based systems.
5668 This option inhibits the use of 68881/68882 instructions that have to be
5669 emulated by software on the 68040.  Use this option if your 68040 does not
5670 have code to emulate those instructions.
5672 @item -m68060
5673 @opindex m68060
5674 Generate output for a 68060.  This is the default when the compiler is
5675 configured for 68060-based systems.
5677 This option inhibits the use of 68020 and 68881/68882 instructions that
5678 have to be emulated by software on the 68060.  Use this option if your 68060
5679 does not have code to emulate those instructions.
5681 @item -mcpu32
5682 @opindex mcpu32
5683 Generate output for a CPU32.  This is the default
5684 when the compiler is configured for CPU32-based systems.
5686 Use this option for microcontrollers with a
5687 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5688 68336, 68340, 68341, 68349 and 68360.
5690 @item -m5200
5691 @opindex m5200
5692 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5693 when the compiler is configured for 520X-based systems.
5695 Use this option for microcontroller with a 5200 core, including
5696 the MCF5202, MCF5203, MCF5204 and MCF5202.
5699 @item -m68020-40
5700 @opindex m68020-40
5701 Generate output for a 68040, without using any of the new instructions.
5702 This results in code which can run relatively efficiently on either a
5703 68020/68881 or a 68030 or a 68040.  The generated code does use the
5704 68881 instructions that are emulated on the 68040.
5706 @item -m68020-60
5707 @opindex m68020-60
5708 Generate output for a 68060, without using any of the new instructions.
5709 This results in code which can run relatively efficiently on either a
5710 68020/68881 or a 68030 or a 68040.  The generated code does use the
5711 68881 instructions that are emulated on the 68060.
5713 @item -msoft-float
5714 @opindex msoft-float
5715 Generate output containing library calls for floating point.
5716 @strong{Warning:} the requisite libraries are not available for all m68k
5717 targets.  Normally the facilities of the machine's usual C compiler are
5718 used, but this can't be done directly in cross-compilation.  You must
5719 make your own arrangements to provide suitable library functions for
5720 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5721 @samp{m68k-*-coff} do provide software floating point support.
5723 @item -mshort
5724 @opindex mshort
5725 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5727 @item -mnobitfield
5728 @opindex mnobitfield
5729 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5730 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5732 @item -mbitfield
5733 @opindex mbitfield
5734 Do use the bit-field instructions.  The @option{-m68020} option implies
5735 @option{-mbitfield}.  This is the default if you use a configuration
5736 designed for a 68020.
5738 @item -mrtd
5739 @opindex mrtd
5740 Use a different function-calling convention, in which functions
5741 that take a fixed number of arguments return with the @code{rtd}
5742 instruction, which pops their arguments while returning.  This
5743 saves one instruction in the caller since there is no need to pop
5744 the arguments there.
5746 This calling convention is incompatible with the one normally
5747 used on Unix, so you cannot use it if you need to call libraries
5748 compiled with the Unix compiler.
5750 Also, you must provide function prototypes for all functions that
5751 take variable numbers of arguments (including @code{printf});
5752 otherwise incorrect code will be generated for calls to those
5753 functions.
5755 In addition, seriously incorrect code will result if you call a
5756 function with too many arguments.  (Normally, extra arguments are
5757 harmlessly ignored.)
5759 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5760 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5762 @item -malign-int
5763 @itemx -mno-align-int
5764 @opindex malign-int
5765 @opindex mno-align-int
5766 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5767 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5768 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5769 Aligning variables on 32-bit boundaries produces code that runs somewhat
5770 faster on processors with 32-bit busses at the expense of more memory.
5772 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5773 align structures containing the above types  differently than
5774 most published application binary interface specifications for the m68k.
5776 @item -mpcrel
5777 @opindex mpcrel
5778 Use the pc-relative addressing mode of the 68000 directly, instead of
5779 using a global offset table.  At present, this option implies @option{-fpic},
5780 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5781 not presently supported with @option{-mpcrel}, though this could be supported for
5782 68020 and higher processors.
5784 @item -mno-strict-align
5785 @itemx -mstrict-align
5786 @opindex mno-strict-align
5787 @opindex mstrict-align
5788 Do not (do) assume that unaligned memory references will be handled by
5789 the system.
5791 @end table
5793 @node M68hc1x Options
5794 @subsection M68hc1x Options
5795 @cindex M68hc1x options
5797 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5798 microcontrollers.  The default values for these options depends on
5799 which style of microcontroller was selected when the compiler was configured;
5800 the defaults for the most common choices are given below.
5802 @table @gcctabopt
5803 @item -m6811
5804 @itemx -m68hc11
5805 @opindex m6811
5806 @opindex m68hc11
5807 Generate output for a 68HC11.  This is the default
5808 when the compiler is configured for 68HC11-based systems.
5810 @item -m6812
5811 @itemx -m68hc12
5812 @opindex m6812
5813 @opindex m68hc12
5814 Generate output for a 68HC12.  This is the default
5815 when the compiler is configured for 68HC12-based systems.
5817 @item -m68S12
5818 @itemx -m68hcs12
5819 @opindex m68S12
5820 @opindex m68hcs12
5821 Generate output for a 68HCS12.  
5823 @item -mauto-incdec
5824 @opindex mauto-incdec
5825 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5826 addressing modes.
5828 @item -minmax
5829 @itemx -nominmax
5830 @opindex minmax
5831 @opindex mnominmax
5832 Enable the use of 68HC12 min and max instructions.
5834 @item -mlong-calls
5835 @itemx -mno-long-calls
5836 @opindex mlong-calls
5837 @opindex mno-long-calls
5838 Treat all calls as being far away (near).  If calls are assumed to be
5839 far away, the compiler will use the @code{call} instruction to
5840 call a function and the @code{rtc} instruction for returning.
5842 @item -mshort
5843 @opindex mshort
5844 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5846 @item -msoft-reg-count=@var{count}
5847 @opindex msoft-reg-count
5848 Specify the number of pseudo-soft registers which are used for the
5849 code generation.  The maximum number is 32.  Using more pseudo-soft
5850 register may or may not result in better code depending on the program.
5851 The default is 4 for 68HC11 and 2 for 68HC12.
5853 @end table
5855 @node VAX Options
5856 @subsection VAX Options
5857 @cindex VAX options
5859 These @samp{-m} options are defined for the VAX:
5861 @table @gcctabopt
5862 @item -munix
5863 @opindex munix
5864 Do not output certain jump instructions (@code{aobleq} and so on)
5865 that the Unix assembler for the VAX cannot handle across long
5866 ranges.
5868 @item -mgnu
5869 @opindex mgnu
5870 Do output those jump instructions, on the assumption that you
5871 will assemble with the GNU assembler.
5873 @item -mg
5874 @opindex mg
5875 Output code for g-format floating point numbers instead of d-format.
5876 @end table
5878 @node SPARC Options
5879 @subsection SPARC Options
5880 @cindex SPARC options
5882 These @samp{-m} switches are supported on the SPARC:
5884 @table @gcctabopt
5885 @item -mno-app-regs
5886 @itemx -mapp-regs
5887 @opindex mno-app-regs
5888 @opindex mapp-regs
5889 Specify @option{-mapp-regs} to generate output using the global registers
5890 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5891 is the default.
5893 To be fully SVR4 ABI compliant at the cost of some performance loss,
5894 specify @option{-mno-app-regs}.  You should compile libraries and system
5895 software with this option.
5897 @item -mfpu
5898 @itemx -mhard-float
5899 @opindex mfpu
5900 @opindex mhard-float
5901 Generate output containing floating point instructions.  This is the
5902 default.
5904 @item -mno-fpu
5905 @itemx -msoft-float
5906 @opindex mno-fpu
5907 @opindex msoft-float
5908 Generate output containing library calls for floating point.
5909 @strong{Warning:} the requisite libraries are not available for all SPARC
5910 targets.  Normally the facilities of the machine's usual C compiler are
5911 used, but this cannot be done directly in cross-compilation.  You must make
5912 your own arrangements to provide suitable library functions for
5913 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5914 @samp{sparclite-*-*} do provide software floating point support.
5916 @option{-msoft-float} changes the calling convention in the output file;
5917 therefore, it is only useful if you compile @emph{all} of a program with
5918 this option.  In particular, you need to compile @file{libgcc.a}, the
5919 library that comes with GCC, with @option{-msoft-float} in order for
5920 this to work.
5922 @item -mhard-quad-float
5923 @opindex mhard-quad-float
5924 Generate output containing quad-word (long double) floating point
5925 instructions.
5927 @item -msoft-quad-float
5928 @opindex msoft-quad-float
5929 Generate output containing library calls for quad-word (long double)
5930 floating point instructions.  The functions called are those specified
5931 in the SPARC ABI@.  This is the default.
5933 As of this writing, there are no sparc implementations that have hardware
5934 support for the quad-word floating point instructions.  They all invoke
5935 a trap handler for one of these instructions, and then the trap handler
5936 emulates the effect of the instruction.  Because of the trap handler overhead,
5937 this is much slower than calling the ABI library routines.  Thus the
5938 @option{-msoft-quad-float} option is the default.
5940 @item -mno-flat
5941 @itemx -mflat
5942 @opindex mno-flat
5943 @opindex mflat
5944 With @option{-mflat}, the compiler does not generate save/restore instructions
5945 and will use a ``flat'' or single register window calling convention.
5946 This model uses %i7 as the frame pointer and is compatible with the normal
5947 register window model.  Code from either may be intermixed.
5948 The local registers and the input registers (0--5) are still treated as
5949 ``call saved'' registers and will be saved on the stack as necessary.
5951 With @option{-mno-flat} (the default), the compiler emits save/restore
5952 instructions (except for leaf functions) and is the normal mode of operation.
5954 @item -mno-unaligned-doubles
5955 @itemx -munaligned-doubles
5956 @opindex mno-unaligned-doubles
5957 @opindex munaligned-doubles
5958 Assume that doubles have 8 byte alignment.  This is the default.
5960 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5961 alignment only if they are contained in another type, or if they have an
5962 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5963 Specifying this option avoids some rare compatibility problems with code
5964 generated by other compilers.  It is not the default because it results
5965 in a performance loss, especially for floating point code.
5967 @item -mno-faster-structs
5968 @itemx -mfaster-structs
5969 @opindex mno-faster-structs
5970 @opindex mfaster-structs
5971 With @option{-mfaster-structs}, the compiler assumes that structures
5972 should have 8 byte alignment.  This enables the use of pairs of
5973 @code{ldd} and @code{std} instructions for copies in structure
5974 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5975 However, the use of this changed alignment directly violates the SPARC
5976 ABI@.  Thus, it's intended only for use on targets where the developer
5977 acknowledges that their resulting code will not be directly in line with
5978 the rules of the ABI@.
5980 @item -mv8
5981 @itemx -msparclite
5982 @opindex mv8
5983 @opindex msparclite
5984 These two options select variations on the SPARC architecture.
5986 By default (unless specifically configured for the Fujitsu SPARClite),
5987 GCC generates code for the v7 variant of the SPARC architecture.
5989 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5990 code is that the compiler emits the integer multiply and integer
5991 divide instructions which exist in SPARC v8 but not in SPARC v7.
5993 @option{-msparclite} will give you SPARClite code.  This adds the integer
5994 multiply, integer divide step and scan (@code{ffs}) instructions which
5995 exist in SPARClite but not in SPARC v7.
5997 These options are deprecated and will be deleted in a future GCC release.
5998 They have been replaced with @option{-mcpu=xxx}.
6000 @item -mcypress
6001 @itemx -msupersparc
6002 @opindex mcypress
6003 @opindex msupersparc
6004 These two options select the processor for which the code is optimized.
6006 With @option{-mcypress} (the default), the compiler optimizes code for the
6007 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6008 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6010 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6011 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6012 of the full SPARC v8 instruction set.
6014 These options are deprecated and will be deleted in a future GCC release.
6015 They have been replaced with @option{-mcpu=xxx}.
6017 @item -mcpu=@var{cpu_type}
6018 @opindex mcpu
6019 Set the instruction set, register set, and instruction scheduling parameters
6020 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6021 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6022 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6023 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6024 @samp{ultrasparc3}.
6026 Default instruction scheduling parameters are used for values that select
6027 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6028 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6030 Here is a list of each supported architecture and their supported
6031 implementations.
6033 @smallexample
6034     v7:             cypress
6035     v8:             supersparc, hypersparc
6036     sparclite:      f930, f934, sparclite86x
6037     sparclet:       tsc701
6038     v9:             ultrasparc, ultrasparc3
6039 @end smallexample
6041 @item -mtune=@var{cpu_type}
6042 @opindex mtune
6043 Set the instruction scheduling parameters for machine type
6044 @var{cpu_type}, but do not set the instruction set or register set that the
6045 option @option{-mcpu=@var{cpu_type}} would.
6047 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6048 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6049 that select a particular cpu implementation.  Those are @samp{cypress},
6050 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6051 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6052 @samp{ultrasparc3}.
6054 @end table
6056 These @samp{-m} switches are supported in addition to the above
6057 on the SPARCLET processor.
6059 @table @gcctabopt
6060 @item -mlittle-endian
6061 @opindex mlittle-endian
6062 Generate code for a processor running in little-endian mode.
6064 @item -mlive-g0
6065 @opindex mlive-g0
6066 Treat register @code{%g0} as a normal register.
6067 GCC will continue to clobber it as necessary but will not assume
6068 it always reads as 0.
6070 @item -mbroken-saverestore
6071 @opindex mbroken-saverestore
6072 Generate code that does not use non-trivial forms of the @code{save} and
6073 @code{restore} instructions.  Early versions of the SPARCLET processor do
6074 not correctly handle @code{save} and @code{restore} instructions used with
6075 arguments.  They correctly handle them used without arguments.  A @code{save}
6076 instruction used without arguments increments the current window pointer
6077 but does not allocate a new stack frame.  It is assumed that the window
6078 overflow trap handler will properly handle this case as will interrupt
6079 handlers.
6080 @end table
6082 These @samp{-m} switches are supported in addition to the above
6083 on SPARC V9 processors in 64-bit environments.
6085 @table @gcctabopt
6086 @item -mlittle-endian
6087 @opindex mlittle-endian
6088 Generate code for a processor running in little-endian mode.
6090 @item -m32
6091 @itemx -m64
6092 @opindex m32
6093 @opindex m64
6094 Generate code for a 32-bit or 64-bit environment.
6095 The 32-bit environment sets int, long and pointer to 32 bits.
6096 The 64-bit environment sets int to 32 bits and long and pointer
6097 to 64 bits.
6099 @item -mcmodel=medlow
6100 @opindex mcmodel=medlow
6101 Generate code for the Medium/Low code model: the program must be linked
6102 in the low 32 bits of the address space.  Pointers are 64 bits.
6103 Programs can be statically or dynamically linked.
6105 @item -mcmodel=medmid
6106 @opindex mcmodel=medmid
6107 Generate code for the Medium/Middle code model: the program must be linked
6108 in the low 44 bits of the address space, the text segment must be less than
6109 2G bytes, and data segment must be within 2G of the text segment.
6110 Pointers are 64 bits.
6112 @item -mcmodel=medany
6113 @opindex mcmodel=medany
6114 Generate code for the Medium/Anywhere code model: the program may be linked
6115 anywhere in the address space, the text segment must be less than
6116 2G bytes, and data segment must be within 2G of the text segment.
6117 Pointers are 64 bits.
6119 @item -mcmodel=embmedany
6120 @opindex mcmodel=embmedany
6121 Generate code for the Medium/Anywhere code model for embedded systems:
6122 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6123 (determined at link time).  Register %g4 points to the base of the
6124 data segment.  Pointers are still 64 bits.
6125 Programs are statically linked, PIC is not supported.
6127 @item -mstack-bias
6128 @itemx -mno-stack-bias
6129 @opindex mstack-bias
6130 @opindex mno-stack-bias
6131 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6132 frame pointer if present, are offset by @minus{}2047 which must be added back
6133 when making stack frame references.
6134 Otherwise, assume no such offset is present.
6135 @end table
6137 @node ARM Options
6138 @subsection ARM Options
6139 @cindex ARM options
6141 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6142 architectures:
6144 @table @gcctabopt
6145 @item -mapcs-frame
6146 @opindex mapcs-frame
6147 Generate a stack frame that is compliant with the ARM Procedure Call
6148 Standard for all functions, even if this is not strictly necessary for
6149 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6150 with this option will cause the stack frames not to be generated for
6151 leaf functions.  The default is @option{-mno-apcs-frame}.
6153 @item -mapcs
6154 @opindex mapcs
6155 This is a synonym for @option{-mapcs-frame}.
6157 @item -mapcs-26
6158 @opindex mapcs-26
6159 Generate code for a processor running with a 26-bit program counter,
6160 and conforming to the function calling standards for the APCS 26-bit
6161 option.  This option replaces the @option{-m2} and @option{-m3} options
6162 of previous releases of the compiler.
6164 @item -mapcs-32
6165 @opindex mapcs-32
6166 Generate code for a processor running with a 32-bit program counter,
6167 and conforming to the function calling standards for the APCS 32-bit
6168 option.  This option replaces the @option{-m6} option of previous releases
6169 of the compiler.
6171 @ignore
6172 @c not currently implemented
6173 @item -mapcs-stack-check
6174 @opindex mapcs-stack-check
6175 Generate code to check the amount of stack space available upon entry to
6176 every function (that actually uses some stack space).  If there is
6177 insufficient space available then either the function
6178 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6179 called, depending upon the amount of stack space required.  The run time
6180 system is required to provide these functions.  The default is
6181 @option{-mno-apcs-stack-check}, since this produces smaller code.
6183 @c not currently implemented
6184 @item -mapcs-float
6185 @opindex mapcs-float
6186 Pass floating point arguments using the float point registers.  This is
6187 one of the variants of the APCS@.  This option is recommended if the
6188 target hardware has a floating point unit or if a lot of floating point
6189 arithmetic is going to be performed by the code.  The default is
6190 @option{-mno-apcs-float}, since integer only code is slightly increased in
6191 size if @option{-mapcs-float} is used.
6193 @c not currently implemented
6194 @item -mapcs-reentrant
6195 @opindex mapcs-reentrant
6196 Generate reentrant, position independent code.  The default is
6197 @option{-mno-apcs-reentrant}.
6198 @end ignore
6200 @item -mthumb-interwork
6201 @opindex mthumb-interwork
6202 Generate code which supports calling between the ARM and Thumb
6203 instruction sets.  Without this option the two instruction sets cannot
6204 be reliably used inside one program.  The default is
6205 @option{-mno-thumb-interwork}, since slightly larger code is generated
6206 when @option{-mthumb-interwork} is specified.
6208 @item -mno-sched-prolog
6209 @opindex mno-sched-prolog
6210 Prevent the reordering of instructions in the function prolog, or the
6211 merging of those instruction with the instructions in the function's
6212 body.  This means that all functions will start with a recognizable set
6213 of instructions (or in fact one of a choice from a small set of
6214 different function prologues), and this information can be used to
6215 locate the start if functions inside an executable piece of code.  The
6216 default is @option{-msched-prolog}.
6218 @item -mhard-float
6219 @opindex mhard-float
6220 Generate output containing floating point instructions.  This is the
6221 default.
6223 @item -msoft-float
6224 @opindex msoft-float
6225 Generate output containing library calls for floating point.
6226 @strong{Warning:} the requisite libraries are not available for all ARM
6227 targets.  Normally the facilities of the machine's usual C compiler are
6228 used, but this cannot be done directly in cross-compilation.  You must make
6229 your own arrangements to provide suitable library functions for
6230 cross-compilation.
6232 @option{-msoft-float} changes the calling convention in the output file;
6233 therefore, it is only useful if you compile @emph{all} of a program with
6234 this option.  In particular, you need to compile @file{libgcc.a}, the
6235 library that comes with GCC, with @option{-msoft-float} in order for
6236 this to work.
6238 @item -mlittle-endian
6239 @opindex mlittle-endian
6240 Generate code for a processor running in little-endian mode.  This is
6241 the default for all standard configurations.
6243 @item -mbig-endian
6244 @opindex mbig-endian
6245 Generate code for a processor running in big-endian mode; the default is
6246 to compile code for a little-endian processor.
6248 @item -mwords-little-endian
6249 @opindex mwords-little-endian
6250 This option only applies when generating code for big-endian processors.
6251 Generate code for a little-endian word order but a big-endian byte
6252 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6253 option should only be used if you require compatibility with code for
6254 big-endian ARM processors generated by versions of the compiler prior to
6255 2.8.
6257 @item -malignment-traps
6258 @opindex malignment-traps
6259 Generate code that will not trap if the MMU has alignment traps enabled.
6260 On ARM architectures prior to ARMv4, there were no instructions to
6261 access half-word objects stored in memory.  However, when reading from
6262 memory a feature of the ARM architecture allows a word load to be used,
6263 even if the address is unaligned, and the processor core will rotate the
6264 data as it is being loaded.  This option tells the compiler that such
6265 misaligned accesses will cause a MMU trap and that it should instead
6266 synthesize the access as a series of byte accesses.  The compiler can
6267 still use word accesses to load half-word data if it knows that the
6268 address is aligned to a word boundary.
6270 This option is ignored when compiling for ARM architecture 4 or later,
6271 since these processors have instructions to directly access half-word
6272 objects in memory.
6274 @item -mno-alignment-traps
6275 @opindex mno-alignment-traps
6276 Generate code that assumes that the MMU will not trap unaligned
6277 accesses.  This produces better code when the target instruction set
6278 does not have half-word memory operations (i.e.@: implementations prior to
6279 ARMv4).
6281 Note that you cannot use this option to access unaligned word objects,
6282 since the processor will only fetch one 32-bit aligned object from
6283 memory.
6285 The default setting for most targets is @option{-mno-alignment-traps}, since
6286 this produces better code when there are no half-word memory
6287 instructions available.
6289 @item -mshort-load-bytes
6290 @itemx -mno-short-load-words
6291 @opindex mshort-load-bytes
6292 @opindex mno-short-load-words
6293 These are deprecated aliases for @option{-malignment-traps}.
6295 @item -mno-short-load-bytes
6296 @itemx -mshort-load-words
6297 @opindex mno-short-load-bytes
6298 @opindex mshort-load-words
6299 This are deprecated aliases for @option{-mno-alignment-traps}.
6301 @item -mcpu=@var{name}
6302 @opindex mcpu
6303 This specifies the name of the target ARM processor.  GCC uses this name
6304 to determine what kind of instructions it can emit when generating
6305 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6306 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6307 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6308 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6309 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6310 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6311 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6312 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6313 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6314 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6316 @itemx -mtune=@var{name}
6317 @opindex mtune
6318 This option is very similar to the @option{-mcpu=} option, except that
6319 instead of specifying the actual target processor type, and hence
6320 restricting which instructions can be used, it specifies that GCC should
6321 tune the performance of the code as if the target were of the type
6322 specified in this option, but still choosing the instructions that it
6323 will generate based on the cpu specified by a @option{-mcpu=} option.
6324 For some ARM implementations better performance can be obtained by using
6325 this option.
6327 @item -march=@var{name}
6328 @opindex march
6329 This specifies the name of the target ARM architecture.  GCC uses this
6330 name to determine what kind of instructions it can emit when generating
6331 assembly code.  This option can be used in conjunction with or instead
6332 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6333 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6334 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6336 @item -mfpe=@var{number}
6337 @itemx -mfp=@var{number}
6338 @opindex mfpe
6339 @opindex mfp
6340 This specifies the version of the floating point emulation available on
6341 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6342 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6344 @item -mstructure-size-boundary=@var{n}
6345 @opindex mstructure-size-boundary
6346 The size of all structures and unions will be rounded up to a multiple
6347 of the number of bits set by this option.  Permissible values are 8 and
6348 32.  The default value varies for different toolchains.  For the COFF
6349 targeted toolchain the default value is 8.  Specifying the larger number
6350 can produce faster, more efficient code, but can also increase the size
6351 of the program.  The two values are potentially incompatible.  Code
6352 compiled with one value cannot necessarily expect to work with code or
6353 libraries compiled with the other value, if they exchange information
6354 using structures or unions.
6356 @item -mabort-on-noreturn
6357 @opindex mabort-on-noreturn
6358 Generate a call to the function @code{abort} at the end of a
6359 @code{noreturn} function.  It will be executed if the function tries to
6360 return.
6362 @item -mlong-calls
6363 @itemx -mno-long-calls
6364 @opindex mlong-calls
6365 @opindex mno-long-calls
6366 Tells the compiler to perform function calls by first loading the
6367 address of the function into a register and then performing a subroutine
6368 call on this register.  This switch is needed if the target function
6369 will lie outside of the 64 megabyte addressing range of the offset based
6370 version of subroutine call instruction.
6372 Even if this switch is enabled, not all function calls will be turned
6373 into long calls.  The heuristic is that static functions, functions
6374 which have the @samp{short-call} attribute, functions that are inside
6375 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6376 definitions have already been compiled within the current compilation
6377 unit, will not be turned into long calls.  The exception to this rule is
6378 that weak function definitions, functions with the @samp{long-call}
6379 attribute or the @samp{section} attribute, and functions that are within
6380 the scope of a @samp{#pragma long_calls} directive, will always be
6381 turned into long calls.
6383 This feature is not enabled by default.  Specifying
6384 @option{-mno-long-calls} will restore the default behavior, as will
6385 placing the function calls within the scope of a @samp{#pragma
6386 long_calls_off} directive.  Note these switches have no effect on how
6387 the compiler generates code to handle function calls via function
6388 pointers.
6390 @item -mnop-fun-dllimport
6391 @opindex mnop-fun-dllimport
6392 Disable support for the @code{dllimport} attribute.
6394 @item -msingle-pic-base
6395 @opindex msingle-pic-base
6396 Treat the register used for PIC addressing as read-only, rather than
6397 loading it in the prologue for each function.  The run-time system is
6398 responsible for initializing this register with an appropriate value
6399 before execution begins.
6401 @item -mpic-register=@var{reg}
6402 @opindex mpic-register
6403 Specify the register to be used for PIC addressing.  The default is R10
6404 unless stack-checking is enabled, when R9 is used.
6406 @item -mcirrus-fix-invalid-insns
6407 @opindex -mcirrus-fix-invalid-insns
6408 @opindex -mno-cirrus-fix-invalid-insns
6409 Insert NOPs into the instruction stream to in order to work around
6410 problems with invalid Maverick instruction combinations.  This option
6411 is only valid if the @option{-mcpu=ep9312} option has been used to
6412 enable generation of instructions for the Cirrus Maverick floating
6413 point co-processor.  This option is not enabled by default, since the
6414 problem is only present in older Maverick implementations.  The default
6415 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6416 switch.
6418 @item -mpoke-function-name
6419 @opindex mpoke-function-name
6420 Write the name of each function into the text section, directly
6421 preceding the function prologue.  The generated code is similar to this:
6423 @smallexample
6424      t0
6425          .ascii "arm_poke_function_name", 0
6426          .align
6427      t1
6428          .word 0xff000000 + (t1 - t0)
6429      arm_poke_function_name
6430          mov     ip, sp
6431          stmfd   sp!, @{fp, ip, lr, pc@}
6432          sub     fp, ip, #4
6433 @end smallexample
6435 When performing a stack backtrace, code can inspect the value of
6436 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6437 location @code{pc - 12} and the top 8 bits are set, then we know that
6438 there is a function name embedded immediately preceding this location
6439 and has length @code{((pc[-3]) & 0xff000000)}.
6441 @item -mthumb
6442 @opindex mthumb
6443 Generate code for the 16-bit Thumb instruction set.  The default is to
6444 use the 32-bit ARM instruction set.
6446 @item -mtpcs-frame
6447 @opindex mtpcs-frame
6448 Generate a stack frame that is compliant with the Thumb Procedure Call
6449 Standard for all non-leaf functions.  (A leaf function is one that does
6450 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6452 @item -mtpcs-leaf-frame
6453 @opindex mtpcs-leaf-frame
6454 Generate a stack frame that is compliant with the Thumb Procedure Call
6455 Standard for all leaf functions.  (A leaf function is one that does
6456 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6458 @item -mcallee-super-interworking
6459 @opindex mcallee-super-interworking
6460 Gives all externally visible functions in the file being compiled an ARM
6461 instruction set header which switches to Thumb mode before executing the
6462 rest of the function.  This allows these functions to be called from
6463 non-interworking code.
6465 @item -mcaller-super-interworking
6466 @opindex mcaller-super-interworking
6467 Allows calls via function pointers (including virtual functions) to
6468 execute correctly regardless of whether the target code has been
6469 compiled for interworking or not.  There is a small overhead in the cost
6470 of executing a function pointer if this option is enabled.
6472 @end table
6474 @node MN10200 Options
6475 @subsection MN10200 Options
6476 @cindex MN10200 options
6478 These @option{-m} options are defined for Matsushita MN10200 architectures:
6479 @table @gcctabopt
6481 @item -mrelax
6482 @opindex mrelax
6483 Indicate to the linker that it should perform a relaxation optimization pass
6484 to shorten branches, calls and absolute memory addresses.  This option only
6485 has an effect when used on the command line for the final link step.
6487 This option makes symbolic debugging impossible.
6488 @end table
6490 @node MN10300 Options
6491 @subsection MN10300 Options
6492 @cindex MN10300 options
6494 These @option{-m} options are defined for Matsushita MN10300 architectures:
6496 @table @gcctabopt
6497 @item -mmult-bug
6498 @opindex mmult-bug
6499 Generate code to avoid bugs in the multiply instructions for the MN10300
6500 processors.  This is the default.
6502 @item -mno-mult-bug
6503 @opindex mno-mult-bug
6504 Do not generate code to avoid bugs in the multiply instructions for the
6505 MN10300 processors.
6507 @item -mam33
6508 @opindex mam33
6509 Generate code which uses features specific to the AM33 processor.
6511 @item -mno-am33
6512 @opindex mno-am33
6513 Do not generate code which uses features specific to the AM33 processor.  This
6514 is the default.
6516 @item -mno-crt0
6517 @opindex mno-crt0
6518 Do not link in the C run-time initialization object file.
6520 @item -mrelax
6521 @opindex mrelax
6522 Indicate to the linker that it should perform a relaxation optimization pass
6523 to shorten branches, calls and absolute memory addresses.  This option only
6524 has an effect when used on the command line for the final link step.
6526 This option makes symbolic debugging impossible.
6527 @end table
6530 @node M32R/D Options
6531 @subsection M32R/D Options
6532 @cindex M32R/D options
6534 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6536 @table @gcctabopt
6537 @item -m32rx
6538 @opindex m32rx
6539 Generate code for the M32R/X@.
6541 @item -m32r
6542 @opindex m32r
6543 Generate code for the M32R@.  This is the default.
6545 @item -mcode-model=small
6546 @opindex mcode-model=small
6547 Assume all objects live in the lower 16MB of memory (so that their addresses
6548 can be loaded with the @code{ld24} instruction), and assume all subroutines
6549 are reachable with the @code{bl} instruction.
6550 This is the default.
6552 The addressability of a particular object can be set with the
6553 @code{model} attribute.
6555 @item -mcode-model=medium
6556 @opindex mcode-model=medium
6557 Assume objects may be anywhere in the 32-bit address space (the compiler
6558 will generate @code{seth/add3} instructions to load their addresses), and
6559 assume all subroutines are reachable with the @code{bl} instruction.
6561 @item -mcode-model=large
6562 @opindex mcode-model=large
6563 Assume objects may be anywhere in the 32-bit address space (the compiler
6564 will generate @code{seth/add3} instructions to load their addresses), and
6565 assume subroutines may not be reachable with the @code{bl} instruction
6566 (the compiler will generate the much slower @code{seth/add3/jl}
6567 instruction sequence).
6569 @item -msdata=none
6570 @opindex msdata=none
6571 Disable use of the small data area.  Variables will be put into
6572 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6573 @code{section} attribute has been specified).
6574 This is the default.
6576 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6577 Objects may be explicitly put in the small data area with the
6578 @code{section} attribute using one of these sections.
6580 @item -msdata=sdata
6581 @opindex msdata=sdata
6582 Put small global and static data in the small data area, but do not
6583 generate special code to reference them.
6585 @item -msdata=use
6586 @opindex msdata=use
6587 Put small global and static data in the small data area, and generate
6588 special instructions to reference them.
6590 @item -G @var{num}
6591 @opindex G
6592 @cindex smaller data references
6593 Put global and static objects less than or equal to @var{num} bytes
6594 into the small data or bss sections instead of the normal data or bss
6595 sections.  The default value of @var{num} is 8.
6596 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6597 for this option to have any effect.
6599 All modules should be compiled with the same @option{-G @var{num}} value.
6600 Compiling with different values of @var{num} may or may not work; if it
6601 doesn't the linker will give an error message---incorrect code will not be
6602 generated.
6604 @end table
6606 @node M88K Options
6607 @subsection M88K Options
6608 @cindex M88k options
6610 These @samp{-m} options are defined for Motorola 88k architectures:
6612 @table @gcctabopt
6613 @item -m88000
6614 @opindex m88000
6615 Generate code that works well on both the m88100 and the
6616 m88110.
6618 @item -m88100
6619 @opindex m88100
6620 Generate code that works best for the m88100, but that also
6621 runs on the m88110.
6623 @item -m88110
6624 @opindex m88110
6625 Generate code that works best for the m88110, and may not run
6626 on the m88100.
6628 @item -mbig-pic
6629 @opindex mbig-pic
6630 Obsolete option to be removed from the next revision.
6631 Use @option{-fPIC}.
6633 @item -midentify-revision
6634 @opindex midentify-revision
6635 @cindex identifying source, compiler (88k)
6636 Include an @code{ident} directive in the assembler output recording the
6637 source file name, compiler name and version, timestamp, and compilation
6638 flags used.
6640 @item -mno-underscores
6641 @opindex mno-underscores
6642 @cindex underscores, avoiding (88k)
6643 In assembler output, emit symbol names without adding an underscore
6644 character at the beginning of each name.  The default is to use an
6645 underscore as prefix on each name.
6647 @item -mocs-debug-info
6648 @itemx -mno-ocs-debug-info
6649 @opindex mocs-debug-info
6650 @opindex mno-ocs-debug-info
6651 @cindex OCS (88k)
6652 @cindex debugging, 88k OCS
6653 Include (or omit) additional debugging information (about registers used
6654 in each stack frame) as specified in the 88open Object Compatibility
6655 Standard, ``OCS''@.  This extra information allows debugging of code that
6656 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6657 SVr3.2 is to include this information; other 88k configurations omit this
6658 information by default.
6660 @item -mocs-frame-position
6661 @opindex mocs-frame-position
6662 @cindex register positions in frame (88k)
6663 When emitting COFF debugging information for automatic variables and
6664 parameters stored on the stack, use the offset from the canonical frame
6665 address, which is the stack pointer (register 31) on entry to the
6666 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6667 @option{-mocs-frame-position}; other 88k configurations have the default
6668 @option{-mno-ocs-frame-position}.
6670 @item -mno-ocs-frame-position
6671 @opindex mno-ocs-frame-position
6672 @cindex register positions in frame (88k)
6673 When emitting COFF debugging information for automatic variables and
6674 parameters stored on the stack, use the offset from the frame pointer
6675 register (register 30).  When this option is in effect, the frame
6676 pointer is not eliminated when debugging information is selected by the
6677 -g switch.
6679 @item -moptimize-arg-area
6680 @opindex moptimize-arg-area
6681 @cindex arguments in frame (88k)
6682 Save space by reorganizing the stack frame.  This option generates code
6683 that does not agree with the 88open specifications, but uses less
6684 memory.
6686 @itemx -mno-optimize-arg-area
6687 @opindex mno-optimize-arg-area
6688 Do not reorganize the stack frame to save space.  This is the default.
6689 The generated conforms to the specification, but uses more memory.
6691 @item -mshort-data-@var{num}
6692 @opindex mshort-data
6693 @cindex smaller data references (88k)
6694 @cindex r0-relative references (88k)
6695 Generate smaller data references by making them relative to @code{r0},
6696 which allows loading a value using a single instruction (rather than the
6697 usual two).  You control which data references are affected by
6698 specifying @var{num} with this option.  For example, if you specify
6699 @option{-mshort-data-512}, then the data references affected are those
6700 involving displacements of less than 512 bytes.
6701 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6702 than 64k.
6704 @item -mserialize-volatile
6705 @opindex mserialize-volatile
6706 @itemx -mno-serialize-volatile
6707 @opindex mno-serialize-volatile
6708 @cindex sequential consistency on 88k
6709 Do, or don't, generate code to guarantee sequential consistency
6710 of volatile memory references.  By default, consistency is
6711 guaranteed.
6713 The order of memory references made by the MC88110 processor does
6714 not always match the order of the instructions requesting those
6715 references.  In particular, a load instruction may execute before
6716 a preceding store instruction.  Such reordering violates
6717 sequential consistency of volatile memory references, when there
6718 are multiple processors.   When consistency must be guaranteed,
6719 GCC generates special instructions, as needed, to force
6720 execution in the proper order.
6722 The MC88100 processor does not reorder memory references and so
6723 always provides sequential consistency.  However, by default, GCC
6724 generates the special instructions to guarantee consistency
6725 even when you use @option{-m88100}, so that the code may be run on an
6726 MC88110 processor.  If you intend to run your code only on the
6727 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6729 The extra code generated to guarantee consistency may affect the
6730 performance of your application.  If you know that you can safely
6731 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6733 @item -msvr4
6734 @itemx -msvr3
6735 @opindex msvr4
6736 @opindex msvr3
6737 @cindex assembler syntax, 88k
6738 @cindex SVr4
6739 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6740 related to System V release 4 (SVr4).  This controls the following:
6742 @enumerate
6743 @item
6744 Which variant of the assembler syntax to emit.
6745 @item
6746 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6747 that is used on System V release 4.
6748 @item
6749 @option{-msvr4} makes GCC issue additional declaration directives used in
6750 SVr4.
6751 @end enumerate
6753 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6754 @option{-msvr3} is the default for all other m88k configurations.
6756 @item -mversion-03.00
6757 @opindex mversion-03.00
6758 This option is obsolete, and is ignored.
6759 @c ??? which asm syntax better for GAS?  option there too?
6761 @item -mno-check-zero-division
6762 @itemx -mcheck-zero-division
6763 @opindex mno-check-zero-division
6764 @opindex mcheck-zero-division
6765 @cindex zero division on 88k
6766 Do, or don't, generate code to guarantee that integer division by
6767 zero will be detected.  By default, detection is guaranteed.
6769 Some models of the MC88100 processor fail to trap upon integer
6770 division by zero under certain conditions.  By default, when
6771 compiling code that might be run on such a processor, GCC
6772 generates code that explicitly checks for zero-valued divisors
6773 and traps with exception number 503 when one is detected.  Use of
6774 @option{-mno-check-zero-division} suppresses such checking for code
6775 generated to run on an MC88100 processor.
6777 GCC assumes that the MC88110 processor correctly detects all instances
6778 of integer division by zero.  When @option{-m88110} is specified, no
6779 explicit checks for zero-valued divisors are generated, and both
6780 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6781 ignored.
6783 @item -muse-div-instruction
6784 @opindex muse-div-instruction
6785 @cindex divide instruction, 88k
6786 Use the div instruction for signed integer division on the
6787 MC88100 processor.  By default, the div instruction is not used.
6789 On the MC88100 processor the signed integer division instruction
6790 div) traps to the operating system on a negative operand.  The
6791 operating system transparently completes the operation, but at a
6792 large cost in execution time.  By default, when compiling code
6793 that might be run on an MC88100 processor, GCC emulates signed
6794 integer division using the unsigned integer division instruction
6795 divu), thereby avoiding the large penalty of a trap to the
6796 operating system.  Such emulation has its own, smaller, execution
6797 cost in both time and space.  To the extent that your code's
6798 important signed integer division operations are performed on two
6799 nonnegative operands, it may be desirable to use the div
6800 instruction directly.
6802 On the MC88110 processor the div instruction (also known as the
6803 divs instruction) processes negative operands without trapping to
6804 the operating system.  When @option{-m88110} is specified,
6805 @option{-muse-div-instruction} is ignored, and the div instruction is used
6806 for signed integer division.
6808 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6809 particular, the behavior of such a division with and without
6810 @option{-muse-div-instruction} may differ.
6812 @item -mtrap-large-shift
6813 @itemx -mhandle-large-shift
6814 @opindex mtrap-large-shift
6815 @opindex mhandle-large-shift
6816 @cindex bit shift overflow (88k)
6817 @cindex large bit shifts (88k)
6818 Include code to detect bit-shifts of more than 31 bits; respectively,
6819 trap such shifts or emit code to handle them properly.  By default GCC
6820 makes no special provision for large bit shifts.
6822 @item -mwarn-passed-structs
6823 @opindex mwarn-passed-structs
6824 @cindex structure passing (88k)
6825 Warn when a function passes a struct as an argument or result.
6826 Structure-passing conventions have changed during the evolution of the C
6827 language, and are often the source of portability problems.  By default,
6828 GCC issues no such warning.
6829 @end table
6831 @c break page here to avoid unsightly interparagraph stretch.
6832 @c -zw, 2001-8-17
6833 @page
6835 @node RS/6000 and PowerPC Options
6836 @subsection IBM RS/6000 and PowerPC Options
6837 @cindex RS/6000 and PowerPC Options
6838 @cindex IBM RS/6000 and PowerPC Options
6840 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6841 @table @gcctabopt
6842 @item -mpower
6843 @itemx -mno-power
6844 @itemx -mpower2
6845 @itemx -mno-power2
6846 @itemx -mpowerpc
6847 @itemx -mno-powerpc
6848 @itemx -mpowerpc-gpopt
6849 @itemx -mno-powerpc-gpopt
6850 @itemx -mpowerpc-gfxopt
6851 @itemx -mno-powerpc-gfxopt
6852 @itemx -mpowerpc64
6853 @itemx -mno-powerpc64
6854 @opindex mpower
6855 @opindex mno-power
6856 @opindex mpower2
6857 @opindex mno-power2
6858 @opindex mpowerpc
6859 @opindex mno-powerpc
6860 @opindex mpowerpc-gpopt
6861 @opindex mno-powerpc-gpopt
6862 @opindex mpowerpc-gfxopt
6863 @opindex mno-powerpc-gfxopt
6864 @opindex mpowerpc64
6865 @opindex mno-powerpc64
6866 GCC supports two related instruction set architectures for the
6867 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6868 instructions supported by the @samp{rios} chip set used in the original
6869 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6870 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6871 the IBM 4xx microprocessors.
6873 Neither architecture is a subset of the other.  However there is a
6874 large common subset of instructions supported by both.  An MQ
6875 register is included in processors supporting the POWER architecture.
6877 You use these options to specify which instructions are available on the
6878 processor you are using.  The default value of these options is
6879 determined when configuring GCC@.  Specifying the
6880 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6881 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6882 rather than the options listed above.
6884 The @option{-mpower} option allows GCC to generate instructions that
6885 are found only in the POWER architecture and to use the MQ register.
6886 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6887 to generate instructions that are present in the POWER2 architecture but
6888 not the original POWER architecture.
6890 The @option{-mpowerpc} option allows GCC to generate instructions that
6891 are found only in the 32-bit subset of the PowerPC architecture.
6892 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6893 GCC to use the optional PowerPC architecture instructions in the
6894 General Purpose group, including floating-point square root.  Specifying
6895 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6896 use the optional PowerPC architecture instructions in the Graphics
6897 group, including floating-point select.
6899 The @option{-mpowerpc64} option allows GCC to generate the additional
6900 64-bit instructions that are found in the full PowerPC64 architecture
6901 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6902 @option{-mno-powerpc64}.
6904 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6905 will use only the instructions in the common subset of both
6906 architectures plus some special AIX common-mode calls, and will not use
6907 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6908 permits GCC to use any instruction from either architecture and to
6909 allow use of the MQ register; specify this for the Motorola MPC601.
6911 @item -mnew-mnemonics
6912 @itemx -mold-mnemonics
6913 @opindex mnew-mnemonics
6914 @opindex mold-mnemonics
6915 Select which mnemonics to use in the generated assembler code.  With
6916 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6917 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6918 assembler mnemonics defined for the POWER architecture.  Instructions
6919 defined in only one architecture have only one mnemonic; GCC uses that
6920 mnemonic irrespective of which of these options is specified.
6922 GCC defaults to the mnemonics appropriate for the architecture in
6923 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6924 value of these option.  Unless you are building a cross-compiler, you
6925 should normally not specify either @option{-mnew-mnemonics} or
6926 @option{-mold-mnemonics}, but should instead accept the default.
6928 @item -mcpu=@var{cpu_type}
6929 @opindex mcpu
6930 Set architecture type, register usage, choice of mnemonics, and
6931 instruction scheduling parameters for machine type @var{cpu_type}.
6932 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6933 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6934 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6935 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6936 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6937 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6939 @option{-mcpu=common} selects a completely generic processor.  Code
6940 generated under this option will run on any POWER or PowerPC processor.
6941 GCC will use only the instructions in the common subset of both
6942 architectures, and will not use the MQ register.  GCC assumes a generic
6943 processor model for scheduling purposes.
6945 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6946 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6947 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6948 types, with an appropriate, generic processor model assumed for
6949 scheduling purposes.
6951 The other options specify a specific processor.  Code generated under
6952 those options will run best on that processor, and may not run at all on
6953 others.
6955 The @option{-mcpu} options automatically enable or disable other
6956 @option{-m} options as follows:
6958 @table @samp
6959 @item common
6960 @option{-mno-power}, @option{-mno-powerpc}
6962 @item power
6963 @itemx power2
6964 @itemx rios1
6965 @itemx rios2
6966 @itemx rsc
6967 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6969 @item powerpc
6970 @itemx rs64a
6971 @itemx 602
6972 @itemx 603
6973 @itemx 603e
6974 @itemx 604
6975 @itemx 620
6976 @itemx 630
6977 @itemx 740
6978 @itemx 7400
6979 @itemx 7450
6980 @itemx 750
6981 @itemx 505
6982 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6984 @item 601
6985 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6987 @item 403
6988 @itemx 821
6989 @itemx 860
6990 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6991 @end table
6993 @item -mtune=@var{cpu_type}
6994 @opindex mtune
6995 Set the instruction scheduling parameters for machine type
6996 @var{cpu_type}, but do not set the architecture type, register usage, or
6997 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6998 values for @var{cpu_type} are used for @option{-mtune} as for
6999 @option{-mcpu}.  If both are specified, the code generated will use the
7000 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7001 scheduling parameters set by @option{-mtune}.
7003 @item -maltivec
7004 @itemx -mno-altivec
7005 @opindex maltivec
7006 @opindex mno-altivec
7007 These switches enable or disable the use of built-in functions that
7008 allow access to the AltiVec instruction set.  You may also need to set
7009 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7010 enhancements.
7012 @item -mabi=spe
7013 @opindex mabi=spe
7014 Extend the current ABI with SPE ABI extensions.  This does not change
7015 the default ABI, instead it adds the SPE ABI extensions to the current
7016 ABI@.
7018 @item -mabi=no-spe
7019 @opindex mabi=no-spe
7020 Disable Booke SPE ABI extensions for the current ABI.
7022 @item -misel=@var{yes/no}
7023 @itemx -misel
7024 @opindex misel
7025 This switch enables or disables the generation of ISEL instructions.
7027 @item -mspe=@var{yes/no}
7028 @itemx -mspe
7029 @opindex mspe
7030 This switch enables or disables the generation of SPE simd
7031 instructions.
7033 @item -mfloat-gprs=@var{yes/no}
7034 @itemx -mfloat-gprs
7035 @opindex mfloat-gprs
7036 This switch enables or disables the generation of floating point
7037 operations on the general purpose registers for architectures that
7038 support it.  This option is currently only available on the MPC8540.
7040 @item -mfull-toc
7041 @itemx -mno-fp-in-toc
7042 @itemx -mno-sum-in-toc
7043 @itemx -mminimal-toc
7044 @opindex mfull-toc
7045 @opindex mno-fp-in-toc
7046 @opindex mno-sum-in-toc
7047 @opindex mminimal-toc
7048 Modify generation of the TOC (Table Of Contents), which is created for
7049 every executable file.  The @option{-mfull-toc} option is selected by
7050 default.  In that case, GCC will allocate at least one TOC entry for
7051 each unique non-automatic variable reference in your program.  GCC
7052 will also place floating-point constants in the TOC@.  However, only
7053 16,384 entries are available in the TOC@.
7055 If you receive a linker error message that saying you have overflowed
7056 the available TOC space, you can reduce the amount of TOC space used
7057 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7058 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7059 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7060 generate code to calculate the sum of an address and a constant at
7061 run-time instead of putting that sum into the TOC@.  You may specify one
7062 or both of these options.  Each causes GCC to produce very slightly
7063 slower and larger code at the expense of conserving TOC space.
7065 If you still run out of space in the TOC even when you specify both of
7066 these options, specify @option{-mminimal-toc} instead.  This option causes
7067 GCC to make only one TOC entry for every file.  When you specify this
7068 option, GCC will produce code that is slower and larger but which
7069 uses extremely little TOC space.  You may wish to use this option
7070 only on files that contain less frequently executed code.
7072 @item -maix64
7073 @itemx -maix32
7074 @opindex maix64
7075 @opindex maix32
7076 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7077 @code{long} type, and the infrastructure needed to support them.
7078 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7079 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7080 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7082 @item -mxl-call
7083 @itemx -mno-xl-call
7084 @opindex mxl-call
7085 @opindex mno-xl-call
7086 On AIX, pass floating-point arguments to prototyped functions beyond the
7087 register save area (RSA) on the stack in addition to argument FPRs.  The
7088 AIX calling convention was extended but not initially documented to
7089 handle an obscure K&R C case of calling a function that takes the
7090 address of its arguments with fewer arguments than declared.  AIX XL
7091 compilers access floating point arguments which do not fit in the
7092 RSA from the stack when a subroutine is compiled without
7093 optimization.  Because always storing floating-point arguments on the
7094 stack is inefficient and rarely needed, this option is not enabled by
7095 default and only is necessary when calling subroutines compiled by AIX
7096 XL compilers without optimization.
7098 @item -mpe
7099 @opindex mpe
7100 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7101 application written to use message passing with special startup code to
7102 enable the application to run.  The system must have PE installed in the
7103 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7104 must be overridden with the @option{-specs=} option to specify the
7105 appropriate directory location.  The Parallel Environment does not
7106 support threads, so the @option{-mpe} option and the @option{-pthread}
7107 option are incompatible.
7109 @item -msoft-float
7110 @itemx -mhard-float
7111 @opindex msoft-float
7112 @opindex mhard-float
7113 Generate code that does not use (uses) the floating-point register set.
7114 Software floating point emulation is provided if you use the
7115 @option{-msoft-float} option, and pass the option to GCC when linking.
7117 @item -mmultiple
7118 @itemx -mno-multiple
7119 @opindex mmultiple
7120 @opindex mno-multiple
7121 Generate code that uses (does not use) the load multiple word
7122 instructions and the store multiple word instructions.  These
7123 instructions are generated by default on POWER systems, and not
7124 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7125 endian PowerPC systems, since those instructions do not work when the
7126 processor is in little endian mode.  The exceptions are PPC740 and
7127 PPC750 which permit the instructions usage in little endian mode.
7129 @item -mstring
7130 @itemx -mno-string
7131 @opindex mstring
7132 @opindex mno-string
7133 Generate code that uses (does not use) the load string instructions
7134 and the store string word instructions to save multiple registers and
7135 do small block moves.  These instructions are generated by default on
7136 POWER systems, and not generated on PowerPC systems.  Do not use
7137 @option{-mstring} on little endian PowerPC systems, since those
7138 instructions do not work when the processor is in little endian mode.
7139 The exceptions are PPC740 and PPC750 which permit the instructions
7140 usage in little endian mode.
7142 @item -mupdate
7143 @itemx -mno-update
7144 @opindex mupdate
7145 @opindex mno-update
7146 Generate code that uses (does not use) the load or store instructions
7147 that update the base register to the address of the calculated memory
7148 location.  These instructions are generated by default.  If you use
7149 @option{-mno-update}, there is a small window between the time that the
7150 stack pointer is updated and the address of the previous frame is
7151 stored, which means code that walks the stack frame across interrupts or
7152 signals may get corrupted data.
7154 @item -mfused-madd
7155 @itemx -mno-fused-madd
7156 @opindex mfused-madd
7157 @opindex mno-fused-madd
7158 Generate code that uses (does not use) the floating point multiply and
7159 accumulate instructions.  These instructions are generated by default if
7160 hardware floating is used.
7162 @item -mno-bit-align
7163 @itemx -mbit-align
7164 @opindex mno-bit-align
7165 @opindex mbit-align
7166 On System V.4 and embedded PowerPC systems do not (do) force structures
7167 and unions that contain bit-fields to be aligned to the base type of the
7168 bit-field.
7170 For example, by default a structure containing nothing but 8
7171 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7172 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7173 the structure would be aligned to a 1 byte boundary and be one byte in
7174 size.
7176 @item -mno-strict-align
7177 @itemx -mstrict-align
7178 @opindex mno-strict-align
7179 @opindex mstrict-align
7180 On System V.4 and embedded PowerPC systems do not (do) assume that
7181 unaligned memory references will be handled by the system.
7183 @item -mrelocatable
7184 @itemx -mno-relocatable
7185 @opindex mrelocatable
7186 @opindex mno-relocatable
7187 On embedded PowerPC systems generate code that allows (does not allow)
7188 the program to be relocated to a different address at runtime.  If you
7189 use @option{-mrelocatable} on any module, all objects linked together must
7190 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7192 @item -mrelocatable-lib
7193 @itemx -mno-relocatable-lib
7194 @opindex mrelocatable-lib
7195 @opindex mno-relocatable-lib
7196 On embedded PowerPC systems generate code that allows (does not allow)
7197 the program to be relocated to a different address at runtime.  Modules
7198 compiled with @option{-mrelocatable-lib} can be linked with either modules
7199 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7200 with modules compiled with the @option{-mrelocatable} options.
7202 @item -mno-toc
7203 @itemx -mtoc
7204 @opindex mno-toc
7205 @opindex mtoc
7206 On System V.4 and embedded PowerPC systems do not (do) assume that
7207 register 2 contains a pointer to a global area pointing to the addresses
7208 used in the program.
7210 @item -mlittle
7211 @itemx -mlittle-endian
7212 @opindex mlittle
7213 @opindex mlittle-endian
7214 On System V.4 and embedded PowerPC systems compile code for the
7215 processor in little endian mode.  The @option{-mlittle-endian} option is
7216 the same as @option{-mlittle}.
7218 @item -mbig
7219 @itemx -mbig-endian
7220 @opindex mbig
7221 @opindex mbig-endian
7222 On System V.4 and embedded PowerPC systems compile code for the
7223 processor in big endian mode.  The @option{-mbig-endian} option is
7224 the same as @option{-mbig}.
7226 @item -mdynamic-no-pic
7227 @opindex mdynamic-no-pic
7228 On Darwin and Mac OS X systems, compile code so that it is not
7229 relocatable, but that its external references are relocatable.  The
7230 resulting code is suitable for applications, but not shared
7231 libraries.
7233 @item -mcall-sysv
7234 @opindex mcall-sysv
7235 On System V.4 and embedded PowerPC systems compile code using calling
7236 conventions that adheres to the March 1995 draft of the System V
7237 Application Binary Interface, PowerPC processor supplement.  This is the
7238 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7240 @item -mcall-sysv-eabi
7241 @opindex mcall-sysv-eabi
7242 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7244 @item -mcall-sysv-noeabi
7245 @opindex mcall-sysv-noeabi
7246 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7248 @item -mcall-solaris
7249 @opindex mcall-solaris
7250 On System V.4 and embedded PowerPC systems compile code for the Solaris
7251 operating system.
7253 @item -mcall-linux
7254 @opindex mcall-linux
7255 On System V.4 and embedded PowerPC systems compile code for the
7256 Linux-based GNU system.
7258 @item -mcall-gnu
7259 @opindex mcall-gnu
7260 On System V.4 and embedded PowerPC systems compile code for the
7261 Hurd-based GNU system.
7263 @item -mcall-netbsd
7264 @opindex mcall-netbsd
7265 On System V.4 and embedded PowerPC systems compile code for the
7266 NetBSD operating system.
7268 @item -maix-struct-return
7269 @opindex maix-struct-return
7270 Return all structures in memory (as specified by the AIX ABI)@.
7272 @item -msvr4-struct-return
7273 @opindex msvr4-struct-return
7274 Return structures smaller than 8 bytes in registers (as specified by the
7275 SVR4 ABI)@.
7277 @item -mabi=altivec
7278 @opindex mabi=altivec
7279 Extend the current ABI with AltiVec ABI extensions.  This does not
7280 change the default ABI, instead it adds the AltiVec ABI extensions to
7281 the current ABI@.
7283 @item -mabi=no-altivec
7284 @opindex mabi=no-altivec
7285 Disable AltiVec ABI extensions for the current ABI.
7287 @item -mprototype
7288 @itemx -mno-prototype
7289 @opindex mprototype
7290 @opindex mno-prototype
7291 On System V.4 and embedded PowerPC systems assume that all calls to
7292 variable argument functions are properly prototyped.  Otherwise, the
7293 compiler must insert an instruction before every non prototyped call to
7294 set or clear bit 6 of the condition code register (@var{CR}) to
7295 indicate whether floating point values were passed in the floating point
7296 registers in case the function takes a variable arguments.  With
7297 @option{-mprototype}, only calls to prototyped variable argument functions
7298 will set or clear the bit.
7300 @item -msim
7301 @opindex msim
7302 On embedded PowerPC systems, assume that the startup module is called
7303 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7304 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7305 configurations.
7307 @item -mmvme
7308 @opindex mmvme
7309 On embedded PowerPC systems, assume that the startup module is called
7310 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7311 @file{libc.a}.
7313 @item -mads
7314 @opindex mads
7315 On embedded PowerPC systems, assume that the startup module is called
7316 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7317 @file{libc.a}.
7319 @item -myellowknife
7320 @opindex myellowknife
7321 On embedded PowerPC systems, assume that the startup module is called
7322 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7323 @file{libc.a}.
7325 @item -mvxworks
7326 @opindex mvxworks
7327 On System V.4 and embedded PowerPC systems, specify that you are
7328 compiling for a VxWorks system.
7330 @item -mwindiss
7331 @opindex mwindiss
7332 Specify that you are compiling for the WindISS simulation environment.
7334 @item -memb
7335 @opindex memb
7336 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7337 header to indicate that @samp{eabi} extended relocations are used.
7339 @item -meabi
7340 @itemx -mno-eabi
7341 @opindex meabi
7342 @opindex mno-eabi
7343 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7344 Embedded Applications Binary Interface (eabi) which is a set of
7345 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7346 means that the stack is aligned to an 8 byte boundary, a function
7347 @code{__eabi} is called to from @code{main} to set up the eabi
7348 environment, and the @option{-msdata} option can use both @code{r2} and
7349 @code{r13} to point to two separate small data areas.  Selecting
7350 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7351 do not call an initialization function from @code{main}, and the
7352 @option{-msdata} option will only use @code{r13} to point to a single
7353 small data area.  The @option{-meabi} option is on by default if you
7354 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7356 @item -msdata=eabi
7357 @opindex msdata=eabi
7358 On System V.4 and embedded PowerPC systems, put small initialized
7359 @code{const} global and static data in the @samp{.sdata2} section, which
7360 is pointed to by register @code{r2}.  Put small initialized
7361 non-@code{const} global and static data in the @samp{.sdata} section,
7362 which is pointed to by register @code{r13}.  Put small uninitialized
7363 global and static data in the @samp{.sbss} section, which is adjacent to
7364 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7365 incompatible with the @option{-mrelocatable} option.  The
7366 @option{-msdata=eabi} option also sets the @option{-memb} option.
7368 @item -msdata=sysv
7369 @opindex msdata=sysv
7370 On System V.4 and embedded PowerPC systems, put small global and static
7371 data in the @samp{.sdata} section, which is pointed to by register
7372 @code{r13}.  Put small uninitialized global and static data in the
7373 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7374 The @option{-msdata=sysv} option is incompatible with the
7375 @option{-mrelocatable} option.
7377 @item -msdata=default
7378 @itemx -msdata
7379 @opindex msdata=default
7380 @opindex msdata
7381 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7382 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7383 same as @option{-msdata=sysv}.
7385 @item -msdata-data
7386 @opindex msdata-data
7387 On System V.4 and embedded PowerPC systems, put small global and static
7388 data in the @samp{.sdata} section.  Put small uninitialized global and
7389 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7390 to address small data however.  This is the default behavior unless
7391 other @option{-msdata} options are used.
7393 @item -msdata=none
7394 @itemx -mno-sdata
7395 @opindex msdata=none
7396 @opindex mno-sdata
7397 On embedded PowerPC systems, put all initialized global and static data
7398 in the @samp{.data} section, and all uninitialized data in the
7399 @samp{.bss} section.
7401 @item -G @var{num}
7402 @opindex G
7403 @cindex smaller data references (PowerPC)
7404 @cindex .sdata/.sdata2 references (PowerPC)
7405 On embedded PowerPC systems, put global and static items less than or
7406 equal to @var{num} bytes into the small data or bss sections instead of
7407 the normal data or bss section.  By default, @var{num} is 8.  The
7408 @option{-G @var{num}} switch is also passed to the linker.
7409 All modules should be compiled with the same @option{-G @var{num}} value.
7411 @item -mregnames
7412 @itemx -mno-regnames
7413 @opindex mregnames
7414 @opindex mno-regnames
7415 On System V.4 and embedded PowerPC systems do (do not) emit register
7416 names in the assembly language output using symbolic forms.
7418 @item -mlongcall
7419 @itemx -mno-longcall
7420 @opindex mlongcall
7421 @opindex mno-longcall
7422 Default to making all function calls via pointers, so that functions
7423 which reside further than 64 megabytes (67,108,864 bytes) from the
7424 current location can be called.  This setting can be overridden by the
7425 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7427 Some linkers are capable of detecting out-of-range calls and generating
7428 glue code on the fly.  On these systems, long calls are unnecessary and
7429 generate slower code.  As of this writing, the AIX linker can do this,
7430 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7431 to the GNU linker for 32-bit PowerPC systems as well.
7433 In the future, we may cause GCC to ignore all longcall specifications
7434 when the linker is known to generate glue.
7436 @item -pthread
7437 @opindex pthread
7438 Adds support for multithreading with the @dfn{pthreads} library.
7439 This option sets flags for both the preprocessor and linker.
7441 @end table
7443 @node Darwin Options
7444 @subsection Darwin Options
7445 @cindex Darwin options
7447 These options are defined for all architectures running the Darwin operating
7448 system.  They are useful for compatibility with other Mac OS compilers.
7450 @table @gcctabopt
7451 @item -all_load    
7452 @opindex all_load   
7453 Loads all members of static archive libraries.
7454 See man ld(1) for more information.
7456 @item -arch_errors_fatal
7457 @opindex arch_errors_fatal
7458 Cause the errors having to do with files that have the wrong architecture
7459 to be fatal.
7461 @item -bind_at_load
7462 @opindex bind_at_load
7463 Causes the output file to be marked such that the dynamic linker will
7464 bind all undefined references when the file is loaded or launched.
7466 @item -bundle     
7467 @opindex bundle
7468 Produce a Mach-o bundle format file.
7469 See man ld(1) for more information.
7471 @item -bundle_loader @var{executable}
7472 @opindex bundle_loader
7473 This specifies the @var{executable} that will be loading the build
7474 output file being linked. See man ld(1) for more information.
7476 @item -allowable_client  @var{client_name}
7477 @item -arch_only
7479 @item -client_name       
7480 @item -compatibility_version
7481 @item -current_version    
7482 @item -dependency-file
7483 @item -dylib_file    
7484 @item -dylinker_install_name
7485 @item -dynamic
7486 @item -dynamiclib   
7487 @item -exported_symbols_list  
7488 @item -filelist
7489 @item -flat_namespace   
7490 @item -force_cpusubtype_ALL
7491 @item -force_flat_namespace   
7492 @item -headerpad_max_install_names
7493 @item -image_base  
7494 @item -init
7495 @item -install_name
7496 @item -keep_private_externs
7497 @item -multi_module
7498 @item -multiply_defined      
7499 @item -multiply_defined_unused      
7500 @item -noall_load  
7501 @item -nomultidefs
7502 @item -noprebind     
7503 @item -noseglinkedit
7504 @item -pagezero_size    
7505 @item -prebind
7506 @item -prebind_all_twolevel_modules
7507 @item -private_bundle
7508 @item -read_only_relocs
7509 @item -sectalign  
7510 @item -sectobjectsymbols    
7511 @item -whyload
7512 @item -seg1addr 
7513 @item -sectcreate
7514 @item -sectobjectsymbols
7515 @item -sectorder
7516 @item -seg_addr_table
7517 @item -seg_addr_table_filename
7518 @item -seglinkedit
7519 @item -segprot   
7520 @item -segs_read_only_addr
7521 @item -segs_read_write_addr
7522 @item -single_module   
7523 @item -static
7524 @item -sub_library
7525 @item -sub_umbrella 
7526 @item -twolevel_namespace
7527 @item -umbrella
7528 @item -undefined
7529 @item -unexported_symbols_list
7530 @item -weak_reference_mismatches
7531 @item -whatsloaded  
7533 @opindex allowable_client
7534 @opindex arch_only    
7535 @opindex client_name
7536 @opindex compatibility_version
7537 @opindex current_version
7538 @opindex dependency-file
7539 @opindex dylib_file
7540 @opindex dylinker_install_name
7541 @opindex dynamic
7542 @opindex dynamiclib
7543 @opindex exported_symbols_list
7544 @opindex filelist  
7545 @opindex flat_namespace    
7546 @opindex force_cpusubtype_ALL
7547 @opindex force_flat_namespace
7548 @opindex headerpad_max_install_names
7549 @opindex image_base
7550 @opindex init     
7551 @opindex install_name
7552 @opindex keep_private_externs
7553 @opindex multi_module   
7554 @opindex multiply_defined
7555 @opindex multiply_defined_unused   
7556 @opindex noall_load  
7557 @opindex nomultidefs   
7558 @opindex noprebind
7559 @opindex noseglinkedit      
7560 @opindex pagezero_size
7561 @opindex prebind
7562 @opindex prebind_all_twolevel_modules
7563 @opindex private_bundle 
7564 @opindex read_only_relocs
7565 @opindex sectalign   
7566 @opindex sectobjectsymbols    
7567 @opindex whyload  
7568 @opindex seg1addr
7569 @opindex sectcreate       
7570 @opindex sectobjectsymbols 
7571 @opindex sectorder     
7572 @opindex seg_addr_table
7573 @opindex seg_addr_table_filename
7574 @opindex seglinkedit
7575 @opindex segprot
7576 @opindex segs_read_only_addr
7577 @opindex segs_read_write_addr
7578 @opindex single_module
7579 @opindex static
7580 @opindex sub_library
7581 @opindex sub_umbrella
7582 @opindex twolevel_namespace
7583 @opindex umbrella
7584 @opindex undefined
7585 @opindex unexported_symbols_list
7586 @opindex weak_reference_mismatches
7587 @opindex whatsloaded
7589 This options are available for Darwin linker. Darwin linker man page
7590 describes them in detail.
7591 @end table
7594 @node RT Options
7595 @subsection IBM RT Options
7596 @cindex RT options
7597 @cindex IBM RT options
7599 These @samp{-m} options are defined for the IBM RT PC:
7601 @table @gcctabopt
7602 @item -min-line-mul
7603 @opindex min-line-mul
7604 Use an in-line code sequence for integer multiplies.  This is the
7605 default.
7607 @item -mcall-lib-mul
7608 @opindex mcall-lib-mul
7609 Call @code{lmul$$} for integer multiples.
7611 @item -mfull-fp-blocks
7612 @opindex mfull-fp-blocks
7613 Generate full-size floating point data blocks, including the minimum
7614 amount of scratch space recommended by IBM@.  This is the default.
7616 @item -mminimum-fp-blocks
7617 @opindex mminimum-fp-blocks
7618 Do not include extra scratch space in floating point data blocks.  This
7619 results in smaller code, but slower execution, since scratch space must
7620 be allocated dynamically.
7622 @cindex @file{stdarg.h} and RT PC
7623 @item -mfp-arg-in-fpregs
7624 @opindex mfp-arg-in-fpregs
7625 Use a calling sequence incompatible with the IBM calling convention in
7626 which floating point arguments are passed in floating point registers.
7627 Note that @code{stdarg.h} will not work with floating point operands
7628 if this option is specified.
7630 @item -mfp-arg-in-gregs
7631 @opindex mfp-arg-in-gregs
7632 Use the normal calling convention for floating point arguments.  This is
7633 the default.
7635 @item -mhc-struct-return
7636 @opindex mhc-struct-return
7637 Return structures of more than one word in memory, rather than in a
7638 register.  This provides compatibility with the MetaWare HighC (hc)
7639 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7640 with the Portable C Compiler (pcc).
7642 @item -mnohc-struct-return
7643 @opindex mnohc-struct-return
7644 Return some structures of more than one word in registers, when
7645 convenient.  This is the default.  For compatibility with the
7646 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7647 option @option{-mhc-struct-return}.
7648 @end table
7650 @node MIPS Options
7651 @subsection MIPS Options
7652 @cindex MIPS options
7654 These @samp{-m} options are defined for the MIPS family of computers:
7656 @table @gcctabopt
7658 @item -march=@var{arch}
7659 @opindex march
7660 Generate code that will run on @var{arch}, which can be the name of a
7661 generic MIPS ISA, or the name of a particular processor.
7662 The ISA names are:
7663 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7664 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7665 The processor names are:
7666 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7667 @samp{m4k},
7668 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7669 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7670 @samp{orion},
7671 @samp{sb1},
7672 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7673 The special value @samp{from-abi} selects the
7674 most compatible architecture for the selected ABI (that is,
7675 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7677 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7678 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7679 @samp{vr} may be written @samp{r}.
7681 GCC defines two macros based on the value of this option.  The first
7682 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7683 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7684 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7685 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7686 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7688 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7689 above.  In other words, it will have the full prefix and will not
7690 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7691 the macro names the resolved architecture (either @samp{"mips1"} or
7692 @samp{"mips3"}).  It names the default architecture when no
7693 @option{-march} option is given.
7695 @item -mtune=@var{arch}
7696 @opindex mtune
7697 Optimize for @var{arch}.  Among other things, this option controls
7698 the way instructions are scheduled, and the perceived cost of arithmetic
7699 operations.  The list of @var{arch} values is the same as for
7700 @option{-march}.
7702 When this option is not used, GCC will optimize for the processor
7703 specified by @option{-march}.  By using @option{-march} and
7704 @option{-mtune} together, it is possible to generate code that will
7705 run on a family of processors, but optimize the code for one
7706 particular member of that family.
7708 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7709 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7710 @samp{-march} ones described above.
7712 @item -mips1
7713 @opindex mips1
7714 Equivalent to @samp{-march=mips1}.
7716 @item -mips2
7717 @opindex mips2
7718 Equivalent to @samp{-march=mips2}.
7720 @item -mips3
7721 @opindex mips3
7722 Equivalent to @samp{-march=mips3}.
7724 @item -mips4
7725 @opindex mips4
7726 Equivalent to @samp{-march=mips4}.
7728 @item -mips32
7729 @opindex mips32
7730 Equivalent to @samp{-march=mips32}.
7732 @item -mips32r2
7733 @opindex mips32r2
7734 Equivalent to @samp{-march=mips32r2}.
7736 @item -mips64
7737 @opindex mips64
7738 Equivalent to @samp{-march=mips64}.
7740 @item -mfused-madd
7741 @itemx -mno-fused-madd
7742 @opindex mfused-madd
7743 @opindex mno-fused-madd
7744 Generate code that uses (does not use) the floating point multiply and
7745 accumulate instructions, when they are available.  These instructions
7746 are generated by default if they are available, but this may be
7747 undesirable if the extra precision causes problems or on certain chips
7748 in the mode where denormals are rounded to zero where denormals
7749 generated by multiply and accumulate instructions cause exceptions
7750 anyway.
7752 @item -mfp32
7753 @opindex mfp32
7754 Assume that floating point registers are 32 bits wide.
7756 @item -mfp64
7757 @opindex mfp64
7758 Assume that floating point registers are 64 bits wide.
7760 @item -mgp32
7761 @opindex mgp32
7762 Assume that general purpose registers are 32 bits wide.
7764 @item -mgp64
7765 @opindex mgp64
7766 Assume that general purpose registers are 64 bits wide.
7768 @item -mint64
7769 @opindex mint64
7770 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7771 explanation of the default, and the width of pointers.
7773 @item -mlong64
7774 @opindex mlong64
7775 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7776 explanation of the default, and the width of pointers.
7778 @item -mlong32
7779 @opindex mlong32
7780 Force long, int, and pointer types to be 32 bits wide.
7782 The default size of ints, longs and pointers depends on the ABI@.  All
7783 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7784 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7785 are the same size as longs, or the same size as integer registers,
7786 whichever is smaller.
7788 @item -mabi=32
7789 @itemx -mabi=o64
7790 @itemx -mabi=n32
7791 @itemx -mabi=64
7792 @itemx -mabi=eabi
7793 @itemx -mabi=meabi
7794 @opindex mabi=32
7795 @opindex mabi=o64
7796 @opindex mabi=n32
7797 @opindex mabi=64
7798 @opindex mabi=eabi
7799 @opindex mabi=meabi
7800 Generate code for the given ABI@.
7802 Note that there are two embedded ABIs: @option{-mabi=eabi}
7803 selects the one defined by Cygnus while @option{-meabi=meabi}
7804 selects the one defined by MIPS@.  Both these ABIs have
7805 32-bit and 64-bit variants.  Normally, GCC will generate
7806 64-bit code when you select a 64-bit architecture, but you
7807 can use @option{-mgp32} to get 32-bit code instead.
7809 @item -mabi-fake-default
7810 @opindex mabi-fake-default
7811 You don't want to know what this option does.  No, really.  I mean
7812 it.  Move on to the next option.
7814 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7815 wants the default set of options to get the root of the multilib tree,
7816 and the shared library SONAMEs without any multilib-indicating
7817 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7818 we want to default to the N32 ABI, while still being binary-compatible
7819 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7820 binary-compatible means shared libraries should have the same SONAMEs,
7821 and libraries should live in the same location.  Having O32 libraries
7822 in a sub-directory named say @file{o32} is not acceptable.
7824 So we trick GCC into believing that O32 is the default ABI, except
7825 that we override the default with some internal command-line
7826 processing magic.  Problem is, if we stopped at that, and you then
7827 created a multilib-aware package that used the output of @command{gcc
7828 -print-multi-lib} to decide which multilibs to build, and how, and
7829 you'd find yourself in an awkward situation when you found out that
7830 some of the options listed ended up mapping to the same multilib, and
7831 none of your libraries was actually built for the multilib that
7832 @option{-print-multi-lib} claims to be the default.  So we added this
7833 option that disables the default switcher, falling back to GCC's
7834 original notion of the default library.  Confused yet?
7836 For short: don't ever use this option, unless you find it in the list
7837 of additional options to be used when building for multilibs, in the
7838 output of @option{gcc -print-multi-lib}.
7840 @item -mmips-as
7841 @opindex mmips-as
7842 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7843 add normal debug information.  This is the default for all
7844 platforms except for the OSF/1 reference platform, using the OSF/rose
7845 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7846 switches are used, the @file{mips-tfile} program will encapsulate the
7847 stabs within MIPS ECOFF@.
7849 @item -mgas
7850 @opindex mgas
7851 Generate code for the GNU assembler.  This is the default on the OSF/1
7852 reference platform, using the OSF/rose object format.  Also, this is
7853 the default if the configure option @option{--with-gnu-as} is used.
7855 @item -msplit-addresses
7856 @itemx -mno-split-addresses
7857 @opindex msplit-addresses
7858 @opindex mno-split-addresses
7859 Generate code to load the high and low parts of address constants separately.
7860 This allows GCC to optimize away redundant loads of the high order
7861 bits of addresses.  This optimization requires GNU as and GNU ld.
7862 This optimization is enabled by default for some embedded targets where
7863 GNU as and GNU ld are standard.
7865 @item -mrnames
7866 @itemx -mno-rnames
7867 @opindex mrnames
7868 @opindex mno-rnames
7869 The @option{-mrnames} switch says to output code using the MIPS software
7870 names for the registers, instead of the hardware names (ie, @var{a0}
7871 instead of @var{$4}).  The only known assembler that supports this option
7872 is the Algorithmics assembler.
7874 @item -mgpopt
7875 @itemx -mno-gpopt
7876 @opindex mgpopt
7877 @opindex mno-gpopt
7878 The @option{-mgpopt} switch says to write all of the data declarations
7879 before the instructions in the text section, this allows the MIPS
7880 assembler to generate one word memory references instead of using two
7881 words for short global or static data items.  This is on by default if
7882 optimization is selected.
7884 @item -mmemcpy
7885 @itemx -mno-memcpy
7886 @opindex mmemcpy
7887 @opindex mno-memcpy
7888 The @option{-mmemcpy} switch makes all block moves call the appropriate
7889 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7890 generating inline code.
7892 @item -mmips-tfile
7893 @itemx -mno-mips-tfile
7894 @opindex mmips-tfile
7895 @opindex mno-mips-tfile
7896 The @option{-mno-mips-tfile} switch causes the compiler not
7897 postprocess the object file with the @file{mips-tfile} program,
7898 after the MIPS assembler has generated it to add debug support.  If
7899 @file{mips-tfile} is not run, then no local variables will be
7900 available to the debugger.  In addition, @file{stage2} and
7901 @file{stage3} objects will have the temporary file names passed to the
7902 assembler embedded in the object file, which means the objects will
7903 not compare the same.  The @option{-mno-mips-tfile} switch should only
7904 be used when there are bugs in the @file{mips-tfile} program that
7905 prevents compilation.
7907 @item -msoft-float
7908 @opindex msoft-float
7909 Generate output containing library calls for floating point.
7910 @strong{Warning:} the requisite libraries are not part of GCC@.
7911 Normally the facilities of the machine's usual C compiler are used, but
7912 this can't be done directly in cross-compilation.  You must make your
7913 own arrangements to provide suitable library functions for
7914 cross-compilation.
7916 @item -mhard-float
7917 @opindex mhard-float
7918 Generate output containing floating point instructions.  This is the
7919 default if you use the unmodified sources.
7921 @item -mabicalls
7922 @itemx -mno-abicalls
7923 @opindex mabicalls
7924 @opindex mno-abicalls
7925 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7926 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7927 position independent code.
7929 @item -mlong-calls
7930 @itemx -mno-long-calls
7931 @opindex mlong-calls
7932 @opindex mno-long-calls
7933 Do all calls with the @samp{JALR} instruction, which requires
7934 loading up a function's address into a register before the call.
7935 You need to use this switch, if you call outside of the current
7936 512 megabyte segment to functions that are not through pointers.
7938 @item -mhalf-pic
7939 @itemx -mno-half-pic
7940 @opindex mhalf-pic
7941 @opindex mno-half-pic
7942 Put pointers to extern references into the data section and load them
7943 up, rather than put the references in the text section.
7945 @item -membedded-pic
7946 @itemx -mno-embedded-pic
7947 @opindex membedded-pic
7948 @opindex mno-embedded-pic
7949 Generate PIC code suitable for some embedded systems.  All calls are
7950 made using PC relative address, and all data is addressed using the $gp
7951 register.  No more than 65536 bytes of global data may be used.  This
7952 requires GNU as and GNU ld which do most of the work.  This currently
7953 only works on targets which use ECOFF; it does not work with ELF@.
7955 @item -membedded-data
7956 @itemx -mno-embedded-data
7957 @opindex membedded-data
7958 @opindex mno-embedded-data
7959 Allocate variables to the read-only data section first if possible, then
7960 next in the small data section if possible, otherwise in data.  This gives
7961 slightly slower code than the default, but reduces the amount of RAM required
7962 when executing, and thus may be preferred for some embedded systems.
7964 @item -muninit-const-in-rodata
7965 @itemx -mno-uninit-const-in-rodata
7966 @opindex muninit-const-in-rodata
7967 @opindex mno-uninit-const-in-rodata
7968 When used together with @option{-membedded-data}, it will always store uninitialized
7969 const variables in the read-only data section.
7971 @item -msingle-float
7972 @itemx -mdouble-float
7973 @opindex msingle-float
7974 @opindex mdouble-float
7975 The @option{-msingle-float} switch tells gcc to assume that the floating
7976 point coprocessor only supports single precision operations, as on the
7977 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7978 double precision operations.  This is the default.
7980 @item -mmad
7981 @itemx -mno-mad
7982 @opindex mmad
7983 @opindex mno-mad
7984 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7985 as on the @samp{r4650} chip.
7987 @item -m4650
7988 @opindex m4650
7989 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7990 @option{-mcpu=r4650}.
7992 @item -mips16
7993 @itemx -mno-mips16
7994 @opindex mips16
7995 @opindex mno-mips16
7996 Enable 16-bit instructions.
7998 @item -mentry
7999 @opindex mentry
8000 Use the entry and exit pseudo ops.  This option can only be used with
8001 @option{-mips16}.
8003 @item -EL
8004 @opindex EL
8005 Compile code for the processor in little endian mode.
8006 The requisite libraries are assumed to exist.
8008 @item -EB
8009 @opindex EB
8010 Compile code for the processor in big endian mode.
8011 The requisite libraries are assumed to exist.
8013 @item -G @var{num}
8014 @opindex G
8015 @cindex smaller data references (MIPS)
8016 @cindex gp-relative references (MIPS)
8017 Put global and static items less than or equal to @var{num} bytes into
8018 the small data or bss sections instead of the normal data or bss
8019 section.  This allows the assembler to emit one word memory reference
8020 instructions based on the global pointer (@var{gp} or @var{$28}),
8021 instead of the normal two words used.  By default, @var{num} is 8 when
8022 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8023 @option{-G @var{num}} switch is also passed to the assembler and linker.
8024 All modules should be compiled with the same @option{-G @var{num}}
8025 value.
8027 @item -nocpp
8028 @opindex nocpp
8029 Tell the MIPS assembler to not run its preprocessor over user
8030 assembler files (with a @samp{.s} suffix) when assembling them.
8032 @item -mfix7000
8033 @opindex mfix7000
8034 Pass an option to gas which will cause nops to be inserted if
8035 the read of the destination register of an mfhi or mflo instruction
8036 occurs in the following two instructions.
8038 @item -no-crt0
8039 @opindex no-crt0
8040 Do not include the default crt0.
8042 @item -mflush-func=@var{func}
8043 @itemx -mno-flush-func
8044 @opindex mflush-func
8045 Specifies the function to call to flush the I and D caches, or to not
8046 call any such function.  If called, the function must take the same
8047 arguments as the common @code{_flush_func()}, that is, the address of the
8048 memory range for which the cache is being flushed, the size of the
8049 memory range, and the number 3 (to flush both caches).  The default
8050 depends on the target gcc was configured for, but commonly is either
8051 @samp{_flush_func} or @samp{__cpu_flush}.
8053 @item -mbranch-likely
8054 @itemx -mno-branch-likely
8055 @opindex mbranch-likely
8056 @opindex mno-branch-likely
8057 Enable or disable use of Branch Likely instructions, regardless of the
8058 default for the selected architecture.  By default, Branch Likely
8059 instructions may be generated if they are supported by the selected
8060 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8061 and processors which implement those architectures; for those, Branch
8062 Likely instructions will not be generated by default because the MIPS32
8063 and MIPS64 architectures specifically deprecate their use.
8064 @end table
8066 @node i386 and x86-64 Options
8067 @subsection Intel 386 and AMD x86-64 Options
8068 @cindex i386 Options
8069 @cindex x86-64 Options
8070 @cindex Intel 386 Options
8071 @cindex AMD x86-64 Options
8073 These @samp{-m} options are defined for the i386 and x86-64 family of
8074 computers:
8076 @table @gcctabopt
8077 @item -mtune=@var{cpu-type}
8078 @opindex mtune
8079 Tune to @var{cpu-type} everything applicable about the generated code, except
8080 for the ABI and the set of available instructions.  The choices for
8081 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8082 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8083 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8084 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8085 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8086 and @samp{c3-2}.
8088 While picking a specific @var{cpu-type} will schedule things appropriately
8089 for that particular chip, the compiler will not generate any code that
8090 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8091 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8092 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8093 AMD chips as opposed to the Intel ones.
8095 @item -march=@var{cpu-type}
8096 @opindex march
8097 Generate instructions for the machine type @var{cpu-type}.  The choices
8098 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8099 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8101 @item -mcpu=@var{cpu-type}
8102 @opindex mcpu
8103 A deprecated synonym for @option{-mtune}.
8105 @item -m386
8106 @itemx -m486
8107 @itemx -mpentium
8108 @itemx -mpentiumpro
8109 @opindex m386
8110 @opindex m486
8111 @opindex mpentium
8112 @opindex mpentiumpro
8113 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8114 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8115 These synonyms are deprecated.
8117 @item -mfpmath=@var{unit}
8118 @opindex march
8119 generate floating point arithmetics for selected unit @var{unit}.  the choices
8120 for @var{unit} are:
8122 @table @samp
8123 @item 387
8124 Use the standard 387 floating point coprocessor present majority of chips and
8125 emulated otherwise.  Code compiled with this option will run almost everywhere.
8126 The temporary results are computed in 80bit precision instead of precision
8127 specified by the type resulting in slightly different results compared to most
8128 of other chips. See @option{-ffloat-store} for more detailed description.
8130 This is the default choice for i386 compiler.
8132 @item sse
8133 Use scalar floating point instructions present in the SSE instruction set.
8134 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8135 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8136 instruction set supports only single precision arithmetics, thus the double and
8137 extended precision arithmetics is still done using 387.  Later version, present
8138 only in Pentium4 and the future AMD x86-64 chips supports double precision
8139 arithmetics too.
8141 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8142 @option{-msse2} switches to enable SSE extensions and make this option
8143 effective.  For x86-64 compiler, these extensions are enabled by default.
8145 The resulting code should be considerably faster in majority of cases and avoid
8146 the numerical instability problems of 387 code, but may break some existing
8147 code that expects temporaries to be 80bit.
8149 This is the default choice for x86-64 compiler.
8151 @item sse,387
8152 Attempt to utilize both instruction sets at once.  This effectively double the
8153 amount of available registers and on chips with separate execution units for
8154 387 and SSE the execution resources too.  Use this option with care, as it is
8155 still experimental, because gcc register allocator does not model separate
8156 functional units well resulting in instable performance.
8157 @end table
8159 @item -masm=@var{dialect}
8160 @opindex masm=@var{dialect}
8161 Output asm instructions using selected @var{dialect}. Supported choices are
8162 @samp{intel} or @samp{att} (the default one).
8164 @item -mieee-fp
8165 @itemx -mno-ieee-fp
8166 @opindex mieee-fp
8167 @opindex mno-ieee-fp
8168 Control whether or not the compiler uses IEEE floating point
8169 comparisons.  These handle correctly the case where the result of a
8170 comparison is unordered.
8172 @item -msoft-float
8173 @opindex msoft-float
8174 Generate output containing library calls for floating point.
8175 @strong{Warning:} the requisite libraries are not part of GCC@.
8176 Normally the facilities of the machine's usual C compiler are used, but
8177 this can't be done directly in cross-compilation.  You must make your
8178 own arrangements to provide suitable library functions for
8179 cross-compilation.
8181 On machines where a function returns floating point results in the 80387
8182 register stack, some floating point opcodes may be emitted even if
8183 @option{-msoft-float} is used.
8185 @item -mno-fp-ret-in-387
8186 @opindex mno-fp-ret-in-387
8187 Do not use the FPU registers for return values of functions.
8189 The usual calling convention has functions return values of types
8190 @code{float} and @code{double} in an FPU register, even if there
8191 is no FPU@.  The idea is that the operating system should emulate
8192 an FPU@.
8194 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8195 in ordinary CPU registers instead.
8197 @item -mno-fancy-math-387
8198 @opindex mno-fancy-math-387
8199 Some 387 emulators do not support the @code{sin}, @code{cos} and
8200 @code{sqrt} instructions for the 387.  Specify this option to avoid
8201 generating those instructions.  This option is the default on FreeBSD,
8202 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8203 indicates that the target cpu will always have an FPU and so the
8204 instruction will not need emulation.  As of revision 2.6.1, these
8205 instructions are not generated unless you also use the
8206 @option{-funsafe-math-optimizations} switch.
8208 @item -malign-double
8209 @itemx -mno-align-double
8210 @opindex malign-double
8211 @opindex mno-align-double
8212 Control whether GCC aligns @code{double}, @code{long double}, and
8213 @code{long long} variables on a two word boundary or a one word
8214 boundary.  Aligning @code{double} variables on a two word boundary will
8215 produce code that runs somewhat faster on a @samp{Pentium} at the
8216 expense of more memory.
8218 @strong{Warning:} if you use the @option{-malign-double} switch,
8219 structures containing the above types will be aligned differently than
8220 the published application binary interface specifications for the 386
8221 and will not be binary compatible with structures in code compiled
8222 without that switch.
8224 @item -m128bit-long-double
8225 @opindex m128bit-long-double
8226 Control the size of @code{long double} type. i386 application binary interface
8227 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8228 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8229 impossible to reach with 12 byte long doubles in the array accesses.
8231 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8232 structures and arrays containing @code{long double} will change their size as
8233 well as function calling convention for function taking @code{long double}
8234 will be modified.
8236 @item -m96bit-long-double
8237 @opindex m96bit-long-double
8238 Set the size of @code{long double} to 96 bits as required by the i386
8239 application binary interface.  This is the default.
8241 @item -msvr3-shlib
8242 @itemx -mno-svr3-shlib
8243 @opindex msvr3-shlib
8244 @opindex mno-svr3-shlib
8245 Control whether GCC places uninitialized local variables into the
8246 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8247 into @code{bss}.  These options are meaningful only on System V Release 3.
8249 @item -mrtd
8250 @opindex mrtd
8251 Use a different function-calling convention, in which functions that
8252 take a fixed number of arguments return with the @code{ret} @var{num}
8253 instruction, which pops their arguments while returning.  This saves one
8254 instruction in the caller since there is no need to pop the arguments
8255 there.
8257 You can specify that an individual function is called with this calling
8258 sequence with the function attribute @samp{stdcall}.  You can also
8259 override the @option{-mrtd} option by using the function attribute
8260 @samp{cdecl}.  @xref{Function Attributes}.
8262 @strong{Warning:} this calling convention is incompatible with the one
8263 normally used on Unix, so you cannot use it if you need to call
8264 libraries compiled with the Unix compiler.
8266 Also, you must provide function prototypes for all functions that
8267 take variable numbers of arguments (including @code{printf});
8268 otherwise incorrect code will be generated for calls to those
8269 functions.
8271 In addition, seriously incorrect code will result if you call a
8272 function with too many arguments.  (Normally, extra arguments are
8273 harmlessly ignored.)
8275 @item -mregparm=@var{num}
8276 @opindex mregparm
8277 Control how many registers are used to pass integer arguments.  By
8278 default, no registers are used to pass arguments, and at most 3
8279 registers can be used.  You can control this behavior for a specific
8280 function by using the function attribute @samp{regparm}.
8281 @xref{Function Attributes}.
8283 @strong{Warning:} if you use this switch, and
8284 @var{num} is nonzero, then you must build all modules with the same
8285 value, including any libraries.  This includes the system libraries and
8286 startup modules.
8288 @item -mpreferred-stack-boundary=@var{num}
8289 @opindex mpreferred-stack-boundary
8290 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8291 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8292 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8293 size (@option{-Os}), in which case the default is the minimum correct
8294 alignment (4 bytes for x86, and 8 bytes for x86-64).
8296 On Pentium and PentiumPro, @code{double} and @code{long double} values
8297 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8298 suffer significant run time performance penalties.  On Pentium III, the
8299 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8300 penalties if it is not 16 byte aligned.
8302 To ensure proper alignment of this values on the stack, the stack boundary
8303 must be as aligned as that required by any value stored on the stack.
8304 Further, every function must be generated such that it keeps the stack
8305 aligned.  Thus calling a function compiled with a higher preferred
8306 stack boundary from a function compiled with a lower preferred stack
8307 boundary will most likely misalign the stack.  It is recommended that
8308 libraries that use callbacks always use the default setting.
8310 This extra alignment does consume extra stack space, and generally
8311 increases code size.  Code that is sensitive to stack space usage, such
8312 as embedded systems and operating system kernels, may want to reduce the
8313 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8315 @item -mmmx
8316 @itemx -mno-mmx
8317 @item -msse
8318 @itemx -mno-sse
8319 @item -msse2
8320 @itemx -mno-sse2
8321 @item -m3dnow
8322 @itemx -mno-3dnow
8323 @opindex mmmx
8324 @opindex mno-mmx
8325 @opindex msse
8326 @opindex mno-sse
8327 @opindex m3dnow
8328 @opindex mno-3dnow
8329 These switches enable or disable the use of built-in functions that allow
8330 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8332 @xref{X86 Built-in Functions}, for details of the functions enabled
8333 and disabled by these switches.
8335 To have SSE/SSE2 instructions generated automatically from floating-point
8336 code, see @option{-mfpmath=sse}.
8338 @item -mpush-args
8339 @itemx -mno-push-args
8340 @opindex mpush-args
8341 @opindex mno-push-args
8342 Use PUSH operations to store outgoing parameters.  This method is shorter
8343 and usually equally fast as method using SUB/MOV operations and is enabled
8344 by default.  In some cases disabling it may improve performance because of
8345 improved scheduling and reduced dependencies.
8347 @item -maccumulate-outgoing-args
8348 @opindex maccumulate-outgoing-args
8349 If enabled, the maximum amount of space required for outgoing arguments will be
8350 computed in the function prologue.  This is faster on most modern CPUs
8351 because of reduced dependencies, improved scheduling and reduced stack usage
8352 when preferred stack boundary is not equal to 2.  The drawback is a notable
8353 increase in code size.  This switch implies @option{-mno-push-args}.
8355 @item -mthreads
8356 @opindex mthreads
8357 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8358 on thread-safe exception handling must compile and link all code with the
8359 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8360 @option{-D_MT}; when linking, it links in a special thread helper library
8361 @option{-lmingwthrd} which cleans up per thread exception handling data.
8363 @item -mno-align-stringops
8364 @opindex mno-align-stringops
8365 Do not align destination of inlined string operations.  This switch reduces
8366 code size and improves performance in case the destination is already aligned,
8367 but gcc don't know about it.
8369 @item -minline-all-stringops
8370 @opindex minline-all-stringops
8371 By default GCC inlines string operations only when destination is known to be
8372 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8373 size, but may improve performance of code that depends on fast memcpy, strlen
8374 and memset for short lengths.
8376 @item -momit-leaf-frame-pointer
8377 @opindex momit-leaf-frame-pointer
8378 Don't keep the frame pointer in a register for leaf functions.  This
8379 avoids the instructions to save, set up and restore frame pointers and
8380 makes an extra register available in leaf functions.  The option
8381 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8382 which might make debugging harder.
8383 @end table
8385 These @samp{-m} switches are supported in addition to the above
8386 on AMD x86-64 processors in 64-bit environments.
8388 @table @gcctabopt
8389 @item -m32
8390 @itemx -m64
8391 @opindex m32
8392 @opindex m64
8393 Generate code for a 32-bit or 64-bit environment.
8394 The 32-bit environment sets int, long and pointer to 32 bits and
8395 generates code that runs on any i386 system.
8396 The 64-bit environment sets int to 32 bits and long and pointer
8397 to 64 bits and generates code for AMD's x86-64 architecture.
8399 @item -mno-red-zone
8400 @opindex no-red-zone
8401 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8402 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8403 stack pointer that will not be modified by signal or interrupt handlers
8404 and therefore can be used for temporary data without adjusting the stack
8405 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8407 @item -mcmodel=small
8408 @opindex mcmodel=small
8409 Generate code for the small code model: the program and its symbols must
8410 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8411 Programs can be statically or dynamically linked.  This is the default
8412 code model.
8414 @item -mcmodel=kernel
8415 @opindex mcmodel=kernel
8416 Generate code for the kernel code model.  The kernel runs in the
8417 negative 2 GB of the address space.
8418 This model has to be used for Linux kernel code.
8420 @item -mcmodel=medium
8421 @opindex mcmodel=medium
8422 Generate code for the medium model: The program is linked in the lower 2
8423 GB of the address space but symbols can be located anywhere in the
8424 address space.  Programs can be statically or dynamically linked, but
8425 building of shared libraries are not supported with the medium model.
8427 @item -mcmodel=large
8428 @opindex mcmodel=large
8429 Generate code for the large model: This model makes no assumptions
8430 about addresses and sizes of sections.  Currently GCC does not implement
8431 this model.
8432 @end table
8434 @node HPPA Options
8435 @subsection HPPA Options
8436 @cindex HPPA Options
8438 These @samp{-m} options are defined for the HPPA family of computers:
8440 @table @gcctabopt
8441 @item -march=@var{architecture-type}
8442 @opindex march
8443 Generate code for the specified architecture.  The choices for
8444 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8445 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8446 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8447 architecture option for your machine.  Code compiled for lower numbered
8448 architectures will run on higher numbered architectures, but not the
8449 other way around.
8451 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8452 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8453 support.
8455 @item -mpa-risc-1-0
8456 @itemx -mpa-risc-1-1
8457 @itemx -mpa-risc-2-0
8458 @opindex mpa-risc-1-0
8459 @opindex mpa-risc-1-1
8460 @opindex mpa-risc-2-0
8461 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8463 @item -mbig-switch
8464 @opindex mbig-switch
8465 Generate code suitable for big switch tables.  Use this option only if
8466 the assembler/linker complain about out of range branches within a switch
8467 table.
8469 @item -mjump-in-delay
8470 @opindex mjump-in-delay
8471 Fill delay slots of function calls with unconditional jump instructions
8472 by modifying the return pointer for the function call to be the target
8473 of the conditional jump.
8475 @item -mdisable-fpregs
8476 @opindex mdisable-fpregs
8477 Prevent floating point registers from being used in any manner.  This is
8478 necessary for compiling kernels which perform lazy context switching of
8479 floating point registers.  If you use this option and attempt to perform
8480 floating point operations, the compiler will abort.
8482 @item -mdisable-indexing
8483 @opindex mdisable-indexing
8484 Prevent the compiler from using indexing address modes.  This avoids some
8485 rather obscure problems when compiling MIG generated code under MACH@.
8487 @item -mno-space-regs
8488 @opindex mno-space-regs
8489 Generate code that assumes the target has no space registers.  This allows
8490 GCC to generate faster indirect calls and use unscaled index address modes.
8492 Such code is suitable for level 0 PA systems and kernels.
8494 @item -mfast-indirect-calls
8495 @opindex mfast-indirect-calls
8496 Generate code that assumes calls never cross space boundaries.  This
8497 allows GCC to emit code which performs faster indirect calls.
8499 This option will not work in the presence of shared libraries or nested
8500 functions.
8502 @item -mlong-load-store
8503 @opindex mlong-load-store
8504 Generate 3-instruction load and store sequences as sometimes required by
8505 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8506 the HP compilers.
8508 @item -mportable-runtime
8509 @opindex mportable-runtime
8510 Use the portable calling conventions proposed by HP for ELF systems.
8512 @item -mgas
8513 @opindex mgas
8514 Enable the use of assembler directives only GAS understands.
8516 @item -mschedule=@var{cpu-type}
8517 @opindex mschedule
8518 Schedule code according to the constraints for the machine type
8519 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8520 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8521 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8522 proper scheduling option for your machine.  The default scheduling is
8523 @samp{8000}.
8525 @item -mlinker-opt
8526 @opindex mlinker-opt
8527 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8528 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8529 linkers in which they give bogus error messages when linking some programs.
8531 @item -msoft-float
8532 @opindex msoft-float
8533 Generate output containing library calls for floating point.
8534 @strong{Warning:} the requisite libraries are not available for all HPPA
8535 targets.  Normally the facilities of the machine's usual C compiler are
8536 used, but this cannot be done directly in cross-compilation.  You must make
8537 your own arrangements to provide suitable library functions for
8538 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8539 does provide software floating point support.
8541 @option{-msoft-float} changes the calling convention in the output file;
8542 therefore, it is only useful if you compile @emph{all} of a program with
8543 this option.  In particular, you need to compile @file{libgcc.a}, the
8544 library that comes with GCC, with @option{-msoft-float} in order for
8545 this to work.
8547 @item -msio
8548 @opindex msio
8549 Generate the predefine, @code{_SIO}, for server IO.  The default is
8550 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8551 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8552 options are available under HP-UX and HI-UX.
8554 @item -mgnu-ld
8555 @opindex gnu-ld
8556 Use GNU ld specific options.  This passes @option{-shared} to ld when
8557 building a shared library.  It is the default when GCC is configured,
8558 explicitly or implicitly, with the GNU linker.  This option does not
8559 have any affect on which ld is called, it only changes what parameters
8560 are passed to that ld.  The ld that is called is determined by the
8561 @option{--with-ld} configure option, gcc's program search path, and
8562 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8563 using @samp{which `gcc -print-prog-name=ld`}.
8565 @item -mhp-ld
8566 @opindex hp-ld
8567 Use HP ld specific options.  This passes @option{-b} to ld when building
8568 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8569 links.  It is the default when GCC is configured, explicitly or
8570 implicitly, with the HP linker.  This option does not have any affect on
8571 which ld is called, it only changes what parameters are passed to that
8572 ld.  The ld that is called is determined by the @option{--with-ld}
8573 configure option, gcc's program search path, and finally by the user's
8574 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8575 `gcc -print-prog-name=ld`}.
8577 @item -mlong-calls
8578 @opindex mno-long-calls
8579 Generate code that uses long call sequences.  This ensures that a call
8580 is always able to reach linker generated stubs.  The default is to generate
8581 long calls only when the distance from the call site to the beginning
8582 of the function or translation unit, as the case may be, exceeds a
8583 predefined limit set by the branch type being used.  The limits for
8584 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8585 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8586 240,000 bytes.
8588 Distances are measured from the beginning of functions when using the
8589 @option{-ffunction-sections} option, or when using the @option{-mgas}
8590 and @option{-mno-portable-runtime} options together under HP-UX with
8591 the SOM linker.
8593 It is normally not desirable to use this option as it will degrade
8594 performance.  However, it may be useful in large applications,
8595 particularly when partial linking is used to build the application.
8597 The types of long calls used depends on the capabilities of the
8598 assembler and linker, and the type of code being generated.  The
8599 impact on systems that support long absolute calls, and long pic
8600 symbol-difference or pc-relative calls should be relatively small.
8601 However, an indirect call is used on 32-bit ELF systems in pic code
8602 and it is quite long.
8604 @item -nolibdld
8605 @opindex nolibdld
8606 Suppress the generation of link options to search libdld.sl when the
8607 @option{-static} option is specified on HP-UX 10 and later.
8609 @item -static
8610 @opindex static
8611 The HP-UX implementation of setlocale in libc has a dependency on
8612 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8613 when the @option{-static} option is specified, special link options
8614 are needed to resolve this dependency.
8616 On HP-UX 10 and later, the GCC driver adds the necessary options to
8617 link with libdld.sl when the @option{-static} option is specified.
8618 This causes the resulting binary to be dynamic.  On the 64-bit port,
8619 the linkers generate dynamic binaries by default in any case.  The
8620 @option{-nolibdld} option can be used to prevent the GCC driver from
8621 adding these link options.
8623 @item -threads
8624 @opindex threads
8625 Add support for multithreading with the @dfn{dce thread} library
8626 under HP-UX.  This option sets flags for both the preprocessor and
8627 linker.
8628 @end table
8630 @node Intel 960 Options
8631 @subsection Intel 960 Options
8633 These @samp{-m} options are defined for the Intel 960 implementations:
8635 @table @gcctabopt
8636 @item -m@var{cpu-type}
8637 @opindex mka
8638 @opindex mkb
8639 @opindex mmc
8640 @opindex mca
8641 @opindex mcf
8642 @opindex msa
8643 @opindex msb
8644 Assume the defaults for the machine type @var{cpu-type} for some of
8645 the other options, including instruction scheduling, floating point
8646 support, and addressing modes.  The choices for @var{cpu-type} are
8647 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8648 @samp{sa}, and @samp{sb}.
8649 The default is
8650 @samp{kb}.
8652 @item -mnumerics
8653 @itemx -msoft-float
8654 @opindex mnumerics
8655 @opindex msoft-float
8656 The @option{-mnumerics} option indicates that the processor does support
8657 floating-point instructions.  The @option{-msoft-float} option indicates
8658 that floating-point support should not be assumed.
8660 @item -mleaf-procedures
8661 @itemx -mno-leaf-procedures
8662 @opindex mleaf-procedures
8663 @opindex mno-leaf-procedures
8664 Do (or do not) attempt to alter leaf procedures to be callable with the
8665 @code{bal} instruction as well as @code{call}.  This will result in more
8666 efficient code for explicit calls when the @code{bal} instruction can be
8667 substituted by the assembler or linker, but less efficient code in other
8668 cases, such as calls via function pointers, or using a linker that doesn't
8669 support this optimization.
8671 @item -mtail-call
8672 @itemx -mno-tail-call
8673 @opindex mtail-call
8674 @opindex mno-tail-call
8675 Do (or do not) make additional attempts (beyond those of the
8676 machine-independent portions of the compiler) to optimize tail-recursive
8677 calls into branches.  You may not want to do this because the detection of
8678 cases where this is not valid is not totally complete.  The default is
8679 @option{-mno-tail-call}.
8681 @item -mcomplex-addr
8682 @itemx -mno-complex-addr
8683 @opindex mcomplex-addr
8684 @opindex mno-complex-addr
8685 Assume (or do not assume) that the use of a complex addressing mode is a
8686 win on this implementation of the i960.  Complex addressing modes may not
8687 be worthwhile on the K-series, but they definitely are on the C-series.
8688 The default is currently @option{-mcomplex-addr} for all processors except
8689 the CB and CC@.
8691 @item -mcode-align
8692 @itemx -mno-code-align
8693 @opindex mcode-align
8694 @opindex mno-code-align
8695 Align code to 8-byte boundaries for faster fetching (or don't bother).
8696 Currently turned on by default for C-series implementations only.
8698 @ignore
8699 @item -mclean-linkage
8700 @itemx -mno-clean-linkage
8701 @opindex mclean-linkage
8702 @opindex mno-clean-linkage
8703 These options are not fully implemented.
8704 @end ignore
8706 @item -mic-compat
8707 @itemx -mic2.0-compat
8708 @itemx -mic3.0-compat
8709 @opindex mic-compat
8710 @opindex mic2.0-compat
8711 @opindex mic3.0-compat
8712 Enable compatibility with iC960 v2.0 or v3.0.
8714 @item -masm-compat
8715 @itemx -mintel-asm
8716 @opindex masm-compat
8717 @opindex mintel-asm
8718 Enable compatibility with the iC960 assembler.
8720 @item -mstrict-align
8721 @itemx -mno-strict-align
8722 @opindex mstrict-align
8723 @opindex mno-strict-align
8724 Do not permit (do permit) unaligned accesses.
8726 @item -mold-align
8727 @opindex mold-align
8728 Enable structure-alignment compatibility with Intel's gcc release version
8729 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8731 @item -mlong-double-64
8732 @opindex mlong-double-64
8733 Implement type @samp{long double} as 64-bit floating point numbers.
8734 Without the option @samp{long double} is implemented by 80-bit
8735 floating point numbers.  The only reason we have it because there is
8736 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8737 is only useful for people using soft-float targets.  Otherwise, we
8738 should recommend against use of it.
8740 @end table
8742 @node DEC Alpha Options
8743 @subsection DEC Alpha Options
8745 These @samp{-m} options are defined for the DEC Alpha implementations:
8747 @table @gcctabopt
8748 @item -mno-soft-float
8749 @itemx -msoft-float
8750 @opindex mno-soft-float
8751 @opindex msoft-float
8752 Use (do not use) the hardware floating-point instructions for
8753 floating-point operations.  When @option{-msoft-float} is specified,
8754 functions in @file{libgcc.a} will be used to perform floating-point
8755 operations.  Unless they are replaced by routines that emulate the
8756 floating-point operations, or compiled in such a way as to call such
8757 emulations routines, these routines will issue floating-point
8758 operations.   If you are compiling for an Alpha without floating-point
8759 operations, you must ensure that the library is built so as not to call
8760 them.
8762 Note that Alpha implementations without floating-point operations are
8763 required to have floating-point registers.
8765 @item -mfp-reg
8766 @itemx -mno-fp-regs
8767 @opindex mfp-reg
8768 @opindex mno-fp-regs
8769 Generate code that uses (does not use) the floating-point register set.
8770 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8771 register set is not used, floating point operands are passed in integer
8772 registers as if they were integers and floating-point results are passed
8773 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8774 so any function with a floating-point argument or return value called by code
8775 compiled with @option{-mno-fp-regs} must also be compiled with that
8776 option.
8778 A typical use of this option is building a kernel that does not use,
8779 and hence need not save and restore, any floating-point registers.
8781 @item -mieee
8782 @opindex mieee
8783 The Alpha architecture implements floating-point hardware optimized for
8784 maximum performance.  It is mostly compliant with the IEEE floating
8785 point standard.  However, for full compliance, software assistance is
8786 required.  This option generates code fully IEEE compliant code
8787 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8788 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8789 defined during compilation.  The resulting code is less efficient but is
8790 able to correctly support denormalized numbers and exceptional IEEE
8791 values such as not-a-number and plus/minus infinity.  Other Alpha
8792 compilers call this option @option{-ieee_with_no_inexact}.
8794 @item -mieee-with-inexact
8795 @opindex mieee-with-inexact
8796 This is like @option{-mieee} except the generated code also maintains
8797 the IEEE @var{inexact-flag}.  Turning on this option causes the
8798 generated code to implement fully-compliant IEEE math.  In addition to
8799 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8800 macro.  On some Alpha implementations the resulting code may execute
8801 significantly slower than the code generated by default.  Since there is
8802 very little code that depends on the @var{inexact-flag}, you should
8803 normally not specify this option.  Other Alpha compilers call this
8804 option @option{-ieee_with_inexact}.
8806 @item -mfp-trap-mode=@var{trap-mode}
8807 @opindex mfp-trap-mode
8808 This option controls what floating-point related traps are enabled.
8809 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8810 The trap mode can be set to one of four values:
8812 @table @samp
8813 @item n
8814 This is the default (normal) setting.  The only traps that are enabled
8815 are the ones that cannot be disabled in software (e.g., division by zero
8816 trap).
8818 @item u
8819 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8820 as well.
8822 @item su
8823 Like @samp{su}, but the instructions are marked to be safe for software
8824 completion (see Alpha architecture manual for details).
8826 @item sui
8827 Like @samp{su}, but inexact traps are enabled as well.
8828 @end table
8830 @item -mfp-rounding-mode=@var{rounding-mode}
8831 @opindex mfp-rounding-mode
8832 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8833 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8836 @table @samp
8837 @item n
8838 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8839 the nearest machine number or towards the even machine number in case
8840 of a tie.
8842 @item m
8843 Round towards minus infinity.
8845 @item c
8846 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8848 @item d
8849 Dynamic rounding mode.  A field in the floating point control register
8850 (@var{fpcr}, see Alpha architecture reference manual) controls the
8851 rounding mode in effect.  The C library initializes this register for
8852 rounding towards plus infinity.  Thus, unless your program modifies the
8853 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8854 @end table
8856 @item -mtrap-precision=@var{trap-precision}
8857 @opindex mtrap-precision
8858 In the Alpha architecture, floating point traps are imprecise.  This
8859 means without software assistance it is impossible to recover from a
8860 floating trap and program execution normally needs to be terminated.
8861 GCC can generate code that can assist operating system trap handlers
8862 in determining the exact location that caused a floating point trap.
8863 Depending on the requirements of an application, different levels of
8864 precisions can be selected:
8866 @table @samp
8867 @item p
8868 Program precision.  This option is the default and means a trap handler
8869 can only identify which program caused a floating point exception.
8871 @item f
8872 Function precision.  The trap handler can determine the function that
8873 caused a floating point exception.
8875 @item i
8876 Instruction precision.  The trap handler can determine the exact
8877 instruction that caused a floating point exception.
8878 @end table
8880 Other Alpha compilers provide the equivalent options called
8881 @option{-scope_safe} and @option{-resumption_safe}.
8883 @item -mieee-conformant
8884 @opindex mieee-conformant
8885 This option marks the generated code as IEEE conformant.  You must not
8886 use this option unless you also specify @option{-mtrap-precision=i} and either
8887 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8888 is to emit the line @samp{.eflag 48} in the function prologue of the
8889 generated assembly file.  Under DEC Unix, this has the effect that
8890 IEEE-conformant math library routines will be linked in.
8892 @item -mbuild-constants
8893 @opindex mbuild-constants
8894 Normally GCC examines a 32- or 64-bit integer constant to
8895 see if it can construct it from smaller constants in two or three
8896 instructions.  If it cannot, it will output the constant as a literal and
8897 generate code to load it from the data segment at runtime.
8899 Use this option to require GCC to construct @emph{all} integer constants
8900 using code, even if it takes more instructions (the maximum is six).
8902 You would typically use this option to build a shared library dynamic
8903 loader.  Itself a shared library, it must relocate itself in memory
8904 before it can find the variables and constants in its own data segment.
8906 @item -malpha-as
8907 @itemx -mgas
8908 @opindex malpha-as
8909 @opindex mgas
8910 Select whether to generate code to be assembled by the vendor-supplied
8911 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8913 @item -mbwx
8914 @itemx -mno-bwx
8915 @itemx -mcix
8916 @itemx -mno-cix
8917 @itemx -mfix
8918 @itemx -mno-fix
8919 @itemx -mmax
8920 @itemx -mno-max
8921 @opindex mbwx
8922 @opindex mno-bwx
8923 @opindex mcix
8924 @opindex mno-cix
8925 @opindex mfix
8926 @opindex mno-fix
8927 @opindex mmax
8928 @opindex mno-max
8929 Indicate whether GCC should generate code to use the optional BWX,
8930 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8931 sets supported by the CPU type specified via @option{-mcpu=} option or that
8932 of the CPU on which GCC was built if none was specified.
8934 @item -mfloat-vax
8935 @itemx -mfloat-ieee
8936 @opindex mfloat-vax
8937 @opindex mfloat-ieee
8938 Generate code that uses (does not use) VAX F and G floating point
8939 arithmetic instead of IEEE single and double precision.
8941 @item -mexplicit-relocs
8942 @itemx -mno-explicit-relocs
8943 @opindex mexplicit-relocs
8944 @opindex mno-explicit-relocs
8945 Older Alpha assemblers provided no way to generate symbol relocations
8946 except via assembler macros.  Use of these macros does not allow
8947 optimal instruction scheduling.  GNU binutils as of version 2.12
8948 supports a new syntax that allows the compiler to explicitly mark
8949 which relocations should apply to which instructions.  This option
8950 is mostly useful for debugging, as GCC detects the capabilities of
8951 the assembler when it is built and sets the default accordingly.
8953 @item -msmall-data
8954 @itemx -mlarge-data
8955 @opindex msmall-data
8956 @opindex mlarge-data
8957 When @option{-mexplicit-relocs} is in effect, static data is
8958 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8959 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8960 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8961 16-bit relocations off of the @code{$gp} register.  This limits the
8962 size of the small data area to 64KB, but allows the variables to be
8963 directly accessed via a single instruction.
8965 The default is @option{-mlarge-data}.  With this option the data area
8966 is limited to just below 2GB.  Programs that require more than 2GB of
8967 data must use @code{malloc} or @code{mmap} to allocate the data in the
8968 heap instead of in the program's data segment.
8970 When generating code for shared libraries, @option{-fpic} implies
8971 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8973 @item -msmall-text
8974 @itemx -mlarge-text
8975 @opindex msmall-text
8976 @opindex mlarge-text
8977 When @option{-msmall-text} is used, the compiler assumes that the
8978 code of the entire program (or shared library) fits in 4MB, and is
8979 thus reachable with a branch instruction.  When @option{-msmall-data}
8980 is used, the compiler can assume that all local symbols share the
8981 same @code{$gp} value, and thus reduce the number of instructions
8982 required for a function call from 4 to 1.
8984 The default is @option{-mlarge-text}.
8986 @item -mcpu=@var{cpu_type}
8987 @opindex mcpu
8988 Set the instruction set and instruction scheduling parameters for
8989 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8990 style name or the corresponding chip number.  GCC supports scheduling
8991 parameters for the EV4, EV5 and EV6 family of processors and will
8992 choose the default values for the instruction set from the processor
8993 you specify.  If you do not specify a processor type, GCC will default
8994 to the processor on which the compiler was built.
8996 Supported values for @var{cpu_type} are
8998 @table @samp
8999 @item ev4
9000 @item ev45
9001 @itemx 21064
9002 Schedules as an EV4 and has no instruction set extensions.
9004 @item ev5
9005 @itemx 21164
9006 Schedules as an EV5 and has no instruction set extensions.
9008 @item ev56
9009 @itemx 21164a
9010 Schedules as an EV5 and supports the BWX extension.
9012 @item pca56
9013 @itemx 21164pc
9014 @itemx 21164PC
9015 Schedules as an EV5 and supports the BWX and MAX extensions.
9017 @item ev6
9018 @itemx 21264
9019 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9021 @item ev67
9022 @item 21264a
9023 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9024 @end table
9026 @item -mtune=@var{cpu_type}
9027 @opindex mtune
9028 Set only the instruction scheduling parameters for machine type
9029 @var{cpu_type}.  The instruction set is not changed.
9031 @item -mmemory-latency=@var{time}
9032 @opindex mmemory-latency
9033 Sets the latency the scheduler should assume for typical memory
9034 references as seen by the application.  This number is highly
9035 dependent on the memory access patterns used by the application
9036 and the size of the external cache on the machine.
9038 Valid options for @var{time} are
9040 @table @samp
9041 @item @var{number}
9042 A decimal number representing clock cycles.
9044 @item L1
9045 @itemx L2
9046 @itemx L3
9047 @itemx main
9048 The compiler contains estimates of the number of clock cycles for
9049 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9050 (also called Dcache, Scache, and Bcache), as well as to main memory.
9051 Note that L3 is only valid for EV5.
9053 @end table
9054 @end table
9056 @node DEC Alpha/VMS Options
9057 @subsection DEC Alpha/VMS Options
9059 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9061 @table @gcctabopt
9062 @item -mvms-return-codes
9063 @opindex mvms-return-codes
9064 Return VMS condition codes from main.  The default is to return POSIX
9065 style condition (e.g.@ error) codes.
9066 @end table
9068 @node H8/300 Options
9069 @subsection H8/300 Options
9071 These @samp{-m} options are defined for the H8/300 implementations:
9073 @table @gcctabopt
9074 @item -mrelax
9075 @opindex mrelax
9076 Shorten some address references at link time, when possible; uses the
9077 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9078 ld.info, Using ld}, for a fuller description.
9080 @item -mh
9081 @opindex mh
9082 Generate code for the H8/300H@.
9084 @item -ms
9085 @opindex ms
9086 Generate code for the H8S@.
9088 @item -mn
9089 @opindex mn
9090 Generate code for the H8S and H8/300H in the normal mode.  This switch
9091 must be used either with -mh or -ms.
9093 @item -ms2600
9094 @opindex ms2600
9095 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9097 @item -mint32
9098 @opindex mint32
9099 Make @code{int} data 32 bits by default.
9101 @item -malign-300
9102 @opindex malign-300
9103 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9104 The default for the H8/300H and H8S is to align longs and floats on 4
9105 byte boundaries.
9106 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9107 This option has no effect on the H8/300.
9108 @end table
9110 @node SH Options
9111 @subsection SH Options
9113 These @samp{-m} options are defined for the SH implementations:
9115 @table @gcctabopt
9116 @item -m1
9117 @opindex m1
9118 Generate code for the SH1.
9120 @item -m2
9121 @opindex m2
9122 Generate code for the SH2.
9124 @item -m2e
9125 Generate code for the SH2e.
9127 @item -m3
9128 @opindex m3
9129 Generate code for the SH3.
9131 @item -m3e
9132 @opindex m3e
9133 Generate code for the SH3e.
9135 @item -m4-nofpu
9136 @opindex m4-nofpu
9137 Generate code for the SH4 without a floating-point unit.
9139 @item -m4-single-only
9140 @opindex m4-single-only
9141 Generate code for the SH4 with a floating-point unit that only
9142 supports single-precision arithmetic.
9144 @item -m4-single
9145 @opindex m4-single
9146 Generate code for the SH4 assuming the floating-point unit is in
9147 single-precision mode by default.
9149 @item -m4
9150 @opindex m4
9151 Generate code for the SH4.
9153 @item -mb
9154 @opindex mb
9155 Compile code for the processor in big endian mode.
9157 @item -ml
9158 @opindex ml
9159 Compile code for the processor in little endian mode.
9161 @item -mdalign
9162 @opindex mdalign
9163 Align doubles at 64-bit boundaries.  Note that this changes the calling
9164 conventions, and thus some functions from the standard C library will
9165 not work unless you recompile it first with @option{-mdalign}.
9167 @item -mrelax
9168 @opindex mrelax
9169 Shorten some address references at link time, when possible; uses the
9170 linker option @option{-relax}.
9172 @item -mbigtable
9173 @opindex mbigtable
9174 Use 32-bit offsets in @code{switch} tables.  The default is to use
9175 16-bit offsets.
9177 @item -mfmovd
9178 @opindex mfmovd
9179 Enable the use of the instruction @code{fmovd}.
9181 @item -mhitachi
9182 @opindex mhitachi
9183 Comply with the calling conventions defined by Hitachi.
9185 @item -mnomacsave
9186 @opindex mnomacsave
9187 Mark the @code{MAC} register as call-clobbered, even if
9188 @option{-mhitachi} is given.
9190 @item -mieee
9191 @opindex mieee
9192 Increase IEEE-compliance of floating-point code.
9194 @item -misize
9195 @opindex misize
9196 Dump instruction size and location in the assembly code.
9198 @item -mpadstruct
9199 @opindex mpadstruct
9200 This option is deprecated.  It pads structures to multiple of 4 bytes,
9201 which is incompatible with the SH ABI@.
9203 @item -mspace
9204 @opindex mspace
9205 Optimize for space instead of speed.  Implied by @option{-Os}.
9207 @item -mprefergot
9208 @opindex mprefergot
9209 When generating position-independent code, emit function calls using
9210 the Global Offset Table instead of the Procedure Linkage Table.
9212 @item -musermode
9213 @opindex musermode
9214 Generate a library function call to invalidate instruction cache
9215 entries, after fixing up a trampoline.  This library function call
9216 doesn't assume it can write to the whole memory address space.  This
9217 is the default when the target is @code{sh-*-linux*}.
9218 @end table
9220 @node System V Options
9221 @subsection Options for System V
9223 These additional options are available on System V Release 4 for
9224 compatibility with other compilers on those systems:
9226 @table @gcctabopt
9227 @item -G
9228 @opindex G
9229 Create a shared object.
9230 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9232 @item -Qy
9233 @opindex Qy
9234 Identify the versions of each tool used by the compiler, in a
9235 @code{.ident} assembler directive in the output.
9237 @item -Qn
9238 @opindex Qn
9239 Refrain from adding @code{.ident} directives to the output file (this is
9240 the default).
9242 @item -YP,@var{dirs}
9243 @opindex YP
9244 Search the directories @var{dirs}, and no others, for libraries
9245 specified with @option{-l}.
9247 @item -Ym,@var{dir}
9248 @opindex Ym
9249 Look in the directory @var{dir} to find the M4 preprocessor.
9250 The assembler uses this option.
9251 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9252 @c the generic assembler that comes with Solaris takes just -Ym.
9253 @end table
9255 @node TMS320C3x/C4x Options
9256 @subsection TMS320C3x/C4x Options
9257 @cindex TMS320C3x/C4x Options
9259 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9261 @table @gcctabopt
9263 @item -mcpu=@var{cpu_type}
9264 @opindex mcpu
9265 Set the instruction set, register set, and instruction scheduling
9266 parameters for machine type @var{cpu_type}.  Supported values for
9267 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9268 @samp{c44}.  The default is @samp{c40} to generate code for the
9269 TMS320C40.
9271 @item -mbig-memory
9272 @item -mbig
9273 @itemx -msmall-memory
9274 @itemx -msmall
9275 @opindex mbig-memory
9276 @opindex mbig
9277 @opindex msmall-memory
9278 @opindex msmall
9279 Generates code for the big or small memory model.  The small memory
9280 model assumed that all data fits into one 64K word page.  At run-time
9281 the data page (DP) register must be set to point to the 64K page
9282 containing the .bss and .data program sections.  The big memory model is
9283 the default and requires reloading of the DP register for every direct
9284 memory access.
9286 @item -mbk
9287 @itemx -mno-bk
9288 @opindex mbk
9289 @opindex mno-bk
9290 Allow (disallow) allocation of general integer operands into the block
9291 count register BK@.
9293 @item -mdb
9294 @itemx -mno-db
9295 @opindex mdb
9296 @opindex mno-db
9297 Enable (disable) generation of code using decrement and branch,
9298 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9299 on the safe side, this is disabled for the C3x, since the maximum
9300 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9301 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9302 that it can utilize the decrement and branch instruction, but will give
9303 up if there is more than one memory reference in the loop.  Thus a loop
9304 where the loop counter is decremented can generate slightly more
9305 efficient code, in cases where the RPTB instruction cannot be utilized.
9307 @item -mdp-isr-reload
9308 @itemx -mparanoid
9309 @opindex mdp-isr-reload
9310 @opindex mparanoid
9311 Force the DP register to be saved on entry to an interrupt service
9312 routine (ISR), reloaded to point to the data section, and restored on
9313 exit from the ISR@.  This should not be required unless someone has
9314 violated the small memory model by modifying the DP register, say within
9315 an object library.
9317 @item -mmpyi
9318 @itemx -mno-mpyi
9319 @opindex mmpyi
9320 @opindex mno-mpyi
9321 For the C3x use the 24-bit MPYI instruction for integer multiplies
9322 instead of a library call to guarantee 32-bit results.  Note that if one
9323 of the operands is a constant, then the multiplication will be performed
9324 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9325 then squaring operations are performed inline instead of a library call.
9327 @item -mfast-fix
9328 @itemx -mno-fast-fix
9329 @opindex mfast-fix
9330 @opindex mno-fast-fix
9331 The C3x/C4x FIX instruction to convert a floating point value to an
9332 integer value chooses the nearest integer less than or equal to the
9333 floating point value rather than to the nearest integer.  Thus if the
9334 floating point number is negative, the result will be incorrectly
9335 truncated an additional code is necessary to detect and correct this
9336 case.  This option can be used to disable generation of the additional
9337 code required to correct the result.
9339 @item -mrptb
9340 @itemx -mno-rptb
9341 @opindex mrptb
9342 @opindex mno-rptb
9343 Enable (disable) generation of repeat block sequences using the RPTB
9344 instruction for zero overhead looping.  The RPTB construct is only used
9345 for innermost loops that do not call functions or jump across the loop
9346 boundaries.  There is no advantage having nested RPTB loops due to the
9347 overhead required to save and restore the RC, RS, and RE registers.
9348 This is enabled by default with @option{-O2}.
9350 @item -mrpts=@var{count}
9351 @itemx -mno-rpts
9352 @opindex mrpts
9353 @opindex mno-rpts
9354 Enable (disable) the use of the single instruction repeat instruction
9355 RPTS@.  If a repeat block contains a single instruction, and the loop
9356 count can be guaranteed to be less than the value @var{count}, GCC will
9357 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9358 then a RPTS will be emitted even if the loop count cannot be determined
9359 at compile time.  Note that the repeated instruction following RPTS does
9360 not have to be reloaded from memory each iteration, thus freeing up the
9361 CPU buses for operands.  However, since interrupts are blocked by this
9362 instruction, it is disabled by default.
9364 @item -mloop-unsigned
9365 @itemx -mno-loop-unsigned
9366 @opindex mloop-unsigned
9367 @opindex mno-loop-unsigned
9368 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9369 is @math{2^{31} + 1} since these instructions test if the iteration count is
9370 negative to terminate the loop.  If the iteration count is unsigned
9371 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9372 exceeded.  This switch allows an unsigned iteration count.
9374 @item -mti
9375 @opindex mti
9376 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9377 with.  This also enforces compatibility with the API employed by the TI
9378 C3x C compiler.  For example, long doubles are passed as structures
9379 rather than in floating point registers.
9381 @item -mregparm
9382 @itemx -mmemparm
9383 @opindex mregparm
9384 @opindex mmemparm
9385 Generate code that uses registers (stack) for passing arguments to functions.
9386 By default, arguments are passed in registers where possible rather
9387 than by pushing arguments on to the stack.
9389 @item -mparallel-insns
9390 @itemx -mno-parallel-insns
9391 @opindex mparallel-insns
9392 @opindex mno-parallel-insns
9393 Allow the generation of parallel instructions.  This is enabled by
9394 default with @option{-O2}.
9396 @item -mparallel-mpy
9397 @itemx -mno-parallel-mpy
9398 @opindex mparallel-mpy
9399 @opindex mno-parallel-mpy
9400 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9401 provided @option{-mparallel-insns} is also specified.  These instructions have
9402 tight register constraints which can pessimize the code generation
9403 of large functions.
9405 @end table
9407 @node V850 Options
9408 @subsection V850 Options
9409 @cindex V850 Options
9411 These @samp{-m} options are defined for V850 implementations:
9413 @table @gcctabopt
9414 @item -mlong-calls
9415 @itemx -mno-long-calls
9416 @opindex mlong-calls
9417 @opindex mno-long-calls
9418 Treat all calls as being far away (near).  If calls are assumed to be
9419 far away, the compiler will always load the functions address up into a
9420 register, and call indirect through the pointer.
9422 @item -mno-ep
9423 @itemx -mep
9424 @opindex mno-ep
9425 @opindex mep
9426 Do not optimize (do optimize) basic blocks that use the same index
9427 pointer 4 or more times to copy pointer into the @code{ep} register, and
9428 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9429 option is on by default if you optimize.
9431 @item -mno-prolog-function
9432 @itemx -mprolog-function
9433 @opindex mno-prolog-function
9434 @opindex mprolog-function
9435 Do not use (do use) external functions to save and restore registers at
9436 the prolog and epilog of a function.  The external functions are slower,
9437 but use less code space if more than one function saves the same number
9438 of registers.  The @option{-mprolog-function} option is on by default if
9439 you optimize.
9441 @item -mspace
9442 @opindex mspace
9443 Try to make the code as small as possible.  At present, this just turns
9444 on the @option{-mep} and @option{-mprolog-function} options.
9446 @item -mtda=@var{n}
9447 @opindex mtda
9448 Put static or global variables whose size is @var{n} bytes or less into
9449 the tiny data area that register @code{ep} points to.  The tiny data
9450 area can hold up to 256 bytes in total (128 bytes for byte references).
9452 @item -msda=@var{n}
9453 @opindex msda
9454 Put static or global variables whose size is @var{n} bytes or less into
9455 the small data area that register @code{gp} points to.  The small data
9456 area can hold up to 64 kilobytes.
9458 @item -mzda=@var{n}
9459 @opindex mzda
9460 Put static or global variables whose size is @var{n} bytes or less into
9461 the first 32 kilobytes of memory.
9463 @item -mv850
9464 @opindex mv850
9465 Specify that the target processor is the V850.
9467 @item -mbig-switch
9468 @opindex mbig-switch
9469 Generate code suitable for big switch tables.  Use this option only if
9470 the assembler/linker complain about out of range branches within a switch
9471 table.
9473 @item -mapp-regs
9474 @opindex -mapp-regs
9475 This option will cause r2 and r5 to be used in the code generated by
9476 the compiler.  This setting is the default.
9478 @item -mno-app-regs
9479 @opindex -mno-app-regs
9480 This option will cause r2 and r5 to be treated as fixed registers.
9481   
9482 @item -mv850e
9483 @opindex -mv850e
9484 Specify that the target processor is the V850E.  The preprocessor
9485 constant @samp{__v850e__} will be defined if this option is used.
9487 If neither @option{-mv850} nor @option{-mv850e} are defined
9488 then a default target processor will be chosen and the relevant
9489 @samp{__v850*__} preprocessor constant will be defined.
9491 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9492 defined, regardless of which processor variant is the target.
9494 @item -mdisable-callt
9495 @opindex -mdisable-callt
9496 This option will suppress generation of the CALLT instruction for the
9497 v850e flavors of the v850 architecture.  The default is
9498 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9500 @end table
9502 @node ARC Options
9503 @subsection ARC Options
9504 @cindex ARC Options
9506 These options are defined for ARC implementations:
9508 @table @gcctabopt
9509 @item -EL
9510 @opindex EL
9511 Compile code for little endian mode.  This is the default.
9513 @item -EB
9514 @opindex EB
9515 Compile code for big endian mode.
9517 @item -mmangle-cpu
9518 @opindex mmangle-cpu
9519 Prepend the name of the cpu to all public symbol names.
9520 In multiple-processor systems, there are many ARC variants with different
9521 instruction and register set characteristics.  This flag prevents code
9522 compiled for one cpu to be linked with code compiled for another.
9523 No facility exists for handling variants that are ``almost identical''.
9524 This is an all or nothing option.
9526 @item -mcpu=@var{cpu}
9527 @opindex mcpu
9528 Compile code for ARC variant @var{cpu}.
9529 Which variants are supported depend on the configuration.
9530 All variants support @option{-mcpu=base}, this is the default.
9532 @item -mtext=@var{text-section}
9533 @itemx -mdata=@var{data-section}
9534 @itemx -mrodata=@var{readonly-data-section}
9535 @opindex mtext
9536 @opindex mdata
9537 @opindex mrodata
9538 Put functions, data, and readonly data in @var{text-section},
9539 @var{data-section}, and @var{readonly-data-section} respectively
9540 by default.  This can be overridden with the @code{section} attribute.
9541 @xref{Variable Attributes}.
9543 @end table
9545 @node NS32K Options
9546 @subsection NS32K Options
9547 @cindex NS32K options
9549 These are the @samp{-m} options defined for the 32000 series.  The default
9550 values for these options depends on which style of 32000 was selected when
9551 the compiler was configured; the defaults for the most common choices are
9552 given below.
9554 @table @gcctabopt
9555 @item -m32032
9556 @itemx -m32032
9557 @opindex m32032
9558 @opindex m32032
9559 Generate output for a 32032.  This is the default
9560 when the compiler is configured for 32032 and 32016 based systems.
9562 @item -m32332
9563 @itemx -m32332
9564 @opindex m32332
9565 @opindex m32332
9566 Generate output for a 32332.  This is the default
9567 when the compiler is configured for 32332-based systems.
9569 @item -m32532
9570 @itemx -m32532
9571 @opindex m32532
9572 @opindex m32532
9573 Generate output for a 32532.  This is the default
9574 when the compiler is configured for 32532-based systems.
9576 @item -m32081
9577 @opindex m32081
9578 Generate output containing 32081 instructions for floating point.
9579 This is the default for all systems.
9581 @item -m32381
9582 @opindex m32381
9583 Generate output containing 32381 instructions for floating point.  This
9584 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9585 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9587 @item -mmulti-add
9588 @opindex mmulti-add
9589 Try and generate multiply-add floating point instructions @code{polyF}
9590 and @code{dotF}.  This option is only available if the @option{-m32381}
9591 option is in effect.  Using these instructions requires changes to
9592 register allocation which generally has a negative impact on
9593 performance.  This option should only be enabled when compiling code
9594 particularly likely to make heavy use of multiply-add instructions.
9596 @item -mnomulti-add
9597 @opindex mnomulti-add
9598 Do not try and generate multiply-add floating point instructions
9599 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9601 @item -msoft-float
9602 @opindex msoft-float
9603 Generate output containing library calls for floating point.
9604 @strong{Warning:} the requisite libraries may not be available.
9606 @item -mieee-compare
9607 @itemx -mno-ieee-compare
9608 @opindex mieee-compare
9609 @opindex mno-ieee-compare
9610 Control whether or not the compiler uses IEEE floating point
9611 comparisons.  These handle correctly the case where the result of a
9612 comparison is unordered.
9613 @strong{Warning:} the requisite kernel support may not be available.
9615 @item -mnobitfield
9616 @opindex mnobitfield
9617 Do not use the bit-field instructions.  On some machines it is faster to
9618 use shifting and masking operations.  This is the default for the pc532.
9620 @item -mbitfield
9621 @opindex mbitfield
9622 Do use the bit-field instructions.  This is the default for all platforms
9623 except the pc532.
9625 @item -mrtd
9626 @opindex mrtd
9627 Use a different function-calling convention, in which functions
9628 that take a fixed number of arguments return pop their
9629 arguments on return with the @code{ret} instruction.
9631 This calling convention is incompatible with the one normally
9632 used on Unix, so you cannot use it if you need to call libraries
9633 compiled with the Unix compiler.
9635 Also, you must provide function prototypes for all functions that
9636 take variable numbers of arguments (including @code{printf});
9637 otherwise incorrect code will be generated for calls to those
9638 functions.
9640 In addition, seriously incorrect code will result if you call a
9641 function with too many arguments.  (Normally, extra arguments are
9642 harmlessly ignored.)
9644 This option takes its name from the 680x0 @code{rtd} instruction.
9647 @item -mregparam
9648 @opindex mregparam
9649 Use a different function-calling convention where the first two arguments
9650 are passed in registers.
9652 This calling convention is incompatible with the one normally
9653 used on Unix, so you cannot use it if you need to call libraries
9654 compiled with the Unix compiler.
9656 @item -mnoregparam
9657 @opindex mnoregparam
9658 Do not pass any arguments in registers.  This is the default for all
9659 targets.
9661 @item -msb
9662 @opindex msb
9663 It is OK to use the sb as an index register which is always loaded with
9664 zero.  This is the default for the pc532-netbsd target.
9666 @item -mnosb
9667 @opindex mnosb
9668 The sb register is not available for use or has not been initialized to
9669 zero by the run time system.  This is the default for all targets except
9670 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9671 @option{-fpic} is set.
9673 @item -mhimem
9674 @opindex mhimem
9675 Many ns32000 series addressing modes use displacements of up to 512MB@.
9676 If an address is above 512MB then displacements from zero can not be used.
9677 This option causes code to be generated which can be loaded above 512MB@.
9678 This may be useful for operating systems or ROM code.
9680 @item -mnohimem
9681 @opindex mnohimem
9682 Assume code will be loaded in the first 512MB of virtual address space.
9683 This is the default for all platforms.
9686 @end table
9688 @node AVR Options
9689 @subsection AVR Options
9690 @cindex AVR Options
9692 These options are defined for AVR implementations:
9694 @table @gcctabopt
9695 @item -mmcu=@var{mcu}
9696 @opindex mmcu
9697 Specify ATMEL AVR instruction set or MCU type.
9699 Instruction set avr1 is for the minimal AVR core, not supported by the C
9700 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9701 attiny11, attiny12, attiny15, attiny28).
9703 Instruction set avr2 (default) is for the classic AVR core with up to
9704 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9705 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9706 at90c8534, at90s8535).
9708 Instruction set avr3 is for the classic AVR core with up to 128K program
9709 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9711 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9712 memory space (MCU types: atmega8, atmega83, atmega85).
9714 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9715 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9716 atmega64, atmega128, at43usb355, at94k).
9718 @item -msize
9719 @opindex msize
9720 Output instruction sizes to the asm file.
9722 @item -minit-stack=@var{N}
9723 @opindex minit-stack
9724 Specify the initial stack address, which may be a symbol or numeric value,
9725 @samp{__stack} is the default.
9727 @item -mno-interrupts
9728 @opindex mno-interrupts
9729 Generated code is not compatible with hardware interrupts.
9730 Code size will be smaller.
9732 @item -mcall-prologues
9733 @opindex mcall-prologues
9734 Functions prologues/epilogues expanded as call to appropriate
9735 subroutines.  Code size will be smaller.
9737 @item -mno-tablejump
9738 @opindex mno-tablejump
9739 Do not generate tablejump insns which sometimes increase code size.
9741 @item -mtiny-stack
9742 @opindex mtiny-stack
9743 Change only the low 8 bits of the stack pointer.
9744 @end table
9746 @node MCore Options
9747 @subsection MCore Options
9748 @cindex MCore options
9750 These are the @samp{-m} options defined for the Motorola M*Core
9751 processors.
9753 @table @gcctabopt
9755 @item -mhardlit
9756 @itemx -mno-hardlit
9757 @opindex mhardlit
9758 @opindex mno-hardlit
9759 Inline constants into the code stream if it can be done in two
9760 instructions or less.
9762 @item -mdiv
9763 @itemx -mno-div
9764 @opindex mdiv
9765 @opindex mno-div
9766 Use the divide instruction.  (Enabled by default).
9768 @item -mrelax-immediate
9769 @itemx -mno-relax-immediate
9770 @opindex mrelax-immediate
9771 @opindex mno-relax-immediate
9772 Allow arbitrary sized immediates in bit operations.
9774 @item -mwide-bitfields
9775 @itemx -mno-wide-bitfields
9776 @opindex mwide-bitfields
9777 @opindex mno-wide-bitfields
9778 Always treat bit-fields as int-sized.
9780 @item -m4byte-functions
9781 @itemx -mno-4byte-functions
9782 @opindex m4byte-functions
9783 @opindex mno-4byte-functions
9784 Force all functions to be aligned to a four byte boundary.
9786 @item -mcallgraph-data
9787 @itemx -mno-callgraph-data
9788 @opindex mcallgraph-data
9789 @opindex mno-callgraph-data
9790 Emit callgraph information.
9792 @item -mslow-bytes
9793 @itemx -mno-slow-bytes
9794 @opindex mslow-bytes
9795 @opindex mno-slow-bytes
9796 Prefer word access when reading byte quantities.
9798 @item -mlittle-endian
9799 @itemx -mbig-endian
9800 @opindex mlittle-endian
9801 @opindex mbig-endian
9802 Generate code for a little endian target.
9804 @item -m210
9805 @itemx -m340
9806 @opindex m210
9807 @opindex m340
9808 Generate code for the 210 processor.
9809 @end table
9811 @node IA-64 Options
9812 @subsection IA-64 Options
9813 @cindex IA-64 Options
9815 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9817 @table @gcctabopt
9818 @item -mbig-endian
9819 @opindex mbig-endian
9820 Generate code for a big endian target.  This is the default for HP-UX@.
9822 @item -mlittle-endian
9823 @opindex mlittle-endian
9824 Generate code for a little endian target.  This is the default for AIX5
9825 and Linux.
9827 @item -mgnu-as
9828 @itemx -mno-gnu-as
9829 @opindex mgnu-as
9830 @opindex mno-gnu-as
9831 Generate (or don't) code for the GNU assembler.  This is the default.
9832 @c Also, this is the default if the configure option @option{--with-gnu-as}
9833 @c is used.
9835 @item -mgnu-ld
9836 @itemx -mno-gnu-ld
9837 @opindex mgnu-ld
9838 @opindex mno-gnu-ld
9839 Generate (or don't) code for the GNU linker.  This is the default.
9840 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9841 @c is used.
9843 @item -mno-pic
9844 @opindex mno-pic
9845 Generate code that does not use a global pointer register.  The result
9846 is not position independent code, and violates the IA-64 ABI@.
9848 @item -mvolatile-asm-stop
9849 @itemx -mno-volatile-asm-stop
9850 @opindex mvolatile-asm-stop
9851 @opindex mno-volatile-asm-stop
9852 Generate (or don't) a stop bit immediately before and after volatile asm
9853 statements.
9855 @item -mb-step
9856 @opindex mb-step
9857 Generate code that works around Itanium B step errata.
9859 @item -mregister-names
9860 @itemx -mno-register-names
9861 @opindex mregister-names
9862 @opindex mno-register-names
9863 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9864 the stacked registers.  This may make assembler output more readable.
9866 @item -mno-sdata
9867 @itemx -msdata
9868 @opindex mno-sdata
9869 @opindex msdata
9870 Disable (or enable) optimizations that use the small data section.  This may
9871 be useful for working around optimizer bugs.
9873 @item -mconstant-gp
9874 @opindex mconstant-gp
9875 Generate code that uses a single constant global pointer value.  This is
9876 useful when compiling kernel code.
9878 @item -mauto-pic
9879 @opindex mauto-pic
9880 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9881 This is useful when compiling firmware code.
9883 @item -minline-float-divide-min-latency
9884 @opindex minline-float-divide-min-latency
9885 Generate code for inline divides of floating point values
9886 using the minimum latency algorithm.
9888 @item -minline-float-divide-max-throughput
9889 @opindex minline-float-divide-max-throughput
9890 Generate code for inline divides of floating point values
9891 using the maximum throughput algorithm.
9893 @item -minline-int-divide-min-latency
9894 @opindex minline-int-divide-min-latency
9895 Generate code for inline divides of integer values
9896 using the minimum latency algorithm.
9898 @item -minline-int-divide-max-throughput
9899 @opindex minline-int-divide-max-throughput
9900 Generate code for inline divides of integer values
9901 using the maximum throughput algorithm.
9903 @item -mno-dwarf2-asm
9904 @itemx -mdwarf2-asm
9905 @opindex mno-dwarf2-asm
9906 @opindex mdwarf2-asm
9907 Don't (or do) generate assembler code for the DWARF2 line number debugging
9908 info.  This may be useful when not using the GNU assembler.
9910 @item -mfixed-range=@var{register-range}
9911 @opindex mfixed-range
9912 Generate code treating the given register range as fixed registers.
9913 A fixed register is one that the register allocator can not use.  This is
9914 useful when compiling kernel code.  A register range is specified as
9915 two registers separated by a dash.  Multiple register ranges can be
9916 specified separated by a comma.
9918 @item -mearly-stop-bits
9919 @itemx -mno-early-stop-bits
9920 @opindex mearly-stop-bits
9921 @opindex mno-early-stop-bits
9922 Allow stop bits to be placed earlier than immediately preceding the
9923 instruction that triggered the stop bit.  This can improve instruction
9924 scheduling, but does not always do so.
9925 @end table
9927 @node D30V Options
9928 @subsection D30V Options
9929 @cindex D30V Options
9931 These @samp{-m} options are defined for D30V implementations:
9933 @table @gcctabopt
9934 @item -mextmem
9935 @opindex mextmem
9936 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9937 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9938 memory, which starts at location @code{0x80000000}.
9940 @item -mextmemory
9941 @opindex mextmemory
9942 Same as the @option{-mextmem} switch.
9944 @item -monchip
9945 @opindex monchip
9946 Link the @samp{.text} section into onchip text memory, which starts at
9947 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9948 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9949 into onchip data memory, which starts at location @code{0x20000000}.
9951 @item -mno-asm-optimize
9952 @itemx -masm-optimize
9953 @opindex mno-asm-optimize
9954 @opindex masm-optimize
9955 Disable (enable) passing @option{-O} to the assembler when optimizing.
9956 The assembler uses the @option{-O} option to automatically parallelize
9957 adjacent short instructions where possible.
9959 @item -mbranch-cost=@var{n}
9960 @opindex mbranch-cost
9961 Increase the internal costs of branches to @var{n}.  Higher costs means
9962 that the compiler will issue more instructions to avoid doing a branch.
9963 The default is 2.
9965 @item -mcond-exec=@var{n}
9966 @opindex mcond-exec
9967 Specify the maximum number of conditionally executed instructions that
9968 replace a branch.  The default is 4.
9969 @end table
9971 @node S/390 and zSeries Options
9972 @subsection S/390 and zSeries Options
9973 @cindex S/390 and zSeries Options
9975 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9977 @table @gcctabopt
9978 @item -mhard-float
9979 @itemx -msoft-float
9980 @opindex mhard-float
9981 @opindex msoft-float
9982 Use (do not use) the hardware floating-point instructions and registers
9983 for floating-point operations.  When @option{-msoft-float} is specified,
9984 functions in @file{libgcc.a} will be used to perform floating-point
9985 operations.  When @option{-mhard-float} is specified, the compiler
9986 generates IEEE floating-point instructions.  This is the default.
9988 @item -mbackchain
9989 @itemx -mno-backchain
9990 @opindex mbackchain
9991 @opindex mno-backchain
9992 Generate (or do not generate) code which maintains an explicit
9993 backchain within the stack frame that points to the caller's frame.
9994 This is currently needed to allow debugging.  The default is to
9995 generate the backchain.
9997 @item -msmall-exec
9998 @itemx -mno-small-exec
9999 @opindex msmall-exec
10000 @opindex mno-small-exec
10001 Generate (or do not generate) code using the @code{bras} instruction
10002 to do subroutine calls.
10003 This only works reliably if the total executable size does not
10004 exceed 64k.  The default is to use the @code{basr} instruction instead,
10005 which does not have this limitation.
10007 @item -m64
10008 @itemx -m31
10009 @opindex m64
10010 @opindex m31
10011 When @option{-m31} is specified, generate code compliant to the
10012 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10013 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10014 particular to generate 64-bit instructions.  For the @samp{s390}
10015 targets, the default is @option{-m31}, while the @samp{s390x}
10016 targets default to @option{-m64}.
10018 @item -mzarch
10019 @itemx -mesa
10020 @opindex mzarch
10021 @opindex mesa
10022 When @option{-mzarch} is specified, generate code using the 
10023 instructions available on z/Architecture. 
10024 When @option{-mesa} is specified, generate code using the 
10025 instructions available on ESA/390. Note that @option{-mesa} is
10026 not possible with @option{-m64}.
10027 For the @samp{s390} targets, the default is @option{-mesa}, 
10028 while the @samp{s390x} targets default to @option{-mzarch}.
10030 @item -mmvcle
10031 @itemx -mno-mvcle
10032 @opindex mmvcle
10033 @opindex mno-mvcle
10034 Generate (or do not generate) code using the @code{mvcle} instruction
10035 to perform block moves.  When @option{-mno-mvcle} is specified,
10036 use a @code{mvc} loop instead.  This is the default.
10038 @item -mdebug
10039 @itemx -mno-debug
10040 @opindex mdebug
10041 @opindex mno-debug
10042 Print (or do not print) additional debug information when compiling.
10043 The default is to not print debug information.
10045 @item -march=@var{arch}
10046 @opindex march
10047 Generate code that will run on @var{arch}, which is the name of system
10048 representing a certain processor type. Possible values for
10049 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
10051 @item -mtune=@var{arch}
10052 @opindex mtune
10053 Tune to @var{cpu-type} everything applicable about the generated code,
10054  except for the ABI and the set of available instructions. 
10055 The list of @var{arch} values is the same as for @option{-march}.
10057 @end table
10059 @node CRIS Options
10060 @subsection CRIS Options
10061 @cindex CRIS Options
10063 These options are defined specifically for the CRIS ports.
10065 @table @gcctabopt
10066 @item -march=@var{architecture-type}
10067 @itemx -mcpu=@var{architecture-type}
10068 @opindex march
10069 @opindex mcpu
10070 Generate code for the specified architecture.  The choices for
10071 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10072 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10073 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10074 @samp{v10}.
10076 @item -mtune=@var{architecture-type}
10077 @opindex mtune
10078 Tune to @var{architecture-type} everything applicable about the generated
10079 code, except for the ABI and the set of available instructions.  The
10080 choices for @var{architecture-type} are the same as for
10081 @option{-march=@var{architecture-type}}.
10083 @item -mmax-stack-frame=@var{n}
10084 @opindex mmax-stack-frame
10085 Warn when the stack frame of a function exceeds @var{n} bytes.
10087 @item -melinux-stacksize=@var{n}
10088 @opindex melinux-stacksize
10089 Only available with the @samp{cris-axis-aout} target.  Arranges for
10090 indications in the program to the kernel loader that the stack of the
10091 program should be set to @var{n} bytes.
10093 @item -metrax4
10094 @itemx -metrax100
10095 @opindex metrax4
10096 @opindex metrax100
10097 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10098 @option{-march=v3} and @option{-march=v8} respectively.
10100 @item -mpdebug
10101 @opindex mpdebug
10102 Enable CRIS-specific verbose debug-related information in the assembly
10103 code.  This option also has the effect to turn off the @samp{#NO_APP}
10104 formatted-code indicator to the assembler at the beginning of the
10105 assembly file.
10107 @item -mcc-init
10108 @opindex mcc-init
10109 Do not use condition-code results from previous instruction; always emit
10110 compare and test instructions before use of condition codes.
10112 @item -mno-side-effects
10113 @opindex mno-side-effects
10114 Do not emit instructions with side-effects in addressing modes other than
10115 post-increment.
10117 @item -mstack-align
10118 @itemx -mno-stack-align
10119 @itemx -mdata-align
10120 @itemx -mno-data-align
10121 @itemx -mconst-align
10122 @itemx -mno-const-align
10123 @opindex mstack-align
10124 @opindex mno-stack-align
10125 @opindex mdata-align
10126 @opindex mno-data-align
10127 @opindex mconst-align
10128 @opindex mno-const-align
10129 These options (no-options) arranges (eliminate arrangements) for the
10130 stack-frame, individual data and constants to be aligned for the maximum
10131 single data access size for the chosen CPU model.  The default is to
10132 arrange for 32-bit alignment.  ABI details such as structure layout are
10133 not affected by these options.
10135 @item -m32-bit
10136 @itemx -m16-bit
10137 @itemx -m8-bit
10138 @opindex m32-bit
10139 @opindex m16-bit
10140 @opindex m8-bit
10141 Similar to the stack- data- and const-align options above, these options
10142 arrange for stack-frame, writable data and constants to all be 32-bit,
10143 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10145 @item -mno-prologue-epilogue
10146 @itemx -mprologue-epilogue
10147 @opindex mno-prologue-epilogue
10148 @opindex mprologue-epilogue
10149 With @option{-mno-prologue-epilogue}, the normal function prologue and
10150 epilogue that sets up the stack-frame are omitted and no return
10151 instructions or return sequences are generated in the code.  Use this
10152 option only together with visual inspection of the compiled code: no
10153 warnings or errors are generated when call-saved registers must be saved,
10154 or storage for local variable needs to be allocated.
10156 @item -mno-gotplt
10157 @itemx -mgotplt
10158 @opindex mno-gotplt
10159 @opindex mgotplt
10160 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10161 instruction sequences that load addresses for functions from the PLT part
10162 of the GOT rather than (traditional on other architectures) calls to the
10163 PLT.  The default is @option{-mgotplt}.
10165 @item -maout
10166 @opindex maout
10167 Legacy no-op option only recognized with the cris-axis-aout target.
10169 @item -melf
10170 @opindex melf
10171 Legacy no-op option only recognized with the cris-axis-elf and
10172 cris-axis-linux-gnu targets.
10174 @item -melinux
10175 @opindex melinux
10176 Only recognized with the cris-axis-aout target, where it selects a
10177 GNU/linux-like multilib, include files and instruction set for
10178 @option{-march=v8}.
10180 @item -mlinux
10181 @opindex mlinux
10182 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10184 @item -sim
10185 @opindex sim
10186 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10187 to link with input-output functions from a simulator library.  Code,
10188 initialized data and zero-initialized data are allocated consecutively.
10190 @item -sim2
10191 @opindex sim2
10192 Like @option{-sim}, but pass linker options to locate initialized data at
10193 0x40000000 and zero-initialized data at 0x80000000.
10194 @end table
10196 @node MMIX Options
10197 @subsection MMIX Options
10198 @cindex MMIX Options
10200 These options are defined for the MMIX:
10202 @table @gcctabopt
10203 @item -mlibfuncs
10204 @itemx -mno-libfuncs
10205 @opindex mlibfuncs
10206 @opindex mno-libfuncs
10207 Specify that intrinsic library functions are being compiled, passing all
10208 values in registers, no matter the size.
10210 @item -mepsilon
10211 @itemx -mno-epsilon
10212 @opindex mepsilon
10213 @opindex mno-epsilon
10214 Generate floating-point comparison instructions that compare with respect
10215 to the @code{rE} epsilon register.
10217 @item -mabi=mmixware
10218 @itemx -mabi=gnu
10219 @opindex mabi-mmixware
10220 @opindex mabi=gnu
10221 Generate code that passes function parameters and return values that (in
10222 the called function) are seen as registers @code{$0} and up, as opposed to
10223 the GNU ABI which uses global registers @code{$231} and up.
10225 @item -mzero-extend
10226 @itemx -mno-zero-extend
10227 @opindex mzero-extend
10228 @opindex mno-zero-extend
10229 When reading data from memory in sizes shorter than 64 bits, use (do not
10230 use) zero-extending load instructions by default, rather than
10231 sign-extending ones.
10233 @item -mknuthdiv
10234 @itemx -mno-knuthdiv
10235 @opindex mknuthdiv
10236 @opindex mno-knuthdiv
10237 Make the result of a division yielding a remainder have the same sign as
10238 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10239 remainder follows the sign of the dividend.  Both methods are
10240 arithmetically valid, the latter being almost exclusively used.
10242 @item -mtoplevel-symbols
10243 @itemx -mno-toplevel-symbols
10244 @opindex mtoplevel-symbols
10245 @opindex mno-toplevel-symbols
10246 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10247 code can be used with the @code{PREFIX} assembly directive.
10249 @item -melf
10250 @opindex melf
10251 Generate an executable in the ELF format, rather than the default
10252 @samp{mmo} format used by the @command{mmix} simulator.
10254 @item -mbranch-predict
10255 @itemx -mno-branch-predict
10256 @opindex mbranch-predict
10257 @opindex mno-branch-predict
10258 Use (do not use) the probable-branch instructions, when static branch
10259 prediction indicates a probable branch.
10261 @item -mbase-addresses
10262 @itemx -mno-base-addresses
10263 @opindex mbase-addresses
10264 @opindex mno-base-addresses
10265 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10266 base address automatically generates a request (handled by the assembler
10267 and the linker) for a constant to be set up in a global register.  The
10268 register is used for one or more base address requests within the range 0
10269 to 255 from the value held in the register.  The generally leads to short
10270 and fast code, but the number of different data items that can be
10271 addressed is limited.  This means that a program that uses lots of static
10272 data may require @option{-mno-base-addresses}.
10274 @item -msingle-exit
10275 @itemx -mno-single-exit
10276 @opindex msingle-exit
10277 @opindex mno-single-exit
10278 Force (do not force) generated code to have a single exit point in each
10279 function.
10280 @end table
10282 @node PDP-11 Options
10283 @subsection PDP-11 Options
10284 @cindex PDP-11 Options
10286 These options are defined for the PDP-11:
10288 @table @gcctabopt
10289 @item -mfpu
10290 @opindex mfpu
10291 Use hardware FPP floating point.  This is the default.  (FIS floating
10292 point on the PDP-11/40 is not supported.)
10294 @item -msoft-float
10295 @opindex msoft-float
10296 Do not use hardware floating point.
10298 @item -mac0
10299 @opindex mac0
10300 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10302 @item -mno-ac0
10303 @opindex mno-ac0
10304 Return floating-point results in memory.  This is the default.
10306 @item -m40
10307 @opindex m40
10308 Generate code for a PDP-11/40.
10310 @item -m45
10311 @opindex m45
10312 Generate code for a PDP-11/45.  This is the default.
10314 @item -m10
10315 @opindex m10
10316 Generate code for a PDP-11/10.
10318 @item -mbcopy-builtin
10319 @opindex bcopy-builtin
10320 Use inline @code{movstrhi} patterns for copying memory.  This is the
10321 default.
10323 @item -mbcopy
10324 @opindex mbcopy
10325 Do not use inline @code{movstrhi} patterns for copying memory.
10327 @item -mint16
10328 @itemx -mno-int32
10329 @opindex mint16
10330 @opindex mno-int32
10331 Use 16-bit @code{int}.  This is the default.
10333 @item -mint32
10334 @itemx -mno-int16
10335 @opindex mint32
10336 @opindex mno-int16
10337 Use 32-bit @code{int}.
10339 @item -mfloat64
10340 @itemx -mno-float32
10341 @opindex mfloat64
10342 @opindex mno-float32
10343 Use 64-bit @code{float}.  This is the default.
10345 @item -mfloat32
10346 @item -mno-float64
10347 @opindex mfloat32
10348 @opindex mno-float64
10349 Use 32-bit @code{float}.
10351 @item -mabshi
10352 @opindex mabshi
10353 Use @code{abshi2} pattern.  This is the default.
10355 @item -mno-abshi
10356 @opindex mno-abshi
10357 Do not use @code{abshi2} pattern.
10359 @item -mbranch-expensive
10360 @opindex mbranch-expensive
10361 Pretend that branches are expensive.  This is for experimenting with
10362 code generation only.
10364 @item -mbranch-cheap
10365 @opindex mbranch-cheap
10366 Do not pretend that branches are expensive.  This is the default.
10368 @item -msplit
10369 @opindex msplit
10370 Generate code for a system with split I&D.
10372 @item -mno-split
10373 @opindex mno-split
10374 Generate code for a system without split I&D.  This is the default.
10376 @item -munix-asm
10377 @opindex munix-asm
10378 Use Unix assembler syntax.  This is the default when configured for
10379 @samp{pdp11-*-bsd}.
10381 @item -mdec-asm
10382 @opindex mdec-asm
10383 Use DEC assembler syntax.  This is the default when configured for any
10384 PDP-11 target other than @samp{pdp11-*-bsd}.
10385 @end table
10387 @node Xstormy16 Options
10388 @subsection Xstormy16 Options
10389 @cindex Xstormy16 Options
10391 These options are defined for Xstormy16:
10393 @table @gcctabopt
10394 @item -msim
10395 @opindex msim
10396 Choose startup files and linker script suitable for the simulator.
10397 @end table
10399 @node FRV Options
10400 @subsection FRV Options
10401 @cindex FRV Options
10403 @table @gcctabopt
10404 @item -mgpr-32
10405 @opindex mgpr-32
10407 Only use the first 32 general purpose registers.
10409 @item -mgpr-64
10410 @opindex mgpr-64
10412 Use all 64 general purpose registers.
10414 @item -mfpr-32
10415 @opindex mfpr-32
10417 Use only the first 32 floating point registers.
10419 @item -mfpr-64
10420 @opindex mfpr-64
10422 Use all 64 floating point registers
10424 @item -mhard-float
10425 @opindex mhard-float
10427 Use hardware instructions for floating point operations.
10429 @item -msoft-float
10430 @opindex msoft-float
10432 Use library routines for floating point operations.
10434 @item -malloc-cc
10435 @opindex malloc-cc
10437 Dynamically allocate condition code registers.
10439 @item -mfixed-cc
10440 @opindex mfixed-cc
10442 Do not try to dynamically allocate condition code registers, only
10443 use @code{icc0} and @code{fcc0}.
10445 @item -mdword
10446 @opindex mdword
10448 Change ABI to use double word insns.
10450 @item -mno-dword
10451 @opindex mno-dword
10453 Do not use double word instructions.
10455 @item -mdouble
10456 @opindex mdouble
10458 Use floating point double instructions.
10460 @item -mno-double
10461 @opindex mno-double
10463 Do not use floating point double instructions.
10465 @item -mmedia
10466 @opindex mmedia
10468 Use media instructions.
10470 @item -mno-media
10471 @opindex mno-media
10473 Do not use media instructions.
10475 @item -mmuladd
10476 @opindex mmuladd
10478 Use multiply and add/subtract instructions.
10480 @item -mno-muladd
10481 @opindex mno-muladd
10483 Do not use multiply and add/subtract instructions.
10485 @item -mlibrary-pic
10486 @opindex mlibrary-pic
10488 Enable PIC support for building libraries
10490 @item -macc-4
10491 @opindex macc-4
10493 Use only the first four media accumulator registers.
10495 @item -macc-8
10496 @opindex macc-8
10498 Use all eight media accumulator registers.
10500 @item -mpack
10501 @opindex mpack
10503 Pack VLIW instructions.
10505 @item -mno-pack
10506 @opindex mno-pack
10508 Do not pack VLIW instructions.
10510 @item -mno-eflags
10511 @opindex mno-eflags
10513 Do not mark ABI switches in e_flags.
10515 @item -mcond-move
10516 @opindex mcond-move
10518 Enable the use of conditional-move instructions (default).
10520 This switch is mainly for debugging the compiler and will likely be removed
10521 in a future version.
10523 @item -mno-cond-move
10524 @opindex mno-cond-move
10526 Disable the use of conditional-move instructions.
10528 This switch is mainly for debugging the compiler and will likely be removed
10529 in a future version.
10531 @item -mscc
10532 @opindex mscc
10534 Enable the use of conditional set instructions (default).
10536 This switch is mainly for debugging the compiler and will likely be removed
10537 in a future version.
10539 @item -mno-scc
10540 @opindex mno-scc
10542 Disable the use of conditional set instructions.
10544 This switch is mainly for debugging the compiler and will likely be removed
10545 in a future version.
10547 @item -mcond-exec
10548 @opindex mcond-exec
10550 Enable the use of conditional execution (default).
10552 This switch is mainly for debugging the compiler and will likely be removed
10553 in a future version.
10555 @item -mno-cond-exec
10556 @opindex mno-cond-exec
10558 Disable the use of conditional execution.
10560 This switch is mainly for debugging the compiler and will likely be removed
10561 in a future version.
10563 @item -mvliw-branch
10564 @opindex mvliw-branch
10566 Run a pass to pack branches into VLIW instructions (default).
10568 This switch is mainly for debugging the compiler and will likely be removed
10569 in a future version.
10571 @item -mno-vliw-branch
10572 @opindex mno-vliw-branch
10574 Do not run a pass to pack branches into VLIW instructions.
10576 This switch is mainly for debugging the compiler and will likely be removed
10577 in a future version.
10579 @item -mmulti-cond-exec
10580 @opindex mmulti-cond-exec
10582 Enable optimization of @code{&&} and @code{||} in conditional execution
10583 (default).
10585 This switch is mainly for debugging the compiler and will likely be removed
10586 in a future version.
10588 @item -mno-multi-cond-exec
10589 @opindex mno-multi-cond-exec
10591 Disable optimization of @code{&&} and @code{||} in conditional execution.
10593 This switch is mainly for debugging the compiler and will likely be removed
10594 in a future version.
10596 @item -mnested-cond-exec
10597 @opindex mnested-cond-exec
10599 Enable nested conditional execution optimizations (default).
10601 This switch is mainly for debugging the compiler and will likely be removed
10602 in a future version.
10604 @item -mno-nested-cond-exec
10605 @opindex mno-nested-cond-exec
10607 Disable nested conditional execution optimizations.
10609 This switch is mainly for debugging the compiler and will likely be removed
10610 in a future version.
10612 @item -mtomcat-stats
10613 @opindex mtomcat-stats
10615 Cause gas to print out tomcat statistics.
10617 @item -mcpu=@var{cpu}
10618 @opindex mcpu
10620 Select the processor type for which to generate code.  Possible values are
10621 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10622 @samp{frv}.
10624 @end table
10626 @node Xtensa Options
10627 @subsection Xtensa Options
10628 @cindex Xtensa Options
10630 The Xtensa architecture is designed to support many different
10631 configurations.  The compiler's default options can be set to match a
10632 particular Xtensa configuration by copying a configuration file into the
10633 GCC sources when building GCC@.  The options below may be used to
10634 override the default options.
10636 @table @gcctabopt
10637 @item -mbig-endian
10638 @itemx -mlittle-endian
10639 @opindex mbig-endian
10640 @opindex mlittle-endian
10641 Specify big-endian or little-endian byte ordering for the target Xtensa
10642 processor.
10644 @item -mdensity
10645 @itemx -mno-density
10646 @opindex mdensity
10647 @opindex mno-density
10648 Enable or disable use of the optional Xtensa code density instructions.
10650 @item -mconst16
10651 @itemx -mno-const16
10652 @opindex mconst16
10653 @opindex mno-const16
10654 Enable or disable use of @code{CONST16} instructions for loading
10655 constant values.  The @code{CONST16} instruction is currently not a
10656 standard option from Tensilica.  When enabled, @code{CONST16}
10657 instructions are always used in place of the standard @code{L32R}
10658 instructions.  The use of @code{CONST16} is enabled by default only if
10659 the @code{L32R} instruction is not available.
10661 @item -mabs
10662 @itemx -mno-abs
10663 @opindex mabs
10664 @opindex mno-abs
10665 Enable or disable use of the Xtensa @code{ABS} instruction for absolute
10666 value operations.
10668 @item -maddx
10669 @itemx -mno-addx
10670 @opindex maddx
10671 @opindex mno-addx
10672 Enable or disable use of the Xtensa @code{ADDX} and @code{SUBX}
10673 instructions.
10675 @item -mmac16
10676 @itemx -mno-mac16
10677 @opindex mmac16
10678 @opindex mno-mac16
10679 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10680 will generate MAC16 instructions from standard C code, with the
10681 limitation that it will use neither the MR register file nor any
10682 instruction that operates on the MR registers.  When this option is
10683 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10684 combination of core instructions and library calls, depending on whether
10685 any other multiplier options are enabled.
10687 @item -mmul16
10688 @itemx -mno-mul16
10689 @opindex mmul16
10690 @opindex mno-mul16
10691 Enable or disable use of the 16-bit integer multiplier option.  When
10692 enabled, the compiler will generate 16-bit multiply instructions for
10693 multiplications of 16 bits or smaller in standard C code.  When this
10694 option is disabled, the compiler will either use 32-bit multiply or
10695 MAC16 instructions if they are available or generate library calls to
10696 perform the multiply operations using shifts and adds.
10698 @item -mmul32
10699 @itemx -mno-mul32
10700 @opindex mmul32
10701 @opindex mno-mul32
10702 Enable or disable use of the 32-bit integer multiplier option.  When
10703 enabled, the compiler will generate 32-bit multiply instructions for
10704 multiplications of 32 bits or smaller in standard C code.  When this
10705 option is disabled, the compiler will generate library calls to perform
10706 the multiply operations using either shifts and adds or 16-bit multiply
10707 instructions if they are available.
10709 @item -mnsa
10710 @itemx -mno-nsa
10711 @opindex mnsa
10712 @opindex mno-nsa
10713 Enable or disable use of the optional normalization shift amount
10714 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10716 @item -mminmax
10717 @itemx -mno-minmax
10718 @opindex mminmax
10719 @opindex mno-minmax
10720 Enable or disable use of the optional minimum and maximum value
10721 instructions.
10723 @item -msext
10724 @itemx -mno-sext
10725 @opindex msext
10726 @opindex mno-sext
10727 Enable or disable use of the optional sign extend (@code{SEXT})
10728 instruction.
10730 @item -mbooleans
10731 @itemx -mno-booleans
10732 @opindex mbooleans
10733 @opindex mno-booleans
10734 Enable or disable support for the boolean register file used by Xtensa
10735 coprocessors.  This is not typically useful by itself but may be
10736 required for other options that make use of the boolean registers (e.g.,
10737 the floating-point option).
10739 @item -mhard-float
10740 @itemx -msoft-float
10741 @opindex mhard-float
10742 @opindex msoft-float
10743 Enable or disable use of the floating-point option.  When enabled, GCC
10744 generates floating-point instructions for 32-bit @code{float}
10745 operations.  When this option is disabled, GCC generates library calls
10746 to emulate 32-bit floating-point operations using integer instructions.
10747 Regardless of this option, 64-bit @code{double} operations are always
10748 emulated with calls to library functions.
10750 @item -mfused-madd
10751 @itemx -mno-fused-madd
10752 @opindex mfused-madd
10753 @opindex mno-fused-madd
10754 Enable or disable use of fused multiply/add and multiply/subtract
10755 instructions in the floating-point option.  This has no effect if the
10756 floating-point option is not also enabled.  Disabling fused multiply/add
10757 and multiply/subtract instructions forces the compiler to use separate
10758 instructions for the multiply and add/subtract operations.  This may be
10759 desirable in some cases where strict IEEE 754-compliant results are
10760 required: the fused multiply add/subtract instructions do not round the
10761 intermediate result, thereby producing results with @emph{more} bits of
10762 precision than specified by the IEEE standard.  Disabling fused multiply
10763 add/subtract instructions also ensures that the program output is not
10764 sensitive to the compiler's ability to combine multiply and add/subtract
10765 operations.
10767 @item -mserialize-volatile
10768 @itemx -mno-serialize-volatile
10769 @opindex mserialize-volatile
10770 @opindex mno-serialize-volatile
10771 When this option is enabled, GCC inserts @code{MEMW} instructions before
10772 @code{volatile} memory references to guarantee sequential consistency.
10773 The default is @option{-mserialize-volatile}.  Use
10774 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10776 @item -mtext-section-literals
10777 @itemx -mno-text-section-literals
10778 @opindex mtext-section-literals
10779 @opindex mno-text-section-literals
10780 Control the treatment of literal pools.  The default is
10781 @option{-mno-text-section-literals}, which places literals in a separate
10782 section in the output file.  This allows the literal pool to be placed
10783 in a data RAM/ROM, and it also allows the linker to combine literal
10784 pools from separate object files to remove redundant literals and
10785 improve code size.  With @option{-mtext-section-literals}, the literals
10786 are interspersed in the text section in order to keep them as close as
10787 possible to their references.  This may be necessary for large assembly
10788 files.
10790 @item -mtarget-align
10791 @itemx -mno-target-align
10792 @opindex mtarget-align
10793 @opindex mno-target-align
10794 When this option is enabled, GCC instructs the assembler to
10795 automatically align instructions to reduce branch penalties at the
10796 expense of some code density.  The assembler attempts to widen density
10797 instructions to align branch targets and the instructions following call
10798 instructions.  If there are not enough preceding safe density
10799 instructions to align a target, no widening will be performed.  The
10800 default is @option{-mtarget-align}.  These options do not affect the
10801 treatment of auto-aligned instructions like @code{LOOP}, which the
10802 assembler will always align, either by widening density instructions or
10803 by inserting no-op instructions.
10805 @item -mlongcalls
10806 @itemx -mno-longcalls
10807 @opindex mlongcalls
10808 @opindex mno-longcalls
10809 When this option is enabled, GCC instructs the assembler to translate
10810 direct calls to indirect calls unless it can determine that the target
10811 of a direct call is in the range allowed by the call instruction.  This
10812 translation typically occurs for calls to functions in other source
10813 files.  Specifically, the assembler translates a direct @code{CALL}
10814 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10815 The default is @option{-mno-longcalls}.  This option should be used in
10816 programs where the call target can potentially be out of range.  This
10817 option is implemented in the assembler, not the compiler, so the
10818 assembly code generated by GCC will still show direct call
10819 instructions---look at the disassembled object code to see the actual
10820 instructions.  Note that the assembler will use an indirect call for
10821 every cross-file call, not just those that really will be out of range.
10822 @end table
10824 @node Code Gen Options
10825 @section Options for Code Generation Conventions
10826 @cindex code generation conventions
10827 @cindex options, code generation
10828 @cindex run-time options
10830 These machine-independent options control the interface conventions
10831 used in code generation.
10833 Most of them have both positive and negative forms; the negative form
10834 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10835 one of the forms is listed---the one which is not the default.  You
10836 can figure out the other form by either removing @samp{no-} or adding
10839 @table @gcctabopt
10840 @item -fbounds-check
10841 @opindex fbounds-check
10842 For front-ends that support it, generate additional code to check that
10843 indices used to access arrays are within the declared range.  This is
10844 currently only supported by the Java and Fortran 77 front-ends, where
10845 this option defaults to true and false respectively.
10847 @item -ftrapv
10848 @opindex ftrapv
10849 This option generates traps for signed overflow on addition, subtraction,
10850 multiplication operations.
10852 @item -fexceptions
10853 @opindex fexceptions
10854 Enable exception handling.  Generates extra code needed to propagate
10855 exceptions.  For some targets, this implies GCC will generate frame
10856 unwind information for all functions, which can produce significant data
10857 size overhead, although it does not affect execution.  If you do not
10858 specify this option, GCC will enable it by default for languages like
10859 C++ which normally require exception handling, and disable it for
10860 languages like C that do not normally require it.  However, you may need
10861 to enable this option when compiling C code that needs to interoperate
10862 properly with exception handlers written in C++.  You may also wish to
10863 disable this option if you are compiling older C++ programs that don't
10864 use exception handling.
10866 @item -fnon-call-exceptions
10867 @opindex fnon-call-exceptions
10868 Generate code that allows trapping instructions to throw exceptions.
10869 Note that this requires platform-specific runtime support that does
10870 not exist everywhere.  Moreover, it only allows @emph{trapping}
10871 instructions to throw exceptions, i.e.@: memory references or floating
10872 point instructions.  It does not allow exceptions to be thrown from
10873 arbitrary signal handlers such as @code{SIGALRM}.
10875 @item -funwind-tables
10876 @opindex funwind-tables
10877 Similar to @option{-fexceptions}, except that it will just generate any needed
10878 static data, but will not affect the generated code in any other way.
10879 You will normally not enable this option; instead, a language processor
10880 that needs this handling would enable it on your behalf.
10882 @item -fasynchronous-unwind-tables
10883 @opindex funwind-tables
10884 Generate unwind table in dwarf2 format, if supported by target machine.  The
10885 table is exact at each instruction boundary, so it can be used for stack
10886 unwinding from asynchronous events (such as debugger or garbage collector).
10888 @item -fpcc-struct-return
10889 @opindex fpcc-struct-return
10890 Return ``short'' @code{struct} and @code{union} values in memory like
10891 longer ones, rather than in registers.  This convention is less
10892 efficient, but it has the advantage of allowing intercallability between
10893 GCC-compiled files and files compiled with other compilers, particularly
10894 the Portable C Compiler (pcc).
10896 The precise convention for returning structures in memory depends
10897 on the target configuration macros.
10899 Short structures and unions are those whose size and alignment match
10900 that of some integer type.
10902 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10903 switch is not binary compatible with code compiled with the
10904 @option{-freg-struct-return} switch.
10905 Use it to conform to a non-default application binary interface.
10907 @item -freg-struct-return
10908 @opindex freg-struct-return
10909 Return @code{struct} and @code{union} values in registers when possible.
10910 This is more efficient for small structures than
10911 @option{-fpcc-struct-return}.
10913 If you specify neither @option{-fpcc-struct-return} nor
10914 @option{-freg-struct-return}, GCC defaults to whichever convention is
10915 standard for the target.  If there is no standard convention, GCC
10916 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10917 the principal compiler.  In those cases, we can choose the standard, and
10918 we chose the more efficient register return alternative.
10920 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10921 switch is not binary compatible with code compiled with the
10922 @option{-fpcc-struct-return} switch.
10923 Use it to conform to a non-default application binary interface.
10925 @item -fshort-enums
10926 @opindex fshort-enums
10927 Allocate to an @code{enum} type only as many bytes as it needs for the
10928 declared range of possible values.  Specifically, the @code{enum} type
10929 will be equivalent to the smallest integer type which has enough room.
10931 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10932 code that is not binary compatible with code generated without that switch.
10933 Use it to conform to a non-default application binary interface.
10935 @item -fshort-double
10936 @opindex fshort-double
10937 Use the same size for @code{double} as for @code{float}.
10939 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10940 code that is not binary compatible with code generated without that switch.
10941 Use it to conform to a non-default application binary interface.
10943 @item -fshort-wchar
10944 @opindex fshort-wchar
10945 Override the underlying type for @samp{wchar_t} to be @samp{short
10946 unsigned int} instead of the default for the target.  This option is
10947 useful for building programs to run under WINE@.
10949 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10950 code that is not binary compatible with code generated without that switch.
10951 Use it to conform to a non-default application binary interface.
10953 @item -fshared-data
10954 @opindex fshared-data
10955 Requests that the data and non-@code{const} variables of this
10956 compilation be shared data rather than private data.  The distinction
10957 makes sense only on certain operating systems, where shared data is
10958 shared between processes running the same program, while private data
10959 exists in one copy per process.
10961 @item -fno-common
10962 @opindex fno-common
10963 In C, allocate even uninitialized global variables in the data section of the
10964 object file, rather than generating them as common blocks.  This has the
10965 effect that if the same variable is declared (without @code{extern}) in
10966 two different compilations, you will get an error when you link them.
10967 The only reason this might be useful is if you wish to verify that the
10968 program will work on other systems which always work this way.
10970 @item -fno-ident
10971 @opindex fno-ident
10972 Ignore the @samp{#ident} directive.
10974 @item -fno-gnu-linker
10975 @opindex fno-gnu-linker
10976 Do not output global initializations (such as C++ constructors and
10977 destructors) in the form used by the GNU linker (on systems where the GNU
10978 linker is the standard method of handling them).  Use this option when
10979 you want to use a non-GNU linker, which also requires using the
10980 @command{collect2} program to make sure the system linker includes
10981 constructors and destructors.  (@command{collect2} is included in the GCC
10982 distribution.)  For systems which @emph{must} use @command{collect2}, the
10983 compiler driver @command{gcc} is configured to do this automatically.
10985 @item -finhibit-size-directive
10986 @opindex finhibit-size-directive
10987 Don't output a @code{.size} assembler directive, or anything else that
10988 would cause trouble if the function is split in the middle, and the
10989 two halves are placed at locations far apart in memory.  This option is
10990 used when compiling @file{crtstuff.c}; you should not need to use it
10991 for anything else.
10993 @item -fverbose-asm
10994 @opindex fverbose-asm
10995 Put extra commentary information in the generated assembly code to
10996 make it more readable.  This option is generally only of use to those
10997 who actually need to read the generated assembly code (perhaps while
10998 debugging the compiler itself).
11000 @option{-fno-verbose-asm}, the default, causes the
11001 extra information to be omitted and is useful when comparing two assembler
11002 files.
11004 @item -fpic
11005 @opindex fpic
11006 @cindex global offset table
11007 @cindex PIC
11008 Generate position-independent code (PIC) suitable for use in a shared
11009 library, if supported for the target machine.  Such code accesses all
11010 constant addresses through a global offset table (GOT)@.  The dynamic
11011 loader resolves the GOT entries when the program starts (the dynamic
11012 loader is not part of GCC; it is part of the operating system).  If
11013 the GOT size for the linked executable exceeds a machine-specific
11014 maximum size, you get an error message from the linker indicating that
11015 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11016 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11017 on the m68k and RS/6000.  The 386 has no such limit.)
11019 Position-independent code requires special support, and therefore works
11020 only on certain machines.  For the 386, GCC supports PIC for System V
11021 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11022 position-independent.
11024 @item -fPIC
11025 @opindex fPIC
11026 If supported for the target machine, emit position-independent code,
11027 suitable for dynamic linking and avoiding any limit on the size of the
11028 global offset table.  This option makes a difference on the m68k, m88k,
11029 and the SPARC.
11031 Position-independent code requires special support, and therefore works
11032 only on certain machines.
11034 @item -ffixed-@var{reg}
11035 @opindex ffixed
11036 Treat the register named @var{reg} as a fixed register; generated code
11037 should never refer to it (except perhaps as a stack pointer, frame
11038 pointer or in some other fixed role).
11040 @var{reg} must be the name of a register.  The register names accepted
11041 are machine-specific and are defined in the @code{REGISTER_NAMES}
11042 macro in the machine description macro file.
11044 This flag does not have a negative form, because it specifies a
11045 three-way choice.
11047 @item -fcall-used-@var{reg}
11048 @opindex fcall-used
11049 Treat the register named @var{reg} as an allocable register that is
11050 clobbered by function calls.  It may be allocated for temporaries or
11051 variables that do not live across a call.  Functions compiled this way
11052 will not save and restore the register @var{reg}.
11054 It is an error to used this flag with the frame pointer or stack pointer.
11055 Use of this flag for other registers that have fixed pervasive roles in
11056 the machine's execution model will produce disastrous results.
11058 This flag does not have a negative form, because it specifies a
11059 three-way choice.
11061 @item -fcall-saved-@var{reg}
11062 @opindex fcall-saved
11063 Treat the register named @var{reg} as an allocable register saved by
11064 functions.  It may be allocated even for temporaries or variables that
11065 live across a call.  Functions compiled this way will save and restore
11066 the register @var{reg} if they use it.
11068 It is an error to used this flag with the frame pointer or stack pointer.
11069 Use of this flag for other registers that have fixed pervasive roles in
11070 the machine's execution model will produce disastrous results.
11072 A different sort of disaster will result from the use of this flag for
11073 a register in which function values may be returned.
11075 This flag does not have a negative form, because it specifies a
11076 three-way choice.
11078 @item -fpack-struct
11079 @opindex fpack-struct
11080 Pack all structure members together without holes.
11082 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11083 code that is not binary compatible with code generated without that switch.
11084 Additionally, it makes the code suboptimal.
11085 Use it to conform to a non-default application binary interface.
11087 @item -finstrument-functions
11088 @opindex finstrument-functions
11089 Generate instrumentation calls for entry and exit to functions.  Just
11090 after function entry and just before function exit, the following
11091 profiling functions will be called with the address of the current
11092 function and its call site.  (On some platforms,
11093 @code{__builtin_return_address} does not work beyond the current
11094 function, so the call site information may not be available to the
11095 profiling functions otherwise.)
11097 @example
11098 void __cyg_profile_func_enter (void *this_fn,
11099                                void *call_site);
11100 void __cyg_profile_func_exit  (void *this_fn,
11101                                void *call_site);
11102 @end example
11104 The first argument is the address of the start of the current function,
11105 which may be looked up exactly in the symbol table.
11107 This instrumentation is also done for functions expanded inline in other
11108 functions.  The profiling calls will indicate where, conceptually, the
11109 inline function is entered and exited.  This means that addressable
11110 versions of such functions must be available.  If all your uses of a
11111 function are expanded inline, this may mean an additional expansion of
11112 code size.  If you use @samp{extern inline} in your C code, an
11113 addressable version of such functions must be provided.  (This is
11114 normally the case anyways, but if you get lucky and the optimizer always
11115 expands the functions inline, you might have gotten away without
11116 providing static copies.)
11118 A function may be given the attribute @code{no_instrument_function}, in
11119 which case this instrumentation will not be done.  This can be used, for
11120 example, for the profiling functions listed above, high-priority
11121 interrupt routines, and any functions from which the profiling functions
11122 cannot safely be called (perhaps signal handlers, if the profiling
11123 routines generate output or allocate memory).
11125 @item -fstack-check
11126 @opindex fstack-check
11127 Generate code to verify that you do not go beyond the boundary of the
11128 stack.  You should specify this flag if you are running in an
11129 environment with multiple threads, but only rarely need to specify it in
11130 a single-threaded environment since stack overflow is automatically
11131 detected on nearly all systems if there is only one stack.
11133 Note that this switch does not actually cause checking to be done; the
11134 operating system must do that.  The switch causes generation of code
11135 to ensure that the operating system sees the stack being extended.
11137 @item -fstack-limit-register=@var{reg}
11138 @itemx -fstack-limit-symbol=@var{sym}
11139 @itemx -fno-stack-limit
11140 @opindex fstack-limit-register
11141 @opindex fstack-limit-symbol
11142 @opindex fno-stack-limit
11143 Generate code to ensure that the stack does not grow beyond a certain value,
11144 either the value of a register or the address of a symbol.  If the stack
11145 would grow beyond the value, a signal is raised.  For most targets,
11146 the signal is raised before the stack overruns the boundary, so
11147 it is possible to catch the signal without taking special precautions.
11149 For instance, if the stack starts at absolute address @samp{0x80000000}
11150 and grows downwards, you can use the flags
11151 @option{-fstack-limit-symbol=__stack_limit} and
11152 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11153 of 128KB@.  Note that this may only work with the GNU linker.
11155 @cindex aliasing of parameters
11156 @cindex parameters, aliased
11157 @item -fargument-alias
11158 @itemx -fargument-noalias
11159 @itemx -fargument-noalias-global
11160 @opindex fargument-alias
11161 @opindex fargument-noalias
11162 @opindex fargument-noalias-global
11163 Specify the possible relationships among parameters and between
11164 parameters and global data.
11166 @option{-fargument-alias} specifies that arguments (parameters) may
11167 alias each other and may alias global storage.@*
11168 @option{-fargument-noalias} specifies that arguments do not alias
11169 each other, but may alias global storage.@*
11170 @option{-fargument-noalias-global} specifies that arguments do not
11171 alias each other and do not alias global storage.
11173 Each language will automatically use whatever option is required by
11174 the language standard.  You should not need to use these options yourself.
11176 @item -fleading-underscore
11177 @opindex fleading-underscore
11178 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11179 change the way C symbols are represented in the object file.  One use
11180 is to help link with legacy assembly code.
11182 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11183 generate code that is not binary compatible with code generated without that
11184 switch.  Use it to conform to a non-default application binary interface.
11185 Not all targets provide complete support for this switch.
11187 @item -ftls-model=@var{model}
11188 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11189 The @var{model} argument should be one of @code{global-dynamic},
11190 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11192 The default without @option{-fpic} is @code{initial-exec}; with
11193 @option{-fpic} the default is @code{global-dynamic}.
11194 @end table
11196 @c man end
11198 @node Environment Variables
11199 @section Environment Variables Affecting GCC
11200 @cindex environment variables
11202 @c man begin ENVIRONMENT
11203 This section describes several environment variables that affect how GCC
11204 operates.  Some of them work by specifying directories or prefixes to use
11205 when searching for various kinds of files.  Some are used to specify other
11206 aspects of the compilation environment.
11208 Note that you can also specify places to search using options such as
11209 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11210 take precedence over places specified using environment variables, which
11211 in turn take precedence over those specified by the configuration of GCC@.
11212 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11213 GNU Compiler Collection (GCC) Internals}.
11215 @table @env
11216 @item LANG
11217 @itemx LC_CTYPE
11218 @c @itemx LC_COLLATE
11219 @itemx LC_MESSAGES
11220 @c @itemx LC_MONETARY
11221 @c @itemx LC_NUMERIC
11222 @c @itemx LC_TIME
11223 @itemx LC_ALL
11224 @findex LANG
11225 @findex LC_CTYPE
11226 @c @findex LC_COLLATE
11227 @findex LC_MESSAGES
11228 @c @findex LC_MONETARY
11229 @c @findex LC_NUMERIC
11230 @c @findex LC_TIME
11231 @findex LC_ALL
11232 @cindex locale
11233 These environment variables control the way that GCC uses
11234 localization information that allow GCC to work with different
11235 national conventions.  GCC inspects the locale categories
11236 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11237 so.  These locale categories can be set to any value supported by your
11238 installation.  A typical value is @samp{en_UK} for English in the United
11239 Kingdom.
11241 The @env{LC_CTYPE} environment variable specifies character
11242 classification.  GCC uses it to determine the character boundaries in
11243 a string; this is needed for some multibyte encodings that contain quote
11244 and escape characters that would otherwise be interpreted as a string
11245 end or escape.
11247 The @env{LC_MESSAGES} environment variable specifies the language to
11248 use in diagnostic messages.
11250 If the @env{LC_ALL} environment variable is set, it overrides the value
11251 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11252 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11253 environment variable.  If none of these variables are set, GCC
11254 defaults to traditional C English behavior.
11256 @item TMPDIR
11257 @findex TMPDIR
11258 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11259 files.  GCC uses temporary files to hold the output of one stage of
11260 compilation which is to be used as input to the next stage: for example,
11261 the output of the preprocessor, which is the input to the compiler
11262 proper.
11264 @item GCC_EXEC_PREFIX
11265 @findex GCC_EXEC_PREFIX
11266 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11267 names of the subprograms executed by the compiler.  No slash is added
11268 when this prefix is combined with the name of a subprogram, but you can
11269 specify a prefix that ends with a slash if you wish.
11271 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11272 an appropriate prefix to use based on the pathname it was invoked with.
11274 If GCC cannot find the subprogram using the specified prefix, it
11275 tries looking in the usual places for the subprogram.
11277 The default value of @env{GCC_EXEC_PREFIX} is
11278 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11279 of @code{prefix} when you ran the @file{configure} script.
11281 Other prefixes specified with @option{-B} take precedence over this prefix.
11283 This prefix is also used for finding files such as @file{crt0.o} that are
11284 used for linking.
11286 In addition, the prefix is used in an unusual way in finding the
11287 directories to search for header files.  For each of the standard
11288 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11289 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11290 replacing that beginning with the specified prefix to produce an
11291 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11292 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11293 These alternate directories are searched first; the standard directories
11294 come next.
11296 @item COMPILER_PATH
11297 @findex COMPILER_PATH
11298 The value of @env{COMPILER_PATH} is a colon-separated list of
11299 directories, much like @env{PATH}.  GCC tries the directories thus
11300 specified when searching for subprograms, if it can't find the
11301 subprograms using @env{GCC_EXEC_PREFIX}.
11303 @item LIBRARY_PATH
11304 @findex LIBRARY_PATH
11305 The value of @env{LIBRARY_PATH} is a colon-separated list of
11306 directories, much like @env{PATH}.  When configured as a native compiler,
11307 GCC tries the directories thus specified when searching for special
11308 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11309 using GCC also uses these directories when searching for ordinary
11310 libraries for the @option{-l} option (but directories specified with
11311 @option{-L} come first).
11313 @item LANG
11314 @findex LANG
11315 @cindex locale definition
11316 This variable is used to pass locale information to the compiler.  One way in
11317 which this information is used is to determine the character set to be used
11318 when character literals, string literals and comments are parsed in C and C++.
11319 When the compiler is configured to allow multibyte characters,
11320 the following values for @env{LANG} are recognized:
11322 @table @samp
11323 @item C-JIS
11324 Recognize JIS characters.
11325 @item C-SJIS
11326 Recognize SJIS characters.
11327 @item C-EUCJP
11328 Recognize EUCJP characters.
11329 @end table
11331 If @env{LANG} is not defined, or if it has some other value, then the
11332 compiler will use mblen and mbtowc as defined by the default locale to
11333 recognize and translate multibyte characters.
11334 @end table
11336 @noindent
11337 Some additional environments variables affect the behavior of the
11338 preprocessor.
11340 @include cppenv.texi
11342 @c man end
11344 @node Precompiled Headers
11345 @section Using Precompiled Headers
11346 @cindex precompiled headers
11347 @cindex speed of compilation
11349 Often large projects have many header files that are included in every
11350 source file.  The time the compiler takes to process these header files
11351 over and over again can account for nearly all of the time required to
11352 build the project.  To make builds faster, GCC allows users to
11353 `precompile' a header file; then, if builds can use the precompiled
11354 header file they will be much faster.
11356 To create a precompiled header file, simply compile it as you would any
11357 other file, if necessary using the @option{-x} option to make the driver
11358 treat it as a C or C++ header file.  You will probably want to use a
11359 tool like @command{make} to keep the precompiled header up-to-date when
11360 the headers it contains change.
11362 A precompiled header file will be searched for when @code{#include} is
11363 seen in the compilation.  As it searches for the included file
11364 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11365 compiler looks for a precompiled header in each directory just before it
11366 looks for the include file in that directory.  The name searched for is
11367 the name specified in the @code{#include} with @samp{.gch} appended.  If
11368 the precompiled header file can't be used, it is ignored.
11370 For instance, if you have @code{#include "all.h"}, and you have
11371 @file{all.h.gch} in the same directory as @file{all.h}, then the
11372 precompiled header file will be used if possible, and the original
11373 header will be used otherwise.
11375 Alternatively, you might decide to put the precompiled header file in a
11376 directory and use @option{-I} to ensure that directory is searched
11377 before (or instead of) the directory containing the original header.
11378 Then, if you want to check that the precompiled header file is always
11379 used, you can put a file of the same name as the original header in this
11380 directory containing an @code{#error} command.
11382 This also works with @option{-include}.  So yet another way to use
11383 precompiled headers, good for projects not designed with precompiled
11384 header files in mind, is to simply take most of the header files used by
11385 a project, include them from another header file, precompile that header
11386 file, and @option{-include} the precompiled header.  If the header files
11387 have guards against multiple inclusion, they will be skipped because
11388 they've already been included (in the precompiled header).
11390 If you need to precompile the same header file for different
11391 languages, targets, or compiler options, you can instead make a
11392 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11393 header in the directory.  (It doesn't matter what you call the files
11394 in the directory, every precompiled header in the directory will be
11395 considered.)  The first precompiled header encountered in the
11396 directory that is valid for this compilation will be used; they're
11397 searched in no particular order.
11399 There are many other possibilities, limited only by your imagination,
11400 good sense, and the constraints of your build system.
11402 A precompiled header file can be used only when these conditions apply:
11404 @itemize
11405 @item
11406 Only one precompiled header can be used in a particular compilation.
11407 @item
11408 A precompiled header can't be used once the first C token is seen.  You
11409 can have preprocessor directives before a precompiled header; you can
11410 even include a precompiled header from inside another header, so long as
11411 there are no C tokens before the @code{#include}.
11412 @item
11413 The precompiled header file must be produced for the same language as
11414 the current compilation.  You can't use a C precompiled header for a C++
11415 compilation.
11416 @item
11417 The precompiled header file must be produced by the same compiler
11418 version and configuration as the current compilation is using.
11419 The easiest way to guarantee this is to use the same compiler binary
11420 for creating and using precompiled headers.
11421 @item
11422 Any macros defined before the precompiled header (including with
11423 @option{-D}) must either be defined in the same way as when the
11424 precompiled header was generated, or must not affect the precompiled
11425 header, which usually means that the they don't appear in the
11426 precompiled header at all.
11427 @item
11428 Certain command-line options must be defined in the same way as when the
11429 precompiled header was generated.  At present, it's not clear which
11430 options are safe to change and which are not; the safest choice is to
11431 use exactly the same options when generating and using the precompiled
11432 header.
11433 @end itemize
11435 For all of these but the last, the compiler will automatically ignore
11436 the precompiled header if the conditions aren't met.  For the last item,
11437 some option changes will cause the precompiled header to be rejected,
11438 but not all incompatible option combinations have yet been found.  If
11439 you find a new incompatible combination, please consider filing a bug
11440 report, see @ref{Bugs}.
11442 @node Running Protoize
11443 @section Running Protoize
11445 The program @code{protoize} is an optional part of GCC@.  You can use
11446 it to add prototypes to a program, thus converting the program to ISO
11447 C in one respect.  The companion program @code{unprotoize} does the
11448 reverse: it removes argument types from any prototypes that are found.
11450 When you run these programs, you must specify a set of source files as
11451 command line arguments.  The conversion programs start out by compiling
11452 these files to see what functions they define.  The information gathered
11453 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11455 After scanning comes actual conversion.  The specified files are all
11456 eligible to be converted; any files they include (whether sources or
11457 just headers) are eligible as well.
11459 But not all the eligible files are converted.  By default,
11460 @code{protoize} and @code{unprotoize} convert only source and header
11461 files in the current directory.  You can specify additional directories
11462 whose files should be converted with the @option{-d @var{directory}}
11463 option.  You can also specify particular files to exclude with the
11464 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11465 directory name matches one of the specified directory names, and its
11466 name within the directory has not been excluded.
11468 Basic conversion with @code{protoize} consists of rewriting most
11469 function definitions and function declarations to specify the types of
11470 the arguments.  The only ones not rewritten are those for varargs
11471 functions.
11473 @code{protoize} optionally inserts prototype declarations at the
11474 beginning of the source file, to make them available for any calls that
11475 precede the function's definition.  Or it can insert prototype
11476 declarations with block scope in the blocks where undeclared functions
11477 are called.
11479 Basic conversion with @code{unprotoize} consists of rewriting most
11480 function declarations to remove any argument types, and rewriting
11481 function definitions to the old-style pre-ISO form.
11483 Both conversion programs print a warning for any function declaration or
11484 definition that they can't convert.  You can suppress these warnings
11485 with @option{-q}.
11487 The output from @code{protoize} or @code{unprotoize} replaces the
11488 original source file.  The original file is renamed to a name ending
11489 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11490 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11491 for DOS) file already exists, then the source file is simply discarded.
11493 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11494 scan the program and collect information about the functions it uses.
11495 So neither of these programs will work until GCC is installed.
11497 Here is a table of the options you can use with @code{protoize} and
11498 @code{unprotoize}.  Each option works with both programs unless
11499 otherwise stated.
11501 @table @code
11502 @item -B @var{directory}
11503 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11504 usual directory (normally @file{/usr/local/lib}).  This file contains
11505 prototype information about standard system functions.  This option
11506 applies only to @code{protoize}.
11508 @item -c @var{compilation-options}
11509 Use @var{compilation-options} as the options when running @command{gcc} to
11510 produce the @samp{.X} files.  The special option @option{-aux-info} is
11511 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11513 Note that the compilation options must be given as a single argument to
11514 @code{protoize} or @code{unprotoize}.  If you want to specify several
11515 @command{gcc} options, you must quote the entire set of compilation options
11516 to make them a single word in the shell.
11518 There are certain @command{gcc} arguments that you cannot use, because they
11519 would produce the wrong kind of output.  These include @option{-g},
11520 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11521 the @var{compilation-options}, they are ignored.
11523 @item -C
11524 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11525 systems) instead of @samp{.c}.  This is convenient if you are converting
11526 a C program to C++.  This option applies only to @code{protoize}.
11528 @item -g
11529 Add explicit global declarations.  This means inserting explicit
11530 declarations at the beginning of each source file for each function
11531 that is called in the file and was not declared.  These declarations
11532 precede the first function definition that contains a call to an
11533 undeclared function.  This option applies only to @code{protoize}.
11535 @item -i @var{string}
11536 Indent old-style parameter declarations with the string @var{string}.
11537 This option applies only to @code{protoize}.
11539 @code{unprotoize} converts prototyped function definitions to old-style
11540 function definitions, where the arguments are declared between the
11541 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11542 uses five spaces as the indentation.  If you want to indent with just
11543 one space instead, use @option{-i " "}.
11545 @item -k
11546 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11547 is finished.
11549 @item -l
11550 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11551 a prototype declaration for each function in each block which calls the
11552 function without any declaration.  This option applies only to
11553 @code{protoize}.
11555 @item -n
11556 Make no real changes.  This mode just prints information about the conversions
11557 that would have been done without @option{-n}.
11559 @item -N
11560 Make no @samp{.save} files.  The original files are simply deleted.
11561 Use this option with caution.
11563 @item -p @var{program}
11564 Use the program @var{program} as the compiler.  Normally, the name
11565 @file{gcc} is used.
11567 @item -q
11568 Work quietly.  Most warnings are suppressed.
11570 @item -v
11571 Print the version number, just like @option{-v} for @command{gcc}.
11572 @end table
11574 If you need special compiler options to compile one of your program's
11575 source files, then you should generate that file's @samp{.X} file
11576 specially, by running @command{gcc} on that source file with the
11577 appropriate options and the option @option{-aux-info}.  Then run
11578 @code{protoize} on the entire set of files.  @code{protoize} will use
11579 the existing @samp{.X} file because it is newer than the source file.
11580 For example:
11582 @example
11583 gcc -Dfoo=bar file1.c -aux-info file1.X
11584 protoize *.c
11585 @end example
11587 @noindent
11588 You need to include the special files along with the rest in the
11589 @code{protoize} command, even though their @samp{.X} files already
11590 exist, because otherwise they won't get converted.
11592 @xref{Protoize Caveats}, for more information on how to use
11593 @code{protoize} successfully.