OSDN Git Service

* configure.in (enable_coverage): Remove -DSELF_COVERAGE, add
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs  -fexternal-templates @gol
178 -falt-external-templates @gol
179 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
180 -fno-implicit-templates @gol
181 -fno-implicit-inline-templates @gol
182 -fno-implement-inlines  -fms-extensions @gol
183 -fno-nonansi-builtins  -fno-operator-names @gol
184 -fno-optional-diags  -fpermissive @gol
185 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
186 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
198 -Wno-protocol  -Wselector -Wundeclared-selector}
199
200 @item Language Independent Options
201 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
202 @gccoptlist{-fmessage-length=@var{n}  @gol
203 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
204
205 @item Warning Options
206 @xref{Warning Options,,Options to Request or Suppress Warnings}.
207 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
208 -w  -Wextra  -Wall  -Waggregate-return @gol
209 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
210 -Wconversion  -Wno-deprecated-declarations @gol
211 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
212 -Wfloat-equal  -Wformat  -Wformat=2 @gol
213 -Wformat-nonliteral  -Wformat-security @gol
214 -Wimplicit  -Wimplicit-int  @gol
215 -Wimplicit-function-declaration @gol
216 -Werror-implicit-function-declaration @gol
217 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
218 -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}
232
233 @item C-only Warning Options
234 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
235 -Wmissing-prototypes  -Wnested-externs @gol
236 -Wstrict-prototypes  -Wtraditional}
237
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 -feliminate-unused-debug-symbols -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}
256
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 -fprofile-values -fbranch-target-load-optimize @gol
262 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
263 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
264 -fdelayed-branch  -fdelete-null-pointer-checks @gol
265 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
266 -fforce-addr  -fforce-mem  -ffunction-sections @gol
267 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
268 -fif-conversion  -fif-conversion2 @gol
269 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
270 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
271 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
272 -fno-default-inline  -fno-defer-pop @gol
273 -fno-function-cse  -fno-guess-branch-probability @gol
274 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
275 -funsafe-math-optimizations  -ffinite-math-only @gol
276 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
277 -fomit-frame-pointer  -foptimize-register-move @gol
278 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
279 -freduce-all-givs  -fregmove  -frename-registers @gol
280 -freorder-blocks  -freorder-functions @gol
281 -frerun-cse-after-loop  -frerun-loop-opt @gol
282 -fschedule-insns  -fschedule-insns2 @gol
283 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
284 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
285 -fsched2-use-traces  -fsignaling-nans @gol
286 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
287 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
288 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
289 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
290 --param @var{name}=@var{value}
291 -O  -O0  -O1  -O2  -O3  -Os}
292
293 @item Preprocessor Options
294 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
295 @gccoptlist{-A@var{question}=@var{answer} @gol
296 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
297 -C  -dD  -dI  -dM  -dN @gol
298 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
299 -idirafter @var{dir} @gol
300 -include @var{file}  -imacros @var{file} @gol
301 -iprefix @var{file}  -iwithprefix @var{dir} @gol
302 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
303 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
304 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
305 -Xpreprocessor @var{option}}
306
307 @item Assembler Option
308 @xref{Assembler Options,,Passing Options to the Assembler}.
309 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
310
311 @item Linker Options
312 @xref{Link Options,,Options for Linking}.
313 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
314 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
315 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
316 -Wl,@var{option}  -Xlinker @var{option} @gol
317 -u @var{symbol}}
318
319 @item Directory Options
320 @xref{Directory Options,,Options for Directory Search}.
321 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
322
323 @item Target Options
324 @c I wrote this xref this way to avoid overfull hbox. -- rms
325 @xref{Target Options}.
326 @gccoptlist{-V @var{version}  -b @var{machine}}
327
328 @item Machine Dependent Options
329 @xref{Submodel Options,,Hardware Models and Configurations}.
330
331 @emph{M680x0 Options}
332 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
333 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
334 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
335 -malign-int  -mstrict-align}
336
337 @emph{M68hc1x Options}
338 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
339 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
340 -msoft-reg-count=@var{count}}
341
342 @emph{VAX Options}
343 @gccoptlist{-mg  -mgnu  -munix}
344
345 @emph{SPARC Options}
346 @gccoptlist{-mcpu=@var{cpu-type} @gol
347 -mtune=@var{cpu-type} @gol
348 -mcmodel=@var{code-model} @gol
349 -m32  -m64 @gol
350 -mapp-regs  -mbroken-saverestore  -mcypress @gol
351 -mfaster-structs  -mflat @gol
352 -mfpu  -mhard-float  -mhard-quad-float @gol
353 -mimpure-text  -mlive-g0  -mno-app-regs @gol
354 -mno-faster-structs  -mno-flat  -mno-fpu @gol
355 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
356 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
357 -msupersparc  -munaligned-doubles  -mv8}
358
359 @emph{ARM Options}
360 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
361 -mapcs-26  -mapcs-32 @gol
362 -mapcs-stack-check  -mno-apcs-stack-check @gol
363 -mapcs-float  -mno-apcs-float @gol
364 -mapcs-reentrant  -mno-apcs-reentrant @gol
365 -msched-prolog  -mno-sched-prolog @gol
366 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
367 -malignment-traps  -mno-alignment-traps @gol
368 -msoft-float  -mhard-float  -mfpe @gol
369 -mthumb-interwork  -mno-thumb-interwork @gol
370 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
371 -mstructure-size-boundary=@var{n} @gol
372 -mabort-on-noreturn @gol
373 -mlong-calls  -mno-long-calls @gol
374 -msingle-pic-base  -mno-single-pic-base @gol
375 -mpic-register=@var{reg} @gol
376 -mnop-fun-dllimport @gol
377 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
378 -mpoke-function-name @gol
379 -mthumb  -marm @gol
380 -mtpcs-frame  -mtpcs-leaf-frame @gol
381 -mcaller-super-interworking  -mcallee-super-interworking}
382
383 @emph{MN10200 Options}
384 @gccoptlist{-mrelax}
385
386 @emph{MN10300 Options}
387 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
388 -mam33  -mno-am33 @gol
389 -mno-crt0  -mrelax}
390
391 @emph{M32R/D Options}
392 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
393 -msdata=@var{sdata-type}  -G @var{num}}
394
395 @emph{M88K Options}
396 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
397 -mcheck-zero-division  -mhandle-large-shift @gol
398 -midentify-revision  -mno-check-zero-division @gol
399 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
400 -mno-optimize-arg-area  -mno-serialize-volatile @gol
401 -mno-underscores  -mocs-debug-info @gol
402 -mocs-frame-position  -moptimize-arg-area @gol
403 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
404 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
405 -mversion-03.00  -mwarn-passed-structs}
406
407 @emph{RS/6000 and PowerPC Options}
408 @gccoptlist{-mcpu=@var{cpu-type} @gol
409 -mtune=@var{cpu-type} @gol
410 -mpower  -mno-power  -mpower2  -mno-power2 @gol
411 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
412 -maltivec  -mno-altivec @gol
413 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
414 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
415 -mnew-mnemonics  -mold-mnemonics @gol
416 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
417 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
418 -malign-power  -malign-natural @gol
419 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
420 -mstring  -mno-string  -mupdate  -mno-update @gol
421 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
422 -mstrict-align  -mno-strict-align  -mrelocatable @gol
423 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
424 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
425 -mdynamic-no-pic @gol
426 -mcall-sysv  -mcall-netbsd @gol
427 -maix-struct-return  -msvr4-struct-return @gol
428 -mabi=altivec  -mabi=no-altivec @gol
429 -mabi=spe  -mabi=no-spe @gol
430 -misel=yes  -misel=no @gol
431 -mspe=yes  -mspe=no @gol
432 -mfloat-gprs=yes  -mfloat-gprs=no @gol
433 -mprototype  -mno-prototype @gol
434 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
435 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
436
437 @emph{Darwin Options}
438 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
439 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
440 -client_name  -compatibility_version  -current_version @gol
441 -dependency-file  -dylib_file  -dylinker_install_name @gol
442 -dynamic  -dynamiclib  -exported_symbols_list @gol
443 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
444 -force_flat_namespace  -headerpad_max_install_names @gol
445 -image_base  -init  -install_name  -keep_private_externs @gol
446 -multi_module  -multiply_defined  -multiply_defined_unused @gol
447 -noall_load  -nomultidefs  -noprebind  -noseglinkedit @gol
448 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
449 -private_bundle  -read_only_relocs  -sectalign @gol
450 -sectobjectsymbols  -whyload  -seg1addr @gol
451 -sectcreate  -sectobjectsymbols  -sectorder @gol
452 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
453 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
454 -single_module  -static  -sub_library  -sub_umbrella @gol
455 -twolevel_namespace  -umbrella  -undefined @gol
456 -unexported_symbols_list  -weak_reference_mismatches @gol
457 -whatsloaded}
458
459 @emph{RT Options}
460 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
461 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
462 -mminimum-fp-blocks  -mnohc-struct-return}
463
464 @emph{MIPS Options}
465 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
466 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
467 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
468 -mgas  -mgp32  -mgp64 @gol
469 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
470 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
471 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
472 -mmips-as  -mmips-tfile  -mno-abicalls @gol
473 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
474 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
475 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
476 -mrnames  -msoft-float @gol
477 -m4650  -msingle-float  -mmad @gol
478 -EL  -EB  -G @var{num}  -nocpp @gol
479 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
480 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
481 -mbranch-likely -mno-branch-likely}
482
483 @emph{i386 and x86-64 Options}
484 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
485 -mfpmath=@var{unit} @gol
486 -masm=@var{dialect}  -mno-fancy-math-387 @gol
487 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
488 -mno-wide-multiply  -mrtd  -malign-double @gol
489 -mpreferred-stack-boundary=@var{num} @gol
490 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
491 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
492 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
493 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
494 -mno-red-zone -mno-tls-direct-seg-refs @gol
495 -mcmodel=@var{code-model} @gol
496 -m32  -m64}
497
498 @emph{HPPA Options}
499 @gccoptlist{-march=@var{architecture-type} @gol
500 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
501 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
502 -mjump-in-delay -mlinker-opt -mlong-calls @gol
503 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
504 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
505 -mno-jump-in-delay  -mno-long-load-store @gol
506 -mno-portable-runtime  -mno-soft-float @gol
507 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
508 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
509 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
510 -nolibdld  -static  -threads}
511
512 @emph{Intel 960 Options}
513 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
514 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
515 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
516 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
517 -mno-complex-addr  -mno-leaf-procedures @gol
518 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
519 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
520 -mtail-call}
521
522 @emph{DEC Alpha Options}
523 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
524 -mieee  -mieee-with-inexact  -mieee-conformant @gol
525 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
526 -mtrap-precision=@var{mode}  -mbuild-constants @gol
527 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
528 -mbwx  -mmax  -mfix  -mcix @gol
529 -mfloat-vax  -mfloat-ieee @gol
530 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
531 -msmall-text  -mlarge-text @gol
532 -mmemory-latency=@var{time}}
533
534 @emph{DEC Alpha/VMS Options}
535 @gccoptlist{-mvms-return-codes}
536
537 @emph{H8/300 Options}
538 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
539
540 @emph{SH Options}
541 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
542 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
543 -m5-64media  -m5-64media-nofpu @gol
544 -m5-32media  -m5-32media-nofpu @gol
545 -m5-compact  -m5-compact-nofpu @gol
546 -mb  -ml  -mdalign  -mrelax @gol
547 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
548 -mieee  -misize  -mpadstruct  -mspace @gol
549 -mprefergot  -musermode}
550
551 @emph{System V Options}
552 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
553
554 @emph{ARC Options}
555 @gccoptlist{-EB  -EL @gol
556 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
557 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
558
559 @emph{TMS320C3x/C4x Options}
560 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
561 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
562 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
563 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
564
565 @emph{V850 Options}
566 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
567 -mprolog-function  -mno-prolog-function  -mspace @gol
568 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
569 -mapp-regs  -mno-app-regs @gol
570 -mdisable-callt  -mno-disable-callt @gol
571 -mv850e @gol
572 -mv850  -mbig-switch}
573
574 @emph{NS32K Options}
575 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
576 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
577 -mregparam  -mnoregparam  -msb  -mnosb @gol
578 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
579
580 @emph{AVR Options}
581 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
582 -mcall-prologues  -mno-tablejump  -mtiny-stack}
583
584 @emph{MCore Options}
585 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
586 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
587 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
588 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
589 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
590
591 @emph{MMIX Options}
592 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
593 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
594 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
595 -mno-base-addresses  -msingle-exit  -mno-single-exit}
596
597 @emph{IA-64 Options}
598 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
599 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
600 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
601 -minline-float-divide-max-throughput @gol
602 -minline-int-divide-min-latency @gol
603 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
604 -mfixed-range=@var{register-range}}
605
606 @emph{D30V Options}
607 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
608 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
609
610 @emph{S/390 and zSeries Options}
611 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
612 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
613 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
614 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
615
616 @emph{CRIS Options}
617 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
618 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
619 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
620 -mstack-align  -mdata-align  -mconst-align @gol
621 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
622 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
623
624 @emph{PDP-11 Options}
625 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
626 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
627 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
628 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
629 -mbranch-expensive  -mbranch-cheap @gol
630 -msplit  -mno-split  -munix-asm  -mdec-asm}
631
632 @emph{Xstormy16 Options}
633 @gccoptlist{-msim}
634
635 @emph{Xtensa Options}
636 @gccoptlist{-mbig-endian  -mlittle-endian @gol
637 -mdensity  -mno-density @gol
638 -mconst16 -mno-const16 @gol
639 -mabs -mno-abs @gol
640 -maddx -mno-addx @gol
641 -mmac16  -mno-mac16 @gol
642 -mmul16  -mno-mul16 @gol
643 -mmul32  -mno-mul32 @gol
644 -mnsa  -mno-nsa @gol
645 -mminmax  -mno-minmax @gol
646 -msext  -mno-sext @gol
647 -mbooleans  -mno-booleans @gol
648 -mhard-float  -msoft-float @gol
649 -mfused-madd  -mno-fused-madd @gol
650 -mtext-section-literals  -mno-text-section-literals @gol
651 -mtarget-align  -mno-target-align @gol
652 -mlongcalls  -mno-longcalls}
653
654 @emph{FRV Options}
655 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
656 -mhard-float  -msoft-float @gol
657 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
658 -mdouble  -mno-double @gol
659 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
660 -mlibrary-pic  -macc-4 -macc-8 @gol
661 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
662 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
663 -mvliw-branch  -mno-vliw-branch @gol
664 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
665 -mno-nested-cond-exec  -mtomcat-stats @gol
666 -mcpu=@var{cpu}}
667
668 @item Code Generation Options
669 @xref{Code Gen Options,,Options for Code Generation Conventions}.
670 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
671 -ffixed-@var{reg}  -fexceptions @gol
672 -fnon-call-exceptions  -funwind-tables @gol
673 -fasynchronous-unwind-tables @gol
674 -finhibit-size-directive  -finstrument-functions @gol
675 -fno-common  -fno-ident  -fno-gnu-linker @gol
676 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
677 -freg-struct-return  -fshared-data  -fshort-enums @gol
678 -fshort-double  -fshort-wchar @gol
679 -fverbose-asm  -fpack-struct  -fstack-check @gol
680 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
681 -fargument-alias  -fargument-noalias @gol
682 -fargument-noalias-global  -fleading-underscore @gol
683 -ftls-model=@var{model} @gol
684 -ftrapv  -fwrapv  -fbounds-check}
685 @end table
686
687 @menu
688 * Overall Options::     Controlling the kind of output:
689                         an executable, object files, assembler files,
690                         or preprocessed source.
691 * C Dialect Options::   Controlling the variant of C language compiled.
692 * C++ Dialect Options:: Variations on C++.
693 * Objective-C Dialect Options:: Variations on Objective-C.
694 * Language Independent Options:: Controlling how diagnostics should be
695                         formatted.
696 * Warning Options::     How picky should the compiler be?
697 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
698 * Optimize Options::    How much optimization?
699 * Preprocessor Options:: Controlling header files and macro definitions.
700                          Also, getting dependency information for Make.
701 * Assembler Options::   Passing options to the assembler.
702 * Link Options::        Specifying libraries and so on.
703 * Directory Options::   Where to find header files and libraries.
704                         Where to find the compiler executable files.
705 * Spec Files::          How to pass switches to sub-processes.
706 * Target Options::      Running a cross-compiler, or an old version of GCC.
707 @end menu
708
709 @node Overall Options
710 @section Options Controlling the Kind of Output
711
712 Compilation can involve up to four stages: preprocessing, compilation
713 proper, assembly and linking, always in that order.  The first three
714 stages apply to an individual source file, and end by producing an
715 object file; linking combines all the object files (those newly
716 compiled, and those specified as input) into an executable file.
717
718 @cindex file name suffix
719 For any given input file, the file name suffix determines what kind of
720 compilation is done:
721
722 @table @gcctabopt
723 @item @var{file}.c
724 C source code which must be preprocessed.
725
726 @item @var{file}.i
727 C source code which should not be preprocessed.
728
729 @item @var{file}.ii
730 C++ source code which should not be preprocessed.
731
732 @item @var{file}.m
733 Objective-C source code.  Note that you must link with the library
734 @file{libobjc.a} to make an Objective-C program work.
735
736 @item @var{file}.mi
737 Objective-C source code which should not be preprocessed.
738
739 @item @var{file}.h
740 C or C++ header file to be turned into a precompiled header.
741
742 @item @var{file}.cc
743 @itemx @var{file}.cp
744 @itemx @var{file}.cxx
745 @itemx @var{file}.cpp
746 @itemx @var{file}.CPP
747 @itemx @var{file}.c++
748 @itemx @var{file}.C
749 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
750 the last two letters must both be literally @samp{x}.  Likewise,
751 @samp{.C} refers to a literal capital C@.
752
753 @item @var{file}.hh
754 @itemx @var{file}.H
755 C++ header file to be turned into a precompiled header.
756
757 @item @var{file}.f
758 @itemx @var{file}.for
759 @itemx @var{file}.FOR
760 Fortran source code which should not be preprocessed.
761
762 @item @var{file}.F
763 @itemx @var{file}.fpp
764 @itemx @var{file}.FPP
765 Fortran source code which must be preprocessed (with the traditional
766 preprocessor).
767
768 @item @var{file}.r
769 Fortran source code which must be preprocessed with a RATFOR
770 preprocessor (not included with GCC)@.
771
772 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
773 Using and Porting GNU Fortran}, for more details of the handling of
774 Fortran input files.
775
776 @c FIXME: Descriptions of Java file types.
777 @c @var{file}.java
778 @c @var{file}.class
779 @c @var{file}.zip
780 @c @var{file}.jar
781
782 @item @var{file}.ads
783 Ada source code file which contains a library unit declaration (a
784 declaration of a package, subprogram, or generic, or a generic
785 instantiation), or a library unit renaming declaration (a package,
786 generic, or subprogram renaming declaration).  Such files are also
787 called @dfn{specs}.
788
789 @itemx @var{file}.adb
790 Ada source code file containing a library unit body (a subprogram or
791 package body).  Such files are also called @dfn{bodies}.
792
793 @c GCC also knows about some suffixes for languages not yet included:
794 @c Pascal:
795 @c @var{file}.p
796 @c @var{file}.pas
797
798 @item @var{file}.s
799 Assembler code.
800
801 @item @var{file}.S
802 Assembler code which must be preprocessed.
803
804 @item @var{other}
805 An object file to be fed straight into linking.
806 Any file name with no recognized suffix is treated this way.
807 @end table
808
809 @opindex x
810 You can specify the input language explicitly with the @option{-x} option:
811
812 @table @gcctabopt
813 @item -x @var{language}
814 Specify explicitly the @var{language} for the following input files
815 (rather than letting the compiler choose a default based on the file
816 name suffix).  This option applies to all following input files until
817 the next @option{-x} option.  Possible values for @var{language} are:
818 @example
819 c  c-header  cpp-output
820 c++  c++-header  c++-cpp-output
821 objective-c  objective-c-header  objc-cpp-output
822 assembler  assembler-with-cpp
823 ada
824 f77  f77-cpp-input  ratfor
825 java
826 treelang
827 @end example
828
829 @item -x none
830 Turn off any specification of a language, so that subsequent files are
831 handled according to their file name suffixes (as they are if @option{-x}
832 has not been used at all).
833
834 @item -pass-exit-codes
835 @opindex pass-exit-codes
836 Normally the @command{gcc} program will exit with the code of 1 if any
837 phase of the compiler returns a non-success return code.  If you specify
838 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
839 numerically highest error produced by any phase that returned an error
840 indication.
841 @end table
842
843 If you only want some of the stages of compilation, you can use
844 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
845 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
846 @command{gcc} is to stop.  Note that some combinations (for example,
847 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
848
849 @table @gcctabopt
850 @item -c
851 @opindex c
852 Compile or assemble the source files, but do not link.  The linking
853 stage simply is not done.  The ultimate output is in the form of an
854 object file for each source file.
855
856 By default, the object file name for a source file is made by replacing
857 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
858
859 Unrecognized input files, not requiring compilation or assembly, are
860 ignored.
861
862 @item -S
863 @opindex S
864 Stop after the stage of compilation proper; do not assemble.  The output
865 is in the form of an assembler code file for each non-assembler input
866 file specified.
867
868 By default, the assembler file name for a source file is made by
869 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
870
871 Input files that don't require compilation are ignored.
872
873 @item -E
874 @opindex E
875 Stop after the preprocessing stage; do not run the compiler proper.  The
876 output is in the form of preprocessed source code, which is sent to the
877 standard output.
878
879 Input files which don't require preprocessing are ignored.
880
881 @cindex output file option
882 @item -o @var{file}
883 @opindex o
884 Place output in file @var{file}.  This applies regardless to whatever
885 sort of output is being produced, whether it be an executable file,
886 an object file, an assembler file or preprocessed C code.
887
888 Since only one output file can be specified, it does not make sense to
889 use @option{-o} when compiling more than one input file, unless you are
890 producing an executable file as output.
891
892 If @option{-o} is not specified, the default is to put an executable file
893 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
894 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
895 all preprocessed C source on standard output.
896
897 @item -v
898 @opindex v
899 Print (on standard error output) the commands executed to run the stages
900 of compilation.  Also print the version number of the compiler driver
901 program and of the preprocessor and the compiler proper.
902
903 @item -###
904 @opindex ###
905 Like @option{-v} except the commands are not executed and all command
906 arguments are quoted.  This is useful for shell scripts to capture the
907 driver-generated command lines.
908
909 @item -pipe
910 @opindex pipe
911 Use pipes rather than temporary files for communication between the
912 various stages of compilation.  This fails to work on some systems where
913 the assembler is unable to read from a pipe; but the GNU assembler has
914 no trouble.
915
916 @item --help
917 @opindex help
918 Print (on the standard output) a description of the command line options
919 understood by @command{gcc}.  If the @option{-v} option is also specified
920 then @option{--help} will also be passed on to the various processes
921 invoked by @command{gcc}, so that they can display the command line options
922 they accept.  If the @option{-Wextra} option is also specified then command
923 line options which have no documentation associated with them will also
924 be displayed.
925
926 @item --target-help
927 @opindex target-help
928 Print (on the standard output) a description of target specific command
929 line options for each tool.
930
931 @item --version
932 @opindex version
933 Display the version number and copyrights of the invoked GCC.
934 @end table
935
936 @node Invoking G++
937 @section Compiling C++ Programs
938
939 @cindex suffixes for C++ source
940 @cindex C++ source file suffixes
941 C++ source files conventionally use one of the suffixes @samp{.C},
942 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
943 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
944 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
945 files with these names and compiles them as C++ programs even if you
946 call the compiler the same way as for compiling C programs (usually
947 with the name @command{gcc}).
948
949 @findex g++
950 @findex c++
951 However, C++ programs often require class libraries as well as a
952 compiler that understands the C++ language---and under some
953 circumstances, you might want to compile programs or header files from
954 standard input, or otherwise without a suffix that flags them as C++
955 programs.  You might also like to precompile a C header file with a
956 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
957 program that calls GCC with the default language set to C++, and
958 automatically specifies linking against the C++ library.  On many
959 systems, @command{g++} is also installed with the name @command{c++}.
960
961 @cindex invoking @command{g++}
962 When you compile C++ programs, you may specify many of the same
963 command-line options that you use for compiling programs in any
964 language; or command-line options meaningful for C and related
965 languages; or options that are meaningful only for C++ programs.
966 @xref{C Dialect Options,,Options Controlling C Dialect}, for
967 explanations of options for languages related to C@.
968 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
969 explanations of options that are meaningful only for C++ programs.
970
971 @node C Dialect Options
972 @section Options Controlling C Dialect
973 @cindex dialect options
974 @cindex language dialect options
975 @cindex options, dialect
976
977 The following options control the dialect of C (or languages derived
978 from C, such as C++ and Objective-C) that the compiler accepts:
979
980 @table @gcctabopt
981 @cindex ANSI support
982 @cindex ISO support
983 @item -ansi
984 @opindex ansi
985 In C mode, support all ISO C90 programs.  In C++ mode,
986 remove GNU extensions that conflict with ISO C++.
987
988 This turns off certain features of GCC that are incompatible with ISO
989 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
990 such as the @code{asm} and @code{typeof} keywords, and
991 predefined macros such as @code{unix} and @code{vax} that identify the
992 type of system you are using.  It also enables the undesirable and
993 rarely used ISO trigraph feature.  For the C compiler,
994 it disables recognition of C++ style @samp{//} comments as well as
995 the @code{inline} keyword.
996
997 The alternate keywords @code{__asm__}, @code{__extension__},
998 @code{__inline__} and @code{__typeof__} continue to work despite
999 @option{-ansi}.  You would not want to use them in an ISO C program, of
1000 course, but it is useful to put them in header files that might be included
1001 in compilations done with @option{-ansi}.  Alternate predefined macros
1002 such as @code{__unix__} and @code{__vax__} are also available, with or
1003 without @option{-ansi}.
1004
1005 The @option{-ansi} option does not cause non-ISO programs to be
1006 rejected gratuitously.  For that, @option{-pedantic} is required in
1007 addition to @option{-ansi}.  @xref{Warning Options}.
1008
1009 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1010 option is used.  Some header files may notice this macro and refrain
1011 from declaring certain functions or defining certain macros that the
1012 ISO standard doesn't call for; this is to avoid interfering with any
1013 programs that might use these names for other things.
1014
1015 Functions which would normally be built in but do not have semantics
1016 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1017 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1018 built-in functions provided by GCC}, for details of the functions
1019 affected.
1020
1021 @item -std=
1022 @opindex std
1023 Determine the language standard.  This option is currently only
1024 supported when compiling C or C++.  A value for this option must be
1025 provided; possible values are
1026
1027 @table @samp
1028 @item c89
1029 @itemx iso9899:1990
1030 ISO C90 (same as @option{-ansi}).
1031
1032 @item iso9899:199409
1033 ISO C90 as modified in amendment 1.
1034
1035 @item c99
1036 @itemx c9x
1037 @itemx iso9899:1999
1038 @itemx iso9899:199x
1039 ISO C99.  Note that this standard is not yet fully supported; see
1040 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1041 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1042
1043 @item gnu89
1044 Default, ISO C90 plus GNU extensions (including some C99 features).
1045
1046 @item gnu99
1047 @item gnu9x
1048 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1049 this will become the default.  The name @samp{gnu9x} is deprecated.
1050
1051 @item c++98
1052 The 1998 ISO C++ standard plus amendments.
1053
1054 @item gnu++98
1055 The same as @option{-std=c++98} plus GNU extensions.  This is the
1056 default for C++ code.
1057 @end table
1058
1059 Even when this option is not specified, you can still use some of the
1060 features of newer standards in so far as they do not conflict with
1061 previous C standards.  For example, you may use @code{__restrict__} even
1062 when @option{-std=c99} is not specified.
1063
1064 The @option{-std} options specifying some version of ISO C have the same
1065 effects as @option{-ansi}, except that features that were not in ISO C90
1066 but are in the specified version (for example, @samp{//} comments and
1067 the @code{inline} keyword in ISO C99) are not disabled.
1068
1069 @xref{Standards,,Language Standards Supported by GCC}, for details of
1070 these standard versions.
1071
1072 @item -aux-info @var{filename}
1073 @opindex aux-info
1074 Output to the given filename prototyped declarations for all functions
1075 declared and/or defined in a translation unit, including those in header
1076 files.  This option is silently ignored in any language other than C@.
1077
1078 Besides declarations, the file indicates, in comments, the origin of
1079 each declaration (source file and line), whether the declaration was
1080 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1081 @samp{O} for old, respectively, in the first character after the line
1082 number and the colon), and whether it came from a declaration or a
1083 definition (@samp{C} or @samp{F}, respectively, in the following
1084 character).  In the case of function definitions, a K&R-style list of
1085 arguments followed by their declarations is also provided, inside
1086 comments, after the declaration.
1087
1088 @item -fno-asm
1089 @opindex fno-asm
1090 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1091 keyword, so that code can use these words as identifiers.  You can use
1092 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1093 instead.  @option{-ansi} implies @option{-fno-asm}.
1094
1095 In C++, this switch only affects the @code{typeof} keyword, since
1096 @code{asm} and @code{inline} are standard keywords.  You may want to
1097 use the @option{-fno-gnu-keywords} flag instead, which has the same
1098 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1099 switch only affects the @code{asm} and @code{typeof} keywords, since
1100 @code{inline} is a standard keyword in ISO C99.
1101
1102 @item -fno-builtin
1103 @itemx -fno-builtin-@var{function}
1104 @opindex fno-builtin
1105 @cindex built-in functions
1106 Don't recognize built-in functions that do not begin with
1107 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1108 functions provided by GCC}, for details of the functions affected,
1109 including those which are not built-in functions when @option{-ansi} or
1110 @option{-std} options for strict ISO C conformance are used because they
1111 do not have an ISO standard meaning.
1112
1113 GCC normally generates special code to handle certain built-in functions
1114 more efficiently; for instance, calls to @code{alloca} may become single
1115 instructions that adjust the stack directly, and calls to @code{memcpy}
1116 may become inline copy loops.  The resulting code is often both smaller
1117 and faster, but since the function calls no longer appear as such, you
1118 cannot set a breakpoint on those calls, nor can you change the behavior
1119 of the functions by linking with a different library.
1120
1121 With the @option{-fno-builtin-@var{function}} option
1122 only the built-in function @var{function} is
1123 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1124 function is named this is not built-in in this version of GCC, this
1125 option is ignored.  There is no corresponding
1126 @option{-fbuiltin-@var{function}} option; if you wish to enable
1127 built-in functions selectively when using @option{-fno-builtin} or
1128 @option{-ffreestanding}, you may define macros such as:
1129
1130 @smallexample
1131 #define abs(n)          __builtin_abs ((n))
1132 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1133 @end smallexample
1134
1135 @item -fhosted
1136 @opindex fhosted
1137 @cindex hosted environment
1138
1139 Assert that compilation takes place in a hosted environment.  This implies
1140 @option{-fbuiltin}.  A hosted environment is one in which the
1141 entire standard library is available, and in which @code{main} has a return
1142 type of @code{int}.  Examples are nearly everything except a kernel.
1143 This is equivalent to @option{-fno-freestanding}.
1144
1145 @item -ffreestanding
1146 @opindex ffreestanding
1147 @cindex hosted environment
1148
1149 Assert that compilation takes place in a freestanding environment.  This
1150 implies @option{-fno-builtin}.  A freestanding environment
1151 is one in which the standard library may not exist, and program startup may
1152 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1153 This is equivalent to @option{-fno-hosted}.
1154
1155 @xref{Standards,,Language Standards Supported by GCC}, for details of
1156 freestanding and hosted environments.
1157
1158 @item -fms-extensions
1159 @opindex fms-extensions
1160 Accept some non-standard constructs used in Microsoft header files.
1161
1162 @item -trigraphs
1163 @opindex trigraphs
1164 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1165 options for strict ISO C conformance) implies @option{-trigraphs}.
1166
1167 @item -no-integrated-cpp
1168 @opindex no-integrated-cpp
1169 Performs a compilation in two passes: preprocessing and compiling.  This
1170 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1171 @option{-B} option. The user supplied compilation step can then add in
1172 an additional preprocessing step after normal preprocessing but before
1173 compiling. The default is to use the integrated cpp (internal cpp)
1174
1175 The semantics of this option will change if "cc1", "cc1plus", and
1176 "cc1obj" are merged.
1177
1178 @cindex traditional C language
1179 @cindex C language, traditional
1180 @item -traditional
1181 @itemx -traditional-cpp
1182 @opindex traditional-cpp
1183 @opindex traditional
1184 Formerly, these options caused GCC to attempt to emulate a pre-standard
1185 C compiler.  They are now only supported with the @option{-E} switch.
1186 The preprocessor continues to support a pre-standard mode.  See the GNU
1187 CPP manual for details.
1188
1189 @item -fcond-mismatch
1190 @opindex fcond-mismatch
1191 Allow conditional expressions with mismatched types in the second and
1192 third arguments.  The value of such an expression is void.  This option
1193 is not supported for C++.
1194
1195 @item -funsigned-char
1196 @opindex funsigned-char
1197 Let the type @code{char} be unsigned, like @code{unsigned char}.
1198
1199 Each kind of machine has a default for what @code{char} should
1200 be.  It is either like @code{unsigned char} by default or like
1201 @code{signed char} by default.
1202
1203 Ideally, a portable program should always use @code{signed char} or
1204 @code{unsigned char} when it depends on the signedness of an object.
1205 But many programs have been written to use plain @code{char} and
1206 expect it to be signed, or expect it to be unsigned, depending on the
1207 machines they were written for.  This option, and its inverse, let you
1208 make such a program work with the opposite default.
1209
1210 The type @code{char} is always a distinct type from each of
1211 @code{signed char} or @code{unsigned char}, even though its behavior
1212 is always just like one of those two.
1213
1214 @item -fsigned-char
1215 @opindex fsigned-char
1216 Let the type @code{char} be signed, like @code{signed char}.
1217
1218 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1219 the negative form of @option{-funsigned-char}.  Likewise, the option
1220 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1221
1222 @item -fsigned-bitfields
1223 @itemx -funsigned-bitfields
1224 @itemx -fno-signed-bitfields
1225 @itemx -fno-unsigned-bitfields
1226 @opindex fsigned-bitfields
1227 @opindex funsigned-bitfields
1228 @opindex fno-signed-bitfields
1229 @opindex fno-unsigned-bitfields
1230 These options control whether a bit-field is signed or unsigned, when the
1231 declaration does not use either @code{signed} or @code{unsigned}.  By
1232 default, such a bit-field is signed, because this is consistent: the
1233 basic integer types such as @code{int} are signed types.
1234
1235 @item -fwritable-strings
1236 @opindex fwritable-strings
1237 Store string constants in the writable data segment and don't uniquize
1238 them.  This is for compatibility with old programs which assume they can
1239 write into string constants.
1240
1241 Writing into string constants is a very bad idea; ``constants'' should
1242 be constant.
1243 @end table
1244
1245 @node C++ Dialect Options
1246 @section Options Controlling C++ Dialect
1247
1248 @cindex compiler options, C++
1249 @cindex C++ options, command line
1250 @cindex options, C++
1251 This section describes the command-line options that are only meaningful
1252 for C++ programs; but you can also use most of the GNU compiler options
1253 regardless of what language your program is in.  For example, you
1254 might compile a file @code{firstClass.C} like this:
1255
1256 @example
1257 g++ -g -frepo -O -c firstClass.C
1258 @end example
1259
1260 @noindent
1261 In this example, only @option{-frepo} is an option meant
1262 only for C++ programs; you can use the other options with any
1263 language supported by GCC@.
1264
1265 Here is a list of options that are @emph{only} for compiling C++ programs:
1266
1267 @table @gcctabopt
1268
1269 @item -fabi-version=@var{n}
1270 @opindex fabi-version
1271 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1272 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1273 version that conforms most closely to the C++ ABI specification.
1274 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1275 fixed.
1276
1277 The default is version 1.
1278
1279 @item -fno-access-control
1280 @opindex fno-access-control
1281 Turn off all access checking.  This switch is mainly useful for working
1282 around bugs in the access control code.
1283
1284 @item -fcheck-new
1285 @opindex fcheck-new
1286 Check that the pointer returned by @code{operator new} is non-null
1287 before attempting to modify the storage allocated.  This check is
1288 normally unnecessary because the C++ standard specifies that
1289 @code{operator new} will only return @code{0} if it is declared
1290 @samp{throw()}, in which case the compiler will always check the
1291 return value even without this option.  In all other cases, when
1292 @code{operator new} has a non-empty exception specification, memory
1293 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1294 @samp{new (nothrow)}.
1295
1296 @item -fconserve-space
1297 @opindex fconserve-space
1298 Put uninitialized or runtime-initialized global variables into the
1299 common segment, as C does.  This saves space in the executable at the
1300 cost of not diagnosing duplicate definitions.  If you compile with this
1301 flag and your program mysteriously crashes after @code{main()} has
1302 completed, you may have an object that is being destroyed twice because
1303 two definitions were merged.
1304
1305 This option is no longer useful on most targets, now that support has
1306 been added for putting variables into BSS without making them common.
1307
1308 @item -fno-const-strings
1309 @opindex fno-const-strings
1310 Give string constants type @code{char *} instead of type @code{const
1311 char *}.  By default, G++ uses type @code{const char *} as required by
1312 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1313 actually modify the value of a string constant, unless you also use
1314 @option{-fwritable-strings}.
1315
1316 This option might be removed in a future release of G++.  For maximum
1317 portability, you should structure your code so that it works with
1318 string constants that have type @code{const char *}.
1319
1320 @item -fno-elide-constructors
1321 @opindex fno-elide-constructors
1322 The C++ standard allows an implementation to omit creating a temporary
1323 which is only used to initialize another object of the same type.
1324 Specifying this option disables that optimization, and forces G++ to
1325 call the copy constructor in all cases.
1326
1327 @item -fno-enforce-eh-specs
1328 @opindex fno-enforce-eh-specs
1329 Don't check for violation of exception specifications at runtime.  This
1330 option violates the C++ standard, but may be useful for reducing code
1331 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1332 will still optimize based on the exception specifications.
1333
1334 @item -fexternal-templates
1335 @opindex fexternal-templates
1336
1337 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1338 template instantiation; template instances are emitted or not according
1339 to the location of the template definition.  @xref{Template
1340 Instantiation}, for more information.
1341
1342 This option is deprecated.
1343
1344 @item -falt-external-templates
1345 @opindex falt-external-templates
1346 Similar to @option{-fexternal-templates}, but template instances are
1347 emitted or not according to the place where they are first instantiated.
1348 @xref{Template Instantiation}, for more information.
1349
1350 This option is deprecated.
1351
1352 @item -ffor-scope
1353 @itemx -fno-for-scope
1354 @opindex ffor-scope
1355 @opindex fno-for-scope
1356 If @option{-ffor-scope} is specified, the scope of variables declared in
1357 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1358 as specified by the C++ standard.
1359 If @option{-fno-for-scope} is specified, the scope of variables declared in
1360 a @i{for-init-statement} extends to the end of the enclosing scope,
1361 as was the case in old versions of G++, and other (traditional)
1362 implementations of C++.
1363
1364 The default if neither flag is given to follow the standard,
1365 but to allow and give a warning for old-style code that would
1366 otherwise be invalid, or have different behavior.
1367
1368 @item -fno-gnu-keywords
1369 @opindex fno-gnu-keywords
1370 Do not recognize @code{typeof} as a keyword, so that code can use this
1371 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1372 @option{-ansi} implies @option{-fno-gnu-keywords}.
1373
1374 @item -fno-implicit-templates
1375 @opindex fno-implicit-templates
1376 Never emit code for non-inline templates which are instantiated
1377 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1378 @xref{Template Instantiation}, for more information.
1379
1380 @item -fno-implicit-inline-templates
1381 @opindex fno-implicit-inline-templates
1382 Don't emit code for implicit instantiations of inline templates, either.
1383 The default is to handle inlines differently so that compiles with and
1384 without optimization will need the same set of explicit instantiations.
1385
1386 @item -fno-implement-inlines
1387 @opindex fno-implement-inlines
1388 To save space, do not emit out-of-line copies of inline functions
1389 controlled by @samp{#pragma implementation}.  This will cause linker
1390 errors if these functions are not inlined everywhere they are called.
1391
1392 @item -fms-extensions
1393 @opindex fms-extensions
1394 Disable pedantic warnings about constructs used in MFC, such as implicit
1395 int and getting a pointer to member function via non-standard syntax.
1396
1397 @item -fno-nonansi-builtins
1398 @opindex fno-nonansi-builtins
1399 Disable built-in declarations of functions that are not mandated by
1400 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1401 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1402
1403 @item -fno-operator-names
1404 @opindex fno-operator-names
1405 Do not treat the operator name keywords @code{and}, @code{bitand},
1406 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1407 synonyms as keywords.
1408
1409 @item -fno-optional-diags
1410 @opindex fno-optional-diags
1411 Disable diagnostics that the standard says a compiler does not need to
1412 issue.  Currently, the only such diagnostic issued by G++ is the one for
1413 a name having multiple meanings within a class.
1414
1415 @item -fpermissive
1416 @opindex fpermissive
1417 Downgrade messages about nonconformant code from errors to warnings.  By
1418 default, G++ effectively sets @option{-pedantic-errors} without
1419 @option{-pedantic}; this option reverses that.  This behavior and this
1420 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1421
1422 @item -frepo
1423 @opindex frepo
1424 Enable automatic template instantiation at link time.  This option also
1425 implies @option{-fno-implicit-templates}.  @xref{Template
1426 Instantiation}, for more information.
1427
1428 @item -fno-rtti
1429 @opindex fno-rtti
1430 Disable generation of information about every class with virtual
1431 functions for use by the C++ runtime type identification features
1432 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1433 of the language, you can save some space by using this flag.  Note that
1434 exception handling uses the same information, but it will generate it as
1435 needed.
1436
1437 @item -fstats
1438 @opindex fstats
1439 Emit statistics about front-end processing at the end of the compilation.
1440 This information is generally only useful to the G++ development team.
1441
1442 @item -ftemplate-depth-@var{n}
1443 @opindex ftemplate-depth
1444 Set the maximum instantiation depth for template classes to @var{n}.
1445 A limit on the template instantiation depth is needed to detect
1446 endless recursions during template class instantiation.  ANSI/ISO C++
1447 conforming programs must not rely on a maximum depth greater than 17.
1448
1449 @item -fuse-cxa-atexit
1450 @opindex fuse-cxa-atexit
1451 Register destructors for objects with static storage duration with the
1452 @code{__cxa_atexit} function rather than the @code{atexit} function.
1453 This option is required for fully standards-compliant handling of static
1454 destructors, but will only work if your C library supports
1455 @code{__cxa_atexit}.
1456
1457 @item -fvtable-gc
1458 @opindex fvtable-gc
1459 Emit special relocations for vtables and virtual function references
1460 so that the linker can identify unused virtual functions and zero out
1461 vtable slots that refer to them.  This is most useful with
1462 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1463 also discard the functions themselves.
1464
1465 This optimization requires GNU as and GNU ld.  Not all systems support
1466 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1467
1468 @item -fno-weak
1469 @opindex fno-weak
1470 Do not use weak symbol support, even if it is provided by the linker.
1471 By default, G++ will use weak symbols if they are available.  This
1472 option exists only for testing, and should not be used by end-users;
1473 it will result in inferior code and has no benefits.  This option may
1474 be removed in a future release of G++.
1475
1476 @item -nostdinc++
1477 @opindex nostdinc++
1478 Do not search for header files in the standard directories specific to
1479 C++, but do still search the other standard directories.  (This option
1480 is used when building the C++ library.)
1481 @end table
1482
1483 In addition, these optimization, warning, and code generation options
1484 have meanings only for C++ programs:
1485
1486 @table @gcctabopt
1487 @item -fno-default-inline
1488 @opindex fno-default-inline
1489 Do not assume @samp{inline} for functions defined inside a class scope.
1490 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1491 functions will have linkage like inline functions; they just won't be
1492 inlined by default.
1493
1494 @item -Wabi @r{(C++ only)}
1495 @opindex Wabi
1496 Warn when G++ generates code that is probably not compatible with the
1497 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1498 all such cases, there are probably some cases that are not warned about, 
1499 even though G++ is generating incompatible code.  There may also be
1500 cases where warnings are emitted even though the code that is generated
1501 will be compatible.
1502
1503 You should rewrite your code to avoid these warnings if you are
1504 concerned about the fact that code generated by G++ may not be binary
1505 compatible with code generated by other compilers.
1506
1507 The known incompatibilities at this point include:
1508
1509 @itemize @bullet
1510
1511 @item
1512 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1513 pack data into the same byte as a base class.  For example:
1514
1515 @smallexample
1516 struct A @{ virtual void f(); int f1 : 1; @};
1517 struct B : public A @{ int f2 : 1; @};
1518 @end smallexample
1519
1520 @noindent
1521 In this case, G++ will place @code{B::f2} into the same byte
1522 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1523 by explicitly padding @code{A} so that its size is a multiple of the
1524 byte size on your platform; that will cause G++ and other compilers to
1525 layout @code{B} identically.
1526
1527 @item
1528 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1529 tail padding when laying out virtual bases.  For example:
1530
1531 @smallexample
1532 struct A @{ virtual void f(); char c1; @};
1533 struct B @{ B(); char c2; @};
1534 struct C : public A, public virtual B @{@};
1535 @end smallexample
1536
1537 @noindent
1538 In this case, G++ will not place @code{B} into the tail-padding for
1539 @code{A}; other compilers will.  You can avoid this problem by
1540 explicitly padding @code{A} so that its size is a multiple of its
1541 alignment (ignoring virtual base classes); that will cause G++ and other
1542 compilers to layout @code{C} identically.
1543
1544 @item
1545 Incorrect handling of bit-fields with declared widths greater than that
1546 of their underlying types, when the bit-fields appear in a union.  For
1547 example:
1548
1549 @smallexample
1550 union U @{ int i : 4096; @};
1551 @end smallexample
1552
1553 @noindent
1554 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1555 union too small by the number of bits in an @code{int}.
1556
1557 @item
1558 Empty classes can be placed at incorrect offsets.  For example:
1559  
1560 @smallexample
1561 struct A @{@};
1562
1563 struct B @{
1564   A a;
1565   virtual void f ();
1566 @};
1567
1568 struct C : public B, public A @{@};
1569 @end smallexample
1570
1571 @noindent
1572 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1573 it should be placed at offset zero.  G++ mistakenly believes that the
1574 @code{A} data member of @code{B} is already at offset zero.
1575
1576 @item
1577 Names of template functions whose types involve @code{typename} or
1578 template template parameters can be mangled incorrectly.
1579
1580 @smallexample
1581 template <typename Q>
1582 void f(typename Q::X) @{@}
1583
1584 template <template <typename> class Q>
1585 void f(typename Q<int>::X) @{@}
1586 @end smallexample
1587
1588 @noindent
1589 Instantiations of these templates may be mangled incorrectly.
1590
1591 @end itemize
1592
1593 @item -Wctor-dtor-privacy @r{(C++ only)}
1594 @opindex Wctor-dtor-privacy
1595 Warn when a class seems unusable, because all the constructors or
1596 destructors in a class are private and the class has no friends or
1597 public static member functions.
1598
1599 @item -Wnon-virtual-dtor @r{(C++ only)}
1600 @opindex Wnon-virtual-dtor
1601 Warn when a class declares a non-virtual destructor that should probably
1602 be virtual, because it looks like the class will be used polymorphically.
1603 This warning is enabled by @option{-Wall}.
1604
1605 @item -Wreorder @r{(C++ only)}
1606 @opindex Wreorder
1607 @cindex reordering, warning
1608 @cindex warning for reordering of member initializers
1609 Warn when the order of member initializers given in the code does not
1610 match the order in which they must be executed.  For instance:
1611
1612 @smallexample
1613 struct A @{
1614   int i;
1615   int j;
1616   A(): j (0), i (1) @{ @}
1617 @};
1618 @end smallexample
1619
1620 Here the compiler will warn that the member initializers for @samp{i}
1621 and @samp{j} will be rearranged to match the declaration order of the
1622 members.  This warning is enabled by @option{-Wall}.
1623 @end table
1624
1625 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1626
1627 @table @gcctabopt
1628 @item -Weffc++ @r{(C++ only)}
1629 @opindex Weffc++
1630 Warn about violations of the following style guidelines from Scott Meyers'
1631 @cite{Effective C++} book:
1632
1633 @itemize @bullet
1634 @item
1635 Item 11:  Define a copy constructor and an assignment operator for classes
1636 with dynamically allocated memory.
1637
1638 @item
1639 Item 12:  Prefer initialization to assignment in constructors.
1640
1641 @item
1642 Item 14:  Make destructors virtual in base classes.
1643
1644 @item
1645 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1646
1647 @item
1648 Item 23:  Don't try to return a reference when you must return an object.
1649
1650 @end itemize
1651
1652 and about violations of the following style guidelines from Scott Meyers'
1653 @cite{More Effective C++} book:
1654
1655 @itemize @bullet
1656 @item
1657 Item 6:  Distinguish between prefix and postfix forms of increment and
1658 decrement operators.
1659
1660 @item
1661 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1662
1663 @end itemize
1664
1665 If you use this option, you should be aware that the standard library
1666 headers do not obey all of these guidelines; you can use @samp{grep -v}
1667 to filter out those warnings.
1668
1669 @item -Wno-deprecated @r{(C++ only)}
1670 @opindex Wno-deprecated
1671 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1672
1673 @item -Wno-non-template-friend @r{(C++ only)}
1674 @opindex Wno-non-template-friend
1675 Disable warnings when non-templatized friend functions are declared
1676 within a template.  With the advent of explicit template specification
1677 support in G++, if the name of the friend is an unqualified-id (i.e.,
1678 @samp{friend foo(int)}), the C++ language specification demands that the
1679 friend declare or define an ordinary, nontemplate function.  (Section
1680 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1681 could be interpreted as a particular specialization of a templatized
1682 function.  Because this non-conforming behavior is no longer the default
1683 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1684 check existing code for potential trouble spots, and is on by default.
1685 This new compiler behavior can be turned off with
1686 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1687 but disables the helpful warning.
1688
1689 @item -Wold-style-cast @r{(C++ only)}
1690 @opindex Wold-style-cast
1691 Warn if an old-style (C-style) cast to a non-void type is used within
1692 a C++ program.  The new-style casts (@samp{static_cast},
1693 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1694 unintended effects, and much easier to grep for.
1695
1696 @item -Woverloaded-virtual @r{(C++ only)}
1697 @opindex Woverloaded-virtual
1698 @cindex overloaded virtual fn, warning
1699 @cindex warning for overloaded virtual fn
1700 Warn when a function declaration hides virtual functions from a
1701 base class.  For example, in:
1702
1703 @smallexample
1704 struct A @{
1705   virtual void f();
1706 @};
1707
1708 struct B: public A @{
1709   void f(int);
1710 @};
1711 @end smallexample
1712
1713 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1714 like this:
1715
1716 @smallexample
1717 B* b;
1718 b->f();
1719 @end smallexample
1720
1721 will fail to compile.
1722
1723 @item -Wno-pmf-conversions @r{(C++ only)}
1724 @opindex Wno-pmf-conversions
1725 Disable the diagnostic for converting a bound pointer to member function
1726 to a plain pointer.
1727
1728 @item -Wsign-promo @r{(C++ only)}
1729 @opindex Wsign-promo
1730 Warn when overload resolution chooses a promotion from unsigned or
1731 enumeral type to a signed type over a conversion to an unsigned type of
1732 the same size.  Previous versions of G++ would try to preserve
1733 unsignedness, but the standard mandates the current behavior.
1734
1735 @item -Wsynth @r{(C++ only)}
1736 @opindex Wsynth
1737 @cindex warning for synthesized methods
1738 @cindex synthesized methods, warning
1739 Warn when G++'s synthesis behavior does not match that of cfront.  For
1740 instance:
1741
1742 @smallexample
1743 struct A @{
1744   operator int ();
1745   A& operator = (int);
1746 @};
1747
1748 main ()
1749 @{
1750   A a,b;
1751   a = b;
1752 @}
1753 @end smallexample
1754
1755 In this example, G++ will synthesize a default @samp{A& operator =
1756 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1757 @end table
1758
1759 @node Objective-C Dialect Options
1760 @section Options Controlling Objective-C Dialect
1761
1762 @cindex compiler options, Objective-C
1763 @cindex Objective-C options, command line
1764 @cindex options, Objective-C
1765 This section describes the command-line options that are only meaningful
1766 for Objective-C programs; but you can also use most of the GNU compiler
1767 options regardless of what language your program is in.  For example,
1768 you might compile a file @code{some_class.m} like this:
1769
1770 @example
1771 gcc -g -fgnu-runtime -O -c some_class.m
1772 @end example
1773
1774 @noindent
1775 In this example, only @option{-fgnu-runtime} is an option meant only for
1776 Objective-C programs; you can use the other options with any language
1777 supported by GCC@.
1778
1779 Here is a list of options that are @emph{only} for compiling Objective-C
1780 programs:
1781
1782 @table @gcctabopt
1783 @item -fconstant-string-class=@var{class-name}
1784 @opindex fconstant-string-class
1785 Use @var{class-name} as the name of the class to instantiate for each
1786 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1787 class name is @code{NXConstantString}.
1788
1789 @item -fgnu-runtime
1790 @opindex fgnu-runtime
1791 Generate object code compatible with the standard GNU Objective-C
1792 runtime.  This is the default for most types of systems.
1793
1794 @item -fnext-runtime
1795 @opindex fnext-runtime
1796 Generate output compatible with the NeXT runtime.  This is the default
1797 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1798 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1799 used.
1800
1801 @item -gen-decls
1802 @opindex gen-decls
1803 Dump interface declarations for all classes seen in the source file to a
1804 file named @file{@var{sourcename}.decl}.
1805
1806 @item -Wno-protocol
1807 @opindex Wno-protocol
1808 If a class is declared to implement a protocol, a warning is issued for
1809 every method in the protocol that is not implemented by the class.  The
1810 default behavior is to issue a warning for every method not explicitly
1811 implemented in the class, even if a method implementation is inherited
1812 from the superclass.  If you use the @code{-Wno-protocol} option, then
1813 methods inherited from the superclass are considered to be implemented,
1814 and no warning is issued for them.
1815
1816 @item -Wselector
1817 @opindex Wselector
1818 Warn if multiple methods of different types for the same selector are
1819 found during compilation.  The check is performed on the list of methods
1820 in the final stage of compilation.  Additionally, a check is performed
1821 that for each selector appearing in a @code{@@selector(@dots{})}
1822 expression, a corresponding method with that selector has been found
1823 during compilation.  Because these checks scan the method table only at
1824 the end of compilation, these warnings are not produced if the final
1825 stage of compilation is not reached, for example because an error is
1826 found during compilation, or because the @code{-fsyntax-only} option is
1827 being used.
1828
1829 @item -Wundeclared-selector
1830 @opindex Wundeclared-selector
1831 Warn if a @code{@@selector(@dots{})} expression referring to an
1832 undeclared selector is found.  A selector is considered undeclared if no
1833 method with that name has been declared (explicitly, in an
1834 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1835 an @code{@@implementation} section) before the
1836 @code{@@selector(@dots{})} expression.  This option always performs its
1837 checks as soon as a @code{@@selector(@dots{})} expression is found
1838 (while @code{-Wselector} only performs its checks in the final stage of
1839 compilation), and so additionally enforces the coding style convention
1840 that methods and selectors must be declared before being used.
1841
1842 @c not documented because only avail via -Wp
1843 @c @item -print-objc-runtime-info
1844
1845 @end table
1846
1847 @node Language Independent Options
1848 @section Options to Control Diagnostic Messages Formatting
1849 @cindex options to control diagnostics formatting
1850 @cindex diagnostic messages
1851 @cindex message formatting
1852
1853 Traditionally, diagnostic messages have been formatted irrespective of
1854 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1855 below can be used to control the diagnostic messages formatting
1856 algorithm, e.g.@: how many characters per line, how often source location
1857 information should be reported.  Right now, only the C++ front end can
1858 honor these options.  However it is expected, in the near future, that
1859 the remaining front ends would be able to digest them correctly.
1860
1861 @table @gcctabopt
1862 @item -fmessage-length=@var{n}
1863 @opindex fmessage-length
1864 Try to format error messages so that they fit on lines of about @var{n}
1865 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1866 the front ends supported by GCC@.  If @var{n} is zero, then no
1867 line-wrapping will be done; each error message will appear on a single
1868 line.
1869
1870 @opindex fdiagnostics-show-location
1871 @item -fdiagnostics-show-location=once
1872 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1873 reporter to emit @emph{once} source location information; that is, in
1874 case the message is too long to fit on a single physical line and has to
1875 be wrapped, the source location won't be emitted (as prefix) again,
1876 over and over, in subsequent continuation lines.  This is the default
1877 behavior.
1878
1879 @item -fdiagnostics-show-location=every-line
1880 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1881 messages reporter to emit the same source location information (as
1882 prefix) for physical lines that result from the process of breaking
1883 a message which is too long to fit on a single line.
1884
1885 @end table
1886
1887 @node Warning Options
1888 @section Options to Request or Suppress Warnings
1889 @cindex options to control warnings
1890 @cindex warning messages
1891 @cindex messages, warning
1892 @cindex suppressing warnings
1893
1894 Warnings are diagnostic messages that report constructions which
1895 are not inherently erroneous but which are risky or suggest there
1896 may have been an error.
1897
1898 You can request many specific warnings with options beginning @samp{-W},
1899 for example @option{-Wimplicit} to request warnings on implicit
1900 declarations.  Each of these specific warning options also has a
1901 negative form beginning @samp{-Wno-} to turn off warnings;
1902 for example, @option{-Wno-implicit}.  This manual lists only one of the
1903 two forms, whichever is not the default.
1904
1905 The following options control the amount and kinds of warnings produced
1906 by GCC; for further, language-specific options also refer to
1907 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1908
1909 @table @gcctabopt
1910 @cindex syntax checking
1911 @item -fsyntax-only
1912 @opindex fsyntax-only
1913 Check the code for syntax errors, but don't do anything beyond that.
1914
1915 @item -pedantic
1916 @opindex pedantic
1917 Issue all the warnings demanded by strict ISO C and ISO C++;
1918 reject all programs that use forbidden extensions, and some other
1919 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1920 version of the ISO C standard specified by any @option{-std} option used.
1921
1922 Valid ISO C and ISO C++ programs should compile properly with or without
1923 this option (though a rare few will require @option{-ansi} or a
1924 @option{-std} option specifying the required version of ISO C)@.  However,
1925 without this option, certain GNU extensions and traditional C and C++
1926 features are supported as well.  With this option, they are rejected.
1927
1928 @option{-pedantic} does not cause warning messages for use of the
1929 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1930 warnings are also disabled in the expression that follows
1931 @code{__extension__}.  However, only system header files should use
1932 these escape routes; application programs should avoid them.
1933 @xref{Alternate Keywords}.
1934
1935 Some users try to use @option{-pedantic} to check programs for strict ISO
1936 C conformance.  They soon find that it does not do quite what they want:
1937 it finds some non-ISO practices, but not all---only those for which
1938 ISO C @emph{requires} a diagnostic, and some others for which
1939 diagnostics have been added.
1940
1941 A feature to report any failure to conform to ISO C might be useful in
1942 some instances, but would require considerable additional work and would
1943 be quite different from @option{-pedantic}.  We don't have plans to
1944 support such a feature in the near future.
1945
1946 Where the standard specified with @option{-std} represents a GNU
1947 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1948 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1949 extended dialect is based.  Warnings from @option{-pedantic} are given
1950 where they are required by the base standard.  (It would not make sense
1951 for such warnings to be given only for features not in the specified GNU
1952 C dialect, since by definition the GNU dialects of C include all
1953 features the compiler supports with the given option, and there would be
1954 nothing to warn about.)
1955
1956 @item -pedantic-errors
1957 @opindex pedantic-errors
1958 Like @option{-pedantic}, except that errors are produced rather than
1959 warnings.
1960
1961 @item -w
1962 @opindex w
1963 Inhibit all warning messages.
1964
1965 @item -Wno-import
1966 @opindex Wno-import
1967 Inhibit warning messages about the use of @samp{#import}.
1968
1969 @item -Wchar-subscripts
1970 @opindex Wchar-subscripts
1971 Warn if an array subscript has type @code{char}.  This is a common cause
1972 of error, as programmers often forget that this type is signed on some
1973 machines.
1974
1975 @item -Wcomment
1976 @opindex Wcomment
1977 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1978 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1979
1980 @item -Wformat
1981 @opindex Wformat
1982 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1983 the arguments supplied have types appropriate to the format string
1984 specified, and that the conversions specified in the format string make
1985 sense.  This includes standard functions, and others specified by format
1986 attributes (@pxref{Function Attributes}), in the @code{printf},
1987 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1988 not in the C standard) families.
1989
1990 The formats are checked against the format features supported by GNU
1991 libc version 2.2.  These include all ISO C90 and C99 features, as well
1992 as features from the Single Unix Specification and some BSD and GNU
1993 extensions.  Other library implementations may not support all these
1994 features; GCC does not support warning about features that go beyond a
1995 particular library's limitations.  However, if @option{-pedantic} is used
1996 with @option{-Wformat}, warnings will be given about format features not
1997 in the selected standard version (but not for @code{strfmon} formats,
1998 since those are not in any version of the C standard).  @xref{C Dialect
1999 Options,,Options Controlling C Dialect}.
2000
2001 Since @option{-Wformat} also checks for null format arguments for
2002 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2003
2004 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2005 aspects of format checking, the options @option{-Wno-format-y2k},
2006 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2007 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2008 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2009
2010 @item -Wno-format-y2k
2011 @opindex Wno-format-y2k
2012 If @option{-Wformat} is specified, do not warn about @code{strftime}
2013 formats which may yield only a two-digit year.
2014
2015 @item -Wno-format-extra-args
2016 @opindex Wno-format-extra-args
2017 If @option{-Wformat} is specified, do not warn about excess arguments to a
2018 @code{printf} or @code{scanf} format function.  The C standard specifies
2019 that such arguments are ignored.
2020
2021 Where the unused arguments lie between used arguments that are
2022 specified with @samp{$} operand number specifications, normally
2023 warnings are still given, since the implementation could not know what
2024 type to pass to @code{va_arg} to skip the unused arguments.  However,
2025 in the case of @code{scanf} formats, this option will suppress the
2026 warning if the unused arguments are all pointers, since the Single
2027 Unix Specification says that such unused arguments are allowed.
2028
2029 @item -Wno-format-zero-length
2030 @opindex Wno-format-zero-length
2031 If @option{-Wformat} is specified, do not warn about zero-length formats.
2032 The C standard specifies that zero-length formats are allowed.
2033
2034 @item -Wformat-nonliteral
2035 @opindex Wformat-nonliteral
2036 If @option{-Wformat} is specified, also warn if the format string is not a
2037 string literal and so cannot be checked, unless the format function
2038 takes its format arguments as a @code{va_list}.
2039
2040 @item -Wformat-security
2041 @opindex Wformat-security
2042 If @option{-Wformat} is specified, also warn about uses of format
2043 functions that represent possible security problems.  At present, this
2044 warns about calls to @code{printf} and @code{scanf} functions where the
2045 format string is not a string literal and there are no format arguments,
2046 as in @code{printf (foo);}.  This may be a security hole if the format
2047 string came from untrusted input and contains @samp{%n}.  (This is
2048 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2049 in future warnings may be added to @option{-Wformat-security} that are not
2050 included in @option{-Wformat-nonliteral}.)
2051
2052 @item -Wformat=2
2053 @opindex Wformat=2
2054 Enable @option{-Wformat} plus format checks not included in
2055 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2056 -Wformat-nonliteral -Wformat-security}.
2057
2058 @item -Wnonnull
2059 @opindex Wnonnull
2060 Enable warning about passing a null pointer for arguments marked as
2061 requiring a non-null value by the @code{nonnull} function attribute.
2062
2063 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2064 can be disabled with the @option{-Wno-nonnull} option.
2065
2066 @item -Wimplicit-int
2067 @opindex Wimplicit-int
2068 Warn when a declaration does not specify a type.
2069
2070 @item -Wimplicit-function-declaration
2071 @itemx -Werror-implicit-function-declaration
2072 @opindex Wimplicit-function-declaration
2073 @opindex Werror-implicit-function-declaration
2074 Give a warning (or error) whenever a function is used before being
2075 declared.
2076
2077 @item -Wimplicit
2078 @opindex Wimplicit
2079 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2080
2081 @item -Wmain
2082 @opindex Wmain
2083 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2084 function with external linkage, returning int, taking either zero
2085 arguments, two, or three arguments of appropriate types.
2086
2087 @item -Wmissing-braces
2088 @opindex Wmissing-braces
2089 Warn if an aggregate or union initializer is not fully bracketed.  In
2090 the following example, the initializer for @samp{a} is not fully
2091 bracketed, but that for @samp{b} is fully bracketed.
2092
2093 @smallexample
2094 int a[2][2] = @{ 0, 1, 2, 3 @};
2095 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2096 @end smallexample
2097
2098 @item -Wparentheses
2099 @opindex Wparentheses
2100 Warn if parentheses are omitted in certain contexts, such
2101 as when there is an assignment in a context where a truth value
2102 is expected, or when operators are nested whose precedence people
2103 often get confused about.
2104
2105 Also warn about constructions where there may be confusion to which
2106 @code{if} statement an @code{else} branch belongs.  Here is an example of
2107 such a case:
2108
2109 @smallexample
2110 @group
2111 @{
2112   if (a)
2113     if (b)
2114       foo ();
2115   else
2116     bar ();
2117 @}
2118 @end group
2119 @end smallexample
2120
2121 In C, every @code{else} branch belongs to the innermost possible @code{if}
2122 statement, which in this example is @code{if (b)}.  This is often not
2123 what the programmer expected, as illustrated in the above example by
2124 indentation the programmer chose.  When there is the potential for this
2125 confusion, GCC will issue a warning when this flag is specified.
2126 To eliminate the warning, add explicit braces around the innermost
2127 @code{if} statement so there is no way the @code{else} could belong to
2128 the enclosing @code{if}.  The resulting code would look like this:
2129
2130 @smallexample
2131 @group
2132 @{
2133   if (a)
2134     @{
2135       if (b)
2136         foo ();
2137       else
2138         bar ();
2139     @}
2140 @}
2141 @end group
2142 @end smallexample
2143
2144 @item -Wsequence-point
2145 @opindex Wsequence-point
2146 Warn about code that may have undefined semantics because of violations
2147 of sequence point rules in the C standard.
2148
2149 The C standard defines the order in which expressions in a C program are
2150 evaluated in terms of @dfn{sequence points}, which represent a partial
2151 ordering between the execution of parts of the program: those executed
2152 before the sequence point, and those executed after it.  These occur
2153 after the evaluation of a full expression (one which is not part of a
2154 larger expression), after the evaluation of the first operand of a
2155 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2156 function is called (but after the evaluation of its arguments and the
2157 expression denoting the called function), and in certain other places.
2158 Other than as expressed by the sequence point rules, the order of
2159 evaluation of subexpressions of an expression is not specified.  All
2160 these rules describe only a partial order rather than a total order,
2161 since, for example, if two functions are called within one expression
2162 with no sequence point between them, the order in which the functions
2163 are called is not specified.  However, the standards committee have
2164 ruled that function calls do not overlap.
2165
2166 It is not specified when between sequence points modifications to the
2167 values of objects take effect.  Programs whose behavior depends on this
2168 have undefined behavior; the C standard specifies that ``Between the
2169 previous and next sequence point an object shall have its stored value
2170 modified at most once by the evaluation of an expression.  Furthermore,
2171 the prior value shall be read only to determine the value to be
2172 stored.''.  If a program breaks these rules, the results on any
2173 particular implementation are entirely unpredictable.
2174
2175 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2176 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2177 diagnosed by this option, and it may give an occasional false positive
2178 result, but in general it has been found fairly effective at detecting
2179 this sort of problem in programs.
2180
2181 The present implementation of this option only works for C programs.  A
2182 future implementation may also work for C++ programs.
2183
2184 The C standard is worded confusingly, therefore there is some debate
2185 over the precise meaning of the sequence point rules in subtle cases.
2186 Links to discussions of the problem, including proposed formal
2187 definitions, may be found on our readings page, at
2188 @w{@uref{http://gcc.gnu.org/readings.html}}.
2189
2190 @item -Wreturn-type
2191 @opindex Wreturn-type
2192 Warn whenever a function is defined with a return-type that defaults to
2193 @code{int}.  Also warn about any @code{return} statement with no
2194 return-value in a function whose return-type is not @code{void}.
2195
2196 For C++, a function without return type always produces a diagnostic
2197 message, even when @option{-Wno-return-type} is specified.  The only
2198 exceptions are @samp{main} and functions defined in system headers.
2199
2200 @item -Wswitch
2201 @opindex Wswitch
2202 Warn whenever a @code{switch} statement has an index of enumeral type
2203 and lacks a @code{case} for one or more of the named codes of that
2204 enumeration.  (The presence of a @code{default} label prevents this
2205 warning.)  @code{case} labels outside the enumeration range also
2206 provoke warnings when this option is used.
2207
2208 @item -Wswitch-default
2209 @opindex Wswitch-switch
2210 Warn whenever a @code{switch} statement does not have a @code{default}
2211 case.
2212
2213 @item -Wswitch-enum
2214 @opindex Wswitch-enum
2215 Warn whenever a @code{switch} statement has an index of enumeral type
2216 and lacks a @code{case} for one or more of the named codes of that
2217 enumeration.  @code{case} labels outside the enumeration range also
2218 provoke warnings when this option is used.
2219
2220 @item -Wtrigraphs
2221 @opindex Wtrigraphs
2222 Warn if any trigraphs are encountered that might change the meaning of
2223 the program (trigraphs within comments are not warned about).
2224
2225 @item -Wunused-function
2226 @opindex Wunused-function
2227 Warn whenever a static function is declared but not defined or a
2228 non\-inline static function is unused.
2229
2230 @item -Wunused-label
2231 @opindex Wunused-label
2232 Warn whenever a label is declared but not used.
2233
2234 To suppress this warning use the @samp{unused} attribute
2235 (@pxref{Variable Attributes}).
2236
2237 @item -Wunused-parameter
2238 @opindex Wunused-parameter
2239 Warn whenever a function parameter is unused aside from its declaration.
2240
2241 To suppress this warning use the @samp{unused} attribute
2242 (@pxref{Variable Attributes}).
2243
2244 @item -Wunused-variable
2245 @opindex Wunused-variable
2246 Warn whenever a local variable or non-constant static variable is unused
2247 aside from its declaration
2248
2249 To suppress this warning use the @samp{unused} attribute
2250 (@pxref{Variable Attributes}).
2251
2252 @item -Wunused-value
2253 @opindex Wunused-value
2254 Warn whenever a statement computes a result that is explicitly not used.
2255
2256 To suppress this warning cast the expression to @samp{void}.
2257
2258 @item -Wunused
2259 @opindex Wunused
2260 All the above @option{-Wunused} options combined.
2261
2262 In order to get a warning about an unused function parameter, you must
2263 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2264 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2265
2266 @item -Wuninitialized
2267 @opindex Wuninitialized
2268 Warn if an automatic variable is used without first being initialized or
2269 if a variable may be clobbered by a @code{setjmp} call.
2270
2271 These warnings are possible only in optimizing compilation,
2272 because they require data flow information that is computed only
2273 when optimizing.  If you don't specify @option{-O}, you simply won't
2274 get these warnings.
2275
2276 These warnings occur only for variables that are candidates for
2277 register allocation.  Therefore, they do not occur for a variable that
2278 is declared @code{volatile}, or whose address is taken, or whose size
2279 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2280 structures, unions or arrays, even when they are in registers.
2281
2282 Note that there may be no warning about a variable that is used only
2283 to compute a value that itself is never used, because such
2284 computations may be deleted by data flow analysis before the warnings
2285 are printed.
2286
2287 These warnings are made optional because GCC is not smart
2288 enough to see all the reasons why the code might be correct
2289 despite appearing to have an error.  Here is one example of how
2290 this can happen:
2291
2292 @smallexample
2293 @group
2294 @{
2295   int x;
2296   switch (y)
2297     @{
2298     case 1: x = 1;
2299       break;
2300     case 2: x = 4;
2301       break;
2302     case 3: x = 5;
2303     @}
2304   foo (x);
2305 @}
2306 @end group
2307 @end smallexample
2308
2309 @noindent
2310 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2311 always initialized, but GCC doesn't know this.  Here is
2312 another common case:
2313
2314 @smallexample
2315 @{
2316   int save_y;
2317   if (change_y) save_y = y, y = new_y;
2318   @dots{}
2319   if (change_y) y = save_y;
2320 @}
2321 @end smallexample
2322
2323 @noindent
2324 This has no bug because @code{save_y} is used only if it is set.
2325
2326 @cindex @code{longjmp} warnings
2327 This option also warns when a non-volatile automatic variable might be
2328 changed by a call to @code{longjmp}.  These warnings as well are possible
2329 only in optimizing compilation.
2330
2331 The compiler sees only the calls to @code{setjmp}.  It cannot know
2332 where @code{longjmp} will be called; in fact, a signal handler could
2333 call it at any point in the code.  As a result, you may get a warning
2334 even when there is in fact no problem because @code{longjmp} cannot
2335 in fact be called at the place which would cause a problem.
2336
2337 Some spurious warnings can be avoided if you declare all the functions
2338 you use that never return as @code{noreturn}.  @xref{Function
2339 Attributes}.
2340
2341 @item -Wunknown-pragmas
2342 @opindex Wunknown-pragmas
2343 @cindex warning for unknown pragmas
2344 @cindex unknown pragmas, warning
2345 @cindex pragmas, warning of unknown
2346 Warn when a #pragma directive is encountered which is not understood by
2347 GCC@.  If this command line option is used, warnings will even be issued
2348 for unknown pragmas in system header files.  This is not the case if
2349 the warnings were only enabled by the @option{-Wall} command line option.
2350
2351 @item -Wstrict-aliasing
2352 @opindex Wstrict-aliasing
2353 This option is only active when @option{-fstrict-aliasing} is active.
2354 It warns about code which might break the strict aliasing rules that the
2355 compiler is using for optimization. The warning does not catch all
2356 cases, but does attempt to catch the more common pitfalls. It is
2357 included in @option{-Wall}.
2358
2359 @item -Wall
2360 @opindex Wall
2361 All of the above @samp{-W} options combined.  This enables all the
2362 warnings about constructions that some users consider questionable, and
2363 that are easy to avoid (or modify to prevent the warning), even in
2364 conjunction with macros.  This also enables some language-specific
2365 warnings described in @ref{C++ Dialect Options} and
2366 @ref{Objective-C Dialect Options}.
2367 @end table
2368
2369 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2370 Some of them warn about constructions that users generally do not
2371 consider questionable, but which occasionally you might wish to check
2372 for; others warn about constructions that are necessary or hard to avoid
2373 in some cases, and there is no simple way to modify the code to suppress
2374 the warning.
2375
2376 @table @gcctabopt
2377 @item -Wextra
2378 @opindex W
2379 @opindex Wextra
2380 (This option used to be called @option{-W}.  The older name is still
2381 supported, but the newer name is more descriptive.)  Print extra warning
2382 messages for these events:
2383
2384 @itemize @bullet
2385 @item
2386 A function can return either with or without a value.  (Falling
2387 off the end of the function body is considered returning without
2388 a value.)  For example, this function would evoke such a
2389 warning:
2390
2391 @smallexample
2392 @group
2393 foo (a)
2394 @{
2395   if (a > 0)
2396     return a;
2397 @}
2398 @end group
2399 @end smallexample
2400
2401 @item
2402 An expression-statement or the left-hand side of a comma expression
2403 contains no side effects.
2404 To suppress the warning, cast the unused expression to void.
2405 For example, an expression such as @samp{x[i,j]} will cause a warning,
2406 but @samp{x[(void)i,j]} will not.
2407
2408 @item
2409 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2410
2411 @item
2412 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2413 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2414 that of ordinary mathematical notation.
2415
2416 @item
2417 Storage-class specifiers like @code{static} are not the first things in
2418 a declaration.  According to the C Standard, this usage is obsolescent.
2419
2420 @item
2421 The return type of a function has a type qualifier such as @code{const}.
2422 Such a type qualifier has no effect, since the value returned by a
2423 function is not an lvalue.  (But don't warn about the GNU extension of
2424 @code{volatile void} return types.  That extension will be warned about
2425 if @option{-pedantic} is specified.)
2426
2427 @item
2428 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2429 arguments.
2430
2431 @item
2432 A comparison between signed and unsigned values could produce an
2433 incorrect result when the signed value is converted to unsigned.
2434 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2435
2436 @item
2437 An aggregate has an initializer which does not initialize all members.
2438 For example, the following code would cause such a warning, because
2439 @code{x.h} would be implicitly initialized to zero:
2440
2441 @smallexample
2442 struct s @{ int f, g, h; @};
2443 struct s x = @{ 3, 4 @};
2444 @end smallexample
2445
2446 @item
2447 A function parameter is declared without a type specifier in K&R-style
2448 functions:
2449
2450 @smallexample
2451 void foo(bar) @{ @}
2452 @end smallexample
2453
2454 @item
2455 An empty body occurs in an @samp{if} or @samp{else} statement.
2456
2457 @item
2458 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2459 @samp{>}, or @samp{>=}.
2460
2461 @item
2462 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2463
2464 @item
2465 Any of several floating-point events that often indicate errors, such as
2466 overflow, underflow, loss of precision, etc.
2467
2468 @item @r{(C++ only)}
2469 An enumerator and a non-enumerator both appear in a conditional expression.
2470
2471 @item @r{(C++ only)}
2472 A non-static reference or non-static @samp{const} member appears in a
2473 class without constructors.
2474
2475 @item @r{(C++ only)}
2476 Ambiguous virtual bases.
2477
2478 @item @r{(C++ only)}
2479 Subscripting an array which has been declared @samp{register}.
2480
2481 @item @r{(C++ only)}
2482 Taking the address of a variable which has been declared @samp{register}.
2483
2484 @item @r{(C++ only)}
2485 A base class is not initialized in a derived class' copy constructor.
2486 @end itemize
2487
2488 @item -Wno-div-by-zero
2489 @opindex Wno-div-by-zero
2490 @opindex Wdiv-by-zero
2491 Do not warn about compile-time integer division by zero.  Floating point
2492 division by zero is not warned about, as it can be a legitimate way of
2493 obtaining infinities and NaNs.
2494
2495 @item -Wsystem-headers
2496 @opindex Wsystem-headers
2497 @cindex warnings from system headers
2498 @cindex system headers, warnings from
2499 Print warning messages for constructs found in system header files.
2500 Warnings from system headers are normally suppressed, on the assumption
2501 that they usually do not indicate real problems and would only make the
2502 compiler output harder to read.  Using this command line option tells
2503 GCC to emit warnings from system headers as if they occurred in user
2504 code.  However, note that using @option{-Wall} in conjunction with this
2505 option will @emph{not} warn about unknown pragmas in system
2506 headers---for that, @option{-Wunknown-pragmas} must also be used.
2507
2508 @item -Wfloat-equal
2509 @opindex Wfloat-equal
2510 Warn if floating point values are used in equality comparisons.
2511
2512 The idea behind this is that sometimes it is convenient (for the
2513 programmer) to consider floating-point values as approximations to
2514 infinitely precise real numbers.  If you are doing this, then you need
2515 to compute (by analyzing the code, or in some other way) the maximum or
2516 likely maximum error that the computation introduces, and allow for it
2517 when performing comparisons (and when producing output, but that's a
2518 different problem).  In particular, instead of testing for equality, you
2519 would check to see whether the two values have ranges that overlap; and
2520 this is done with the relational operators, so equality comparisons are
2521 probably mistaken.
2522
2523 @item -Wtraditional @r{(C only)}
2524 @opindex Wtraditional
2525 Warn about certain constructs that behave differently in traditional and
2526 ISO C@.  Also warn about ISO C constructs that have no traditional C
2527 equivalent, and/or problematic constructs which should be avoided.
2528
2529 @itemize @bullet
2530 @item
2531 Macro parameters that appear within string literals in the macro body.
2532 In traditional C macro replacement takes place within string literals,
2533 but does not in ISO C@.
2534
2535 @item
2536 In traditional C, some preprocessor directives did not exist.
2537 Traditional preprocessors would only consider a line to be a directive
2538 if the @samp{#} appeared in column 1 on the line.  Therefore
2539 @option{-Wtraditional} warns about directives that traditional C
2540 understands but would ignore because the @samp{#} does not appear as the
2541 first character on the line.  It also suggests you hide directives like
2542 @samp{#pragma} not understood by traditional C by indenting them.  Some
2543 traditional implementations would not recognize @samp{#elif}, so it
2544 suggests avoiding it altogether.
2545
2546 @item
2547 A function-like macro that appears without arguments.
2548
2549 @item
2550 The unary plus operator.
2551
2552 @item
2553 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2554 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2555 constants.)  Note, these suffixes appear in macros defined in the system
2556 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2557 Use of these macros in user code might normally lead to spurious
2558 warnings, however gcc's integrated preprocessor has enough context to
2559 avoid warning in these cases.
2560
2561 @item
2562 A function declared external in one block and then used after the end of
2563 the block.
2564
2565 @item
2566 A @code{switch} statement has an operand of type @code{long}.
2567
2568 @item
2569 A non-@code{static} function declaration follows a @code{static} one.
2570 This construct is not accepted by some traditional C compilers.
2571
2572 @item
2573 The ISO type of an integer constant has a different width or
2574 signedness from its traditional type.  This warning is only issued if
2575 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2576 typically represent bit patterns, are not warned about.
2577
2578 @item
2579 Usage of ISO string concatenation is detected.
2580
2581 @item
2582 Initialization of automatic aggregates.
2583
2584 @item
2585 Identifier conflicts with labels.  Traditional C lacks a separate
2586 namespace for labels.
2587
2588 @item
2589 Initialization of unions.  If the initializer is zero, the warning is
2590 omitted.  This is done under the assumption that the zero initializer in
2591 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2592 initializer warnings and relies on default initialization to zero in the
2593 traditional C case.
2594
2595 @item
2596 Conversions by prototypes between fixed/floating point values and vice
2597 versa.  The absence of these prototypes when compiling with traditional
2598 C would cause serious problems.  This is a subset of the possible
2599 conversion warnings, for the full set use @option{-Wconversion}.
2600
2601 @item
2602 Use of ISO C style function definitions.  This warning intentionally is
2603 @emph{not} issued for prototype declarations or variadic functions
2604 because these ISO C features will appear in your code when using
2605 libiberty's traditional C compatibility macros, @code{PARAMS} and
2606 @code{VPARAMS}.  This warning is also bypassed for nested functions
2607 because that feature is already a gcc extension and thus not relevant to
2608 traditional C compatibility.
2609 @end itemize
2610
2611 @item -Wundef
2612 @opindex Wundef
2613 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2614
2615 @item -Wendif-labels
2616 @opindex Wendif-labels
2617 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2618
2619 @item -Wshadow
2620 @opindex Wshadow
2621 Warn whenever a local variable shadows another local variable, parameter or
2622 global variable or whenever a built-in function is shadowed.
2623
2624 @item -Wlarger-than-@var{len}
2625 @opindex Wlarger-than
2626 Warn whenever an object of larger than @var{len} bytes is defined.
2627
2628 @item -Wpointer-arith
2629 @opindex Wpointer-arith
2630 Warn about anything that depends on the ``size of'' a function type or
2631 of @code{void}.  GNU C assigns these types a size of 1, for
2632 convenience in calculations with @code{void *} pointers and pointers
2633 to functions.
2634
2635 @item -Wbad-function-cast @r{(C only)}
2636 @opindex Wbad-function-cast
2637 Warn whenever a function call is cast to a non-matching type.
2638 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2639
2640 @item -Wcast-qual
2641 @opindex Wcast-qual
2642 Warn whenever a pointer is cast so as to remove a type qualifier from
2643 the target type.  For example, warn if a @code{const char *} is cast
2644 to an ordinary @code{char *}.
2645
2646 @item -Wcast-align
2647 @opindex Wcast-align
2648 Warn whenever a pointer is cast such that the required alignment of the
2649 target is increased.  For example, warn if a @code{char *} is cast to
2650 an @code{int *} on machines where integers can only be accessed at
2651 two- or four-byte boundaries.
2652
2653 @item -Wwrite-strings
2654 @opindex Wwrite-strings
2655 When compiling C, give string constants the type @code{const
2656 char[@var{length}]} so that
2657 copying the address of one into a non-@code{const} @code{char *}
2658 pointer will get a warning; when compiling C++, warn about the
2659 deprecated conversion from string constants to @code{char *}.
2660 These warnings will help you find at
2661 compile time code that can try to write into a string constant, but
2662 only if you have been very careful about using @code{const} in
2663 declarations and prototypes.  Otherwise, it will just be a nuisance;
2664 this is why we did not make @option{-Wall} request these warnings.
2665
2666 @item -Wconversion
2667 @opindex Wconversion
2668 Warn if a prototype causes a type conversion that is different from what
2669 would happen to the same argument in the absence of a prototype.  This
2670 includes conversions of fixed point to floating and vice versa, and
2671 conversions changing the width or signedness of a fixed point argument
2672 except when the same as the default promotion.
2673
2674 Also, warn if a negative integer constant expression is implicitly
2675 converted to an unsigned type.  For example, warn about the assignment
2676 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2677 casts like @code{(unsigned) -1}.
2678
2679 @item -Wsign-compare
2680 @opindex Wsign-compare
2681 @cindex warning for comparison of signed and unsigned values
2682 @cindex comparison of signed and unsigned values, warning
2683 @cindex signed and unsigned values, comparison warning
2684 Warn when a comparison between signed and unsigned values could produce
2685 an incorrect result when the signed value is converted to unsigned.
2686 This warning is also enabled by @option{-Wextra}; to get the other warnings
2687 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2688
2689 @item -Waggregate-return
2690 @opindex Waggregate-return
2691 Warn if any functions that return structures or unions are defined or
2692 called.  (In languages where you can return an array, this also elicits
2693 a warning.)
2694
2695 @item -Wstrict-prototypes @r{(C only)}
2696 @opindex Wstrict-prototypes
2697 Warn if a function is declared or defined without specifying the
2698 argument types.  (An old-style function definition is permitted without
2699 a warning if preceded by a declaration which specifies the argument
2700 types.)
2701
2702 @item -Wmissing-prototypes @r{(C only)}
2703 @opindex Wmissing-prototypes
2704 Warn if a global function is defined without a previous prototype
2705 declaration.  This warning is issued even if the definition itself
2706 provides a prototype.  The aim is to detect global functions that fail
2707 to be declared in header files.
2708
2709 @item -Wmissing-declarations @r{(C only)}
2710 @opindex Wmissing-declarations
2711 Warn if a global function is defined without a previous declaration.
2712 Do so even if the definition itself provides a prototype.
2713 Use this option to detect global functions that are not declared in
2714 header files.
2715
2716 @item -Wmissing-noreturn
2717 @opindex Wmissing-noreturn
2718 Warn about functions which might be candidates for attribute @code{noreturn}.
2719 Note these are only possible candidates, not absolute ones.  Care should
2720 be taken to manually verify functions actually do not ever return before
2721 adding the @code{noreturn} attribute, otherwise subtle code generation
2722 bugs could be introduced.  You will not get a warning for @code{main} in
2723 hosted C environments.
2724
2725 @item -Wmissing-format-attribute
2726 @opindex Wmissing-format-attribute
2727 @opindex Wformat
2728 If @option{-Wformat} is enabled, also warn about functions which might be
2729 candidates for @code{format} attributes.  Note these are only possible
2730 candidates, not absolute ones.  GCC will guess that @code{format}
2731 attributes might be appropriate for any function that calls a function
2732 like @code{vprintf} or @code{vscanf}, but this might not always be the
2733 case, and some functions for which @code{format} attributes are
2734 appropriate may not be detected.  This option has no effect unless
2735 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2736
2737 @item -Wno-multichar
2738 @opindex Wno-multichar
2739 @opindex Wmultichar
2740 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2741 Usually they indicate a typo in the user's code, as they have
2742 implementation-defined values, and should not be used in portable code.
2743
2744 @item -Wno-deprecated-declarations
2745 @opindex Wno-deprecated-declarations
2746 Do not warn about uses of functions, variables, and types marked as
2747 deprecated by using the @code{deprecated} attribute.
2748 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2749 @pxref{Type Attributes}.)
2750
2751 @item -Wpacked
2752 @opindex Wpacked
2753 Warn if a structure is given the packed attribute, but the packed
2754 attribute has no effect on the layout or size of the structure.
2755 Such structures may be mis-aligned for little benefit.  For
2756 instance, in this code, the variable @code{f.x} in @code{struct bar}
2757 will be misaligned even though @code{struct bar} does not itself
2758 have the packed attribute:
2759
2760 @smallexample
2761 @group
2762 struct foo @{
2763   int x;
2764   char a, b, c, d;
2765 @} __attribute__((packed));
2766 struct bar @{
2767   char z;
2768   struct foo f;
2769 @};
2770 @end group
2771 @end smallexample
2772
2773 @item -Wpadded
2774 @opindex Wpadded
2775 Warn if padding is included in a structure, either to align an element
2776 of the structure or to align the whole structure.  Sometimes when this
2777 happens it is possible to rearrange the fields of the structure to
2778 reduce the padding and so make the structure smaller.
2779
2780 @item -Wredundant-decls
2781 @opindex Wredundant-decls
2782 Warn if anything is declared more than once in the same scope, even in
2783 cases where multiple declaration is valid and changes nothing.
2784
2785 @item -Wnested-externs @r{(C only)}
2786 @opindex Wnested-externs
2787 Warn if an @code{extern} declaration is encountered within a function.
2788
2789 @item -Wunreachable-code
2790 @opindex Wunreachable-code
2791 Warn if the compiler detects that code will never be executed.
2792
2793 This option is intended to warn when the compiler detects that at
2794 least a whole line of source code will never be executed, because
2795 some condition is never satisfied or because it is after a
2796 procedure that never returns.
2797
2798 It is possible for this option to produce a warning even though there
2799 are circumstances under which part of the affected line can be executed,
2800 so care should be taken when removing apparently-unreachable code.
2801
2802 For instance, when a function is inlined, a warning may mean that the
2803 line is unreachable in only one inlined copy of the function.
2804
2805 This option is not made part of @option{-Wall} because in a debugging
2806 version of a program there is often substantial code which checks
2807 correct functioning of the program and is, hopefully, unreachable
2808 because the program does work.  Another common use of unreachable
2809 code is to provide behavior which is selectable at compile-time.
2810
2811 @item -Winline
2812 @opindex Winline
2813 Warn if a function can not be inlined and it was declared as inline.
2814 Even with this option, the compiler will not warn about failures to
2815 inline functions declared in system headers.  
2816
2817 The compiler uses a variety of heuristics to determine whether or not
2818 to inline a function.  For example, the compiler takes into account
2819 the size of the function being inlined and the the amount of inlining
2820 that has already been done in the current function.  Therefore,
2821 seemingly insignificant changes in the source program can cause the
2822 warnings produced by @option{-Winline} to appear or disappear.
2823
2824 @item -Wno-invalid-offsetof @r{(C++ only)}
2825 @opindex Wno-invalid-offsetof
2826 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2827 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2828 to a non-POD type is undefined.  In existing C++ implementations,
2829 however, @samp{offsetof} typically gives meaningful results even when
2830 applied to certain kinds of non-POD types. (Such as a simple
2831 @samp{struct} that fails to be a POD type only by virtue of having a
2832 constructor.)  This flag is for users who are aware that they are
2833 writing nonportable code and who have deliberately chosen to ignore the
2834 warning about it.
2835
2836 The restrictions on @samp{offsetof} may be relaxed in a future version
2837 of the C++ standard.
2838
2839 @item -Winvalid-pch
2840 @opindex Winvalid-pch
2841 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2842 the search path but can't be used.
2843
2844 @item -Wlong-long
2845 @opindex Wlong-long
2846 @opindex Wno-long-long
2847 Warn if @samp{long long} type is used.  This is default.  To inhibit
2848 the warning messages, use @option{-Wno-long-long}.  Flags
2849 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2850 only when @option{-pedantic} flag is used.
2851
2852 @item -Wdisabled-optimization
2853 @opindex Wdisabled-optimization
2854 Warn if a requested optimization pass is disabled.  This warning does
2855 not generally indicate that there is anything wrong with your code; it
2856 merely indicates that GCC's optimizers were unable to handle the code
2857 effectively.  Often, the problem is that your code is too big or too
2858 complex; GCC will refuse to optimize programs when the optimization
2859 itself is likely to take inordinate amounts of time.
2860
2861 @item -Werror
2862 @opindex Werror
2863 Make all warnings into errors.
2864 @end table
2865
2866 @node Debugging Options
2867 @section Options for Debugging Your Program or GCC
2868 @cindex options, debugging
2869 @cindex debugging information options
2870
2871 GCC has various special options that are used for debugging
2872 either your program or GCC:
2873
2874 @table @gcctabopt
2875 @item -g
2876 @opindex g
2877 Produce debugging information in the operating system's native format
2878 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2879 information.
2880
2881 On most systems that use stabs format, @option{-g} enables use of extra
2882 debugging information that only GDB can use; this extra information
2883 makes debugging work better in GDB but will probably make other debuggers
2884 crash or
2885 refuse to read the program.  If you want to control for certain whether
2886 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2887 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2888 or @option{-gvms} (see below).
2889
2890 Unlike most other C compilers, GCC allows you to use @option{-g} with
2891 @option{-O}.  The shortcuts taken by optimized code may occasionally
2892 produce surprising results: some variables you declared may not exist
2893 at all; flow of control may briefly move where you did not expect it;
2894 some statements may not be executed because they compute constant
2895 results or their values were already at hand; some statements may
2896 execute in different places because they were moved out of loops.
2897
2898 Nevertheless it proves possible to debug optimized output.  This makes
2899 it reasonable to use the optimizer for programs that might have bugs.
2900
2901 The following options are useful when GCC is generated with the
2902 capability for more than one debugging format.
2903
2904 @item -ggdb
2905 @opindex ggdb
2906 Produce debugging information for use by GDB@.  This means to use the
2907 most expressive format available (DWARF 2, stabs, or the native format
2908 if neither of those are supported), including GDB extensions if at all
2909 possible.
2910
2911 @item -gstabs
2912 @opindex gstabs
2913 Produce debugging information in stabs format (if that is supported),
2914 without GDB extensions.  This is the format used by DBX on most BSD
2915 systems.  On MIPS, Alpha and System V Release 4 systems this option
2916 produces stabs debugging output which is not understood by DBX or SDB@.
2917 On System V Release 4 systems this option requires the GNU assembler.
2918
2919 @item -feliminate-unused-debug-symbols
2920 @opindex feliminate-unused-debug-symbols
2921 Produce debugging information in stabs format (if that is supported),
2922 for only symbols that are actually used.
2923
2924 @item -gstabs+
2925 @opindex gstabs+
2926 Produce debugging information in stabs format (if that is supported),
2927 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2928 use of these extensions is likely to make other debuggers crash or
2929 refuse to read the program.
2930
2931 @item -gcoff
2932 @opindex gcoff
2933 Produce debugging information in COFF format (if that is supported).
2934 This is the format used by SDB on most System V systems prior to
2935 System V Release 4.
2936
2937 @item -gxcoff
2938 @opindex gxcoff
2939 Produce debugging information in XCOFF format (if that is supported).
2940 This is the format used by the DBX debugger on IBM RS/6000 systems.
2941
2942 @item -gxcoff+
2943 @opindex gxcoff+
2944 Produce debugging information in XCOFF format (if that is supported),
2945 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2946 use of these extensions is likely to make other debuggers crash or
2947 refuse to read the program, and may cause assemblers other than the GNU
2948 assembler (GAS) to fail with an error.
2949
2950 @item -gdwarf
2951 @opindex gdwarf
2952 Produce debugging information in DWARF version 1 format (if that is
2953 supported).  This is the format used by SDB on most System V Release 4
2954 systems.
2955
2956 This option is deprecated.
2957
2958 @item -gdwarf+
2959 @opindex gdwarf+
2960 Produce debugging information in DWARF version 1 format (if that is
2961 supported), using GNU extensions understood only by the GNU debugger
2962 (GDB)@.  The use of these extensions is likely to make other debuggers
2963 crash or refuse to read the program.
2964
2965 This option is deprecated.
2966
2967 @item -gdwarf-2
2968 @opindex gdwarf-2
2969 Produce debugging information in DWARF version 2 format (if that is
2970 supported).  This is the format used by DBX on IRIX 6.
2971
2972 @item -gvms
2973 @opindex gvms
2974 Produce debugging information in VMS debug format (if that is
2975 supported).  This is the format used by DEBUG on VMS systems.
2976
2977 @item -g@var{level}
2978 @itemx -ggdb@var{level}
2979 @itemx -gstabs@var{level}
2980 @itemx -gcoff@var{level}
2981 @itemx -gxcoff@var{level}
2982 @itemx -gvms@var{level}
2983 Request debugging information and also use @var{level} to specify how
2984 much information.  The default level is 2.
2985
2986 Level 1 produces minimal information, enough for making backtraces in
2987 parts of the program that you don't plan to debug.  This includes
2988 descriptions of functions and external variables, but no information
2989 about local variables and no line numbers.
2990
2991 Level 3 includes extra information, such as all the macro definitions
2992 present in the program.  Some debuggers support macro expansion when
2993 you use @option{-g3}.
2994
2995 Note that in order to avoid confusion between DWARF1 debug level 2,
2996 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2997 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2998 option to change the debug level for DWARF1 or DWARF2.
2999
3000 @item -feliminate-dwarf2-dups
3001 @opindex feliminate-dwarf2-dups
3002 Compress DWARF2 debugging information by eliminating duplicated
3003 information about each symbol.  This option only makes sense when
3004 generating DWARF2 debugging information with @option{-gdwarf-2}.
3005
3006 @cindex @command{prof}
3007 @item -p
3008 @opindex p
3009 Generate extra code to write profile information suitable for the
3010 analysis program @command{prof}.  You must use this option when compiling
3011 the source files you want data about, and you must also use it when
3012 linking.
3013
3014 @cindex @command{gprof}
3015 @item -pg
3016 @opindex pg
3017 Generate extra code to write profile information suitable for the
3018 analysis program @command{gprof}.  You must use this option when compiling
3019 the source files you want data about, and you must also use it when
3020 linking.
3021
3022 @item -Q
3023 @opindex Q
3024 Makes the compiler print out each function name as it is compiled, and
3025 print some statistics about each pass when it finishes.
3026
3027 @item -ftime-report
3028 @opindex ftime-report
3029 Makes the compiler print some statistics about the time consumed by each
3030 pass when it finishes.
3031
3032 @item -fmem-report
3033 @opindex fmem-report
3034 Makes the compiler print some statistics about permanent memory
3035 allocation when it finishes.
3036
3037 @item -fprofile-arcs
3038 @opindex fprofile-arcs
3039 Add code so that program flow @dfn{arcs} are instrumented.  During
3040 execution the program records how many times each branch and call is
3041 executed and how many times it is taken or returns.  When the compiled
3042 program exits it saves this data to a file called
3043 @file{@var{auxname}.da} for each source file. The data may be used for
3044 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3045 test coverage analysis (@option{-ftest-coverage}). Each object file's
3046 @var{auxname} is generated from the name of the output file, if
3047 explicitly specified and it is not the final executable, otherwise it is
3048 the basename of the source file. In both cases any suffix is removed
3049 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3050 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3051
3052 @itemize
3053
3054 @item
3055 Compile the source files with @option{-fprofile-arcs} plus optimization
3056 and code generation options. For test coverage analysis, use the
3057 additional @option{-ftest-coverage} option. You do not need to profile
3058 every source file in a program.
3059
3060 @item
3061 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3062 (the latter implies the former).
3063
3064 @item
3065 Run the program on a representative workload to generate the arc profile
3066 information. This may be repeated any number of times. You can run
3067 concurrent instances of your program, and provided that the file system
3068 supports locking, the data files will be correctly updated. Also
3069 @code{fork} calls are detected and correctly handled (double counting
3070 will not happen).
3071
3072 @item
3073 For profile-directed optimizations, compile the source files again with
3074 the same optimization and code generation options plus
3075 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3076 Control Optimization}).
3077
3078 @item
3079 For test coverage analysis, use @command{gcov} to produce human readable
3080 information from the @file{.bbg} and @file{.da} files. Refer to the
3081 @command{gcov} documentation for further information.
3082
3083 @end itemize
3084
3085 With @option{-fprofile-arcs}, for each function of your program GCC
3086 creates a program flow graph, then finds a spanning tree for the graph.
3087 Only arcs that are not on the spanning tree have to be instrumented: the
3088 compiler adds code to count the number of times that these arcs are
3089 executed.  When an arc is the only exit or only entrance to a block, the
3090 instrumentation code can be added to the block; otherwise, a new basic
3091 block must be created to hold the instrumentation code.
3092
3093 @need 2000
3094 @item -ftest-coverage
3095 @opindex ftest-coverage
3096 Produce a graph file that the @command{gcov} code-coverage utility
3097 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3098 show program coverage. Each source file's data file is called
3099 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3100 above for a description of @var{auxname} and instructions on how to
3101 generate test coverage data. Coverage data will match the source files
3102 more closely, if you do not optimize.
3103
3104 @item -d@var{letters}
3105 @opindex d
3106 Says to make debugging dumps during compilation at times specified by
3107 @var{letters}.  This is used for debugging the compiler.  The file names
3108 for most of the dumps are made by appending a pass number and a word to
3109 the @var{dumpname}. @var{dumpname} is generated from the name of the
3110 output file, if explicitly specified and it is not an executable,
3111 otherwise it is the basename of the source file. In both cases any
3112 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3113 Here are the possible letters for use in @var{letters}, and their
3114 meanings:
3115
3116 @table @samp
3117 @item A
3118 @opindex dA
3119 Annotate the assembler output with miscellaneous debugging information.
3120 @item b
3121 @opindex db
3122 Dump after computing branch probabilities, to @file{@var{file}.15.bp}.
3123 @item B
3124 @opindex dB
3125 Dump after block reordering, to @file{@var{file}.31.bbro}.
3126 @item c
3127 @opindex dc
3128 Dump after instruction combination, to the file @file{@var{file}.21.combine}.
3129 @item C
3130 @opindex dC
3131 Dump after the first if conversion, to the file @file{@var{file}.16.ce1}.
3132 Also dump after the second if conversion, to the file @file{@var{file}.22.ce2}.
3133 @item d
3134 @opindex dd
3135 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3136 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3137 @item D
3138 @opindex dD
3139 Dump all macro definitions, at the end of preprocessing, in addition to
3140 normal output.
3141 @item e
3142 @opindex de
3143 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3144 @file{@var{file}.07.ussa}.
3145 @item E
3146 @opindex dE
3147 Dump after the second if conversion, to @file{@var{file}.32.ce3}.
3148 @item f
3149 @opindex df
3150 Dump after control and data flow analysis, to @file{@var{file}.14.cfg}.
3151 Also dump after life analysis, to @file{@var{file}.20.life}.
3152 @item F
3153 @opindex dF
3154 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3155 @item g
3156 @opindex dg
3157 Dump after global register allocation, to @file{@var{file}.26.greg}.
3158 @item G
3159 @opindex dG
3160 Dump after GCSE, to @file{@var{file}.11.gcse}.
3161 Also dump after jump bypassing and control flow optimizations, to
3162 @file{@var{file}.13.bypass}.
3163 @item h
3164 @opindex dh
3165 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3166 @item i
3167 @opindex di
3168 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3169 @item j
3170 @opindex dj
3171 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3172 @item k
3173 @opindex dk
3174 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3175 @item l
3176 @opindex dl
3177 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3178 @item L
3179 @opindex dL
3180 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3181 @file{@var{file}.18.loop2}.
3182 @item M
3183 @opindex dM
3184 Dump after performing the machine dependent reorganization pass, to
3185 @file{@var{file}.36.mach}.
3186 @item n
3187 @opindex dn
3188 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3189 @item N
3190 @opindex dN
3191 Dump after the register move pass, to @file{@var{file}.23.regmove}.
3192 @item o
3193 @opindex do
3194 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3195 @item r
3196 @opindex dr
3197 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3198 @item R
3199 @opindex dR
3200 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3201 @item s
3202 @opindex ds
3203 Dump after CSE (including the jump optimization that sometimes follows
3204 CSE), to @file{@var{file}.09.cse}.
3205 @item S
3206 @opindex dS
3207 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3208 @item t
3209 @opindex dt
3210 Dump after the second CSE pass (including the jump optimization that
3211 sometimes follows CSE), to @file{@var{file}.19.cse2}.
3212 @item T
3213 @opindex dT
3214 Dump after running tracer, to @file{@var{file}.17.tracer}.
3215 @item u
3216 @opindex du
3217 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3218 @item w
3219 @opindex dw
3220 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3221 @item W
3222 @opindex dW
3223 Dump after SSA conditional constant propagation, to
3224 @file{@var{file}.05.ssaccp}.
3225 @item X
3226 @opindex dX
3227 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3228 @item z
3229 @opindex dz
3230 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3231 @item a
3232 @opindex da
3233 Produce all the dumps listed above.
3234 @item H
3235 @opindex dH
3236 Produce a core dump whenever an error occurs.
3237 @item m
3238 @opindex dm
3239 Print statistics on memory usage, at the end of the run, to
3240 standard error.
3241 @item p
3242 @opindex dp
3243 Annotate the assembler output with a comment indicating which
3244 pattern and alternative was used.  The length of each instruction is
3245 also printed.
3246 @item P
3247 @opindex dP
3248 Dump the RTL in the assembler output as a comment before each instruction.
3249 Also turns on @option{-dp} annotation.
3250 @item v
3251 @opindex dv
3252 For each of the other indicated dump files (except for
3253 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3254 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3255 @item x
3256 @opindex dx
3257 Just generate RTL for a function instead of compiling it.  Usually used
3258 with @samp{r}.
3259 @item y
3260 @opindex dy
3261 Dump debugging information during parsing, to standard error.
3262 @end table
3263
3264 @item -fdump-unnumbered
3265 @opindex fdump-unnumbered
3266 When doing debugging dumps (see @option{-d} option above), suppress instruction
3267 numbers and line number note output.  This makes it more feasible to
3268 use diff on debugging dumps for compiler invocations with different
3269 options, in particular with and without @option{-g}.
3270
3271 @item -fdump-translation-unit @r{(C and C++ only)}
3272 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3273 @opindex fdump-translation-unit
3274 Dump a representation of the tree structure for the entire translation
3275 unit to a file.  The file name is made by appending @file{.tu} to the
3276 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3277 controls the details of the dump as described for the
3278 @option{-fdump-tree} options.
3279
3280 @item -fdump-class-hierarchy @r{(C++ only)}
3281 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3282 @opindex fdump-class-hierarchy
3283 Dump a representation of each class's hierarchy and virtual function
3284 table layout to a file.  The file name is made by appending @file{.class}
3285 to the source file name.  If the @samp{-@var{options}} form is used,
3286 @var{options} controls the details of the dump as described for the
3287 @option{-fdump-tree} options.
3288
3289 @item -fdump-tree-@var{switch} @r{(C++ only)}
3290 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3291 @opindex fdump-tree
3292 Control the dumping at various stages of processing the intermediate
3293 language tree to a file.  The file name is generated by appending a switch
3294 specific suffix to the source file name.  If the @samp{-@var{options}}
3295 form is used, @var{options} is a list of @samp{-} separated options that
3296 control the details of the dump. Not all options are applicable to all
3297 dumps, those which are not meaningful will be ignored. The following
3298 options are available
3299
3300 @table @samp
3301 @item address
3302 Print the address of each node.  Usually this is not meaningful as it
3303 changes according to the environment and source file. Its primary use
3304 is for tying up a dump file with a debug environment.
3305 @item slim
3306 Inhibit dumping of members of a scope or body of a function merely
3307 because that scope has been reached. Only dump such items when they
3308 are directly reachable by some other path.
3309 @item all
3310 Turn on all options.
3311 @end table
3312
3313 The following tree dumps are possible:
3314 @table @samp
3315 @item original
3316 Dump before any tree based optimization, to @file{@var{file}.original}.
3317 @item optimized
3318 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3319 @item inlined
3320 Dump after function inlining, to @file{@var{file}.inlined}.
3321 @end table
3322
3323 @item -frandom-seed=@var{string}
3324 @opindex frandom-string
3325 This option provides a seed that GCC uses when it would otherwise use
3326 random numbers.  It is used to generate certain symbol names
3327 that have to be different in every compiled file. It is also used to
3328 place unique stamps in coverage data files and the object files that
3329 produce them. You can use the @option{-frandom-seed} option to produce
3330 reproducibly identical object files.
3331
3332 The @var{string} should be different for every file you compile.
3333
3334 @item -fsched-verbose=@var{n}
3335 @opindex fsched-verbose
3336 On targets that use instruction scheduling, this option controls the
3337 amount of debugging output the scheduler prints.  This information is
3338 written to standard error, unless @option{-dS} or @option{-dR} is
3339 specified, in which case it is output to the usual dump
3340 listing file, @file{.sched} or @file{.sched2} respectively.  However
3341 for @var{n} greater than nine, the output is always printed to standard
3342 error.
3343
3344 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3345 same information as @option{-dRS}.  For @var{n} greater than one, it
3346 also output basic block probabilities, detailed ready list information
3347 and unit/insn info.  For @var{n} greater than two, it includes RTL
3348 at abort point, control-flow and regions info.  And for @var{n} over
3349 four, @option{-fsched-verbose} also includes dependence info.
3350
3351 @item -save-temps
3352 @opindex save-temps
3353 Store the usual ``temporary'' intermediate files permanently; place them
3354 in the current directory and name them based on the source file.  Thus,
3355 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3356 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3357 preprocessed @file{foo.i} output file even though the compiler now
3358 normally uses an integrated preprocessor.
3359
3360 @item -time
3361 @opindex time
3362 Report the CPU time taken by each subprocess in the compilation
3363 sequence.  For C source files, this is the compiler proper and assembler
3364 (plus the linker if linking is done).  The output looks like this:
3365
3366 @smallexample
3367 # cc1 0.12 0.01
3368 # as 0.00 0.01
3369 @end smallexample
3370
3371 The first number on each line is the ``user time,'' that is time spent
3372 executing the program itself.  The second number is ``system time,''
3373 time spent executing operating system routines on behalf of the program.
3374 Both numbers are in seconds.
3375
3376 @item -print-file-name=@var{library}
3377 @opindex print-file-name
3378 Print the full absolute name of the library file @var{library} that
3379 would be used when linking---and don't do anything else.  With this
3380 option, GCC does not compile or link anything; it just prints the
3381 file name.
3382
3383 @item -print-multi-directory
3384 @opindex print-multi-directory
3385 Print the directory name corresponding to the multilib selected by any
3386 other switches present in the command line.  This directory is supposed
3387 to exist in @env{GCC_EXEC_PREFIX}.
3388
3389 @item -print-multi-lib
3390 @opindex print-multi-lib
3391 Print the mapping from multilib directory names to compiler switches
3392 that enable them.  The directory name is separated from the switches by
3393 @samp{;}, and each switch starts with an @samp{@@} instead of the
3394 @samp{-}, without spaces between multiple switches.  This is supposed to
3395 ease shell-processing.
3396
3397 @item -print-prog-name=@var{program}
3398 @opindex print-prog-name
3399 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3400
3401 @item -print-libgcc-file-name
3402 @opindex print-libgcc-file-name
3403 Same as @option{-print-file-name=libgcc.a}.
3404
3405 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3406 but you do want to link with @file{libgcc.a}.  You can do
3407
3408 @example
3409 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3410 @end example
3411
3412 @item -print-search-dirs
3413 @opindex print-search-dirs
3414 Print the name of the configured installation directory and a list of
3415 program and library directories gcc will search---and don't do anything else.
3416
3417 This is useful when gcc prints the error message
3418 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3419 To resolve this you either need to put @file{cpp0} and the other compiler
3420 components where gcc expects to find them, or you can set the environment
3421 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3422 Don't forget the trailing '/'.
3423 @xref{Environment Variables}.
3424
3425 @item -dumpmachine
3426 @opindex dumpmachine
3427 Print the compiler's target machine (for example,
3428 @samp{i686-pc-linux-gnu})---and don't do anything else.
3429
3430 @item -dumpversion
3431 @opindex dumpversion
3432 Print the compiler version (for example, @samp{3.0})---and don't do
3433 anything else.
3434
3435 @item -dumpspecs
3436 @opindex dumpspecs
3437 Print the compiler's built-in specs---and don't do anything else.  (This
3438 is used when GCC itself is being built.)  @xref{Spec Files}.
3439
3440 @item -feliminate-unused-debug-types
3441 @opindex feliminate-unused-debug-types
3442 Normally, when producing DWARF2 output, GCC will emit debugging
3443 information for all types declared in a compilation
3444 unit, regardless of whether or not they are actually used
3445 in that compilation unit.  Sometimes this is useful, such as
3446 if, in the debugger, you want to cast a value to a type that is
3447 not actually used in your program (but is declared).  More often,
3448 however, this results in a significant amount of wasted space.
3449 With this option, GCC will avoid producing debug symbol output
3450 for types that are nowhere used in the source file being compiled.
3451 @end table
3452
3453 @node Optimize Options
3454 @section Options That Control Optimization
3455 @cindex optimize options
3456 @cindex options, optimization
3457
3458 These options control various sorts of optimizations.
3459
3460 Without any optimization option, the compiler's goal is to reduce the
3461 cost of compilation and to make debugging produce the expected
3462 results.  Statements are independent: if you stop the program with a
3463 breakpoint between statements, you can then assign a new value to any
3464 variable or change the program counter to any other statement in the
3465 function and get exactly the results you would expect from the source
3466 code.
3467
3468 Turning on optimization flags makes the compiler attempt to improve
3469 the performance and/or code size at the expense of compilation time
3470 and possibly the ability to debug the program.
3471
3472 Not all optimizations are controlled directly by a flag.  Only
3473 optimizations that have a flag are listed.
3474
3475 @table @gcctabopt
3476 @item -O
3477 @itemx -O1
3478 @opindex O
3479 @opindex O1
3480 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3481 more memory for a large function.
3482
3483 With @option{-O}, the compiler tries to reduce code size and execution
3484 time, without performing any optimizations that take a great deal of
3485 compilation time.
3486
3487 @option{-O} turns on the following optimization flags: 
3488 @gccoptlist{-fdefer-pop @gol
3489 -fmerge-constants @gol
3490 -fthread-jumps @gol
3491 -floop-optimize @gol
3492 -fcrossjumping @gol
3493 -fif-conversion @gol
3494 -fif-conversion2 @gol
3495 -fdelayed-branch @gol
3496 -fguess-branch-probability @gol
3497 -fcprop-registers}
3498
3499 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3500 where doing so does not interfere with debugging.
3501
3502 @item -O2
3503 @opindex O2
3504 Optimize even more.  GCC performs nearly all supported optimizations
3505 that do not involve a space-speed tradeoff.  The compiler does not
3506 perform loop unrolling or function inlining when you specify @option{-O2}.
3507 As compared to @option{-O}, this option increases both compilation time
3508 and the performance of the generated code.
3509
3510 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3511 also turns on the following optimization flags:
3512 @gccoptlist{-fforce-mem @gol
3513 -foptimize-sibling-calls @gol
3514 -fstrength-reduce @gol
3515 -fcse-follow-jumps  -fcse-skip-blocks @gol
3516 -frerun-cse-after-loop  -frerun-loop-opt @gol
3517 -fgcse   -fgcse-lm   -fgcse-sm @gol
3518 -fdelete-null-pointer-checks @gol
3519 -fexpensive-optimizations @gol
3520 -fregmove @gol
3521 -fschedule-insns  -fschedule-insns2 @gol
3522 -fsched-interblock  -fsched-spec @gol
3523 -fcaller-saves @gol
3524 -fpeephole2 @gol
3525 -freorder-blocks  -freorder-functions @gol
3526 -fstrict-aliasing @gol
3527 -falign-functions  -falign-jumps @gol
3528 -falign-loops  -falign-labels}
3529
3530 Please note the warning under @option{-fgcse} about
3531 invoking @option{-O2} on programs that use computed gotos.
3532
3533 @item -O3
3534 @opindex O3
3535 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3536 @option{-O2} and also turns on the @option{-finline-functions},
3537 @option{-funit-at-a-time} and @option{-frename-registers} options.
3538
3539 @item -O0
3540 @opindex O0
3541 Do not optimize.  This is the default.
3542
3543 @item -Os
3544 @opindex Os
3545 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3546 do not typically increase code size.  It also performs further
3547 optimizations designed to reduce code size.
3548
3549 @option{-Os} disables the following optimization flags:
3550 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3551 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3552
3553 If you use multiple @option{-O} options, with or without level numbers,
3554 the last such option is the one that is effective.
3555 @end table
3556
3557 Options of the form @option{-f@var{flag}} specify machine-independent
3558 flags.  Most flags have both positive and negative forms; the negative
3559 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3560 below, only one of the forms is listed---the one you typically will
3561 use.  You can figure out the other form by either removing @samp{no-}
3562 or adding it.
3563
3564 The following options control specific optimizations.  They are either
3565 activated by @option{-O} options or are related to ones that are.  You
3566 can use the following flags in the rare cases when ``fine-tuning'' of
3567 optimizations to be performed is desired.
3568
3569 @table @gcctabopt
3570 @item -fno-default-inline
3571 @opindex fno-default-inline
3572 Do not make member functions inline by default merely because they are
3573 defined inside the class scope (C++ only).  Otherwise, when you specify
3574 @w{@option{-O}}, member functions defined inside class scope are compiled
3575 inline by default; i.e., you don't need to add @samp{inline} in front of
3576 the member function name.
3577
3578 @item -fno-defer-pop
3579 @opindex fno-defer-pop
3580 Always pop the arguments to each function call as soon as that function
3581 returns.  For machines which must pop arguments after a function call,
3582 the compiler normally lets arguments accumulate on the stack for several
3583 function calls and pops them all at once.
3584
3585 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3586
3587 @item -fforce-mem
3588 @opindex fforce-mem
3589 Force memory operands to be copied into registers before doing
3590 arithmetic on them.  This produces better code by making all memory
3591 references potential common subexpressions.  When they are not common
3592 subexpressions, instruction combination should eliminate the separate
3593 register-load.
3594
3595 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3596
3597 @item -fforce-addr
3598 @opindex fforce-addr
3599 Force memory address constants to be copied into registers before
3600 doing arithmetic on them.  This may produce better code just as
3601 @option{-fforce-mem} may.
3602
3603 @item -fomit-frame-pointer
3604 @opindex fomit-frame-pointer
3605 Don't keep the frame pointer in a register for functions that
3606 don't need one.  This avoids the instructions to save, set up and
3607 restore frame pointers; it also makes an extra register available
3608 in many functions.  @strong{It also makes debugging impossible on
3609 some machines.}
3610
3611 On some machines, such as the VAX, this flag has no effect, because
3612 the standard calling sequence automatically handles the frame pointer
3613 and nothing is saved by pretending it doesn't exist.  The
3614 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3615 whether a target machine supports this flag.  @xref{Registers,,Register
3616 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3617
3618 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3619
3620 @item -foptimize-sibling-calls
3621 @opindex foptimize-sibling-calls
3622 Optimize sibling and tail recursive calls.
3623
3624 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3625
3626 @item -fno-inline
3627 @opindex fno-inline
3628 Don't pay attention to the @code{inline} keyword.  Normally this option
3629 is used to keep the compiler from expanding any functions inline.
3630 Note that if you are not optimizing, no functions can be expanded inline.
3631
3632 @item -finline-functions
3633 @opindex finline-functions
3634 Integrate all simple functions into their callers.  The compiler
3635 heuristically decides which functions are simple enough to be worth
3636 integrating in this way.
3637
3638 If all calls to a given function are integrated, and the function is
3639 declared @code{static}, then the function is normally not output as
3640 assembler code in its own right.
3641
3642 Enabled at level @option{-O3}.
3643
3644 @item -finline-limit=@var{n}
3645 @opindex finline-limit
3646 By default, gcc limits the size of functions that can be inlined.  This flag
3647 allows the control of this limit for functions that are explicitly marked as
3648 inline (i.e., marked with the inline keyword or defined within the class
3649 definition in c++).  @var{n} is the size of functions that can be inlined in
3650 number of pseudo instructions (not counting parameter handling).  The default
3651 value of @var{n} is 600.
3652 Increasing this value can result in more inlined code at
3653 the cost of compilation time and memory consumption.  Decreasing usually makes
3654 the compilation faster and less code will be inlined (which presumably
3655 means slower programs).  This option is particularly useful for programs that
3656 use inlining heavily such as those based on recursive templates with C++.
3657
3658 Inlining is actually controlled by a number of parameters, which may be
3659 specified individually by using @option{--param @var{name}=@var{value}}.
3660 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3661 as follows:
3662
3663 @table @gcctabopt
3664  @item max-inline-insns
3665   is set to @var{n}.
3666  @item max-inline-insns-single
3667   is set to @var{n}/2.
3668  @item max-inline-insns-auto
3669   is set to @var{n}/2.
3670  @item min-inline-insns
3671   is set to 130 or @var{n}/4, whichever is smaller.
3672  @item max-inline-insns-rtl
3673   is set to @var{n}.
3674 @end table
3675
3676 Using @option{-finline-limit=600} thus results in the default settings
3677 for these parameters.  See below for a documentation of the individual
3678 parameters controlling inlining.
3679
3680 @emph{Note:} pseudo instruction represents, in this particular context, an
3681 abstract measurement of function's size.  In no way, it represents a count
3682 of assembly instructions and as such its exact meaning might change from one
3683 release to an another.
3684
3685 @item -fkeep-inline-functions
3686 @opindex fkeep-inline-functions
3687 Even if all calls to a given function are integrated, and the function
3688 is declared @code{static}, nevertheless output a separate run-time
3689 callable version of the function.  This switch does not affect
3690 @code{extern inline} functions.
3691
3692 @item -fkeep-static-consts
3693 @opindex fkeep-static-consts
3694 Emit variables declared @code{static const} when optimization isn't turned
3695 on, even if the variables aren't referenced.
3696
3697 GCC enables this option by default.  If you want to force the compiler to
3698 check if the variable was referenced, regardless of whether or not
3699 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3700
3701 @item -fmerge-constants
3702 Attempt to merge identical constants (string constants and floating point
3703 constants) across compilation units.
3704
3705 This option is the default for optimized compilation if the assembler and
3706 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3707 behavior.
3708
3709 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3710
3711 @item -fmerge-all-constants
3712 Attempt to merge identical constants and identical variables.
3713
3714 This option implies @option{-fmerge-constants}.  In addition to
3715 @option{-fmerge-constants} this considers e.g. even constant initialized
3716 arrays or initialized constant variables with integral or floating point
3717 types.  Languages like C or C++ require each non-automatic variable to
3718 have distinct location, so using this option will result in non-conforming
3719 behavior.
3720
3721 @item -fnew-ra
3722 @opindex fnew-ra
3723 Use a graph coloring register allocator.  Currently this option is meant
3724 for testing, so we are interested to hear about miscompilations with
3725 @option{-fnew-ra}.
3726
3727 @item -fno-branch-count-reg
3728 @opindex fno-branch-count-reg
3729 Do not use ``decrement and branch'' instructions on a count register,
3730 but instead generate a sequence of instructions that decrement a
3731 register, compare it against zero, then branch based upon the result.
3732 This option is only meaningful on architectures that support such
3733 instructions, which include x86, PowerPC, IA-64 and S/390.
3734
3735 The default is @option{-fbranch-count-reg}, enabled when
3736 @option{-fstrength-reduce} is enabled.
3737
3738 @item -fno-function-cse
3739 @opindex fno-function-cse
3740 Do not put function addresses in registers; make each instruction that
3741 calls a constant function contain the function's address explicitly.
3742
3743 This option results in less efficient code, but some strange hacks
3744 that alter the assembler output may be confused by the optimizations
3745 performed when this option is not used.
3746
3747 The default is @option{-ffunction-cse}
3748
3749 @item -fno-zero-initialized-in-bss
3750 @opindex fno-zero-initialized-in-bss
3751 If the target supports a BSS section, GCC by default puts variables that
3752 are initialized to zero into BSS@.  This can save space in the resulting
3753 code.
3754
3755 This option turns off this behavior because some programs explicitly
3756 rely on variables going to the data section.  E.g., so that the
3757 resulting executable can find the beginning of that section and/or make
3758 assumptions based on that.
3759
3760 The default is @option{-fzero-initialized-in-bss}.
3761
3762 @item -fstrength-reduce
3763 @opindex fstrength-reduce
3764 Perform the optimizations of loop strength reduction and
3765 elimination of iteration variables.
3766
3767 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3768
3769 @item -fthread-jumps
3770 @opindex fthread-jumps
3771 Perform optimizations where we check to see if a jump branches to a
3772 location where another comparison subsumed by the first is found.  If
3773 so, the first branch is redirected to either the destination of the
3774 second branch or a point immediately following it, depending on whether
3775 the condition is known to be true or false.
3776
3777 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3778
3779 @item -fcse-follow-jumps
3780 @opindex fcse-follow-jumps
3781 In common subexpression elimination, scan through jump instructions
3782 when the target of the jump is not reached by any other path.  For
3783 example, when CSE encounters an @code{if} statement with an
3784 @code{else} clause, CSE will follow the jump when the condition
3785 tested is false.
3786
3787 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3788
3789 @item -fcse-skip-blocks
3790 @opindex fcse-skip-blocks
3791 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3792 follow jumps which conditionally skip over blocks.  When CSE
3793 encounters a simple @code{if} statement with no else clause,
3794 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3795 body of the @code{if}.
3796
3797 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3798
3799 @item -frerun-cse-after-loop
3800 @opindex frerun-cse-after-loop
3801 Re-run common subexpression elimination after loop optimizations has been
3802 performed.
3803
3804 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3805
3806 @item -frerun-loop-opt
3807 @opindex frerun-loop-opt
3808 Run the loop optimizer twice.
3809
3810 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3811
3812 @item -fgcse
3813 @opindex fgcse
3814 Perform a global common subexpression elimination pass.
3815 This pass also performs global constant and copy propagation.
3816
3817 @emph{Note:} When compiling a program using computed gotos, a GCC
3818 extension, you may get better runtime performance if you disable
3819 the global common subexpression elimination pass by adding
3820 @option{-fno-gcse} to the command line.
3821
3822 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3823
3824 @item -fgcse-lm
3825 @opindex fgcse-lm
3826 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3827 attempt to move loads which are only killed by stores into themselves.  This
3828 allows a loop containing a load/store sequence to be changed to a load outside
3829 the loop, and a copy/store within the loop.
3830
3831 Enabled by default when gcse is enabled.
3832
3833 @item -fgcse-sm
3834 @opindex fgcse-sm
3835 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3836 subexpression elimination.  This pass will attempt to move stores out of loops.
3837 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3838 can be changed to a load before the loop and a store after the loop.
3839
3840 Enabled by default when gcse is enabled.
3841
3842 @item -floop-optimize
3843 @opindex floop-optimize
3844 Perform loop optimizations: move constant expressions out of loops, simplify
3845 exit test conditions and optionally do strength-reduction and loop unrolling as
3846 well.
3847
3848 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3849
3850 @item -fcrossjumping
3851 @opindex crossjumping
3852 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3853 resulting code may or may not perform better than without cross-jumping.
3854
3855 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3856
3857 @item -fif-conversion
3858 @opindex if-conversion
3859 Attempt to transform conditional jumps into branch-less equivalents.  This
3860 include use of conditional moves, min, max, set flags and abs instructions, and
3861 some tricks doable by standard arithmetics.  The use of conditional execution
3862 on chips where it is available is controlled by @code{if-conversion2}.
3863
3864 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3865
3866 @item -fif-conversion2
3867 @opindex if-conversion2
3868 Use conditional execution (where available) to transform conditional jumps into
3869 branch-less equivalents.
3870
3871 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3872
3873 @item -fdelete-null-pointer-checks
3874 @opindex fdelete-null-pointer-checks
3875 Use global dataflow analysis to identify and eliminate useless checks
3876 for null pointers.  The compiler assumes that dereferencing a null
3877 pointer would have halted the program.  If a pointer is checked after
3878 it has already been dereferenced, it cannot be null.
3879
3880 In some environments, this assumption is not true, and programs can
3881 safely dereference null pointers.  Use
3882 @option{-fno-delete-null-pointer-checks} to disable this optimization
3883 for programs which depend on that behavior.
3884
3885 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3886
3887 @item -fexpensive-optimizations
3888 @opindex fexpensive-optimizations
3889 Perform a number of minor optimizations that are relatively expensive.
3890
3891 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3892
3893 @item -foptimize-register-move
3894 @itemx -fregmove
3895 @opindex foptimize-register-move
3896 @opindex fregmove
3897 Attempt to reassign register numbers in move instructions and as
3898 operands of other simple instructions in order to maximize the amount of
3899 register tying.  This is especially helpful on machines with two-operand
3900 instructions.
3901
3902 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3903 optimization.
3904
3905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3906
3907 @item -fdelayed-branch
3908 @opindex fdelayed-branch
3909 If supported for the target machine, attempt to reorder instructions
3910 to exploit instruction slots available after delayed branch
3911 instructions.
3912
3913 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3914
3915 @item -fschedule-insns
3916 @opindex fschedule-insns
3917 If supported for the target machine, attempt to reorder instructions to
3918 eliminate execution stalls due to required data being unavailable.  This
3919 helps machines that have slow floating point or memory load instructions
3920 by allowing other instructions to be issued until the result of the load
3921 or floating point instruction is required.
3922
3923 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3924
3925 @item -fschedule-insns2
3926 @opindex fschedule-insns2
3927 Similar to @option{-fschedule-insns}, but requests an additional pass of
3928 instruction scheduling after register allocation has been done.  This is
3929 especially useful on machines with a relatively small number of
3930 registers and where memory load instructions take more than one cycle.
3931
3932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3933
3934 @item -fno-sched-interblock
3935 @opindex fno-sched-interblock
3936 Don't schedule instructions across basic blocks.  This is normally
3937 enabled by default when scheduling before register allocation, i.e.@:
3938 with @option{-fschedule-insns} or at @option{-O2} or higher.
3939
3940 @item -fno-sched-spec
3941 @opindex fno-sched-spec
3942 Don't allow speculative motion of non-load instructions.  This is normally
3943 enabled by default when scheduling before register allocation, i.e.@:
3944 with @option{-fschedule-insns} or at @option{-O2} or higher.
3945
3946 @item -fsched-spec-load
3947 @opindex fsched-spec-load
3948 Allow speculative motion of some load instructions.  This only makes
3949 sense when scheduling before register allocation, i.e.@: with
3950 @option{-fschedule-insns} or at @option{-O2} or higher.
3951
3952 @item -fsched-spec-load-dangerous
3953 @opindex fsched-spec-load-dangerous
3954 Allow speculative motion of more load instructions.  This only makes
3955 sense when scheduling before register allocation, i.e.@: with
3956 @option{-fschedule-insns} or at @option{-O2} or higher.
3957
3958 @item -fsched2-use-superblocks
3959 @opindex fsched2-use-superblocks
3960 When scheduling after register allocation, do use superblock scheduling
3961 algorithm.  Superblock scheduling allows motion across basic block boundaries
3962 resulting on faster schedules.  This option is experimental, as not all machine
3963 descriptions used by GCC model the CPU closely enough to avoid unreliable
3964 results from the algorithm. 
3965
3966 This only makes sense when scheduling after register allocation, i.e.@: with
3967 @option{-fschedule-insns2} or at @option{-O2} or higher.
3968
3969 @item -fsched2-use-traces
3970 @opindex fsched2-use-traces
3971 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3972 allocation and additionally perform code duplication in order to increase the
3973 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3974 trace formation.
3975
3976 This mode should produce faster but significantly longer programs.  Also
3977 without @code{-fbranch-probabilities} the traces constructed may not match the
3978 reality and hurt the performance.  This only makes
3979 sense when scheduling after register allocation, i.e.@: with
3980 @option{-fschedule-insns2} or at @option{-O2} or higher.
3981
3982 @item -fcaller-saves
3983 @opindex fcaller-saves
3984 Enable values to be allocated in registers that will be clobbered by
3985 function calls, by emitting extra instructions to save and restore the
3986 registers around such calls.  Such allocation is done only when it
3987 seems to result in better code than would otherwise be produced.
3988
3989 This option is always enabled by default on certain machines, usually
3990 those which have no call-preserved registers to use instead.
3991
3992 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3993
3994 @item -fmove-all-movables
3995 @opindex fmove-all-movables
3996 Forces all invariant computations in loops to be moved
3997 outside the loop.
3998
3999 @item -freduce-all-givs
4000 @opindex freduce-all-givs
4001 Forces all general-induction variables in loops to be
4002 strength-reduced.
4003
4004 @emph{Note:} When compiling programs written in Fortran,
4005 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4006 by default when you use the optimizer.
4007
4008 These options may generate better or worse code; results are highly
4009 dependent on the structure of loops within the source code.
4010
4011 These two options are intended to be removed someday, once
4012 they have helped determine the efficacy of various
4013 approaches to improving loop optimizations.
4014
4015 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4016 know how use of these options affects
4017 the performance of your production code.
4018 We're very interested in code that runs @emph{slower}
4019 when these options are @emph{enabled}.
4020
4021 @item -fno-peephole
4022 @itemx -fno-peephole2
4023 @opindex fno-peephole
4024 @opindex fno-peephole2
4025 Disable any machine-specific peephole optimizations.  The difference
4026 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4027 are implemented in the compiler; some targets use one, some use the
4028 other, a few use both.
4029
4030 @option{-fpeephole} is enabled by default.
4031 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4032
4033 @item -fno-guess-branch-probability
4034 @opindex fno-guess-branch-probability
4035 Do not guess branch probabilities using a randomized model.
4036
4037 Sometimes gcc will opt to use a randomized model to guess branch
4038 probabilities, when none are available from either profiling feedback
4039 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4040 different runs of the compiler on the same program may produce different
4041 object code.
4042
4043 In a hard real-time system, people don't want different runs of the
4044 compiler to produce code that has different behavior; minimizing
4045 non-determinism is of paramount import.  This switch allows users to
4046 reduce non-determinism, possibly at the expense of inferior
4047 optimization.
4048
4049 The default is @option{-fguess-branch-probability} at levels
4050 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4051
4052 @item -freorder-blocks
4053 @opindex freorder-blocks
4054 Reorder basic blocks in the compiled function in order to reduce number of
4055 taken branches and improve code locality.
4056
4057 Enabled at levels @option{-O2}, @option{-O3}.
4058
4059 @item -freorder-functions
4060 @opindex freorder-functions
4061 Reorder basic blocks in the compiled function in order to reduce number of
4062 taken branches and improve code locality. This is implemented by using special
4063 subsections @code{text.hot} for most frequently executed functions and
4064 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4065 the linker so object file format must support named sections and linker must
4066 place them in a reasonable way.
4067
4068 Also profile feedback must be available in to make this option effective.  See
4069 @option{-fprofile-arcs} for details.
4070
4071 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4072
4073 @item -fstrict-aliasing
4074 @opindex fstrict-aliasing
4075 Allows the compiler to assume the strictest aliasing rules applicable to
4076 the language being compiled.  For C (and C++), this activates
4077 optimizations based on the type of expressions.  In particular, an
4078 object of one type is assumed never to reside at the same address as an
4079 object of a different type, unless the types are almost the same.  For
4080 example, an @code{unsigned int} can alias an @code{int}, but not a
4081 @code{void*} or a @code{double}.  A character type may alias any other
4082 type.
4083
4084 Pay special attention to code like this:
4085 @example
4086 union a_union @{
4087   int i;
4088   double d;
4089 @};
4090
4091 int f() @{
4092   a_union t;
4093   t.d = 3.0;
4094   return t.i;
4095 @}
4096 @end example
4097 The practice of reading from a different union member than the one most
4098 recently written to (called ``type-punning'') is common.  Even with
4099 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4100 is accessed through the union type.  So, the code above will work as
4101 expected.  However, this code might not:
4102 @example
4103 int f() @{
4104   a_union t;
4105   int* ip;
4106   t.d = 3.0;
4107   ip = &t.i;
4108   return *ip;
4109 @}
4110 @end example
4111
4112 Every language that wishes to perform language-specific alias analysis
4113 should define a function that computes, given an @code{tree}
4114 node, an alias set for the node.  Nodes in different alias sets are not
4115 allowed to alias.  For an example, see the C front-end function
4116 @code{c_get_alias_set}.
4117
4118 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4119
4120 @item -falign-functions
4121 @itemx -falign-functions=@var{n}
4122 @opindex falign-functions
4123 Align the start of functions to the next power-of-two greater than
4124 @var{n}, skipping up to @var{n} bytes.  For instance,
4125 @option{-falign-functions=32} aligns functions to the next 32-byte
4126 boundary, but @option{-falign-functions=24} would align to the next
4127 32-byte boundary only if this can be done by skipping 23 bytes or less.
4128
4129 @option{-fno-align-functions} and @option{-falign-functions=1} are
4130 equivalent and mean that functions will not be aligned.
4131
4132 Some assemblers only support this flag when @var{n} is a power of two;
4133 in that case, it is rounded up.
4134
4135 If @var{n} is not specified or is zero, use a machine-dependent default.
4136
4137 Enabled at levels @option{-O2}, @option{-O3}.
4138
4139 @item -falign-labels
4140 @itemx -falign-labels=@var{n}
4141 @opindex falign-labels
4142 Align all branch targets to a power-of-two boundary, skipping up to
4143 @var{n} bytes like @option{-falign-functions}.  This option can easily
4144 make code slower, because it must insert dummy operations for when the
4145 branch target is reached in the usual flow of the code.
4146
4147 @option{-fno-align-labels} and @option{-falign-labels=1} are
4148 equivalent and mean that labels will not be aligned.
4149
4150 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4151 are greater than this value, then their values are used instead.
4152
4153 If @var{n} is not specified or is zero, use a machine-dependent default
4154 which is very likely to be @samp{1}, meaning no alignment.
4155
4156 Enabled at levels @option{-O2}, @option{-O3}.
4157
4158 @item -falign-loops
4159 @itemx -falign-loops=@var{n}
4160 @opindex falign-loops
4161 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4162 like @option{-falign-functions}.  The hope is that the loop will be
4163 executed many times, which will make up for any execution of the dummy
4164 operations.
4165
4166 @option{-fno-align-loops} and @option{-falign-loops=1} are
4167 equivalent and mean that loops will not be aligned.
4168
4169 If @var{n} is not specified or is zero, use a machine-dependent default.
4170
4171 Enabled at levels @option{-O2}, @option{-O3}.
4172
4173 @item -falign-jumps
4174 @itemx -falign-jumps=@var{n}
4175 @opindex falign-jumps
4176 Align branch targets to a power-of-two boundary, for branch targets
4177 where the targets can only be reached by jumping, skipping up to @var{n}
4178 bytes like @option{-falign-functions}.  In this case, no dummy operations
4179 need be executed.
4180
4181 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4182 equivalent and mean that loops will not be aligned.
4183
4184 If @var{n} is not specified or is zero, use a machine-dependent default.
4185
4186 Enabled at levels @option{-O2}, @option{-O3}.
4187
4188 @item -frename-registers
4189 @opindex frename-registers
4190 Attempt to avoid false dependencies in scheduled code by making use
4191 of registers left over after register allocation.  This optimization
4192 will most benefit processors with lots of registers.  It can, however,
4193 make debugging impossible, since variables will no longer stay in
4194 a ``home register''.
4195
4196 Enabled at levels @option{-O3}.
4197
4198 @item -fno-cprop-registers
4199 @opindex fno-cprop-registers
4200 After register allocation and post-register allocation instruction splitting,
4201 we perform a copy-propagation pass to try to reduce scheduling dependencies
4202 and occasionally eliminate the copy.
4203
4204 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4205
4206 @end table
4207
4208 The following options control compiler behavior regarding floating
4209 point arithmetic.  These options trade off between speed and
4210 correctness.  All must be specifically enabled.
4211
4212 @table @gcctabopt
4213 @item -ffloat-store
4214 @opindex ffloat-store
4215 Do not store floating point variables in registers, and inhibit other
4216 options that might change whether a floating point value is taken from a
4217 register or memory.
4218
4219 @cindex floating point precision
4220 This option prevents undesirable excess precision on machines such as
4221 the 68000 where the floating registers (of the 68881) keep more
4222 precision than a @code{double} is supposed to have.  Similarly for the
4223 x86 architecture.  For most programs, the excess precision does only
4224 good, but a few programs rely on the precise definition of IEEE floating
4225 point.  Use @option{-ffloat-store} for such programs, after modifying
4226 them to store all pertinent intermediate computations into variables.
4227
4228 @item -ffast-math
4229 @opindex ffast-math
4230 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4231 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4232 @option{-fno-signaling-nans}.
4233
4234 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4235
4236 This option should never be turned on by any @option{-O} option since
4237 it can result in incorrect output for programs which depend on
4238 an exact implementation of IEEE or ISO rules/specifications for
4239 math functions.
4240
4241 @item -fno-math-errno
4242 @opindex fno-math-errno
4243 Do not set ERRNO after calling math functions that are executed
4244 with a single instruction, e.g., sqrt.  A program that relies on
4245 IEEE exceptions for math error handling may want to use this flag
4246 for speed while maintaining IEEE arithmetic compatibility.
4247
4248 This option should never be turned on by any @option{-O} option since
4249 it can result in incorrect output for programs which depend on
4250 an exact implementation of IEEE or ISO rules/specifications for
4251 math functions.
4252
4253 The default is @option{-fmath-errno}.
4254
4255 @item -funsafe-math-optimizations
4256 @opindex funsafe-math-optimizations
4257 Allow optimizations for floating-point arithmetic that (a) assume
4258 that arguments and results are valid and (b) may violate IEEE or
4259 ANSI standards.  When used at link-time, it may include libraries
4260 or startup files that change the default FPU control word or other
4261 similar optimizations.
4262
4263 This option should never be turned on by any @option{-O} option since
4264 it can result in incorrect output for programs which depend on
4265 an exact implementation of IEEE or ISO rules/specifications for
4266 math functions.
4267
4268 The default is @option{-fno-unsafe-math-optimizations}.
4269
4270 @item -ffinite-math-only
4271 @opindex ffinite-math-only
4272 Allow optimizations for floating-point arithmetic that assume
4273 that arguments and results are not NaNs or +-Infs.
4274
4275 This option should never be turned on by any @option{-O} option since
4276 it can result in incorrect output for programs which depend on
4277 an exact implementation of IEEE or ISO rules/specifications.
4278
4279 The default is @option{-fno-finite-math-only}.
4280
4281 @item -fno-trapping-math
4282 @opindex fno-trapping-math
4283 Compile code assuming that floating-point operations cannot generate
4284 user-visible traps.  These traps include division by zero, overflow,
4285 underflow, inexact result and invalid operation.  This option implies
4286 @option{-fno-signaling-nans}.  Setting this option may allow faster
4287 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4288
4289 This option should never be turned on by any @option{-O} option since
4290 it can result in incorrect output for programs which depend on
4291 an exact implementation of IEEE or ISO rules/specifications for
4292 math functions.
4293
4294 The default is @option{-ftrapping-math}.
4295
4296 @item -fsignaling-nans
4297 @opindex fsignaling-nans
4298 Compile code assuming that IEEE signaling NaNs may generate user-visible
4299 traps during floating-point operations.  Setting this option disables
4300 optimizations that may change the number of exceptions visible with
4301 signaling NaNs.  This option implies @option{-ftrapping-math}.
4302
4303 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4304 be defined.
4305
4306 The default is @option{-fno-signaling-nans}.
4307
4308 This option is experimental and does not currently guarantee to
4309 disable all GCC optimizations that affect signaling NaN behavior.
4310
4311 @item -fsingle-precision-constant
4312 @opindex fsingle-precision-constant
4313 Treat floating point constant as single precision constant instead of
4314 implicitly converting it to double precision constant.
4315
4316
4317 @end table
4318
4319 The following options control optimizations that may improve
4320 performance, but are not enabled by any @option{-O} options.  This
4321 section includes experimental options that may produce broken code.
4322
4323 @table @gcctabopt
4324 @item -fbranch-probabilities
4325 @opindex fbranch-probabilities
4326 After running a program compiled with @option{-fprofile-arcs}
4327 (@pxref{Debugging Options,, Options for Debugging Your Program or
4328 @command{gcc}}), you can compile it a second time using
4329 @option{-fbranch-probabilities}, to improve optimizations based on
4330 the number of times each branch was taken.  When the program
4331 compiled with @option{-fprofile-arcs} exits it saves arc execution
4332 counts to a file called @file{@var{sourcename}.da} for each source
4333 file  The information in this data file is very dependent on the
4334 structure of the generated code, so you must use the same source code
4335 and the same optimization options for both compilations.
4336
4337 With @option{-fbranch-probabilities}, GCC puts a 
4338 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4339 These can be used to improve optimization.  Currently, they are only
4340 used in one place: in @file{reorg.c}, instead of guessing which path a
4341 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4342 exactly determine which path is taken more often.
4343
4344 @item -fprofile-values
4345 @opindex fprofile-values
4346 If combined with @option{-fprofile-arcs}, it adds code so that some
4347 data about values of expressions in the program is gathered.
4348
4349 @item -fnew-ra
4350 @opindex fnew-ra
4351 Use a graph coloring register allocator.  Currently this option is meant
4352 for testing, so we are interested to hear about miscompilations with
4353 @option{-fnew-ra}.
4354
4355 @item -ftracer
4356 @opindex ftracer
4357 Perform tail duplication to enlarge superblock size. This transformation
4358 simplifies the control flow of the function allowing other optimizations to do
4359 better job.
4360
4361 @item -funit-at-a-time
4362 @opindex funit-at-a-time
4363 Parse the whole compilation unit before starting to produce code.  This allows some
4364 extra optimizations to take place but consumes more memory.
4365
4366 @item -funroll-loops
4367 @opindex funroll-loops
4368 Unroll loops whose number of iterations can be determined at compile time or
4369 upon entry to the loop.  @option{-funroll-loops} implies
4370 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4371 (i.e. complete removal of loops with small constant number of iterations).
4372 This option makes code larger, and may or may not make it run faster.
4373
4374 @item -funroll-all-loops
4375 @opindex funroll-all-loops
4376 Unroll all loops, even if their number of iterations is uncertain when
4377 the loop is entered.  This usually makes programs run more slowly.
4378 @option{-funroll-all-loops} implies the same options as
4379 @option{-funroll-loops}.
4380
4381 @item -fpeel-loops
4382 @opindex fpeel-loops
4383 Peels the loops for that there is enough information that they do not
4384 roll much (from profile feedback).  It also turns on complete loop peeling
4385 (i.e. complete removal of loops with small constant number of iterations).
4386
4387 @item -funswitch-loops
4388 @opindex funswitch-loops
4389 Move branches with loop invariant conditions out of the loop, with duplicates
4390 of the loop on both branches (modified according to result of the condition).
4391
4392 @item -fold-unroll-loops
4393 @opindex fold-unroll-loops
4394 Unroll loops whose number of iterations can be determined at compile
4395 time or upon entry to the loop, using the old loop unroller whose loop
4396 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4397 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4398 option makes code larger, and may or may not make it run faster.
4399
4400 @item -fold-unroll-all-loops
4401 @opindex fold-unroll-all-loops
4402 Unroll all loops, even if their number of iterations is uncertain when
4403 the loop is entered. This is done using the old loop unroller whose loop
4404 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4405 @option{-fold-unroll-all-loops} implies the same options as
4406 @option{-fold-unroll-loops}.
4407  
4408 @item -funswitch-loops
4409 @opindex funswitch-loops
4410 Move branches with loop invariant conditions out of the loop, with duplicates
4411 of the loop on both branches (modified according to result of the condition).
4412
4413 @item -funswitch-loops
4414 @opindex funswitch-loops
4415 Move branches with loop invariant conditions out of the loop, with duplicates
4416 of the loop on both branches (modified according to result of the condition).
4417
4418 @item -fprefetch-loop-arrays
4419 @opindex fprefetch-loop-arrays
4420 If supported by the target machine, generate instructions to prefetch
4421 memory to improve the performance of loops that access large arrays.
4422
4423 Disabled at level @option{-Os}.
4424
4425 @item -ffunction-sections
4426 @itemx -fdata-sections
4427 @opindex ffunction-sections
4428 @opindex fdata-sections
4429 Place each function or data item into its own section in the output
4430 file if the target supports arbitrary sections.  The name of the
4431 function or the name of the data item determines the section's name
4432 in the output file.
4433
4434 Use these options on systems where the linker can perform optimizations
4435 to improve locality of reference in the instruction space.  Most systems
4436 using the ELF object format and SPARC processors running Solaris 2 have
4437 linkers with such optimizations.  AIX may have these optimizations in
4438 the future.
4439
4440 Only use these options when there are significant benefits from doing
4441 so.  When you specify these options, the assembler and linker will
4442 create larger object and executable files and will also be slower.
4443 You will not be able to use @code{gprof} on all systems if you
4444 specify this option and you may have problems with debugging if
4445 you specify both this option and @option{-g}.
4446
4447 @item -fssa
4448 @opindex fssa
4449 Perform optimizations in static single assignment form.  Each function's
4450 flow graph is translated into SSA form, optimizations are performed, and
4451 the flow graph is translated back from SSA form.  Users should not
4452 specify this option, since it is not yet ready for production use.
4453
4454 @item -fssa-ccp
4455 @opindex fssa-ccp
4456 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4457 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4458
4459 @item -fssa-dce
4460 @opindex fssa-dce
4461 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4462 Like @option{-fssa}, this is an experimental feature.
4463
4464 @item -fbranch-target-load-optimize
4465 @opindex fbranch-target-load-optimize
4466 Perform branch target register load optimization before prologue / epilogue
4467 threading.
4468 The use of target registers can typically be exposed only during reload,
4469 thus hoisting loads out of loops and doing inter-block scheduling needs
4470 a separate optimization pass.
4471
4472 @item -fbranch-target-load-optimize2
4473 @opindex fbranch-target-load-optimize2
4474 Perform branch target register load optimization after prologue / epilogue
4475 threading.
4476
4477
4478
4479
4480 @item --param @var{name}=@var{value}
4481 @opindex param
4482 In some places, GCC uses various constants to control the amount of
4483 optimization that is done.  For example, GCC will not inline functions
4484 that contain more that a certain number of instructions.  You can
4485 control some of these constants on the command-line using the
4486 @option{--param} option.
4487
4488 In each case, the @var{value} is an integer.  The allowable choices for
4489 @var{name} are given in the following table:
4490
4491 @table @gcctabopt
4492 @item max-crossjump-edges
4493 The maximum number of incoming edges to consider for crossjumping.
4494 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4495 the number of edges incoming to each block.  Increasing values mean
4496 more aggressive optimization, making the compile time increase with
4497 probably small improvement in executable size.
4498
4499 @item max-delay-slot-insn-search
4500 The maximum number of instructions to consider when looking for an
4501 instruction to fill a delay slot.  If more than this arbitrary number of
4502 instructions is searched, the time savings from filling the delay slot
4503 will be minimal so stop searching.  Increasing values mean more
4504 aggressive optimization, making the compile time increase with probably
4505 small improvement in executable run time.
4506
4507 @item max-delay-slot-live-search
4508 When trying to fill delay slots, the maximum number of instructions to
4509 consider when searching for a block with valid live register
4510 information.  Increasing this arbitrarily chosen value means more
4511 aggressive optimization, increasing the compile time.  This parameter
4512 should be removed when the delay slot code is rewritten to maintain the
4513 control-flow graph.
4514
4515 @item max-gcse-memory
4516 The approximate maximum amount of memory that will be allocated in
4517 order to perform the global common subexpression elimination
4518 optimization.  If more memory than specified is required, the
4519 optimization will not be done.
4520
4521 @item max-gcse-passes
4522 The maximum number of passes of GCSE to run.
4523
4524 @item max-pending-list-length
4525 The maximum number of pending dependencies scheduling will allow
4526 before flushing the current state and starting over.  Large functions
4527 with few branches or calls can create excessively large lists which
4528 needlessly consume memory and resources.
4529
4530 @item max-inline-insns-single
4531 Several parameters control the tree inliner used in gcc.
4532 This number sets the maximum number of instructions (counted in gcc's
4533 internal representation) in a single function that the tree inliner 
4534 will consider for inlining.  This only affects functions declared
4535 inline and methods implemented in a class declaration (C++).
4536 The default value is 300.
4537
4538 @item max-inline-insns-auto
4539 When you use @option{-finline-functions} (included in @option{-O3}),
4540 a lot of functions that would otherwise not be considered for inlining
4541 by the compiler will be investigated.  To those functions, a different
4542 (more restrictive) limit compared to functions declared inline can
4543 be applied.
4544 The default value is 300.
4545
4546 @item max-inline-insns
4547 The tree inliner does decrease the allowable size for single functions 
4548 to be inlined after we already inlined the number of instructions
4549 given here by repeated inlining.  This number should be a factor of 
4550 two or more larger than the single function limit.
4551 Higher numbers result in better runtime performance, but incur higher
4552 compile-time resource (CPU time, memory) requirements and result in
4553 larger binaries.  Very high values are not advisable, as too large
4554 binaries may adversely affect runtime performance.
4555 The default value is 600.
4556
4557 @item max-inline-slope
4558 After exceeding the maximum number of inlined instructions by repeated
4559 inlining, a linear function is used to decrease the allowable size
4560 for single functions.  The slope of that function is the negative
4561 reciprocal of the number specified here.
4562 The default value is 32.
4563
4564 @item min-inline-insns
4565 The repeated inlining is throttled more and more by the linear function
4566 after exceeding the limit.  To avoid too much throttling, a minimum for
4567 this function is specified here to allow repeated inlining for very small
4568 functions even when a lot of repeated inlining already has been done.
4569 The default value is 130.
4570
4571 @item max-inline-insns-rtl
4572 For languages that use the RTL inliner (this happens at a later stage
4573 than tree inlining), you can set the maximum allowable size (counted 
4574 in RTL instructions) for the RTL inliner with this parameter.
4575 The default value is 600.
4576
4577
4578 @item max-unrolled-insns
4579 The maximum number of instructions that a loop should have if that loop
4580 is unrolled, and if the loop is unrolled, it determines how many times
4581 the loop code is unrolled.
4582
4583 @item max-average-unrolled-insns
4584 The maximum number of instructions biased by probabilities of their execution
4585 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4586 it determines how many times the loop code is unrolled.
4587
4588 @item max-unroll-times
4589 The maximum number of unrollings of a single loop.
4590
4591 @item max-peeled-insns
4592 The maximum number of instructions that a loop should have if that loop
4593 is peeled, and if the loop is peeled, it determines how many times
4594 the loop code is peeled.
4595
4596 @item max-peel-times
4597 The maximum number of peelings of a single loop.
4598
4599 @item max-completely-peeled-insns
4600 The maximum number of insns of a completely peeled loop.
4601
4602 @item max-completely-peel-times
4603 The maximum number of iterations of a loop to be suitable for complete peeling.
4604
4605 @item max-unswitch-insns
4606 The maximum number of insns of an unswitched loop.
4607
4608 @item max-unswitch-level
4609 The maximum number of branches unswitched in a single loop.
4610
4611 @item hot-bb-count-fraction
4612 Select fraction of the maximal count of repetitions of basic block in program
4613 given basic block needs to have to be considered hot.
4614
4615 @item hot-bb-frequency-fraction
4616 Select fraction of the maximal frequency of executions of basic block in
4617 function given basic block needs to have to be considered hot
4618
4619 @item tracer-dynamic-coverage
4620 @itemx tracer-dynamic-coverage-feedback
4621
4622 This value is used to limit superblock formation once the given percentage of
4623 executed instructions is covered.  This limits unnecessary code size
4624 expansion.
4625
4626 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4627 feedback is available.  The real profiles (as opposed to statically estimated
4628 ones) are much less balanced allowing the threshold to be larger value.
4629
4630 @item tracer-max-code-growth
4631 Stop tail duplication once code growth has reached given percentage.  This is
4632 rather hokey argument, as most of the duplicates will be eliminated later in
4633 cross jumping, so it may be set to much higher values than is the desired code
4634 growth.
4635
4636 @item tracer-min-branch-ratio
4637
4638 Stop reverse growth when the reverse probability of best edge is less than this
4639 threshold (in percent).
4640
4641 @item tracer-min-branch-ratio
4642 @itemx tracer-min-branch-ratio-feedback
4643
4644 Stop forward growth if the best edge do have probability lower than this
4645 threshold.
4646
4647 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4648 compilation for profile feedback and one for compilation without.  The value
4649 for compilation with profile feedback needs to be more conservative (higher) in
4650 order to make tracer effective.
4651
4652 @item max-cse-path-length
4653
4654 Maximum number of basic blocks on path that cse considers.
4655
4656 @item ggc-min-expand
4657
4658 GCC uses a garbage collector to manage its own memory allocation.  This
4659 parameter specifies the minimum percentage by which the garbage
4660 collector's heap should be allowed to expand between collections.
4661 Tuning this may improve compilation speed; it has no effect on code
4662 generation.
4663
4664 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4665 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4666 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4667 GCC is not able to calculate RAM on a particular platform, the lower
4668 bound of 30% is used.  Setting this parameter and
4669 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4670 every opportunity.  This is extremely slow, but can be useful for
4671 debugging.
4672
4673 @item ggc-min-heapsize
4674
4675 Minimum size of the garbage collector's heap before it begins bothering
4676 to collect garbage.  The first collection occurs after the heap expands
4677 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4678 tuning this may improve compilation speed, and has no effect on code
4679 generation.
4680
4681 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4682 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4683 available, the notion of "RAM" is the smallest of actual RAM,
4684 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4685 RAM on a particular platform, the lower bound is used.  Setting this
4686 parameter very large effectively disables garbage collection.  Setting
4687 this parameter and @option{ggc-min-expand} to zero causes a full
4688 collection to occur at every opportunity.
4689
4690 @item reorder-blocks-duplicate
4691 @itemx reorder-blocks-duplicate-feedback
4692
4693 Used by basic block reordering pass to decide whether to use unconditional
4694 branch or duplicate the code on it's destination.  Code is duplicated when it's
4695 estimated size is smaller than this value multiplied by the estimated size of
4696 unconditional jump in the hot spots of the program.
4697
4698 The @option{reorder-block-duplicate-feedback} is used only when profile
4699 feedback is available and may be set to higher values than
4700 @option{reorder-block-duplicate} since information about the hot spots is more
4701 accurate.
4702 @end table
4703 @end table
4704
4705 @node Preprocessor Options
4706 @section Options Controlling the Preprocessor
4707 @cindex preprocessor options
4708 @cindex options, preprocessor
4709
4710 These options control the C preprocessor, which is run on each C source
4711 file before actual compilation.
4712
4713 If you use the @option{-E} option, nothing is done except preprocessing.
4714 Some of these options make sense only together with @option{-E} because
4715 they cause the preprocessor output to be unsuitable for actual
4716 compilation.
4717
4718 @table @gcctabopt
4719 @opindex Wp
4720 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4721 and pass @var{option} directly through to the preprocessor.  If
4722 @var{option} contains commas, it is split into multiple options at the
4723 commas.  However, many options are modified, translated or interpreted
4724 by the compiler driver before being passed to the preprocessor, and
4725 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4726 interface is undocumented and subject to change, so whenever possible
4727 you should avoid using @option{-Wp} and let the driver handle the
4728 options instead.
4729
4730 @item -Xpreprocessor @var{option}
4731 @opindex preprocessor
4732 Pass @var{option} as an option to the preprocessor.  You can use this to
4733 supply system-specific preprocessor options which GCC does not know how to
4734 recognize.
4735
4736 If you want to pass an option that takes an argument, you must use
4737 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4738 @end table
4739
4740 @include cppopts.texi
4741
4742 @node Assembler Options
4743 @section Passing Options to the Assembler
4744
4745 @c prevent bad page break with this line
4746 You can pass options to the assembler.
4747
4748 @table @gcctabopt
4749 @item -Wa,@var{option}
4750 @opindex Wa
4751 Pass @var{option} as an option to the assembler.  If @var{option}
4752 contains commas, it is split into multiple options at the commas.
4753
4754 @item -Xassembler @var{option}
4755 @opindex Xassembler
4756 Pass @var{option} as an option to the assembler.  You can use this to
4757 supply system-specific assembler options which GCC does not know how to
4758 recognize.
4759
4760 If you want to pass an option that takes an argument, you must use
4761 @option{-Xassembler} twice, once for the option and once for the argument.
4762
4763 @end table
4764
4765 @node Link Options
4766 @section Options for Linking
4767 @cindex link options
4768 @cindex options, linking
4769
4770 These options come into play when the compiler links object files into
4771 an executable output file.  They are meaningless if the compiler is
4772 not doing a link step.
4773
4774 @table @gcctabopt
4775 @cindex file names
4776 @item @var{object-file-name}
4777 A file name that does not end in a special recognized suffix is
4778 considered to name an object file or library.  (Object files are
4779 distinguished from libraries by the linker according to the file
4780 contents.)  If linking is done, these object files are used as input
4781 to the linker.
4782
4783 @item -c
4784 @itemx -S
4785 @itemx -E
4786 @opindex c
4787 @opindex S
4788 @opindex E
4789 If any of these options is used, then the linker is not run, and
4790 object file names should not be used as arguments.  @xref{Overall
4791 Options}.
4792
4793 @cindex Libraries
4794 @item -l@var{library}
4795 @itemx -l @var{library}
4796 @opindex l
4797 Search the library named @var{library} when linking.  (The second
4798 alternative with the library as a separate argument is only for
4799 POSIX compliance and is not recommended.)
4800
4801 It makes a difference where in the command you write this option; the
4802 linker searches and processes libraries and object files in the order they
4803 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4804 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4805 to functions in @samp{z}, those functions may not be loaded.
4806
4807 The linker searches a standard list of directories for the library,
4808 which is actually a file named @file{lib@var{library}.a}.  The linker
4809 then uses this file as if it had been specified precisely by name.
4810
4811 The directories searched include several standard system directories
4812 plus any that you specify with @option{-L}.
4813
4814 Normally the files found this way are library files---archive files
4815 whose members are object files.  The linker handles an archive file by
4816 scanning through it for members which define symbols that have so far
4817 been referenced but not defined.  But if the file that is found is an
4818 ordinary object file, it is linked in the usual fashion.  The only
4819 difference between using an @option{-l} option and specifying a file name
4820 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4821 and searches several directories.
4822
4823 @item -lobjc
4824 @opindex lobjc
4825 You need this special case of the @option{-l} option in order to
4826 link an Objective-C program.
4827
4828 @item -nostartfiles
4829 @opindex nostartfiles
4830 Do not use the standard system startup files when linking.
4831 The standard system libraries are used normally, unless @option{-nostdlib}
4832 or @option{-nodefaultlibs} is used.
4833
4834 @item -nodefaultlibs
4835 @opindex nodefaultlibs
4836 Do not use the standard system libraries when linking.
4837 Only the libraries you specify will be passed to the linker.
4838 The standard startup files are used normally, unless @option{-nostartfiles}
4839 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4840 for System V (and ISO C) environments or to bcopy and bzero for
4841 BSD environments.  These entries are usually resolved by entries in
4842 libc.  These entry points should be supplied through some other
4843 mechanism when this option is specified.
4844
4845 @item -nostdlib
4846 @opindex nostdlib
4847 Do not use the standard system startup files or libraries when linking.
4848 No startup files and only the libraries you specify will be passed to
4849 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4850 for System V (and ISO C) environments or to bcopy and bzero for
4851 BSD environments.  These entries are usually resolved by entries in
4852 libc.  These entry points should be supplied through some other
4853 mechanism when this option is specified.
4854
4855 @cindex @option{-lgcc}, use with @option{-nostdlib}
4856 @cindex @option{-nostdlib} and unresolved references
4857 @cindex unresolved references and @option{-nostdlib}
4858 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4859 @cindex @option{-nodefaultlibs} and unresolved references
4860 @cindex unresolved references and @option{-nodefaultlibs}
4861 One of the standard libraries bypassed by @option{-nostdlib} and
4862 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4863 that GCC uses to overcome shortcomings of particular machines, or special
4864 needs for some languages.
4865 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4866 Collection (GCC) Internals},
4867 for more discussion of @file{libgcc.a}.)
4868 In most cases, you need @file{libgcc.a} even when you want to avoid
4869 other standard libraries.  In other words, when you specify @option{-nostdlib}
4870 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4871 This ensures that you have no unresolved references to internal GCC
4872 library subroutines.  (For example, @samp{__main}, used to ensure C++
4873 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4874 GNU Compiler Collection (GCC) Internals}.)
4875
4876 @item -pie
4877 @opindex pie
4878 Produce a position independent executable on targets which support it.
4879 For predictable results, you must also specify the same set of options
4880 that were used to generate code (@option{-fpie}, @option{-fPIE},
4881 or model suboptions) when you specify this option.
4882
4883 @item -s
4884 @opindex s
4885 Remove all symbol table and relocation information from the executable.
4886
4887 @item -static
4888 @opindex static
4889 On systems that support dynamic linking, this prevents linking with the shared
4890 libraries.  On other systems, this option has no effect.
4891
4892 @item -shared
4893 @opindex shared
4894 Produce a shared object which can then be linked with other objects to
4895 form an executable.  Not all systems support this option.  For predictable
4896 results, you must also specify the same set of options that were used to
4897 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4898 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4899 needs to build supplementary stub code for constructors to work.  On
4900 multi-libbed systems, @samp{gcc -shared} must select the correct support
4901 libraries to link against.  Failing to supply the correct flags may lead
4902 to subtle defects.  Supplying them in cases where they are not necessary
4903 is innocuous.}
4904
4905 @item -shared-libgcc
4906 @itemx -static-libgcc
4907 @opindex shared-libgcc
4908 @opindex static-libgcc
4909 On systems that provide @file{libgcc} as a shared library, these options
4910 force the use of either the shared or static version respectively.
4911 If no shared version of @file{libgcc} was built when the compiler was
4912 configured, these options have no effect.
4913
4914 There are several situations in which an application should use the
4915 shared @file{libgcc} instead of the static version.  The most common
4916 of these is when the application wishes to throw and catch exceptions
4917 across different shared libraries.  In that case, each of the libraries
4918 as well as the application itself should use the shared @file{libgcc}.
4919
4920 Therefore, the G++ and GCJ drivers automatically add
4921 @option{-shared-libgcc} whenever you build a shared library or a main
4922 executable, because C++ and Java programs typically use exceptions, so
4923 this is the right thing to do.
4924
4925 If, instead, you use the GCC driver to create shared libraries, you may
4926 find that they will not always be linked with the shared @file{libgcc}.
4927 If GCC finds, at its configuration time, that you have a GNU linker that
4928 does not support option @option{--eh-frame-hdr}, it will link the shared
4929 version of @file{libgcc} into shared libraries by default.  Otherwise,
4930 it will take advantage of the linker and optimize away the linking with
4931 the shared version of @file{libgcc}, linking with the static version of
4932 libgcc by default.  This allows exceptions to propagate through such
4933 shared libraries, without incurring relocation costs at library load
4934 time.
4935
4936 However, if a library or main executable is supposed to throw or catch
4937 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4938 for the languages used in the program, or using the option
4939 @option{-shared-libgcc}, such that it is linked with the shared
4940 @file{libgcc}.
4941
4942 @item -symbolic
4943 @opindex symbolic
4944 Bind references to global symbols when building a shared object.  Warn
4945 about any unresolved references (unless overridden by the link editor
4946 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4947 this option.
4948
4949 @item -Xlinker @var{option}
4950 @opindex Xlinker
4951 Pass @var{option} as an option to the linker.  You can use this to
4952 supply system-specific linker options which GCC does not know how to
4953 recognize.
4954
4955 If you want to pass an option that takes an argument, you must use
4956 @option{-Xlinker} twice, once for the option and once for the argument.
4957 For example, to pass @option{-assert definitions}, you must write
4958 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4959 @option{-Xlinker "-assert definitions"}, because this passes the entire
4960 string as a single argument, which is not what the linker expects.
4961
4962 @item -Wl,@var{option}
4963 @opindex Wl
4964 Pass @var{option} as an option to the linker.  If @var{option} contains
4965 commas, it is split into multiple options at the commas.
4966
4967 @item -u @var{symbol}
4968 @opindex u
4969 Pretend the symbol @var{symbol} is undefined, to force linking of
4970 library modules to define it.  You can use @option{-u} multiple times with
4971 different symbols to force loading of additional library modules.
4972 @end table
4973
4974 @node Directory Options
4975 @section Options for Directory Search
4976 @cindex directory options
4977 @cindex options, directory search
4978 @cindex search path
4979
4980 These options specify directories to search for header files, for
4981 libraries and for parts of the compiler:
4982
4983 @table @gcctabopt
4984 @item -I@var{dir}
4985 @opindex I
4986 Add the directory @var{dir} to the head of the list of directories to be
4987 searched for header files.  This can be used to override a system header
4988 file, substituting your own version, since these directories are
4989 searched before the system header file directories.  However, you should
4990 not use this option to add directories that contain vendor-supplied
4991 system header files (use @option{-isystem} for that).  If you use more than
4992 one @option{-I} option, the directories are scanned in left-to-right
4993 order; the standard system directories come after.
4994
4995 If a standard system include directory, or a directory specified with
4996 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4997 option will be ignored.  The directory will still be searched but as a
4998 system directory at its normal position in the system include chain.
4999 This is to ensure that GCC's procedure to fix buggy system headers and
5000 the ordering for the include_next directive are not inadvertently changed.
5001 If you really need to change the search order for system directories,
5002 use the @option{-nostdinc} and/or @option{-isystem} options.
5003
5004 @item -I-
5005 @opindex I-
5006 Any directories you specify with @option{-I} options before the @option{-I-}
5007 option are searched only for the case of @samp{#include "@var{file}"};
5008 they are not searched for @samp{#include <@var{file}>}.
5009
5010 If additional directories are specified with @option{-I} options after
5011 the @option{-I-}, these directories are searched for all @samp{#include}
5012 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5013 this way.)
5014
5015 In addition, the @option{-I-} option inhibits the use of the current
5016 directory (where the current input file came from) as the first search
5017 directory for @samp{#include "@var{file}"}.  There is no way to
5018 override this effect of @option{-I-}.  With @option{-I.} you can specify
5019 searching the directory which was current when the compiler was
5020 invoked.  That is not exactly the same as what the preprocessor does
5021 by default, but it is often satisfactory.
5022
5023 @option{-I-} does not inhibit the use of the standard system directories
5024 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5025 independent.
5026
5027 @item -L@var{dir}
5028 @opindex L
5029 Add directory @var{dir} to the list of directories to be searched
5030 for @option{-l}.
5031
5032 @item -B@var{prefix}
5033 @opindex B
5034 This option specifies where to find the executables, libraries,
5035 include files, and data files of the compiler itself.
5036
5037 The compiler driver program runs one or more of the subprograms
5038 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5039 @var{prefix} as a prefix for each program it tries to run, both with and
5040 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5041
5042 For each subprogram to be run, the compiler driver first tries the
5043 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5044 was not specified, the driver tries two standard prefixes, which are
5045 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
5046 those results in a file name that is found, the unmodified program
5047 name is searched for using the directories specified in your
5048 @env{PATH} environment variable.
5049
5050 The compiler will check to see if the path provided by the @option{-B}
5051 refers to a directory, and if necessary it will add a directory
5052 separator character at the end of the path.
5053
5054 @option{-B} prefixes that effectively specify directory names also apply
5055 to libraries in the linker, because the compiler translates these
5056 options into @option{-L} options for the linker.  They also apply to
5057 includes files in the preprocessor, because the compiler translates these
5058 options into @option{-isystem} options for the preprocessor.  In this case,
5059 the compiler appends @samp{include} to the prefix.
5060
5061 The run-time support file @file{libgcc.a} can also be searched for using
5062 the @option{-B} prefix, if needed.  If it is not found there, the two
5063 standard prefixes above are tried, and that is all.  The file is left
5064 out of the link if it is not found by those means.
5065
5066 Another way to specify a prefix much like the @option{-B} prefix is to use
5067 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5068 Variables}.
5069
5070 As a special kludge, if the path provided by @option{-B} is
5071 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5072 9, then it will be replaced by @file{[dir/]include}.  This is to help
5073 with boot-strapping the compiler.
5074
5075 @item -specs=@var{file}
5076 @opindex specs
5077 Process @var{file} after the compiler reads in the standard @file{specs}
5078 file, in order to override the defaults that the @file{gcc} driver
5079 program uses when determining what switches to pass to @file{cc1},
5080 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5081 @option{-specs=@var{file}} can be specified on the command line, and they
5082 are processed in order, from left to right.
5083 @end table
5084
5085 @c man end
5086
5087 @node Spec Files
5088 @section Specifying subprocesses and the switches to pass to them
5089 @cindex Spec Files
5090
5091 @command{gcc} is a driver program.  It performs its job by invoking a
5092 sequence of other programs to do the work of compiling, assembling and
5093 linking.  GCC interprets its command-line parameters and uses these to
5094 deduce which programs it should invoke, and which command-line options
5095 it ought to place on their command lines.  This behavior is controlled
5096 by @dfn{spec strings}.  In most cases there is one spec string for each
5097 program that GCC can invoke, but a few programs have multiple spec
5098 strings to control their behavior.  The spec strings built into GCC can
5099 be overridden by using the @option{-specs=} command-line switch to specify
5100 a spec file.
5101
5102 @dfn{Spec files} are plaintext files that are used to construct spec
5103 strings.  They consist of a sequence of directives separated by blank
5104 lines.  The type of directive is determined by the first non-whitespace
5105 character on the line and it can be one of the following:
5106
5107 @table @code
5108 @item %@var{command}
5109 Issues a @var{command} to the spec file processor.  The commands that can
5110 appear here are:
5111
5112 @table @code
5113 @item %include <@var{file}>
5114 @cindex %include
5115 Search for @var{file} and insert its text at the current point in the
5116 specs file.
5117
5118 @item %include_noerr <@var{file}>
5119 @cindex %include_noerr
5120 Just like @samp{%include}, but do not generate an error message if the include
5121 file cannot be found.
5122
5123 @item %rename @var{old_name} @var{new_name}
5124 @cindex %rename
5125 Rename the spec string @var{old_name} to @var{new_name}.
5126
5127 @end table
5128
5129 @item *[@var{spec_name}]:
5130 This tells the compiler to create, override or delete the named spec
5131 string.  All lines after this directive up to the next directive or
5132 blank line are considered to be the text for the spec string.  If this
5133 results in an empty string then the spec will be deleted.  (Or, if the
5134 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5135 does not currently exist a new spec will be created.  If the spec does
5136 exist then its contents will be overridden by the text of this
5137 directive, unless the first character of that text is the @samp{+}
5138 character, in which case the text will be appended to the spec.
5139
5140 @item [@var{suffix}]:
5141 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5142 and up to the next directive or blank line are considered to make up the
5143 spec string for the indicated suffix.  When the compiler encounters an
5144 input file with the named suffix, it will processes the spec string in
5145 order to work out how to compile that file.  For example:
5146
5147 @smallexample
5148 .ZZ:
5149 z-compile -input %i
5150 @end smallexample
5151
5152 This says that any input file whose name ends in @samp{.ZZ} should be
5153 passed to the program @samp{z-compile}, which should be invoked with the
5154 command-line switch @option{-input} and with the result of performing the
5155 @samp{%i} substitution.  (See below.)
5156
5157 As an alternative to providing a spec string, the text that follows a
5158 suffix directive can be one of the following:
5159
5160 @table @code
5161 @item @@@var{language}
5162 This says that the suffix is an alias for a known @var{language}.  This is
5163 similar to using the @option{-x} command-line switch to GCC to specify a
5164 language explicitly.  For example:
5165
5166 @smallexample
5167 .ZZ:
5168 @@c++
5169 @end smallexample
5170
5171 Says that .ZZ files are, in fact, C++ source files.
5172
5173 @item #@var{name}
5174 This causes an error messages saying:
5175
5176 @smallexample
5177 @var{name} compiler not installed on this system.
5178 @end smallexample
5179 @end table
5180
5181 GCC already has an extensive list of suffixes built into it.
5182 This directive will add an entry to the end of the list of suffixes, but
5183 since the list is searched from the end backwards, it is effectively
5184 possible to override earlier entries using this technique.
5185
5186 @end table
5187
5188 GCC has the following spec strings built into it.  Spec files can
5189 override these strings or create their own.  Note that individual
5190 targets can also add their own spec strings to this list.
5191
5192 @smallexample
5193 asm          Options to pass to the assembler
5194 asm_final    Options to pass to the assembler post-processor
5195 cpp          Options to pass to the C preprocessor
5196 cc1          Options to pass to the C compiler
5197 cc1plus      Options to pass to the C++ compiler
5198 endfile      Object files to include at the end of the link
5199 link         Options to pass to the linker
5200 lib          Libraries to include on the command line to the linker
5201 libgcc       Decides which GCC support library to pass to the linker
5202 linker       Sets the name of the linker
5203 predefines   Defines to be passed to the C preprocessor
5204 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5205              by default
5206 startfile    Object files to include at the start of the link
5207 @end smallexample
5208
5209 Here is a small example of a spec file:
5210
5211 @smallexample
5212 %rename lib                 old_lib
5213
5214 *lib:
5215 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5216 @end smallexample
5217
5218 This example renames the spec called @samp{lib} to @samp{old_lib} and
5219 then overrides the previous definition of @samp{lib} with a new one.
5220 The new definition adds in some extra command-line options before
5221 including the text of the old definition.
5222
5223 @dfn{Spec strings} are a list of command-line options to be passed to their
5224 corresponding program.  In addition, the spec strings can contain
5225 @samp{%}-prefixed sequences to substitute variable text or to
5226 conditionally insert text into the command line.  Using these constructs
5227 it is possible to generate quite complex command lines.
5228
5229 Here is a table of all defined @samp{%}-sequences for spec
5230 strings.  Note that spaces are not generated automatically around the
5231 results of expanding these sequences.  Therefore you can concatenate them
5232 together or combine them with constant text in a single argument.
5233
5234 @table @code
5235 @item %%
5236 Substitute one @samp{%} into the program name or argument.
5237
5238 @item %i
5239 Substitute the name of the input file being processed.
5240
5241 @item %b
5242 Substitute the basename of the input file being processed.
5243 This is the substring up to (and not including) the last period
5244 and not including the directory.
5245
5246 @item %B
5247 This is the same as @samp{%b}, but include the file suffix (text after
5248 the last period).
5249
5250 @item %d
5251 Marks the argument containing or following the @samp{%d} as a
5252 temporary file name, so that that file will be deleted if GCC exits
5253 successfully.  Unlike @samp{%g}, this contributes no text to the
5254 argument.
5255
5256 @item %g@var{suffix}
5257 Substitute a file name that has suffix @var{suffix} and is chosen
5258 once per compilation, and mark the argument in the same way as
5259 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5260 name is now chosen in a way that is hard to predict even when previously
5261 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5262 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5263 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5264 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5265 was simply substituted with a file name chosen once per compilation,
5266 without regard to any appended suffix (which was therefore treated
5267 just like ordinary text), making such attacks more likely to succeed.
5268
5269 @item %u@var{suffix}
5270 Like @samp{%g}, but generates a new temporary file name even if
5271 @samp{%u@var{suffix}} was already seen.
5272
5273 @item %U@var{suffix}
5274 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5275 new one if there is no such last file name.  In the absence of any
5276 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5277 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5278 would involve the generation of two distinct file names, one
5279 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5280 simply substituted with a file name chosen for the previous @samp{%u},
5281 without regard to any appended suffix.
5282
5283 @item %j@var{suffix}
5284 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5285 writable, and if save-temps is off; otherwise, substitute the name
5286 of a temporary file, just like @samp{%u}.  This temporary file is not
5287 meant for communication between processes, but rather as a junk
5288 disposal mechanism.
5289
5290 @item %|@var{suffix}
5291 @itemx %m@var{suffix}
5292 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5293 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5294 all.  These are the two most common ways to instruct a program that it
5295 should read from standard input or write to standard output.  If you
5296 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5297 construct: see for example @file{f/lang-specs.h}.
5298
5299 @item %.@var{SUFFIX}
5300 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5301 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5302 terminated by the next space or %.
5303
5304 @item %w
5305 Marks the argument containing or following the @samp{%w} as the
5306 designated output file of this compilation.  This puts the argument
5307 into the sequence of arguments that @samp{%o} will substitute later.
5308
5309 @item %o
5310 Substitutes the names of all the output files, with spaces
5311 automatically placed around them.  You should write spaces
5312 around the @samp{%o} as well or the results are undefined.
5313 @samp{%o} is for use in the specs for running the linker.
5314 Input files whose names have no recognized suffix are not compiled
5315 at all, but they are included among the output files, so they will
5316 be linked.
5317
5318 @item %O
5319 Substitutes the suffix for object files.  Note that this is
5320 handled specially when it immediately follows @samp{%g, %u, or %U},
5321 because of the need for those to form complete file names.  The
5322 handling is such that @samp{%O} is treated exactly as if it had already
5323 been substituted, except that @samp{%g, %u, and %U} do not currently
5324 support additional @var{suffix} characters following @samp{%O} as they would
5325 following, for example, @samp{.o}.
5326
5327 @item %p
5328 Substitutes the standard macro predefinitions for the
5329 current target machine.  Use this when running @code{cpp}.
5330
5331 @item %P
5332 Like @samp{%p}, but puts @samp{__} before and after the name of each
5333 predefined macro, except for macros that start with @samp{__} or with
5334 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5335 C@.
5336
5337 @item %I
5338 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5339 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5340 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5341 as necessary.
5342
5343 @item %s
5344 Current argument is the name of a library or startup file of some sort.
5345 Search for that file in a standard list of directories and substitute
5346 the full name found.
5347
5348 @item %e@var{str}
5349 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5350 Use this when inconsistent options are detected.
5351
5352 @item %(@var{name})
5353 Substitute the contents of spec string @var{name} at this point.
5354
5355 @item %[@var{name}]
5356 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5357
5358 @item %x@{@var{option}@}
5359 Accumulate an option for @samp{%X}.
5360
5361 @item %X
5362 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5363 spec string.
5364
5365 @item %Y
5366 Output the accumulated assembler options specified by @option{-Wa}.
5367
5368 @item %Z
5369 Output the accumulated preprocessor options specified by @option{-Wp}.
5370
5371 @item %a
5372 Process the @code{asm} spec.  This is used to compute the
5373 switches to be passed to the assembler.
5374
5375 @item %A
5376 Process the @code{asm_final} spec.  This is a spec string for
5377 passing switches to an assembler post-processor, if such a program is
5378 needed.
5379
5380 @item %l
5381 Process the @code{link} spec.  This is the spec for computing the
5382 command line passed to the linker.  Typically it will make use of the
5383 @samp{%L %G %S %D and %E} sequences.
5384
5385 @item %D
5386 Dump out a @option{-L} option for each directory that GCC believes might
5387 contain startup files.  If the target supports multilibs then the
5388 current multilib directory will be prepended to each of these paths.
5389
5390 @item %M
5391 Output the multilib directory with directory separators replaced with
5392 @samp{_}.  If multilib directories are not set, or the multilib directory is
5393 @file{.} then this option emits nothing.
5394
5395 @item %L
5396 Process the @code{lib} spec.  This is a spec string for deciding which
5397 libraries should be included on the command line to the linker.
5398
5399 @item %G
5400 Process the @code{libgcc} spec.  This is a spec string for deciding
5401 which GCC support library should be included on the command line to the linker.
5402
5403 @item %S
5404 Process the @code{startfile} spec.  This is a spec for deciding which
5405 object files should be the first ones passed to the linker.  Typically
5406 this might be a file named @file{crt0.o}.
5407
5408 @item %E
5409 Process the @code{endfile} spec.  This is a spec string that specifies
5410 the last object files that will be passed to the linker.
5411
5412 @item %C
5413 Process the @code{cpp} spec.  This is used to construct the arguments
5414 to be passed to the C preprocessor.
5415
5416 @item %c
5417 Process the @code{signed_char} spec.  This is intended to be used
5418 to tell cpp whether a char is signed.  It typically has the definition:
5419 @smallexample
5420 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5421 @end smallexample
5422
5423 @item %1
5424 Process the @code{cc1} spec.  This is used to construct the options to be
5425 passed to the actual C compiler (@samp{cc1}).
5426
5427 @item %2
5428 Process the @code{cc1plus} spec.  This is used to construct the options to be
5429 passed to the actual C++ compiler (@samp{cc1plus}).
5430
5431 @item %*
5432 Substitute the variable part of a matched option.  See below.
5433 Note that each comma in the substituted string is replaced by
5434 a single space.
5435
5436 @item %<@code{S}
5437 Remove all occurrences of @code{-S} from the command line.  Note---this
5438 command is position dependent.  @samp{%} commands in the spec string
5439 before this one will see @code{-S}, @samp{%} commands in the spec string
5440 after this one will not.
5441
5442 @item %:@var{function}(@var{args})
5443 Call the named function @var{function}, passing it @var{args}.
5444 @var{args} is first processed as a nested spec string, then split
5445 into an argument vector in the usual fashion.  The function returns
5446 a string which is processed as if it had appeared literally as part
5447 of the current spec.
5448
5449 The following built-in spec functions are provided:
5450
5451 @table @code
5452 @item @code{if-exists}
5453 The @code{if-exists} spec function takes one argument, an absolute
5454 pathname to a file.  If the file exists, @code{if-exists} returns the
5455 pathname.  Here is a small example of its usage:
5456
5457 @smallexample
5458 *startfile:
5459 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5460 @end smallexample
5461
5462 @item @code{if-exists-else}
5463 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5464 spec function, except that it takes two arguments.  The first argument is
5465 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5466 returns the pathname.  If it does not exist, it returns the second argument.
5467 This way, @code{if-exists-else} can be used to select one file or another,
5468 based on the existence of the first.  Here is a small example of its usage:
5469
5470 @smallexample 
5471 *startfile:
5472 crt0%O%s %:if-exists(crti%O%s) \
5473 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5474 @end smallexample
5475 @end table 
5476
5477 @item %@{@code{S}@}
5478 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5479 If that switch was not specified, this substitutes nothing.  Note that
5480 the leading dash is omitted when specifying this option, and it is
5481 automatically inserted if the substitution is performed.  Thus the spec
5482 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5483 and would output the command line option @option{-foo}.
5484
5485 @item %W@{@code{S}@}
5486 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5487 deleted on failure.
5488
5489 @item %@{@code{S}*@}
5490 Substitutes all the switches specified to GCC whose names start
5491 with @code{-S}, but which also take an argument.  This is used for
5492 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5493 GCC considers @option{-o foo} as being
5494 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5495 text, including the space.  Thus two arguments would be generated.
5496
5497 @item %@{@code{S}*&@code{T}*@}
5498 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5499 (the order of @code{S} and @code{T} in the spec is not significant).
5500 There can be any number of ampersand-separated variables; for each the
5501 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5502
5503 @item %@{@code{S}:@code{X}@}
5504 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5505
5506 @item %@{!@code{S}:@code{X}@}
5507 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5508
5509 @item %@{@code{S}*:@code{X}@}
5510 Substitutes @code{X} if one or more switches whose names start with
5511 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5512 once, no matter how many such switches appeared.  However, if @code{%*}
5513 appears somewhere in @code{X}, then @code{X} will be substituted once
5514 for each matching switch, with the @code{%*} replaced by the part of
5515 that switch that matched the @code{*}.
5516
5517 @item %@{.@code{S}:@code{X}@}
5518 Substitutes @code{X}, if processing a file with suffix @code{S}.
5519
5520 @item %@{!.@code{S}:@code{X}@}
5521 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5522
5523 @item %@{@code{S}|@code{P}:@code{X}@}
5524 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5525 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5526 although they have a stronger binding than the @samp{|}.  If @code{%*}
5527 appears in @code{X}, all of the alternatives must be starred, and only
5528 the first matching alternative is substituted.
5529
5530 For example, a spec string like this:
5531
5532 @smallexample
5533 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5534 @end smallexample
5535
5536 will output the following command-line options from the following input
5537 command-line options:
5538
5539 @smallexample
5540 fred.c        -foo -baz
5541 jim.d         -bar -boggle
5542 -d fred.c     -foo -baz -boggle
5543 -d jim.d      -bar -baz -boggle
5544 @end smallexample
5545
5546 @item %@{S:X; T:Y; :D@}
5547
5548 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5549 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5550 be as many clauses as you need.  This may be combined with @code{.}, 
5551 @code{!}, @code{|}, and @code{*} as needed.
5552
5553
5554 @end table
5555
5556 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5557 construct may contain other nested @samp{%} constructs or spaces, or
5558 even newlines.  They are processed as usual, as described above.
5559 Trailing white space in @code{X} is ignored.  White space may also
5560 appear anywhere on the left side of the colon in these constructs,
5561 except between @code{.} or @code{*} and the corresponding word.
5562
5563 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5564 handled specifically in these constructs.  If another value of
5565 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5566 @option{-W} switch is found later in the command line, the earlier
5567 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5568 just one letter, which passes all matching options.
5569
5570 The character @samp{|} at the beginning of the predicate text is used to
5571 indicate that a command should be piped to the following command, but
5572 only if @option{-pipe} is specified.
5573
5574 It is built into GCC which switches take arguments and which do not.
5575 (You might think it would be useful to generalize this to allow each
5576 compiler's spec to say which switches take arguments.  But this cannot
5577 be done in a consistent fashion.  GCC cannot even decide which input
5578 files have been specified without knowing which switches take arguments,
5579 and it must know which input files to compile in order to tell which
5580 compilers to run).
5581
5582 GCC also knows implicitly that arguments starting in @option{-l} are to be
5583 treated as compiler output files, and passed to the linker in their
5584 proper position among the other output files.
5585
5586 @c man begin OPTIONS
5587
5588 @node Target Options
5589 @section Specifying Target Machine and Compiler Version
5590 @cindex target options
5591 @cindex cross compiling
5592 @cindex specifying machine version
5593 @cindex specifying compiler version and target machine
5594 @cindex compiler version, specifying
5595 @cindex target machine, specifying
5596
5597 The usual way to run GCC is to run the executable called @file{gcc}, or
5598 @file{<machine>-gcc} when cross-compiling, or
5599 @file{<machine>-gcc-<version>} to run a version other than the one that
5600 was installed last.  Sometimes this is inconvenient, so GCC provides
5601 options that will switch to another cross-compiler or version.
5602
5603 @table @gcctabopt
5604 @item -b @var{machine}
5605 @opindex b
5606 The argument @var{machine} specifies the target machine for compilation.
5607
5608 The value to use for @var{machine} is the same as was specified as the
5609 machine type when configuring GCC as a cross-compiler.  For
5610 example, if a cross-compiler was configured with @samp{configure
5611 i386v}, meaning to compile for an 80386 running System V, then you
5612 would specify @option{-b i386v} to run that cross compiler.
5613
5614 @item -V @var{version}
5615 @opindex V
5616 The argument @var{version} specifies which version of GCC to run.
5617 This is useful when multiple versions are installed.  For example,
5618 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5619 @end table
5620
5621 The @option{-V} and @option{-b} options work by running the
5622 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5623 use them if you can just run that directly.
5624
5625 @node Submodel Options
5626 @section Hardware Models and Configurations
5627 @cindex submodel options
5628 @cindex specifying hardware config
5629 @cindex hardware models and configurations, specifying
5630 @cindex machine dependent options
5631
5632 Earlier we discussed the standard option @option{-b} which chooses among
5633 different installed compilers for completely different target
5634 machines, such as VAX vs.@: 68000 vs.@: 80386.
5635
5636 In addition, each of these target machine types can have its own
5637 special options, starting with @samp{-m}, to choose among various
5638 hardware models or configurations---for example, 68010 vs 68020,
5639 floating coprocessor or none.  A single installed version of the
5640 compiler can compile for any model or configuration, according to the
5641 options specified.
5642
5643 Some configurations of the compiler also support additional special
5644 options, usually for compatibility with other compilers on the same
5645 platform.
5646
5647 These options are defined by the macro @code{TARGET_SWITCHES} in the
5648 machine description.  The default for the options is also defined by
5649 that macro, which enables you to change the defaults.
5650
5651 @menu
5652 * M680x0 Options::
5653 * M68hc1x Options::
5654 * VAX Options::
5655 * SPARC Options::
5656 * ARM Options::
5657 * MN10200 Options::
5658 * MN10300 Options::
5659 * M32R/D Options::
5660 * M88K Options::
5661 * RS/6000 and PowerPC Options::
5662 * Darwin Options::
5663 * RT Options::
5664 * MIPS Options::
5665 * i386 and x86-64 Options::
5666 * HPPA Options::
5667 * Intel 960 Options::
5668 * DEC Alpha Options::
5669 * DEC Alpha/VMS Options::
5670 * H8/300 Options::
5671 * SH Options::
5672 * System V Options::
5673 * TMS320C3x/C4x Options::
5674 * V850 Options::
5675 * ARC Options::
5676 * NS32K Options::
5677 * AVR Options::
5678 * MCore Options::
5679 * IA-64 Options::
5680 * D30V Options::
5681 * S/390 and zSeries Options::
5682 * CRIS Options::
5683 * MMIX Options::
5684 * PDP-11 Options::
5685 * Xstormy16 Options::
5686 * Xtensa Options::
5687 * FRV Options::
5688 @end menu
5689
5690 @node M680x0 Options
5691 @subsection M680x0 Options
5692 @cindex M680x0 options
5693
5694 These are the @samp{-m} options defined for the 68000 series.  The default
5695 values for these options depends on which style of 68000 was selected when
5696 the compiler was configured; the defaults for the most common choices are
5697 given below.
5698
5699 @table @gcctabopt
5700 @item -m68000
5701 @itemx -mc68000
5702 @opindex m68000
5703 @opindex mc68000
5704 Generate output for a 68000.  This is the default
5705 when the compiler is configured for 68000-based systems.
5706
5707 Use this option for microcontrollers with a 68000 or EC000 core,
5708 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5709
5710 @item -m68020
5711 @itemx -mc68020
5712 @opindex m68020
5713 @opindex mc68020
5714 Generate output for a 68020.  This is the default
5715 when the compiler is configured for 68020-based systems.
5716
5717 @item -m68881
5718 @opindex m68881
5719 Generate output containing 68881 instructions for floating point.
5720 This is the default for most 68020 systems unless @option{--nfp} was
5721 specified when the compiler was configured.
5722
5723 @item -m68030
5724 @opindex m68030
5725 Generate output for a 68030.  This is the default when the compiler is
5726 configured for 68030-based systems.
5727
5728 @item -m68040
5729 @opindex m68040
5730 Generate output for a 68040.  This is the default when the compiler is
5731 configured for 68040-based systems.
5732
5733 This option inhibits the use of 68881/68882 instructions that have to be
5734 emulated by software on the 68040.  Use this option if your 68040 does not
5735 have code to emulate those instructions.
5736
5737 @item -m68060
5738 @opindex m68060
5739 Generate output for a 68060.  This is the default when the compiler is
5740 configured for 68060-based systems.
5741
5742 This option inhibits the use of 68020 and 68881/68882 instructions that
5743 have to be emulated by software on the 68060.  Use this option if your 68060
5744 does not have code to emulate those instructions.
5745
5746 @item -mcpu32
5747 @opindex mcpu32
5748 Generate output for a CPU32.  This is the default
5749 when the compiler is configured for CPU32-based systems.
5750
5751 Use this option for microcontrollers with a
5752 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5753 68336, 68340, 68341, 68349 and 68360.
5754
5755 @item -m5200
5756 @opindex m5200
5757 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5758 when the compiler is configured for 520X-based systems.
5759
5760 Use this option for microcontroller with a 5200 core, including
5761 the MCF5202, MCF5203, MCF5204 and MCF5202.
5762
5763
5764 @item -m68020-40
5765 @opindex m68020-40
5766 Generate output for a 68040, without using any of the new instructions.
5767 This results in code which can run relatively efficiently on either a
5768 68020/68881 or a 68030 or a 68040.  The generated code does use the
5769 68881 instructions that are emulated on the 68040.
5770
5771 @item -m68020-60
5772 @opindex m68020-60
5773 Generate output for a 68060, without using any of the new instructions.
5774 This results in code which can run relatively efficiently on either a
5775 68020/68881 or a 68030 or a 68040.  The generated code does use the
5776 68881 instructions that are emulated on the 68060.
5777
5778 @item -msoft-float
5779 @opindex msoft-float
5780 Generate output containing library calls for floating point.
5781 @strong{Warning:} the requisite libraries are not available for all m68k
5782 targets.  Normally the facilities of the machine's usual C compiler are
5783 used, but this can't be done directly in cross-compilation.  You must
5784 make your own arrangements to provide suitable library functions for
5785 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5786 @samp{m68k-*-coff} do provide software floating point support.
5787
5788 @item -mshort
5789 @opindex mshort
5790 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5791
5792 @item -mnobitfield
5793 @opindex mnobitfield
5794 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5795 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5796
5797 @item -mbitfield
5798 @opindex mbitfield
5799 Do use the bit-field instructions.  The @option{-m68020} option implies
5800 @option{-mbitfield}.  This is the default if you use a configuration
5801 designed for a 68020.
5802
5803 @item -mrtd
5804 @opindex mrtd
5805 Use a different function-calling convention, in which functions
5806 that take a fixed number of arguments return with the @code{rtd}
5807 instruction, which pops their arguments while returning.  This
5808 saves one instruction in the caller since there is no need to pop
5809 the arguments there.
5810
5811 This calling convention is incompatible with the one normally
5812 used on Unix, so you cannot use it if you need to call libraries
5813 compiled with the Unix compiler.
5814
5815 Also, you must provide function prototypes for all functions that
5816 take variable numbers of arguments (including @code{printf});
5817 otherwise incorrect code will be generated for calls to those
5818 functions.
5819
5820 In addition, seriously incorrect code will result if you call a
5821 function with too many arguments.  (Normally, extra arguments are
5822 harmlessly ignored.)
5823
5824 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5825 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5826
5827 @item -malign-int
5828 @itemx -mno-align-int
5829 @opindex malign-int
5830 @opindex mno-align-int
5831 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5832 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5833 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5834 Aligning variables on 32-bit boundaries produces code that runs somewhat
5835 faster on processors with 32-bit busses at the expense of more memory.
5836
5837 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5838 align structures containing the above types  differently than
5839 most published application binary interface specifications for the m68k.
5840
5841 @item -mpcrel
5842 @opindex mpcrel
5843 Use the pc-relative addressing mode of the 68000 directly, instead of
5844 using a global offset table.  At present, this option implies @option{-fpic},
5845 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5846 not presently supported with @option{-mpcrel}, though this could be supported for
5847 68020 and higher processors.
5848
5849 @item -mno-strict-align
5850 @itemx -mstrict-align
5851 @opindex mno-strict-align
5852 @opindex mstrict-align
5853 Do not (do) assume that unaligned memory references will be handled by
5854 the system.
5855
5856 @end table
5857
5858 @node M68hc1x Options
5859 @subsection M68hc1x Options
5860 @cindex M68hc1x options
5861
5862 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5863 microcontrollers.  The default values for these options depends on
5864 which style of microcontroller was selected when the compiler was configured;
5865 the defaults for the most common choices are given below.
5866
5867 @table @gcctabopt
5868 @item -m6811
5869 @itemx -m68hc11
5870 @opindex m6811
5871 @opindex m68hc11
5872 Generate output for a 68HC11.  This is the default
5873 when the compiler is configured for 68HC11-based systems.
5874
5875 @item -m6812
5876 @itemx -m68hc12
5877 @opindex m6812
5878 @opindex m68hc12
5879 Generate output for a 68HC12.  This is the default
5880 when the compiler is configured for 68HC12-based systems.
5881
5882 @item -m68S12
5883 @itemx -m68hcs12
5884 @opindex m68S12
5885 @opindex m68hcs12
5886 Generate output for a 68HCS12.  
5887
5888 @item -mauto-incdec
5889 @opindex mauto-incdec
5890 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5891 addressing modes.
5892
5893 @item -minmax
5894 @itemx -nominmax
5895 @opindex minmax
5896 @opindex mnominmax
5897 Enable the use of 68HC12 min and max instructions.
5898
5899 @item -mlong-calls
5900 @itemx -mno-long-calls
5901 @opindex mlong-calls
5902 @opindex mno-long-calls
5903 Treat all calls as being far away (near).  If calls are assumed to be
5904 far away, the compiler will use the @code{call} instruction to
5905 call a function and the @code{rtc} instruction for returning.
5906
5907 @item -mshort
5908 @opindex mshort
5909 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5910
5911 @item -msoft-reg-count=@var{count}
5912 @opindex msoft-reg-count
5913 Specify the number of pseudo-soft registers which are used for the
5914 code generation.  The maximum number is 32.  Using more pseudo-soft
5915 register may or may not result in better code depending on the program.
5916 The default is 4 for 68HC11 and 2 for 68HC12.
5917
5918 @end table
5919
5920 @node VAX Options
5921 @subsection VAX Options
5922 @cindex VAX options
5923
5924 These @samp{-m} options are defined for the VAX:
5925
5926 @table @gcctabopt
5927 @item -munix
5928 @opindex munix
5929 Do not output certain jump instructions (@code{aobleq} and so on)
5930 that the Unix assembler for the VAX cannot handle across long
5931 ranges.
5932
5933 @item -mgnu
5934 @opindex mgnu
5935 Do output those jump instructions, on the assumption that you
5936 will assemble with the GNU assembler.
5937
5938 @item -mg
5939 @opindex mg
5940 Output code for g-format floating point numbers instead of d-format.
5941 @end table
5942
5943 @node SPARC Options
5944 @subsection SPARC Options
5945 @cindex SPARC options
5946
5947 These @samp{-m} switches are supported on the SPARC:
5948
5949 @table @gcctabopt
5950 @item -mno-app-regs
5951 @itemx -mapp-regs
5952 @opindex mno-app-regs
5953 @opindex mapp-regs
5954 Specify @option{-mapp-regs} to generate output using the global registers
5955 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5956 is the default.
5957
5958 To be fully SVR4 ABI compliant at the cost of some performance loss,
5959 specify @option{-mno-app-regs}.  You should compile libraries and system
5960 software with this option.
5961
5962 @item -mfpu
5963 @itemx -mhard-float
5964 @opindex mfpu
5965 @opindex mhard-float
5966 Generate output containing floating point instructions.  This is the
5967 default.
5968
5969 @item -mno-fpu
5970 @itemx -msoft-float
5971 @opindex mno-fpu
5972 @opindex msoft-float
5973 Generate output containing library calls for floating point.
5974 @strong{Warning:} the requisite libraries are not available for all SPARC
5975 targets.  Normally the facilities of the machine's usual C compiler are
5976 used, but this cannot be done directly in cross-compilation.  You must make
5977 your own arrangements to provide suitable library functions for
5978 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5979 @samp{sparclite-*-*} do provide software floating point support.
5980
5981 @option{-msoft-float} changes the calling convention in the output file;
5982 therefore, it is only useful if you compile @emph{all} of a program with
5983 this option.  In particular, you need to compile @file{libgcc.a}, the
5984 library that comes with GCC, with @option{-msoft-float} in order for
5985 this to work.
5986
5987 @item -mhard-quad-float
5988 @opindex mhard-quad-float
5989 Generate output containing quad-word (long double) floating point
5990 instructions.
5991
5992 @item -mimpure-text
5993 @opindex mimpure-text
5994 @option{-mimpure-text}, used in addition to @option{-shared}, tells
5995 the compiler to not pass @option{-z text} to the linker when linking a
5996 shared object.  Using this option, you can link position-dependent
5997 code into a shared object.  
5998
5999 @option{-mimpure-text} suppresses the ``relocations remain against
6000 allocatable but non-writable sections'' linker error message.
6001 However, the necessary relocations will trigger copy-on-write, and the
6002 shared object is not actually shared across processes.  Instead of
6003 using @option{-mimpure-text}, you should compile all source code with
6004 @option{-fpic} or @option{-fPIC}.
6005
6006 This option is only available on SunOS and Solaris.
6007
6008 @item -msoft-quad-float
6009 @opindex msoft-quad-float
6010 Generate output containing library calls for quad-word (long double)
6011 floating point instructions.  The functions called are those specified
6012 in the SPARC ABI@.  This is the default.
6013
6014 As of this writing, there are no sparc implementations that have hardware
6015 support for the quad-word floating point instructions.  They all invoke
6016 a trap handler for one of these instructions, and then the trap handler
6017 emulates the effect of the instruction.  Because of the trap handler overhead,
6018 this is much slower than calling the ABI library routines.  Thus the
6019 @option{-msoft-quad-float} option is the default.
6020
6021 @item -mno-flat
6022 @itemx -mflat
6023 @opindex mno-flat
6024 @opindex mflat
6025 With @option{-mflat}, the compiler does not generate save/restore instructions
6026 and will use a ``flat'' or single register window calling convention.
6027 This model uses %i7 as the frame pointer and is compatible with the normal
6028 register window model.  Code from either may be intermixed.
6029 The local registers and the input registers (0--5) are still treated as
6030 ``call saved'' registers and will be saved on the stack as necessary.
6031
6032 With @option{-mno-flat} (the default), the compiler emits save/restore
6033 instructions (except for leaf functions) and is the normal mode of operation.
6034
6035 @item -mno-unaligned-doubles
6036 @itemx -munaligned-doubles
6037 @opindex mno-unaligned-doubles
6038 @opindex munaligned-doubles
6039 Assume that doubles have 8 byte alignment.  This is the default.
6040
6041 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6042 alignment only if they are contained in another type, or if they have an
6043 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6044 Specifying this option avoids some rare compatibility problems with code
6045 generated by other compilers.  It is not the default because it results
6046 in a performance loss, especially for floating point code.
6047
6048 @item -mno-faster-structs
6049 @itemx -mfaster-structs
6050 @opindex mno-faster-structs
6051 @opindex mfaster-structs
6052 With @option{-mfaster-structs}, the compiler assumes that structures
6053 should have 8 byte alignment.  This enables the use of pairs of
6054 @code{ldd} and @code{std} instructions for copies in structure
6055 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6056 However, the use of this changed alignment directly violates the SPARC
6057 ABI@.  Thus, it's intended only for use on targets where the developer
6058 acknowledges that their resulting code will not be directly in line with
6059 the rules of the ABI@.
6060
6061 @item -mv8
6062 @itemx -msparclite
6063 @opindex mv8
6064 @opindex msparclite
6065 These two options select variations on the SPARC architecture.
6066
6067 By default (unless specifically configured for the Fujitsu SPARClite),
6068 GCC generates code for the v7 variant of the SPARC architecture.
6069
6070 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6071 code is that the compiler emits the integer multiply and integer
6072 divide instructions which exist in SPARC v8 but not in SPARC v7.
6073
6074 @option{-msparclite} will give you SPARClite code.  This adds the integer
6075 multiply, integer divide step and scan (@code{ffs}) instructions which
6076 exist in SPARClite but not in SPARC v7.
6077
6078 These options are deprecated and will be deleted in a future GCC release.
6079 They have been replaced with @option{-mcpu=xxx}.
6080
6081 @item -mcypress
6082 @itemx -msupersparc
6083 @opindex mcypress
6084 @opindex msupersparc
6085 These two options select the processor for which the code is optimized.
6086
6087 With @option{-mcypress} (the default), the compiler optimizes code for the
6088 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6089 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6090
6091 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6092 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6093 of the full SPARC v8 instruction set.
6094
6095 These options are deprecated and will be deleted in a future GCC release.
6096 They have been replaced with @option{-mcpu=xxx}.
6097
6098 @item -mcpu=@var{cpu_type}
6099 @opindex mcpu
6100 Set the instruction set, register set, and instruction scheduling parameters
6101 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6102 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6103 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6104 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6105 @samp{ultrasparc3}.
6106
6107 Default instruction scheduling parameters are used for values that select
6108 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6109 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6110
6111 Here is a list of each supported architecture and their supported
6112 implementations.
6113
6114 @smallexample
6115     v7:             cypress
6116     v8:             supersparc, hypersparc
6117     sparclite:      f930, f934, sparclite86x
6118     sparclet:       tsc701
6119     v9:             ultrasparc, ultrasparc3
6120 @end smallexample
6121
6122 @item -mtune=@var{cpu_type}
6123 @opindex mtune
6124 Set the instruction scheduling parameters for machine type
6125 @var{cpu_type}, but do not set the instruction set or register set that the
6126 option @option{-mcpu=@var{cpu_type}} would.
6127
6128 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6129 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6130 that select a particular cpu implementation.  Those are @samp{cypress},
6131 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6132 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6133 @samp{ultrasparc3}.
6134
6135 @end table
6136
6137 These @samp{-m} switches are supported in addition to the above
6138 on the SPARCLET processor.
6139
6140 @table @gcctabopt
6141 @item -mlittle-endian
6142 @opindex mlittle-endian
6143 Generate code for a processor running in little-endian mode.
6144
6145 @item -mlive-g0
6146 @opindex mlive-g0
6147 Treat register @code{%g0} as a normal register.
6148 GCC will continue to clobber it as necessary but will not assume
6149 it always reads as 0.
6150
6151 @item -mbroken-saverestore
6152 @opindex mbroken-saverestore
6153 Generate code that does not use non-trivial forms of the @code{save} and
6154 @code{restore} instructions.  Early versions of the SPARCLET processor do
6155 not correctly handle @code{save} and @code{restore} instructions used with
6156 arguments.  They correctly handle them used without arguments.  A @code{save}
6157 instruction used without arguments increments the current window pointer
6158 but does not allocate a new stack frame.  It is assumed that the window
6159 overflow trap handler will properly handle this case as will interrupt
6160 handlers.
6161 @end table
6162
6163 These @samp{-m} switches are supported in addition to the above
6164 on SPARC V9 processors in 64-bit environments.
6165
6166 @table @gcctabopt
6167 @item -mlittle-endian
6168 @opindex mlittle-endian
6169 Generate code for a processor running in little-endian mode.
6170
6171 @item -m32
6172 @itemx -m64
6173 @opindex m32
6174 @opindex m64
6175 Generate code for a 32-bit or 64-bit environment.
6176 The 32-bit environment sets int, long and pointer to 32 bits.
6177 The 64-bit environment sets int to 32 bits and long and pointer
6178 to 64 bits.
6179
6180 @item -mcmodel=medlow
6181 @opindex mcmodel=medlow
6182 Generate code for the Medium/Low code model: the program must be linked
6183 in the low 32 bits of the address space.  Pointers are 64 bits.
6184 Programs can be statically or dynamically linked.
6185
6186 @item -mcmodel=medmid
6187 @opindex mcmodel=medmid
6188 Generate code for the Medium/Middle code model: the program must be linked
6189 in the low 44 bits of the address space, the text segment must be less than
6190 2G bytes, and data segment must be within 2G of the text segment.
6191 Pointers are 64 bits.
6192
6193 @item -mcmodel=medany
6194 @opindex mcmodel=medany
6195 Generate code for the Medium/Anywhere code model: the program may be linked
6196 anywhere in the address space, the text segment must be less than
6197 2G bytes, and data segment must be within 2G of the text segment.
6198 Pointers are 64 bits.
6199
6200 @item -mcmodel=embmedany
6201 @opindex mcmodel=embmedany
6202 Generate code for the Medium/Anywhere code model for embedded systems:
6203 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6204 (determined at link time).  Register %g4 points to the base of the
6205 data segment.  Pointers are still 64 bits.
6206 Programs are statically linked, PIC is not supported.
6207
6208 @item -mstack-bias
6209 @itemx -mno-stack-bias
6210 @opindex mstack-bias
6211 @opindex mno-stack-bias
6212 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6213 frame pointer if present, are offset by @minus{}2047 which must be added back
6214 when making stack frame references.
6215 Otherwise, assume no such offset is present.
6216 @end table
6217
6218 @node ARM Options
6219 @subsection ARM Options
6220 @cindex ARM options
6221
6222 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6223 architectures:
6224
6225 @table @gcctabopt
6226 @item -mapcs-frame
6227 @opindex mapcs-frame
6228 Generate a stack frame that is compliant with the ARM Procedure Call
6229 Standard for all functions, even if this is not strictly necessary for
6230 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6231 with this option will cause the stack frames not to be generated for
6232 leaf functions.  The default is @option{-mno-apcs-frame}.
6233
6234 @item -mapcs
6235 @opindex mapcs
6236 This is a synonym for @option{-mapcs-frame}.
6237
6238 @item -mapcs-26
6239 @opindex mapcs-26
6240 Generate code for a processor running with a 26-bit program counter,
6241 and conforming to the function calling standards for the APCS 26-bit
6242 option.  This option replaces the @option{-m2} and @option{-m3} options
6243 of previous releases of the compiler.
6244
6245 @item -mapcs-32
6246 @opindex mapcs-32
6247 Generate code for a processor running with a 32-bit program counter,
6248 and conforming to the function calling standards for the APCS 32-bit
6249 option.  This option replaces the @option{-m6} option of previous releases
6250 of the compiler.
6251
6252 @ignore
6253 @c not currently implemented
6254 @item -mapcs-stack-check
6255 @opindex mapcs-stack-check
6256 Generate code to check the amount of stack space available upon entry to
6257 every function (that actually uses some stack space).  If there is
6258 insufficient space available then either the function
6259 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6260 called, depending upon the amount of stack space required.  The run time
6261 system is required to provide these functions.  The default is
6262 @option{-mno-apcs-stack-check}, since this produces smaller code.
6263
6264 @c not currently implemented
6265 @item -mapcs-float
6266 @opindex mapcs-float
6267 Pass floating point arguments using the float point registers.  This is
6268 one of the variants of the APCS@.  This option is recommended if the
6269 target hardware has a floating point unit or if a lot of floating point
6270 arithmetic is going to be performed by the code.  The default is
6271 @option{-mno-apcs-float}, since integer only code is slightly increased in
6272 size if @option{-mapcs-float} is used.
6273
6274 @c not currently implemented
6275 @item -mapcs-reentrant
6276 @opindex mapcs-reentrant
6277 Generate reentrant, position independent code.  The default is
6278 @option{-mno-apcs-reentrant}.
6279 @end ignore
6280
6281 @item -mthumb-interwork
6282 @opindex mthumb-interwork
6283 Generate code which supports calling between the ARM and Thumb
6284 instruction sets.  Without this option the two instruction sets cannot
6285 be reliably used inside one program.  The default is
6286 @option{-mno-thumb-interwork}, since slightly larger code is generated
6287 when @option{-mthumb-interwork} is specified.
6288
6289 @item -mno-sched-prolog
6290 @opindex mno-sched-prolog
6291 Prevent the reordering of instructions in the function prolog, or the
6292 merging of those instruction with the instructions in the function's
6293 body.  This means that all functions will start with a recognizable set
6294 of instructions (or in fact one of a choice from a small set of
6295 different function prologues), and this information can be used to
6296 locate the start if functions inside an executable piece of code.  The
6297 default is @option{-msched-prolog}.
6298
6299 @item -mhard-float
6300 @opindex mhard-float
6301 Generate output containing floating point instructions.  This is the
6302 default.
6303
6304 @item -msoft-float
6305 @opindex msoft-float
6306 Generate output containing library calls for floating point.
6307 @strong{Warning:} the requisite libraries are not available for all ARM
6308 targets.  Normally the facilities of the machine's usual C compiler are
6309 used, but this cannot be done directly in cross-compilation.  You must make
6310 your own arrangements to provide suitable library functions for
6311 cross-compilation.
6312
6313 @option{-msoft-float} changes the calling convention in the output file;
6314 therefore, it is only useful if you compile @emph{all} of a program with
6315 this option.  In particular, you need to compile @file{libgcc.a}, the
6316 library that comes with GCC, with @option{-msoft-float} in order for
6317 this to work.
6318
6319 @item -mlittle-endian
6320 @opindex mlittle-endian
6321 Generate code for a processor running in little-endian mode.  This is
6322 the default for all standard configurations.
6323
6324 @item -mbig-endian
6325 @opindex mbig-endian
6326 Generate code for a processor running in big-endian mode; the default is
6327 to compile code for a little-endian processor.
6328
6329 @item -mwords-little-endian
6330 @opindex mwords-little-endian
6331 This option only applies when generating code for big-endian processors.
6332 Generate code for a little-endian word order but a big-endian byte
6333 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6334 option should only be used if you require compatibility with code for
6335 big-endian ARM processors generated by versions of the compiler prior to
6336 2.8.
6337
6338 @item -malignment-traps
6339 @opindex malignment-traps
6340 Generate code that will not trap if the MMU has alignment traps enabled.
6341 On ARM architectures prior to ARMv4, there were no instructions to
6342 access half-word objects stored in memory.  However, when reading from
6343 memory a feature of the ARM architecture allows a word load to be used,
6344 even if the address is unaligned, and the processor core will rotate the
6345 data as it is being loaded.  This option tells the compiler that such
6346 misaligned accesses will cause a MMU trap and that it should instead
6347 synthesize the access as a series of byte accesses.  The compiler can
6348 still use word accesses to load half-word data if it knows that the
6349 address is aligned to a word boundary.
6350
6351 This option is ignored when compiling for ARM architecture 4 or later,
6352 since these processors have instructions to directly access half-word
6353 objects in memory.
6354
6355 @item -mno-alignment-traps
6356 @opindex mno-alignment-traps
6357 Generate code that assumes that the MMU will not trap unaligned
6358 accesses.  This produces better code when the target instruction set
6359 does not have half-word memory operations (i.e.@: implementations prior to
6360 ARMv4).
6361
6362 Note that you cannot use this option to access unaligned word objects,
6363 since the processor will only fetch one 32-bit aligned object from
6364 memory.
6365
6366 The default setting for most targets is @option{-mno-alignment-traps}, since
6367 this produces better code when there are no half-word memory
6368 instructions available.
6369
6370 @item -mshort-load-bytes
6371 @itemx -mno-short-load-words
6372 @opindex mshort-load-bytes
6373 @opindex mno-short-load-words
6374 These are deprecated aliases for @option{-malignment-traps}.
6375
6376 @item -mno-short-load-bytes
6377 @itemx -mshort-load-words
6378 @opindex mno-short-load-bytes
6379 @opindex mshort-load-words
6380 This are deprecated aliases for @option{-mno-alignment-traps}.
6381
6382 @item -mcpu=@var{name}
6383 @opindex mcpu
6384 This specifies the name of the target ARM processor.  GCC uses this name
6385 to determine what kind of instructions it can emit when generating
6386 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6387 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6388 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6389 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6390 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6391 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6392 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6393 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6394 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6395 @samp{arm1020t}, @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
6396
6397 @itemx -mtune=@var{name}
6398 @opindex mtune
6399 This option is very similar to the @option{-mcpu=} option, except that
6400 instead of specifying the actual target processor type, and hence
6401 restricting which instructions can be used, it specifies that GCC should
6402 tune the performance of the code as if the target were of the type
6403 specified in this option, but still choosing the instructions that it
6404 will generate based on the cpu specified by a @option{-mcpu=} option.
6405 For some ARM implementations better performance can be obtained by using
6406 this option.
6407
6408 @item -march=@var{name}
6409 @opindex march
6410 This specifies the name of the target ARM architecture.  GCC uses this
6411 name to determine what kind of instructions it can emit when generating
6412 assembly code.  This option can be used in conjunction with or instead
6413 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6414 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6415 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{iwmmxt}, @samp{ep9312}.
6416
6417 @item -mfpe=@var{number}
6418 @itemx -mfp=@var{number}
6419 @opindex mfpe
6420 @opindex mfp
6421 This specifies the version of the floating point emulation available on
6422 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6423 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6424
6425 @item -mstructure-size-boundary=@var{n}
6426 @opindex mstructure-size-boundary
6427 The size of all structures and unions will be rounded up to a multiple
6428 of the number of bits set by this option.  Permissible values are 8 and
6429 32.  The default value varies for different toolchains.  For the COFF
6430 targeted toolchain the default value is 8.  Specifying the larger number
6431 can produce faster, more efficient code, but can also increase the size
6432 of the program.  The two values are potentially incompatible.  Code
6433 compiled with one value cannot necessarily expect to work with code or
6434 libraries compiled with the other value, if they exchange information
6435 using structures or unions.
6436
6437 @item -mabort-on-noreturn
6438 @opindex mabort-on-noreturn
6439 Generate a call to the function @code{abort} at the end of a
6440 @code{noreturn} function.  It will be executed if the function tries to
6441 return.
6442
6443 @item -mlong-calls
6444 @itemx -mno-long-calls
6445 @opindex mlong-calls
6446 @opindex mno-long-calls
6447 Tells the compiler to perform function calls by first loading the
6448 address of the function into a register and then performing a subroutine
6449 call on this register.  This switch is needed if the target function
6450 will lie outside of the 64 megabyte addressing range of the offset based
6451 version of subroutine call instruction.
6452
6453 Even if this switch is enabled, not all function calls will be turned
6454 into long calls.  The heuristic is that static functions, functions
6455 which have the @samp{short-call} attribute, functions that are inside
6456 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6457 definitions have already been compiled within the current compilation
6458 unit, will not be turned into long calls.  The exception to this rule is
6459 that weak function definitions, functions with the @samp{long-call}
6460 attribute or the @samp{section} attribute, and functions that are within
6461 the scope of a @samp{#pragma long_calls} directive, will always be
6462 turned into long calls.
6463
6464 This feature is not enabled by default.  Specifying
6465 @option{-mno-long-calls} will restore the default behavior, as will
6466 placing the function calls within the scope of a @samp{#pragma
6467 long_calls_off} directive.  Note these switches have no effect on how
6468 the compiler generates code to handle function calls via function
6469 pointers.
6470
6471 @item -mnop-fun-dllimport
6472 @opindex mnop-fun-dllimport
6473 Disable support for the @code{dllimport} attribute.
6474
6475 @item -msingle-pic-base
6476 @opindex msingle-pic-base
6477 Treat the register used for PIC addressing as read-only, rather than
6478 loading it in the prologue for each function.  The run-time system is
6479 responsible for initializing this register with an appropriate value
6480 before execution begins.
6481
6482 @item -mpic-register=@var{reg}
6483 @opindex mpic-register
6484 Specify the register to be used for PIC addressing.  The default is R10
6485 unless stack-checking is enabled, when R9 is used.
6486
6487 @item -mcirrus-fix-invalid-insns
6488 @opindex mcirrus-fix-invalid-insns
6489 @opindex mno-cirrus-fix-invalid-insns
6490 Insert NOPs into the instruction stream to in order to work around
6491 problems with invalid Maverick instruction combinations.  This option
6492 is only valid if the @option{-mcpu=ep9312} option has been used to
6493 enable generation of instructions for the Cirrus Maverick floating
6494 point co-processor.  This option is not enabled by default, since the
6495 problem is only present in older Maverick implementations.  The default
6496 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6497 switch.
6498
6499 @item -mpoke-function-name
6500 @opindex mpoke-function-name
6501 Write the name of each function into the text section, directly
6502 preceding the function prologue.  The generated code is similar to this:
6503
6504 @smallexample
6505      t0
6506          .ascii "arm_poke_function_name", 0
6507          .align
6508      t1
6509          .word 0xff000000 + (t1 - t0)
6510      arm_poke_function_name
6511          mov     ip, sp
6512          stmfd   sp!, @{fp, ip, lr, pc@}
6513          sub     fp, ip, #4
6514 @end smallexample
6515
6516 When performing a stack backtrace, code can inspect the value of
6517 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6518 location @code{pc - 12} and the top 8 bits are set, then we know that
6519 there is a function name embedded immediately preceding this location
6520 and has length @code{((pc[-3]) & 0xff000000)}.
6521
6522 @item -mthumb
6523 @opindex mthumb
6524 Generate code for the 16-bit Thumb instruction set.  The default is to
6525 use the 32-bit ARM instruction set.
6526
6527 @item -mtpcs-frame
6528 @opindex mtpcs-frame
6529 Generate a stack frame that is compliant with the Thumb Procedure Call
6530 Standard for all non-leaf functions.  (A leaf function is one that does
6531 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6532
6533 @item -mtpcs-leaf-frame
6534 @opindex mtpcs-leaf-frame
6535 Generate a stack frame that is compliant with the Thumb Procedure Call
6536 Standard for all leaf functions.  (A leaf function is one that does
6537 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6538
6539 @item -mcallee-super-interworking
6540 @opindex mcallee-super-interworking
6541 Gives all externally visible functions in the file being compiled an ARM
6542 instruction set header which switches to Thumb mode before executing the
6543 rest of the function.  This allows these functions to be called from
6544 non-interworking code.
6545
6546 @item -mcaller-super-interworking
6547 @opindex mcaller-super-interworking
6548 Allows calls via function pointers (including virtual functions) to
6549 execute correctly regardless of whether the target code has been
6550 compiled for interworking or not.  There is a small overhead in the cost
6551 of executing a function pointer if this option is enabled.
6552
6553 @end table
6554
6555 @node MN10200 Options
6556 @subsection MN10200 Options
6557 @cindex MN10200 options
6558
6559 These @option{-m} options are defined for Matsushita MN10200 architectures:
6560 @table @gcctabopt
6561
6562 @item -mrelax
6563 @opindex mrelax
6564 Indicate to the linker that it should perform a relaxation optimization pass
6565 to shorten branches, calls and absolute memory addresses.  This option only
6566 has an effect when used on the command line for the final link step.
6567
6568 This option makes symbolic debugging impossible.
6569 @end table
6570
6571 @node MN10300 Options
6572 @subsection MN10300 Options
6573 @cindex MN10300 options
6574
6575 These @option{-m} options are defined for Matsushita MN10300 architectures:
6576
6577 @table @gcctabopt
6578 @item -mmult-bug
6579 @opindex mmult-bug
6580 Generate code to avoid bugs in the multiply instructions for the MN10300
6581 processors.  This is the default.
6582
6583 @item -mno-mult-bug
6584 @opindex mno-mult-bug
6585 Do not generate code to avoid bugs in the multiply instructions for the
6586 MN10300 processors.
6587
6588 @item -mam33
6589 @opindex mam33
6590 Generate code which uses features specific to the AM33 processor.
6591
6592 @item -mno-am33
6593 @opindex mno-am33
6594 Do not generate code which uses features specific to the AM33 processor.  This
6595 is the default.
6596
6597 @item -mno-crt0
6598 @opindex mno-crt0
6599 Do not link in the C run-time initialization object file.
6600
6601 @item -mrelax
6602 @opindex mrelax
6603 Indicate to the linker that it should perform a relaxation optimization pass
6604 to shorten branches, calls and absolute memory addresses.  This option only
6605 has an effect when used on the command line for the final link step.
6606
6607 This option makes symbolic debugging impossible.
6608 @end table
6609
6610
6611 @node M32R/D Options
6612 @subsection M32R/D Options
6613 @cindex M32R/D options
6614
6615 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6616
6617 @table @gcctabopt
6618 @item -m32rx
6619 @opindex m32rx
6620 Generate code for the M32R/X@.
6621
6622 @item -m32r
6623 @opindex m32r
6624 Generate code for the M32R@.  This is the default.
6625
6626 @item -mcode-model=small
6627 @opindex mcode-model=small
6628 Assume all objects live in the lower 16MB of memory (so that their addresses
6629 can be loaded with the @code{ld24} instruction), and assume all subroutines
6630 are reachable with the @code{bl} instruction.
6631 This is the default.
6632
6633 The addressability of a particular object can be set with the
6634 @code{model} attribute.
6635
6636 @item -mcode-model=medium
6637 @opindex mcode-model=medium
6638 Assume objects may be anywhere in the 32-bit address space (the compiler
6639 will generate @code{seth/add3} instructions to load their addresses), and
6640 assume all subroutines are reachable with the @code{bl} instruction.
6641
6642 @item -mcode-model=large
6643 @opindex mcode-model=large
6644 Assume objects may be anywhere in the 32-bit address space (the compiler
6645 will generate @code{seth/add3} instructions to load their addresses), and
6646 assume subroutines may not be reachable with the @code{bl} instruction
6647 (the compiler will generate the much slower @code{seth/add3/jl}
6648 instruction sequence).
6649
6650 @item -msdata=none
6651 @opindex msdata=none
6652 Disable use of the small data area.  Variables will be put into
6653 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6654 @code{section} attribute has been specified).
6655 This is the default.
6656
6657 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6658 Objects may be explicitly put in the small data area with the
6659 @code{section} attribute using one of these sections.
6660
6661 @item -msdata=sdata
6662 @opindex msdata=sdata
6663 Put small global and static data in the small data area, but do not
6664 generate special code to reference them.
6665
6666 @item -msdata=use
6667 @opindex msdata=use
6668 Put small global and static data in the small data area, and generate
6669 special instructions to reference them.
6670
6671 @item -G @var{num}
6672 @opindex G
6673 @cindex smaller data references
6674 Put global and static objects less than or equal to @var{num} bytes
6675 into the small data or bss sections instead of the normal data or bss
6676 sections.  The default value of @var{num} is 8.
6677 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6678 for this option to have any effect.
6679
6680 All modules should be compiled with the same @option{-G @var{num}} value.
6681 Compiling with different values of @var{num} may or may not work; if it
6682 doesn't the linker will give an error message---incorrect code will not be
6683 generated.
6684
6685 @end table
6686
6687 @node M88K Options
6688 @subsection M88K Options
6689 @cindex M88k options
6690
6691 These @samp{-m} options are defined for Motorola 88k architectures:
6692
6693 @table @gcctabopt
6694 @item -m88000
6695 @opindex m88000
6696 Generate code that works well on both the m88100 and the
6697 m88110.
6698
6699 @item -m88100
6700 @opindex m88100
6701 Generate code that works best for the m88100, but that also
6702 runs on the m88110.
6703
6704 @item -m88110
6705 @opindex m88110
6706 Generate code that works best for the m88110, and may not run
6707 on the m88100.
6708
6709 @item -mbig-pic
6710 @opindex mbig-pic
6711 Obsolete option to be removed from the next revision.
6712 Use @option{-fPIC}.
6713
6714 @item -midentify-revision
6715 @opindex midentify-revision
6716 @cindex identifying source, compiler (88k)
6717 Include an @code{ident} directive in the assembler output recording the
6718 source file name, compiler name and version, timestamp, and compilation
6719 flags used.
6720
6721 @item -mno-underscores
6722 @opindex mno-underscores
6723 @cindex underscores, avoiding (88k)
6724 In assembler output, emit symbol names without adding an underscore
6725 character at the beginning of each name.  The default is to use an
6726 underscore as prefix on each name.
6727
6728 @item -mocs-debug-info
6729 @itemx -mno-ocs-debug-info
6730 @opindex mocs-debug-info
6731 @opindex mno-ocs-debug-info
6732 @cindex OCS (88k)
6733 @cindex debugging, 88k OCS
6734 Include (or omit) additional debugging information (about registers used
6735 in each stack frame) as specified in the 88open Object Compatibility
6736 Standard, ``OCS''@.  This extra information allows debugging of code that
6737 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6738 SVr3.2 is to include this information; other 88k configurations omit this
6739 information by default.
6740
6741 @item -mocs-frame-position
6742 @opindex mocs-frame-position
6743 @cindex register positions in frame (88k)
6744 When emitting COFF debugging information for automatic variables and
6745 parameters stored on the stack, use the offset from the canonical frame
6746 address, which is the stack pointer (register 31) on entry to the
6747 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6748 @option{-mocs-frame-position}; other 88k configurations have the default
6749 @option{-mno-ocs-frame-position}.
6750
6751 @item -mno-ocs-frame-position
6752 @opindex mno-ocs-frame-position
6753 @cindex register positions in frame (88k)
6754 When emitting COFF debugging information for automatic variables and
6755 parameters stored on the stack, use the offset from the frame pointer
6756 register (register 30).  When this option is in effect, the frame
6757 pointer is not eliminated when debugging information is selected by the
6758 -g switch.
6759
6760 @item -moptimize-arg-area
6761 @opindex moptimize-arg-area
6762 @cindex arguments in frame (88k)
6763 Save space by reorganizing the stack frame.  This option generates code
6764 that does not agree with the 88open specifications, but uses less
6765 memory.
6766
6767 @itemx -mno-optimize-arg-area
6768 @opindex mno-optimize-arg-area
6769 Do not reorganize the stack frame to save space.  This is the default.
6770 The generated conforms to the specification, but uses more memory.
6771
6772 @item -mshort-data-@var{num}
6773 @opindex mshort-data
6774 @cindex smaller data references (88k)
6775 @cindex r0-relative references (88k)
6776 Generate smaller data references by making them relative to @code{r0},
6777 which allows loading a value using a single instruction (rather than the
6778 usual two).  You control which data references are affected by
6779 specifying @var{num} with this option.  For example, if you specify
6780 @option{-mshort-data-512}, then the data references affected are those
6781 involving displacements of less than 512 bytes.
6782 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6783 than 64k.
6784
6785 @item -mserialize-volatile
6786 @opindex mserialize-volatile
6787 @itemx -mno-serialize-volatile
6788 @opindex mno-serialize-volatile
6789 @cindex sequential consistency on 88k
6790 Do, or don't, generate code to guarantee sequential consistency
6791 of volatile memory references.  By default, consistency is
6792 guaranteed.
6793
6794 The order of memory references made by the MC88110 processor does
6795 not always match the order of the instructions requesting those
6796 references.  In particular, a load instruction may execute before
6797 a preceding store instruction.  Such reordering violates
6798 sequential consistency of volatile memory references, when there
6799 are multiple processors.   When consistency must be guaranteed,
6800 GCC generates special instructions, as needed, to force
6801 execution in the proper order.
6802
6803 The MC88100 processor does not reorder memory references and so
6804 always provides sequential consistency.  However, by default, GCC
6805 generates the special instructions to guarantee consistency
6806 even when you use @option{-m88100}, so that the code may be run on an
6807 MC88110 processor.  If you intend to run your code only on the
6808 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6809
6810 The extra code generated to guarantee consistency may affect the
6811 performance of your application.  If you know that you can safely
6812 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6813
6814 @item -msvr4
6815 @itemx -msvr3
6816 @opindex msvr4
6817 @opindex msvr3
6818 @cindex assembler syntax, 88k
6819 @cindex SVr4
6820 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6821 related to System V release 4 (SVr4).  This controls the following:
6822
6823 @enumerate
6824 @item
6825 Which variant of the assembler syntax to emit.
6826 @item
6827 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6828 that is used on System V release 4.
6829 @item
6830 @option{-msvr4} makes GCC issue additional declaration directives used in
6831 SVr4.
6832 @end enumerate
6833
6834 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6835 @option{-msvr3} is the default for all other m88k configurations.
6836
6837 @item -mversion-03.00
6838 @opindex mversion-03.00
6839 This option is obsolete, and is ignored.
6840 @c ??? which asm syntax better for GAS?  option there too?
6841
6842 @item -mno-check-zero-division
6843 @itemx -mcheck-zero-division
6844 @opindex mno-check-zero-division
6845 @opindex mcheck-zero-division
6846 @cindex zero division on 88k
6847 Do, or don't, generate code to guarantee that integer division by
6848 zero will be detected.  By default, detection is guaranteed.
6849
6850 Some models of the MC88100 processor fail to trap upon integer
6851 division by zero under certain conditions.  By default, when
6852 compiling code that might be run on such a processor, GCC
6853 generates code that explicitly checks for zero-valued divisors
6854 and traps with exception number 503 when one is detected.  Use of
6855 @option{-mno-check-zero-division} suppresses such checking for code
6856 generated to run on an MC88100 processor.
6857
6858 GCC assumes that the MC88110 processor correctly detects all instances
6859 of integer division by zero.  When @option{-m88110} is specified, no
6860 explicit checks for zero-valued divisors are generated, and both
6861 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6862 ignored.
6863
6864 @item -muse-div-instruction
6865 @opindex muse-div-instruction
6866 @cindex divide instruction, 88k
6867 Use the div instruction for signed integer division on the
6868 MC88100 processor.  By default, the div instruction is not used.
6869
6870 On the MC88100 processor the signed integer division instruction
6871 div) traps to the operating system on a negative operand.  The
6872 operating system transparently completes the operation, but at a
6873 large cost in execution time.  By default, when compiling code
6874 that might be run on an MC88100 processor, GCC emulates signed
6875 integer division using the unsigned integer division instruction
6876 divu), thereby avoiding the large penalty of a trap to the
6877 operating system.  Such emulation has its own, smaller, execution
6878 cost in both time and space.  To the extent that your code's
6879 important signed integer division operations are performed on two
6880 nonnegative operands, it may be desirable to use the div
6881 instruction directly.
6882
6883 On the MC88110 processor the div instruction (also known as the
6884 divs instruction) processes negative operands without trapping to
6885 the operating system.  When @option{-m88110} is specified,
6886 @option{-muse-div-instruction} is ignored, and the div instruction is used
6887 for signed integer division.
6888
6889 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6890 particular, the behavior of such a division with and without
6891 @option{-muse-div-instruction} may differ.
6892
6893 @item -mtrap-large-shift
6894 @itemx -mhandle-large-shift
6895 @opindex mtrap-large-shift
6896 @opindex mhandle-large-shift
6897 @cindex bit shift overflow (88k)
6898 @cindex large bit shifts (88k)
6899 Include code to detect bit-shifts of more than 31 bits; respectively,
6900 trap such shifts or emit code to handle them properly.  By default GCC
6901 makes no special provision for large bit shifts.
6902
6903 @item -mwarn-passed-structs
6904 @opindex mwarn-passed-structs
6905 @cindex structure passing (88k)
6906 Warn when a function passes a struct as an argument or result.
6907 Structure-passing conventions have changed during the evolution of the C
6908 language, and are often the source of portability problems.  By default,
6909 GCC issues no such warning.
6910 @end table
6911
6912 @c break page here to avoid unsightly interparagraph stretch.
6913 @c -zw, 2001-8-17
6914 @page
6915
6916 @node RS/6000 and PowerPC Options
6917 @subsection IBM RS/6000 and PowerPC Options
6918 @cindex RS/6000 and PowerPC Options
6919 @cindex IBM RS/6000 and PowerPC Options
6920
6921 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6922 @table @gcctabopt
6923 @item -mpower
6924 @itemx -mno-power
6925 @itemx -mpower2
6926 @itemx -mno-power2
6927 @itemx -mpowerpc
6928 @itemx -mno-powerpc
6929 @itemx -mpowerpc-gpopt
6930 @itemx -mno-powerpc-gpopt
6931 @itemx -mpowerpc-gfxopt
6932 @itemx -mno-powerpc-gfxopt
6933 @itemx -mpowerpc64
6934 @itemx -mno-powerpc64
6935 @opindex mpower
6936 @opindex mno-power
6937 @opindex mpower2
6938 @opindex mno-power2
6939 @opindex mpowerpc
6940 @opindex mno-powerpc
6941 @opindex mpowerpc-gpopt
6942 @opindex mno-powerpc-gpopt
6943 @opindex mpowerpc-gfxopt
6944 @opindex mno-powerpc-gfxopt
6945 @opindex mpowerpc64
6946 @opindex mno-powerpc64
6947 GCC supports two related instruction set architectures for the
6948 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6949 instructions supported by the @samp{rios} chip set used in the original
6950 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6951 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6952 the IBM 4xx microprocessors.
6953
6954 Neither architecture is a subset of the other.  However there is a
6955 large common subset of instructions supported by both.  An MQ
6956 register is included in processors supporting the POWER architecture.
6957
6958 You use these options to specify which instructions are available on the
6959 processor you are using.  The default value of these options is
6960 determined when configuring GCC@.  Specifying the
6961 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6962 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6963 rather than the options listed above.
6964
6965 The @option{-mpower} option allows GCC to generate instructions that
6966 are found only in the POWER architecture and to use the MQ register.
6967 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6968 to generate instructions that are present in the POWER2 architecture but
6969 not the original POWER architecture.
6970
6971 The @option{-mpowerpc} option allows GCC to generate instructions that
6972 are found only in the 32-bit subset of the PowerPC architecture.
6973 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6974 GCC to use the optional PowerPC architecture instructions in the
6975 General Purpose group, including floating-point square root.  Specifying
6976 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6977 use the optional PowerPC architecture instructions in the Graphics
6978 group, including floating-point select.
6979
6980 The @option{-mpowerpc64} option allows GCC to generate the additional
6981 64-bit instructions that are found in the full PowerPC64 architecture
6982 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6983 @option{-mno-powerpc64}.
6984
6985 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6986 will use only the instructions in the common subset of both
6987 architectures plus some special AIX common-mode calls, and will not use
6988 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6989 permits GCC to use any instruction from either architecture and to
6990 allow use of the MQ register; specify this for the Motorola MPC601.
6991
6992 @item -mnew-mnemonics
6993 @itemx -mold-mnemonics
6994 @opindex mnew-mnemonics
6995 @opindex mold-mnemonics
6996 Select which mnemonics to use in the generated assembler code.  With
6997 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6998 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6999 assembler mnemonics defined for the POWER architecture.  Instructions
7000 defined in only one architecture have only one mnemonic; GCC uses that
7001 mnemonic irrespective of which of these options is specified.
7002
7003 GCC defaults to the mnemonics appropriate for the architecture in
7004 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7005 value of these option.  Unless you are building a cross-compiler, you
7006 should normally not specify either @option{-mnew-mnemonics} or
7007 @option{-mold-mnemonics}, but should instead accept the default.
7008
7009 @item -mcpu=@var{cpu_type}
7010 @opindex mcpu
7011 Set architecture type, register usage, choice of mnemonics, and
7012 instruction scheduling parameters for machine type @var{cpu_type}.
7013 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
7014 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
7015 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
7016 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
7017 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
7018 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
7019
7020 @option{-mcpu=common} selects a completely generic processor.  Code
7021 generated under this option will run on any POWER or PowerPC processor.
7022 GCC will use only the instructions in the common subset of both
7023 architectures, and will not use the MQ register.  GCC assumes a generic
7024 processor model for scheduling purposes.
7025
7026 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7027 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7028 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7029 types, with an appropriate, generic processor model assumed for
7030 scheduling purposes.
7031
7032 The other options specify a specific processor.  Code generated under
7033 those options will run best on that processor, and may not run at all on
7034 others.
7035
7036 The @option{-mcpu} options automatically enable or disable other
7037 @option{-m} options as follows:
7038
7039 @table @samp
7040 @item common
7041 @option{-mno-power}, @option{-mno-powerpc}
7042
7043 @item power
7044 @itemx power2
7045 @itemx rios1
7046 @itemx rios2
7047 @itemx rsc
7048 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7049
7050 @item powerpc
7051 @itemx rs64a
7052 @itemx 602
7053 @itemx 603
7054 @itemx 603e
7055 @itemx 604
7056 @itemx 620
7057 @itemx 630
7058 @itemx 740
7059 @itemx 7400
7060 @itemx 7450
7061 @itemx 750
7062 @itemx 505
7063 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7064
7065 @item 601
7066 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7067
7068 @item 403
7069 @itemx 821
7070 @itemx 860
7071 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7072 @end table
7073
7074 @item -mtune=@var{cpu_type}
7075 @opindex mtune
7076 Set the instruction scheduling parameters for machine type
7077 @var{cpu_type}, but do not set the architecture type, register usage, or
7078 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7079 values for @var{cpu_type} are used for @option{-mtune} as for
7080 @option{-mcpu}.  If both are specified, the code generated will use the
7081 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7082 scheduling parameters set by @option{-mtune}.
7083
7084 @item -maltivec
7085 @itemx -mno-altivec
7086 @opindex maltivec
7087 @opindex mno-altivec
7088 These switches enable or disable the use of built-in functions that
7089 allow access to the AltiVec instruction set.  You may also need to set
7090 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7091 enhancements.
7092
7093 @item -mabi=spe
7094 @opindex mabi=spe
7095 Extend the current ABI with SPE ABI extensions.  This does not change
7096 the default ABI, instead it adds the SPE ABI extensions to the current
7097 ABI@.
7098
7099 @item -mabi=no-spe
7100 @opindex mabi=no-spe
7101 Disable Booke SPE ABI extensions for the current ABI.
7102
7103 @item -misel=@var{yes/no}
7104 @itemx -misel
7105 @opindex misel
7106 This switch enables or disables the generation of ISEL instructions.
7107
7108 @item -mspe=@var{yes/no}
7109 @itemx -mspe
7110 @opindex mspe
7111 This switch enables or disables the generation of SPE simd
7112 instructions.
7113
7114 @item -mfloat-gprs=@var{yes/no}
7115 @itemx -mfloat-gprs
7116 @opindex mfloat-gprs
7117 This switch enables or disables the generation of floating point
7118 operations on the general purpose registers for architectures that
7119 support it.  This option is currently only available on the MPC8540.
7120
7121 @item -mfull-toc
7122 @itemx -mno-fp-in-toc
7123 @itemx -mno-sum-in-toc
7124 @itemx -mminimal-toc
7125 @opindex mfull-toc
7126 @opindex mno-fp-in-toc
7127 @opindex mno-sum-in-toc
7128 @opindex mminimal-toc
7129 Modify generation of the TOC (Table Of Contents), which is created for
7130 every executable file.  The @option{-mfull-toc} option is selected by
7131 default.  In that case, GCC will allocate at least one TOC entry for
7132 each unique non-automatic variable reference in your program.  GCC
7133 will also place floating-point constants in the TOC@.  However, only
7134 16,384 entries are available in the TOC@.
7135
7136 If you receive a linker error message that saying you have overflowed
7137 the available TOC space, you can reduce the amount of TOC space used
7138 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7139 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7140 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7141 generate code to calculate the sum of an address and a constant at
7142 run-time instead of putting that sum into the TOC@.  You may specify one
7143 or both of these options.  Each causes GCC to produce very slightly
7144 slower and larger code at the expense of conserving TOC space.
7145
7146 If you still run out of space in the TOC even when you specify both of
7147 these options, specify @option{-mminimal-toc} instead.  This option causes
7148 GCC to make only one TOC entry for every file.  When you specify this
7149 option, GCC will produce code that is slower and larger but which
7150 uses extremely little TOC space.  You may wish to use this option
7151 only on files that contain less frequently executed code.
7152
7153 @item -maix64
7154 @itemx -maix32
7155 @opindex maix64
7156 @opindex maix32
7157 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7158 @code{long} type, and the infrastructure needed to support them.
7159 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7160 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7161 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7162
7163 @item -mxl-call
7164 @itemx -mno-xl-call
7165 @opindex mxl-call
7166 @opindex mno-xl-call
7167 On AIX, pass floating-point arguments to prototyped functions beyond the
7168 register save area (RSA) on the stack in addition to argument FPRs.  The
7169 AIX calling convention was extended but not initially documented to
7170 handle an obscure K&R C case of calling a function that takes the
7171 address of its arguments with fewer arguments than declared.  AIX XL
7172 compilers access floating point arguments which do not fit in the
7173 RSA from the stack when a subroutine is compiled without
7174 optimization.  Because always storing floating-point arguments on the
7175 stack is inefficient and rarely needed, this option is not enabled by
7176 default and only is necessary when calling subroutines compiled by AIX
7177 XL compilers without optimization.
7178
7179 @item -mpe
7180 @opindex mpe
7181 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7182 application written to use message passing with special startup code to
7183 enable the application to run.  The system must have PE installed in the
7184 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7185 must be overridden with the @option{-specs=} option to specify the
7186 appropriate directory location.  The Parallel Environment does not
7187 support threads, so the @option{-mpe} option and the @option{-pthread}
7188 option are incompatible.
7189
7190 @item -malign-natural
7191 @itemx -malign-power
7192 @opindex malign-natural
7193 @opindex malign-power
7194 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7195 @option{-malign-natural} overrides the ABI-defined alignment of larger
7196 types, such as floating-point doubles, on their natural size-based boundary.
7197 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7198 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7199
7200 @item -msoft-float
7201 @itemx -mhard-float
7202 @opindex msoft-float
7203 @opindex mhard-float
7204 Generate code that does not use (uses) the floating-point register set.
7205 Software floating point emulation is provided if you use the
7206 @option{-msoft-float} option, and pass the option to GCC when linking.
7207
7208 @item -mmultiple
7209 @itemx -mno-multiple
7210 @opindex mmultiple
7211 @opindex mno-multiple
7212 Generate code that uses (does not use) the load multiple word
7213 instructions and the store multiple word instructions.  These
7214 instructions are generated by default on POWER systems, and not
7215 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7216 endian PowerPC systems, since those instructions do not work when the
7217 processor is in little endian mode.  The exceptions are PPC740 and
7218 PPC750 which permit the instructions usage in little endian mode.
7219
7220 @item -mstring
7221 @itemx -mno-string
7222 @opindex mstring
7223 @opindex mno-string
7224 Generate code that uses (does not use) the load string instructions
7225 and the store string word instructions to save multiple registers and
7226 do small block moves.  These instructions are generated by default on
7227 POWER systems, and not generated on PowerPC systems.  Do not use
7228 @option{-mstring} on little endian PowerPC systems, since those
7229 instructions do not work when the processor is in little endian mode.
7230 The exceptions are PPC740 and PPC750 which permit the instructions
7231 usage in little endian mode.
7232
7233 @item -mupdate
7234 @itemx -mno-update
7235 @opindex mupdate
7236 @opindex mno-update
7237 Generate code that uses (does not use) the load or store instructions
7238 that update the base register to the address of the calculated memory
7239 location.  These instructions are generated by default.  If you use
7240 @option{-mno-update}, there is a small window between the time that the
7241 stack pointer is updated and the address of the previous frame is
7242 stored, which means code that walks the stack frame across interrupts or
7243 signals may get corrupted data.
7244
7245 @item -mfused-madd
7246 @itemx -mno-fused-madd
7247 @opindex mfused-madd
7248 @opindex mno-fused-madd
7249 Generate code that uses (does not use) the floating point multiply and
7250 accumulate instructions.  These instructions are generated by default if
7251 hardware floating is used.
7252
7253 @item -mno-bit-align
7254 @itemx -mbit-align
7255 @opindex mno-bit-align
7256 @opindex mbit-align
7257 On System V.4 and embedded PowerPC systems do not (do) force structures
7258 and unions that contain bit-fields to be aligned to the base type of the
7259 bit-field.
7260
7261 For example, by default a structure containing nothing but 8
7262 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7263 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7264 the structure would be aligned to a 1 byte boundary and be one byte in
7265 size.
7266
7267 @item -mno-strict-align
7268 @itemx -mstrict-align
7269 @opindex mno-strict-align
7270 @opindex mstrict-align
7271 On System V.4 and embedded PowerPC systems do not (do) assume that
7272 unaligned memory references will be handled by the system.
7273
7274 @item -mrelocatable
7275 @itemx -mno-relocatable
7276 @opindex mrelocatable
7277 @opindex mno-relocatable
7278 On embedded PowerPC systems generate code that allows (does not allow)
7279 the program to be relocated to a different address at runtime.  If you
7280 use @option{-mrelocatable} on any module, all objects linked together must
7281 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7282
7283 @item -mrelocatable-lib
7284 @itemx -mno-relocatable-lib
7285 @opindex mrelocatable-lib
7286 @opindex mno-relocatable-lib
7287 On embedded PowerPC systems generate code that allows (does not allow)
7288 the program to be relocated to a different address at runtime.  Modules
7289 compiled with @option{-mrelocatable-lib} can be linked with either modules
7290 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7291 with modules compiled with the @option{-mrelocatable} options.
7292
7293 @item -mno-toc
7294 @itemx -mtoc
7295 @opindex mno-toc
7296 @opindex mtoc
7297 On System V.4 and embedded PowerPC systems do not (do) assume that
7298 register 2 contains a pointer to a global area pointing to the addresses
7299 used in the program.
7300
7301 @item -mlittle
7302 @itemx -mlittle-endian
7303 @opindex mlittle
7304 @opindex mlittle-endian
7305 On System V.4 and embedded PowerPC systems compile code for the
7306 processor in little endian mode.  The @option{-mlittle-endian} option is
7307 the same as @option{-mlittle}.
7308
7309 @item -mbig
7310 @itemx -mbig-endian
7311 @opindex mbig
7312 @opindex mbig-endian
7313 On System V.4 and embedded PowerPC systems compile code for the
7314 processor in big endian mode.  The @option{-mbig-endian} option is
7315 the same as @option{-mbig}.
7316
7317 @item -mdynamic-no-pic
7318 @opindex mdynamic-no-pic
7319 On Darwin and Mac OS X systems, compile code so that it is not
7320 relocatable, but that its external references are relocatable.  The
7321 resulting code is suitable for applications, but not shared
7322 libraries.
7323
7324 @item -mcall-sysv
7325 @opindex mcall-sysv
7326 On System V.4 and embedded PowerPC systems compile code using calling
7327 conventions that adheres to the March 1995 draft of the System V
7328 Application Binary Interface, PowerPC processor supplement.  This is the
7329 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7330
7331 @item -mcall-sysv-eabi
7332 @opindex mcall-sysv-eabi
7333 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7334
7335 @item -mcall-sysv-noeabi
7336 @opindex mcall-sysv-noeabi
7337 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7338
7339 @item -mcall-solaris
7340 @opindex mcall-solaris
7341 On System V.4 and embedded PowerPC systems compile code for the Solaris
7342 operating system.
7343
7344 @item -mcall-linux
7345 @opindex mcall-linux
7346 On System V.4 and embedded PowerPC systems compile code for the
7347 Linux-based GNU system.
7348
7349 @item -mcall-gnu
7350 @opindex mcall-gnu
7351 On System V.4 and embedded PowerPC systems compile code for the
7352 Hurd-based GNU system.
7353
7354 @item -mcall-netbsd
7355 @opindex mcall-netbsd
7356 On System V.4 and embedded PowerPC systems compile code for the
7357 NetBSD operating system.
7358
7359 @item -maix-struct-return
7360 @opindex maix-struct-return
7361 Return all structures in memory (as specified by the AIX ABI)@.
7362
7363 @item -msvr4-struct-return
7364 @opindex msvr4-struct-return
7365 Return structures smaller than 8 bytes in registers (as specified by the
7366 SVR4 ABI)@.
7367
7368 @item -mabi=altivec
7369 @opindex mabi=altivec
7370 Extend the current ABI with AltiVec ABI extensions.  This does not
7371 change the default ABI, instead it adds the AltiVec ABI extensions to
7372 the current ABI@.
7373
7374 @item -mabi=no-altivec
7375 @opindex mabi=no-altivec
7376 Disable AltiVec ABI extensions for the current ABI.
7377
7378 @item -mprototype
7379 @itemx -mno-prototype
7380 @opindex mprototype
7381 @opindex mno-prototype
7382 On System V.4 and embedded PowerPC systems assume that all calls to
7383 variable argument functions are properly prototyped.  Otherwise, the
7384 compiler must insert an instruction before every non prototyped call to
7385 set or clear bit 6 of the condition code register (@var{CR}) to
7386 indicate whether floating point values were passed in the floating point
7387 registers in case the function takes a variable arguments.  With
7388 @option{-mprototype}, only calls to prototyped variable argument functions
7389 will set or clear the bit.
7390
7391 @item -msim
7392 @opindex msim
7393 On embedded PowerPC systems, assume that the startup module is called
7394 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7395 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7396 configurations.
7397
7398 @item -mmvme
7399 @opindex mmvme
7400 On embedded PowerPC systems, assume that the startup module is called
7401 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7402 @file{libc.a}.
7403
7404 @item -mads
7405 @opindex mads
7406 On embedded PowerPC systems, assume that the startup module is called
7407 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7408 @file{libc.a}.
7409
7410 @item -myellowknife
7411 @opindex myellowknife
7412 On embedded PowerPC systems, assume that the startup module is called
7413 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7414 @file{libc.a}.
7415
7416 @item -mvxworks
7417 @opindex mvxworks
7418 On System V.4 and embedded PowerPC systems, specify that you are
7419 compiling for a VxWorks system.
7420
7421 @item -mwindiss
7422 @opindex mwindiss
7423 Specify that you are compiling for the WindISS simulation environment.
7424
7425 @item -memb
7426 @opindex memb
7427 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7428 header to indicate that @samp{eabi} extended relocations are used.
7429
7430 @item -meabi
7431 @itemx -mno-eabi
7432 @opindex meabi
7433 @opindex mno-eabi
7434 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7435 Embedded Applications Binary Interface (eabi) which is a set of
7436 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7437 means that the stack is aligned to an 8 byte boundary, a function
7438 @code{__eabi} is called to from @code{main} to set up the eabi
7439 environment, and the @option{-msdata} option can use both @code{r2} and
7440 @code{r13} to point to two separate small data areas.  Selecting
7441 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7442 do not call an initialization function from @code{main}, and the
7443 @option{-msdata} option will only use @code{r13} to point to a single
7444 small data area.  The @option{-meabi} option is on by default if you
7445 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7446
7447 @item -msdata=eabi
7448 @opindex msdata=eabi
7449 On System V.4 and embedded PowerPC systems, put small initialized
7450 @code{const} global and static data in the @samp{.sdata2} section, which
7451 is pointed to by register @code{r2}.  Put small initialized
7452 non-@code{const} global and static data in the @samp{.sdata} section,
7453 which is pointed to by register @code{r13}.  Put small uninitialized
7454 global and static data in the @samp{.sbss} section, which is adjacent to
7455 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7456 incompatible with the @option{-mrelocatable} option.  The
7457 @option{-msdata=eabi} option also sets the @option{-memb} option.
7458
7459 @item -msdata=sysv
7460 @opindex msdata=sysv
7461 On System V.4 and embedded PowerPC systems, put small global and static
7462 data in the @samp{.sdata} section, which is pointed to by register
7463 @code{r13}.  Put small uninitialized global and static data in the
7464 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7465 The @option{-msdata=sysv} option is incompatible with the
7466 @option{-mrelocatable} option.
7467
7468 @item -msdata=default
7469 @itemx -msdata
7470 @opindex msdata=default
7471 @opindex msdata
7472 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7473 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7474 same as @option{-msdata=sysv}.
7475
7476 @item -msdata-data
7477 @opindex msdata-data
7478 On System V.4 and embedded PowerPC systems, put small global and static
7479 data in the @samp{.sdata} section.  Put small uninitialized global and
7480 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7481 to address small data however.  This is the default behavior unless
7482 other @option{-msdata} options are used.
7483
7484 @item -msdata=none
7485 @itemx -mno-sdata
7486 @opindex msdata=none
7487 @opindex mno-sdata
7488 On embedded PowerPC systems, put all initialized global and static data
7489 in the @samp{.data} section, and all uninitialized data in the
7490 @samp{.bss} section.
7491
7492 @item -G @var{num}
7493 @opindex G
7494 @cindex smaller data references (PowerPC)
7495 @cindex .sdata/.sdata2 references (PowerPC)
7496 On embedded PowerPC systems, put global and static items less than or
7497 equal to @var{num} bytes into the small data or bss sections instead of
7498 the normal data or bss section.  By default, @var{num} is 8.  The
7499 @option{-G @var{num}} switch is also passed to the linker.
7500 All modules should be compiled with the same @option{-G @var{num}} value.
7501
7502 @item -mregnames
7503 @itemx -mno-regnames
7504 @opindex mregnames
7505 @opindex mno-regnames
7506 On System V.4 and embedded PowerPC systems do (do not) emit register
7507 names in the assembly language output using symbolic forms.
7508
7509 @item -mlongcall
7510 @itemx -mno-longcall
7511 @opindex mlongcall
7512 @opindex mno-longcall
7513 Default to making all function calls via pointers, so that functions
7514 which reside further than 64 megabytes (67,108,864 bytes) from the
7515 current location can be called.  This setting can be overridden by the
7516 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7517
7518 Some linkers are capable of detecting out-of-range calls and generating
7519 glue code on the fly.  On these systems, long calls are unnecessary and
7520 generate slower code.  As of this writing, the AIX linker can do this,
7521 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7522 to the GNU linker for 32-bit PowerPC systems as well.
7523
7524 In the future, we may cause GCC to ignore all longcall specifications
7525 when the linker is known to generate glue.
7526
7527 @item -pthread
7528 @opindex pthread
7529 Adds support for multithreading with the @dfn{pthreads} library.
7530 This option sets flags for both the preprocessor and linker.
7531
7532 @end table
7533
7534 @node Darwin Options
7535 @subsection Darwin Options
7536 @cindex Darwin options
7537
7538 These options are defined for all architectures running the Darwin operating
7539 system.  They are useful for compatibility with other Mac OS compilers.
7540
7541 @table @gcctabopt
7542 @item -all_load    
7543 @opindex all_load   
7544 Loads all members of static archive libraries.
7545 See man ld(1) for more information.
7546
7547 @item -arch_errors_fatal
7548 @opindex arch_errors_fatal
7549 Cause the errors having to do with files that have the wrong architecture
7550 to be fatal.
7551
7552 @item -bind_at_load
7553 @opindex bind_at_load
7554 Causes the output file to be marked such that the dynamic linker will
7555 bind all undefined references when the file is loaded or launched.
7556
7557 @item -bundle     
7558 @opindex bundle
7559 Produce a Mach-o bundle format file.
7560 See man ld(1) for more information.
7561
7562 @item -bundle_loader @var{executable}
7563 @opindex bundle_loader
7564 This specifies the @var{executable} that will be loading the build
7565 output file being linked. See man ld(1) for more information.
7566
7567 @item -allowable_client  @var{client_name}
7568 @item -arch_only
7569
7570 @item -client_name       
7571 @item -compatibility_version
7572 @item -current_version    
7573 @item -dependency-file
7574 @item -dylib_file    
7575 @item -dylinker_install_name
7576 @item -dynamic
7577 @item -dynamiclib   
7578 @item -exported_symbols_list  
7579 @item -filelist
7580 @item -flat_namespace   
7581 @item -force_cpusubtype_ALL
7582 @item -force_flat_namespace   
7583 @item -headerpad_max_install_names
7584 @item -image_base  
7585 @item -init
7586 @item -install_name
7587 @item -keep_private_externs
7588 @item -multi_module
7589 @item -multiply_defined      
7590 @item -multiply_defined_unused      
7591 @item -noall_load  
7592 @item -nomultidefs
7593 @item -noprebind     
7594 @item -noseglinkedit
7595 @item -pagezero_size    
7596 @item -prebind
7597 @item -prebind_all_twolevel_modules
7598 @item -private_bundle
7599 @item -read_only_relocs
7600 @item -sectalign  
7601 @item -sectobjectsymbols    
7602 @item -whyload
7603 @item -seg1addr 
7604 @item -sectcreate
7605 @item -sectobjectsymbols
7606 @item -sectorder
7607 @item -seg_addr_table
7608 @item -seg_addr_table_filename
7609 @item -seglinkedit
7610 @item -segprot   
7611 @item -segs_read_only_addr
7612 @item -segs_read_write_addr
7613 @item -single_module   
7614 @item -static
7615 @item -sub_library
7616 @item -sub_umbrella 
7617 @item -twolevel_namespace
7618 @item -umbrella
7619 @item -undefined
7620 @item -unexported_symbols_list
7621 @item -weak_reference_mismatches
7622 @item -whatsloaded  
7623
7624 @opindex allowable_client
7625 @opindex arch_only    
7626 @opindex client_name
7627 @opindex compatibility_version
7628 @opindex current_version
7629 @opindex dependency-file
7630 @opindex dylib_file
7631 @opindex dylinker_install_name
7632 @opindex dynamic
7633 @opindex dynamiclib
7634 @opindex exported_symbols_list
7635 @opindex filelist  
7636 @opindex flat_namespace    
7637 @opindex force_cpusubtype_ALL
7638 @opindex force_flat_namespace
7639 @opindex headerpad_max_install_names
7640 @opindex image_base
7641 @opindex init     
7642 @opindex install_name
7643 @opindex keep_private_externs
7644 @opindex multi_module   
7645 @opindex multiply_defined
7646 @opindex multiply_defined_unused   
7647 @opindex noall_load  
7648 @opindex nomultidefs   
7649 @opindex noprebind
7650 @opindex noseglinkedit      
7651 @opindex pagezero_size
7652 @opindex prebind
7653 @opindex prebind_all_twolevel_modules
7654 @opindex private_bundle 
7655 @opindex read_only_relocs
7656 @opindex sectalign   
7657 @opindex sectobjectsymbols    
7658 @opindex whyload  
7659 @opindex seg1addr
7660 @opindex sectcreate       
7661 @opindex sectobjectsymbols 
7662 @opindex sectorder     
7663 @opindex seg_addr_table
7664 @opindex seg_addr_table_filename
7665 @opindex seglinkedit
7666 @opindex segprot
7667 @opindex segs_read_only_addr
7668 @opindex segs_read_write_addr
7669 @opindex single_module
7670 @opindex static
7671 @opindex sub_library
7672 @opindex sub_umbrella
7673 @opindex twolevel_namespace
7674 @opindex umbrella
7675 @opindex undefined
7676 @opindex unexported_symbols_list
7677 @opindex weak_reference_mismatches
7678 @opindex whatsloaded
7679
7680 This options are available for Darwin linker. Darwin linker man page
7681 describes them in detail.
7682 @end table
7683
7684
7685 @node RT Options
7686 @subsection IBM RT Options
7687 @cindex RT options
7688 @cindex IBM RT options
7689
7690 These @samp{-m} options are defined for the IBM RT PC:
7691
7692 @table @gcctabopt
7693 @item -min-line-mul
7694 @opindex min-line-mul
7695 Use an in-line code sequence for integer multiplies.  This is the
7696 default.
7697
7698 @item -mcall-lib-mul
7699 @opindex mcall-lib-mul
7700 Call @code{lmul$$} for integer multiples.
7701
7702 @item -mfull-fp-blocks
7703 @opindex mfull-fp-blocks
7704 Generate full-size floating point data blocks, including the minimum
7705 amount of scratch space recommended by IBM@.  This is the default.
7706
7707 @item -mminimum-fp-blocks
7708 @opindex mminimum-fp-blocks
7709 Do not include extra scratch space in floating point data blocks.  This
7710 results in smaller code, but slower execution, since scratch space must
7711 be allocated dynamically.
7712
7713 @cindex @file{stdarg.h} and RT PC
7714 @item -mfp-arg-in-fpregs
7715 @opindex mfp-arg-in-fpregs
7716 Use a calling sequence incompatible with the IBM calling convention in
7717 which floating point arguments are passed in floating point registers.
7718 Note that @code{stdarg.h} will not work with floating point operands
7719 if this option is specified.
7720
7721 @item -mfp-arg-in-gregs
7722 @opindex mfp-arg-in-gregs
7723 Use the normal calling convention for floating point arguments.  This is
7724 the default.
7725
7726 @item -mhc-struct-return
7727 @opindex mhc-struct-return
7728 Return structures of more than one word in memory, rather than in a
7729 register.  This provides compatibility with the MetaWare HighC (hc)
7730 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7731 with the Portable C Compiler (pcc).
7732
7733 @item -mnohc-struct-return
7734 @opindex mnohc-struct-return
7735 Return some structures of more than one word in registers, when
7736 convenient.  This is the default.  For compatibility with the
7737 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7738 option @option{-mhc-struct-return}.
7739 @end table
7740
7741 @node MIPS Options
7742 @subsection MIPS Options
7743 @cindex MIPS options
7744
7745 These @samp{-m} options are defined for the MIPS family of computers:
7746
7747 @table @gcctabopt
7748
7749 @item -march=@var{arch}
7750 @opindex march
7751 Generate code that will run on @var{arch}, which can be the name of a
7752 generic MIPS ISA, or the name of a particular processor.
7753 The ISA names are:
7754 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7755 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7756 The processor names are:
7757 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7758 @samp{m4k},
7759 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7760 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7761 @samp{orion},
7762 @samp{sb1},
7763 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7764 The special value @samp{from-abi} selects the
7765 most compatible architecture for the selected ABI (that is,
7766 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7767
7768 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7769 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7770 @samp{vr} may be written @samp{r}.
7771
7772 GCC defines two macros based on the value of this option.  The first
7773 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7774 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7775 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7776 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7777 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7778
7779 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7780 above.  In other words, it will have the full prefix and will not
7781 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7782 the macro names the resolved architecture (either @samp{"mips1"} or
7783 @samp{"mips3"}).  It names the default architecture when no
7784 @option{-march} option is given.
7785
7786 @item -mtune=@var{arch}
7787 @opindex mtune
7788 Optimize for @var{arch}.  Among other things, this option controls
7789 the way instructions are scheduled, and the perceived cost of arithmetic
7790 operations.  The list of @var{arch} values is the same as for
7791 @option{-march}.
7792
7793 When this option is not used, GCC will optimize for the processor
7794 specified by @option{-march}.  By using @option{-march} and
7795 @option{-mtune} together, it is possible to generate code that will
7796 run on a family of processors, but optimize the code for one
7797 particular member of that family.
7798
7799 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7800 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7801 @samp{-march} ones described above.
7802
7803 @item -mips1
7804 @opindex mips1
7805 Equivalent to @samp{-march=mips1}.
7806
7807 @item -mips2
7808 @opindex mips2
7809 Equivalent to @samp{-march=mips2}.
7810
7811 @item -mips3
7812 @opindex mips3
7813 Equivalent to @samp{-march=mips3}.
7814
7815 @item -mips4
7816 @opindex mips4
7817 Equivalent to @samp{-march=mips4}.
7818
7819 @item -mips32
7820 @opindex mips32
7821 Equivalent to @samp{-march=mips32}.
7822
7823 @item -mips32r2
7824 @opindex mips32r2
7825 Equivalent to @samp{-march=mips32r2}.
7826
7827 @item -mips64
7828 @opindex mips64
7829 Equivalent to @samp{-march=mips64}.
7830
7831 @item -mfused-madd
7832 @itemx -mno-fused-madd
7833 @opindex mfused-madd
7834 @opindex mno-fused-madd
7835 Generate code that uses (does not use) the floating point multiply and
7836 accumulate instructions, when they are available.  These instructions
7837 are generated by default if they are available, but this may be
7838 undesirable if the extra precision causes problems or on certain chips
7839 in the mode where denormals are rounded to zero where denormals
7840 generated by multiply and accumulate instructions cause exceptions
7841 anyway.
7842
7843 @item -mfp32
7844 @opindex mfp32
7845 Assume that floating point registers are 32 bits wide.
7846
7847 @item -mfp64
7848 @opindex mfp64
7849 Assume that floating point registers are 64 bits wide.
7850
7851 @item -mgp32
7852 @opindex mgp32
7853 Assume that general purpose registers are 32 bits wide.
7854
7855 @item -mgp64
7856 @opindex mgp64
7857 Assume that general purpose registers are 64 bits wide.
7858
7859 @item -mint64
7860 @opindex mint64
7861 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7862 explanation of the default, and the width of pointers.
7863
7864 @item -mlong64
7865 @opindex mlong64
7866 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7867 explanation of the default, and the width of pointers.
7868
7869 @item -mlong32
7870 @opindex mlong32
7871 Force long, int, and pointer types to be 32 bits wide.
7872
7873 The default size of ints, longs and pointers depends on the ABI@.  All
7874 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7875 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7876 are the same size as longs, or the same size as integer registers,
7877 whichever is smaller.
7878
7879 @item -mabi=32
7880 @itemx -mabi=o64
7881 @itemx -mabi=n32
7882 @itemx -mabi=64
7883 @itemx -mabi=eabi
7884 @itemx -mabi=meabi
7885 @opindex mabi=32
7886 @opindex mabi=o64
7887 @opindex mabi=n32
7888 @opindex mabi=64
7889 @opindex mabi=eabi
7890 @opindex mabi=meabi
7891 Generate code for the given ABI@.
7892
7893 Note that there are two embedded ABIs: @option{-mabi=eabi}
7894 selects the one defined by Cygnus while @option{-meabi=meabi}
7895 selects the one defined by MIPS@.  Both these ABIs have
7896 32-bit and 64-bit variants.  Normally, GCC will generate
7897 64-bit code when you select a 64-bit architecture, but you
7898 can use @option{-mgp32} to get 32-bit code instead.
7899
7900 @item -mabi-fake-default
7901 @opindex mabi-fake-default
7902 You don't want to know what this option does.  No, really.  I mean
7903 it.  Move on to the next option.
7904
7905 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7906 wants the default set of options to get the root of the multilib tree,
7907 and the shared library SONAMEs without any multilib-indicating
7908 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7909 we want to default to the N32 ABI, while still being binary-compatible
7910 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7911 binary-compatible means shared libraries should have the same SONAMEs,
7912 and libraries should live in the same location.  Having O32 libraries
7913 in a sub-directory named say @file{o32} is not acceptable.
7914
7915 So we trick GCC into believing that O32 is the default ABI, except
7916 that we override the default with some internal command-line
7917 processing magic.  Problem is, if we stopped at that, and you then
7918 created a multilib-aware package that used the output of @command{gcc
7919 -print-multi-lib} to decide which multilibs to build, and how, and
7920 you'd find yourself in an awkward situation when you found out that
7921 some of the options listed ended up mapping to the same multilib, and
7922 none of your libraries was actually built for the multilib that
7923 @option{-print-multi-lib} claims to be the default.  So we added this
7924 option that disables the default switcher, falling back to GCC's
7925 original notion of the default library.  Confused yet?
7926
7927 For short: don't ever use this option, unless you find it in the list
7928 of additional options to be used when building for multilibs, in the
7929 output of @option{gcc -print-multi-lib}.
7930
7931 @item -mmips-as
7932 @opindex mmips-as
7933 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7934 add normal debug information.  This is the default for all
7935 platforms except for the OSF/1 reference platform, using the OSF/rose
7936 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7937 switches are used, the @file{mips-tfile} program will encapsulate the
7938 stabs within MIPS ECOFF@.
7939
7940 @item -mgas
7941 @opindex mgas
7942 Generate code for the GNU assembler.  This is the default on the OSF/1
7943 reference platform, using the OSF/rose object format.  Also, this is
7944 the default if the configure option @option{--with-gnu-as} is used.
7945
7946 @item -msplit-addresses
7947 @itemx -mno-split-addresses
7948 @opindex msplit-addresses
7949 @opindex mno-split-addresses
7950 Generate code to load the high and low parts of address constants separately.
7951 This allows GCC to optimize away redundant loads of the high order
7952 bits of addresses.  This optimization requires GNU as and GNU ld.
7953 This optimization is enabled by default for some embedded targets where
7954 GNU as and GNU ld are standard.
7955
7956 @item -mrnames
7957 @itemx -mno-rnames
7958 @opindex mrnames
7959 @opindex mno-rnames
7960 The @option{-mrnames} switch says to output code using the MIPS software
7961 names for the registers, instead of the hardware names (ie, @var{a0}
7962 instead of @var{$4}).  The only known assembler that supports this option
7963 is the Algorithmics assembler.
7964
7965 @item -mgpopt
7966 @itemx -mno-gpopt
7967 @opindex mgpopt
7968 @opindex mno-gpopt
7969 The @option{-mgpopt} switch says to write all of the data declarations
7970 before the instructions in the text section, this allows the MIPS
7971 assembler to generate one word memory references instead of using two
7972 words for short global or static data items.  This is on by default if
7973 optimization is selected.
7974
7975 @item -mmemcpy
7976 @itemx -mno-memcpy
7977 @opindex mmemcpy
7978 @opindex mno-memcpy
7979 The @option{-mmemcpy} switch makes all block moves call the appropriate
7980 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7981 generating inline code.
7982
7983 @item -mmips-tfile
7984 @itemx -mno-mips-tfile
7985 @opindex mmips-tfile
7986 @opindex mno-mips-tfile
7987 The @option{-mno-mips-tfile} switch causes the compiler not
7988 postprocess the object file with the @file{mips-tfile} program,
7989 after the MIPS assembler has generated it to add debug support.  If
7990 @file{mips-tfile} is not run, then no local variables will be
7991 available to the debugger.  In addition, @file{stage2} and
7992 @file{stage3} objects will have the temporary file names passed to the
7993 assembler embedded in the object file, which means the objects will
7994 not compare the same.  The @option{-mno-mips-tfile} switch should only
7995 be used when there are bugs in the @file{mips-tfile} program that
7996 prevents compilation.
7997
7998 @item -msoft-float
7999 @opindex msoft-float
8000 Generate output containing library calls for floating point.
8001 @strong{Warning:} the requisite libraries are not part of GCC@.
8002 Normally the facilities of the machine's usual C compiler are used, but
8003 this can't be done directly in cross-compilation.  You must make your
8004 own arrangements to provide suitable library functions for
8005 cross-compilation.
8006
8007 @item -mhard-float
8008 @opindex mhard-float
8009 Generate output containing floating point instructions.  This is the
8010 default if you use the unmodified sources.
8011
8012 @item -mabicalls
8013 @itemx -mno-abicalls
8014 @opindex mabicalls
8015 @opindex mno-abicalls
8016 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8017 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8018 position independent code.
8019
8020 @item -mlong-calls
8021 @itemx -mno-long-calls
8022 @opindex mlong-calls
8023 @opindex mno-long-calls
8024 Do all calls with the @samp{JALR} instruction, which requires
8025 loading up a function's address into a register before the call.
8026 You need to use this switch, if you call outside of the current
8027 512 megabyte segment to functions that are not through pointers.
8028
8029 @item -mhalf-pic
8030 @itemx -mno-half-pic
8031 @opindex mhalf-pic
8032 @opindex mno-half-pic
8033 Put pointers to extern references into the data section and load them
8034 up, rather than put the references in the text section.
8035
8036 @item -membedded-pic
8037 @itemx -mno-embedded-pic
8038 @opindex membedded-pic
8039 @opindex mno-embedded-pic
8040 Generate PIC code suitable for some embedded systems.  All calls are
8041 made using PC relative address, and all data is addressed using the $gp
8042 register.  No more than 65536 bytes of global data may be used.  This
8043 requires GNU as and GNU ld which do most of the work.  This currently
8044 only works on targets which use ECOFF; it does not work with ELF@.
8045
8046 @item -membedded-data
8047 @itemx -mno-embedded-data
8048 @opindex membedded-data
8049 @opindex mno-embedded-data
8050 Allocate variables to the read-only data section first if possible, then
8051 next in the small data section if possible, otherwise in data.  This gives
8052 slightly slower code than the default, but reduces the amount of RAM required
8053 when executing, and thus may be preferred for some embedded systems.
8054
8055 @item -muninit-const-in-rodata
8056 @itemx -mno-uninit-const-in-rodata
8057 @opindex muninit-const-in-rodata
8058 @opindex mno-uninit-const-in-rodata
8059 When used together with @option{-membedded-data}, it will always store uninitialized
8060 const variables in the read-only data section.
8061
8062 @item -msingle-float
8063 @itemx -mdouble-float
8064 @opindex msingle-float
8065 @opindex mdouble-float
8066 The @option{-msingle-float} switch tells gcc to assume that the floating
8067 point coprocessor only supports single precision operations, as on the
8068 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8069 double precision operations.  This is the default.
8070
8071 @item -mmad
8072 @itemx -mno-mad
8073 @opindex mmad
8074 @opindex mno-mad
8075 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8076 as on the @samp{r4650} chip.
8077
8078 @item -m4650
8079 @opindex m4650
8080 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8081 @option{-mcpu=r4650}.
8082
8083 @item -mips16
8084 @itemx -mno-mips16
8085 @opindex mips16
8086 @opindex mno-mips16
8087 Enable 16-bit instructions.
8088
8089 @item -mentry
8090 @opindex mentry
8091 Use the entry and exit pseudo ops.  This option can only be used with
8092 @option{-mips16}.
8093
8094 @item -EL
8095 @opindex EL
8096 Compile code for the processor in little endian mode.
8097 The requisite libraries are assumed to exist.
8098
8099 @item -EB
8100 @opindex EB
8101 Compile code for the processor in big endian mode.
8102 The requisite libraries are assumed to exist.
8103
8104 @item -G @var{num}
8105 @opindex G
8106 @cindex smaller data references (MIPS)
8107 @cindex gp-relative references (MIPS)
8108 Put global and static items less than or equal to @var{num} bytes into
8109 the small data or bss sections instead of the normal data or bss
8110 section.  This allows the assembler to emit one word memory reference
8111 instructions based on the global pointer (@var{gp} or @var{$28}),
8112 instead of the normal two words used.  By default, @var{num} is 8 when
8113 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8114 @option{-G @var{num}} switch is also passed to the assembler and linker.
8115 All modules should be compiled with the same @option{-G @var{num}}
8116 value.
8117
8118 @item -nocpp
8119 @opindex nocpp
8120 Tell the MIPS assembler to not run its preprocessor over user
8121 assembler files (with a @samp{.s} suffix) when assembling them.
8122
8123 @item -mfix7000
8124 @opindex mfix7000
8125 Pass an option to gas which will cause nops to be inserted if
8126 the read of the destination register of an mfhi or mflo instruction
8127 occurs in the following two instructions.
8128
8129 @item -no-crt0
8130 @opindex no-crt0
8131 Do not include the default crt0.
8132
8133 @item -mflush-func=@var{func}
8134 @itemx -mno-flush-func
8135 @opindex mflush-func
8136 Specifies the function to call to flush the I and D caches, or to not
8137 call any such function.  If called, the function must take the same
8138 arguments as the common @code{_flush_func()}, that is, the address of the
8139 memory range for which the cache is being flushed, the size of the
8140 memory range, and the number 3 (to flush both caches).  The default
8141 depends on the target gcc was configured for, but commonly is either
8142 @samp{_flush_func} or @samp{__cpu_flush}.
8143
8144 @item -mbranch-likely
8145 @itemx -mno-branch-likely
8146 @opindex mbranch-likely
8147 @opindex mno-branch-likely
8148 Enable or disable use of Branch Likely instructions, regardless of the
8149 default for the selected architecture.  By default, Branch Likely
8150 instructions may be generated if they are supported by the selected
8151 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8152 and processors which implement those architectures; for those, Branch
8153 Likely instructions will not be generated by default because the MIPS32
8154 and MIPS64 architectures specifically deprecate their use.
8155 @end table
8156
8157 @node i386 and x86-64 Options
8158 @subsection Intel 386 and AMD x86-64 Options
8159 @cindex i386 Options
8160 @cindex x86-64 Options
8161 @cindex Intel 386 Options
8162 @cindex AMD x86-64 Options
8163
8164 These @samp{-m} options are defined for the i386 and x86-64 family of
8165 computers:
8166
8167 @table @gcctabopt
8168 @item -mtune=@var{cpu-type}
8169 @opindex mtune
8170 Tune to @var{cpu-type} everything applicable about the generated code, except
8171 for the ABI and the set of available instructions.  The choices for
8172 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8173 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8174 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8175 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8176 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8177 and @samp{c3-2}.
8178
8179 While picking a specific @var{cpu-type} will schedule things appropriately
8180 for that particular chip, the compiler will not generate any code that
8181 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8182 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8183 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8184 AMD chips as opposed to the Intel ones.
8185
8186 @item -march=@var{cpu-type}
8187 @opindex march
8188 Generate instructions for the machine type @var{cpu-type}.  The choices
8189 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8190 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8191
8192 @item -mcpu=@var{cpu-type}
8193 @opindex mcpu
8194 A deprecated synonym for @option{-mtune}.
8195
8196 @item -m386
8197 @itemx -m486
8198 @itemx -mpentium
8199 @itemx -mpentiumpro
8200 @opindex m386
8201 @opindex m486
8202 @opindex mpentium
8203 @opindex mpentiumpro
8204 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8205 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8206 These synonyms are deprecated.
8207
8208 @item -mfpmath=@var{unit}
8209 @opindex march
8210 generate floating point arithmetics for selected unit @var{unit}.  the choices
8211 for @var{unit} are:
8212
8213 @table @samp
8214 @item 387
8215 Use the standard 387 floating point coprocessor present majority of chips and
8216 emulated otherwise.  Code compiled with this option will run almost everywhere.
8217 The temporary results are computed in 80bit precision instead of precision
8218 specified by the type resulting in slightly different results compared to most
8219 of other chips. See @option{-ffloat-store} for more detailed description.
8220
8221 This is the default choice for i386 compiler.
8222
8223 @item sse
8224 Use scalar floating point instructions present in the SSE instruction set.
8225 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8226 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8227 instruction set supports only single precision arithmetics, thus the double and
8228 extended precision arithmetics is still done using 387.  Later version, present
8229 only in Pentium4 and the future AMD x86-64 chips supports double precision
8230 arithmetics too.
8231
8232 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8233 @option{-msse2} switches to enable SSE extensions and make this option
8234 effective.  For x86-64 compiler, these extensions are enabled by default.
8235
8236 The resulting code should be considerably faster in majority of cases and avoid
8237 the numerical instability problems of 387 code, but may break some existing
8238 code that expects temporaries to be 80bit.
8239
8240 This is the default choice for x86-64 compiler.
8241
8242 @item pni
8243 Use all SSE extensions enabled by @option{-msse2} as well as the new
8244 SSE extensions in Prescott New Instructions. @option{-mpni} also
8245 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8246 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8247 @code{mwait}. 
8248
8249 @item sse,387
8250 Attempt to utilize both instruction sets at once.  This effectively double the
8251 amount of available registers and on chips with separate execution units for
8252 387 and SSE the execution resources too.  Use this option with care, as it is
8253 still experimental, because gcc register allocator does not model separate
8254 functional units well resulting in instable performance.
8255 @end table
8256
8257 @item -masm=@var{dialect}
8258 @opindex masm=@var{dialect}
8259 Output asm instructions using selected @var{dialect}. Supported choices are
8260 @samp{intel} or @samp{att} (the default one).
8261
8262 @item -mieee-fp
8263 @itemx -mno-ieee-fp
8264 @opindex mieee-fp
8265 @opindex mno-ieee-fp
8266 Control whether or not the compiler uses IEEE floating point
8267 comparisons.  These handle correctly the case where the result of a
8268 comparison is unordered.
8269
8270 @item -msoft-float
8271 @opindex msoft-float
8272 Generate output containing library calls for floating point.
8273 @strong{Warning:} the requisite libraries are not part of GCC@.
8274 Normally the facilities of the machine's usual C compiler are used, but
8275 this can't be done directly in cross-compilation.  You must make your
8276 own arrangements to provide suitable library functions for
8277 cross-compilation.
8278
8279 On machines where a function returns floating point results in the 80387
8280 register stack, some floating point opcodes may be emitted even if
8281 @option{-msoft-float} is used.
8282
8283 @item -mno-fp-ret-in-387
8284 @opindex mno-fp-ret-in-387
8285 Do not use the FPU registers for return values of functions.
8286
8287 The usual calling convention has functions return values of types
8288 @code{float} and @code{double} in an FPU register, even if there
8289 is no FPU@.  The idea is that the operating system should emulate
8290 an FPU@.
8291
8292 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8293 in ordinary CPU registers instead.
8294
8295 @item -mno-fancy-math-387
8296 @opindex mno-fancy-math-387
8297 Some 387 emulators do not support the @code{sin}, @code{cos} and
8298 @code{sqrt} instructions for the 387.  Specify this option to avoid
8299 generating those instructions.  This option is the default on FreeBSD,
8300 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8301 indicates that the target cpu will always have an FPU and so the
8302 instruction will not need emulation.  As of revision 2.6.1, these
8303 instructions are not generated unless you also use the
8304 @option{-funsafe-math-optimizations} switch.
8305
8306 @item -malign-double
8307 @itemx -mno-align-double
8308 @opindex malign-double
8309 @opindex mno-align-double
8310 Control whether GCC aligns @code{double}, @code{long double}, and
8311 @code{long long} variables on a two word boundary or a one word
8312 boundary.  Aligning @code{double} variables on a two word boundary will
8313 produce code that runs somewhat faster on a @samp{Pentium} at the
8314 expense of more memory.
8315
8316 @strong{Warning:} if you use the @option{-malign-double} switch,
8317 structures containing the above types will be aligned differently than
8318 the published application binary interface specifications for the 386
8319 and will not be binary compatible with structures in code compiled
8320 without that switch.
8321
8322 @item -m96bit-long-double
8323 @item -m128bit-long-double
8324 @opindex m96bit-long-double
8325 @opindex m128bit-long-double
8326 These switches control the size of @code{long double} type. The i386 
8327 application binary interface specifies the size to be 96 bits, 
8328 so @option{-m96bit-long-double} is the default in 32 bit mode.
8329
8330 Modern architectures (Pentium and newer) would prefer @code{long double}
8331 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8332 conforming to the ABI, this would not be possible.  So specifying a 
8333 @option{-m128bit-long-double} will align @code{long double}
8334 to a 16 byte boundary by padding the @code{long double} with an additional
8335 32 bit zero. 
8336
8337 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8338 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8339  
8340 Notice that neither of these options enable any extra precision over the x87
8341 standard of 80 bits for a @code{long double}. 
8342
8343 @strong{Warning:} if you override the default value for your target ABI, the
8344 structures and arrays containing @code{long double} will change their size as
8345 well as function calling convention for function taking @code{long double}
8346 will be modified.  Hence they will not be binary compatible with arrays or
8347 structures in code compiled without that switch.
8348
8349
8350 @item -msvr3-shlib
8351 @itemx -mno-svr3-shlib
8352 @opindex msvr3-shlib
8353 @opindex mno-svr3-shlib
8354 Control whether GCC places uninitialized local variables into the
8355 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8356 into @code{bss}.  These options are meaningful only on System V Release 3.
8357
8358 @item -mrtd
8359 @opindex mrtd
8360 Use a different function-calling convention, in which functions that
8361 take a fixed number of arguments return with the @code{ret} @var{num}
8362 instruction, which pops their arguments while returning.  This saves one
8363 instruction in the caller since there is no need to pop the arguments
8364 there.
8365
8366 You can specify that an individual function is called with this calling
8367 sequence with the function attribute @samp{stdcall}.  You can also
8368 override the @option{-mrtd} option by using the function attribute
8369 @samp{cdecl}.  @xref{Function Attributes}.
8370
8371 @strong{Warning:} this calling convention is incompatible with the one
8372 normally used on Unix, so you cannot use it if you need to call
8373 libraries compiled with the Unix compiler.
8374
8375 Also, you must provide function prototypes for all functions that
8376 take variable numbers of arguments (including @code{printf});
8377 otherwise incorrect code will be generated for calls to those
8378 functions.
8379
8380 In addition, seriously incorrect code will result if you call a
8381 function with too many arguments.  (Normally, extra arguments are
8382 harmlessly ignored.)
8383
8384 @item -mregparm=@var{num}
8385 @opindex mregparm
8386 Control how many registers are used to pass integer arguments.  By
8387 default, no registers are used to pass arguments, and at most 3
8388 registers can be used.  You can control this behavior for a specific
8389 function by using the function attribute @samp{regparm}.
8390 @xref{Function Attributes}.
8391
8392 @strong{Warning:} if you use this switch, and
8393 @var{num} is nonzero, then you must build all modules with the same
8394 value, including any libraries.  This includes the system libraries and
8395 startup modules.
8396
8397 @item -mpreferred-stack-boundary=@var{num}
8398 @opindex mpreferred-stack-boundary
8399 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8400 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8401 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8402 size (@option{-Os}), in which case the default is the minimum correct
8403 alignment (4 bytes for x86, and 8 bytes for x86-64).
8404
8405 On Pentium and PentiumPro, @code{double} and @code{long double} values
8406 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8407 suffer significant run time performance penalties.  On Pentium III, the
8408 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8409 penalties if it is not 16 byte aligned.
8410
8411 To ensure proper alignment of this values on the stack, the stack boundary
8412 must be as aligned as that required by any value stored on the stack.
8413 Further, every function must be generated such that it keeps the stack
8414 aligned.  Thus calling a function compiled with a higher preferred
8415 stack boundary from a function compiled with a lower preferred stack
8416 boundary will most likely misalign the stack.  It is recommended that
8417 libraries that use callbacks always use the default setting.
8418
8419 This extra alignment does consume extra stack space, and generally
8420 increases code size.  Code that is sensitive to stack space usage, such
8421 as embedded systems and operating system kernels, may want to reduce the
8422 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8423
8424 @item -mmmx
8425 @itemx -mno-mmx
8426 @item -msse
8427 @itemx -mno-sse
8428 @item -msse2
8429 @itemx -mno-sse2
8430 @item -mpni
8431 @itemx -mno-pni
8432 @item -m3dnow
8433 @itemx -mno-3dnow
8434 @opindex mmmx
8435 @opindex mno-mmx
8436 @opindex msse
8437 @opindex mno-sse
8438 @opindex m3dnow
8439 @opindex mno-3dnow
8440 These switches enable or disable the use of built-in functions that allow
8441 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8442
8443 @xref{X86 Built-in Functions}, for details of the functions enabled
8444 and disabled by these switches.
8445
8446 To have SSE/SSE2 instructions generated automatically from floating-point
8447 code, see @option{-mfpmath=sse}.
8448
8449 @item -mpush-args
8450 @itemx -mno-push-args
8451 @opindex mpush-args
8452 @opindex mno-push-args
8453 Use PUSH operations to store outgoing parameters.  This method is shorter
8454 and usually equally fast as method using SUB/MOV operations and is enabled
8455 by default.  In some cases disabling it may improve performance because of
8456 improved scheduling and reduced dependencies.
8457
8458 @item -maccumulate-outgoing-args
8459 @opindex maccumulate-outgoing-args
8460 If enabled, the maximum amount of space required for outgoing arguments will be
8461 computed in the function prologue.  This is faster on most modern CPUs
8462 because of reduced dependencies, improved scheduling and reduced stack usage
8463 when preferred stack boundary is not equal to 2.  The drawback is a notable
8464 increase in code size.  This switch implies @option{-mno-push-args}.
8465
8466 @item -mthreads
8467 @opindex mthreads
8468 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8469 on thread-safe exception handling must compile and link all code with the
8470 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8471 @option{-D_MT}; when linking, it links in a special thread helper library
8472 @option{-lmingwthrd} which cleans up per thread exception handling data.
8473
8474 @item -mno-align-stringops
8475 @opindex mno-align-stringops
8476 Do not align destination of inlined string operations.  This switch reduces
8477 code size and improves performance in case the destination is already aligned,
8478 but gcc don't know about it.
8479
8480 @item -minline-all-stringops
8481 @opindex minline-all-stringops
8482 By default GCC inlines string operations only when destination is known to be
8483 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8484 size, but may improve performance of code that depends on fast memcpy, strlen
8485 and memset for short lengths.
8486
8487 @item -momit-leaf-frame-pointer
8488 @opindex momit-leaf-frame-pointer
8489 Don't keep the frame pointer in a register for leaf functions.  This
8490 avoids the instructions to save, set up and restore frame pointers and
8491 makes an extra register available in leaf functions.  The option
8492 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8493 which might make debugging harder.
8494
8495 @item -mtls-direct-seg-refs
8496 @itemx -mno-tls-direct-seg-refs
8497 @opindex mtls-direct-seg-refs
8498 Controls whether TLS variables may be accessed with offsets from the
8499 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8500 or whether the thread base pointer must be added.  Whether or not this
8501 is legal depends on the operating system, and whether it maps the
8502 segment to cover the entire TLS area.
8503
8504 For systems that use GNU libc, the default is on.
8505 @end table
8506
8507 These @samp{-m} switches are supported in addition to the above
8508 on AMD x86-64 processors in 64-bit environments.
8509
8510 @table @gcctabopt
8511 @item -m32
8512 @itemx -m64
8513 @opindex m32
8514 @opindex m64
8515 Generate code for a 32-bit or 64-bit environment.
8516 The 32-bit environment sets int, long and pointer to 32 bits and
8517 generates code that runs on any i386 system.
8518 The 64-bit environment sets int to 32 bits and long and pointer
8519 to 64 bits and generates code for AMD's x86-64 architecture.
8520
8521 @item -mno-red-zone
8522 @opindex no-red-zone
8523 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8524 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8525 stack pointer that will not be modified by signal or interrupt handlers
8526 and therefore can be used for temporary data without adjusting the stack
8527 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8528
8529 @item -mcmodel=small
8530 @opindex mcmodel=small
8531 Generate code for the small code model: the program and its symbols must
8532 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8533 Programs can be statically or dynamically linked.  This is the default
8534 code model.
8535
8536 @item -mcmodel=kernel
8537 @opindex mcmodel=kernel
8538 Generate code for the kernel code model.  The kernel runs in the
8539 negative 2 GB of the address space.
8540 This model has to be used for Linux kernel code.
8541
8542 @item -mcmodel=medium
8543 @opindex mcmodel=medium
8544 Generate code for the medium model: The program is linked in the lower 2
8545 GB of the address space but symbols can be located anywhere in the
8546 address space.  Programs can be statically or dynamically linked, but
8547 building of shared libraries are not supported with the medium model.
8548
8549 @item -mcmodel=large
8550 @opindex mcmodel=large
8551 Generate code for the large model: This model makes no assumptions
8552 about addresses and sizes of sections.  Currently GCC does not implement
8553 this model.
8554 @end table
8555
8556 @node HPPA Options
8557 @subsection HPPA Options
8558 @cindex HPPA Options
8559
8560 These @samp{-m} options are defined for the HPPA family of computers:
8561
8562 @table @gcctabopt
8563 @item -march=@var{architecture-type}
8564 @opindex march
8565 Generate code for the specified architecture.  The choices for
8566 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8567 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8568 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8569 architecture option for your machine.  Code compiled for lower numbered
8570 architectures will run on higher numbered architectures, but not the
8571 other way around.
8572
8573 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8574 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8575 support.
8576
8577 @item -mpa-risc-1-0
8578 @itemx -mpa-risc-1-1
8579 @itemx -mpa-risc-2-0
8580 @opindex mpa-risc-1-0
8581 @opindex mpa-risc-1-1
8582 @opindex mpa-risc-2-0
8583 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8584
8585 @item -mbig-switch
8586 @opindex mbig-switch
8587 Generate code suitable for big switch tables.  Use this option only if
8588 the assembler/linker complain about out of range branches within a switch
8589 table.
8590
8591 @item -mjump-in-delay
8592 @opindex mjump-in-delay
8593 Fill delay slots of function calls with unconditional jump instructions
8594 by modifying the return pointer for the function call to be the target
8595 of the conditional jump.
8596
8597 @item -mdisable-fpregs
8598 @opindex mdisable-fpregs
8599 Prevent floating point registers from being used in any manner.  This is
8600 necessary for compiling kernels which perform lazy context switching of
8601 floating point registers.  If you use this option and attempt to perform
8602 floating point operations, the compiler will abort.
8603
8604 @item -mdisable-indexing
8605 @opindex mdisable-indexing
8606 Prevent the compiler from using indexing address modes.  This avoids some
8607 rather obscure problems when compiling MIG generated code under MACH@.
8608
8609 @item -mno-space-regs
8610 @opindex mno-space-regs
8611 Generate code that assumes the target has no space registers.  This allows
8612 GCC to generate faster indirect calls and use unscaled index address modes.
8613
8614 Such code is suitable for level 0 PA systems and kernels.
8615
8616 @item -mfast-indirect-calls
8617 @opindex mfast-indirect-calls
8618 Generate code that assumes calls never cross space boundaries.  This
8619 allows GCC to emit code which performs faster indirect calls.
8620
8621 This option will not work in the presence of shared libraries or nested
8622 functions.
8623
8624 @item -mlong-load-store
8625 @opindex mlong-load-store
8626 Generate 3-instruction load and store sequences as sometimes required by
8627 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8628 the HP compilers.
8629
8630 @item -mportable-runtime
8631 @opindex mportable-runtime
8632 Use the portable calling conventions proposed by HP for ELF systems.
8633
8634 @item -mgas
8635 @opindex mgas
8636 Enable the use of assembler directives only GAS understands.
8637
8638 @item -mschedule=@var{cpu-type}
8639 @opindex mschedule
8640 Schedule code according to the constraints for the machine type
8641 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8642 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8643 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8644 proper scheduling option for your machine.  The default scheduling is
8645 @samp{8000}.
8646
8647 @item -mlinker-opt
8648 @opindex mlinker-opt
8649 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8650 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8651 linkers in which they give bogus error messages when linking some programs.
8652
8653 @item -msoft-float
8654 @opindex msoft-float
8655 Generate output containing library calls for floating point.
8656 @strong{Warning:} the requisite libraries are not available for all HPPA
8657 targets.  Normally the facilities of the machine's usual C compiler are
8658 used, but this cannot be done directly in cross-compilation.  You must make
8659 your own arrangements to provide suitable library functions for
8660 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8661 does provide software floating point support.
8662
8663 @option{-msoft-float} changes the calling convention in the output file;
8664 therefore, it is only useful if you compile @emph{all} of a program with
8665 this option.  In particular, you need to compile @file{libgcc.a}, the
8666 library that comes with GCC, with @option{-msoft-float} in order for
8667 this to work.
8668
8669 @item -msio
8670 @opindex msio
8671 Generate the predefine, @code{_SIO}, for server IO.  The default is
8672 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8673 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8674 options are available under HP-UX and HI-UX.
8675
8676 @item -mgnu-ld
8677 @opindex gnu-ld
8678 Use GNU ld specific options.  This passes @option{-shared} to ld when
8679 building a shared library.  It is the default when GCC is configured,
8680 explicitly or implicitly, with the GNU linker.  This option does not
8681 have any affect on which ld is called, it only changes what parameters
8682 are passed to that ld.  The ld that is called is determined by the
8683 @option{--with-ld} configure option, gcc's program search path, and
8684 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8685 using @samp{which `gcc -print-prog-name=ld`}.
8686
8687 @item -mhp-ld
8688 @opindex hp-ld
8689 Use HP ld specific options.  This passes @option{-b} to ld when building
8690 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8691 links.  It is the default when GCC is configured, explicitly or
8692 implicitly, with the HP linker.  This option does not have any affect on
8693 which ld is called, it only changes what parameters are passed to that
8694 ld.  The ld that is called is determined by the @option{--with-ld}
8695 configure option, gcc's program search path, and finally by the user's
8696 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8697 `gcc -print-prog-name=ld`}.
8698
8699 @item -mlong-calls
8700 @opindex mno-long-calls
8701 Generate code that uses long call sequences.  This ensures that a call
8702 is always able to reach linker generated stubs.  The default is to generate
8703 long calls only when the distance from the call site to the beginning
8704 of the function or translation unit, as the case may be, exceeds a
8705 predefined limit set by the branch type being used.  The limits for
8706 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8707 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8708 240,000 bytes.
8709
8710 Distances are measured from the beginning of functions when using the
8711 @option{-ffunction-sections} option, or when using the @option{-mgas}
8712 and @option{-mno-portable-runtime} options together under HP-UX with
8713 the SOM linker.
8714
8715 It is normally not desirable to use this option as it will degrade
8716 performance.  However, it may be useful in large applications,
8717 particularly when partial linking is used to build the application.
8718
8719 The types of long calls used depends on the capabilities of the
8720 assembler and linker, and the type of code being generated.  The
8721 impact on systems that support long absolute calls, and long pic
8722 symbol-difference or pc-relative calls should be relatively small.
8723 However, an indirect call is used on 32-bit ELF systems in pic code
8724 and it is quite long.
8725
8726 @item -nolibdld
8727 @opindex nolibdld
8728 Suppress the generation of link options to search libdld.sl when the
8729 @option{-static} option is specified on HP-UX 10 and later.
8730
8731 @item -static
8732 @opindex static
8733 The HP-UX implementation of setlocale in libc has a dependency on
8734 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8735 when the @option{-static} option is specified, special link options
8736 are needed to resolve this dependency.
8737
8738 On HP-UX 10 and later, the GCC driver adds the necessary options to
8739 link with libdld.sl when the @option{-static} option is specified.
8740 This causes the resulting binary to be dynamic.  On the 64-bit port,
8741 the linkers generate dynamic binaries by default in any case.  The
8742 @option{-nolibdld} option can be used to prevent the GCC driver from
8743 adding these link options.
8744
8745 @item -threads
8746 @opindex threads
8747 Add support for multithreading with the @dfn{dce thread} library
8748 under HP-UX.  This option sets flags for both the preprocessor and
8749 linker.
8750 @end table
8751
8752 @node Intel 960 Options
8753 @subsection Intel 960 Options
8754
8755 These @samp{-m} options are defined for the Intel 960 implementations:
8756
8757 @table @gcctabopt
8758 @item -m@var{cpu-type}
8759 @opindex mka
8760 @opindex mkb
8761 @opindex mmc
8762 @opindex mca
8763 @opindex mcf
8764 @opindex msa
8765 @opindex msb
8766 Assume the defaults for the machine type @var{cpu-type} for some of
8767 the other options, including instruction scheduling, floating point
8768 support, and addressing modes.  The choices for @var{cpu-type} are
8769 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8770 @samp{sa}, and @samp{sb}.
8771 The default is
8772 @samp{kb}.
8773
8774 @item -mnumerics
8775 @itemx -msoft-float
8776 @opindex mnumerics
8777 @opindex msoft-float
8778 The @option{-mnumerics} option indicates that the processor does support
8779 floating-point instructions.  The @option{-msoft-float} option indicates
8780 that floating-point support should not be assumed.
8781
8782 @item -mleaf-procedures
8783 @itemx -mno-leaf-procedures
8784 @opindex mleaf-procedures
8785 @opindex mno-leaf-procedures
8786 Do (or do not) attempt to alter leaf procedures to be callable with the
8787 @code{bal} instruction as well as @code{call}.  This will result in more
8788 efficient code for explicit calls when the @code{bal} instruction can be
8789 substituted by the assembler or linker, but less efficient code in other
8790 cases, such as calls via function pointers, or using a linker that doesn't
8791 support this optimization.
8792
8793 @item -mtail-call
8794 @itemx -mno-tail-call
8795 @opindex mtail-call
8796 @opindex mno-tail-call
8797 Do (or do not) make additional attempts (beyond those of the
8798 machine-independent portions of the compiler) to optimize tail-recursive
8799 calls into branches.  You may not want to do this because the detection of
8800 cases where this is not valid is not totally complete.  The default is
8801 @option{-mno-tail-call}.
8802
8803 @item -mcomplex-addr
8804 @itemx -mno-complex-addr
8805 @opindex mcomplex-addr
8806 @opindex mno-complex-addr
8807 Assume (or do not assume) that the use of a complex addressing mode is a
8808 win on this implementation of the i960.  Complex addressing modes may not
8809 be worthwhile on the K-series, but they definitely are on the C-series.
8810 The default is currently @option{-mcomplex-addr} for all processors except
8811 the CB and CC@.
8812
8813 @item -mcode-align
8814 @itemx -mno-code-align
8815 @opindex mcode-align
8816 @opindex mno-code-align
8817 Align code to 8-byte boundaries for faster fetching (or don't bother).
8818 Currently turned on by default for C-series implementations only.
8819
8820 @ignore
8821 @item -mclean-linkage
8822 @itemx -mno-clean-linkage
8823 @opindex mclean-linkage
8824 @opindex mno-clean-linkage
8825 These options are not fully implemented.
8826 @end ignore
8827
8828 @item -mic-compat
8829 @itemx -mic2.0-compat
8830 @itemx -mic3.0-compat
8831 @opindex mic-compat
8832 @opindex mic2.0-compat
8833 @opindex mic3.0-compat
8834 Enable compatibility with iC960 v2.0 or v3.0.
8835
8836 @item -masm-compat
8837 @itemx -mintel-asm
8838 @opindex masm-compat
8839 @opindex mintel-asm
8840 Enable compatibility with the iC960 assembler.
8841
8842 @item -mstrict-align
8843 @itemx -mno-strict-align
8844 @opindex mstrict-align
8845 @opindex mno-strict-align
8846 Do not permit (do permit) unaligned accesses.
8847
8848 @item -mold-align
8849 @opindex mold-align
8850 Enable structure-alignment compatibility with Intel's gcc release version
8851 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8852
8853 @item -mlong-double-64
8854 @opindex mlong-double-64
8855 Implement type @samp{long double} as 64-bit floating point numbers.
8856 Without the option @samp{long double} is implemented by 80-bit
8857 floating point numbers.  The only reason we have it because there is
8858 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8859 is only useful for people using soft-float targets.  Otherwise, we
8860 should recommend against use of it.
8861
8862 @end table
8863
8864 @node DEC Alpha Options
8865 @subsection DEC Alpha Options
8866
8867 These @samp{-m} options are defined for the DEC Alpha implementations:
8868
8869 @table @gcctabopt
8870 @item -mno-soft-float
8871 @itemx -msoft-float
8872 @opindex mno-soft-float
8873 @opindex msoft-float
8874 Use (do not use) the hardware floating-point instructions for
8875 floating-point operations.  When @option{-msoft-float} is specified,
8876 functions in @file{libgcc.a} will be used to perform floating-point
8877 operations.  Unless they are replaced by routines that emulate the
8878 floating-point operations, or compiled in such a way as to call such
8879 emulations routines, these routines will issue floating-point
8880 operations.   If you are compiling for an Alpha without floating-point
8881 operations, you must ensure that the library is built so as not to call
8882 them.
8883
8884 Note that Alpha implementations without floating-point operations are
8885 required to have floating-point registers.
8886
8887 @item -mfp-reg
8888 @itemx -mno-fp-regs
8889 @opindex mfp-reg
8890 @opindex mno-fp-regs
8891 Generate code that uses (does not use) the floating-point register set.
8892 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8893 register set is not used, floating point operands are passed in integer
8894 registers as if they were integers and floating-point results are passed
8895 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8896 so any function with a floating-point argument or return value called by code
8897 compiled with @option{-mno-fp-regs} must also be compiled with that
8898 option.
8899
8900 A typical use of this option is building a kernel that does not use,
8901 and hence need not save and restore, any floating-point registers.
8902
8903 @item -mieee
8904 @opindex mieee
8905 The Alpha architecture implements floating-point hardware optimized for
8906 maximum performance.  It is mostly compliant with the IEEE floating
8907 point standard.  However, for full compliance, software assistance is
8908 required.  This option generates code fully IEEE compliant code
8909 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8910 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8911 defined during compilation.  The resulting code is less efficient but is
8912 able to correctly support denormalized numbers and exceptional IEEE
8913 values such as not-a-number and plus/minus infinity.  Other Alpha
8914 compilers call this option @option{-ieee_with_no_inexact}.
8915
8916 @item -mieee-with-inexact
8917 @opindex mieee-with-inexact
8918 This is like @option{-mieee} except the generated code also maintains
8919 the IEEE @var{inexact-flag}.  Turning on this option causes the
8920 generated code to implement fully-compliant IEEE math.  In addition to
8921 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8922 macro.  On some Alpha implementations the resulting code may execute
8923 significantly slower than the code generated by default.  Since there is
8924 very little code that depends on the @var{inexact-flag}, you should
8925 normally not specify this option.  Other Alpha compilers call this
8926 option @option{-ieee_with_inexact}.
8927
8928 @item -mfp-trap-mode=@var{trap-mode}
8929 @opindex mfp-trap-mode
8930 This option controls what floating-point related traps are enabled.
8931 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8932 The trap mode can be set to one of four values:
8933
8934 @table @samp
8935 @item n
8936 This is the default (normal) setting.  The only traps that are enabled
8937 are the ones that cannot be disabled in software (e.g., division by zero
8938 trap).
8939
8940 @item u
8941 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8942 as well.
8943
8944 @item su
8945 Like @samp{su}, but the instructions are marked to be safe for software
8946 completion (see Alpha architecture manual for details).
8947
8948 @item sui
8949 Like @samp{su}, but inexact traps are enabled as well.
8950 @end table
8951
8952 @item -mfp-rounding-mode=@var{rounding-mode}
8953 @opindex mfp-rounding-mode
8954 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8955 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8956 of:
8957
8958 @table @samp
8959 @item n
8960 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8961 the nearest machine number or towards the even machine number in case
8962 of a tie.
8963
8964 @item m
8965 Round towards minus infinity.
8966
8967 @item c
8968 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8969
8970 @item d
8971 Dynamic rounding mode.  A field in the floating point control register
8972 (@var{fpcr}, see Alpha architecture reference manual) controls the
8973 rounding mode in effect.  The C library initializes this register for
8974 rounding towards plus infinity.  Thus, unless your program modifies the
8975 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8976 @end table
8977
8978 @item -mtrap-precision=@var{trap-precision}
8979 @opindex mtrap-precision
8980 In the Alpha architecture, floating point traps are imprecise.  This
8981 means without software assistance it is impossible to recover from a
8982 floating trap and program execution normally needs to be terminated.
8983 GCC can generate code that can assist operating system trap handlers
8984 in determining the exact location that caused a floating point trap.
8985 Depending on the requirements of an application, different levels of
8986 precisions can be selected:
8987
8988 @table @samp
8989 @item p
8990 Program precision.  This option is the default and means a trap handler
8991 can only identify which program caused a floating point exception.
8992
8993 @item f
8994 Function precision.  The trap handler can determine the function that
8995 caused a floating point exception.
8996
8997 @item i
8998 Instruction precision.  The trap handler can determine the exact
8999 instruction that caused a floating point exception.
9000 @end table
9001
9002 Other Alpha compilers provide the equivalent options called
9003 @option{-scope_safe} and @option{-resumption_safe}.
9004
9005 @item -mieee-conformant
9006 @opindex mieee-conformant
9007 This option marks the generated code as IEEE conformant.  You must not
9008 use this option unless you also specify @option{-mtrap-precision=i} and either
9009 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9010 is to emit the line @samp{.eflag 48} in the function prologue of the
9011 generated assembly file.  Under DEC Unix, this has the effect that
9012 IEEE-conformant math library routines will be linked in.
9013
9014 @item -mbuild-constants
9015 @opindex mbuild-constants
9016 Normally GCC examines a 32- or 64-bit integer constant to
9017 see if it can construct it from smaller constants in two or three
9018 instructions.  If it cannot, it will output the constant as a literal and
9019 generate code to load it from the data segment at runtime.
9020
9021 Use this option to require GCC to construct @emph{all} integer constants
9022 using code, even if it takes more instructions (the maximum is six).
9023
9024 You would typically use this option to build a shared library dynamic
9025 loader.  Itself a shared library, it must relocate itself in memory
9026 before it can find the variables and constants in its own data segment.
9027
9028 @item -malpha-as
9029 @itemx -mgas
9030 @opindex malpha-as
9031 @opindex mgas
9032 Select whether to generate code to be assembled by the vendor-supplied
9033 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9034
9035 @item -mbwx
9036 @itemx -mno-bwx
9037 @itemx -mcix
9038 @itemx -mno-cix
9039 @itemx -mfix
9040 @itemx -mno-fix
9041 @itemx -mmax
9042 @itemx -mno-max
9043 @opindex mbwx
9044 @opindex mno-bwx
9045 @opindex mcix
9046 @opindex mno-cix
9047 @opindex mfix
9048 @opindex mno-fix
9049 @opindex mmax
9050 @opindex mno-max
9051 Indicate whether GCC should generate code to use the optional BWX,
9052 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9053 sets supported by the CPU type specified via @option{-mcpu=} option or that
9054 of the CPU on which GCC was built if none was specified.
9055
9056 @item -mfloat-vax
9057 @itemx -mfloat-ieee
9058 @opindex mfloat-vax
9059 @opindex mfloat-ieee
9060 Generate code that uses (does not use) VAX F and G floating point
9061 arithmetic instead of IEEE single and double precision.
9062
9063 @item -mexplicit-relocs
9064 @itemx -mno-explicit-relocs
9065 @opindex mexplicit-relocs
9066 @opindex mno-explicit-relocs
9067 Older Alpha assemblers provided no way to generate symbol relocations
9068 except via assembler macros.  Use of these macros does not allow
9069 optimal instruction scheduling.  GNU binutils as of version 2.12
9070 supports a new syntax that allows the compiler to explicitly mark
9071 which relocations should apply to which instructions.  This option
9072 is mostly useful for debugging, as GCC detects the capabilities of
9073 the assembler when it is built and sets the default accordingly.
9074
9075 @item -msmall-data
9076 @itemx -mlarge-data
9077 @opindex msmall-data
9078 @opindex mlarge-data
9079 When @option{-mexplicit-relocs} is in effect, static data is
9080 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9081 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9082 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9083 16-bit relocations off of the @code{$gp} register.  This limits the
9084 size of the small data area to 64KB, but allows the variables to be
9085 directly accessed via a single instruction.
9086
9087 The default is @option{-mlarge-data}.  With this option the data area
9088 is limited to just below 2GB.  Programs that require more than 2GB of
9089 data must use @code{malloc} or @code{mmap} to allocate the data in the
9090 heap instead of in the program's data segment.
9091
9092 When generating code for shared libraries, @option{-fpic} implies
9093 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9094
9095 @item -msmall-text
9096 @itemx -mlarge-text
9097 @opindex msmall-text
9098 @opindex mlarge-text
9099 When @option{-msmall-text} is used, the compiler assumes that the
9100 code of the entire program (or shared library) fits in 4MB, and is
9101 thus reachable with a branch instruction.  When @option{-msmall-data}
9102 is used, the compiler can assume that all local symbols share the
9103 same @code{$gp} value, and thus reduce the number of instructions
9104 required for a function call from 4 to 1.
9105
9106 The default is @option{-mlarge-text}.
9107
9108 @item -mcpu=@var{cpu_type}
9109 @opindex mcpu
9110 Set the instruction set and instruction scheduling parameters for
9111 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9112 style name or the corresponding chip number.  GCC supports scheduling
9113 parameters for the EV4, EV5 and EV6 family of processors and will
9114 choose the default values for the instruction set from the processor
9115 you specify.  If you do not specify a processor type, GCC will default
9116 to the processor on which the compiler was built.
9117
9118 Supported values for @var{cpu_type} are
9119
9120 @table @samp
9121 @item ev4
9122 @item ev45
9123 @itemx 21064
9124 Schedules as an EV4 and has no instruction set extensions.
9125
9126 @item ev5
9127 @itemx 21164
9128 Schedules as an EV5 and has no instruction set extensions.
9129
9130 @item ev56
9131 @itemx 21164a
9132 Schedules as an EV5 and supports the BWX extension.
9133
9134 @item pca56
9135 @itemx 21164pc
9136 @itemx 21164PC
9137 Schedules as an EV5 and supports the BWX and MAX extensions.
9138
9139 @item ev6
9140 @itemx 21264
9141 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9142
9143 @item ev67
9144 @item 21264a
9145 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9146 @end table
9147
9148 @item -mtune=@var{cpu_type}
9149 @opindex mtune
9150 Set only the instruction scheduling parameters for machine type
9151 @var{cpu_type}.  The instruction set is not changed.
9152
9153 @item -mmemory-latency=@var{time}
9154 @opindex mmemory-latency
9155 Sets the latency the scheduler should assume for typical memory
9156 references as seen by the application.  This number is highly
9157 dependent on the memory access patterns used by the application
9158 and the size of the external cache on the machine.
9159
9160 Valid options for @var{time} are
9161
9162 @table @samp
9163 @item @var{number}
9164 A decimal number representing clock cycles.
9165
9166 @item L1
9167 @itemx L2
9168 @itemx L3
9169 @itemx main
9170 The compiler contains estimates of the number of clock cycles for
9171 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9172 (also called Dcache, Scache, and Bcache), as well as to main memory.
9173 Note that L3 is only valid for EV5.
9174
9175 @end table
9176 @end table
9177
9178 @node DEC Alpha/VMS Options
9179 @subsection DEC Alpha/VMS Options
9180
9181 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9182
9183 @table @gcctabopt
9184 @item -mvms-return-codes
9185 @opindex mvms-return-codes
9186 Return VMS condition codes from main.  The default is to return POSIX
9187 style condition (e.g.@ error) codes.
9188 @end table
9189
9190 @node H8/300 Options
9191 @subsection H8/300 Options
9192
9193 These @samp{-m} options are defined for the H8/300 implementations:
9194
9195 @table @gcctabopt
9196 @item -mrelax
9197 @opindex mrelax
9198 Shorten some address references at link time, when possible; uses the
9199 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9200 ld.info, Using ld}, for a fuller description.
9201
9202 @item -mh
9203 @opindex mh
9204 Generate code for the H8/300H@.
9205
9206 @item -ms
9207 @opindex ms
9208 Generate code for the H8S@.
9209
9210 @item -mn
9211 @opindex mn
9212 Generate code for the H8S and H8/300H in the normal mode.  This switch
9213 must be used either with -mh or -ms.
9214
9215 @item -ms2600
9216 @opindex ms2600
9217 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9218
9219 @item -mint32
9220 @opindex mint32
9221 Make @code{int} data 32 bits by default.
9222
9223 @item -malign-300
9224 @opindex malign-300
9225 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9226 The default for the H8/300H and H8S is to align longs and floats on 4
9227 byte boundaries.
9228 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9229 This option has no effect on the H8/300.
9230 @end table
9231
9232 @node SH Options
9233 @subsection SH Options
9234
9235 These @samp{-m} options are defined for the SH implementations:
9236
9237 @table @gcctabopt
9238 @item -m1
9239 @opindex m1
9240 Generate code for the SH1.
9241
9242 @item -m2
9243 @opindex m2
9244 Generate code for the SH2.
9245
9246 @item -m2e
9247 Generate code for the SH2e.
9248
9249 @item -m3
9250 @opindex m3
9251 Generate code for the SH3.
9252
9253 @item -m3e
9254 @opindex m3e
9255 Generate code for the SH3e.
9256
9257 @item -m4-nofpu
9258 @opindex m4-nofpu
9259 Generate code for the SH4 without a floating-point unit.
9260
9261 @item -m4-single-only
9262 @opindex m4-single-only
9263 Generate code for the SH4 with a floating-point unit that only
9264 supports single-precision arithmetic.
9265
9266 @item -m4-single
9267 @opindex m4-single
9268 Generate code for the SH4 assuming the floating-point unit is in
9269 single-precision mode by default.
9270
9271 @item -m4
9272 @opindex m4
9273 Generate code for the SH4.
9274
9275 @item -mb
9276 @opindex mb
9277 Compile code for the processor in big endian mode.
9278
9279 @item -ml
9280 @opindex ml
9281 Compile code for the processor in little endian mode.
9282
9283 @item -mdalign
9284 @opindex mdalign
9285 Align doubles at 64-bit boundaries.  Note that this changes the calling
9286 conventions, and thus some functions from the standard C library will
9287 not work unless you recompile it first with @option{-mdalign}.
9288
9289 @item -mrelax
9290 @opindex mrelax
9291 Shorten some address references at link time, when possible; uses the
9292 linker option @option{-relax}.
9293
9294 @item -mbigtable
9295 @opindex mbigtable
9296 Use 32-bit offsets in @code{switch} tables.  The default is to use
9297 16-bit offsets.
9298
9299 @item -mfmovd
9300 @opindex mfmovd
9301 Enable the use of the instruction @code{fmovd}.
9302
9303 @item -mhitachi
9304 @opindex mhitachi
9305 Comply with the calling conventions defined by Renesas.
9306
9307 @item -mnomacsave
9308 @opindex mnomacsave
9309 Mark the @code{MAC} register as call-clobbered, even if
9310 @option{-mhitachi} is given.
9311
9312 @item -mieee
9313 @opindex mieee
9314 Increase IEEE-compliance of floating-point code.
9315
9316 @item -misize
9317 @opindex misize
9318 Dump instruction size and location in the assembly code.
9319
9320 @item -mpadstruct
9321 @opindex mpadstruct
9322 This option is deprecated.  It pads structures to multiple of 4 bytes,
9323 which is incompatible with the SH ABI@.
9324
9325 @item -mspace
9326 @opindex mspace
9327 Optimize for space instead of speed.  Implied by @option{-Os}.
9328
9329 @item -mprefergot
9330 @opindex mprefergot
9331 When generating position-independent code, emit function calls using
9332 the Global Offset Table instead of the Procedure Linkage Table.
9333
9334 @item -musermode
9335 @opindex musermode
9336 Generate a library function call to invalidate instruction cache
9337 entries, after fixing up a trampoline.  This library function call
9338 doesn't assume it can write to the whole memory address space.  This
9339 is the default when the target is @code{sh-*-linux*}.
9340 @end table
9341
9342 @node System V Options
9343 @subsection Options for System V
9344
9345 These additional options are available on System V Release 4 for
9346 compatibility with other compilers on those systems:
9347
9348 @table @gcctabopt
9349 @item -G
9350 @opindex G
9351 Create a shared object.
9352 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9353
9354 @item -Qy
9355 @opindex Qy
9356 Identify the versions of each tool used by the compiler, in a
9357 @code{.ident} assembler directive in the output.
9358
9359 @item -Qn
9360 @opindex Qn
9361 Refrain from adding @code{.ident} directives to the output file (this is
9362 the default).
9363
9364 @item -YP,@var{dirs}
9365 @opindex YP
9366 Search the directories @var{dirs}, and no others, for libraries
9367 specified with @option{-l}.
9368
9369 @item -Ym,@var{dir}
9370 @opindex Ym
9371 Look in the directory @var{dir} to find the M4 preprocessor.
9372 The assembler uses this option.
9373 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9374 @c the generic assembler that comes with Solaris takes just -Ym.
9375 @end table
9376
9377 @node TMS320C3x/C4x Options
9378 @subsection TMS320C3x/C4x Options
9379 @cindex TMS320C3x/C4x Options
9380
9381 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9382
9383 @table @gcctabopt
9384
9385 @item -mcpu=@var{cpu_type}
9386 @opindex mcpu
9387 Set the instruction set, register set, and instruction scheduling
9388 parameters for machine type @var{cpu_type}.  Supported values for
9389 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9390 @samp{c44}.  The default is @samp{c40} to generate code for the
9391 TMS320C40.
9392
9393 @item -mbig-memory
9394 @item -mbig
9395 @itemx -msmall-memory
9396 @itemx -msmall
9397 @opindex mbig-memory
9398 @opindex mbig
9399 @opindex msmall-memory
9400 @opindex msmall
9401 Generates code for the big or small memory model.  The small memory
9402 model assumed that all data fits into one 64K word page.  At run-time
9403 the data page (DP) register must be set to point to the 64K page
9404 containing the .bss and .data program sections.  The big memory model is
9405 the default and requires reloading of the DP register for every direct
9406 memory access.
9407
9408 @item -mbk
9409 @itemx -mno-bk
9410 @opindex mbk
9411 @opindex mno-bk
9412 Allow (disallow) allocation of general integer operands into the block
9413 count register BK@.
9414
9415 @item -mdb
9416 @itemx -mno-db
9417 @opindex mdb
9418 @opindex mno-db
9419 Enable (disable) generation of code using decrement and branch,
9420 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9421 on the safe side, this is disabled for the C3x, since the maximum
9422 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9423 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9424 that it can utilize the decrement and branch instruction, but will give
9425 up if there is more than one memory reference in the loop.  Thus a loop
9426 where the loop counter is decremented can generate slightly more
9427 efficient code, in cases where the RPTB instruction cannot be utilized.
9428
9429 @item -mdp-isr-reload
9430 @itemx -mparanoid
9431 @opindex mdp-isr-reload
9432 @opindex mparanoid
9433 Force the DP register to be saved on entry to an interrupt service
9434 routine (ISR), reloaded to point to the data section, and restored on
9435 exit from the ISR@.  This should not be required unless someone has
9436 violated the small memory model by modifying the DP register, say within
9437 an object library.
9438
9439 @item -mmpyi
9440 @itemx -mno-mpyi
9441 @opindex mmpyi
9442 @opindex mno-mpyi
9443 For the C3x use the 24-bit MPYI instruction for integer multiplies
9444 instead of a library call to guarantee 32-bit results.  Note that if one
9445 of the operands is a constant, then the multiplication will be performed
9446 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9447 then squaring operations are performed inline instead of a library call.
9448
9449 @item -mfast-fix
9450 @itemx -mno-fast-fix
9451 @opindex mfast-fix
9452 @opindex mno-fast-fix
9453 The C3x/C4x FIX instruction to convert a floating point value to an
9454 integer value chooses the nearest integer less than or equal to the
9455 floating point value rather than to the nearest integer.  Thus if the
9456 floating point number is negative, the result will be incorrectly
9457 truncated an additional code is necessary to detect and correct this
9458 case.  This option can be used to disable generation of the additional
9459 code required to correct the result.
9460
9461 @item -mrptb
9462 @itemx -mno-rptb
9463 @opindex mrptb
9464 @opindex mno-rptb
9465 Enable (disable) generation of repeat block sequences using the RPTB
9466 instruction for zero overhead looping.  The RPTB construct is only used
9467 for innermost loops that do not call functions or jump across the loop
9468 boundaries.  There is no advantage having nested RPTB loops due to the
9469 overhead required to save and restore the RC, RS, and RE registers.
9470 This is enabled by default with @option{-O2}.
9471
9472 @item -mrpts=@var{count}
9473 @itemx -mno-rpts
9474 @opindex mrpts
9475 @opindex mno-rpts
9476 Enable (disable) the use of the single instruction repeat instruction
9477 RPTS@.  If a repeat block contains a single instruction, and the loop
9478 count can be guaranteed to be less than the value @var{count}, GCC will
9479 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9480 then a RPTS will be emitted even if the loop count cannot be determined
9481 at compile time.  Note that the repeated instruction following RPTS does
9482 not have to be reloaded from memory each iteration, thus freeing up the
9483 CPU buses for operands.  However, since interrupts are blocked by this
9484 instruction, it is disabled by default.
9485
9486 @item -mloop-unsigned
9487 @itemx -mno-loop-unsigned
9488 @opindex mloop-unsigned
9489 @opindex mno-loop-unsigned
9490 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9491 is @math{2^{31} + 1} since these instructions test if the iteration count is
9492 negative to terminate the loop.  If the iteration count is unsigned
9493 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9494 exceeded.  This switch allows an unsigned iteration count.
9495
9496 @item -mti
9497 @opindex mti
9498 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9499 with.  This also enforces compatibility with the API employed by the TI
9500 C3x C compiler.  For example, long doubles are passed as structures
9501 rather than in floating point registers.
9502
9503 @item -mregparm
9504 @itemx -mmemparm
9505 @opindex mregparm
9506 @opindex mmemparm
9507 Generate code that uses registers (stack) for passing arguments to functions.
9508 By default, arguments are passed in registers where possible rather
9509 than by pushing arguments on to the stack.
9510
9511 @item -mparallel-insns
9512 @itemx -mno-parallel-insns
9513 @opindex mparallel-insns
9514 @opindex mno-parallel-insns
9515 Allow the generation of parallel instructions.  This is enabled by
9516 default with @option{-O2}.
9517
9518 @item -mparallel-mpy
9519 @itemx -mno-parallel-mpy
9520 @opindex mparallel-mpy
9521 @opindex mno-parallel-mpy
9522 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9523 provided @option{-mparallel-insns} is also specified.  These instructions have
9524 tight register constraints which can pessimize the code generation
9525 of large functions.
9526
9527 @end table
9528
9529 @node V850 Options
9530 @subsection V850 Options
9531 @cindex V850 Options
9532
9533 These @samp{-m} options are defined for V850 implementations:
9534
9535 @table @gcctabopt
9536 @item -mlong-calls
9537 @itemx -mno-long-calls
9538 @opindex mlong-calls
9539 @opindex mno-long-calls
9540 Treat all calls as being far away (near).  If calls are assumed to be
9541 far away, the compiler will always load the functions address up into a
9542 register, and call indirect through the pointer.
9543
9544 @item -mno-ep
9545 @itemx -mep
9546 @opindex mno-ep
9547 @opindex mep
9548 Do not optimize (do optimize) basic blocks that use the same index
9549 pointer 4 or more times to copy pointer into the @code{ep} register, and
9550 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9551 option is on by default if you optimize.
9552
9553 @item -mno-prolog-function
9554 @itemx -mprolog-function
9555 @opindex mno-prolog-function
9556 @opindex mprolog-function
9557 Do not use (do use) external functions to save and restore registers at
9558 the prolog and epilog of a function.  The external functions are slower,
9559 but use less code space if more than one function saves the same number
9560 of registers.  The @option{-mprolog-function} option is on by default if
9561 you optimize.
9562
9563 @item -mspace
9564 @opindex mspace
9565 Try to make the code as small as possible.  At present, this just turns
9566 on the @option{-mep} and @option{-mprolog-function} options.
9567
9568 @item -mtda=@var{n}
9569 @opindex mtda
9570 Put static or global variables whose size is @var{n} bytes or less into
9571 the tiny data area that register @code{ep} points to.  The tiny data
9572 area can hold up to 256 bytes in total (128 bytes for byte references).
9573
9574 @item -msda=@var{n}
9575 @opindex msda
9576 Put static or global variables whose size is @var{n} bytes or less into
9577 the small data area that register @code{gp} points to.  The small data
9578 area can hold up to 64 kilobytes.
9579
9580 @item -mzda=@var{n}
9581 @opindex mzda
9582 Put static or global variables whose size is @var{n} bytes or less into
9583 the first 32 kilobytes of memory.
9584
9585 @item -mv850
9586 @opindex mv850
9587 Specify that the target processor is the V850.
9588
9589 @item -mbig-switch
9590 @opindex mbig-switch
9591 Generate code suitable for big switch tables.  Use this option only if
9592 the assembler/linker complain about out of range branches within a switch
9593 table.
9594
9595 @item -mapp-regs
9596 @opindex mapp-regs
9597 This option will cause r2 and r5 to be used in the code generated by
9598 the compiler.  This setting is the default.
9599
9600 @item -mno-app-regs
9601 @opindex mno-app-regs
9602 This option will cause r2 and r5 to be treated as fixed registers.
9603   
9604 @item -mv850e
9605 @opindex mv850e
9606 Specify that the target processor is the V850E.  The preprocessor
9607 constant @samp{__v850e__} will be defined if this option is used.
9608
9609 If neither @option{-mv850} nor @option{-mv850e} are defined
9610 then a default target processor will be chosen and the relevant
9611 @samp{__v850*__} preprocessor constant will be defined.
9612
9613 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9614 defined, regardless of which processor variant is the target.
9615
9616 @item -mdisable-callt
9617 @opindex mdisable-callt
9618 This option will suppress generation of the CALLT instruction for the
9619 v850e flavors of the v850 architecture.  The default is
9620 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9621
9622 @end table
9623
9624 @node ARC Options
9625 @subsection ARC Options
9626 @cindex ARC Options
9627
9628 These options are defined for ARC implementations:
9629
9630 @table @gcctabopt
9631 @item -EL
9632 @opindex EL
9633 Compile code for little endian mode.  This is the default.
9634
9635 @item -EB
9636 @opindex EB
9637 Compile code for big endian mode.
9638
9639 @item -mmangle-cpu
9640 @opindex mmangle-cpu
9641 Prepend the name of the cpu to all public symbol names.
9642 In multiple-processor systems, there are many ARC variants with different
9643 instruction and register set characteristics.  This flag prevents code
9644 compiled for one cpu to be linked with code compiled for another.
9645 No facility exists for handling variants that are ``almost identical''.
9646 This is an all or nothing option.
9647
9648 @item -mcpu=@var{cpu}
9649 @opindex mcpu
9650 Compile code for ARC variant @var{cpu}.
9651 Which variants are supported depend on the configuration.
9652 All variants support @option{-mcpu=base}, this is the default.
9653
9654 @item -mtext=@var{text-section}
9655 @itemx -mdata=@var{data-section}
9656 @itemx -mrodata=@var{readonly-data-section}
9657 @opindex mtext
9658 @opindex mdata
9659 @opindex mrodata
9660 Put functions, data, and readonly data in @var{text-section},
9661 @var{data-section}, and @var{readonly-data-section} respectively
9662 by default.  This can be overridden with the @code{section} attribute.
9663 @xref{Variable Attributes}.
9664
9665 @end table
9666
9667 @node NS32K Options
9668 @subsection NS32K Options
9669 @cindex NS32K options
9670
9671 These are the @samp{-m} options defined for the 32000 series.  The default
9672 values for these options depends on which style of 32000 was selected when
9673 the compiler was configured; the defaults for the most common choices are
9674 given below.
9675
9676 @table @gcctabopt
9677 @item -m32032
9678 @itemx -m32032
9679 @opindex m32032
9680 @opindex m32032
9681 Generate output for a 32032.  This is the default
9682 when the compiler is configured for 32032 and 32016 based systems.
9683
9684 @item -m32332
9685 @itemx -m32332
9686 @opindex m32332
9687 @opindex m32332
9688 Generate output for a 32332.  This is the default
9689 when the compiler is configured for 32332-based systems.
9690
9691 @item -m32532
9692 @itemx -m32532
9693 @opindex m32532
9694 @opindex m32532
9695 Generate output for a 32532.  This is the default
9696 when the compiler is configured for 32532-based systems.
9697
9698 @item -m32081
9699 @opindex m32081
9700 Generate output containing 32081 instructions for floating point.
9701 This is the default for all systems.
9702
9703 @item -m32381
9704 @opindex m32381
9705 Generate output containing 32381 instructions for floating point.  This
9706 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9707 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9708
9709 @item -mmulti-add
9710 @opindex mmulti-add
9711 Try and generate multiply-add floating point instructions @code{polyF}
9712 and @code{dotF}.  This option is only available if the @option{-m32381}
9713 option is in effect.  Using these instructions requires changes to
9714 register allocation which generally has a negative impact on
9715 performance.  This option should only be enabled when compiling code
9716 particularly likely to make heavy use of multiply-add instructions.
9717
9718 @item -mnomulti-add
9719 @opindex mnomulti-add
9720 Do not try and generate multiply-add floating point instructions
9721 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9722
9723 @item -msoft-float
9724 @opindex msoft-float
9725 Generate output containing library calls for floating point.
9726 @strong{Warning:} the requisite libraries may not be available.
9727
9728 @item -mieee-compare
9729 @itemx -mno-ieee-compare
9730 @opindex mieee-compare
9731 @opindex mno-ieee-compare
9732 Control whether or not the compiler uses IEEE floating point
9733 comparisons.  These handle correctly the case where the result of a
9734 comparison is unordered.
9735 @strong{Warning:} the requisite kernel support may not be available.
9736
9737 @item -mnobitfield
9738 @opindex mnobitfield
9739 Do not use the bit-field instructions.  On some machines it is faster to
9740 use shifting and masking operations.  This is the default for the pc532.
9741
9742 @item -mbitfield
9743 @opindex mbitfield
9744 Do use the bit-field instructions.  This is the default for all platforms
9745 except the pc532.
9746
9747 @item -mrtd
9748 @opindex mrtd
9749 Use a different function-calling convention, in which functions
9750 that take a fixed number of arguments return pop their
9751 arguments on return with the @code{ret} instruction.
9752
9753 This calling convention is incompatible with the one normally
9754 used on Unix, so you cannot use it if you need to call libraries
9755 compiled with the Unix compiler.
9756
9757 Also, you must provide function prototypes for all functions that
9758 take variable numbers of arguments (including @code{printf});
9759 otherwise incorrect code will be generated for calls to those
9760 functions.
9761
9762 In addition, seriously incorrect code will result if you call a
9763 function with too many arguments.  (Normally, extra arguments are
9764 harmlessly ignored.)
9765
9766 This option takes its name from the 680x0 @code{rtd} instruction.
9767
9768
9769 @item -mregparam
9770 @opindex mregparam
9771 Use a different function-calling convention where the first two arguments
9772 are passed in registers.
9773
9774 This calling convention is incompatible with the one normally
9775 used on Unix, so you cannot use it if you need to call libraries
9776 compiled with the Unix compiler.
9777
9778 @item -mnoregparam
9779 @opindex mnoregparam
9780 Do not pass any arguments in registers.  This is the default for all
9781 targets.
9782
9783 @item -msb
9784 @opindex msb
9785 It is OK to use the sb as an index register which is always loaded with
9786 zero.  This is the default for the pc532-netbsd target.
9787
9788 @item -mnosb
9789 @opindex mnosb
9790 The sb register is not available for use or has not been initialized to
9791 zero by the run time system.  This is the default for all targets except
9792 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9793 @option{-fpic} is set.
9794
9795 @item -mhimem
9796 @opindex mhimem
9797 Many ns32000 series addressing modes use displacements of up to 512MB@.
9798 If an address is above 512MB then displacements from zero can not be used.
9799 This option causes code to be generated which can be loaded above 512MB@.
9800 This may be useful for operating systems or ROM code.
9801
9802 @item -mnohimem
9803 @opindex mnohimem
9804 Assume code will be loaded in the first 512MB of virtual address space.
9805 This is the default for all platforms.
9806
9807
9808 @end table
9809
9810 @node AVR Options
9811 @subsection AVR Options
9812 @cindex AVR Options
9813
9814 These options are defined for AVR implementations:
9815
9816 @table @gcctabopt
9817 @item -mmcu=@var{mcu}
9818 @opindex mmcu
9819 Specify ATMEL AVR instruction set or MCU type.
9820
9821 Instruction set avr1 is for the minimal AVR core, not supported by the C
9822 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9823 attiny11, attiny12, attiny15, attiny28).
9824
9825 Instruction set avr2 (default) is for the classic AVR core with up to
9826 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9827 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9828 at90c8534, at90s8535).
9829
9830 Instruction set avr3 is for the classic AVR core with up to 128K program
9831 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9832
9833 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9834 memory space (MCU types: atmega8, atmega83, atmega85).
9835
9836 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9837 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9838 atmega64, atmega128, at43usb355, at94k).
9839
9840 @item -msize
9841 @opindex msize
9842 Output instruction sizes to the asm file.
9843
9844 @item -minit-stack=@var{N}
9845 @opindex minit-stack
9846 Specify the initial stack address, which may be a symbol or numeric value,
9847 @samp{__stack} is the default.
9848
9849 @item -mno-interrupts
9850 @opindex mno-interrupts
9851 Generated code is not compatible with hardware interrupts.
9852 Code size will be smaller.
9853
9854 @item -mcall-prologues
9855 @opindex mcall-prologues
9856 Functions prologues/epilogues expanded as call to appropriate
9857 subroutines.  Code size will be smaller.
9858
9859 @item -mno-tablejump
9860 @opindex mno-tablejump
9861 Do not generate tablejump insns which sometimes increase code size.
9862
9863 @item -mtiny-stack
9864 @opindex mtiny-stack
9865 Change only the low 8 bits of the stack pointer.
9866 @end table
9867
9868 @node MCore Options
9869 @subsection MCore Options
9870 @cindex MCore options
9871
9872 These are the @samp{-m} options defined for the Motorola M*Core
9873 processors.
9874
9875 @table @gcctabopt
9876
9877 @item -mhardlit
9878 @itemx -mno-hardlit
9879 @opindex mhardlit
9880 @opindex mno-hardlit
9881 Inline constants into the code stream if it can be done in two
9882 instructions or less.
9883
9884 @item -mdiv
9885 @itemx -mno-div
9886 @opindex mdiv
9887 @opindex mno-div
9888 Use the divide instruction.  (Enabled by default).
9889
9890 @item -mrelax-immediate
9891 @itemx -mno-relax-immediate
9892 @opindex mrelax-immediate
9893 @opindex mno-relax-immediate
9894 Allow arbitrary sized immediates in bit operations.
9895
9896 @item -mwide-bitfields
9897 @itemx -mno-wide-bitfields
9898 @opindex mwide-bitfields
9899 @opindex mno-wide-bitfields
9900 Always treat bit-fields as int-sized.
9901
9902 @item -m4byte-functions
9903 @itemx -mno-4byte-functions
9904 @opindex m4byte-functions
9905 @opindex mno-4byte-functions
9906 Force all functions to be aligned to a four byte boundary.
9907
9908 @item -mcallgraph-data
9909 @itemx -mno-callgraph-data
9910 @opindex mcallgraph-data
9911 @opindex mno-callgraph-data
9912 Emit callgraph information.
9913
9914 @item -mslow-bytes
9915 @itemx -mno-slow-bytes
9916 @opindex mslow-bytes
9917 @opindex mno-slow-bytes
9918 Prefer word access when reading byte quantities.
9919
9920 @item -mlittle-endian
9921 @itemx -mbig-endian
9922 @opindex mlittle-endian
9923 @opindex mbig-endian
9924 Generate code for a little endian target.
9925
9926 @item -m210
9927 @itemx -m340
9928 @opindex m210
9929 @opindex m340
9930 Generate code for the 210 processor.
9931 @end table
9932
9933 @node IA-64 Options
9934 @subsection IA-64 Options
9935 @cindex IA-64 Options
9936
9937 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9938
9939 @table @gcctabopt
9940 @item -mbig-endian
9941 @opindex mbig-endian
9942 Generate code for a big endian target.  This is the default for HP-UX@.
9943
9944 @item -mlittle-endian
9945 @opindex mlittle-endian
9946 Generate code for a little endian target.  This is the default for AIX5
9947 and Linux.
9948
9949 @item -mgnu-as
9950 @itemx -mno-gnu-as
9951 @opindex mgnu-as
9952 @opindex mno-gnu-as
9953 Generate (or don't) code for the GNU assembler.  This is the default.
9954 @c Also, this is the default if the configure option @option{--with-gnu-as}
9955 @c is used.
9956
9957 @item -mgnu-ld
9958 @itemx -mno-gnu-ld
9959 @opindex mgnu-ld
9960 @opindex mno-gnu-ld
9961 Generate (or don't) code for the GNU linker.  This is the default.
9962 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9963 @c is used.
9964
9965 @item -mno-pic
9966 @opindex mno-pic
9967 Generate code that does not use a global pointer register.  The result
9968 is not position independent code, and violates the IA-64 ABI@.
9969
9970 @item -mvolatile-asm-stop
9971 @itemx -mno-volatile-asm-stop
9972 @opindex mvolatile-asm-stop
9973 @opindex mno-volatile-asm-stop
9974 Generate (or don't) a stop bit immediately before and after volatile asm
9975 statements.
9976
9977 @item -mb-step
9978 @opindex mb-step
9979 Generate code that works around Itanium B step errata.
9980
9981 @item -mregister-names
9982 @itemx -mno-register-names
9983 @opindex mregister-names
9984 @opindex mno-register-names
9985 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9986 the stacked registers.  This may make assembler output more readable.
9987
9988 @item -mno-sdata
9989 @itemx -msdata
9990 @opindex mno-sdata
9991 @opindex msdata
9992 Disable (or enable) optimizations that use the small data section.  This may
9993 be useful for working around optimizer bugs.
9994
9995 @item -mconstant-gp
9996 @opindex mconstant-gp
9997 Generate code that uses a single constant global pointer value.  This is
9998 useful when compiling kernel code.
9999
10000 @item -mauto-pic
10001 @opindex mauto-pic
10002 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10003 This is useful when compiling firmware code.
10004
10005 @item -minline-float-divide-min-latency
10006 @opindex minline-float-divide-min-latency
10007 Generate code for inline divides of floating point values
10008 using the minimum latency algorithm.
10009
10010 @item -minline-float-divide-max-throughput
10011 @opindex minline-float-divide-max-throughput
10012 Generate code for inline divides of floating point values
10013 using the maximum throughput algorithm.
10014
10015 @item -minline-int-divide-min-latency
10016 @opindex minline-int-divide-min-latency
10017 Generate code for inline divides of integer values
10018 using the minimum latency algorithm.
10019
10020 @item -minline-int-divide-max-throughput
10021 @opindex minline-int-divide-max-throughput
10022 Generate code for inline divides of integer values
10023 using the maximum throughput algorithm.
10024
10025 @item -mno-dwarf2-asm
10026 @itemx -mdwarf2-asm
10027 @opindex mno-dwarf2-asm
10028 @opindex mdwarf2-asm
10029 Don't (or do) generate assembler code for the DWARF2 line number debugging
10030 info.  This may be useful when not using the GNU assembler.
10031
10032 @item -mfixed-range=@var{register-range}
10033 @opindex mfixed-range
10034 Generate code treating the given register range as fixed registers.
10035 A fixed register is one that the register allocator can not use.  This is
10036 useful when compiling kernel code.  A register range is specified as
10037 two registers separated by a dash.  Multiple register ranges can be
10038 specified separated by a comma.
10039
10040 @item -mearly-stop-bits
10041 @itemx -mno-early-stop-bits
10042 @opindex mearly-stop-bits
10043 @opindex mno-early-stop-bits
10044 Allow stop bits to be placed earlier than immediately preceding the
10045 instruction that triggered the stop bit.  This can improve instruction
10046 scheduling, but does not always do so.
10047 @end table
10048
10049 @node D30V Options
10050 @subsection D30V Options
10051 @cindex D30V Options
10052
10053 These @samp{-m} options are defined for D30V implementations:
10054
10055 @table @gcctabopt
10056 @item -mextmem
10057 @opindex mextmem
10058 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10059 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10060 memory, which starts at location @code{0x80000000}.
10061
10062 @item -mextmemory
10063 @opindex mextmemory
10064 Same as the @option{-mextmem} switch.
10065
10066 @item -monchip
10067 @opindex monchip
10068 Link the @samp{.text} section into onchip text memory, which starts at
10069 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10070 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10071 into onchip data memory, which starts at location @code{0x20000000}.
10072
10073 @item -mno-asm-optimize
10074 @itemx -masm-optimize
10075 @opindex mno-asm-optimize
10076 @opindex masm-optimize
10077 Disable (enable) passing @option{-O} to the assembler when optimizing.
10078 The assembler uses the @option{-O} option to automatically parallelize
10079 adjacent short instructions where possible.
10080
10081 @item -mbranch-cost=@var{n}
10082 @opindex mbranch-cost
10083 Increase the internal costs of branches to @var{n}.  Higher costs means
10084 that the compiler will issue more instructions to avoid doing a branch.
10085 The default is 2.
10086
10087 @item -mcond-exec=@var{n}
10088 @opindex mcond-exec
10089 Specify the maximum number of conditionally executed instructions that
10090 replace a branch.  The default is 4.
10091 @end table
10092
10093 @node S/390 and zSeries Options
10094 @subsection S/390 and zSeries Options
10095 @cindex S/390 and zSeries Options
10096
10097 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10098
10099 @table @gcctabopt
10100 @item -mhard-float
10101 @itemx -msoft-float
10102 @opindex mhard-float
10103 @opindex msoft-float
10104 Use (do not use) the hardware floating-point instructions and registers
10105 for floating-point operations.  When @option{-msoft-float} is specified,
10106 functions in @file{libgcc.a} will be used to perform floating-point
10107 operations.  When @option{-mhard-float} is specified, the compiler
10108 generates IEEE floating-point instructions.  This is the default.
10109
10110 @item -mbackchain
10111 @itemx -mno-backchain
10112 @opindex mbackchain
10113 @opindex mno-backchain
10114 Generate (or do not generate) code which maintains an explicit
10115 backchain within the stack frame that points to the caller's frame.
10116 This is currently needed to allow debugging.  The default is to
10117 generate the backchain.
10118
10119 @item -msmall-exec
10120 @itemx -mno-small-exec
10121 @opindex msmall-exec
10122 @opindex mno-small-exec
10123 Generate (or do not generate) code using the @code{bras} instruction
10124 to do subroutine calls.
10125 This only works reliably if the total executable size does not
10126 exceed 64k.  The default is to use the @code{basr} instruction instead,
10127 which does not have this limitation.
10128
10129 @item -m64
10130 @itemx -m31
10131 @opindex m64
10132 @opindex m31
10133 When @option{-m31} is specified, generate code compliant to the
10134 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10135 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10136 particular to generate 64-bit instructions.  For the @samp{s390}
10137 targets, the default is @option{-m31}, while the @samp{s390x}
10138 targets default to @option{-m64}.
10139
10140 @item -mzarch
10141 @itemx -mesa
10142 @opindex mzarch
10143 @opindex mesa
10144 When @option{-mzarch} is specified, generate code using the 
10145 instructions available on z/Architecture. 
10146 When @option{-mesa} is specified, generate code using the 
10147 instructions available on ESA/390. Note that @option{-mesa} is
10148 not possible with @option{-m64}.
10149 When generating code compliant to the Linux for S/390 ABI,
10150 the default is @option{-mesa}.  When generating code compliant
10151 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10152
10153 @item -mmvcle
10154 @itemx -mno-mvcle
10155 @opindex mmvcle
10156 @opindex mno-mvcle
10157 Generate (or do not generate) code using the @code{mvcle} instruction
10158 to perform block moves.  When @option{-mno-mvcle} is specified,
10159 use a @code{mvc} loop instead.  This is the default.
10160
10161 @item -mdebug
10162 @itemx -mno-debug
10163 @opindex mdebug
10164 @opindex mno-debug
10165 Print (or do not print) additional debug information when compiling.
10166 The default is to not print debug information.
10167
10168 @item -march=@var{cpu-type}
10169 @opindex march
10170 Generate code that will run on @var{cpu-type}, which is the name of a system
10171 representing a certain processor type. Possible values for
10172 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10173 When generating code using the instructions available on z/Architecture,
10174 the default is @option{-march=z900}.  Otherwise, the default is
10175 @option{-march=g5}.
10176
10177 @item -mtune=@var{cpu-type}
10178 @opindex mtune
10179 Tune to @var{cpu-type} everything applicable about the generated code,
10180 except for the ABI and the set of available instructions.
10181 The list of @var{cpu-type} values is the same as for @option{-march}.
10182 The default is the value used for @option{-march}.
10183
10184 @end table
10185
10186 @node CRIS Options
10187 @subsection CRIS Options
10188 @cindex CRIS Options
10189
10190 These options are defined specifically for the CRIS ports.
10191
10192 @table @gcctabopt
10193 @item -march=@var{architecture-type}
10194 @itemx -mcpu=@var{architecture-type}
10195 @opindex march
10196 @opindex mcpu
10197 Generate code for the specified architecture.  The choices for
10198 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10199 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10200 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10201 @samp{v10}.
10202
10203 @item -mtune=@var{architecture-type}
10204 @opindex mtune
10205 Tune to @var{architecture-type} everything applicable about the generated
10206 code, except for the ABI and the set of available instructions.  The
10207 choices for @var{architecture-type} are the same as for
10208 @option{-march=@var{architecture-type}}.
10209
10210 @item -mmax-stack-frame=@var{n}
10211 @opindex mmax-stack-frame
10212 Warn when the stack frame of a function exceeds @var{n} bytes.
10213
10214 @item -melinux-stacksize=@var{n}
10215 @opindex melinux-stacksize
10216 Only available with the @samp{cris-axis-aout} target.  Arranges for
10217 indications in the program to the kernel loader that the stack of the
10218 program should be set to @var{n} bytes.
10219
10220 @item -metrax4
10221 @itemx -metrax100
10222 @opindex metrax4
10223 @opindex metrax100
10224 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10225 @option{-march=v3} and @option{-march=v8} respectively.
10226
10227 @item -mpdebug
10228 @opindex mpdebug
10229 Enable CRIS-specific verbose debug-related information in the assembly
10230 code.  This option also has the effect to turn off the @samp{#NO_APP}
10231 formatted-code indicator to the assembler at the beginning of the
10232 assembly file.
10233
10234 @item -mcc-init
10235 @opindex mcc-init
10236 Do not use condition-code results from previous instruction; always emit
10237 compare and test instructions before use of condition codes.
10238
10239 @item -mno-side-effects
10240 @opindex mno-side-effects
10241 Do not emit instructions with side-effects in addressing modes other than
10242 post-increment.
10243
10244 @item -mstack-align
10245 @itemx -mno-stack-align
10246 @itemx -mdata-align
10247 @itemx -mno-data-align
10248 @itemx -mconst-align
10249 @itemx -mno-const-align
10250 @opindex mstack-align
10251 @opindex mno-stack-align
10252 @opindex mdata-align
10253 @opindex mno-data-align
10254 @opindex mconst-align
10255 @opindex mno-const-align
10256 These options (no-options) arranges (eliminate arrangements) for the
10257 stack-frame, individual data and constants to be aligned for the maximum
10258 single data access size for the chosen CPU model.  The default is to
10259 arrange for 32-bit alignment.  ABI details such as structure layout are
10260 not affected by these options.
10261
10262 @item -m32-bit
10263 @itemx -m16-bit
10264 @itemx -m8-bit
10265 @opindex m32-bit
10266 @opindex m16-bit
10267 @opindex m8-bit
10268 Similar to the stack- data- and const-align options above, these options
10269 arrange for stack-frame, writable data and constants to all be 32-bit,
10270 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10271
10272 @item -mno-prologue-epilogue
10273 @itemx -mprologue-epilogue
10274 @opindex mno-prologue-epilogue
10275 @opindex mprologue-epilogue
10276 With @option{-mno-prologue-epilogue}, the normal function prologue and
10277 epilogue that sets up the stack-frame are omitted and no return
10278 instructions or return sequences are generated in the code.  Use this
10279 option only together with visual inspection of the compiled code: no
10280 warnings or errors are generated when call-saved registers must be saved,
10281 or storage for local variable needs to be allocated.
10282
10283 @item -mno-gotplt
10284 @itemx -mgotplt
10285 @opindex mno-gotplt
10286 @opindex mgotplt
10287 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10288 instruction sequences that load addresses for functions from the PLT part
10289 of the GOT rather than (traditional on other architectures) calls to the
10290 PLT.  The default is @option{-mgotplt}.
10291
10292 @item -maout
10293 @opindex maout
10294 Legacy no-op option only recognized with the cris-axis-aout target.
10295
10296 @item -melf
10297 @opindex melf
10298 Legacy no-op option only recognized with the cris-axis-elf and
10299 cris-axis-linux-gnu targets.
10300
10301 @item -melinux
10302 @opindex melinux
10303 Only recognized with the cris-axis-aout target, where it selects a
10304 GNU/linux-like multilib, include files and instruction set for
10305 @option{-march=v8}.
10306
10307 @item -mlinux
10308 @opindex mlinux
10309 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10310
10311 @item -sim
10312 @opindex sim
10313 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10314 to link with input-output functions from a simulator library.  Code,
10315 initialized data and zero-initialized data are allocated consecutively.
10316
10317 @item -sim2
10318 @opindex sim2
10319 Like @option{-sim}, but pass linker options to locate initialized data at
10320 0x40000000 and zero-initialized data at 0x80000000.
10321 @end table
10322
10323 @node MMIX Options
10324 @subsection MMIX Options
10325 @cindex MMIX Options
10326
10327 These options are defined for the MMIX:
10328
10329 @table @gcctabopt
10330 @item -mlibfuncs
10331 @itemx -mno-libfuncs
10332 @opindex mlibfuncs
10333 @opindex mno-libfuncs
10334 Specify that intrinsic library functions are being compiled, passing all
10335 values in registers, no matter the size.
10336
10337 @item -mepsilon
10338 @itemx -mno-epsilon
10339 @opindex mepsilon
10340 @opindex mno-epsilon
10341 Generate floating-point comparison instructions that compare with respect
10342 to the @code{rE} epsilon register.
10343
10344 @item -mabi=mmixware
10345 @itemx -mabi=gnu
10346 @opindex mabi-mmixware
10347 @opindex mabi=gnu
10348 Generate code that passes function parameters and return values that (in
10349 the called function) are seen as registers @code{$0} and up, as opposed to
10350 the GNU ABI which uses global registers @code{$231} and up.
10351
10352 @item -mzero-extend
10353 @itemx -mno-zero-extend
10354 @opindex mzero-extend
10355 @opindex mno-zero-extend
10356 When reading data from memory in sizes shorter than 64 bits, use (do not
10357 use) zero-extending load instructions by default, rather than
10358 sign-extending ones.
10359
10360 @item -mknuthdiv
10361 @itemx -mno-knuthdiv
10362 @opindex mknuthdiv
10363 @opindex mno-knuthdiv
10364 Make the result of a division yielding a remainder have the same sign as
10365 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10366 remainder follows the sign of the dividend.  Both methods are
10367 arithmetically valid, the latter being almost exclusively used.
10368
10369 @item -mtoplevel-symbols
10370 @itemx -mno-toplevel-symbols
10371 @opindex mtoplevel-symbols
10372 @opindex mno-toplevel-symbols
10373 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10374 code can be used with the @code{PREFIX} assembly directive.
10375
10376 @item -melf
10377 @opindex melf
10378 Generate an executable in the ELF format, rather than the default
10379 @samp{mmo} format used by the @command{mmix} simulator.
10380
10381 @item -mbranch-predict
10382 @itemx -mno-branch-predict
10383 @opindex mbranch-predict
10384 @opindex mno-branch-predict
10385 Use (do not use) the probable-branch instructions, when static branch
10386 prediction indicates a probable branch.
10387
10388 @item -mbase-addresses
10389 @itemx -mno-base-addresses
10390 @opindex mbase-addresses
10391 @opindex mno-base-addresses
10392 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10393 base address automatically generates a request (handled by the assembler
10394 and the linker) for a constant to be set up in a global register.  The
10395 register is used for one or more base address requests within the range 0
10396 to 255 from the value held in the register.  The generally leads to short
10397 and fast code, but the number of different data items that can be
10398 addressed is limited.  This means that a program that uses lots of static
10399 data may require @option{-mno-base-addresses}.
10400
10401 @item -msingle-exit
10402 @itemx -mno-single-exit
10403 @opindex msingle-exit
10404 @opindex mno-single-exit
10405 Force (do not force) generated code to have a single exit point in each
10406 function.
10407 @end table
10408
10409 @node PDP-11 Options
10410 @subsection PDP-11 Options
10411 @cindex PDP-11 Options
10412
10413 These options are defined for the PDP-11:
10414
10415 @table @gcctabopt
10416 @item -mfpu
10417 @opindex mfpu
10418 Use hardware FPP floating point.  This is the default.  (FIS floating
10419 point on the PDP-11/40 is not supported.)
10420
10421 @item -msoft-float
10422 @opindex msoft-float
10423 Do not use hardware floating point.
10424
10425 @item -mac0
10426 @opindex mac0
10427 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10428
10429 @item -mno-ac0
10430 @opindex mno-ac0
10431 Return floating-point results in memory.  This is the default.
10432
10433 @item -m40
10434 @opindex m40
10435 Generate code for a PDP-11/40.
10436
10437 @item -m45
10438 @opindex m45
10439 Generate code for a PDP-11/45.  This is the default.
10440
10441 @item -m10
10442 @opindex m10
10443 Generate code for a PDP-11/10.
10444
10445 @item -mbcopy-builtin
10446 @opindex bcopy-builtin
10447 Use inline @code{movstrhi} patterns for copying memory.  This is the
10448 default.
10449
10450 @item -mbcopy
10451 @opindex mbcopy
10452 Do not use inline @code{movstrhi} patterns for copying memory.
10453
10454 @item -mint16
10455 @itemx -mno-int32
10456 @opindex mint16
10457 @opindex mno-int32
10458 Use 16-bit @code{int}.  This is the default.
10459
10460 @item -mint32
10461 @itemx -mno-int16
10462 @opindex mint32
10463 @opindex mno-int16
10464 Use 32-bit @code{int}.
10465
10466 @item -mfloat64
10467 @itemx -mno-float32
10468 @opindex mfloat64
10469 @opindex mno-float32
10470 Use 64-bit @code{float}.  This is the default.
10471
10472 @item -mfloat32
10473 @item -mno-float64
10474 @opindex mfloat32
10475 @opindex mno-float64
10476 Use 32-bit @code{float}.
10477
10478 @item -mabshi
10479 @opindex mabshi
10480 Use @code{abshi2} pattern.  This is the default.
10481
10482 @item -mno-abshi
10483 @opindex mno-abshi
10484 Do not use @code{abshi2} pattern.
10485
10486 @item -mbranch-expensive
10487 @opindex mbranch-expensive
10488 Pretend that branches are expensive.  This is for experimenting with
10489 code generation only.
10490
10491 @item -mbranch-cheap
10492 @opindex mbranch-cheap
10493 Do not pretend that branches are expensive.  This is the default.
10494
10495 @item -msplit
10496 @opindex msplit
10497 Generate code for a system with split I&D.
10498
10499 @item -mno-split
10500 @opindex mno-split
10501 Generate code for a system without split I&D.  This is the default.
10502
10503 @item -munix-asm
10504 @opindex munix-asm
10505 Use Unix assembler syntax.  This is the default when configured for
10506 @samp{pdp11-*-bsd}.
10507
10508 @item -mdec-asm
10509 @opindex mdec-asm
10510 Use DEC assembler syntax.  This is the default when configured for any
10511 PDP-11 target other than @samp{pdp11-*-bsd}.
10512 @end table
10513
10514 @node Xstormy16 Options
10515 @subsection Xstormy16 Options
10516 @cindex Xstormy16 Options
10517
10518 These options are defined for Xstormy16:
10519
10520 @table @gcctabopt
10521 @item -msim
10522 @opindex msim
10523 Choose startup files and linker script suitable for the simulator.
10524 @end table
10525
10526 @node FRV Options
10527 @subsection FRV Options
10528 @cindex FRV Options
10529
10530 @table @gcctabopt
10531 @item -mgpr-32
10532 @opindex mgpr-32
10533
10534 Only use the first 32 general purpose registers.
10535
10536 @item -mgpr-64
10537 @opindex mgpr-64
10538
10539 Use all 64 general purpose registers.
10540
10541 @item -mfpr-32
10542 @opindex mfpr-32
10543
10544 Use only the first 32 floating point registers.
10545
10546 @item -mfpr-64
10547 @opindex mfpr-64
10548
10549 Use all 64 floating point registers
10550
10551 @item -mhard-float
10552 @opindex mhard-float
10553
10554 Use hardware instructions for floating point operations.
10555
10556 @item -msoft-float
10557 @opindex msoft-float
10558
10559 Use library routines for floating point operations.
10560
10561 @item -malloc-cc
10562 @opindex malloc-cc
10563
10564 Dynamically allocate condition code registers.
10565
10566 @item -mfixed-cc
10567 @opindex mfixed-cc
10568
10569 Do not try to dynamically allocate condition code registers, only
10570 use @code{icc0} and @code{fcc0}.
10571
10572 @item -mdword
10573 @opindex mdword
10574
10575 Change ABI to use double word insns.
10576
10577 @item -mno-dword
10578 @opindex mno-dword
10579
10580 Do not use double word instructions.
10581
10582 @item -mdouble
10583 @opindex mdouble
10584
10585 Use floating point double instructions.
10586
10587 @item -mno-double
10588 @opindex mno-double
10589
10590 Do not use floating point double instructions.
10591
10592 @item -mmedia
10593 @opindex mmedia
10594
10595 Use media instructions.
10596
10597 @item -mno-media
10598 @opindex mno-media
10599
10600 Do not use media instructions.
10601
10602 @item -mmuladd
10603 @opindex mmuladd
10604
10605 Use multiply and add/subtract instructions.
10606
10607 @item -mno-muladd
10608 @opindex mno-muladd
10609
10610 Do not use multiply and add/subtract instructions.
10611
10612 @item -mlibrary-pic
10613 @opindex mlibrary-pic
10614
10615 Enable PIC support for building libraries
10616
10617 @item -macc-4
10618 @opindex macc-4
10619
10620 Use only the first four media accumulator registers.
10621
10622 @item -macc-8
10623 @opindex macc-8
10624
10625 Use all eight media accumulator registers.
10626
10627 @item -mpack
10628 @opindex mpack
10629
10630 Pack VLIW instructions.
10631
10632 @item -mno-pack
10633 @opindex mno-pack
10634
10635 Do not pack VLIW instructions.
10636
10637 @item -mno-eflags
10638 @opindex mno-eflags
10639
10640 Do not mark ABI switches in e_flags.
10641
10642 @item -mcond-move
10643 @opindex mcond-move
10644
10645 Enable the use of conditional-move instructions (default).
10646
10647 This switch is mainly for debugging the compiler and will likely be removed
10648 in a future version.
10649
10650 @item -mno-cond-move
10651 @opindex mno-cond-move
10652
10653 Disable the use of conditional-move instructions.
10654
10655 This switch is mainly for debugging the compiler and will likely be removed
10656 in a future version.
10657
10658 @item -mscc
10659 @opindex mscc
10660
10661 Enable the use of conditional set instructions (default).
10662
10663 This switch is mainly for debugging the compiler and will likely be removed
10664 in a future version.
10665
10666 @item -mno-scc
10667 @opindex mno-scc
10668
10669 Disable the use of conditional set instructions.
10670
10671 This switch is mainly for debugging the compiler and will likely be removed
10672 in a future version.
10673
10674 @item -mcond-exec
10675 @opindex mcond-exec
10676
10677 Enable the use of conditional execution (default).
10678
10679 This switch is mainly for debugging the compiler and will likely be removed
10680 in a future version.
10681
10682 @item -mno-cond-exec
10683 @opindex mno-cond-exec
10684
10685 Disable the use of conditional execution.
10686
10687 This switch is mainly for debugging the compiler and will likely be removed
10688 in a future version.
10689
10690 @item -mvliw-branch
10691 @opindex mvliw-branch
10692
10693 Run a pass to pack branches into VLIW instructions (default).
10694
10695 This switch is mainly for debugging the compiler and will likely be removed
10696 in a future version.
10697
10698 @item -mno-vliw-branch
10699 @opindex mno-vliw-branch
10700
10701 Do not run a pass to pack branches into VLIW instructions.
10702
10703 This switch is mainly for debugging the compiler and will likely be removed
10704 in a future version.
10705
10706 @item -mmulti-cond-exec
10707 @opindex mmulti-cond-exec
10708
10709 Enable optimization of @code{&&} and @code{||} in conditional execution
10710 (default).
10711
10712 This switch is mainly for debugging the compiler and will likely be removed
10713 in a future version.
10714
10715 @item -mno-multi-cond-exec
10716 @opindex mno-multi-cond-exec
10717
10718 Disable optimization of @code{&&} and @code{||} in conditional execution.
10719
10720 This switch is mainly for debugging the compiler and will likely be removed
10721 in a future version.
10722
10723 @item -mnested-cond-exec
10724 @opindex mnested-cond-exec
10725
10726 Enable nested conditional execution optimizations (default).
10727
10728 This switch is mainly for debugging the compiler and will likely be removed
10729 in a future version.
10730
10731 @item -mno-nested-cond-exec
10732 @opindex mno-nested-cond-exec
10733
10734 Disable nested conditional execution optimizations.
10735
10736 This switch is mainly for debugging the compiler and will likely be removed
10737 in a future version.
10738
10739 @item -mtomcat-stats
10740 @opindex mtomcat-stats
10741
10742 Cause gas to print out tomcat statistics.
10743
10744 @item -mcpu=@var{cpu}
10745 @opindex mcpu
10746
10747 Select the processor type for which to generate code.  Possible values are
10748 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10749 @samp{frv}.
10750
10751 @end table
10752
10753 @node Xtensa Options
10754 @subsection Xtensa Options
10755 @cindex Xtensa Options
10756
10757 The Xtensa architecture is designed to support many different
10758 configurations.  The compiler's default options can be set to match a
10759 particular Xtensa configuration by copying a configuration file into the
10760 GCC sources when building GCC@.  The options below may be used to
10761 override the default options.
10762
10763 @table @gcctabopt
10764 @item -mbig-endian
10765 @itemx -mlittle-endian
10766 @opindex mbig-endian
10767 @opindex mlittle-endian
10768 Specify big-endian or little-endian byte ordering for the target Xtensa
10769 processor.
10770
10771 @item -mdensity
10772 @itemx -mno-density
10773 @opindex mdensity
10774 @opindex mno-density
10775 Enable or disable use of the optional Xtensa code density instructions.
10776
10777 @item -mconst16
10778 @itemx -mno-const16
10779 @opindex mconst16
10780 @opindex mno-const16
10781 Enable or disable use of @code{CONST16} instructions for loading
10782 constant values.  The @code{CONST16} instruction is currently not a
10783 standard option from Tensilica.  When enabled, @code{CONST16}
10784 instructions are always used in place of the standard @code{L32R}
10785 instructions.  The use of @code{CONST16} is enabled by default only if
10786 the @code{L32R} instruction is not available.
10787
10788 @item -mabs
10789 @itemx -mno-abs
10790 @opindex mabs
10791 @opindex mno-abs
10792 Enable or disable use of the Xtensa @code{ABS} instruction for absolute
10793 value operations.
10794
10795 @item -maddx
10796 @itemx -mno-addx
10797 @opindex maddx
10798 @opindex mno-addx
10799 Enable or disable use of the Xtensa @code{ADDX} and @code{SUBX}
10800 instructions.
10801
10802 @item -mmac16
10803 @itemx -mno-mac16
10804 @opindex mmac16
10805 @opindex mno-mac16
10806 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10807 will generate MAC16 instructions from standard C code, with the
10808 limitation that it will use neither the MR register file nor any
10809 instruction that operates on the MR registers.  When this option is
10810 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10811 combination of core instructions and library calls, depending on whether
10812 any other multiplier options are enabled.
10813
10814 @item -mmul16
10815 @itemx -mno-mul16
10816 @opindex mmul16
10817 @opindex mno-mul16
10818 Enable or disable use of the 16-bit integer multiplier option.  When
10819 enabled, the compiler will generate 16-bit multiply instructions for
10820 multiplications of 16 bits or smaller in standard C code.  When this
10821 option is disabled, the compiler will either use 32-bit multiply or
10822 MAC16 instructions if they are available or generate library calls to
10823 perform the multiply operations using shifts and adds.
10824
10825 @item -mmul32
10826 @itemx -mno-mul32
10827 @opindex mmul32
10828 @opindex mno-mul32
10829 Enable or disable use of the 32-bit integer multiplier option.  When
10830 enabled, the compiler will generate 32-bit multiply instructions for
10831 multiplications of 32 bits or smaller in standard C code.  When this
10832 option is disabled, the compiler will generate library calls to perform
10833 the multiply operations using either shifts and adds or 16-bit multiply
10834 instructions if they are available.
10835
10836 @item -mnsa
10837 @itemx -mno-nsa
10838 @opindex mnsa
10839 @opindex mno-nsa
10840 Enable or disable use of the optional normalization shift amount
10841 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10842
10843 @item -mminmax
10844 @itemx -mno-minmax
10845 @opindex mminmax
10846 @opindex mno-minmax
10847 Enable or disable use of the optional minimum and maximum value
10848 instructions.
10849
10850 @item -msext
10851 @itemx -mno-sext
10852 @opindex msext
10853 @opindex mno-sext
10854 Enable or disable use of the optional sign extend (@code{SEXT})
10855 instruction.
10856
10857 @item -mbooleans
10858 @itemx -mno-booleans
10859 @opindex mbooleans
10860 @opindex mno-booleans
10861 Enable or disable support for the boolean register file used by Xtensa
10862 coprocessors.  This is not typically useful by itself but may be
10863 required for other options that make use of the boolean registers (e.g.,
10864 the floating-point option).
10865
10866 @item -mhard-float
10867 @itemx -msoft-float
10868 @opindex mhard-float
10869 @opindex msoft-float
10870 Enable or disable use of the floating-point option.  When enabled, GCC
10871 generates floating-point instructions for 32-bit @code{float}
10872 operations.  When this option is disabled, GCC generates library calls
10873 to emulate 32-bit floating-point operations using integer instructions.
10874 Regardless of this option, 64-bit @code{double} operations are always
10875 emulated with calls to library functions.
10876
10877 @item -mfused-madd
10878 @itemx -mno-fused-madd
10879 @opindex mfused-madd
10880 @opindex mno-fused-madd
10881 Enable or disable use of fused multiply/add and multiply/subtract
10882 instructions in the floating-point option.  This has no effect if the
10883 floating-point option is not also enabled.  Disabling fused multiply/add
10884 and multiply/subtract instructions forces the compiler to use separate
10885 instructions for the multiply and add/subtract operations.  This may be
10886 desirable in some cases where strict IEEE 754-compliant results are
10887 required: the fused multiply add/subtract instructions do not round the
10888 intermediate result, thereby producing results with @emph{more} bits of
10889 precision than specified by the IEEE standard.  Disabling fused multiply
10890 add/subtract instructions also ensures that the program output is not
10891 sensitive to the compiler's ability to combine multiply and add/subtract
10892 operations.
10893
10894 @item -mtext-section-literals
10895 @itemx -mno-text-section-literals
10896 @opindex mtext-section-literals
10897 @opindex mno-text-section-literals
10898 Control the treatment of literal pools.  The default is
10899 @option{-mno-text-section-literals}, which places literals in a separate
10900 section in the output file.  This allows the literal pool to be placed
10901 in a data RAM/ROM, and it also allows the linker to combine literal
10902 pools from separate object files to remove redundant literals and
10903 improve code size.  With @option{-mtext-section-literals}, the literals
10904 are interspersed in the text section in order to keep them as close as
10905 possible to their references.  This may be necessary for large assembly
10906 files.
10907
10908 @item -mtarget-align
10909 @itemx -mno-target-align
10910 @opindex mtarget-align
10911 @opindex mno-target-align
10912 When this option is enabled, GCC instructs the assembler to
10913 automatically align instructions to reduce branch penalties at the
10914 expense of some code density.  The assembler attempts to widen density
10915 instructions to align branch targets and the instructions following call
10916 instructions.  If there are not enough preceding safe density
10917 instructions to align a target, no widening will be performed.  The
10918 default is @option{-mtarget-align}.  These options do not affect the
10919 treatment of auto-aligned instructions like @code{LOOP}, which the
10920 assembler will always align, either by widening density instructions or
10921 by inserting no-op instructions.
10922
10923 @item -mlongcalls
10924 @itemx -mno-longcalls
10925 @opindex mlongcalls
10926 @opindex mno-longcalls
10927 When this option is enabled, GCC instructs the assembler to translate
10928 direct calls to indirect calls unless it can determine that the target
10929 of a direct call is in the range allowed by the call instruction.  This
10930 translation typically occurs for calls to functions in other source
10931 files.  Specifically, the assembler translates a direct @code{CALL}
10932 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10933 The default is @option{-mno-longcalls}.  This option should be used in
10934 programs where the call target can potentially be out of range.  This
10935 option is implemented in the assembler, not the compiler, so the
10936 assembly code generated by GCC will still show direct call
10937 instructions---look at the disassembled object code to see the actual
10938 instructions.  Note that the assembler will use an indirect call for
10939 every cross-file call, not just those that really will be out of range.
10940 @end table
10941
10942 @node Code Gen Options
10943 @section Options for Code Generation Conventions
10944 @cindex code generation conventions
10945 @cindex options, code generation
10946 @cindex run-time options
10947
10948 These machine-independent options control the interface conventions
10949 used in code generation.
10950
10951 Most of them have both positive and negative forms; the negative form
10952 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10953 one of the forms is listed---the one which is not the default.  You
10954 can figure out the other form by either removing @samp{no-} or adding
10955 it.
10956
10957 @table @gcctabopt
10958 @item -fbounds-check
10959 @opindex fbounds-check
10960 For front-ends that support it, generate additional code to check that
10961 indices used to access arrays are within the declared range.  This is
10962 currently only supported by the Java and Fortran 77 front-ends, where
10963 this option defaults to true and false respectively.
10964
10965 @item -ftrapv
10966 @opindex ftrapv
10967 This option generates traps for signed overflow on addition, subtraction,
10968 multiplication operations.
10969
10970 @item -fwrapv
10971 @opindex fwrapv
10972 This option instructs the compiler to assume that signed arithmetic
10973 overflow of addition, subtraction and multiplication wraps around
10974 using twos-complement representation.  This flag enables some optimizations
10975 and disables other.  This option is enabled by default for the Java
10976 front-end, as required by the Java language specification.
10977
10978 @item -fexceptions
10979 @opindex fexceptions
10980 Enable exception handling.  Generates extra code needed to propagate
10981 exceptions.  For some targets, this implies GCC will generate frame
10982 unwind information for all functions, which can produce significant data
10983 size overhead, although it does not affect execution.  If you do not
10984 specify this option, GCC will enable it by default for languages like
10985 C++ which normally require exception handling, and disable it for
10986 languages like C that do not normally require it.  However, you may need
10987 to enable this option when compiling C code that needs to interoperate
10988 properly with exception handlers written in C++.  You may also wish to
10989 disable this option if you are compiling older C++ programs that don't
10990 use exception handling.
10991
10992 @item -fnon-call-exceptions
10993 @opindex fnon-call-exceptions
10994 Generate code that allows trapping instructions to throw exceptions.
10995 Note that this requires platform-specific runtime support that does
10996 not exist everywhere.  Moreover, it only allows @emph{trapping}
10997 instructions to throw exceptions, i.e.@: memory references or floating
10998 point instructions.  It does not allow exceptions to be thrown from
10999 arbitrary signal handlers such as @code{SIGALRM}.
11000
11001 @item -funwind-tables
11002 @opindex funwind-tables
11003 Similar to @option{-fexceptions}, except that it will just generate any needed
11004 static data, but will not affect the generated code in any other way.
11005 You will normally not enable this option; instead, a language processor
11006 that needs this handling would enable it on your behalf.
11007
11008 @item -fasynchronous-unwind-tables
11009 @opindex funwind-tables
11010 Generate unwind table in dwarf2 format, if supported by target machine.  The
11011 table is exact at each instruction boundary, so it can be used for stack
11012 unwinding from asynchronous events (such as debugger or garbage collector).
11013
11014 @item -fpcc-struct-return
11015 @opindex fpcc-struct-return
11016 Return ``short'' @code{struct} and @code{union} values in memory like
11017 longer ones, rather than in registers.  This convention is less
11018 efficient, but it has the advantage of allowing intercallability between
11019 GCC-compiled files and files compiled with other compilers, particularly
11020 the Portable C Compiler (pcc).
11021
11022 The precise convention for returning structures in memory depends
11023 on the target configuration macros.
11024
11025 Short structures and unions are those whose size and alignment match
11026 that of some integer type.
11027
11028 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11029 switch is not binary compatible with code compiled with the
11030 @option{-freg-struct-return} switch.
11031 Use it to conform to a non-default application binary interface.
11032
11033 @item -freg-struct-return
11034 @opindex freg-struct-return
11035 Return @code{struct} and @code{union} values in registers when possible.
11036 This is more efficient for small structures than
11037 @option{-fpcc-struct-return}.
11038
11039 If you specify neither @option{-fpcc-struct-return} nor
11040 @option{-freg-struct-return}, GCC defaults to whichever convention is
11041 standard for the target.  If there is no standard convention, GCC
11042 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11043 the principal compiler.  In those cases, we can choose the standard, and
11044 we chose the more efficient register return alternative.
11045
11046 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11047 switch is not binary compatible with code compiled with the
11048 @option{-fpcc-struct-return} switch.
11049 Use it to conform to a non-default application binary interface.
11050
11051 @item -fshort-enums
11052 @opindex fshort-enums
11053 Allocate to an @code{enum} type only as many bytes as it needs for the
11054 declared range of possible values.  Specifically, the @code{enum} type
11055 will be equivalent to the smallest integer type which has enough room.
11056
11057 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11058 code that is not binary compatible with code generated without that switch.
11059 Use it to conform to a non-default application binary interface.
11060
11061 @item -fshort-double
11062 @opindex fshort-double
11063 Use the same size for @code{double} as for @code{float}.
11064
11065 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11066 code that is not binary compatible with code generated without that switch.
11067 Use it to conform to a non-default application binary interface.
11068
11069 @item -fshort-wchar
11070 @opindex fshort-wchar
11071 Override the underlying type for @samp{wchar_t} to be @samp{short
11072 unsigned int} instead of the default for the target.  This option is
11073 useful for building programs to run under WINE@.
11074
11075 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11076 code that is not binary compatible with code generated without that switch.
11077 Use it to conform to a non-default application binary interface.
11078
11079 @item -fshared-data
11080 @opindex fshared-data
11081 Requests that the data and non-@code{const} variables of this
11082 compilation be shared data rather than private data.  The distinction
11083 makes sense only on certain operating systems, where shared data is
11084 shared between processes running the same program, while private data
11085 exists in one copy per process.
11086
11087 @item -fno-common
11088 @opindex fno-common
11089 In C, allocate even uninitialized global variables in the data section of the
11090 object file, rather than generating them as common blocks.  This has the
11091 effect that if the same variable is declared (without @code{extern}) in
11092 two different compilations, you will get an error when you link them.
11093 The only reason this might be useful is if you wish to verify that the
11094 program will work on other systems which always work this way.
11095
11096 @item -fno-ident
11097 @opindex fno-ident
11098 Ignore the @samp{#ident} directive.
11099
11100 @item -fno-gnu-linker
11101 @opindex fno-gnu-linker
11102 Do not output global initializations (such as C++ constructors and
11103 destructors) in the form used by the GNU linker (on systems where the GNU
11104 linker is the standard method of handling them).  Use this option when
11105 you want to use a non-GNU linker, which also requires using the
11106 @command{collect2} program to make sure the system linker includes
11107 constructors and destructors.  (@command{collect2} is included in the GCC
11108 distribution.)  For systems which @emph{must} use @command{collect2}, the
11109 compiler driver @command{gcc} is configured to do this automatically.
11110
11111 @item -finhibit-size-directive
11112 @opindex finhibit-size-directive
11113 Don't output a @code{.size} assembler directive, or anything else that
11114 would cause trouble if the function is split in the middle, and the
11115 two halves are placed at locations far apart in memory.  This option is
11116 used when compiling @file{crtstuff.c}; you should not need to use it
11117 for anything else.
11118
11119 @item -fverbose-asm
11120 @opindex fverbose-asm
11121 Put extra commentary information in the generated assembly code to
11122 make it more readable.  This option is generally only of use to those
11123 who actually need to read the generated assembly code (perhaps while
11124 debugging the compiler itself).
11125
11126 @option{-fno-verbose-asm}, the default, causes the
11127 extra information to be omitted and is useful when comparing two assembler
11128 files.
11129
11130 @item -fpic
11131 @opindex fpic
11132 @cindex global offset table
11133 @cindex PIC
11134 Generate position-independent code (PIC) suitable for use in a shared
11135 library, if supported for the target machine.  Such code accesses all
11136 constant addresses through a global offset table (GOT)@.  The dynamic
11137 loader resolves the GOT entries when the program starts (the dynamic
11138 loader is not part of GCC; it is part of the operating system).  If
11139 the GOT size for the linked executable exceeds a machine-specific
11140 maximum size, you get an error message from the linker indicating that
11141 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11142 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11143 on the m68k and RS/6000.  The 386 has no such limit.)
11144
11145 Position-independent code requires special support, and therefore works
11146 only on certain machines.  For the 386, GCC supports PIC for System V
11147 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11148 position-independent.
11149
11150 @item -fPIC
11151 @opindex fPIC
11152 If supported for the target machine, emit position-independent code,
11153 suitable for dynamic linking and avoiding any limit on the size of the
11154 global offset table.  This option makes a difference on the m68k, m88k,
11155 and the SPARC.
11156
11157 Position-independent code requires special support, and therefore works
11158 only on certain machines.
11159
11160 @item -fpie
11161 @itemx -fPIE
11162 @opindex fpie
11163 @opindex fPIE
11164 These options are similar to @option{-fpic} and @option{-fPIC}, but
11165 generated position independent code can be only linked into executables.
11166 Usually these options are used when @option{-pie} GCC option will be
11167 used during linking.
11168
11169 @item -ffixed-@var{reg}
11170 @opindex ffixed
11171 Treat the register named @var{reg} as a fixed register; generated code
11172 should never refer to it (except perhaps as a stack pointer, frame
11173 pointer or in some other fixed role).
11174
11175 @var{reg} must be the name of a register.  The register names accepted
11176 are machine-specific and are defined in the @code{REGISTER_NAMES}
11177 macro in the machine description macro file.
11178
11179 This flag does not have a negative form, because it specifies a
11180 three-way choice.
11181
11182 @item -fcall-used-@var{reg}
11183 @opindex fcall-used
11184 Treat the register named @var{reg} as an allocable register that is
11185 clobbered by function calls.  It may be allocated for temporaries or
11186 variables that do not live across a call.  Functions compiled this way
11187 will not save and restore the register @var{reg}.
11188
11189 It is an error to used this flag with the frame pointer or stack pointer.
11190 Use of this flag for other registers that have fixed pervasive roles in
11191 the machine's execution model will produce disastrous results.
11192
11193 This flag does not have a negative form, because it specifies a
11194 three-way choice.
11195
11196 @item -fcall-saved-@var{reg}
11197 @opindex fcall-saved
11198 Treat the register named @var{reg} as an allocable register saved by
11199 functions.  It may be allocated even for temporaries or variables that
11200 live across a call.  Functions compiled this way will save and restore
11201 the register @var{reg} if they use it.
11202
11203 It is an error to used this flag with the frame pointer or stack pointer.
11204 Use of this flag for other registers that have fixed pervasive roles in
11205 the machine's execution model will produce disastrous results.
11206
11207 A different sort of disaster will result from the use of this flag for
11208 a register in which function values may be returned.
11209
11210 This flag does not have a negative form, because it specifies a
11211 three-way choice.
11212
11213 @item -fpack-struct
11214 @opindex fpack-struct
11215 Pack all structure members together without holes.
11216
11217 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11218 code that is not binary compatible with code generated without that switch.
11219 Additionally, it makes the code suboptimal.
11220 Use it to conform to a non-default application binary interface.
11221
11222 @item -finstrument-functions
11223 @opindex finstrument-functions
11224 Generate instrumentation calls for entry and exit to functions.  Just
11225 after function entry and just before function exit, the following
11226 profiling functions will be called with the address of the current
11227 function and its call site.  (On some platforms,
11228 @code{__builtin_return_address} does not work beyond the current
11229 function, so the call site information may not be available to the
11230 profiling functions otherwise.)
11231
11232 @example
11233 void __cyg_profile_func_enter (void *this_fn,
11234                                void *call_site);
11235 void __cyg_profile_func_exit  (void *this_fn,
11236                                void *call_site);
11237 @end example
11238
11239 The first argument is the address of the start of the current function,
11240 which may be looked up exactly in the symbol table.
11241
11242 This instrumentation is also done for functions expanded inline in other
11243 functions.  The profiling calls will indicate where, conceptually, the
11244 inline function is entered and exited.  This means that addressable
11245 versions of such functions must be available.  If all your uses of a
11246 function are expanded inline, this may mean an additional expansion of
11247 code size.  If you use @samp{extern inline} in your C code, an
11248 addressable version of such functions must be provided.  (This is
11249 normally the case anyways, but if you get lucky and the optimizer always
11250 expands the functions inline, you might have gotten away without
11251 providing static copies.)
11252
11253 A function may be given the attribute @code{no_instrument_function}, in
11254 which case this instrumentation will not be done.  This can be used, for
11255 example, for the profiling functions listed above, high-priority
11256 interrupt routines, and any functions from which the profiling functions
11257 cannot safely be called (perhaps signal handlers, if the profiling
11258 routines generate output or allocate memory).
11259
11260 @item -fstack-check
11261 @opindex fstack-check
11262 Generate code to verify that you do not go beyond the boundary of the
11263 stack.  You should specify this flag if you are running in an
11264 environment with multiple threads, but only rarely need to specify it in
11265 a single-threaded environment since stack overflow is automatically
11266 detected on nearly all systems if there is only one stack.
11267
11268 Note that this switch does not actually cause checking to be done; the
11269 operating system must do that.  The switch causes generation of code
11270 to ensure that the operating system sees the stack being extended.
11271
11272 @item -fstack-limit-register=@var{reg}
11273 @itemx -fstack-limit-symbol=@var{sym}
11274 @itemx -fno-stack-limit
11275 @opindex fstack-limit-register
11276 @opindex fstack-limit-symbol
11277 @opindex fno-stack-limit
11278 Generate code to ensure that the stack does not grow beyond a certain value,
11279 either the value of a register or the address of a symbol.  If the stack
11280 would grow beyond the value, a signal is raised.  For most targets,
11281 the signal is raised before the stack overruns the boundary, so
11282 it is possible to catch the signal without taking special precautions.
11283
11284 For instance, if the stack starts at absolute address @samp{0x80000000}
11285 and grows downwards, you can use the flags
11286 @option{-fstack-limit-symbol=__stack_limit} and
11287 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11288 of 128KB@.  Note that this may only work with the GNU linker.
11289
11290 @cindex aliasing of parameters
11291 @cindex parameters, aliased
11292 @item -fargument-alias
11293 @itemx -fargument-noalias
11294 @itemx -fargument-noalias-global
11295 @opindex fargument-alias
11296 @opindex fargument-noalias
11297 @opindex fargument-noalias-global
11298 Specify the possible relationships among parameters and between
11299 parameters and global data.
11300
11301 @option{-fargument-alias} specifies that arguments (parameters) may
11302 alias each other and may alias global storage.@*
11303 @option{-fargument-noalias} specifies that arguments do not alias
11304 each other, but may alias global storage.@*
11305 @option{-fargument-noalias-global} specifies that arguments do not
11306 alias each other and do not alias global storage.
11307
11308 Each language will automatically use whatever option is required by
11309 the language standard.  You should not need to use these options yourself.
11310
11311 @item -fleading-underscore
11312 @opindex fleading-underscore
11313 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11314 change the way C symbols are represented in the object file.  One use
11315 is to help link with legacy assembly code.
11316
11317 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11318 generate code that is not binary compatible with code generated without that
11319 switch.  Use it to conform to a non-default application binary interface.
11320 Not all targets provide complete support for this switch.
11321
11322 @item -ftls-model=@var{model}
11323 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11324 The @var{model} argument should be one of @code{global-dynamic},
11325 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11326
11327 The default without @option{-fpic} is @code{initial-exec}; with
11328 @option{-fpic} the default is @code{global-dynamic}.
11329 @end table
11330
11331 @c man end
11332
11333 @node Environment Variables
11334 @section Environment Variables Affecting GCC
11335 @cindex environment variables
11336
11337 @c man begin ENVIRONMENT
11338 This section describes several environment variables that affect how GCC
11339 operates.  Some of them work by specifying directories or prefixes to use
11340 when searching for various kinds of files.  Some are used to specify other
11341 aspects of the compilation environment.
11342
11343 Note that you can also specify places to search using options such as
11344 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11345 take precedence over places specified using environment variables, which
11346 in turn take precedence over those specified by the configuration of GCC@.
11347 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11348 GNU Compiler Collection (GCC) Internals}.
11349
11350 @table @env
11351 @item LANG
11352 @itemx LC_CTYPE
11353 @c @itemx LC_COLLATE
11354 @itemx LC_MESSAGES
11355 @c @itemx LC_MONETARY
11356 @c @itemx LC_NUMERIC
11357 @c @itemx LC_TIME
11358 @itemx LC_ALL
11359 @findex LANG
11360 @findex LC_CTYPE
11361 @c @findex LC_COLLATE
11362 @findex LC_MESSAGES
11363 @c @findex LC_MONETARY
11364 @c @findex LC_NUMERIC
11365 @c @findex LC_TIME
11366 @findex LC_ALL
11367 @cindex locale
11368 These environment variables control the way that GCC uses
11369 localization information that allow GCC to work with different
11370 national conventions.  GCC inspects the locale categories
11371 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11372 so.  These locale categories can be set to any value supported by your
11373 installation.  A typical value is @samp{en_UK} for English in the United
11374 Kingdom.
11375
11376 The @env{LC_CTYPE} environment variable specifies character
11377 classification.  GCC uses it to determine the character boundaries in
11378 a string; this is needed for some multibyte encodings that contain quote
11379 and escape characters that would otherwise be interpreted as a string
11380 end or escape.
11381
11382 The @env{LC_MESSAGES} environment variable specifies the language to
11383 use in diagnostic messages.
11384
11385 If the @env{LC_ALL} environment variable is set, it overrides the value
11386 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11387 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11388 environment variable.  If none of these variables are set, GCC
11389 defaults to traditional C English behavior.
11390
11391 @item TMPDIR
11392 @findex TMPDIR
11393 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11394 files.  GCC uses temporary files to hold the output of one stage of
11395 compilation which is to be used as input to the next stage: for example,
11396 the output of the preprocessor, which is the input to the compiler
11397 proper.
11398
11399 @item GCC_EXEC_PREFIX
11400 @findex GCC_EXEC_PREFIX
11401 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11402 names of the subprograms executed by the compiler.  No slash is added
11403 when this prefix is combined with the name of a subprogram, but you can
11404 specify a prefix that ends with a slash if you wish.
11405
11406 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11407 an appropriate prefix to use based on the pathname it was invoked with.
11408
11409 If GCC cannot find the subprogram using the specified prefix, it
11410 tries looking in the usual places for the subprogram.
11411
11412 The default value of @env{GCC_EXEC_PREFIX} is
11413 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11414 of @code{prefix} when you ran the @file{configure} script.
11415
11416 Other prefixes specified with @option{-B} take precedence over this prefix.
11417
11418 This prefix is also used for finding files such as @file{crt0.o} that are
11419 used for linking.
11420
11421 In addition, the prefix is used in an unusual way in finding the
11422 directories to search for header files.  For each of the standard
11423 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11424 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11425 replacing that beginning with the specified prefix to produce an
11426 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11427 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11428 These alternate directories are searched first; the standard directories
11429 come next.
11430
11431 @item COMPILER_PATH
11432 @findex COMPILER_PATH
11433 The value of @env{COMPILER_PATH} is a colon-separated list of
11434 directories, much like @env{PATH}.  GCC tries the directories thus
11435 specified when searching for subprograms, if it can't find the
11436 subprograms using @env{GCC_EXEC_PREFIX}.
11437
11438 @item LIBRARY_PATH
11439 @findex LIBRARY_PATH
11440 The value of @env{LIBRARY_PATH} is a colon-separated list of
11441 directories, much like @env{PATH}.  When configured as a native compiler,
11442 GCC tries the directories thus specified when searching for special
11443 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11444 using GCC also uses these directories when searching for ordinary
11445 libraries for the @option{-l} option (but directories specified with
11446 @option{-L} come first).
11447
11448 @item LANG
11449 @findex LANG
11450 @cindex locale definition
11451 This variable is used to pass locale information to the compiler.  One way in
11452 which this information is used is to determine the character set to be used
11453 when character literals, string literals and comments are parsed in C and C++.
11454 When the compiler is configured to allow multibyte characters,
11455 the following values for @env{LANG} are recognized:
11456
11457 @table @samp
11458 @item C-JIS
11459 Recognize JIS characters.
11460 @item C-SJIS
11461 Recognize SJIS characters.
11462 @item C-EUCJP
11463 Recognize EUCJP characters.
11464 @end table
11465
11466 If @env{LANG} is not defined, or if it has some other value, then the
11467 compiler will use mblen and mbtowc as defined by the default locale to
11468 recognize and translate multibyte characters.
11469 @end table
11470
11471 @noindent
11472 Some additional environments variables affect the behavior of the
11473 preprocessor.
11474
11475 @include cppenv.texi
11476
11477 @c man end
11478
11479 @node Precompiled Headers
11480 @section Using Precompiled Headers
11481 @cindex precompiled headers
11482 @cindex speed of compilation
11483
11484 Often large projects have many header files that are included in every
11485 source file.  The time the compiler takes to process these header files
11486 over and over again can account for nearly all of the time required to
11487 build the project.  To make builds faster, GCC allows users to
11488 `precompile' a header file; then, if builds can use the precompiled
11489 header file they will be much faster.
11490
11491 To create a precompiled header file, simply compile it as you would any
11492 other file, if necessary using the @option{-x} option to make the driver
11493 treat it as a C or C++ header file.  You will probably want to use a
11494 tool like @command{make} to keep the precompiled header up-to-date when
11495 the headers it contains change.
11496
11497 A precompiled header file will be searched for when @code{#include} is
11498 seen in the compilation.  As it searches for the included file
11499 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11500 compiler looks for a precompiled header in each directory just before it
11501 looks for the include file in that directory.  The name searched for is
11502 the name specified in the @code{#include} with @samp{.gch} appended.  If
11503 the precompiled header file can't be used, it is ignored.
11504
11505 For instance, if you have @code{#include "all.h"}, and you have
11506 @file{all.h.gch} in the same directory as @file{all.h}, then the
11507 precompiled header file will be used if possible, and the original
11508 header will be used otherwise.
11509
11510 Alternatively, you might decide to put the precompiled header file in a
11511 directory and use @option{-I} to ensure that directory is searched
11512 before (or instead of) the directory containing the original header.
11513 Then, if you want to check that the precompiled header file is always
11514 used, you can put a file of the same name as the original header in this
11515 directory containing an @code{#error} command.
11516
11517 This also works with @option{-include}.  So yet another way to use
11518 precompiled headers, good for projects not designed with precompiled
11519 header files in mind, is to simply take most of the header files used by
11520 a project, include them from another header file, precompile that header
11521 file, and @option{-include} the precompiled header.  If the header files
11522 have guards against multiple inclusion, they will be skipped because
11523 they've already been included (in the precompiled header).
11524
11525 If you need to precompile the same header file for different
11526 languages, targets, or compiler options, you can instead make a
11527 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11528 header in the directory.  (It doesn't matter what you call the files
11529 in the directory, every precompiled header in the directory will be
11530 considered.)  The first precompiled header encountered in the
11531 directory that is valid for this compilation will be used; they're
11532 searched in no particular order.
11533
11534 There are many other possibilities, limited only by your imagination,
11535 good sense, and the constraints of your build system.
11536
11537 A precompiled header file can be used only when these conditions apply:
11538
11539 @itemize
11540 @item
11541 Only one precompiled header can be used in a particular compilation.
11542 @item
11543 A precompiled header can't be used once the first C token is seen.  You
11544 can have preprocessor directives before a precompiled header; you can
11545 even include a precompiled header from inside another header, so long as
11546 there are no C tokens before the @code{#include}.
11547 @item
11548 The precompiled header file must be produced for the same language as
11549 the current compilation.  You can't use a C precompiled header for a C++
11550 compilation.
11551 @item
11552 The precompiled header file must be produced by the same compiler
11553 version and configuration as the current compilation is using.
11554 The easiest way to guarantee this is to use the same compiler binary
11555 for creating and using precompiled headers.
11556 @item
11557 Any macros defined before the precompiled header (including with
11558 @option{-D}) must either be defined in the same way as when the
11559 precompiled header was generated, or must not affect the precompiled
11560 header, which usually means that the they don't appear in the
11561 precompiled header at all.
11562 @item
11563 Certain command-line options must be defined in the same way as when the
11564 precompiled header was generated.  At present, it's not clear which
11565 options are safe to change and which are not; the safest choice is to
11566 use exactly the same options when generating and using the precompiled
11567 header.
11568 @end itemize
11569
11570 For all of these but the last, the compiler will automatically ignore
11571 the precompiled header if the conditions aren't met.  For the last item,
11572 some option changes will cause the precompiled header to be rejected,
11573 but not all incompatible option combinations have yet been found.  If
11574 you find a new incompatible combination, please consider filing a bug
11575 report, see @ref{Bugs}.
11576
11577 @node Running Protoize
11578 @section Running Protoize
11579
11580 The program @code{protoize} is an optional part of GCC@.  You can use
11581 it to add prototypes to a program, thus converting the program to ISO
11582 C in one respect.  The companion program @code{unprotoize} does the
11583 reverse: it removes argument types from any prototypes that are found.
11584
11585 When you run these programs, you must specify a set of source files as
11586 command line arguments.  The conversion programs start out by compiling
11587 these files to see what functions they define.  The information gathered
11588 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11589
11590 After scanning comes actual conversion.  The specified files are all
11591 eligible to be converted; any files they include (whether sources or
11592 just headers) are eligible as well.
11593
11594 But not all the eligible files are converted.  By default,
11595 @code{protoize} and @code{unprotoize} convert only source and header
11596 files in the current directory.  You can specify additional directories
11597 whose files should be converted with the @option{-d @var{directory}}
11598 option.  You can also specify particular files to exclude with the
11599 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11600 directory name matches one of the specified directory names, and its
11601 name within the directory has not been excluded.
11602
11603 Basic conversion with @code{protoize} consists of rewriting most
11604 function definitions and function declarations to specify the types of
11605 the arguments.  The only ones not rewritten are those for varargs
11606 functions.
11607
11608 @code{protoize} optionally inserts prototype declarations at the
11609 beginning of the source file, to make them available for any calls that
11610 precede the function's definition.  Or it can insert prototype
11611 declarations with block scope in the blocks where undeclared functions
11612 are called.
11613
11614 Basic conversion with @code{unprotoize} consists of rewriting most
11615 function declarations to remove any argument types, and rewriting
11616 function definitions to the old-style pre-ISO form.
11617
11618 Both conversion programs print a warning for any function declaration or
11619 definition that they can't convert.  You can suppress these warnings
11620 with @option{-q}.
11621
11622 The output from @code{protoize} or @code{unprotoize} replaces the
11623 original source file.  The original file is renamed to a name ending
11624 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11625 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11626 for DOS) file already exists, then the source file is simply discarded.
11627
11628 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11629 scan the program and collect information about the functions it uses.
11630 So neither of these programs will work until GCC is installed.
11631
11632 Here is a table of the options you can use with @code{protoize} and
11633 @code{unprotoize}.  Each option works with both programs unless
11634 otherwise stated.
11635
11636 @table @code
11637 @item -B @var{directory}
11638 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11639 usual directory (normally @file{/usr/local/lib}).  This file contains
11640 prototype information about standard system functions.  This option
11641 applies only to @code{protoize}.
11642
11643 @item -c @var{compilation-options}
11644 Use @var{compilation-options} as the options when running @command{gcc} to
11645 produce the @samp{.X} files.  The special option @option{-aux-info} is
11646 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11647
11648 Note that the compilation options must be given as a single argument to
11649 @code{protoize} or @code{unprotoize}.  If you want to specify several
11650 @command{gcc} options, you must quote the entire set of compilation options
11651 to make them a single word in the shell.
11652
11653 There are certain @command{gcc} arguments that you cannot use, because they
11654 would produce the wrong kind of output.  These include @option{-g},
11655 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11656 the @var{compilation-options}, they are ignored.
11657
11658 @item -C
11659 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11660 systems) instead of @samp{.c}.  This is convenient if you are converting
11661 a C program to C++.  This option applies only to @code{protoize}.
11662
11663 @item -g
11664 Add explicit global declarations.  This means inserting explicit
11665 declarations at the beginning of each source file for each function
11666 that is called in the file and was not declared.  These declarations
11667 precede the first function definition that contains a call to an
11668 undeclared function.  This option applies only to @code{protoize}.
11669
11670 @item -i @var{string}
11671 Indent old-style parameter declarations with the string @var{string}.
11672 This option applies only to @code{protoize}.
11673
11674 @code{unprotoize} converts prototyped function definitions to old-style
11675 function definitions, where the arguments are declared between the
11676 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11677 uses five spaces as the indentation.  If you want to indent with just
11678 one space instead, use @option{-i " "}.
11679
11680 @item -k
11681 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11682 is finished.
11683
11684 @item -l
11685 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11686 a prototype declaration for each function in each block which calls the
11687 function without any declaration.  This option applies only to
11688 @code{protoize}.
11689
11690 @item -n
11691 Make no real changes.  This mode just prints information about the conversions
11692 that would have been done without @option{-n}.
11693
11694 @item -N
11695 Make no @samp{.save} files.  The original files are simply deleted.
11696 Use this option with caution.
11697
11698 @item -p @var{program}
11699 Use the program @var{program} as the compiler.  Normally, the name
11700 @file{gcc} is used.
11701
11702 @item -q
11703 Work quietly.  Most warnings are suppressed.
11704
11705 @item -v
11706 Print the version number, just like @option{-v} for @command{gcc}.
11707 @end table
11708
11709 If you need special compiler options to compile one of your program's
11710 source files, then you should generate that file's @samp{.X} file
11711 specially, by running @command{gcc} on that source file with the
11712 appropriate options and the option @option{-aux-info}.  Then run
11713 @code{protoize} on the entire set of files.  @code{protoize} will use
11714 the existing @samp{.X} file because it is newer than the source file.
11715 For example:
11716
11717 @example
11718 gcc -Dfoo=bar file1.c -aux-info file1.X
11719 protoize *.c
11720 @end example
11721
11722 @noindent
11723 You need to include the special files along with the rest in the
11724 @code{protoize} command, even though their @samp{.X} files already
11725 exist, because otherwise they won't get converted.
11726
11727 @xref{Protoize Caveats}, for more information on how to use
11728 @code{protoize} successfully.