invoke.texi: Document -mzarch, -mesa, -mcpu= and -march= option for S/390 and zSeries.
[platform/upstream/gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002 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 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.1 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
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
80
81 @cindex C compilation options
82 Most of the command line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
87
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
91
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97 -r}}.
98
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several options
103 of the same kind; for example, if you specify @option{-L} more than once,
104 the directories are searched in the order specified.
105
106 Many options have long names starting with @samp{-f} or with
107 @samp{-W}---for example, @option{-fforce-mem},
108 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
109 these have both positive and negative forms; the negative form of
110 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
111 only one of these two forms, whichever one is not the default.
112
113 @c man end
114
115 @xref{Option Index}, for an index to GCC's options.
116
117 @menu
118 * Option Summary::      Brief list of all options, without explanations.
119 * Overall Options::     Controlling the kind of output:
120                         an executable, object files, assembler files,
121                         or preprocessed source.
122 * Invoking G++::        Compiling C++ programs.
123 * C Dialect Options::   Controlling the variant of C language compiled.
124 * C++ Dialect Options:: Variations on C++.
125 * Objective-C Dialect Options:: Variations on Objective-C.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
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{
159 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
160 -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{
165 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
166 -fno-asm  -fno-builtin -fno-builtin-@var{function} @gol
167 -fhosted  -ffreestanding  -fms-extensions @gol
168 -trigraphs  -traditional  -traditional-cpp @gol
169 -fallow-single-precision  -fcond-mismatch @gol
170 -fsigned-bitfields  -fsigned-char @gol
171 -funsigned-bitfields  -funsigned-char @gol
172 -fwritable-strings}
173
174 @item C++ Language Options
175 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
176 @gccoptlist{
177 -fabi-version=@var{n} -fno-access-control  -fcheck-new @gol
178 -fconserve-space -fno-const-strings  -fdollars-in-identifiers @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs  -fexternal-templates @gol
181 -falt-external-templates @gol
182 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
183 -fno-implicit-templates @gol
184 -fno-implicit-inline-templates @gol
185 -fno-implement-inlines  -fms-extensions @gol
186 -fno-nonansi-builtins  -fno-operator-names @gol
187 -fno-optional-diags  -fpermissive @gol
188 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
189 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
190 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo  -Wsynth}
196
197 @item Objective-C Language Options
198 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
199 @gccoptlist{
200 -fconstant-string-class=@var{class-name} @gol
201 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
202 -Wno-protocol  -Wselector -Wundeclared-selector}
203
204 @item Language Independent Options
205 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
206 @gccoptlist{
207 -fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{
213 -fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -W  -Wall -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wformat-nonliteral  -Wformat-security @gol
220 -Wimplicit  -Wimplicit-int  @gol
221 -Wimplicit-function-declaration @gol
222 -Werror-implicit-function-declaration @gol
223 -Wimport  -Winline -Wno-endif-labels @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
228 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
229 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
230 -Wreturn-type  -Wsequence-point  -Wshadow @gol
231 -Wsign-compare  -Wstrict-aliasing @gol
232 -Wswitch  -Wswitch-default -Wswitch-enum @gol
233 -Wsystem-headers -Wtrigraphs  -Wundef  -Wuninitialized @gol
234 -Wunknown-pragmas  -Wunreachable-code @gol
235 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
236 -Wunused-value  -Wunused-variable  -Wwrite-strings}
237
238 @item C-only Warning Options
239 @gccoptlist{
240 -Wbad-function-cast  -Wmissing-declarations @gol
241 -Wmissing-prototypes  -Wnested-externs @gol
242 -Wstrict-prototypes  -Wtraditional}
243
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{
247 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
248 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
249 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
252 -feliminate-dwarf2-dups  -fmem-report @gol
253 -fprofile-arcs  -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report @gol
255 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{
265 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
266 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
267 -fbounds-check @gol
268 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
274 -fif-conversion -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations -ffinite-math-only @gol
282 -fno-trapping-math -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -freduce-all-givs -fregmove  -frename-registers @gol
286 -freorder-blocks -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  -fsignaling-nans @gol
291 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
292 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
293 -ftrapv -funroll-all-loops  -funroll-loops  @gol
294 --param @var{name}=@var{value}
295 -O  -O0  -O1  -O2  -O3  -Os}
296
297 @item Preprocessor Options
298 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
299 @gccoptlist{
300 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
301 -C  -dD  -dI  -dM  -dN @gol
302 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
303 -idirafter @var{dir} @gol
304 -include @var{file}  -imacros @var{file} @gol
305 -iprefix @var{file}  -iwithprefix @var{dir} @gol
306 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
307 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
308 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
309
310 @item Assembler Option
311 @xref{Assembler Options,,Passing Options to the Assembler}.
312 @gccoptlist{
313 -Wa,@var{option} -Xassembler @var{option}}
314
315 @item Linker Options
316 @xref{Link Options,,Options for Linking}.
317 @gccoptlist{
318 @var{object-file-name}  -l@var{library} @gol
319 -nostartfiles  -nodefaultlibs  -nostdlib @gol
320 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
321 -Wl,@var{option}  -Xlinker @var{option} @gol
322 -u @var{symbol}}
323
324 @item Directory Options
325 @xref{Directory Options,,Options for Directory Search}.
326 @gccoptlist{
327 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
328
329 @item Target Options
330 @c I wrote this xref this way to avoid overfull hbox. -- rms
331 @xref{Target Options}.
332 @gccoptlist{
333 -V @var{version} -b @var{machine}}
334
335 @item Machine Dependent Options
336 @xref{Submodel Options,,Hardware Models and Configurations}.
337
338 @emph{M680x0 Options}
339 @gccoptlist{
340 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
341 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
342 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
343 -malign-int  -mstrict-align}
344
345 @emph{M68hc1x Options}
346 @gccoptlist{
347 -m6811  -m6812  -m68hc11  -m68hc12 @gol
348 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
349 -msoft-reg-count=@var{count}}
350
351 @emph{VAX Options}
352 @gccoptlist{
353 -mg  -mgnu  -munix}
354
355 @emph{SPARC Options}
356 @gccoptlist{
357 -mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32  -m64 @gol
361 -mapp-regs  -mbroken-saverestore  -mcypress @gol
362 -mfaster-structs  -mflat @gol
363 -mfpu  -mhard-float  -mhard-quad-float @gol
364 -mimpure-text  -mlive-g0  -mno-app-regs @gol
365 -mno-faster-structs  -mno-flat  -mno-fpu @gol
366 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
367 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
368 -msupersparc  -munaligned-doubles  -mv8}
369
370 @emph{Convex Options}
371 @gccoptlist{
372 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
373 -margcount  -mnoargcount @gol
374 -mlong32  -mlong64 @gol
375 -mvolatile-cache  -mvolatile-nocache}
376
377 @emph{AMD29K Options}
378 @gccoptlist{
379 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
380 -mlarge  -mnormal  -msmall @gol
381 -mkernel-registers  -mno-reuse-arg-regs @gol
382 -mno-stack-check  -mno-storem-bug @gol
383 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
384 -mstorem-bug  -muser-registers}
385
386 @emph{ARM Options}
387 @gccoptlist{
388 -mapcs-frame  -mno-apcs-frame @gol
389 -mapcs-26  -mapcs-32 @gol
390 -mapcs-stack-check  -mno-apcs-stack-check @gol
391 -mapcs-float  -mno-apcs-float @gol
392 -mapcs-reentrant  -mno-apcs-reentrant @gol
393 -msched-prolog  -mno-sched-prolog @gol
394 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
395 -malignment-traps  -mno-alignment-traps @gol
396 -msoft-float  -mhard-float  -mfpe @gol
397 -mthumb-interwork  -mno-thumb-interwork @gol
398 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
399 -mstructure-size-boundary=@var{n} @gol
400 -mbsd -mxopen  -mno-symrename @gol
401 -mabort-on-noreturn @gol
402 -mlong-calls  -mno-long-calls @gol
403 -msingle-pic-base  -mno-single-pic-base @gol
404 -mpic-register=@var{reg} @gol
405 -mnop-fun-dllimport @gol
406 -mpoke-function-name @gol
407 -mthumb  -marm @gol
408 -mtpcs-frame  -mtpcs-leaf-frame @gol
409 -mcaller-super-interworking  -mcallee-super-interworking }
410
411 @emph{MN10200 Options}
412 @gccoptlist{
413 -mrelax}
414
415 @emph{MN10300 Options}
416 @gccoptlist{
417 -mmult-bug  -mno-mult-bug @gol
418 -mam33  -mno-am33 @gol
419 -mno-crt0  -mrelax}
420
421 @emph{M32R/D Options}
422 @gccoptlist{
423 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
424 -G @var{num}}
425
426 @emph{M88K Options}
427 @gccoptlist{
428 -m88000  -m88100  -m88110  -mbig-pic @gol
429 -mcheck-zero-division  -mhandle-large-shift @gol
430 -midentify-revision  -mno-check-zero-division @gol
431 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
432 -mno-optimize-arg-area  -mno-serialize-volatile @gol
433 -mno-underscores  -mocs-debug-info @gol
434 -mocs-frame-position  -moptimize-arg-area @gol
435 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
436 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
437 -mversion-03.00  -mwarn-passed-structs}
438
439 @emph{RS/6000 and PowerPC Options}
440 @gccoptlist{
441 -mcpu=@var{cpu-type} @gol
442 -mtune=@var{cpu-type} @gol
443 -mpower  -mno-power  -mpower2  -mno-power2 @gol
444 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
445 -maltivec -mno-altivec @gol
446 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
447 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
448 -mnew-mnemonics  -mold-mnemonics @gol
449 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
450 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
451 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
452 -mstring  -mno-string  -mupdate  -mno-update @gol
453 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
454 -mstrict-align  -mno-strict-align  -mrelocatable @gol
455 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
456 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
457 -mcall-aix -mcall-sysv -mcall-netbsd @gol
458 -maix-struct-return -msvr4-struct-return @gol
459 -mabi=altivec -mabi=no-altivec @gol
460 -mabi=spe -mabi=no-spe @gol
461 -misel=yes -misel=no @gol
462 -mprototype  -mno-prototype @gol
463 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
464 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
465
466 @emph{Darwin Options}
467 @gccoptlist{
468 -all_load -allowable_client -arch -arch_errors_fatal @gol
469 -arch_only -bind_at_load -bundle -bundle_loader @gol
470 -client_name -compatibility_version -current_version @gol
471 -dependency-file -dylib_file -dylinker_install_name @gol
472 -dynamic -dynamiclib -exported_symbols_list @gol
473 -filelist -flat_namespace -force_cpusubtype_ALL @gol
474 -force_flat_namespace -headerpad_max_install_names @gol
475 -image_base -init -install_name -keep_private_externs @gol
476 -multi_module -multiply_defined -multiply_defined_unused @gol
477 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
478 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
479 -private_bundle -read_only_relocs -sectalign @gol
480 -sectobjectsymbols -whyload -seg1addr @gol
481 -sectcreate -sectobjectsymbols -sectorder @gol
482 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
483 -segprot -segs_read_only_addr -segs_read_write_addr @gol
484 -single_module -static -sub_library -sub_umbrella @gol
485 -twolevel_namespace -umbrella -undefined @gol
486 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
487
488 @emph{RT Options}
489 @gccoptlist{
490 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
491 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
492 -mminimum-fp-blocks  -mnohc-struct-return}
493
494 @emph{MIPS Options}
495 @gccoptlist{
496 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
497 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
498 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
499 -mgas  -mgp32  -mgp64 @gol
500 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
501 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
502 -mmips-as  -mmips-tfile  -mno-abicalls @gol
503 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
504 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
505 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
506 -mrnames  -msoft-float @gol
507 -m4650  -msingle-float  -mmad @gol
508 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
509 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
510 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
511 -mbranch-likely -mno-branch-likely}
512
513 @emph{i386 and x86-64 Options}
514 @gccoptlist{
515 -mcpu=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
516 -masm=@var{dialect}  -mno-fancy-math-387 @gol
517 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
518 -mno-wide-multiply  -mrtd  -malign-double @gol
519 -mpreferred-stack-boundary=@var{num} @gol
520 -mmmx  -msse -msse2 -m3dnow @gol
521 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
522 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
523 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
524 -mno-red-zone@gol
525 -mcmodel=@var{code-model} @gol
526 -m32 -m64}
527
528 @emph{HPPA Options}
529 @gccoptlist{
530 -march=@var{architecture-type} @gol
531 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
532 -mfast-indirect-calls  -mgas  -mgnu-ld -mhp-ld @gol
533 -mjump-in-delay -mlinker-opt -mlong-calls @gol
534 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
535 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
536 -mno-jump-in-delay  -mno-long-load-store @gol
537 -mno-portable-runtime  -mno-soft-float @gol
538 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
539 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
540 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
541
542 @emph{Intel 960 Options}
543 @gccoptlist{
544 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
545 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
546 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
547 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
548 -mno-complex-addr  -mno-leaf-procedures @gol
549 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
550 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
551 -mtail-call}
552
553 @emph{DEC Alpha Options}
554 @gccoptlist{
555 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
556 -mieee  -mieee-with-inexact  -mieee-conformant @gol
557 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
558 -mtrap-precision=@var{mode}  -mbuild-constants @gol
559 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
560 -mbwx  -mmax  -mfix  -mcix @gol
561 -mfloat-vax  -mfloat-ieee @gol
562 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
563 -mmemory-latency=@var{time}}
564
565 @emph{DEC Alpha/VMS Options}
566 @gccoptlist{
567 -mvms-return-codes}
568
569 @emph{Clipper Options}
570 @gccoptlist{
571 -mc300  -mc400}
572
573 @emph{H8/300 Options}
574 @gccoptlist{
575 -mrelax  -mh  -ms  -mn  -mint32  -malign-300}
576
577 @emph{SH Options}
578 @gccoptlist{
579 -m1  -m2  -m3  -m3e @gol
580 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
581 -m5-64media -m5-64media-nofpu @gol
582 -m5-32media -m5-32media-nofpu @gol
583 -m5-compact -m5-compact-nofpu @gol
584 -mb  -ml  -mdalign  -mrelax @gol
585 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
586 -mieee  -misize  -mpadstruct  -mspace @gol
587 -mprefergot  -musermode}
588
589 @emph{System V Options}
590 @gccoptlist{
591 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
592
593 @emph{ARC Options}
594 @gccoptlist{
595 -EB  -EL @gol
596 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
597 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
598
599 @emph{TMS320C3x/C4x Options}
600 @gccoptlist{
601 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
602 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
603 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
604 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
605
606 @emph{V850 Options}
607 @gccoptlist{
608 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
609 -mprolog-function  -mno-prolog-function  -mspace @gol
610 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
611 -mapp-regs -mno-app-regs @gol
612 -mdisable-callt -mno-disable-callt @gol
613 -mv850e @gol
614 -mv850  -mbig-switch}
615
616 @emph{NS32K Options}
617 @gccoptlist{
618 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
619 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
620 -mregparam  -mnoregparam  -msb  -mnosb @gol
621 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
622
623 @emph{AVR Options}
624 @gccoptlist{
625 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
626 -mcall-prologues  -mno-tablejump  -mtiny-stack}
627
628 @emph{MCore Options}
629 @gccoptlist{
630 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
631 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
632 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
633 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
634 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
635
636 @emph{MMIX Options}
637 @gccoptlist{
638 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
639 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
640 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
641 -mno-base-addresses -msingle-exit -mno-single-exit}
642
643 @emph{IA-64 Options}
644 @gccoptlist{
645 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
646 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
647 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
648 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
649 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
650 -mfixed-range=@var{register-range}}
651
652 @emph{D30V Options}
653 @gccoptlist{
654 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
655 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
656
657 @emph{S/390 and zSeries Options}
658 @gccoptlist{
659 -mcpu=@var{cpu-type} -march=@var{cpu-type} @gol
660 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
661 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
662 -m64 -m31 -mdebug -mno-debug -mesa -mzarch}
663
664 @emph{CRIS Options}
665 @gccoptlist{
666 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
667 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
668 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
669 -mstack-align -mdata-align -mconst-align @gol
670 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
671 -melf -maout -melinux -mlinux -sim -sim2}
672
673 @emph{PDP-11 Options}
674 @gccoptlist{
675 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
676 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
677 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
678 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
679 -mbranch-expensive  -mbranch-cheap @gol
680 -msplit  -mno-split  -munix-asm  -mdec-asm}
681
682 @emph{Xstormy16 Options}
683 @gccoptlist{
684 -msim}
685
686 @emph{Xtensa Options}
687 @gccoptlist{
688 -mbig-endian -mlittle-endian @gol
689 -mdensity -mno-density @gol
690 -mmac16 -mno-mac16 @gol
691 -mmul16 -mno-mul16 @gol
692 -mmul32 -mno-mul32 @gol
693 -mnsa -mno-nsa @gol
694 -mminmax -mno-minmax @gol
695 -msext -mno-sext @gol
696 -mbooleans -mno-booleans @gol
697 -mhard-float -msoft-float @gol
698 -mfused-madd -mno-fused-madd @gol
699 -mserialize-volatile -mno-serialize-volatile @gol
700 -mtext-section-literals -mno-text-section-literals @gol
701 -mtarget-align -mno-target-align @gol
702 -mlongcalls -mno-longcalls}
703
704 @emph{FRV Options}
705 @gccoptlist{
706 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
707 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
708 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
709 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
710 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
711 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
712 -mno-nested-cond-exec -mtomcat-stats @gol
713 -mcpu=@var{cpu}}
714
715
716
717 @item Code Generation Options
718 @xref{Code Gen Options,,Options for Code Generation Conventions}.
719 @gccoptlist{
720 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
721 -ffixed-@var{reg} -fexceptions @gol
722 -fnon-call-exceptions  -funwind-tables @gol
723 -fasynchronous-unwind-tables @gol
724 -finhibit-size-directive  -finstrument-functions @gol
725 -fno-common  -fno-ident  -fno-gnu-linker @gol
726 -fpcc-struct-return  -fpic  -fPIC @gol
727 -freg-struct-return  -fshared-data  -fshort-enums @gol
728 -fshort-double  -fshort-wchar -fvolatile @gol
729 -fvolatile-global  -fvolatile-static @gol
730 -fverbose-asm  -fpack-struct  -fstack-check @gol
731 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
732 -fargument-alias  -fargument-noalias @gol
733 -fargument-noalias-global  -fleading-underscore @gol
734 -ftls-model=@var{model}}
735 @end table
736
737 @menu
738 * Overall Options::     Controlling the kind of output:
739                         an executable, object files, assembler files,
740                         or preprocessed source.
741 * C Dialect Options::   Controlling the variant of C language compiled.
742 * C++ Dialect Options:: Variations on C++.
743 * Objective-C Dialect Options:: Variations on Objective-C.
744 * Language Independent Options:: Controlling how diagnostics should be
745                         formatted.
746 * Warning Options::     How picky should the compiler be?
747 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
748 * Optimize Options::    How much optimization?
749 * Preprocessor Options:: Controlling header files and macro definitions.
750                          Also, getting dependency information for Make.
751 * Assembler Options::   Passing options to the assembler.
752 * Link Options::        Specifying libraries and so on.
753 * Directory Options::   Where to find header files and libraries.
754                         Where to find the compiler executable files.
755 * Spec Files::          How to pass switches to sub-processes.
756 * Target Options::      Running a cross-compiler, or an old version of GCC.
757 @end menu
758
759 @node Overall Options
760 @section Options Controlling the Kind of Output
761
762 Compilation can involve up to four stages: preprocessing, compilation
763 proper, assembly and linking, always in that order.  The first three
764 stages apply to an individual source file, and end by producing an
765 object file; linking combines all the object files (those newly
766 compiled, and those specified as input) into an executable file.
767
768 @cindex file name suffix
769 For any given input file, the file name suffix determines what kind of
770 compilation is done:
771
772 @table @gcctabopt
773 @item @var{file}.c
774 C source code which must be preprocessed.
775
776 @item @var{file}.i
777 C source code which should not be preprocessed.
778
779 @item @var{file}.ii
780 C++ source code which should not be preprocessed.
781
782 @item @var{file}.m
783 Objective-C source code.  Note that you must link with the library
784 @file{libobjc.a} to make an Objective-C program work.
785
786 @item @var{file}.mi
787 Objective-C source code which should not be preprocessed.
788
789 @item @var{file}.h
790 C header file (not to be compiled or linked).
791
792 @item @var{file}.cc
793 @itemx @var{file}.cp
794 @itemx @var{file}.cxx
795 @itemx @var{file}.cpp
796 @itemx @var{file}.CPP
797 @itemx @var{file}.c++
798 @itemx @var{file}.C
799 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
800 the last two letters must both be literally @samp{x}.  Likewise,
801 @samp{.C} refers to a literal capital C@.
802
803 @item @var{file}.f
804 @itemx @var{file}.for
805 @itemx @var{file}.FOR
806 Fortran source code which should not be preprocessed.
807
808 @item @var{file}.F
809 @itemx @var{file}.fpp
810 @itemx @var{file}.FPP
811 Fortran source code which must be preprocessed (with the traditional
812 preprocessor).
813
814 @item @var{file}.r
815 Fortran source code which must be preprocessed with a RATFOR
816 preprocessor (not included with GCC)@.
817
818 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
819 Using and Porting GNU Fortran}, for more details of the handling of
820 Fortran input files.
821
822 @c FIXME: Descriptions of Java file types.
823 @c @var{file}.java
824 @c @var{file}.class
825 @c @var{file}.zip
826 @c @var{file}.jar
827
828 @item @var{file}.ads
829 Ada source code file which contains a library unit declaration (a
830 declaration of a package, subprogram, or generic, or a generic
831 instantiation), or a library unit renaming declaration (a package,
832 generic, or subprogram renaming declaration).  Such files are also
833 called @dfn{specs}.
834
835 @itemx @var{file}.adb
836 Ada source code file containing a library unit body (a subprogram or
837 package body).  Such files are also called @dfn{bodies}.
838
839 @c GCC also knows about some suffixes for languages not yet included:
840 @c Pascal:
841 @c @var{file}.p
842 @c @var{file}.pas
843
844 @item @var{file}.s
845 Assembler code.
846
847 @item @var{file}.S
848 Assembler code which must be preprocessed.
849
850 @item @var{other}
851 An object file to be fed straight into linking.
852 Any file name with no recognized suffix is treated this way.
853 @end table
854
855 @opindex x
856 You can specify the input language explicitly with the @option{-x} option:
857
858 @table @gcctabopt
859 @item -x @var{language}
860 Specify explicitly the @var{language} for the following input files
861 (rather than letting the compiler choose a default based on the file
862 name suffix).  This option applies to all following input files until
863 the next @option{-x} option.  Possible values for @var{language} are:
864 @example
865 c  c-header  cpp-output
866 c++  c++-cpp-output
867 objective-c  objc-cpp-output
868 assembler  assembler-with-cpp
869 ada
870 f77  f77-cpp-input  ratfor
871 java
872 treelang
873 @end example
874
875 @item -x none
876 Turn off any specification of a language, so that subsequent files are
877 handled according to their file name suffixes (as they are if @option{-x}
878 has not been used at all).
879
880 @item -pass-exit-codes
881 @opindex pass-exit-codes
882 Normally the @command{gcc} program will exit with the code of 1 if any
883 phase of the compiler returns a non-success return code.  If you specify
884 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
885 numerically highest error produced by any phase that returned an error
886 indication.
887 @end table
888
889 If you only want some of the stages of compilation, you can use
890 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
891 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
892 @command{gcc} is to stop.  Note that some combinations (for example,
893 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
894
895 @table @gcctabopt
896 @item -c
897 @opindex c
898 Compile or assemble the source files, but do not link.  The linking
899 stage simply is not done.  The ultimate output is in the form of an
900 object file for each source file.
901
902 By default, the object file name for a source file is made by replacing
903 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
904
905 Unrecognized input files, not requiring compilation or assembly, are
906 ignored.
907
908 @item -S
909 @opindex S
910 Stop after the stage of compilation proper; do not assemble.  The output
911 is in the form of an assembler code file for each non-assembler input
912 file specified.
913
914 By default, the assembler file name for a source file is made by
915 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
916
917 Input files that don't require compilation are ignored.
918
919 @item -E
920 @opindex E
921 Stop after the preprocessing stage; do not run the compiler proper.  The
922 output is in the form of preprocessed source code, which is sent to the
923 standard output.
924
925 Input files which don't require preprocessing are ignored.
926
927 @cindex output file option
928 @item -o @var{file}
929 @opindex o
930 Place output in file @var{file}.  This applies regardless to whatever
931 sort of output is being produced, whether it be an executable file,
932 an object file, an assembler file or preprocessed C code.
933
934 Since only one output file can be specified, it does not make sense to
935 use @option{-o} when compiling more than one input file, unless you are
936 producing an executable file as output.
937
938 If @option{-o} is not specified, the default is to put an executable file
939 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
940 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
941 all preprocessed C source on standard output.
942
943 @item -v
944 @opindex v
945 Print (on standard error output) the commands executed to run the stages
946 of compilation.  Also print the version number of the compiler driver
947 program and of the preprocessor and the compiler proper.
948
949 @item -###
950 @opindex ###
951 Like @option{-v} except the commands are not executed and all command
952 arguments are quoted.  This is useful for shell scripts to capture the
953 driver-generated command lines.
954
955 @item -pipe
956 @opindex pipe
957 Use pipes rather than temporary files for communication between the
958 various stages of compilation.  This fails to work on some systems where
959 the assembler is unable to read from a pipe; but the GNU assembler has
960 no trouble.
961
962 @item --help
963 @opindex help
964 Print (on the standard output) a description of the command line options
965 understood by @command{gcc}.  If the @option{-v} option is also specified
966 then @option{--help} will also be passed on to the various processes
967 invoked by @command{gcc}, so that they can display the command line options
968 they accept.  If the @option{-W} option is also specified then command
969 line options which have no documentation associated with them will also
970 be displayed.
971
972 @item --target-help
973 @opindex target-help
974 Print (on the standard output) a description of target specific command
975 line options for each tool.
976
977 @item --version
978 @opindex version
979 Display the version number and copyrights of the invoked GCC.
980 @end table
981
982 @node Invoking G++
983 @section Compiling C++ Programs
984
985 @cindex suffixes for C++ source
986 @cindex C++ source file suffixes
987 C++ source files conventionally use one of the suffixes @samp{.C},
988 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
989 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
990 files with these names and compiles them as C++ programs even if you
991 call the compiler the same way as for compiling C programs (usually with
992 the name @command{gcc}).
993
994 @findex g++
995 @findex c++
996 However, C++ programs often require class libraries as well as a
997 compiler that understands the C++ language---and under some
998 circumstances, you might want to compile programs from standard input,
999 or otherwise without a suffix that flags them as C++ programs.
1000 @command{g++} is a program that calls GCC with the default language
1001 set to C++, and automatically specifies linking against the C++
1002 library.  On many systems, @command{g++} is also
1003 installed with the name @command{c++}.
1004
1005 @cindex invoking @command{g++}
1006 When you compile C++ programs, you may specify many of the same
1007 command-line options that you use for compiling programs in any
1008 language; or command-line options meaningful for C and related
1009 languages; or options that are meaningful only for C++ programs.
1010 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1011 explanations of options for languages related to C@.
1012 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1013 explanations of options that are meaningful only for C++ programs.
1014
1015 @node C Dialect Options
1016 @section Options Controlling C Dialect
1017 @cindex dialect options
1018 @cindex language dialect options
1019 @cindex options, dialect
1020
1021 The following options control the dialect of C (or languages derived
1022 from C, such as C++ and Objective-C) that the compiler accepts:
1023
1024 @table @gcctabopt
1025 @cindex ANSI support
1026 @cindex ISO support
1027 @item -ansi
1028 @opindex ansi
1029 In C mode, support all ISO C90 programs.  In C++ mode,
1030 remove GNU extensions that conflict with ISO C++.
1031
1032 This turns off certain features of GCC that are incompatible with ISO
1033 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1034 such as the @code{asm} and @code{typeof} keywords, and
1035 predefined macros such as @code{unix} and @code{vax} that identify the
1036 type of system you are using.  It also enables the undesirable and
1037 rarely used ISO trigraph feature.  For the C compiler,
1038 it disables recognition of C++ style @samp{//} comments as well as
1039 the @code{inline} keyword.
1040
1041 The alternate keywords @code{__asm__}, @code{__extension__},
1042 @code{__inline__} and @code{__typeof__} continue to work despite
1043 @option{-ansi}.  You would not want to use them in an ISO C program, of
1044 course, but it is useful to put them in header files that might be included
1045 in compilations done with @option{-ansi}.  Alternate predefined macros
1046 such as @code{__unix__} and @code{__vax__} are also available, with or
1047 without @option{-ansi}.
1048
1049 The @option{-ansi} option does not cause non-ISO programs to be
1050 rejected gratuitously.  For that, @option{-pedantic} is required in
1051 addition to @option{-ansi}.  @xref{Warning Options}.
1052
1053 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1054 option is used.  Some header files may notice this macro and refrain
1055 from declaring certain functions or defining certain macros that the
1056 ISO standard doesn't call for; this is to avoid interfering with any
1057 programs that might use these names for other things.
1058
1059 Functions which would normally be built in but do not have semantics
1060 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1061 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1062 built-in functions provided by GCC}, for details of the functions
1063 affected.
1064
1065 @item -std=
1066 @opindex std
1067 Determine the language standard.  This option is currently only
1068 supported when compiling C or C++.  A value for this option must be
1069 provided; possible values are
1070
1071 @table @samp
1072 @item c89
1073 @itemx iso9899:1990
1074 ISO C90 (same as @option{-ansi}).
1075
1076 @item iso9899:199409
1077 ISO C90 as modified in amendment 1.
1078
1079 @item c99
1080 @itemx c9x
1081 @itemx iso9899:1999
1082 @itemx iso9899:199x
1083 ISO C99.  Note that this standard is not yet fully supported; see
1084 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1085 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1086
1087 @item gnu89
1088 Default, ISO C90 plus GNU extensions (including some C99 features).
1089
1090 @item gnu99
1091 @item gnu9x
1092 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1093 this will become the default.  The name @samp{gnu9x} is deprecated.
1094
1095 @item c++98
1096 The 1998 ISO C++ standard plus amendments.
1097
1098 @item gnu++98
1099 The same as @option{-std=c++98} plus GNU extensions.  This is the
1100 default for C++ code.
1101 @end table
1102
1103 Even when this option is not specified, you can still use some of the
1104 features of newer standards in so far as they do not conflict with
1105 previous C standards.  For example, you may use @code{__restrict__} even
1106 when @option{-std=c99} is not specified.
1107
1108 The @option{-std} options specifying some version of ISO C have the same
1109 effects as @option{-ansi}, except that features that were not in ISO C90
1110 but are in the specified version (for example, @samp{//} comments and
1111 the @code{inline} keyword in ISO C99) are not disabled.
1112
1113 @xref{Standards,,Language Standards Supported by GCC}, for details of
1114 these standard versions.
1115
1116 @item -aux-info @var{filename}
1117 @opindex aux-info
1118 Output to the given filename prototyped declarations for all functions
1119 declared and/or defined in a translation unit, including those in header
1120 files.  This option is silently ignored in any language other than C@.
1121
1122 Besides declarations, the file indicates, in comments, the origin of
1123 each declaration (source file and line), whether the declaration was
1124 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1125 @samp{O} for old, respectively, in the first character after the line
1126 number and the colon), and whether it came from a declaration or a
1127 definition (@samp{C} or @samp{F}, respectively, in the following
1128 character).  In the case of function definitions, a K&R-style list of
1129 arguments followed by their declarations is also provided, inside
1130 comments, after the declaration.
1131
1132 @item -fno-asm
1133 @opindex fno-asm
1134 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1135 keyword, so that code can use these words as identifiers.  You can use
1136 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1137 instead.  @option{-ansi} implies @option{-fno-asm}.
1138
1139 In C++, this switch only affects the @code{typeof} keyword, since
1140 @code{asm} and @code{inline} are standard keywords.  You may want to
1141 use the @option{-fno-gnu-keywords} flag instead, which has the same
1142 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1143 switch only affects the @code{asm} and @code{typeof} keywords, since
1144 @code{inline} is a standard keyword in ISO C99.
1145
1146 @item -fno-builtin
1147 @itemx -fno-builtin-@var{function}
1148 @opindex fno-builtin
1149 @cindex built-in functions
1150 Don't recognize built-in functions that do not begin with
1151 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1152 functions provided by GCC}, for details of the functions affected,
1153 including those which are not built-in functions when @option{-ansi} or
1154 @option{-std} options for strict ISO C conformance are used because they
1155 do not have an ISO standard meaning.
1156
1157 GCC normally generates special code to handle certain built-in functions
1158 more efficiently; for instance, calls to @code{alloca} may become single
1159 instructions that adjust the stack directly, and calls to @code{memcpy}
1160 may become inline copy loops.  The resulting code is often both smaller
1161 and faster, but since the function calls no longer appear as such, you
1162 cannot set a breakpoint on those calls, nor can you change the behavior
1163 of the functions by linking with a different library.
1164
1165 With the @option{-fno-builtin-@var{function}} option
1166 only the built-in function @var{function} is
1167 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1168 function is named this is not built-in in this version of GCC, this
1169 option is ignored.  There is no corresponding
1170 @option{-fbuiltin-@var{function}} option; if you wish to enable
1171 built-in functions selectively when using @option{-fno-builtin} or
1172 @option{-ffreestanding}, you may define macros such as:
1173
1174 @smallexample
1175 #define abs(n)          __builtin_abs ((n))
1176 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1177 @end smallexample
1178
1179 @item -fhosted
1180 @opindex fhosted
1181 @cindex hosted environment
1182
1183 Assert that compilation takes place in a hosted environment.  This implies
1184 @option{-fbuiltin}.  A hosted environment is one in which the
1185 entire standard library is available, and in which @code{main} has a return
1186 type of @code{int}.  Examples are nearly everything except a kernel.
1187 This is equivalent to @option{-fno-freestanding}.
1188
1189 @item -ffreestanding
1190 @opindex ffreestanding
1191 @cindex hosted environment
1192
1193 Assert that compilation takes place in a freestanding environment.  This
1194 implies @option{-fno-builtin}.  A freestanding environment
1195 is one in which the standard library may not exist, and program startup may
1196 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1197 This is equivalent to @option{-fno-hosted}.
1198
1199 @xref{Standards,,Language Standards Supported by GCC}, for details of
1200 freestanding and hosted environments.
1201
1202 @item -fms-extensions
1203 @opindex fms-extensions
1204 Accept some non-standard constructs used in Microsoft header files.
1205
1206 @item -trigraphs
1207 @opindex trigraphs
1208 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1209 options for strict ISO C conformance) implies @option{-trigraphs}.
1210
1211 @cindex traditional C language
1212 @cindex C language, traditional
1213 @item -traditional
1214 @itemx -traditional-cpp
1215 @opindex traditional-cpp
1216 @opindex traditional
1217 Formerly, these options caused GCC to attempt to emulate a pre-standard
1218 C compiler.  They are now only supported with the @option{-E} switch.
1219 The preprocessor continues to support a pre-standard mode.  See the GNU
1220 CPP manual for details.
1221
1222 @item -fcond-mismatch
1223 @opindex fcond-mismatch
1224 Allow conditional expressions with mismatched types in the second and
1225 third arguments.  The value of such an expression is void.  This option
1226 is not supported for C++.
1227
1228 @item -funsigned-char
1229 @opindex funsigned-char
1230 Let the type @code{char} be unsigned, like @code{unsigned char}.
1231
1232 Each kind of machine has a default for what @code{char} should
1233 be.  It is either like @code{unsigned char} by default or like
1234 @code{signed char} by default.
1235
1236 Ideally, a portable program should always use @code{signed char} or
1237 @code{unsigned char} when it depends on the signedness of an object.
1238 But many programs have been written to use plain @code{char} and
1239 expect it to be signed, or expect it to be unsigned, depending on the
1240 machines they were written for.  This option, and its inverse, let you
1241 make such a program work with the opposite default.
1242
1243 The type @code{char} is always a distinct type from each of
1244 @code{signed char} or @code{unsigned char}, even though its behavior
1245 is always just like one of those two.
1246
1247 @item -fsigned-char
1248 @opindex fsigned-char
1249 Let the type @code{char} be signed, like @code{signed char}.
1250
1251 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1252 the negative form of @option{-funsigned-char}.  Likewise, the option
1253 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1254
1255 @item -fsigned-bitfields
1256 @itemx -funsigned-bitfields
1257 @itemx -fno-signed-bitfields
1258 @itemx -fno-unsigned-bitfields
1259 @opindex fsigned-bitfields
1260 @opindex funsigned-bitfields
1261 @opindex fno-signed-bitfields
1262 @opindex fno-unsigned-bitfields
1263 These options control whether a bit-field is signed or unsigned, when the
1264 declaration does not use either @code{signed} or @code{unsigned}.  By
1265 default, such a bit-field is signed, because this is consistent: the
1266 basic integer types such as @code{int} are signed types.
1267
1268 @item -fwritable-strings
1269 @opindex fwritable-strings
1270 Store string constants in the writable data segment and don't uniquize
1271 them.  This is for compatibility with old programs which assume they can
1272 write into string constants.
1273
1274 Writing into string constants is a very bad idea; ``constants'' should
1275 be constant.
1276 @end table
1277
1278 @node C++ Dialect Options
1279 @section Options Controlling C++ Dialect
1280
1281 @cindex compiler options, C++
1282 @cindex C++ options, command line
1283 @cindex options, C++
1284 This section describes the command-line options that are only meaningful
1285 for C++ programs; but you can also use most of the GNU compiler options
1286 regardless of what language your program is in.  For example, you
1287 might compile a file @code{firstClass.C} like this:
1288
1289 @example
1290 g++ -g -frepo -O -c firstClass.C
1291 @end example
1292
1293 @noindent
1294 In this example, only @option{-frepo} is an option meant
1295 only for C++ programs; you can use the other options with any
1296 language supported by GCC@.
1297
1298 Here is a list of options that are @emph{only} for compiling C++ programs:
1299
1300 @table @gcctabopt
1301
1302 @item -fabi-version=@var{n}
1303 @opindex fabi-version
1304 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1305 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1306 version that conforms most closely to the C++ ABI specification.
1307 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1308 fixed.
1309
1310 The default is version 1.
1311
1312 @item -fno-access-control
1313 @opindex fno-access-control
1314 Turn off all access checking.  This switch is mainly useful for working
1315 around bugs in the access control code.
1316
1317 @item -fcheck-new
1318 @opindex fcheck-new
1319 Check that the pointer returned by @code{operator new} is non-null
1320 before attempting to modify the storage allocated.  The current Working
1321 Paper requires that @code{operator new} never return a null pointer, so
1322 this check is normally unnecessary.
1323
1324 An alternative to using this option is to specify that your
1325 @code{operator new} does not throw any exceptions; if you declare it
1326 @samp{throw()}, G++ will check the return value.  See also @samp{new
1327 (nothrow)}.
1328
1329 @item -fconserve-space
1330 @opindex fconserve-space
1331 Put uninitialized or runtime-initialized global variables into the
1332 common segment, as C does.  This saves space in the executable at the
1333 cost of not diagnosing duplicate definitions.  If you compile with this
1334 flag and your program mysteriously crashes after @code{main()} has
1335 completed, you may have an object that is being destroyed twice because
1336 two definitions were merged.
1337
1338 This option is no longer useful on most targets, now that support has
1339 been added for putting variables into BSS without making them common.
1340
1341 @item -fno-const-strings
1342 @opindex fno-const-strings
1343 Give string constants type @code{char *} instead of type @code{const
1344 char *}.  By default, G++ uses type @code{const char *} as required by
1345 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1346 actually modify the value of a string constant, unless you also use
1347 @option{-fwritable-strings}.
1348
1349 This option might be removed in a future release of G++.  For maximum
1350 portability, you should structure your code so that it works with
1351 string constants that have type @code{const char *}.
1352
1353 @item -fdollars-in-identifiers
1354 @opindex fdollars-in-identifiers
1355 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1356 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1357 @samp{$} by default on most target systems, but there are a few exceptions.)
1358 Traditional C allowed the character @samp{$} to form part of
1359 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1360
1361 @item -fno-elide-constructors
1362 @opindex fno-elide-constructors
1363 The C++ standard allows an implementation to omit creating a temporary
1364 which is only used to initialize another object of the same type.
1365 Specifying this option disables that optimization, and forces G++ to
1366 call the copy constructor in all cases.
1367
1368 @item -fno-enforce-eh-specs
1369 @opindex fno-enforce-eh-specs
1370 Don't check for violation of exception specifications at runtime.  This
1371 option violates the C++ standard, but may be useful for reducing code
1372 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1373 will still optimize based on the exception specifications.
1374
1375 @item -fexternal-templates
1376 @opindex fexternal-templates
1377
1378 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1379 template instantiation; template instances are emitted or not according
1380 to the location of the template definition.  @xref{Template
1381 Instantiation}, for more information.
1382
1383 This option is deprecated.
1384
1385 @item -falt-external-templates
1386 @opindex falt-external-templates
1387 Similar to @option{-fexternal-templates}, but template instances are
1388 emitted or not according to the place where they are first instantiated.
1389 @xref{Template Instantiation}, for more information.
1390
1391 This option is deprecated.
1392
1393 @item -ffor-scope
1394 @itemx -fno-for-scope
1395 @opindex ffor-scope
1396 @opindex fno-for-scope
1397 If @option{-ffor-scope} is specified, the scope of variables declared in
1398 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1399 as specified by the C++ standard.
1400 If @option{-fno-for-scope} is specified, the scope of variables declared in
1401 a @i{for-init-statement} extends to the end of the enclosing scope,
1402 as was the case in old versions of G++, and other (traditional)
1403 implementations of C++.
1404
1405 The default if neither flag is given to follow the standard,
1406 but to allow and give a warning for old-style code that would
1407 otherwise be invalid, or have different behavior.
1408
1409 @item -fno-gnu-keywords
1410 @opindex fno-gnu-keywords
1411 Do not recognize @code{typeof} as a keyword, so that code can use this
1412 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1413 @option{-ansi} implies @option{-fno-gnu-keywords}.
1414
1415 @item -fno-implicit-templates
1416 @opindex fno-implicit-templates
1417 Never emit code for non-inline templates which are instantiated
1418 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1419 @xref{Template Instantiation}, for more information.
1420
1421 @item -fno-implicit-inline-templates
1422 @opindex fno-implicit-inline-templates
1423 Don't emit code for implicit instantiations of inline templates, either.
1424 The default is to handle inlines differently so that compiles with and
1425 without optimization will need the same set of explicit instantiations.
1426
1427 @item -fno-implement-inlines
1428 @opindex fno-implement-inlines
1429 To save space, do not emit out-of-line copies of inline functions
1430 controlled by @samp{#pragma implementation}.  This will cause linker
1431 errors if these functions are not inlined everywhere they are called.
1432
1433 @item -fms-extensions
1434 @opindex fms-extensions
1435 Disable pedantic warnings about constructs used in MFC, such as implicit
1436 int and getting a pointer to member function via non-standard syntax.
1437
1438 @item -fno-nonansi-builtins
1439 @opindex fno-nonansi-builtins
1440 Disable built-in declarations of functions that are not mandated by
1441 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1442 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1443
1444 @item -fno-operator-names
1445 @opindex fno-operator-names
1446 Do not treat the operator name keywords @code{and}, @code{bitand},
1447 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1448 synonyms as keywords.
1449
1450 @item -fno-optional-diags
1451 @opindex fno-optional-diags
1452 Disable diagnostics that the standard says a compiler does not need to
1453 issue.  Currently, the only such diagnostic issued by G++ is the one for
1454 a name having multiple meanings within a class.
1455
1456 @item -fpermissive
1457 @opindex fpermissive
1458 Downgrade messages about nonconformant code from errors to warnings.  By
1459 default, G++ effectively sets @option{-pedantic-errors} without
1460 @option{-pedantic}; this option reverses that.  This behavior and this
1461 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1462
1463 @item -frepo
1464 @opindex frepo
1465 Enable automatic template instantiation at link time.  This option also
1466 implies @option{-fno-implicit-templates}.  @xref{Template
1467 Instantiation}, for more information.
1468
1469 @item -fno-rtti
1470 @opindex fno-rtti
1471 Disable generation of information about every class with virtual
1472 functions for use by the C++ runtime type identification features
1473 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1474 of the language, you can save some space by using this flag.  Note that
1475 exception handling uses the same information, but it will generate it as
1476 needed.
1477
1478 @item -fstats
1479 @opindex fstats
1480 Emit statistics about front-end processing at the end of the compilation.
1481 This information is generally only useful to the G++ development team.
1482
1483 @item -ftemplate-depth-@var{n}
1484 @opindex ftemplate-depth
1485 Set the maximum instantiation depth for template classes to @var{n}.
1486 A limit on the template instantiation depth is needed to detect
1487 endless recursions during template class instantiation.  ANSI/ISO C++
1488 conforming programs must not rely on a maximum depth greater than 17.
1489
1490 @item -fuse-cxa-atexit
1491 @opindex fuse-cxa-atexit
1492 Register destructors for objects with static storage duration with the
1493 @code{__cxa_atexit} function rather than the @code{atexit} function.
1494 This option is required for fully standards-compliant handling of static
1495 destructors, but will only work if your C library supports
1496 @code{__cxa_atexit}.
1497
1498 @item -fvtable-gc
1499 @opindex fvtable-gc
1500 Emit special relocations for vtables and virtual function references
1501 so that the linker can identify unused virtual functions and zero out
1502 vtable slots that refer to them.  This is most useful with
1503 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1504 also discard the functions themselves.
1505
1506 This optimization requires GNU as and GNU ld.  Not all systems support
1507 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1508
1509 @item -fno-weak
1510 @opindex fno-weak
1511 Do not use weak symbol support, even if it is provided by the linker.
1512 By default, G++ will use weak symbols if they are available.  This
1513 option exists only for testing, and should not be used by end-users;
1514 it will result in inferior code and has no benefits.  This option may
1515 be removed in a future release of G++.
1516
1517 @item -nostdinc++
1518 @opindex nostdinc++
1519 Do not search for header files in the standard directories specific to
1520 C++, but do still search the other standard directories.  (This option
1521 is used when building the C++ library.)
1522 @end table
1523
1524 In addition, these optimization, warning, and code generation options
1525 have meanings only for C++ programs:
1526
1527 @table @gcctabopt
1528 @item -fno-default-inline
1529 @opindex fno-default-inline
1530 Do not assume @samp{inline} for functions defined inside a class scope.
1531 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1532 functions will have linkage like inline functions; they just won't be
1533 inlined by default.
1534
1535 @item -Wabi @r{(C++ only)}
1536 @opindex Wabi
1537 Warn when G++ generates code that is probably not compatible with the
1538 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1539 all such cases, there are probably some cases that are not warned about, 
1540 even though G++ is generating incompatible code.  There may also be
1541 cases where warnings are emitted even though the code that is generated
1542 will be compatible.
1543
1544 You should rewrite your code to avoid these warnings if you are
1545 concerned about the fact that code generated by G++ may not be binary
1546 compatible with code generated by other compilers.
1547
1548 The known incompatibilities at this point include:
1549
1550 @itemize @bullet
1551
1552 @item
1553 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1554 pack data into the same byte as a base class.  For example:
1555
1556 @smallexample
1557 struct A @{ virtual void f(); int f1 : 1; @};
1558 struct B : public A @{ int f2 : 1; @};
1559 @end smallexample
1560
1561 @noindent
1562 In this case, G++ will place @code{B::f2} into the same byte
1563 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1564 by explicitly padding @code{A} so that its size is a multiple of the
1565 byte size on your platform; that will cause G++ and other compilers to
1566 layout @code{B} identically.
1567
1568 @item
1569 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1570 tail padding when laying out virtual bases.  For example:
1571
1572 @smallexample
1573 struct A @{ virtual void f(); char c1; @};
1574 struct B @{ B(); char c2; @};
1575 struct C : public A, public virtual B @{@};
1576 @end smallexample
1577
1578 @noindent
1579 In this case, G++ will not place @code{B} into the tail-padding for
1580 @code{A}; other compilers will.  You can avoid this problem by
1581 explicitly padding @code{A} so that its size is a multiple of its
1582 alignment (ignoring virtual base classes); that will cause G++ and other
1583 compilers to layout @code{C} identically.
1584
1585 @item
1586 Incorrect handling of bit-fields with declared widths greater than that
1587 of their underlying types, when the bit-fields appear in a union.  For
1588 example:
1589
1590 @smallexample
1591 union U @{ int i : 4096; @};
1592 @end smallexample
1593
1594 @noindent
1595 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1596 union too small by the number of bits in an @code{int}.
1597
1598 @item
1599 Empty classes can be placed at incorrect offsets.  For example:
1600  
1601 @smallexample
1602 struct A @{@};
1603
1604 struct B @{
1605   A a;
1606   virtual void f ();
1607 @};
1608
1609 struct C : public B, public A @{@};
1610 @end smallexample
1611
1612 @noindent
1613 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1614 it should be placed at offset zero.  G++ mistakenly believes that the
1615 @code{A} data member of @code{B} is already at offset zero.
1616
1617 @item
1618 Names of template functions whose types involve @code{typename} or
1619 template template parameters can be mangled incorrectly.
1620
1621 @smallexample
1622 template <typename Q>
1623 void f(typename Q::X) @{@}
1624
1625 template <template <typename> class Q>
1626 void f(typename Q<int>::X) @{@}
1627 @end smallexample
1628
1629 @noindent
1630 Instantiations of these templates may be mangled incorrectly.
1631
1632 @end itemize
1633
1634 @item -Wctor-dtor-privacy @r{(C++ only)}
1635 @opindex Wctor-dtor-privacy
1636 Warn when a class seems unusable, because all the constructors or
1637 destructors in a class are private and the class has no friends or
1638 public static member functions.  This warning is enabled by default.
1639
1640 @item -Wnon-virtual-dtor @r{(C++ only)}
1641 @opindex Wnon-virtual-dtor
1642 Warn when a class declares a non-virtual destructor that should probably
1643 be virtual, because it looks like the class will be used polymorphically.
1644 This warning is enabled by @option{-Wall}.
1645
1646 @item -Wreorder @r{(C++ only)}
1647 @opindex Wreorder
1648 @cindex reordering, warning
1649 @cindex warning for reordering of member initializers
1650 Warn when the order of member initializers given in the code does not
1651 match the order in which they must be executed.  For instance:
1652
1653 @smallexample
1654 struct A @{
1655   int i;
1656   int j;
1657   A(): j (0), i (1) @{ @}
1658 @};
1659 @end smallexample
1660
1661 Here the compiler will warn that the member initializers for @samp{i}
1662 and @samp{j} will be rearranged to match the declaration order of the
1663 members.  This warning is enabled by @option{-Wall}.
1664 @end table
1665
1666 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1667
1668 @table @gcctabopt
1669 @item -Weffc++ @r{(C++ only)}
1670 @opindex Weffc++
1671 Warn about violations of the following style guidelines from Scott Meyers'
1672 @cite{Effective C++} book:
1673
1674 @itemize @bullet
1675 @item
1676 Item 11:  Define a copy constructor and an assignment operator for classes
1677 with dynamically allocated memory.
1678
1679 @item
1680 Item 12:  Prefer initialization to assignment in constructors.
1681
1682 @item
1683 Item 14:  Make destructors virtual in base classes.
1684
1685 @item
1686 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1687
1688 @item
1689 Item 23:  Don't try to return a reference when you must return an object.
1690
1691 @end itemize
1692
1693 and about violations of the following style guidelines from Scott Meyers'
1694 @cite{More Effective C++} book:
1695
1696 @itemize @bullet
1697 @item
1698 Item 6:  Distinguish between prefix and postfix forms of increment and
1699 decrement operators.
1700
1701 @item
1702 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1703
1704 @end itemize
1705
1706 If you use this option, you should be aware that the standard library
1707 headers do not obey all of these guidelines; you can use @samp{grep -v}
1708 to filter out those warnings.
1709
1710 @item -Wno-deprecated @r{(C++ only)}
1711 @opindex Wno-deprecated
1712 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1713
1714 @item -Wno-non-template-friend @r{(C++ only)}
1715 @opindex Wno-non-template-friend
1716 Disable warnings when non-templatized friend functions are declared
1717 within a template.  With the advent of explicit template specification
1718 support in G++, if the name of the friend is an unqualified-id (i.e.,
1719 @samp{friend foo(int)}), the C++ language specification demands that the
1720 friend declare or define an ordinary, nontemplate function.  (Section
1721 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1722 could be interpreted as a particular specialization of a templatized
1723 function.  Because this non-conforming behavior is no longer the default
1724 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1725 check existing code for potential trouble spots, and is on by default.
1726 This new compiler behavior can be turned off with
1727 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1728 but disables the helpful warning.
1729
1730 @item -Wold-style-cast @r{(C++ only)}
1731 @opindex Wold-style-cast
1732 Warn if an old-style (C-style) cast to a non-void type is used within
1733 a C++ program.  The new-style casts (@samp{static_cast},
1734 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1735 unintended effects, and much easier to grep for.
1736
1737 @item -Woverloaded-virtual @r{(C++ only)}
1738 @opindex Woverloaded-virtual
1739 @cindex overloaded virtual fn, warning
1740 @cindex warning for overloaded virtual fn
1741 Warn when a function declaration hides virtual functions from a
1742 base class.  For example, in:
1743
1744 @smallexample
1745 struct A @{
1746   virtual void f();
1747 @};
1748
1749 struct B: public A @{
1750   void f(int);
1751 @};
1752 @end smallexample
1753
1754 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1755 like this:
1756
1757 @smallexample
1758 B* b;
1759 b->f();
1760 @end smallexample
1761
1762 will fail to compile.
1763
1764 @item -Wno-pmf-conversions @r{(C++ only)}
1765 @opindex Wno-pmf-conversions
1766 Disable the diagnostic for converting a bound pointer to member function
1767 to a plain pointer.
1768
1769 @item -Wsign-promo @r{(C++ only)}
1770 @opindex Wsign-promo
1771 Warn when overload resolution chooses a promotion from unsigned or
1772 enumeral type to a signed type over a conversion to an unsigned type of
1773 the same size.  Previous versions of G++ would try to preserve
1774 unsignedness, but the standard mandates the current behavior.
1775
1776 @item -Wsynth @r{(C++ only)}
1777 @opindex Wsynth
1778 @cindex warning for synthesized methods
1779 @cindex synthesized methods, warning
1780 Warn when G++'s synthesis behavior does not match that of cfront.  For
1781 instance:
1782
1783 @smallexample
1784 struct A @{
1785   operator int ();
1786   A& operator = (int);
1787 @};
1788
1789 main ()
1790 @{
1791   A a,b;
1792   a = b;
1793 @}
1794 @end smallexample
1795
1796 In this example, G++ will synthesize a default @samp{A& operator =
1797 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1798 @end table
1799
1800 @node Objective-C Dialect Options
1801 @section Options Controlling Objective-C Dialect
1802
1803 @cindex compiler options, Objective-C
1804 @cindex Objective-C options, command line
1805 @cindex options, Objective-C
1806 This section describes the command-line options that are only meaningful
1807 for Objective-C programs; but you can also use most of the GNU compiler
1808 options regardless of what language your program is in.  For example,
1809 you might compile a file @code{some_class.m} like this:
1810
1811 @example
1812 gcc -g -fgnu-runtime -O -c some_class.m
1813 @end example
1814
1815 @noindent
1816 In this example, only @option{-fgnu-runtime} is an option meant only for
1817 Objective-C programs; you can use the other options with any language
1818 supported by GCC@.
1819
1820 Here is a list of options that are @emph{only} for compiling Objective-C
1821 programs:
1822
1823 @table @gcctabopt
1824 @item -fconstant-string-class=@var{class-name}
1825 @opindex fconstant-string-class
1826 Use @var{class-name} as the name of the class to instantiate for each
1827 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1828 class name is @code{NXConstantString}.
1829
1830 @item -fgnu-runtime
1831 @opindex fgnu-runtime
1832 Generate object code compatible with the standard GNU Objective-C
1833 runtime.  This is the default for most types of systems.
1834
1835 @item -fnext-runtime
1836 @opindex fnext-runtime
1837 Generate output compatible with the NeXT runtime.  This is the default
1838 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1839 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1840 used.
1841
1842 @item -gen-decls
1843 @opindex gen-decls
1844 Dump interface declarations for all classes seen in the source file to a
1845 file named @file{@var{sourcename}.decl}.
1846
1847 @item -Wno-protocol
1848 @opindex Wno-protocol
1849 If a class is declared to implement a protocol, a warning is issued for
1850 every method in the protocol that is not implemented by the class.  The
1851 default behavior is to issue a warning for every method not explicitly
1852 implemented in the class, even if a method implementation is inherited
1853 from the superclass.  If you use the @code{-Wno-protocol} option, then
1854 methods inherited from the superclass are considered to be implemented,
1855 and no warning is issued for them.
1856
1857 @item -Wselector
1858 @opindex Wselector
1859 Warn if multiple methods of different types for the same selector are
1860 found during compilation.  The check is performed on the list of methods
1861 in the final stage of compilation.  Additionally, a check is performed
1862 that for each selector appearing in a @code{@@selector(@dots{})}
1863 expression, a corresponding method with that selector has been found
1864 during compilation.  Because these checks scan the method table only at
1865 the end of compilation, these warnings are not produced if the final
1866 stage of compilation is not reached, for example because an error is
1867 found during compilation, or because the @code{-fsyntax-only} option is
1868 being used.
1869
1870 @item -Wundeclared-selector
1871 @opindex Wundeclared-selector
1872 Warn if a @code{@@selector(@dots{})} expression referring to an
1873 undeclared selector is found.  A selector is considered undeclared if no
1874 method with that name has been declared (explicitly, in an
1875 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1876 an @code{@@implementation} section) before the
1877 @code{@@selector(@dots{})} expression.  This option always performs its
1878 checks as soon as a @code{@@selector(@dots{})} expression is found
1879 (while @code{-Wselector} only performs its checks in the final stage of
1880 compilation), and so additionally enforces the coding style convention
1881 that methods and selectors must be declared before being used.
1882
1883 @c not documented because only avail via -Wp
1884 @c @item -print-objc-runtime-info
1885
1886 @end table
1887
1888 @node Language Independent Options
1889 @section Options to Control Diagnostic Messages Formatting
1890 @cindex options to control diagnostics formatting
1891 @cindex diagnostic messages
1892 @cindex message formatting
1893
1894 Traditionally, diagnostic messages have been formatted irrespective of
1895 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1896 below can be used to control the diagnostic messages formatting
1897 algorithm, e.g.@: how many characters per line, how often source location
1898 information should be reported.  Right now, only the C++ front end can
1899 honor these options.  However it is expected, in the near future, that
1900 the remaining front ends would be able to digest them correctly.
1901
1902 @table @gcctabopt
1903 @item -fmessage-length=@var{n}
1904 @opindex fmessage-length
1905 Try to format error messages so that they fit on lines of about @var{n}
1906 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1907 the front ends supported by GCC@.  If @var{n} is zero, then no
1908 line-wrapping will be done; each error message will appear on a single
1909 line.
1910
1911 @opindex fdiagnostics-show-location
1912 @item -fdiagnostics-show-location=once
1913 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1914 reporter to emit @emph{once} source location information; that is, in
1915 case the message is too long to fit on a single physical line and has to
1916 be wrapped, the source location won't be emitted (as prefix) again,
1917 over and over, in subsequent continuation lines.  This is the default
1918 behavior.
1919
1920 @item -fdiagnostics-show-location=every-line
1921 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1922 messages reporter to emit the same source location information (as
1923 prefix) for physical lines that result from the process of breaking
1924 a message which is too long to fit on a single line.
1925
1926 @end table
1927
1928 @node Warning Options
1929 @section Options to Request or Suppress Warnings
1930 @cindex options to control warnings
1931 @cindex warning messages
1932 @cindex messages, warning
1933 @cindex suppressing warnings
1934
1935 Warnings are diagnostic messages that report constructions which
1936 are not inherently erroneous but which are risky or suggest there
1937 may have been an error.
1938
1939 You can request many specific warnings with options beginning @samp{-W},
1940 for example @option{-Wimplicit} to request warnings on implicit
1941 declarations.  Each of these specific warning options also has a
1942 negative form beginning @samp{-Wno-} to turn off warnings;
1943 for example, @option{-Wno-implicit}.  This manual lists only one of the
1944 two forms, whichever is not the default.
1945
1946 The following options control the amount and kinds of warnings produced
1947 by GCC; for further, language-specific options also refer to
1948 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1949
1950 @table @gcctabopt
1951 @cindex syntax checking
1952 @item -fsyntax-only
1953 @opindex fsyntax-only
1954 Check the code for syntax errors, but don't do anything beyond that.
1955
1956 @item -pedantic
1957 @opindex pedantic
1958 Issue all the warnings demanded by strict ISO C and ISO C++;
1959 reject all programs that use forbidden extensions, and some other
1960 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1961 version of the ISO C standard specified by any @option{-std} option used.
1962
1963 Valid ISO C and ISO C++ programs should compile properly with or without
1964 this option (though a rare few will require @option{-ansi} or a
1965 @option{-std} option specifying the required version of ISO C)@.  However,
1966 without this option, certain GNU extensions and traditional C and C++
1967 features are supported as well.  With this option, they are rejected.
1968
1969 @option{-pedantic} does not cause warning messages for use of the
1970 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1971 warnings are also disabled in the expression that follows
1972 @code{__extension__}.  However, only system header files should use
1973 these escape routes; application programs should avoid them.
1974 @xref{Alternate Keywords}.
1975
1976 Some users try to use @option{-pedantic} to check programs for strict ISO
1977 C conformance.  They soon find that it does not do quite what they want:
1978 it finds some non-ISO practices, but not all---only those for which
1979 ISO C @emph{requires} a diagnostic, and some others for which
1980 diagnostics have been added.
1981
1982 A feature to report any failure to conform to ISO C might be useful in
1983 some instances, but would require considerable additional work and would
1984 be quite different from @option{-pedantic}.  We don't have plans to
1985 support such a feature in the near future.
1986
1987 Where the standard specified with @option{-std} represents a GNU
1988 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1989 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1990 extended dialect is based.  Warnings from @option{-pedantic} are given
1991 where they are required by the base standard.  (It would not make sense
1992 for such warnings to be given only for features not in the specified GNU
1993 C dialect, since by definition the GNU dialects of C include all
1994 features the compiler supports with the given option, and there would be
1995 nothing to warn about.)
1996
1997 @item -pedantic-errors
1998 @opindex pedantic-errors
1999 Like @option{-pedantic}, except that errors are produced rather than
2000 warnings.
2001
2002 @item -w
2003 @opindex w
2004 Inhibit all warning messages.
2005
2006 @item -Wno-import
2007 @opindex Wno-import
2008 Inhibit warning messages about the use of @samp{#import}.
2009
2010 @item -Wchar-subscripts
2011 @opindex Wchar-subscripts
2012 Warn if an array subscript has type @code{char}.  This is a common cause
2013 of error, as programmers often forget that this type is signed on some
2014 machines.
2015
2016 @item -Wcomment
2017 @opindex Wcomment
2018 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2019 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2020
2021 @item -Wformat
2022 @opindex Wformat
2023 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2024 the arguments supplied have types appropriate to the format string
2025 specified, and that the conversions specified in the format string make
2026 sense.  This includes standard functions, and others specified by format
2027 attributes (@pxref{Function Attributes}), in the @code{printf},
2028 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2029 not in the C standard) families.
2030
2031 The formats are checked against the format features supported by GNU
2032 libc version 2.2.  These include all ISO C90 and C99 features, as well
2033 as features from the Single Unix Specification and some BSD and GNU
2034 extensions.  Other library implementations may not support all these
2035 features; GCC does not support warning about features that go beyond a
2036 particular library's limitations.  However, if @option{-pedantic} is used
2037 with @option{-Wformat}, warnings will be given about format features not
2038 in the selected standard version (but not for @code{strfmon} formats,
2039 since those are not in any version of the C standard).  @xref{C Dialect
2040 Options,,Options Controlling C Dialect}.
2041
2042 Since @option{-Wformat} also checks for null format arguments for
2043 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2044
2045 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2046 aspects of format checking, the options @option{-Wno-format-y2k},
2047 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2048 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2049 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2050
2051 @item -Wno-format-y2k
2052 @opindex Wno-format-y2k
2053 If @option{-Wformat} is specified, do not warn about @code{strftime}
2054 formats which may yield only a two-digit year.
2055
2056 @item -Wno-format-extra-args
2057 @opindex Wno-format-extra-args
2058 If @option{-Wformat} is specified, do not warn about excess arguments to a
2059 @code{printf} or @code{scanf} format function.  The C standard specifies
2060 that such arguments are ignored.
2061
2062 Where the unused arguments lie between used arguments that are
2063 specified with @samp{$} operand number specifications, normally
2064 warnings are still given, since the implementation could not know what
2065 type to pass to @code{va_arg} to skip the unused arguments.  However,
2066 in the case of @code{scanf} formats, this option will suppress the
2067 warning if the unused arguments are all pointers, since the Single
2068 Unix Specification says that such unused arguments are allowed.
2069
2070 @item -Wno-format-zero-length
2071 @opindex Wno-format-zero-length
2072 If @option{-Wformat} is specified, do not warn about zero-length formats.
2073 The C standard specifies that zero-length formats are allowed.
2074
2075 @item -Wformat-nonliteral
2076 @opindex Wformat-nonliteral
2077 If @option{-Wformat} is specified, also warn if the format string is not a
2078 string literal and so cannot be checked, unless the format function
2079 takes its format arguments as a @code{va_list}.
2080
2081 @item -Wformat-security
2082 @opindex Wformat-security
2083 If @option{-Wformat} is specified, also warn about uses of format
2084 functions that represent possible security problems.  At present, this
2085 warns about calls to @code{printf} and @code{scanf} functions where the
2086 format string is not a string literal and there are no format arguments,
2087 as in @code{printf (foo);}.  This may be a security hole if the format
2088 string came from untrusted input and contains @samp{%n}.  (This is
2089 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2090 in future warnings may be added to @option{-Wformat-security} that are not
2091 included in @option{-Wformat-nonliteral}.)
2092
2093 @item -Wformat=2
2094 @opindex Wformat=2
2095 Enable @option{-Wformat} plus format checks not included in
2096 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2097 -Wformat-nonliteral -Wformat-security}.
2098
2099 @item -Wnonnull
2100 @opindex Wnonnull
2101 Enable warning about passing a null pointer for arguments marked as
2102 requiring a non-null value by the @code{nonnull} function attribute.
2103
2104 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2105 can be disabled with the @option{-Wno-nonnull} option.
2106
2107 @item -Wimplicit-int
2108 @opindex Wimplicit-int
2109 Warn when a declaration does not specify a type.
2110
2111 @item -Wimplicit-function-declaration
2112 @itemx -Werror-implicit-function-declaration
2113 @opindex Wimplicit-function-declaration
2114 @opindex Werror-implicit-function-declaration
2115 Give a warning (or error) whenever a function is used before being
2116 declared.
2117
2118 @item -Wimplicit
2119 @opindex Wimplicit
2120 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2121
2122 @item -Wmain
2123 @opindex Wmain
2124 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2125 function with external linkage, returning int, taking either zero
2126 arguments, two, or three arguments of appropriate types.
2127
2128 @item -Wmissing-braces
2129 @opindex Wmissing-braces
2130 Warn if an aggregate or union initializer is not fully bracketed.  In
2131 the following example, the initializer for @samp{a} is not fully
2132 bracketed, but that for @samp{b} is fully bracketed.
2133
2134 @smallexample
2135 int a[2][2] = @{ 0, 1, 2, 3 @};
2136 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2137 @end smallexample
2138
2139 @item -Wparentheses
2140 @opindex Wparentheses
2141 Warn if parentheses are omitted in certain contexts, such
2142 as when there is an assignment in a context where a truth value
2143 is expected, or when operators are nested whose precedence people
2144 often get confused about.
2145
2146 Also warn about constructions where there may be confusion to which
2147 @code{if} statement an @code{else} branch belongs.  Here is an example of
2148 such a case:
2149
2150 @smallexample
2151 @group
2152 @{
2153   if (a)
2154     if (b)
2155       foo ();
2156   else
2157     bar ();
2158 @}
2159 @end group
2160 @end smallexample
2161
2162 In C, every @code{else} branch belongs to the innermost possible @code{if}
2163 statement, which in this example is @code{if (b)}.  This is often not
2164 what the programmer expected, as illustrated in the above example by
2165 indentation the programmer chose.  When there is the potential for this
2166 confusion, GCC will issue a warning when this flag is specified.
2167 To eliminate the warning, add explicit braces around the innermost
2168 @code{if} statement so there is no way the @code{else} could belong to
2169 the enclosing @code{if}.  The resulting code would look like this:
2170
2171 @smallexample
2172 @group
2173 @{
2174   if (a)
2175     @{
2176       if (b)
2177         foo ();
2178       else
2179         bar ();
2180     @}
2181 @}
2182 @end group
2183 @end smallexample
2184
2185 @item -Wsequence-point
2186 @opindex Wsequence-point
2187 Warn about code that may have undefined semantics because of violations
2188 of sequence point rules in the C standard.
2189
2190 The C standard defines the order in which expressions in a C program are
2191 evaluated in terms of @dfn{sequence points}, which represent a partial
2192 ordering between the execution of parts of the program: those executed
2193 before the sequence point, and those executed after it.  These occur
2194 after the evaluation of a full expression (one which is not part of a
2195 larger expression), after the evaluation of the first operand of a
2196 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2197 function is called (but after the evaluation of its arguments and the
2198 expression denoting the called function), and in certain other places.
2199 Other than as expressed by the sequence point rules, the order of
2200 evaluation of subexpressions of an expression is not specified.  All
2201 these rules describe only a partial order rather than a total order,
2202 since, for example, if two functions are called within one expression
2203 with no sequence point between them, the order in which the functions
2204 are called is not specified.  However, the standards committee have
2205 ruled that function calls do not overlap.
2206
2207 It is not specified when between sequence points modifications to the
2208 values of objects take effect.  Programs whose behavior depends on this
2209 have undefined behavior; the C standard specifies that ``Between the
2210 previous and next sequence point an object shall have its stored value
2211 modified at most once by the evaluation of an expression.  Furthermore,
2212 the prior value shall be read only to determine the value to be
2213 stored.''.  If a program breaks these rules, the results on any
2214 particular implementation are entirely unpredictable.
2215
2216 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2217 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2218 diagnosed by this option, and it may give an occasional false positive
2219 result, but in general it has been found fairly effective at detecting
2220 this sort of problem in programs.
2221
2222 The present implementation of this option only works for C programs.  A
2223 future implementation may also work for C++ programs.
2224
2225 The C standard is worded confusingly, therefore there is some debate
2226 over the precise meaning of the sequence point rules in subtle cases.
2227 Links to discussions of the problem, including proposed formal
2228 definitions, may be found on our readings page, at
2229 @w{@uref{http://gcc.gnu.org/readings.html}}.
2230
2231 @item -Wreturn-type
2232 @opindex Wreturn-type
2233 Warn whenever a function is defined with a return-type that defaults to
2234 @code{int}.  Also warn about any @code{return} statement with no
2235 return-value in a function whose return-type is not @code{void}.
2236
2237 For C++, a function without return type always produces a diagnostic
2238 message, even when @option{-Wno-return-type} is specified.  The only
2239 exceptions are @samp{main} and functions defined in system headers.
2240
2241 @item -Wswitch
2242 @opindex Wswitch
2243 Warn whenever a @code{switch} statement has an index of enumeral type
2244 and lacks a @code{case} for one or more of the named codes of that
2245 enumeration.  (The presence of a @code{default} label prevents this
2246 warning.)  @code{case} labels outside the enumeration range also
2247 provoke warnings when this option is used.
2248
2249 @item -Wswitch-default
2250 @opindex Wswitch-switch
2251 Warn whenever a @code{switch} statement does not have a @code{default}
2252 case.
2253
2254 @item -Wswitch-enum
2255 @opindex Wswitch-enum
2256 Warn whenever a @code{switch} statement has an index of enumeral type
2257 and lacks a @code{case} for one or more of the named codes of that
2258 enumeration.  @code{case} labels outside the enumeration range also
2259 provoke warnings when this option is used.
2260
2261 @item -Wtrigraphs
2262 @opindex Wtrigraphs
2263 Warn if any trigraphs are encountered that might change the meaning of
2264 the program (trigraphs within comments are not warned about).
2265
2266 @item -Wunused-function
2267 @opindex Wunused-function
2268 Warn whenever a static function is declared but not defined or a
2269 non\-inline static function is unused.
2270
2271 @item -Wunused-label
2272 @opindex Wunused-label
2273 Warn whenever a label is declared but not used.
2274
2275 To suppress this warning use the @samp{unused} attribute
2276 (@pxref{Variable Attributes}).
2277
2278 @item -Wunused-parameter
2279 @opindex Wunused-parameter
2280 Warn whenever a function parameter is unused aside from its declaration.
2281
2282 To suppress this warning use the @samp{unused} attribute
2283 (@pxref{Variable Attributes}).
2284
2285 @item -Wunused-variable
2286 @opindex Wunused-variable
2287 Warn whenever a local variable or non-constant static variable is unused
2288 aside from its declaration
2289
2290 To suppress this warning use the @samp{unused} attribute
2291 (@pxref{Variable Attributes}).
2292
2293 @item -Wunused-value
2294 @opindex Wunused-value
2295 Warn whenever a statement computes a result that is explicitly not used.
2296
2297 To suppress this warning cast the expression to @samp{void}.
2298
2299 @item -Wunused
2300 @opindex Wunused
2301 All the above @option{-Wunused} options combined.
2302
2303 In order to get a warning about an unused function parameter, you must
2304 either specify @samp{-W -Wunused} or separately specify
2305 @option{-Wunused-parameter}.
2306
2307 @item -Wuninitialized
2308 @opindex Wuninitialized
2309 Warn if an automatic variable is used without first being initialized or
2310 if a variable may be clobbered by a @code{setjmp} call.
2311
2312 These warnings are possible only in optimizing compilation,
2313 because they require data flow information that is computed only
2314 when optimizing.  If you don't specify @option{-O}, you simply won't
2315 get these warnings.
2316
2317 These warnings occur only for variables that are candidates for
2318 register allocation.  Therefore, they do not occur for a variable that
2319 is declared @code{volatile}, or whose address is taken, or whose size
2320 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2321 structures, unions or arrays, even when they are in registers.
2322
2323 Note that there may be no warning about a variable that is used only
2324 to compute a value that itself is never used, because such
2325 computations may be deleted by data flow analysis before the warnings
2326 are printed.
2327
2328 These warnings are made optional because GCC is not smart
2329 enough to see all the reasons why the code might be correct
2330 despite appearing to have an error.  Here is one example of how
2331 this can happen:
2332
2333 @smallexample
2334 @group
2335 @{
2336   int x;
2337   switch (y)
2338     @{
2339     case 1: x = 1;
2340       break;
2341     case 2: x = 4;
2342       break;
2343     case 3: x = 5;
2344     @}
2345   foo (x);
2346 @}
2347 @end group
2348 @end smallexample
2349
2350 @noindent
2351 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2352 always initialized, but GCC doesn't know this.  Here is
2353 another common case:
2354
2355 @smallexample
2356 @{
2357   int save_y;
2358   if (change_y) save_y = y, y = new_y;
2359   @dots{}
2360   if (change_y) y = save_y;
2361 @}
2362 @end smallexample
2363
2364 @noindent
2365 This has no bug because @code{save_y} is used only if it is set.
2366
2367 @cindex @code{longjmp} warnings
2368 This option also warns when a non-volatile automatic variable might be
2369 changed by a call to @code{longjmp}.  These warnings as well are possible
2370 only in optimizing compilation.
2371
2372 The compiler sees only the calls to @code{setjmp}.  It cannot know
2373 where @code{longjmp} will be called; in fact, a signal handler could
2374 call it at any point in the code.  As a result, you may get a warning
2375 even when there is in fact no problem because @code{longjmp} cannot
2376 in fact be called at the place which would cause a problem.
2377
2378 Some spurious warnings can be avoided if you declare all the functions
2379 you use that never return as @code{noreturn}.  @xref{Function
2380 Attributes}.
2381
2382 @item -Wunknown-pragmas
2383 @opindex Wunknown-pragmas
2384 @cindex warning for unknown pragmas
2385 @cindex unknown pragmas, warning
2386 @cindex pragmas, warning of unknown
2387 Warn when a #pragma directive is encountered which is not understood by
2388 GCC@.  If this command line option is used, warnings will even be issued
2389 for unknown pragmas in system header files.  This is not the case if
2390 the warnings were only enabled by the @option{-Wall} command line option.
2391
2392 @item -Wstrict-aliasing
2393 @opindex Wstrict-aliasing
2394 This option is only active when @option{-fstrict-aliasing} is active.
2395 It warns about code which might break the strict aliasing rules that the
2396 compiler is using for optimization. The warning does not catch all
2397 cases, but does attempt to catch the more common pitfalls. It is
2398 included in @option{-Wall}.
2399
2400 @item -Wall
2401 @opindex Wall
2402 All of the above @samp{-W} options combined.  This enables all the
2403 warnings about constructions that some users consider questionable, and
2404 that are easy to avoid (or modify to prevent the warning), even in
2405 conjunction with macros.  This also enables some language-specific
2406 warnings described in @ref{C++ Dialect Options} and
2407 @ref{Objective-C Dialect Options}.
2408 @end table
2409
2410 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2411 Some of them warn about constructions that users generally do not
2412 consider questionable, but which occasionally you might wish to check
2413 for; others warn about constructions that are necessary or hard to avoid
2414 in some cases, and there is no simple way to modify the code to suppress
2415 the warning.
2416
2417 @table @gcctabopt
2418 @item -W
2419 @opindex W
2420 Print extra warning messages for these events:
2421
2422 @itemize @bullet
2423 @item
2424 A function can return either with or without a value.  (Falling
2425 off the end of the function body is considered returning without
2426 a value.)  For example, this function would evoke such a
2427 warning:
2428
2429 @smallexample
2430 @group
2431 foo (a)
2432 @{
2433   if (a > 0)
2434     return a;
2435 @}
2436 @end group
2437 @end smallexample
2438
2439 @item
2440 An expression-statement or the left-hand side of a comma expression
2441 contains no side effects.
2442 To suppress the warning, cast the unused expression to void.
2443 For example, an expression such as @samp{x[i,j]} will cause a warning,
2444 but @samp{x[(void)i,j]} will not.
2445
2446 @item
2447 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2448
2449 @item
2450 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2451 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2452 that of ordinary mathematical notation.
2453
2454 @item
2455 Storage-class specifiers like @code{static} are not the first things in
2456 a declaration.  According to the C Standard, this usage is obsolescent.
2457
2458 @item
2459 The return type of a function has a type qualifier such as @code{const}.
2460 Such a type qualifier has no effect, since the value returned by a
2461 function is not an lvalue.  (But don't warn about the GNU extension of
2462 @code{volatile void} return types.  That extension will be warned about
2463 if @option{-pedantic} is specified.)
2464
2465 @item
2466 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2467 arguments.
2468
2469 @item
2470 A comparison between signed and unsigned values could produce an
2471 incorrect result when the signed value is converted to unsigned.
2472 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2473
2474 @item
2475 An aggregate has a partly bracketed initializer.
2476 For example, the following code would evoke such a warning,
2477 because braces are missing around the initializer for @code{x.h}:
2478
2479 @smallexample
2480 struct s @{ int f, g; @};
2481 struct t @{ struct s h; int i; @};
2482 struct t x = @{ 1, 2, 3 @};
2483 @end smallexample
2484
2485 @item
2486 An aggregate has an initializer which does not initialize all members.
2487 For example, the following code would cause such a warning, because
2488 @code{x.h} would be implicitly initialized to zero:
2489
2490 @smallexample
2491 struct s @{ int f, g, h; @};
2492 struct s x = @{ 3, 4 @};
2493 @end smallexample
2494 @end itemize
2495
2496 @item -Wno-div-by-zero
2497 @opindex Wno-div-by-zero
2498 @opindex Wdiv-by-zero
2499 Do not warn about compile-time integer division by zero.  Floating point
2500 division by zero is not warned about, as it can be a legitimate way of
2501 obtaining infinities and NaNs.
2502
2503 @item -Wsystem-headers
2504 @opindex Wsystem-headers
2505 @cindex warnings from system headers
2506 @cindex system headers, warnings from
2507 Print warning messages for constructs found in system header files.
2508 Warnings from system headers are normally suppressed, on the assumption
2509 that they usually do not indicate real problems and would only make the
2510 compiler output harder to read.  Using this command line option tells
2511 GCC to emit warnings from system headers as if they occurred in user
2512 code.  However, note that using @option{-Wall} in conjunction with this
2513 option will @emph{not} warn about unknown pragmas in system
2514 headers---for that, @option{-Wunknown-pragmas} must also be used.
2515
2516 @item -Wfloat-equal
2517 @opindex Wfloat-equal
2518 Warn if floating point values are used in equality comparisons.
2519
2520 The idea behind this is that sometimes it is convenient (for the
2521 programmer) to consider floating-point values as approximations to
2522 infinitely precise real numbers.  If you are doing this, then you need
2523 to compute (by analyzing the code, or in some other way) the maximum or
2524 likely maximum error that the computation introduces, and allow for it
2525 when performing comparisons (and when producing output, but that's a
2526 different problem).  In particular, instead of testing for equality, you
2527 would check to see whether the two values have ranges that overlap; and
2528 this is done with the relational operators, so equality comparisons are
2529 probably mistaken.
2530
2531 @item -Wtraditional @r{(C only)}
2532 @opindex Wtraditional
2533 Warn about certain constructs that behave differently in traditional and
2534 ISO C@.  Also warn about ISO C constructs that have no traditional C
2535 equivalent, and/or problematic constructs which should be avoided.
2536
2537 @itemize @bullet
2538 @item
2539 Macro parameters that appear within string literals in the macro body.
2540 In traditional C macro replacement takes place within string literals,
2541 but does not in ISO C@.
2542
2543 @item
2544 In traditional C, some preprocessor directives did not exist.
2545 Traditional preprocessors would only consider a line to be a directive
2546 if the @samp{#} appeared in column 1 on the line.  Therefore
2547 @option{-Wtraditional} warns about directives that traditional C
2548 understands but would ignore because the @samp{#} does not appear as the
2549 first character on the line.  It also suggests you hide directives like
2550 @samp{#pragma} not understood by traditional C by indenting them.  Some
2551 traditional implementations would not recognize @samp{#elif}, so it
2552 suggests avoiding it altogether.
2553
2554 @item
2555 A function-like macro that appears without arguments.
2556
2557 @item
2558 The unary plus operator.
2559
2560 @item
2561 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2562 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2563 constants.)  Note, these suffixes appear in macros defined in the system
2564 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2565 Use of these macros in user code might normally lead to spurious
2566 warnings, however gcc's integrated preprocessor has enough context to
2567 avoid warning in these cases.
2568
2569 @item
2570 A function declared external in one block and then used after the end of
2571 the block.
2572
2573 @item
2574 A @code{switch} statement has an operand of type @code{long}.
2575
2576 @item
2577 A non-@code{static} function declaration follows a @code{static} one.
2578 This construct is not accepted by some traditional C compilers.
2579
2580 @item
2581 The ISO type of an integer constant has a different width or
2582 signedness from its traditional type.  This warning is only issued if
2583 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2584 typically represent bit patterns, are not warned about.
2585
2586 @item
2587 Usage of ISO string concatenation is detected.
2588
2589 @item
2590 Initialization of automatic aggregates.
2591
2592 @item
2593 Identifier conflicts with labels.  Traditional C lacks a separate
2594 namespace for labels.
2595
2596 @item
2597 Initialization of unions.  If the initializer is zero, the warning is
2598 omitted.  This is done under the assumption that the zero initializer in
2599 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2600 initializer warnings and relies on default initialization to zero in the
2601 traditional C case.
2602
2603 @item
2604 Conversions by prototypes between fixed/floating point values and vice
2605 versa.  The absence of these prototypes when compiling with traditional
2606 C would cause serious problems.  This is a subset of the possible
2607 conversion warnings, for the full set use @option{-Wconversion}.
2608
2609 @item
2610 Use of ISO C style function definitions.  This warning intentionally is
2611 @emph{not} issued for prototype declarations or variadic functions
2612 because these ISO C features will appear in your code when using
2613 libiberty's traditional C compatibility macros, @code{PARAMS} and
2614 @code{VPARAMS}.  This warning is also bypassed for nested functions
2615 because that feature is already a gcc extension and thus not relevant to
2616 traditional C compatibility.
2617 @end itemize
2618
2619 @item -Wundef
2620 @opindex Wundef
2621 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2622
2623 @item -Wendif-labels
2624 @opindex Wendif-labels
2625 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2626
2627 @item -Wshadow
2628 @opindex Wshadow
2629 Warn whenever a local variable shadows another local variable, parameter or
2630 global variable or whenever a built-in function is shadowed.
2631
2632 @item -Wlarger-than-@var{len}
2633 @opindex Wlarger-than
2634 Warn whenever an object of larger than @var{len} bytes is defined.
2635
2636 @item -Wpointer-arith
2637 @opindex Wpointer-arith
2638 Warn about anything that depends on the ``size of'' a function type or
2639 of @code{void}.  GNU C assigns these types a size of 1, for
2640 convenience in calculations with @code{void *} pointers and pointers
2641 to functions.
2642
2643 @item -Wbad-function-cast @r{(C only)}
2644 @opindex Wbad-function-cast
2645 Warn whenever a function call is cast to a non-matching type.
2646 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2647
2648 @item -Wcast-qual
2649 @opindex Wcast-qual
2650 Warn whenever a pointer is cast so as to remove a type qualifier from
2651 the target type.  For example, warn if a @code{const char *} is cast
2652 to an ordinary @code{char *}.
2653
2654 @item -Wcast-align
2655 @opindex Wcast-align
2656 Warn whenever a pointer is cast such that the required alignment of the
2657 target is increased.  For example, warn if a @code{char *} is cast to
2658 an @code{int *} on machines where integers can only be accessed at
2659 two- or four-byte boundaries.
2660
2661 @item -Wwrite-strings
2662 @opindex Wwrite-strings
2663 When compiling C, give string constants the type @code{const
2664 char[@var{length}]} so that
2665 copying the address of one into a non-@code{const} @code{char *}
2666 pointer will get a warning; when compiling C++, warn about the
2667 deprecated conversion from string constants to @code{char *}.
2668 These warnings will help you find at
2669 compile time code that can try to write into a string constant, but
2670 only if you have been very careful about using @code{const} in
2671 declarations and prototypes.  Otherwise, it will just be a nuisance;
2672 this is why we did not make @option{-Wall} request these warnings.
2673
2674 @item -Wconversion
2675 @opindex Wconversion
2676 Warn if a prototype causes a type conversion that is different from what
2677 would happen to the same argument in the absence of a prototype.  This
2678 includes conversions of fixed point to floating and vice versa, and
2679 conversions changing the width or signedness of a fixed point argument
2680 except when the same as the default promotion.
2681
2682 Also, warn if a negative integer constant expression is implicitly
2683 converted to an unsigned type.  For example, warn about the assignment
2684 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2685 casts like @code{(unsigned) -1}.
2686
2687 @item -Wsign-compare
2688 @opindex Wsign-compare
2689 @cindex warning for comparison of signed and unsigned values
2690 @cindex comparison of signed and unsigned values, warning
2691 @cindex signed and unsigned values, comparison warning
2692 Warn when a comparison between signed and unsigned values could produce
2693 an incorrect result when the signed value is converted to unsigned.
2694 This warning is also enabled by @option{-W}; to get the other warnings
2695 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2696
2697 @item -Waggregate-return
2698 @opindex Waggregate-return
2699 Warn if any functions that return structures or unions are defined or
2700 called.  (In languages where you can return an array, this also elicits
2701 a warning.)
2702
2703 @item -Wstrict-prototypes @r{(C only)}
2704 @opindex Wstrict-prototypes
2705 Warn if a function is declared or defined without specifying the
2706 argument types.  (An old-style function definition is permitted without
2707 a warning if preceded by a declaration which specifies the argument
2708 types.)
2709
2710 @item -Wmissing-prototypes @r{(C only)}
2711 @opindex Wmissing-prototypes
2712 Warn if a global function is defined without a previous prototype
2713 declaration.  This warning is issued even if the definition itself
2714 provides a prototype.  The aim is to detect global functions that fail
2715 to be declared in header files.
2716
2717 @item -Wmissing-declarations
2718 @opindex Wmissing-declarations
2719 Warn if a global function is defined without a previous declaration.
2720 Do so even if the definition itself provides a prototype.
2721 Use this option to detect global functions that are not declared in
2722 header files.
2723
2724 @item -Wmissing-noreturn
2725 @opindex Wmissing-noreturn
2726 Warn about functions which might be candidates for attribute @code{noreturn}.
2727 Note these are only possible candidates, not absolute ones.  Care should
2728 be taken to manually verify functions actually do not ever return before
2729 adding the @code{noreturn} attribute, otherwise subtle code generation
2730 bugs could be introduced.  You will not get a warning for @code{main} in
2731 hosted C environments.
2732
2733 @item -Wmissing-format-attribute
2734 @opindex Wmissing-format-attribute
2735 @opindex Wformat
2736 If @option{-Wformat} is enabled, also warn about functions which might be
2737 candidates for @code{format} attributes.  Note these are only possible
2738 candidates, not absolute ones.  GCC will guess that @code{format}
2739 attributes might be appropriate for any function that calls a function
2740 like @code{vprintf} or @code{vscanf}, but this might not always be the
2741 case, and some functions for which @code{format} attributes are
2742 appropriate may not be detected.  This option has no effect unless
2743 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2744
2745 @item -Wno-multichar
2746 @opindex Wno-multichar
2747 @opindex Wmultichar
2748 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2749 Usually they indicate a typo in the user's code, as they have
2750 implementation-defined values, and should not be used in portable code.
2751
2752 @item -Wno-deprecated-declarations
2753 @opindex Wno-deprecated-declarations
2754 Do not warn about uses of functions, variables, and types marked as
2755 deprecated by using the @code{deprecated} attribute.
2756 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2757 @pxref{Type Attributes}.)
2758
2759 @item -Wpacked
2760 @opindex Wpacked
2761 Warn if a structure is given the packed attribute, but the packed
2762 attribute has no effect on the layout or size of the structure.
2763 Such structures may be mis-aligned for little benefit.  For
2764 instance, in this code, the variable @code{f.x} in @code{struct bar}
2765 will be misaligned even though @code{struct bar} does not itself
2766 have the packed attribute:
2767
2768 @smallexample
2769 @group
2770 struct foo @{
2771   int x;
2772   char a, b, c, d;
2773 @} __attribute__((packed));
2774 struct bar @{
2775   char z;
2776   struct foo f;
2777 @};
2778 @end group
2779 @end smallexample
2780
2781 @item -Wpadded
2782 @opindex Wpadded
2783 Warn if padding is included in a structure, either to align an element
2784 of the structure or to align the whole structure.  Sometimes when this
2785 happens it is possible to rearrange the fields of the structure to
2786 reduce the padding and so make the structure smaller.
2787
2788 @item -Wredundant-decls
2789 @opindex Wredundant-decls
2790 Warn if anything is declared more than once in the same scope, even in
2791 cases where multiple declaration is valid and changes nothing.
2792
2793 @item -Wnested-externs @r{(C only)}
2794 @opindex Wnested-externs
2795 Warn if an @code{extern} declaration is encountered within a function.
2796
2797 @item -Wunreachable-code
2798 @opindex Wunreachable-code
2799 Warn if the compiler detects that code will never be executed.
2800
2801 This option is intended to warn when the compiler detects that at
2802 least a whole line of source code will never be executed, because
2803 some condition is never satisfied or because it is after a
2804 procedure that never returns.
2805
2806 It is possible for this option to produce a warning even though there
2807 are circumstances under which part of the affected line can be executed,
2808 so care should be taken when removing apparently-unreachable code.
2809
2810 For instance, when a function is inlined, a warning may mean that the
2811 line is unreachable in only one inlined copy of the function.
2812
2813 This option is not made part of @option{-Wall} because in a debugging
2814 version of a program there is often substantial code which checks
2815 correct functioning of the program and is, hopefully, unreachable
2816 because the program does work.  Another common use of unreachable
2817 code is to provide behavior which is selectable at compile-time.
2818
2819 @item -Winline
2820 @opindex Winline
2821 Warn if a function can not be inlined and it was declared as inline.
2822
2823 @item -Wlong-long
2824 @opindex Wlong-long
2825 @opindex Wno-long-long
2826 Warn if @samp{long long} type is used.  This is default.  To inhibit
2827 the warning messages, use @option{-Wno-long-long}.  Flags
2828 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2829 only when @option{-pedantic} flag is used.
2830
2831 @item -Wdisabled-optimization
2832 @opindex Wdisabled-optimization
2833 Warn if a requested optimization pass is disabled.  This warning does
2834 not generally indicate that there is anything wrong with your code; it
2835 merely indicates that GCC's optimizers were unable to handle the code
2836 effectively.  Often, the problem is that your code is too big or too
2837 complex; GCC will refuse to optimize programs when the optimization
2838 itself is likely to take inordinate amounts of time.
2839
2840 @item -Werror
2841 @opindex Werror
2842 Make all warnings into errors.
2843 @end table
2844
2845 @node Debugging Options
2846 @section Options for Debugging Your Program or GCC
2847 @cindex options, debugging
2848 @cindex debugging information options
2849
2850 GCC has various special options that are used for debugging
2851 either your program or GCC:
2852
2853 @table @gcctabopt
2854 @item -g
2855 @opindex g
2856 Produce debugging information in the operating system's native format
2857 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2858 information.
2859
2860 On most systems that use stabs format, @option{-g} enables use of extra
2861 debugging information that only GDB can use; this extra information
2862 makes debugging work better in GDB but will probably make other debuggers
2863 crash or
2864 refuse to read the program.  If you want to control for certain whether
2865 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2866 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2867 or @option{-gvms} (see below).
2868
2869 Unlike most other C compilers, GCC allows you to use @option{-g} with
2870 @option{-O}.  The shortcuts taken by optimized code may occasionally
2871 produce surprising results: some variables you declared may not exist
2872 at all; flow of control may briefly move where you did not expect it;
2873 some statements may not be executed because they compute constant
2874 results or their values were already at hand; some statements may
2875 execute in different places because they were moved out of loops.
2876
2877 Nevertheless it proves possible to debug optimized output.  This makes
2878 it reasonable to use the optimizer for programs that might have bugs.
2879
2880 The following options are useful when GCC is generated with the
2881 capability for more than one debugging format.
2882
2883 @item -ggdb
2884 @opindex ggdb
2885 Produce debugging information for use by GDB@.  This means to use the
2886 most expressive format available (DWARF 2, stabs, or the native format
2887 if neither of those are supported), including GDB extensions if at all
2888 possible.
2889
2890 @item -gstabs
2891 @opindex gstabs
2892 Produce debugging information in stabs format (if that is supported),
2893 without GDB extensions.  This is the format used by DBX on most BSD
2894 systems.  On MIPS, Alpha and System V Release 4 systems this option
2895 produces stabs debugging output which is not understood by DBX or SDB@.
2896 On System V Release 4 systems this option requires the GNU assembler.
2897
2898 @item -gstabs+
2899 @opindex gstabs+
2900 Produce debugging information in stabs format (if that is supported),
2901 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2902 use of these extensions is likely to make other debuggers crash or
2903 refuse to read the program.
2904
2905 @item -gcoff
2906 @opindex gcoff
2907 Produce debugging information in COFF format (if that is supported).
2908 This is the format used by SDB on most System V systems prior to
2909 System V Release 4.
2910
2911 @item -gxcoff
2912 @opindex gxcoff
2913 Produce debugging information in XCOFF format (if that is supported).
2914 This is the format used by the DBX debugger on IBM RS/6000 systems.
2915
2916 @item -gxcoff+
2917 @opindex gxcoff+
2918 Produce debugging information in XCOFF format (if that is supported),
2919 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2920 use of these extensions is likely to make other debuggers crash or
2921 refuse to read the program, and may cause assemblers other than the GNU
2922 assembler (GAS) to fail with an error.
2923
2924 @item -gdwarf
2925 @opindex gdwarf
2926 Produce debugging information in DWARF version 1 format (if that is
2927 supported).  This is the format used by SDB on most System V Release 4
2928 systems.
2929
2930 This option is deprecated.
2931
2932 @item -gdwarf+
2933 @opindex gdwarf+
2934 Produce debugging information in DWARF version 1 format (if that is
2935 supported), using GNU extensions understood only by the GNU debugger
2936 (GDB)@.  The use of these extensions is likely to make other debuggers
2937 crash or refuse to read the program.
2938
2939 This option is deprecated.
2940
2941 @item -gdwarf-2
2942 @opindex gdwarf-2
2943 Produce debugging information in DWARF version 2 format (if that is
2944 supported).  This is the format used by DBX on IRIX 6.
2945
2946 @item -gvms
2947 @opindex gvms
2948 Produce debugging information in VMS debug format (if that is
2949 supported).  This is the format used by DEBUG on VMS systems.
2950
2951 @item -g@var{level}
2952 @itemx -ggdb@var{level}
2953 @itemx -gstabs@var{level}
2954 @itemx -gcoff@var{level}
2955 @itemx -gxcoff@var{level}
2956 @itemx -gvms@var{level}
2957 Request debugging information and also use @var{level} to specify how
2958 much information.  The default level is 2.
2959
2960 Level 1 produces minimal information, enough for making backtraces in
2961 parts of the program that you don't plan to debug.  This includes
2962 descriptions of functions and external variables, but no information
2963 about local variables and no line numbers.
2964
2965 Level 3 includes extra information, such as all the macro definitions
2966 present in the program.  Some debuggers support macro expansion when
2967 you use @option{-g3}.
2968
2969 Note that in order to avoid confusion between DWARF1 debug level 2,
2970 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2971 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2972 option to change the debug level for DWARF1 or DWARF2.
2973
2974 @item -feliminate-dwarf2-dups
2975 @opindex feliminate-dwarf2-dups
2976 Compress DWARF2 debugging information by eliminating duplicated
2977 information about each symbol.  This option only makes sense when
2978 generating DWARF2 debugging information with @option{-gdwarf-2}.
2979
2980 @cindex @code{prof}
2981 @item -p
2982 @opindex p
2983 Generate extra code to write profile information suitable for the
2984 analysis program @code{prof}.  You must use this option when compiling
2985 the source files you want data about, and you must also use it when
2986 linking.
2987
2988 @cindex @code{gprof}
2989 @item -pg
2990 @opindex pg
2991 Generate extra code to write profile information suitable for the
2992 analysis program @code{gprof}.  You must use this option when compiling
2993 the source files you want data about, and you must also use it when
2994 linking.
2995
2996 @item -Q
2997 @opindex Q
2998 Makes the compiler print out each function name as it is compiled, and
2999 print some statistics about each pass when it finishes.
3000
3001 @item -ftime-report
3002 @opindex ftime-report
3003 Makes the compiler print some statistics about the time consumed by each
3004 pass when it finishes.
3005
3006 @item -fmem-report
3007 @opindex fmem-report
3008 Makes the compiler print some statistics about permanent memory
3009 allocation when it finishes.
3010
3011 @item -fprofile-arcs
3012 @opindex fprofile-arcs
3013 Instrument @dfn{arcs} during compilation to generate coverage data or
3014 for profile-directed block ordering.  During execution the program
3015 records how many times each branch is executed and how many times it is
3016 taken.  When the compiled program exits it saves this data to a file
3017 called @file{@var{auxname}.da} for each source file.  @var{auxname} is
3018 generated from the name of the output file, if explicitly specified and
3019 it is not the final executable, otherwise it is the basename of the
3020 source file. In both cases any suffix is removed (e.g.  @file{foo.da}
3021 for input file @file{dir/foo.c}, or @file{dir/foo.da} for output file
3022 specified as @option{-o dir/foo.o}).
3023
3024 For profile-directed block ordering, compile the program with
3025 @option{-fprofile-arcs} plus optimization and code generation options,
3026 generate the arc profile information by running the program on a
3027 selected workload, and then compile the program again with the same
3028 optimization and code generation options plus
3029 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3030 Control Optimization}).
3031
3032 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
3033 when it is used with the @option{-ftest-coverage} option.
3034
3035 With @option{-fprofile-arcs}, for each function of your program GCC
3036 creates a program flow graph, then finds a spanning tree for the graph.
3037 Only arcs that are not on the spanning tree have to be instrumented: the
3038 compiler adds code to count the number of times that these arcs are
3039 executed.  When an arc is the only exit or only entrance to a block, the
3040 instrumentation code can be added to the block; otherwise, a new basic
3041 block must be created to hold the instrumentation code.
3042
3043 @need 2000
3044 @item -ftest-coverage
3045 @opindex ftest-coverage
3046 Create data files for the @code{gcov} code-coverage utility
3047 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).  See
3048 @option{-fprofile-arcs} option above for a description of @var{auxname}.
3049
3050 @table @gcctabopt
3051 @item @var{auxname}.bb
3052 A mapping from basic blocks to line numbers, which @code{gcov} uses to
3053 associate basic block execution counts with line numbers.
3054
3055 @item @var{auxname}.bbg
3056 A list of all arcs in the program flow graph.  This allows @code{gcov}
3057 to reconstruct the program flow graph, so that it can compute all basic
3058 block and arc execution counts from the information in the
3059 @file{@var{auxname}.da} file.
3060 @end table
3061
3062 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
3063 option adds instrumentation to the program, which then writes
3064 execution counts to another data file:
3065
3066 @table @gcctabopt
3067 @item @var{auxname}.da
3068 Runtime arc execution counts, used in conjunction with the arc
3069 information in the file @file{@var{auxname}.bbg}.
3070 @end table
3071
3072 Coverage data will map better to the source files if
3073 @option{-ftest-coverage} is used without optimization.
3074
3075 @item -d@var{letters}
3076 @opindex d
3077 Says to make debugging dumps during compilation at times specified by
3078 @var{letters}.  This is used for debugging the compiler.  The file names
3079 for most of the dumps are made by appending a pass number and a word to
3080 the @var{dumpname}. @var{dumpname} is generated from the name of the
3081 output file, if explicitly specified and it is not an executable,
3082 otherwise it is the basename of the source file. In both cases any
3083 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3084 Here are the possible letters for use in @var{letters}, and their
3085 meanings:
3086
3087 @table @samp
3088 @item A
3089 @opindex dA
3090 Annotate the assembler output with miscellaneous debugging information.
3091 @item b
3092 @opindex db
3093 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3094 @item B
3095 @opindex dB
3096 Dump after block reordering, to @file{@var{file}.32.bbro}.
3097 @item c
3098 @opindex dc
3099 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3100 @item C
3101 @opindex dC
3102 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3103 @item d
3104 @opindex dd
3105 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3106 @item D
3107 @opindex dD
3108 Dump all macro definitions, at the end of preprocessing, in addition to
3109 normal output.
3110 @item e
3111 @opindex de
3112 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3113 @file{@var{file}.07.ussa}.
3114 @item E
3115 @opindex dE
3116 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3117 @item f
3118 @opindex df
3119 Dump after life analysis, to @file{@var{file}.18.life}.
3120 @item F
3121 @opindex dF
3122 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3123 @item g
3124 @opindex dg
3125 Dump after global register allocation, to @file{@var{file}.24.greg}.
3126 @item h
3127 @opindex dh
3128 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3129 @item k
3130 @opindex dk
3131 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3132 @item o
3133 @opindex do
3134 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3135 @item G
3136 @opindex dG
3137 Dump after GCSE, to @file{@var{file}.11.gcse}.
3138 @item i
3139 @opindex di
3140 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3141 @item j
3142 @opindex dj
3143 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3144 @item k
3145 @opindex dk
3146 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3147 @item l
3148 @opindex dl
3149 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3150 @item L
3151 @opindex dL
3152 Dump after loop optimization, to @file{@var{file}.12.loop}.
3153 @item M
3154 @opindex dM
3155 Dump after performing the machine dependent reorganization pass, to
3156 @file{@var{file}.33.mach}.
3157 @item n
3158 @opindex dn
3159 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3160 @item N
3161 @opindex dN
3162 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3163 @item r
3164 @opindex dr
3165 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3166 @item R
3167 @opindex dR
3168 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3169 @item s
3170 @opindex ds
3171 Dump after CSE (including the jump optimization that sometimes follows
3172 CSE), to @file{@var{file}.09.cse}.
3173 @item S
3174 @opindex dS
3175 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3176 @item t
3177 @opindex dt
3178 Dump after the second CSE pass (including the jump optimization that
3179 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3180 @item u
3181 @opindex du
3182 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3183 @item w
3184 @opindex dw
3185 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3186 @item X
3187 @opindex dX
3188 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3189 @item z
3190 @opindex dz
3191 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3192 @item a
3193 @opindex da
3194 Produce all the dumps listed above.
3195 @item m
3196 @opindex dm
3197 Print statistics on memory usage, at the end of the run, to
3198 standard error.
3199 @item p
3200 @opindex dp
3201 Annotate the assembler output with a comment indicating which
3202 pattern and alternative was used.  The length of each instruction is
3203 also printed.
3204 @item P
3205 @opindex dP
3206 Dump the RTL in the assembler output as a comment before each instruction.
3207 Also turns on @option{-dp} annotation.
3208 @item v
3209 @opindex dv
3210 For each of the other indicated dump files (except for
3211 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3212 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3213 @item x
3214 @opindex dx
3215 Just generate RTL for a function instead of compiling it.  Usually used
3216 with @samp{r}.
3217 @item y
3218 @opindex dy
3219 Dump debugging information during parsing, to standard error.
3220 @end table
3221
3222 @item -fdump-unnumbered
3223 @opindex fdump-unnumbered
3224 When doing debugging dumps (see @option{-d} option above), suppress instruction
3225 numbers and line number note output.  This makes it more feasible to
3226 use diff on debugging dumps for compiler invocations with different
3227 options, in particular with and without @option{-g}.
3228
3229 @item -fdump-translation-unit @r{(C and C++ only)}
3230 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3231 @opindex fdump-translation-unit
3232 Dump a representation of the tree structure for the entire translation
3233 unit to a file.  The file name is made by appending @file{.tu} to the
3234 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3235 controls the details of the dump as described for the
3236 @option{-fdump-tree} options.
3237
3238 @item -fdump-class-hierarchy @r{(C++ only)}
3239 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3240 @opindex fdump-class-hierarchy
3241 Dump a representation of each class's hierarchy and virtual function
3242 table layout to a file.  The file name is made by appending @file{.class}
3243 to the source file name.  If the @samp{-@var{options}} form is used,
3244 @var{options} controls the details of the dump as described for the
3245 @option{-fdump-tree} options.
3246
3247 @item -fdump-tree-@var{switch} @r{(C++ only)}
3248 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3249 @opindex fdump-tree
3250 Control the dumping at various stages of processing the intermediate
3251 language tree to a file.  The file name is generated by appending a switch
3252 specific suffix to the source file name.  If the @samp{-@var{options}}
3253 form is used, @var{options} is a list of @samp{-} separated options that
3254 control the details of the dump. Not all options are applicable to all
3255 dumps, those which are not meaningful will be ignored. The following
3256 options are available
3257
3258 @table @samp
3259 @item address
3260 Print the address of each node.  Usually this is not meaningful as it
3261 changes according to the environment and source file. Its primary use
3262 is for tying up a dump file with a debug environment.
3263 @item slim
3264 Inhibit dumping of members of a scope or body of a function merely
3265 because that scope has been reached. Only dump such items when they
3266 are directly reachable by some other path.
3267 @item all
3268 Turn on all options.
3269 @end table
3270
3271 The following tree dumps are possible:
3272 @table @samp
3273 @item original
3274 Dump before any tree based optimization, to @file{@var{file}.original}.
3275 @item optimized
3276 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3277 @item inlined
3278 Dump after function inlining, to @file{@var{file}.inlined}.
3279 @end table
3280
3281 @item -fsched-verbose=@var{n}
3282 @opindex fsched-verbose
3283 On targets that use instruction scheduling, this option controls the
3284 amount of debugging output the scheduler prints.  This information is
3285 written to standard error, unless @option{-dS} or @option{-dR} is
3286 specified, in which case it is output to the usual dump
3287 listing file, @file{.sched} or @file{.sched2} respectively.  However
3288 for @var{n} greater than nine, the output is always printed to standard
3289 error.
3290
3291 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3292 same information as @option{-dRS}.  For @var{n} greater than one, it
3293 also output basic block probabilities, detailed ready list information
3294 and unit/insn info.  For @var{n} greater than two, it includes RTL
3295 at abort point, control-flow and regions info.  And for @var{n} over
3296 four, @option{-fsched-verbose} also includes dependence info.
3297
3298 @item -save-temps
3299 @opindex save-temps
3300 Store the usual ``temporary'' intermediate files permanently; place them
3301 in the current directory and name them based on the source file.  Thus,
3302 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3303 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3304 preprocessed @file{foo.i} output file even though the compiler now
3305 normally uses an integrated preprocessor.
3306
3307 @item -time
3308 @opindex time
3309 Report the CPU time taken by each subprocess in the compilation
3310 sequence.  For C source files, this is the compiler proper and assembler
3311 (plus the linker if linking is done).  The output looks like this:
3312
3313 @smallexample
3314 # cc1 0.12 0.01
3315 # as 0.00 0.01
3316 @end smallexample
3317
3318 The first number on each line is the ``user time,'' that is time spent
3319 executing the program itself.  The second number is ``system time,''
3320 time spent executing operating system routines on behalf of the program.
3321 Both numbers are in seconds.
3322
3323 @item -print-file-name=@var{library}
3324 @opindex print-file-name
3325 Print the full absolute name of the library file @var{library} that
3326 would be used when linking---and don't do anything else.  With this
3327 option, GCC does not compile or link anything; it just prints the
3328 file name.
3329
3330 @item -print-multi-directory
3331 @opindex print-multi-directory
3332 Print the directory name corresponding to the multilib selected by any
3333 other switches present in the command line.  This directory is supposed
3334 to exist in @env{GCC_EXEC_PREFIX}.
3335
3336 @item -print-multi-lib
3337 @opindex print-multi-lib
3338 Print the mapping from multilib directory names to compiler switches
3339 that enable them.  The directory name is separated from the switches by
3340 @samp{;}, and each switch starts with an @samp{@@} instead of the
3341 @samp{-}, without spaces between multiple switches.  This is supposed to
3342 ease shell-processing.
3343
3344 @item -print-prog-name=@var{program}
3345 @opindex print-prog-name
3346 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3347
3348 @item -print-libgcc-file-name
3349 @opindex print-libgcc-file-name
3350 Same as @option{-print-file-name=libgcc.a}.
3351
3352 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3353 but you do want to link with @file{libgcc.a}.  You can do
3354
3355 @example
3356 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3357 @end example
3358
3359 @item -print-search-dirs
3360 @opindex print-search-dirs
3361 Print the name of the configured installation directory and a list of
3362 program and library directories gcc will search---and don't do anything else.
3363
3364 This is useful when gcc prints the error message
3365 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3366 To resolve this you either need to put @file{cpp0} and the other compiler
3367 components where gcc expects to find them, or you can set the environment
3368 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3369 Don't forget the trailing '/'.
3370 @xref{Environment Variables}.
3371
3372 @item -dumpmachine
3373 @opindex dumpmachine
3374 Print the compiler's target machine (for example,
3375 @samp{i686-pc-linux-gnu})---and don't do anything else.
3376
3377 @item -dumpversion
3378 @opindex dumpversion
3379 Print the compiler version (for example, @samp{3.0})---and don't do
3380 anything else.
3381
3382 @item -dumpspecs
3383 @opindex dumpspecs
3384 Print the compiler's built-in specs---and don't do anything else.  (This
3385 is used when GCC itself is being built.)  @xref{Spec Files}.
3386 @end table
3387
3388 @node Optimize Options
3389 @section Options That Control Optimization
3390 @cindex optimize options
3391 @cindex options, optimization
3392
3393 These options control various sorts of optimizations:
3394
3395 @table @gcctabopt
3396 @item -O
3397 @itemx -O1
3398 @opindex O
3399 @opindex O1
3400 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3401 more memory for a large function.
3402
3403 Without @option{-O}, the compiler's goal is to reduce the cost of
3404 compilation and to make debugging produce the expected results.
3405 Statements are independent: if you stop the program with a breakpoint
3406 between statements, you can then assign a new value to any variable or
3407 change the program counter to any other statement in the function and
3408 get exactly the results you would expect from the source code.
3409
3410 With @option{-O}, the compiler tries to reduce code size and execution
3411 time, without performing any optimizations that take a great deal of
3412 compilation time.
3413
3414 @item -O2
3415 @opindex O2
3416 Optimize even more.  GCC performs nearly all supported optimizations
3417 that do not involve a space-speed tradeoff.  The compiler does not
3418 perform loop unrolling or function inlining when you specify @option{-O2}.
3419 As compared to @option{-O}, this option increases both compilation time
3420 and the performance of the generated code.
3421
3422 @option{-O2} turns on all optional optimizations except for loop
3423 unrolling, function inlining, and register renaming.  It also turns on
3424 the @option{-fforce-mem} and @option{-fstrict-aliasing} option on all
3425 machines and frame pointer elimination on machines where doing so does
3426 not interfere with debugging.
3427
3428 Please note the warning under @option{-fgcse} about
3429 invoking @option{-O2} on programs that use computed gotos.
3430
3431 @item -O3
3432 @opindex O3
3433 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3434 @option{-O2} and also turns on the @option{-finline-functions} and
3435 @option{-frename-registers} options.
3436
3437 @item -O0
3438 @opindex O0
3439 Do not optimize.
3440
3441 @item -Os
3442 @opindex Os
3443 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3444 do not typically increase code size.  It also performs further
3445 optimizations designed to reduce code size.
3446
3447 If you use multiple @option{-O} options, with or without level numbers,
3448 the last such option is the one that is effective.
3449 @end table
3450
3451 Options of the form @option{-f@var{flag}} specify machine-independent
3452 flags.  Most flags have both positive and negative forms; the negative
3453 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3454 only one of the forms is listed---the one which is not the default.
3455 You can figure out the other form by either removing @samp{no-} or
3456 adding it.
3457
3458 @table @gcctabopt
3459 @item -ffloat-store
3460 @opindex ffloat-store
3461 Do not store floating point variables in registers, and inhibit other
3462 options that might change whether a floating point value is taken from a
3463 register or memory.
3464
3465 @cindex floating point precision
3466 This option prevents undesirable excess precision on machines such as
3467 the 68000 where the floating registers (of the 68881) keep more
3468 precision than a @code{double} is supposed to have.  Similarly for the
3469 x86 architecture.  For most programs, the excess precision does only
3470 good, but a few programs rely on the precise definition of IEEE floating
3471 point.  Use @option{-ffloat-store} for such programs, after modifying
3472 them to store all pertinent intermediate computations into variables.
3473
3474 @item -fno-default-inline
3475 @opindex fno-default-inline
3476 Do not make member functions inline by default merely because they are
3477 defined inside the class scope (C++ only).  Otherwise, when you specify
3478 @w{@option{-O}}, member functions defined inside class scope are compiled
3479 inline by default; i.e., you don't need to add @samp{inline} in front of
3480 the member function name.
3481
3482 @item -fno-defer-pop
3483 @opindex fno-defer-pop
3484 Always pop the arguments to each function call as soon as that function
3485 returns.  For machines which must pop arguments after a function call,
3486 the compiler normally lets arguments accumulate on the stack for several
3487 function calls and pops them all at once.
3488
3489 @item -fforce-mem
3490 @opindex fforce-mem
3491 Force memory operands to be copied into registers before doing
3492 arithmetic on them.  This produces better code by making all memory
3493 references potential common subexpressions.  When they are not common
3494 subexpressions, instruction combination should eliminate the separate
3495 register-load.  The @option{-O2} option turns on this option.
3496
3497 @item -fforce-addr
3498 @opindex fforce-addr
3499 Force memory address constants to be copied into registers before
3500 doing arithmetic on them.  This may produce better code just as
3501 @option{-fforce-mem} may.
3502
3503 @item -fomit-frame-pointer
3504 @opindex fomit-frame-pointer
3505 Don't keep the frame pointer in a register for functions that
3506 don't need one.  This avoids the instructions to save, set up and
3507 restore frame pointers; it also makes an extra register available
3508 in many functions.  @strong{It also makes debugging impossible on
3509 some machines.}
3510
3511 On some machines, such as the VAX, this flag has no effect, because
3512 the standard calling sequence automatically handles the frame pointer
3513 and nothing is saved by pretending it doesn't exist.  The
3514 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3515 whether a target machine supports this flag.  @xref{Registers,,Register
3516 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3517
3518 @item -foptimize-sibling-calls
3519 @opindex foptimize-sibling-calls
3520 Optimize sibling and tail recursive calls.
3521
3522 @item -ftrapv
3523 @opindex ftrapv
3524 This option generates traps for signed overflow on addition, subtraction,
3525 multiplication operations.
3526
3527 @item -fno-inline
3528 @opindex fno-inline
3529 Don't pay attention to the @code{inline} keyword.  Normally this option
3530 is used to keep the compiler from expanding any functions inline.
3531 Note that if you are not optimizing, no functions can be expanded inline.
3532
3533 @item -finline-functions
3534 @opindex finline-functions
3535 Integrate all simple functions into their callers.  The compiler
3536 heuristically decides which functions are simple enough to be worth
3537 integrating in this way.
3538
3539 If all calls to a given function are integrated, and the function is
3540 declared @code{static}, then the function is normally not output as
3541 assembler code in its own right.
3542
3543 @item -finline-limit=@var{n}
3544 @opindex finline-limit
3545 By default, gcc limits the size of functions that can be inlined.  This flag
3546 allows the control of this limit for functions that are explicitly marked as
3547 inline (i.e., marked with the inline keyword or defined within the class
3548 definition in c++).  @var{n} is the size of functions that can be inlined in
3549 number of pseudo instructions (not counting parameter handling).  The default
3550 value of @var{n} is 600.
3551 Increasing this value can result in more inlined code at
3552 the cost of compilation time and memory consumption.  Decreasing usually makes
3553 the compilation faster and less code will be inlined (which presumably
3554 means slower programs).  This option is particularly useful for programs that
3555 use inlining heavily such as those based on recursive templates with C++.
3556
3557 @emph{Note:} pseudo instruction represents, in this particular context, an
3558 abstract measurement of function's size.  In no way, it represents a count
3559 of assembly instructions and as such its exact meaning might change from one
3560 release to an another.
3561
3562 @item -fkeep-inline-functions
3563 @opindex fkeep-inline-functions
3564 Even if all calls to a given function are integrated, and the function
3565 is declared @code{static}, nevertheless output a separate run-time
3566 callable version of the function.  This switch does not affect
3567 @code{extern inline} functions.
3568
3569 @item -fkeep-static-consts
3570 @opindex fkeep-static-consts
3571 Emit variables declared @code{static const} when optimization isn't turned
3572 on, even if the variables aren't referenced.
3573
3574 GCC enables this option by default.  If you want to force the compiler to
3575 check if the variable was referenced, regardless of whether or not
3576 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3577
3578 @item -fmerge-constants
3579 Attempt to merge identical constants (string constants and floating point
3580 constants) across compilation units.
3581
3582 This option is the default for optimized compilation if the assembler and
3583 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3584 behavior.
3585
3586 @item -fmerge-all-constants
3587 Attempt to merge identical constants and identical variables.
3588
3589 This option implies @option{-fmerge-constants}.  In addition to
3590 @option{-fmerge-constants} this considers e.g. even constant initialized
3591 arrays or initialized constant variables with integral or floating point
3592 types.  Languages like C or C++ require each non-automatic variable to
3593 have distinct location, so using this option will result in non-conforming
3594 behavior.
3595
3596 @item -fnew-ra
3597 @opindex fnew-ra
3598 Use a graph coloring register allocator.  Currently this option is meant
3599 for testing, so we are interested to hear about miscompilations with
3600 @option{-fnew-ra}.
3601
3602 @item -fno-branch-count-reg
3603 @opindex fno-branch-count-reg
3604 Do not use ``decrement and branch'' instructions on a count register,
3605 but instead generate a sequence of instructions that decrement a
3606 register, compare it against zero, then branch based upon the result.
3607 This option is only meaningful on architectures that support such
3608 instructions, which include x86, PowerPC, IA-64 and S/390.
3609
3610 @item -fno-function-cse
3611 @opindex fno-function-cse
3612 Do not put function addresses in registers; make each instruction that
3613 calls a constant function contain the function's address explicitly.
3614
3615 This option results in less efficient code, but some strange hacks
3616 that alter the assembler output may be confused by the optimizations
3617 performed when this option is not used.
3618
3619 @item -ffast-math
3620 @opindex ffast-math
3621 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
3622 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
3623 @option{-fno-signaling-nans}.
3624
3625 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3626
3627 This option should never be turned on by any @option{-O} option since
3628 it can result in incorrect output for programs which depend on
3629 an exact implementation of IEEE or ISO rules/specifications for
3630 math functions.
3631
3632 @item -fno-math-errno
3633 @opindex fno-math-errno
3634 Do not set ERRNO after calling math functions that are executed
3635 with a single instruction, e.g., sqrt.  A program that relies on
3636 IEEE exceptions for math error handling may want to use this flag
3637 for speed while maintaining IEEE arithmetic compatibility.
3638
3639 This option should never be turned on by any @option{-O} option since
3640 it can result in incorrect output for programs which depend on
3641 an exact implementation of IEEE or ISO rules/specifications for
3642 math functions.
3643
3644 The default is @option{-fmath-errno}.
3645
3646 @item -funsafe-math-optimizations
3647 @opindex funsafe-math-optimizations
3648 Allow optimizations for floating-point arithmetic that (a) assume
3649 that arguments and results are valid and (b) may violate IEEE or
3650 ANSI standards.  When used at link-time, it may include libraries
3651 or startup files that change the default FPU control word or other
3652 similar optimizations.
3653
3654 This option should never be turned on by any @option{-O} option since
3655 it can result in incorrect output for programs which depend on
3656 an exact implementation of IEEE or ISO rules/specifications for
3657 math functions.
3658
3659 The default is @option{-fno-unsafe-math-optimizations}.
3660
3661 @item -ffinite-math-only
3662 @opindex ffinite-math-only
3663 Allow optimizations for floating-point arithmetic that assume
3664 that arguments and results are not NaNs or +-Infs.
3665
3666 This option should never be turned on by any @option{-O} option since
3667 it can result in incorrect output for programs which depend on
3668 an exact implementation of IEEE or ISO rules/specifications.
3669
3670 The default is @option{-fno-finite-math-only}.
3671
3672 @item -fno-trapping-math
3673 @opindex fno-trapping-math
3674 Compile code assuming that floating-point operations cannot generate
3675 user-visible traps.  These traps include division by zero, overflow,
3676 underflow, inexact result and invalid operation.  This option implies
3677 @option{-fno-signaling-nans}.  Setting this option may allow faster
3678 code if one relies on ``non-stop'' IEEE arithmetic, for example.
3679
3680 This option should never be turned on by any @option{-O} option since
3681 it can result in incorrect output for programs which depend on
3682 an exact implementation of IEEE or ISO rules/specifications for
3683 math functions.
3684
3685 The default is @option{-ftrapping-math}.
3686
3687 @item -fsignaling-nans
3688 @opindex fsignaling-nans
3689 Compile code assuming that IEEE signaling NaNs may generate user-visible
3690 traps during floating-point operations.  Setting this option disables
3691 optimizations that may change the number of exceptions visible with
3692 signaling NaNs.  This option implies @option{-ftrapping-math}.
3693
3694 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
3695 be defined.
3696
3697 The default is @option{-fno-signaling-nans}.
3698
3699 This option is experimental and does not currently guarantee to
3700 disable all GCC optimizations that affect signaling NaN behavior.
3701
3702 @item -fno-zero-initialized-in-bss
3703 @opindex fno-zero-initialized-in-bss
3704 If the target supports a BSS section, GCC by default puts variables that
3705 are initialized to zero into BSS@.  This can save space in the resulting
3706 code.
3707
3708 This option turns off this behavior because some programs explicitly
3709 rely on variables going to the data section.  E.g., so that the
3710 resulting executable can find the beginning of that section and/or make
3711 assumptions based on that.
3712
3713 The default is @option{-fzero-initialized-in-bss}.
3714
3715 @item -fbounds-check
3716 @opindex fbounds-check
3717 For front-ends that support it, generate additional code to check that
3718 indices used to access arrays are within the declared range.  This is
3719 currently only supported by the Java and Fortran 77 front-ends, where
3720 this option defaults to true and false respectively.
3721
3722 @end table
3723
3724 The following options control specific optimizations.  The @option{-O2}
3725 option turns on all of these optimizations except @option{-funroll-loops}
3726 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3727 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3728 but specific machines may handle it differently.
3729
3730 You can use the following flags in the rare cases when ``fine-tuning''
3731 of optimizations to be performed is desired.
3732
3733 Not all of the optimizations performed by GCC have @option{-f} options
3734 to control them.
3735
3736 @table @gcctabopt
3737 @item -fstrength-reduce
3738 @opindex fstrength-reduce
3739 Perform the optimizations of loop strength reduction and
3740 elimination of iteration variables.
3741
3742 @item -fthread-jumps
3743 @opindex fthread-jumps
3744 Perform optimizations where we check to see if a jump branches to a
3745 location where another comparison subsumed by the first is found.  If
3746 so, the first branch is redirected to either the destination of the
3747 second branch or a point immediately following it, depending on whether
3748 the condition is known to be true or false.
3749
3750 @item -fcse-follow-jumps
3751 @opindex fcse-follow-jumps
3752 In common subexpression elimination, scan through jump instructions
3753 when the target of the jump is not reached by any other path.  For
3754 example, when CSE encounters an @code{if} statement with an
3755 @code{else} clause, CSE will follow the jump when the condition
3756 tested is false.
3757
3758 @item -fcse-skip-blocks
3759 @opindex fcse-skip-blocks
3760 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3761 follow jumps which conditionally skip over blocks.  When CSE
3762 encounters a simple @code{if} statement with no else clause,
3763 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3764 body of the @code{if}.
3765
3766 @item -frerun-cse-after-loop
3767 @opindex frerun-cse-after-loop
3768 Re-run common subexpression elimination after loop optimizations has been
3769 performed.
3770
3771 @item -frerun-loop-opt
3772 @opindex frerun-loop-opt
3773 Run the loop optimizer twice.
3774
3775 @item -fgcse
3776 @opindex fgcse
3777 Perform a global common subexpression elimination pass.
3778 This pass also performs global constant and copy propagation.
3779
3780 @emph{Note:} When compiling a program using computed gotos, a GCC
3781 extension, you may get better runtime performance if you disable
3782 the global common subexpression elimination pass by adding
3783 @option{-fno-gcse} to the command line.
3784
3785 @item -fgcse-lm
3786 @opindex fgcse-lm
3787 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3788 attempt to move loads which are only killed by stores into themselves.  This
3789 allows a loop containing a load/store sequence to be changed to a load outside
3790 the loop, and a copy/store within the loop.
3791
3792 @item -fgcse-sm
3793 @opindex fgcse-sm
3794 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3795 subexpression elimination.  This pass will attempt to move stores out of loops.
3796 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3797 can be changed to a load before the loop and a store after the loop.
3798
3799 @item -floop-optimize
3800 @opindex floop-optimize
3801 Perform loop optimizations: move constant expressions out of loops, simplify
3802 exit test conditions and optionally do strength-reduction and loop unrolling as
3803 well.
3804
3805 @item -fcrossjumping
3806 @opindex crossjumping
3807 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3808 resulting code may or may not perform better than without cross-jumping.
3809
3810 @item -fif-conversion
3811 @opindex if-conversion
3812 Attempt to transform conditional jumps into branch-less equivalents.  This
3813 include use of conditional moves, min, max, set flags and abs instructions, and
3814 some tricks doable by standard arithmetics.  The use of conditional execution
3815 on chips where it is available is controlled by @code{if-conversion2}.
3816
3817 @item -fif-conversion2
3818 @opindex if-conversion2
3819 Use conditional execution (where available) to transform conditional jumps into
3820 branch-less equivalents.
3821
3822 @item -fdelete-null-pointer-checks
3823 @opindex fdelete-null-pointer-checks
3824 Use global dataflow analysis to identify and eliminate useless checks
3825 for null pointers.  The compiler assumes that dereferencing a null
3826 pointer would have halted the program.  If a pointer is checked after
3827 it has already been dereferenced, it cannot be null.
3828
3829 In some environments, this assumption is not true, and programs can
3830 safely dereference null pointers.  Use
3831 @option{-fno-delete-null-pointer-checks} to disable this optimization
3832 for programs which depend on that behavior.
3833
3834 @item -fexpensive-optimizations
3835 @opindex fexpensive-optimizations
3836 Perform a number of minor optimizations that are relatively expensive.
3837
3838 @item -foptimize-register-move
3839 @itemx -fregmove
3840 @opindex foptimize-register-move
3841 @opindex fregmove
3842 Attempt to reassign register numbers in move instructions and as
3843 operands of other simple instructions in order to maximize the amount of
3844 register tying.  This is especially helpful on machines with two-operand
3845 instructions.  GCC enables this optimization by default with @option{-O2}
3846 or higher.
3847
3848 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3849 optimization.
3850
3851 @item -fdelayed-branch
3852 @opindex fdelayed-branch
3853 If supported for the target machine, attempt to reorder instructions
3854 to exploit instruction slots available after delayed branch
3855 instructions.
3856
3857 @item -fschedule-insns
3858 @opindex fschedule-insns
3859 If supported for the target machine, attempt to reorder instructions to
3860 eliminate execution stalls due to required data being unavailable.  This
3861 helps machines that have slow floating point or memory load instructions
3862 by allowing other instructions to be issued until the result of the load
3863 or floating point instruction is required.
3864
3865 @item -fschedule-insns2
3866 @opindex fschedule-insns2
3867 Similar to @option{-fschedule-insns}, but requests an additional pass of
3868 instruction scheduling after register allocation has been done.  This is
3869 especially useful on machines with a relatively small number of
3870 registers and where memory load instructions take more than one cycle.
3871
3872 @item -fno-sched-interblock
3873 @opindex fno-sched-interblock
3874 Don't schedule instructions across basic blocks.  This is normally
3875 enabled by default when scheduling before register allocation, i.e.@:
3876 with @option{-fschedule-insns} or at @option{-O2} or higher.
3877
3878 @item -fno-sched-spec
3879 @opindex fno-sched-spec
3880 Don't allow speculative motion of non-load instructions.  This is normally
3881 enabled by default when scheduling before register allocation, i.e.@:
3882 with @option{-fschedule-insns} or at @option{-O2} or higher.
3883
3884 @item -fsched-spec-load
3885 @opindex fsched-spec-load
3886 Allow speculative motion of some load instructions.  This only makes
3887 sense when scheduling before register allocation, i.e.@: with
3888 @option{-fschedule-insns} or at @option{-O2} or higher.
3889
3890 @item -fsched-spec-load-dangerous
3891 @opindex fsched-spec-load-dangerous
3892 Allow speculative motion of more load instructions.  This only makes
3893 sense when scheduling before register allocation, i.e.@: with
3894 @option{-fschedule-insns} or at @option{-O2} or higher.
3895
3896 @item -ffunction-sections
3897 @itemx -fdata-sections
3898 @opindex ffunction-sections
3899 @opindex fdata-sections
3900 Place each function or data item into its own section in the output
3901 file if the target supports arbitrary sections.  The name of the
3902 function or the name of the data item determines the section's name
3903 in the output file.
3904
3905 Use these options on systems where the linker can perform optimizations
3906 to improve locality of reference in the instruction space.  HPPA
3907 processors running HP-UX and SPARC processors running Solaris 2 have
3908 linkers with such optimizations.  Other systems using the ELF object format
3909 as well as AIX may have these optimizations in the future.
3910
3911 Only use these options when there are significant benefits from doing
3912 so.  When you specify these options, the assembler and linker will
3913 create larger object and executable files and will also be slower.
3914 You will not be able to use @code{gprof} on all systems if you
3915 specify this option and you may have problems with debugging if
3916 you specify both this option and @option{-g}.
3917
3918 @item -fcaller-saves
3919 @opindex fcaller-saves
3920 Enable values to be allocated in registers that will be clobbered by
3921 function calls, by emitting extra instructions to save and restore the
3922 registers around such calls.  Such allocation is done only when it
3923 seems to result in better code than would otherwise be produced.
3924
3925 This option is always enabled by default on certain machines, usually
3926 those which have no call-preserved registers to use instead.
3927
3928 For all machines, optimization level 2 and higher enables this flag by
3929 default.
3930
3931 @item -ftracer
3932 @opindex ftracer
3933 Perform tail duplication to enlarge superblock size. This transformation
3934 simplifies the control flow of the function allowing other optimizations to do
3935 better job.
3936
3937 @item -funroll-loops
3938 @opindex funroll-loops
3939 Unroll loops whose number of iterations can be determined at compile
3940 time or upon entry to the loop.  @option{-funroll-loops} implies both
3941 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3942 option makes code larger, and may or may not make it run faster.
3943
3944 @item -funroll-all-loops
3945 @opindex funroll-all-loops
3946 Unroll all loops, even if their number of iterations is uncertain when
3947 the loop is entered.  This usually makes programs run more slowly.
3948 @option{-funroll-all-loops} implies the same options as
3949 @option{-funroll-loops},
3950
3951 @item -fprefetch-loop-arrays
3952 @opindex fprefetch-loop-arrays
3953 If supported by the target machine, generate instructions to prefetch
3954 memory to improve the performance of loops that access large arrays.
3955
3956 @item -fmove-all-movables
3957 @opindex fmove-all-movables
3958 Forces all invariant computations in loops to be moved
3959 outside the loop.
3960
3961 @item -freduce-all-givs
3962 @opindex freduce-all-givs
3963 Forces all general-induction variables in loops to be
3964 strength-reduced.
3965
3966 @emph{Note:} When compiling programs written in Fortran,
3967 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3968 by default when you use the optimizer.
3969
3970 These options may generate better or worse code; results are highly
3971 dependent on the structure of loops within the source code.
3972
3973 These two options are intended to be removed someday, once
3974 they have helped determine the efficacy of various
3975 approaches to improving loop optimizations.
3976
3977 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3978 know how use of these options affects
3979 the performance of your production code.
3980 We're very interested in code that runs @emph{slower}
3981 when these options are @emph{enabled}.
3982
3983 @item -fno-peephole
3984 @itemx -fno-peephole2
3985 @opindex fno-peephole
3986 @opindex fno-peephole2
3987 Disable any machine-specific peephole optimizations.  The difference
3988 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3989 are implemented in the compiler; some targets use one, some use the
3990 other, a few use both.
3991
3992 @item -fbranch-probabilities
3993 @opindex fbranch-probabilities
3994 After running a program compiled with @option{-fprofile-arcs}
3995 (@pxref{Debugging Options,, Options for Debugging Your Program or
3996 @command{gcc}}), you can compile it a second time using
3997 @option{-fbranch-probabilities}, to improve optimizations based on
3998 the number of times each branch was taken.  When the program
3999 compiled with @option{-fprofile-arcs} exits it saves arc execution
4000 counts to a file called @file{@var{sourcename}.da} for each source
4001 file  The information in this data file is very dependent on the
4002 structure of the generated code, so you must use the same source code
4003 and the same optimization options for both compilations.
4004
4005 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
4006 note on the first instruction of each basic block, and a
4007 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4008 These can be used to improve optimization.  Currently, they are only
4009 used in one place: in @file{reorg.c}, instead of guessing which path a
4010 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4011 exactly determine which path is taken more often.
4012
4013 @item -fno-guess-branch-probability
4014 @opindex fno-guess-branch-probability
4015 Do not guess branch probabilities using a randomized model.
4016
4017 Sometimes gcc will opt to use a randomized model to guess branch
4018 probabilities, when none are available from either profiling feedback
4019 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4020 different runs of the compiler on the same program may produce different
4021 object code.
4022
4023 In a hard real-time system, people don't want different runs of the
4024 compiler to produce code that has different behavior; minimizing
4025 non-determinism is of paramount import.  This switch allows users to
4026 reduce non-determinism, possibly at the expense of inferior
4027 optimization.
4028
4029 @item -freorder-blocks
4030 @opindex freorder-blocks
4031 Reorder basic blocks in the compiled function in order to reduce number of
4032 taken branches and improve code locality.
4033
4034 @item -freorder-functions
4035 @opindex freorder-functions
4036 Reorder basic blocks in the compiled function in order to reduce number of
4037 taken branches and improve code locality. This is implemented by using special
4038 subsections @code{text.hot} for most frequently executed functions and
4039 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4040 the linker so object file format must support named sections and linker must
4041 place them in a reasonable way.
4042
4043 Also profile feedback must be available in to make this option effective.  See
4044 @option{-fprofile-arcs} for details.
4045
4046 @item -fstrict-aliasing
4047 @opindex fstrict-aliasing
4048 Allows the compiler to assume the strictest aliasing rules applicable to
4049 the language being compiled.  For C (and C++), this activates
4050 optimizations based on the type of expressions.  In particular, an
4051 object of one type is assumed never to reside at the same address as an
4052 object of a different type, unless the types are almost the same.  For
4053 example, an @code{unsigned int} can alias an @code{int}, but not a
4054 @code{void*} or a @code{double}.  A character type may alias any other
4055 type.
4056
4057 Pay special attention to code like this:
4058 @example
4059 union a_union @{
4060   int i;
4061   double d;
4062 @};
4063
4064 int f() @{
4065   a_union t;
4066   t.d = 3.0;
4067   return t.i;
4068 @}
4069 @end example
4070 The practice of reading from a different union member than the one most
4071 recently written to (called ``type-punning'') is common.  Even with
4072 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4073 is accessed through the union type.  So, the code above will work as
4074 expected.  However, this code might not:
4075 @example
4076 int f() @{
4077   a_union t;
4078   int* ip;
4079   t.d = 3.0;
4080   ip = &t.i;
4081   return *ip;
4082 @}
4083 @end example
4084
4085 Every language that wishes to perform language-specific alias analysis
4086 should define a function that computes, given an @code{tree}
4087 node, an alias set for the node.  Nodes in different alias sets are not
4088 allowed to alias.  For an example, see the C front-end function
4089 @code{c_get_alias_set}.
4090
4091 For all machines, optimization level 2 and higher enables this flag by
4092 default.
4093
4094 @item -falign-functions
4095 @itemx -falign-functions=@var{n}
4096 @opindex falign-functions
4097 Align the start of functions to the next power-of-two greater than
4098 @var{n}, skipping up to @var{n} bytes.  For instance,
4099 @option{-falign-functions=32} aligns functions to the next 32-byte
4100 boundary, but @option{-falign-functions=24} would align to the next
4101 32-byte boundary only if this can be done by skipping 23 bytes or less.
4102
4103 @option{-fno-align-functions} and @option{-falign-functions=1} are
4104 equivalent and mean that functions will not be aligned.
4105
4106 Some assemblers only support this flag when @var{n} is a power of two;
4107 in that case, it is rounded up.
4108
4109 If @var{n} is not specified, use a machine-dependent default.
4110
4111 @item -falign-labels
4112 @itemx -falign-labels=@var{n}
4113 @opindex falign-labels
4114 Align all branch targets to a power-of-two boundary, skipping up to
4115 @var{n} bytes like @option{-falign-functions}.  This option can easily
4116 make code slower, because it must insert dummy operations for when the
4117 branch target is reached in the usual flow of the code.
4118
4119 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4120 are greater than this value, then their values are used instead.
4121
4122 If @var{n} is not specified, use a machine-dependent default which is
4123 very likely to be @samp{1}, meaning no alignment.
4124
4125 @item -falign-loops
4126 @itemx -falign-loops=@var{n}
4127 @opindex falign-loops
4128 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4129 like @option{-falign-functions}.  The hope is that the loop will be
4130 executed many times, which will make up for any execution of the dummy
4131 operations.
4132
4133 If @var{n} is not specified, use a machine-dependent default.
4134
4135 @item -falign-jumps
4136 @itemx -falign-jumps=@var{n}
4137 @opindex falign-jumps
4138 Align branch targets to a power-of-two boundary, for branch targets
4139 where the targets can only be reached by jumping, skipping up to @var{n}
4140 bytes like @option{-falign-functions}.  In this case, no dummy operations
4141 need be executed.
4142
4143 If @var{n} is not specified, use a machine-dependent default.
4144
4145 @item -fssa
4146 @opindex fssa
4147 Perform optimizations in static single assignment form.  Each function's
4148 flow graph is translated into SSA form, optimizations are performed, and
4149 the flow graph is translated back from SSA form.  Users should not
4150 specify this option, since it is not yet ready for production use.
4151
4152 @item -fssa-ccp
4153 @opindex fssa-ccp
4154 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4155 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4156
4157 @item -fssa-dce
4158 @opindex fssa-dce
4159 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4160 Like @option{-fssa}, this is an experimental feature.
4161
4162 @item -fsingle-precision-constant
4163 @opindex fsingle-precision-constant
4164 Treat floating point constant as single precision constant instead of
4165 implicitly converting it to double precision constant.
4166
4167 @item -frename-registers
4168 @opindex frename-registers
4169 Attempt to avoid false dependencies in scheduled code by making use
4170 of registers left over after register allocation.  This optimization
4171 will most benefit processors with lots of registers.  It can, however,
4172 make debugging impossible, since variables will no longer stay in
4173 a ``home register''.
4174
4175 @item -fno-cprop-registers
4176 @opindex fno-cprop-registers
4177 After register allocation and post-register allocation instruction splitting,
4178 we perform a copy-propagation pass to try to reduce scheduling dependencies
4179 and occasionally eliminate the copy.
4180
4181 @item --param @var{name}=@var{value}
4182 @opindex param
4183 In some places, GCC uses various constants to control the amount of
4184 optimization that is done.  For example, GCC will not inline functions
4185 that contain more that a certain number of instructions.  You can
4186 control some of these constants on the command-line using the
4187 @option{--param} option.
4188
4189 In each case, the @var{value} is an integer.  The allowable choices for
4190 @var{name} are given in the following table:
4191
4192 @table @gcctabopt
4193 @item max-delay-slot-insn-search
4194 The maximum number of instructions to consider when looking for an
4195 instruction to fill a delay slot.  If more than this arbitrary number of
4196 instructions is searched, the time savings from filling the delay slot
4197 will be minimal so stop searching.  Increasing values mean more
4198 aggressive optimization, making the compile time increase with probably
4199 small improvement in executable run time.
4200
4201 @item max-delay-slot-live-search
4202 When trying to fill delay slots, the maximum number of instructions to
4203 consider when searching for a block with valid live register
4204 information.  Increasing this arbitrarily chosen value means more
4205 aggressive optimization, increasing the compile time.  This parameter
4206 should be removed when the delay slot code is rewritten to maintain the
4207 control-flow graph.
4208
4209 @item max-gcse-memory
4210 The approximate maximum amount of memory that will be allocated in
4211 order to perform the global common subexpression elimination
4212 optimization.  If more memory than specified is required, the
4213 optimization will not be done.
4214
4215 @item max-gcse-passes
4216 The maximum number of passes of GCSE to run.
4217
4218 @item max-pending-list-length
4219 The maximum number of pending dependencies scheduling will allow
4220 before flushing the current state and starting over.  Large functions
4221 with few branches or calls can create excessively large lists which
4222 needlessly consume memory and resources.
4223
4224 @item max-inline-insns
4225 If an function contains more than this many instructions, it
4226 will not be inlined.  This option is precisely equivalent to
4227 @option{-finline-limit}.
4228
4229 @item max-unrolled-insns
4230 The maximum number of instructions that a loop should have if that loop
4231 is unrolled, and if the loop is unrolled, it determines how many times
4232 the loop code is unrolled.
4233
4234 @item hot-bb-count-fraction
4235 Select fraction of the maximal count of repetitions of basic block in program
4236 given basic block needs to have to be considered hot.
4237
4238 @item hot-bb-frequency-fraction
4239 Select fraction of the maximal frequency of executions of basic block in
4240 function given basic block needs to have to be considered hot
4241
4242 @item tracer-dynamic-coverage
4243 @itemx tracer-dynamic-coverage-feedback
4244
4245 This value is used to limit superblock formation once the given percentage of
4246 executed instructions is covered.  This limits unnecessary code size
4247 expansion.
4248
4249 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4250 feedback is available.  The real profiles (as opposed to statically estimated
4251 ones) are much less balanced allowing the threshold to be larger value.
4252
4253 @item tracer-max-code-growth
4254 Stop tail duplication once code growth has reached given percentage.  This is
4255 rather hokey argument, as most of the duplicates will be eliminated later in
4256 cross jumping, so it may be set to much higher values than is the desired code
4257 growth.
4258
4259 @item tracer-min-branch-ratio
4260
4261 Stop reverse growth when the reverse probability of best edge is less than this
4262 threshold (in percent).
4263
4264 @item tracer-min-branch-ratio
4265 @itemx tracer-min-branch-ratio-feedback
4266
4267 Stop forward growth if the best edge do have probability lower than this
4268 threshold.
4269
4270 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4271 compilation for profile feedback and one for compilation without.  The value
4272 for compilation with profile feedback needs to be more conservative (higher) in
4273 order to make tracer effective.
4274
4275 @item ggc-min-expand
4276
4277 GCC uses a garbage collector to manage its own memory allocation.  This
4278 parameter specifies the minimum percentage by which the garbage
4279 collector's heap should be allowed to expand between collections.
4280 Tuning this may improve compilation speed; it has no effect on code
4281 generation.
4282
4283 The default is 30%.  Setting this parameter and
4284 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4285 every opportunity.  This is extremely slow, but can be useful for
4286 debugging.
4287
4288 @item ggc-min-heapsize
4289
4290 Minimum size of the garbage collector's heap before it begins bothering
4291 to collect garbage.  The first collection occurs after the heap expands
4292 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4293 tuning this may improve compilation speed, and has no effect on code
4294 generation.
4295
4296 The default is 4096 (four megabytes).  Setting this parameter very large
4297 effectively disables garbage collection.  Setting this parameter and
4298 @option{ggc-min-expand} to zero causes a full collection to occur at
4299 every opportunity.  
4300
4301 @end table
4302 @end table
4303
4304 @node Preprocessor Options
4305 @section Options Controlling the Preprocessor
4306 @cindex preprocessor options
4307 @cindex options, preprocessor
4308
4309 These options control the C preprocessor, which is run on each C source
4310 file before actual compilation.
4311
4312 If you use the @option{-E} option, nothing is done except preprocessing.
4313 Some of these options make sense only together with @option{-E} because
4314 they cause the preprocessor output to be unsuitable for actual
4315 compilation.
4316
4317 @table @gcctabopt
4318 @opindex Wp
4319 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4320 and pass @var{option} directly through to the preprocessor.  If
4321 @var{option} contains commas, it is split into multiple options at the
4322 commas.  However, many options are modified, translated or interpreted
4323 by the compiler driver before being passed to the preprocessor, and
4324 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4325 interface is undocumented and subject to change, so whenever possible
4326 you should avoid using @option{-Wp} and let the driver handle the
4327 options instead.
4328
4329 @item -Xpreprocessor @var{option}
4330 @opindex preprocessor
4331 Pass @var{option} as an option to the preprocessor.  You can use this to
4332 supply system-specific preprocessor options which GCC does not know how to
4333 recognize.
4334
4335 If you want to pass an option that takes an argument, you must use
4336 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4337 @end table
4338
4339 @include cppopts.texi
4340
4341 @node Assembler Options
4342 @section Passing Options to the Assembler
4343
4344 @c prevent bad page break with this line
4345 You can pass options to the assembler.
4346
4347 @table @gcctabopt
4348 @item -Wa,@var{option}
4349 @opindex Wa
4350 Pass @var{option} as an option to the assembler.  If @var{option}
4351 contains commas, it is split into multiple options at the commas.
4352
4353 @item -Xassembler @var{option}
4354 @opindex Xassembler
4355 Pass @var{option} as an option to the assembler.  You can use this to
4356 supply system-specific assembler options which GCC does not know how to
4357 recognize.
4358
4359 If you want to pass an option that takes an argument, you must use
4360 @option{-Xassembler} twice, once for the option and once for the argument.
4361
4362 @end table
4363
4364 @node Link Options
4365 @section Options for Linking
4366 @cindex link options
4367 @cindex options, linking
4368
4369 These options come into play when the compiler links object files into
4370 an executable output file.  They are meaningless if the compiler is
4371 not doing a link step.
4372
4373 @table @gcctabopt
4374 @cindex file names
4375 @item @var{object-file-name}
4376 A file name that does not end in a special recognized suffix is
4377 considered to name an object file or library.  (Object files are
4378 distinguished from libraries by the linker according to the file
4379 contents.)  If linking is done, these object files are used as input
4380 to the linker.
4381
4382 @item -c
4383 @itemx -S
4384 @itemx -E
4385 @opindex c
4386 @opindex S
4387 @opindex E
4388 If any of these options is used, then the linker is not run, and
4389 object file names should not be used as arguments.  @xref{Overall
4390 Options}.
4391
4392 @cindex Libraries
4393 @item -l@var{library}
4394 @itemx -l @var{library}
4395 @opindex l
4396 Search the library named @var{library} when linking.  (The second
4397 alternative with the library as a separate argument is only for
4398 POSIX compliance and is not recommended.)
4399
4400 It makes a difference where in the command you write this option; the
4401 linker searches and processes libraries and object files in the order they
4402 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4403 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4404 to functions in @samp{z}, those functions may not be loaded.
4405
4406 The linker searches a standard list of directories for the library,
4407 which is actually a file named @file{lib@var{library}.a}.  The linker
4408 then uses this file as if it had been specified precisely by name.
4409
4410 The directories searched include several standard system directories
4411 plus any that you specify with @option{-L}.
4412
4413 Normally the files found this way are library files---archive files
4414 whose members are object files.  The linker handles an archive file by
4415 scanning through it for members which define symbols that have so far
4416 been referenced but not defined.  But if the file that is found is an
4417 ordinary object file, it is linked in the usual fashion.  The only
4418 difference between using an @option{-l} option and specifying a file name
4419 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4420 and searches several directories.
4421
4422 @item -lobjc
4423 @opindex lobjc
4424 You need this special case of the @option{-l} option in order to
4425 link an Objective-C program.
4426
4427 @item -nostartfiles
4428 @opindex nostartfiles
4429 Do not use the standard system startup files when linking.
4430 The standard system libraries are used normally, unless @option{-nostdlib}
4431 or @option{-nodefaultlibs} is used.
4432
4433 @item -nodefaultlibs
4434 @opindex nodefaultlibs
4435 Do not use the standard system libraries when linking.
4436 Only the libraries you specify will be passed to the linker.
4437 The standard startup files are used normally, unless @option{-nostartfiles}
4438 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4439 for System V (and ISO C) environments or to bcopy and bzero for
4440 BSD environments.  These entries are usually resolved by entries in
4441 libc.  These entry points should be supplied through some other
4442 mechanism when this option is specified.
4443
4444 @item -nostdlib
4445 @opindex nostdlib
4446 Do not use the standard system startup files or libraries when linking.
4447 No startup files and only the libraries you specify will be passed to
4448 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4449 for System V (and ISO C) environments or to bcopy and bzero for
4450 BSD environments.  These entries are usually resolved by entries in
4451 libc.  These entry points should be supplied through some other
4452 mechanism when this option is specified.
4453
4454 @cindex @option{-lgcc}, use with @option{-nostdlib}
4455 @cindex @option{-nostdlib} and unresolved references
4456 @cindex unresolved references and @option{-nostdlib}
4457 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4458 @cindex @option{-nodefaultlibs} and unresolved references
4459 @cindex unresolved references and @option{-nodefaultlibs}
4460 One of the standard libraries bypassed by @option{-nostdlib} and
4461 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4462 that GCC uses to overcome shortcomings of particular machines, or special
4463 needs for some languages.
4464 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4465 Collection (GCC) Internals},
4466 for more discussion of @file{libgcc.a}.)
4467 In most cases, you need @file{libgcc.a} even when you want to avoid
4468 other standard libraries.  In other words, when you specify @option{-nostdlib}
4469 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4470 This ensures that you have no unresolved references to internal GCC
4471 library subroutines.  (For example, @samp{__main}, used to ensure C++
4472 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4473 GNU Compiler Collection (GCC) Internals}.)
4474
4475 @item -s
4476 @opindex s
4477 Remove all symbol table and relocation information from the executable.
4478
4479 @item -static
4480 @opindex static
4481 On systems that support dynamic linking, this prevents linking with the shared
4482 libraries.  On other systems, this option has no effect.
4483
4484 @item -shared
4485 @opindex shared
4486 Produce a shared object which can then be linked with other objects to
4487 form an executable.  Not all systems support this option.  For predictable
4488 results, you must also specify the same set of options that were used to
4489 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4490 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4491 needs to build supplementary stub code for constructors to work.  On
4492 multi-libbed systems, @samp{gcc -shared} must select the correct support
4493 libraries to link against.  Failing to supply the correct flags may lead
4494 to subtle defects.  Supplying them in cases where they are not necessary
4495 is innocuous.}
4496
4497 @item -shared-libgcc
4498 @itemx -static-libgcc
4499 @opindex shared-libgcc
4500 @opindex static-libgcc
4501 On systems that provide @file{libgcc} as a shared library, these options
4502 force the use of either the shared or static version respectively.
4503 If no shared version of @file{libgcc} was built when the compiler was
4504 configured, these options have no effect.
4505
4506 There are several situations in which an application should use the
4507 shared @file{libgcc} instead of the static version.  The most common
4508 of these is when the application wishes to throw and catch exceptions
4509 across different shared libraries.  In that case, each of the libraries
4510 as well as the application itself should use the shared @file{libgcc}.
4511
4512 Therefore, the G++ and GCJ drivers automatically add
4513 @option{-shared-libgcc} whenever you build a shared library or a main
4514 executable, because C++ and Java programs typically use exceptions, so
4515 this is the right thing to do.
4516
4517 If, instead, you use the GCC driver to create shared libraries, you may
4518 find that they will not always be linked with the shared @file{libgcc}.
4519 If GCC finds, at its configuration time, that you have a GNU linker that
4520 does not support option @option{--eh-frame-hdr}, it will link the shared
4521 version of @file{libgcc} into shared libraries by default.  Otherwise,
4522 it will take advantage of the linker and optimize away the linking with
4523 the shared version of @file{libgcc}, linking with the static version of
4524 libgcc by default.  This allows exceptions to propagate through such
4525 shared libraries, without incurring relocation costs at library load
4526 time.
4527
4528 However, if a library or main executable is supposed to throw or catch
4529 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4530 for the languages used in the program, or using the option
4531 @option{-shared-libgcc}, such that it is linked with the shared
4532 @file{libgcc}.
4533
4534 @item -symbolic
4535 @opindex symbolic
4536 Bind references to global symbols when building a shared object.  Warn
4537 about any unresolved references (unless overridden by the link editor
4538 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4539 this option.
4540
4541 @item -Xlinker @var{option}
4542 @opindex Xlinker
4543 Pass @var{option} as an option to the linker.  You can use this to
4544 supply system-specific linker options which GCC does not know how to
4545 recognize.
4546
4547 If you want to pass an option that takes an argument, you must use
4548 @option{-Xlinker} twice, once for the option and once for the argument.
4549 For example, to pass @option{-assert definitions}, you must write
4550 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4551 @option{-Xlinker "-assert definitions"}, because this passes the entire
4552 string as a single argument, which is not what the linker expects.
4553
4554 @item -Wl,@var{option}
4555 @opindex Wl
4556 Pass @var{option} as an option to the linker.  If @var{option} contains
4557 commas, it is split into multiple options at the commas.
4558
4559 @item -u @var{symbol}
4560 @opindex u
4561 Pretend the symbol @var{symbol} is undefined, to force linking of
4562 library modules to define it.  You can use @option{-u} multiple times with
4563 different symbols to force loading of additional library modules.
4564 @end table
4565
4566 @node Directory Options
4567 @section Options for Directory Search
4568 @cindex directory options
4569 @cindex options, directory search
4570 @cindex search path
4571
4572 These options specify directories to search for header files, for
4573 libraries and for parts of the compiler:
4574
4575 @table @gcctabopt
4576 @item -I@var{dir}
4577 @opindex I
4578 Add the directory @var{dir} to the head of the list of directories to be
4579 searched for header files.  This can be used to override a system header
4580 file, substituting your own version, since these directories are
4581 searched before the system header file directories.  However, you should
4582 not use this option to add directories that contain vendor-supplied
4583 system header files (use @option{-isystem} for that).  If you use more than
4584 one @option{-I} option, the directories are scanned in left-to-right
4585 order; the standard system directories come after.
4586
4587 If a standard system include directory, or a directory specified with
4588 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4589 option will be ignored.  The directory will still be searched but as a
4590 system directory at its normal position in the system include chain.
4591 This is to ensure that GCC's procedure to fix buggy system headers and
4592 the ordering for the include_next directive are not inadvertently changed.
4593 If you really need to change the search order for system directories,
4594 use the @option{-nostdinc} and/or @option{-isystem} options.
4595
4596 @item -I-
4597 @opindex I-
4598 Any directories you specify with @option{-I} options before the @option{-I-}
4599 option are searched only for the case of @samp{#include "@var{file}"};
4600 they are not searched for @samp{#include <@var{file}>}.
4601
4602 If additional directories are specified with @option{-I} options after
4603 the @option{-I-}, these directories are searched for all @samp{#include}
4604 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4605 this way.)
4606
4607 In addition, the @option{-I-} option inhibits the use of the current
4608 directory (where the current input file came from) as the first search
4609 directory for @samp{#include "@var{file}"}.  There is no way to
4610 override this effect of @option{-I-}.  With @option{-I.} you can specify
4611 searching the directory which was current when the compiler was
4612 invoked.  That is not exactly the same as what the preprocessor does
4613 by default, but it is often satisfactory.
4614
4615 @option{-I-} does not inhibit the use of the standard system directories
4616 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4617 independent.
4618
4619 @item -L@var{dir}
4620 @opindex L
4621 Add directory @var{dir} to the list of directories to be searched
4622 for @option{-l}.
4623
4624 @item -B@var{prefix}
4625 @opindex B
4626 This option specifies where to find the executables, libraries,
4627 include files, and data files of the compiler itself.
4628
4629 The compiler driver program runs one or more of the subprograms
4630 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4631 @var{prefix} as a prefix for each program it tries to run, both with and
4632 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4633
4634 For each subprogram to be run, the compiler driver first tries the
4635 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4636 was not specified, the driver tries two standard prefixes, which are
4637 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4638 those results in a file name that is found, the unmodified program
4639 name is searched for using the directories specified in your
4640 @env{PATH} environment variable.
4641
4642 The compiler will check to see if the path provided by the @option{-B}
4643 refers to a directory, and if necessary it will add a directory
4644 separator character at the end of the path.
4645
4646 @option{-B} prefixes that effectively specify directory names also apply
4647 to libraries in the linker, because the compiler translates these
4648 options into @option{-L} options for the linker.  They also apply to
4649 includes files in the preprocessor, because the compiler translates these
4650 options into @option{-isystem} options for the preprocessor.  In this case,
4651 the compiler appends @samp{include} to the prefix.
4652
4653 The run-time support file @file{libgcc.a} can also be searched for using
4654 the @option{-B} prefix, if needed.  If it is not found there, the two
4655 standard prefixes above are tried, and that is all.  The file is left
4656 out of the link if it is not found by those means.
4657
4658 Another way to specify a prefix much like the @option{-B} prefix is to use
4659 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4660 Variables}.
4661
4662 As a special kludge, if the path provided by @option{-B} is
4663 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4664 9, then it will be replaced by @file{[dir/]include}.  This is to help
4665 with boot-strapping the compiler.
4666
4667 @item -specs=@var{file}
4668 @opindex specs
4669 Process @var{file} after the compiler reads in the standard @file{specs}
4670 file, in order to override the defaults that the @file{gcc} driver
4671 program uses when determining what switches to pass to @file{cc1},
4672 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4673 @option{-specs=@var{file}} can be specified on the command line, and they
4674 are processed in order, from left to right.
4675 @end table
4676
4677 @c man end
4678
4679 @node Spec Files
4680 @section Specifying subprocesses and the switches to pass to them
4681 @cindex Spec Files
4682 @command{gcc} is a driver program.  It performs its job by invoking a
4683 sequence of other programs to do the work of compiling, assembling and
4684 linking.  GCC interprets its command-line parameters and uses these to
4685 deduce which programs it should invoke, and which command-line options
4686 it ought to place on their command lines.  This behavior is controlled
4687 by @dfn{spec strings}.  In most cases there is one spec string for each
4688 program that GCC can invoke, but a few programs have multiple spec
4689 strings to control their behavior.  The spec strings built into GCC can
4690 be overridden by using the @option{-specs=} command-line switch to specify
4691 a spec file.
4692
4693 @dfn{Spec files} are plaintext files that are used to construct spec
4694 strings.  They consist of a sequence of directives separated by blank
4695 lines.  The type of directive is determined by the first non-whitespace
4696 character on the line and it can be one of the following:
4697
4698 @table @code
4699 @item %@var{command}
4700 Issues a @var{command} to the spec file processor.  The commands that can
4701 appear here are:
4702
4703 @table @code
4704 @item %include <@var{file}>
4705 @cindex %include
4706 Search for @var{file} and insert its text at the current point in the
4707 specs file.
4708
4709 @item %include_noerr <@var{file}>
4710 @cindex %include_noerr
4711 Just like @samp{%include}, but do not generate an error message if the include
4712 file cannot be found.
4713
4714 @item %rename @var{old_name} @var{new_name}
4715 @cindex %rename
4716 Rename the spec string @var{old_name} to @var{new_name}.
4717
4718 @end table
4719
4720 @item *[@var{spec_name}]:
4721 This tells the compiler to create, override or delete the named spec
4722 string.  All lines after this directive up to the next directive or
4723 blank line are considered to be the text for the spec string.  If this
4724 results in an empty string then the spec will be deleted.  (Or, if the
4725 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4726 does not currently exist a new spec will be created.  If the spec does
4727 exist then its contents will be overridden by the text of this
4728 directive, unless the first character of that text is the @samp{+}
4729 character, in which case the text will be appended to the spec.
4730
4731 @item [@var{suffix}]:
4732 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4733 and up to the next directive or blank line are considered to make up the
4734 spec string for the indicated suffix.  When the compiler encounters an
4735 input file with the named suffix, it will processes the spec string in
4736 order to work out how to compile that file.  For example:
4737
4738 @smallexample
4739 .ZZ:
4740 z-compile -input %i
4741 @end smallexample
4742
4743 This says that any input file whose name ends in @samp{.ZZ} should be
4744 passed to the program @samp{z-compile}, which should be invoked with the
4745 command-line switch @option{-input} and with the result of performing the
4746 @samp{%i} substitution.  (See below.)
4747
4748 As an alternative to providing a spec string, the text that follows a
4749 suffix directive can be one of the following:
4750
4751 @table @code
4752 @item @@@var{language}
4753 This says that the suffix is an alias for a known @var{language}.  This is
4754 similar to using the @option{-x} command-line switch to GCC to specify a
4755 language explicitly.  For example:
4756
4757 @smallexample
4758 .ZZ:
4759 @@c++
4760 @end smallexample
4761
4762 Says that .ZZ files are, in fact, C++ source files.
4763
4764 @item #@var{name}
4765 This causes an error messages saying:
4766
4767 @smallexample
4768 @var{name} compiler not installed on this system.
4769 @end smallexample
4770 @end table
4771
4772 GCC already has an extensive list of suffixes built into it.
4773 This directive will add an entry to the end of the list of suffixes, but
4774 since the list is searched from the end backwards, it is effectively
4775 possible to override earlier entries using this technique.
4776
4777 @end table
4778
4779 GCC has the following spec strings built into it.  Spec files can
4780 override these strings or create their own.  Note that individual
4781 targets can also add their own spec strings to this list.
4782
4783 @smallexample
4784 asm          Options to pass to the assembler
4785 asm_final    Options to pass to the assembler post-processor
4786 cpp          Options to pass to the C preprocessor
4787 cc1          Options to pass to the C compiler
4788 cc1plus      Options to pass to the C++ compiler
4789 endfile      Object files to include at the end of the link
4790 link         Options to pass to the linker
4791 lib          Libraries to include on the command line to the linker
4792 libgcc       Decides which GCC support library to pass to the linker
4793 linker       Sets the name of the linker
4794 predefines   Defines to be passed to the C preprocessor
4795 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4796              by default
4797 startfile    Object files to include at the start of the link
4798 @end smallexample
4799
4800 Here is a small example of a spec file:
4801
4802 @smallexample
4803 %rename lib                 old_lib
4804
4805 *lib:
4806 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4807 @end smallexample
4808
4809 This example renames the spec called @samp{lib} to @samp{old_lib} and
4810 then overrides the previous definition of @samp{lib} with a new one.
4811 The new definition adds in some extra command-line options before
4812 including the text of the old definition.
4813
4814 @dfn{Spec strings} are a list of command-line options to be passed to their
4815 corresponding program.  In addition, the spec strings can contain
4816 @samp{%}-prefixed sequences to substitute variable text or to
4817 conditionally insert text into the command line.  Using these constructs
4818 it is possible to generate quite complex command lines.
4819
4820 Here is a table of all defined @samp{%}-sequences for spec
4821 strings.  Note that spaces are not generated automatically around the
4822 results of expanding these sequences.  Therefore you can concatenate them
4823 together or combine them with constant text in a single argument.
4824
4825 @table @code
4826 @item %%
4827 Substitute one @samp{%} into the program name or argument.
4828
4829 @item %i
4830 Substitute the name of the input file being processed.
4831
4832 @item %b
4833 Substitute the basename of the input file being processed.
4834 This is the substring up to (and not including) the last period
4835 and not including the directory.
4836
4837 @item %B
4838 This is the same as @samp{%b}, but include the file suffix (text after
4839 the last period).
4840
4841 @item %d
4842 Marks the argument containing or following the @samp{%d} as a
4843 temporary file name, so that that file will be deleted if GCC exits
4844 successfully.  Unlike @samp{%g}, this contributes no text to the
4845 argument.
4846
4847 @item %g@var{suffix}
4848 Substitute a file name that has suffix @var{suffix} and is chosen
4849 once per compilation, and mark the argument in the same way as
4850 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4851 name is now chosen in a way that is hard to predict even when previously
4852 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4853 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4854 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4855 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4856 was simply substituted with a file name chosen once per compilation,
4857 without regard to any appended suffix (which was therefore treated
4858 just like ordinary text), making such attacks more likely to succeed.
4859
4860 @item %u@var{suffix}
4861 Like @samp{%g}, but generates a new temporary file name even if
4862 @samp{%u@var{suffix}} was already seen.
4863
4864 @item %U@var{suffix}
4865 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4866 new one if there is no such last file name.  In the absence of any
4867 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4868 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4869 would involve the generation of two distinct file names, one
4870 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4871 simply substituted with a file name chosen for the previous @samp{%u},
4872 without regard to any appended suffix.
4873
4874 @item %j@var{suffix}
4875 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4876 writable, and if save-temps is off; otherwise, substitute the name
4877 of a temporary file, just like @samp{%u}.  This temporary file is not
4878 meant for communication between processes, but rather as a junk
4879 disposal mechanism.
4880
4881 @item %|@var{suffix}
4882 @itemx %m@var{suffix}
4883 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
4884 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
4885 all.  These are the two most common ways to instruct a program that it
4886 should read from standard input or write to standard output.  If you
4887 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
4888 construct: see for example @file{f/lang-specs.h}.
4889
4890 @item %.@var{SUFFIX}
4891 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4892 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4893 terminated by the next space or %.
4894
4895 @item %w
4896 Marks the argument containing or following the @samp{%w} as the
4897 designated output file of this compilation.  This puts the argument
4898 into the sequence of arguments that @samp{%o} will substitute later.
4899
4900 @item %o
4901 Substitutes the names of all the output files, with spaces
4902 automatically placed around them.  You should write spaces
4903 around the @samp{%o} as well or the results are undefined.
4904 @samp{%o} is for use in the specs for running the linker.
4905 Input files whose names have no recognized suffix are not compiled
4906 at all, but they are included among the output files, so they will
4907 be linked.
4908
4909 @item %O
4910 Substitutes the suffix for object files.  Note that this is
4911 handled specially when it immediately follows @samp{%g, %u, or %U},
4912 because of the need for those to form complete file names.  The
4913 handling is such that @samp{%O} is treated exactly as if it had already
4914 been substituted, except that @samp{%g, %u, and %U} do not currently
4915 support additional @var{suffix} characters following @samp{%O} as they would
4916 following, for example, @samp{.o}.
4917
4918 @item %p
4919 Substitutes the standard macro predefinitions for the
4920 current target machine.  Use this when running @code{cpp}.
4921
4922 @item %P
4923 Like @samp{%p}, but puts @samp{__} before and after the name of each
4924 predefined macro, except for macros that start with @samp{__} or with
4925 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4926 C@.
4927
4928 @item %I
4929 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4930
4931 @item %s
4932 Current argument is the name of a library or startup file of some sort.
4933 Search for that file in a standard list of directories and substitute
4934 the full name found.
4935
4936 @item %e@var{str}
4937 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4938 Use this when inconsistent options are detected.
4939
4940 @item %(@var{name})
4941 Substitute the contents of spec string @var{name} at this point.
4942
4943 @item %[@var{name}]
4944 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4945
4946 @item %x@{@var{option}@}
4947 Accumulate an option for @samp{%X}.
4948
4949 @item %X
4950 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4951 spec string.
4952
4953 @item %Y
4954 Output the accumulated assembler options specified by @option{-Wa}.
4955
4956 @item %Z
4957 Output the accumulated preprocessor options specified by @option{-Wp}.
4958
4959 @item %v1
4960 Substitute the major version number of GCC@.
4961 (For version 2.9.5, this is 2.)
4962
4963 @item %v2
4964 Substitute the minor version number of GCC@.
4965 (For version 2.9.5, this is 9.)
4966
4967 @item %v3
4968 Substitute the patch level number of GCC@.
4969 (For version 2.9.5, this is 5.)
4970
4971 @item %a
4972 Process the @code{asm} spec.  This is used to compute the
4973 switches to be passed to the assembler.
4974
4975 @item %A
4976 Process the @code{asm_final} spec.  This is a spec string for
4977 passing switches to an assembler post-processor, if such a program is
4978 needed.
4979
4980 @item %l
4981 Process the @code{link} spec.  This is the spec for computing the
4982 command line passed to the linker.  Typically it will make use of the
4983 @samp{%L %G %S %D and %E} sequences.
4984
4985 @item %D
4986 Dump out a @option{-L} option for each directory that GCC believes might
4987 contain startup files.  If the target supports multilibs then the
4988 current multilib directory will be prepended to each of these paths.
4989
4990 @item %M
4991 Output the multilib directory with directory separators replaced with
4992 @samp{_}.  If multilib directories are not set, or the multilib directory is
4993 @file{.} then this option emits nothing.
4994
4995 @item %L
4996 Process the @code{lib} spec.  This is a spec string for deciding which
4997 libraries should be included on the command line to the linker.
4998
4999 @item %G
5000 Process the @code{libgcc} spec.  This is a spec string for deciding
5001 which GCC support library should be included on the command line to the linker.
5002
5003 @item %S
5004 Process the @code{startfile} spec.  This is a spec for deciding which
5005 object files should be the first ones passed to the linker.  Typically
5006 this might be a file named @file{crt0.o}.
5007
5008 @item %E
5009 Process the @code{endfile} spec.  This is a spec string that specifies
5010 the last object files that will be passed to the linker.
5011
5012 @item %C
5013 Process the @code{cpp} spec.  This is used to construct the arguments
5014 to be passed to the C preprocessor.
5015
5016 @item %c
5017 Process the @code{signed_char} spec.  This is intended to be used
5018 to tell cpp whether a char is signed.  It typically has the definition:
5019 @smallexample
5020 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5021 @end smallexample
5022
5023 @item %1
5024 Process the @code{cc1} spec.  This is used to construct the options to be
5025 passed to the actual C compiler (@samp{cc1}).
5026
5027 @item %2
5028 Process the @code{cc1plus} spec.  This is used to construct the options to be
5029 passed to the actual C++ compiler (@samp{cc1plus}).
5030
5031 @item %*
5032 Substitute the variable part of a matched option.  See below.
5033 Note that each comma in the substituted string is replaced by
5034 a single space.
5035
5036 @item %<@code{S}
5037 Remove all occurrences of @code{-S} from the command line.  Note---this
5038 command is position dependent.  @samp{%} commands in the spec string
5039 before this one will see @code{-S}, @samp{%} commands in the spec string
5040 after this one will not.
5041
5042 @item %:@var{function}(@var{args})
5043 Call the named function @var{function}, passing it @var{args}.
5044 @var{args} is first processed as a nested spec string, then split
5045 into an argument vector in the usual fashion.  The function returns
5046 a string which is processed as if it had appeared literally as part
5047 of the current spec.
5048
5049 The following built-in spec functions are provided:
5050
5051 @table @code
5052 @item @code{if-exists}
5053 The @code{if-exists} spec function takes one argument, an absolute
5054 pathname to a file.  If the file exists, @code{if-exists} returns the
5055 pathname.  Here is a small example of its usage:
5056
5057 @smallexample
5058 *startfile:
5059 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5060 @end smallexample
5061
5062 @item @code{if-exists-else}
5063 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5064 spec function, except that it takes two arguments.  The first argument is
5065 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5066 returns the pathname.  If it does not exist, it returns the second argument.
5067 This way, @code{if-exists-else} can be used to select one file or another,
5068 based on the existence of the first.  Here is a small example of its usage:
5069
5070 @smallexample 
5071 *startfile:
5072 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5073 @end smallexample
5074 @end table 
5075
5076 @item %@{@code{S}@}
5077 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5078 If that switch was not specified, this substitutes nothing.  Note that
5079 the leading dash is omitted when specifying this option, and it is
5080 automatically inserted if the substitution is performed.  Thus the spec
5081 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5082 and would output the command line option @option{-foo}.
5083
5084 @item %W@{@code{S}@}
5085 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5086 deleted on failure.
5087
5088 @item %@{@code{S}*@}
5089 Substitutes all the switches specified to GCC whose names start
5090 with @code{-S}, but which also take an argument.  This is used for
5091 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5092 GCC considers @option{-o foo} as being
5093 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5094 text, including the space.  Thus two arguments would be generated.
5095
5096 @item %@{@code{S}*&@code{T}*@}
5097 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5098 (the order of @code{S} and @code{T} in the spec is not significant).
5099 There can be any number of ampersand-separated variables; for each the
5100 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5101
5102 @item %@{@code{S}:@code{X}@}
5103 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5104
5105 @item %@{!@code{S}:@code{X}@}
5106 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5107
5108 @item %@{@code{S}*:@code{X}@}
5109 Substitutes @code{X} if one or more switches whose names start with
5110 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5111 once, no matter how many such switches appeared.  However, if @code{%*}
5112 appears somewhere in @code{X}, then @code{X} will be substituted once
5113 for each matching switch, with the @code{%*} replaced by the part of
5114 that switch that matched the @code{*}.
5115
5116 @item %@{.@code{S}:@code{X}@}
5117 Substitutes @code{X}, if processing a file with suffix @code{S}.
5118
5119 @item %@{!.@code{S}:@code{X}@}
5120 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5121
5122 @item %@{@code{S}|@code{P}:@code{X}@}
5123 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5124 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5125 although they have a stronger binding than the @samp{|}.  If @code{%*}
5126 appears in @code{X}, all of the alternatives must be starred, and only
5127 the first matching alternative is substituted.
5128
5129 For example, a spec string like this:
5130
5131 @smallexample
5132 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5133 @end smallexample
5134
5135 will output the following command-line options from the following input
5136 command-line options:
5137
5138 @smallexample
5139 fred.c        -foo -baz
5140 jim.d         -bar -boggle
5141 -d fred.c     -foo -baz -boggle
5142 -d jim.d      -bar -baz -boggle
5143 @end smallexample
5144
5145 @item %@{S:X; T:Y; :D@}
5146
5147 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5148 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5149 be as many clauses as you need.  This may be combined with @code{.}, 
5150 @code{!}, @code{|}, and @code{*} as needed.
5151
5152
5153 @end table
5154
5155 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5156 construct may contain other nested @samp{%} constructs or spaces, or
5157 even newlines.  They are processed as usual, as described above.
5158 Trailing white space in @code{X} is ignored.  White space may also
5159 appear anywhere on the left side of the colon in these constructs,
5160 except between @code{.} or @code{*} and the corresponding word.
5161
5162 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5163 handled specifically in these constructs.  If another value of
5164 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5165 @option{-W} switch is found later in the command line, the earlier
5166 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5167 just one letter, which passes all matching options.
5168
5169 The character @samp{|} at the beginning of the predicate text is used to
5170 indicate that a command should be piped to the following command, but
5171 only if @option{-pipe} is specified.
5172
5173 It is built into GCC which switches take arguments and which do not.
5174 (You might think it would be useful to generalize this to allow each
5175 compiler's spec to say which switches take arguments.  But this cannot
5176 be done in a consistent fashion.  GCC cannot even decide which input
5177 files have been specified without knowing which switches take arguments,
5178 and it must know which input files to compile in order to tell which
5179 compilers to run).
5180
5181 GCC also knows implicitly that arguments starting in @option{-l} are to be
5182 treated as compiler output files, and passed to the linker in their
5183 proper position among the other output files.
5184
5185 @c man begin OPTIONS
5186
5187 @node Target Options
5188 @section Specifying Target Machine and Compiler Version
5189 @cindex target options
5190 @cindex cross compiling
5191 @cindex specifying machine version
5192 @cindex specifying compiler version and target machine
5193 @cindex compiler version, specifying
5194 @cindex target machine, specifying
5195
5196 The usual way to run GCC is to run the executable called @file{gcc}, or
5197 @file{<machine>-gcc} when cross-compiling, or
5198 @file{<machine>-gcc-<version>} to run a version other than the one that
5199 was installed last.  Sometimes this is inconvenient, so GCC provides
5200 options that will switch to another cross-compiler or version.
5201
5202 @table @gcctabopt
5203 @item -b @var{machine}
5204 @opindex b
5205 The argument @var{machine} specifies the target machine for compilation.
5206
5207 The value to use for @var{machine} is the same as was specified as the
5208 machine type when configuring GCC as a cross-compiler.  For
5209 example, if a cross-compiler was configured with @samp{configure
5210 i386v}, meaning to compile for an 80386 running System V, then you
5211 would specify @option{-b i386v} to run that cross compiler.
5212
5213 @item -V @var{version}
5214 @opindex V
5215 The argument @var{version} specifies which version of GCC to run.
5216 This is useful when multiple versions are installed.  For example,
5217 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5218 @end table
5219
5220 The @option{-V} and @option{-b} options work by running the
5221 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5222 use them if you can just run that directly.
5223
5224 @node Submodel Options
5225 @section Hardware Models and Configurations
5226 @cindex submodel options
5227 @cindex specifying hardware config
5228 @cindex hardware models and configurations, specifying
5229 @cindex machine dependent options
5230
5231 Earlier we discussed the standard option @option{-b} which chooses among
5232 different installed compilers for completely different target
5233 machines, such as VAX vs.@: 68000 vs.@: 80386.
5234
5235 In addition, each of these target machine types can have its own
5236 special options, starting with @samp{-m}, to choose among various
5237 hardware models or configurations---for example, 68010 vs 68020,
5238 floating coprocessor or none.  A single installed version of the
5239 compiler can compile for any model or configuration, according to the
5240 options specified.
5241
5242 Some configurations of the compiler also support additional special
5243 options, usually for compatibility with other compilers on the same
5244 platform.
5245
5246 These options are defined by the macro @code{TARGET_SWITCHES} in the
5247 machine description.  The default for the options is also defined by
5248 that macro, which enables you to change the defaults.
5249
5250 @menu
5251 * M680x0 Options::
5252 * M68hc1x Options::
5253 * VAX Options::
5254 * SPARC Options::
5255 * Convex Options::
5256 * AMD29K Options::
5257 * ARM Options::
5258 * MN10200 Options::
5259 * MN10300 Options::
5260 * M32R/D Options::
5261 * M88K Options::
5262 * RS/6000 and PowerPC Options::
5263 * Darwin Options::
5264 * RT Options::
5265 * MIPS Options::
5266 * i386 and x86-64 Options::
5267 * HPPA Options::
5268 * Intel 960 Options::
5269 * DEC Alpha Options::
5270 * DEC Alpha/VMS Options::
5271 * Clipper Options::
5272 * H8/300 Options::
5273 * SH Options::
5274 * System V Options::
5275 * TMS320C3x/C4x Options::
5276 * V850 Options::
5277 * ARC Options::
5278 * NS32K Options::
5279 * AVR Options::
5280 * MCore Options::
5281 * IA-64 Options::
5282 * D30V Options::
5283 * S/390 and zSeries Options::
5284 * CRIS Options::
5285 * MMIX Options::
5286 * PDP-11 Options::
5287 * Xstormy16 Options::
5288 * Xtensa Options::
5289 * FRV Options::
5290 @end menu
5291
5292 @node M680x0 Options
5293 @subsection M680x0 Options
5294 @cindex M680x0 options
5295
5296 These are the @samp{-m} options defined for the 68000 series.  The default
5297 values for these options depends on which style of 68000 was selected when
5298 the compiler was configured; the defaults for the most common choices are
5299 given below.
5300
5301 @table @gcctabopt
5302 @item -m68000
5303 @itemx -mc68000
5304 @opindex m68000
5305 @opindex mc68000
5306 Generate output for a 68000.  This is the default
5307 when the compiler is configured for 68000-based systems.
5308
5309 Use this option for microcontrollers with a 68000 or EC000 core,
5310 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5311
5312 @item -m68020
5313 @itemx -mc68020
5314 @opindex m68020
5315 @opindex mc68020
5316 Generate output for a 68020.  This is the default
5317 when the compiler is configured for 68020-based systems.
5318
5319 @item -m68881
5320 @opindex m68881
5321 Generate output containing 68881 instructions for floating point.
5322 This is the default for most 68020 systems unless @option{--nfp} was
5323 specified when the compiler was configured.
5324
5325 @item -m68030
5326 @opindex m68030
5327 Generate output for a 68030.  This is the default when the compiler is
5328 configured for 68030-based systems.
5329
5330 @item -m68040
5331 @opindex m68040
5332 Generate output for a 68040.  This is the default when the compiler is
5333 configured for 68040-based systems.
5334
5335 This option inhibits the use of 68881/68882 instructions that have to be
5336 emulated by software on the 68040.  Use this option if your 68040 does not
5337 have code to emulate those instructions.
5338
5339 @item -m68060
5340 @opindex m68060
5341 Generate output for a 68060.  This is the default when the compiler is
5342 configured for 68060-based systems.
5343
5344 This option inhibits the use of 68020 and 68881/68882 instructions that
5345 have to be emulated by software on the 68060.  Use this option if your 68060
5346 does not have code to emulate those instructions.
5347
5348 @item -mcpu32
5349 @opindex mcpu32
5350 Generate output for a CPU32.  This is the default
5351 when the compiler is configured for CPU32-based systems.
5352
5353 Use this option for microcontrollers with a
5354 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5355 68336, 68340, 68341, 68349 and 68360.
5356
5357 @item -m5200
5358 @opindex m5200
5359 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5360 when the compiler is configured for 520X-based systems.
5361
5362 Use this option for microcontroller with a 5200 core, including
5363 the MCF5202, MCF5203, MCF5204 and MCF5202.
5364
5365
5366 @item -m68020-40
5367 @opindex m68020-40
5368 Generate output for a 68040, without using any of the new instructions.
5369 This results in code which can run relatively efficiently on either a
5370 68020/68881 or a 68030 or a 68040.  The generated code does use the
5371 68881 instructions that are emulated on the 68040.
5372
5373 @item -m68020-60
5374 @opindex m68020-60
5375 Generate output for a 68060, without using any of the new instructions.
5376 This results in code which can run relatively efficiently on either a
5377 68020/68881 or a 68030 or a 68040.  The generated code does use the
5378 68881 instructions that are emulated on the 68060.
5379
5380 @item -mfpa
5381 @opindex mfpa
5382 Generate output containing Sun FPA instructions for floating point.
5383
5384 @item -msoft-float
5385 @opindex msoft-float
5386 Generate output containing library calls for floating point.
5387 @strong{Warning:} the requisite libraries are not available for all m68k
5388 targets.  Normally the facilities of the machine's usual C compiler are
5389 used, but this can't be done directly in cross-compilation.  You must
5390 make your own arrangements to provide suitable library functions for
5391 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5392 @samp{m68k-*-coff} do provide software floating point support.
5393
5394 @item -mshort
5395 @opindex mshort
5396 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5397
5398 @item -mnobitfield
5399 @opindex mnobitfield
5400 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5401 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5402
5403 @item -mbitfield
5404 @opindex mbitfield
5405 Do use the bit-field instructions.  The @option{-m68020} option implies
5406 @option{-mbitfield}.  This is the default if you use a configuration
5407 designed for a 68020.
5408
5409 @item -mrtd
5410 @opindex mrtd
5411 Use a different function-calling convention, in which functions
5412 that take a fixed number of arguments return with the @code{rtd}
5413 instruction, which pops their arguments while returning.  This
5414 saves one instruction in the caller since there is no need to pop
5415 the arguments there.
5416
5417 This calling convention is incompatible with the one normally
5418 used on Unix, so you cannot use it if you need to call libraries
5419 compiled with the Unix compiler.
5420
5421 Also, you must provide function prototypes for all functions that
5422 take variable numbers of arguments (including @code{printf});
5423 otherwise incorrect code will be generated for calls to those
5424 functions.
5425
5426 In addition, seriously incorrect code will result if you call a
5427 function with too many arguments.  (Normally, extra arguments are
5428 harmlessly ignored.)
5429
5430 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5431 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5432
5433 @item -malign-int
5434 @itemx -mno-align-int
5435 @opindex malign-int
5436 @opindex mno-align-int
5437 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5438 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5439 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5440 Aligning variables on 32-bit boundaries produces code that runs somewhat
5441 faster on processors with 32-bit busses at the expense of more memory.
5442
5443 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5444 align structures containing the above types  differently than
5445 most published application binary interface specifications for the m68k.
5446
5447 @item -mpcrel
5448 @opindex mpcrel
5449 Use the pc-relative addressing mode of the 68000 directly, instead of
5450 using a global offset table.  At present, this option implies @option{-fpic},
5451 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5452 not presently supported with @option{-mpcrel}, though this could be supported for
5453 68020 and higher processors.
5454
5455 @item -mno-strict-align
5456 @itemx -mstrict-align
5457 @opindex mno-strict-align
5458 @opindex mstrict-align
5459 Do not (do) assume that unaligned memory references will be handled by
5460 the system.
5461
5462 @end table
5463
5464 @node M68hc1x Options
5465 @subsection M68hc1x Options
5466 @cindex M68hc1x options
5467
5468 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5469 microcontrollers.  The default values for these options depends on
5470 which style of microcontroller was selected when the compiler was configured;
5471 the defaults for the most common choices are given below.
5472
5473 @table @gcctabopt
5474 @item -m6811
5475 @itemx -m68hc11
5476 @opindex m6811
5477 @opindex m68hc11
5478 Generate output for a 68HC11.  This is the default
5479 when the compiler is configured for 68HC11-based systems.
5480
5481 @item -m6812
5482 @itemx -m68hc12
5483 @opindex m6812
5484 @opindex m68hc12
5485 Generate output for a 68HC12.  This is the default
5486 when the compiler is configured for 68HC12-based systems.
5487
5488 @item -mauto-incdec
5489 @opindex mauto-incdec
5490 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5491 addressing modes.
5492
5493 @item -minmax
5494 @itemx -nominmax
5495 @opindex minmax
5496 @opindex mnominmax
5497 Enable the use of 68HC12 min and max instructions.
5498
5499 @item -mlong-calls
5500 @itemx -mno-long-calls
5501 @opindex mlong-calls
5502 @opindex mno-long-calls
5503 Treat all calls as being far away (near).  If calls are assumed to be
5504 far away, the compiler will use the @code{call} instruction to
5505 call a function and the @code{rtc} instruction for returning.
5506
5507 @item -mshort
5508 @opindex mshort
5509 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5510
5511 @item -msoft-reg-count=@var{count}
5512 @opindex msoft-reg-count
5513 Specify the number of pseudo-soft registers which are used for the
5514 code generation.  The maximum number is 32.  Using more pseudo-soft
5515 register may or may not result in better code depending on the program.
5516 The default is 4 for 68HC11 and 2 for 68HC12.
5517
5518 @end table
5519
5520 @node VAX Options
5521 @subsection VAX Options
5522 @cindex VAX options
5523
5524 These @samp{-m} options are defined for the VAX:
5525
5526 @table @gcctabopt
5527 @item -munix
5528 @opindex munix
5529 Do not output certain jump instructions (@code{aobleq} and so on)
5530 that the Unix assembler for the VAX cannot handle across long
5531 ranges.
5532
5533 @item -mgnu
5534 @opindex mgnu
5535 Do output those jump instructions, on the assumption that you
5536 will assemble with the GNU assembler.
5537
5538 @item -mg
5539 @opindex mg
5540 Output code for g-format floating point numbers instead of d-format.
5541 @end table
5542
5543 @node SPARC Options
5544 @subsection SPARC Options
5545 @cindex SPARC options
5546
5547 These @samp{-m} switches are supported on the SPARC:
5548
5549 @table @gcctabopt
5550 @item -mno-app-regs
5551 @itemx -mapp-regs
5552 @opindex mno-app-regs
5553 @opindex mapp-regs
5554 Specify @option{-mapp-regs} to generate output using the global registers
5555 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5556 is the default.
5557
5558 To be fully SVR4 ABI compliant at the cost of some performance loss,
5559 specify @option{-mno-app-regs}.  You should compile libraries and system
5560 software with this option.
5561
5562 @item -mfpu
5563 @itemx -mhard-float
5564 @opindex mfpu
5565 @opindex mhard-float
5566 Generate output containing floating point instructions.  This is the
5567 default.
5568
5569 @item -mno-fpu
5570 @itemx -msoft-float
5571 @opindex mno-fpu
5572 @opindex msoft-float
5573 Generate output containing library calls for floating point.
5574 @strong{Warning:} the requisite libraries are not available for all SPARC
5575 targets.  Normally the facilities of the machine's usual C compiler are
5576 used, but this cannot be done directly in cross-compilation.  You must make
5577 your own arrangements to provide suitable library functions for
5578 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5579 @samp{sparclite-*-*} do provide software floating point support.
5580
5581 @option{-msoft-float} changes the calling convention in the output file;
5582 therefore, it is only useful if you compile @emph{all} of a program with
5583 this option.  In particular, you need to compile @file{libgcc.a}, the
5584 library that comes with GCC, with @option{-msoft-float} in order for
5585 this to work.
5586
5587 @item -mhard-quad-float
5588 @opindex mhard-quad-float
5589 Generate output containing quad-word (long double) floating point
5590 instructions.
5591
5592 @item -msoft-quad-float
5593 @opindex msoft-quad-float
5594 Generate output containing library calls for quad-word (long double)
5595 floating point instructions.  The functions called are those specified
5596 in the SPARC ABI@.  This is the default.
5597
5598 As of this writing, there are no sparc implementations that have hardware
5599 support for the quad-word floating point instructions.  They all invoke
5600 a trap handler for one of these instructions, and then the trap handler
5601 emulates the effect of the instruction.  Because of the trap handler overhead,
5602 this is much slower than calling the ABI library routines.  Thus the
5603 @option{-msoft-quad-float} option is the default.
5604
5605 @item -mno-flat
5606 @itemx -mflat
5607 @opindex mno-flat
5608 @opindex mflat
5609 With @option{-mflat}, the compiler does not generate save/restore instructions
5610 and will use a ``flat'' or single register window calling convention.
5611 This model uses %i7 as the frame pointer and is compatible with the normal
5612 register window model.  Code from either may be intermixed.
5613 The local registers and the input registers (0--5) are still treated as
5614 ``call saved'' registers and will be saved on the stack as necessary.
5615
5616 With @option{-mno-flat} (the default), the compiler emits save/restore
5617 instructions (except for leaf functions) and is the normal mode of operation.
5618
5619 @item -mno-unaligned-doubles
5620 @itemx -munaligned-doubles
5621 @opindex mno-unaligned-doubles
5622 @opindex munaligned-doubles
5623 Assume that doubles have 8 byte alignment.  This is the default.
5624
5625 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5626 alignment only if they are contained in another type, or if they have an
5627 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5628 Specifying this option avoids some rare compatibility problems with code
5629 generated by other compilers.  It is not the default because it results
5630 in a performance loss, especially for floating point code.
5631
5632 @item -mno-faster-structs
5633 @itemx -mfaster-structs
5634 @opindex mno-faster-structs
5635 @opindex mfaster-structs
5636 With @option{-mfaster-structs}, the compiler assumes that structures
5637 should have 8 byte alignment.  This enables the use of pairs of
5638 @code{ldd} and @code{std} instructions for copies in structure
5639 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5640 However, the use of this changed alignment directly violates the SPARC
5641 ABI@.  Thus, it's intended only for use on targets where the developer
5642 acknowledges that their resulting code will not be directly in line with
5643 the rules of the ABI@.
5644
5645 @item -mv8
5646 @itemx -msparclite
5647 @opindex mv8
5648 @opindex msparclite
5649 These two options select variations on the SPARC architecture.
5650
5651 By default (unless specifically configured for the Fujitsu SPARClite),
5652 GCC generates code for the v7 variant of the SPARC architecture.
5653
5654 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5655 code is that the compiler emits the integer multiply and integer
5656 divide instructions which exist in SPARC v8 but not in SPARC v7.
5657
5658 @option{-msparclite} will give you SPARClite code.  This adds the integer
5659 multiply, integer divide step and scan (@code{ffs}) instructions which
5660 exist in SPARClite but not in SPARC v7.
5661
5662 These options are deprecated and will be deleted in a future GCC release.
5663 They have been replaced with @option{-mcpu=xxx}.
5664
5665 @item -mcypress
5666 @itemx -msupersparc
5667 @opindex mcypress
5668 @opindex msupersparc
5669 These two options select the processor for which the code is optimized.
5670
5671 With @option{-mcypress} (the default), the compiler optimizes code for the
5672 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5673 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5674
5675 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5676 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5677 of the full SPARC v8 instruction set.
5678
5679 These options are deprecated and will be deleted in a future GCC release.
5680 They have been replaced with @option{-mcpu=xxx}.
5681
5682 @item -mcpu=@var{cpu_type}
5683 @opindex mcpu
5684 Set the instruction set, register set, and instruction scheduling parameters
5685 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5686 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5687 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5688 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5689 @samp{ultrasparc3}.
5690
5691 Default instruction scheduling parameters are used for values that select
5692 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5693 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5694
5695 Here is a list of each supported architecture and their supported
5696 implementations.
5697
5698 @smallexample
5699     v7:             cypress
5700     v8:             supersparc, hypersparc
5701     sparclite:      f930, f934, sparclite86x
5702     sparclet:       tsc701
5703     v9:             ultrasparc, ultrasparc3
5704 @end smallexample
5705
5706 @item -mtune=@var{cpu_type}
5707 @opindex mtune
5708 Set the instruction scheduling parameters for machine type
5709 @var{cpu_type}, but do not set the instruction set or register set that the
5710 option @option{-mcpu=@var{cpu_type}} would.
5711
5712 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5713 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5714 that select a particular cpu implementation.  Those are @samp{cypress},
5715 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5716 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5717 @samp{ultrasparc3}.
5718
5719 @end table
5720
5721 These @samp{-m} switches are supported in addition to the above
5722 on the SPARCLET processor.
5723
5724 @table @gcctabopt
5725 @item -mlittle-endian
5726 @opindex mlittle-endian
5727 Generate code for a processor running in little-endian mode.
5728
5729 @item -mlive-g0
5730 @opindex mlive-g0
5731 Treat register @code{%g0} as a normal register.
5732 GCC will continue to clobber it as necessary but will not assume
5733 it always reads as 0.
5734
5735 @item -mbroken-saverestore
5736 @opindex mbroken-saverestore
5737 Generate code that does not use non-trivial forms of the @code{save} and
5738 @code{restore} instructions.  Early versions of the SPARCLET processor do
5739 not correctly handle @code{save} and @code{restore} instructions used with
5740 arguments.  They correctly handle them used without arguments.  A @code{save}
5741 instruction used without arguments increments the current window pointer
5742 but does not allocate a new stack frame.  It is assumed that the window
5743 overflow trap handler will properly handle this case as will interrupt
5744 handlers.
5745 @end table
5746
5747 These @samp{-m} switches are supported in addition to the above
5748 on SPARC V9 processors in 64-bit environments.
5749
5750 @table @gcctabopt
5751 @item -mlittle-endian
5752 @opindex mlittle-endian
5753 Generate code for a processor running in little-endian mode.
5754
5755 @item -m32
5756 @itemx -m64
5757 @opindex m32
5758 @opindex m64
5759 Generate code for a 32-bit or 64-bit environment.
5760 The 32-bit environment sets int, long and pointer to 32 bits.
5761 The 64-bit environment sets int to 32 bits and long and pointer
5762 to 64 bits.
5763
5764 @item -mcmodel=medlow
5765 @opindex mcmodel=medlow
5766 Generate code for the Medium/Low code model: the program must be linked
5767 in the low 32 bits of the address space.  Pointers are 64 bits.
5768 Programs can be statically or dynamically linked.
5769
5770 @item -mcmodel=medmid
5771 @opindex mcmodel=medmid
5772 Generate code for the Medium/Middle code model: the program must be linked
5773 in the low 44 bits of the address space, the text segment must be less than
5774 2G bytes, and data segment must be within 2G of the text segment.
5775 Pointers are 64 bits.
5776
5777 @item -mcmodel=medany
5778 @opindex mcmodel=medany
5779 Generate code for the Medium/Anywhere code model: the program may be linked
5780 anywhere in the address space, the text segment must be less than
5781 2G bytes, and data segment must be within 2G of the text segment.
5782 Pointers are 64 bits.
5783
5784 @item -mcmodel=embmedany
5785 @opindex mcmodel=embmedany
5786 Generate code for the Medium/Anywhere code model for embedded systems:
5787 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5788 (determined at link time).  Register %g4 points to the base of the
5789 data segment.  Pointers are still 64 bits.
5790 Programs are statically linked, PIC is not supported.
5791
5792 @item -mstack-bias
5793 @itemx -mno-stack-bias
5794 @opindex mstack-bias
5795 @opindex mno-stack-bias
5796 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5797 frame pointer if present, are offset by @minus{}2047 which must be added back
5798 when making stack frame references.
5799 Otherwise, assume no such offset is present.
5800 @end table
5801
5802 @node Convex Options
5803 @subsection Convex Options
5804 @cindex Convex options
5805
5806 These @samp{-m} options are defined for Convex:
5807
5808 @table @gcctabopt
5809 @item -mc1
5810 @opindex mc1
5811 Generate output for C1.  The code will run on any Convex machine.
5812 The preprocessor symbol @code{__convex__c1__} is defined.
5813
5814 @item -mc2
5815 @opindex mc2
5816 Generate output for C2.  Uses instructions not available on C1.
5817 Scheduling and other optimizations are chosen for max performance on C2.
5818 The preprocessor symbol @code{__convex_c2__} is defined.
5819
5820 @item -mc32
5821 @opindex mc32
5822 Generate output for C32xx.  Uses instructions not available on C1.
5823 Scheduling and other optimizations are chosen for max performance on C32.
5824 The preprocessor symbol @code{__convex_c32__} is defined.
5825
5826 @item -mc34
5827 @opindex mc34
5828 Generate output for C34xx.  Uses instructions not available on C1.
5829 Scheduling and other optimizations are chosen for max performance on C34.
5830 The preprocessor symbol @code{__convex_c34__} is defined.
5831
5832 @item -mc38
5833 @opindex mc38
5834 Generate output for C38xx.  Uses instructions not available on C1.
5835 Scheduling and other optimizations are chosen for max performance on C38.
5836 The preprocessor symbol @code{__convex_c38__} is defined.
5837
5838 @item -margcount
5839 @opindex margcount
5840 Generate code which puts an argument count in the word preceding each
5841 argument list.  This is compatible with regular CC, and a few programs
5842 may need the argument count word.  GDB and other source-level debuggers
5843 do not need it; this info is in the symbol table.
5844
5845 @item -mnoargcount
5846 @opindex mnoargcount
5847 Omit the argument count word.  This is the default.
5848
5849 @item -mvolatile-cache
5850 @opindex mvolatile-cache
5851 Allow volatile references to be cached.  This is the default.
5852
5853 @item -mvolatile-nocache
5854 @opindex mvolatile-nocache
5855 Volatile references bypass the data cache, going all the way to memory.
5856 This is only needed for multi-processor code that does not use standard
5857 synchronization instructions.  Making non-volatile references to volatile
5858 locations will not necessarily work.
5859
5860 @item -mlong32
5861 @opindex mlong32
5862 Type long is 32 bits, the same as type int.  This is the default.
5863
5864 @item -mlong64
5865 @opindex mlong64
5866 Type long is 64 bits, the same as type long long.  This option is useless,
5867 because no library support exists for it.
5868 @end table
5869
5870 @node AMD29K Options
5871 @subsection AMD29K Options
5872 @cindex AMD29K options
5873
5874 These @samp{-m} options are defined for the AMD Am29000:
5875
5876 @table @gcctabopt
5877 @item -mdw
5878 @opindex mdw
5879 @cindex DW bit (29k)
5880 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5881 halfword operations are directly supported by the hardware.  This is the
5882 default.
5883
5884 @item -mndw
5885 @opindex mndw
5886 Generate code that assumes the @code{DW} bit is not set.
5887
5888 @item -mbw
5889 @opindex mbw
5890 @cindex byte writes (29k)
5891 Generate code that assumes the system supports byte and halfword write
5892 operations.  This is the default.
5893
5894 @item -mnbw
5895 @opindex mnbw
5896 Generate code that assumes the systems does not support byte and
5897 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5898
5899 @item -msmall
5900 @opindex msmall
5901 @cindex memory model (29k)
5902 Use a small memory model that assumes that all function addresses are
5903 either within a single 256 KB segment or at an absolute address of less
5904 than 256k.  This allows the @code{call} instruction to be used instead
5905 of a @code{const}, @code{consth}, @code{calli} sequence.
5906
5907 @item -mnormal
5908 @opindex mnormal
5909 Use the normal memory model: Generate @code{call} instructions only when
5910 calling functions in the same file and @code{calli} instructions
5911 otherwise.  This works if each file occupies less than 256 KB but allows
5912 the entire executable to be larger than 256 KB@.  This is the default.
5913
5914 @item -mlarge
5915 @opindex mlarge
5916 Always use @code{calli} instructions.  Specify this option if you expect
5917 a single file to compile into more than 256 KB of code.
5918
5919 @item -m29050
5920 @opindex m29050
5921 @cindex processor selection (29k)
5922 Generate code for the Am29050.
5923
5924 @item -m29000
5925 @opindex m29000
5926 Generate code for the Am29000.  This is the default.
5927
5928 @item -mkernel-registers
5929 @opindex mkernel-registers
5930 @cindex kernel and user registers (29k)
5931 Generate references to registers @code{gr64-gr95} instead of to
5932 registers @code{gr96-gr127}.  This option can be used when compiling
5933 kernel code that wants a set of global registers disjoint from that used
5934 by user-mode code.
5935
5936 Note that when this option is used, register names in @samp{-f} flags
5937 must use the normal, user-mode, names.
5938
5939 @item -muser-registers
5940 @opindex muser-registers
5941 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5942 default.
5943
5944 @item -mstack-check
5945 @itemx -mno-stack-check
5946 @opindex mstack-check
5947 @opindex mno-stack-check
5948 @cindex stack checks (29k)
5949 Insert (or do not insert) a call to @code{__msp_check} after each stack
5950 adjustment.  This is often used for kernel code.
5951
5952 @item -mstorem-bug
5953 @itemx -mno-storem-bug
5954 @opindex mstorem-bug
5955 @opindex mno-storem-bug
5956 @cindex storem bug (29k)
5957 @option{-mstorem-bug} handles 29k processors which cannot handle the
5958 separation of a mtsrim insn and a storem instruction (most 29000 chips
5959 to date, but not the 29050).
5960
5961 @item -mno-reuse-arg-regs
5962 @itemx -mreuse-arg-regs
5963 @opindex mno-reuse-arg-regs
5964 @opindex mreuse-arg-regs
5965 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5966 registers for copying out arguments.  This helps detect calling a function
5967 with fewer arguments than it was declared with.
5968
5969 @item -mno-impure-text
5970 @itemx -mimpure-text
5971 @opindex mno-impure-text
5972 @opindex mimpure-text
5973 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5974 not pass @option{-assert pure-text} to the linker when linking a shared object.
5975
5976 @item -msoft-float
5977 @opindex msoft-float
5978 Generate output containing library calls for floating point.
5979 @strong{Warning:} the requisite libraries are not part of GCC@.
5980 Normally the facilities of the machine's usual C compiler are used, but
5981 this can't be done directly in cross-compilation.  You must make your
5982 own arrangements to provide suitable library functions for
5983 cross-compilation.
5984
5985 @item -mno-multm
5986 @opindex mno-multm
5987 Do not generate multm or multmu instructions.  This is useful for some embedded
5988 systems which do not have trap handlers for these instructions.
5989 @end table
5990
5991 @node ARM Options
5992 @subsection ARM Options
5993 @cindex ARM options
5994
5995 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5996 architectures:
5997
5998 @table @gcctabopt
5999 @item -mapcs-frame
6000 @opindex mapcs-frame
6001 Generate a stack frame that is compliant with the ARM Procedure Call
6002 Standard for all functions, even if this is not strictly necessary for
6003 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6004 with this option will cause the stack frames not to be generated for
6005 leaf functions.  The default is @option{-mno-apcs-frame}.
6006
6007 @item -mapcs
6008 @opindex mapcs
6009 This is a synonym for @option{-mapcs-frame}.
6010
6011 @item -mapcs-26
6012 @opindex mapcs-26
6013 Generate code for a processor running with a 26-bit program counter,
6014 and conforming to the function calling standards for the APCS 26-bit
6015 option.  This option replaces the @option{-m2} and @option{-m3} options
6016 of previous releases of the compiler.
6017
6018 @item -mapcs-32
6019 @opindex mapcs-32
6020 Generate code for a processor running with a 32-bit program counter,
6021 and conforming to the function calling standards for the APCS 32-bit
6022 option.  This option replaces the @option{-m6} option of previous releases
6023 of the compiler.
6024
6025 @ignore
6026 @c not currently implemented
6027 @item -mapcs-stack-check
6028 @opindex mapcs-stack-check
6029 Generate code to check the amount of stack space available upon entry to
6030 every function (that actually uses some stack space).  If there is
6031 insufficient space available then either the function
6032 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6033 called, depending upon the amount of stack space required.  The run time
6034 system is required to provide these functions.  The default is
6035 @option{-mno-apcs-stack-check}, since this produces smaller code.
6036
6037 @c not currently implemented
6038 @item -mapcs-float
6039 @opindex mapcs-float
6040 Pass floating point arguments using the float point registers.  This is
6041 one of the variants of the APCS@.  This option is recommended if the
6042 target hardware has a floating point unit or if a lot of floating point
6043 arithmetic is going to be performed by the code.  The default is
6044 @option{-mno-apcs-float}, since integer only code is slightly increased in
6045 size if @option{-mapcs-float} is used.
6046
6047 @c not currently implemented
6048 @item -mapcs-reentrant
6049 @opindex mapcs-reentrant
6050 Generate reentrant, position independent code.  The default is
6051 @option{-mno-apcs-reentrant}.
6052 @end ignore
6053
6054 @item -mthumb-interwork
6055 @opindex mthumb-interwork
6056 Generate code which supports calling between the ARM and Thumb
6057 instruction sets.  Without this option the two instruction sets cannot
6058 be reliably used inside one program.  The default is
6059 @option{-mno-thumb-interwork}, since slightly larger code is generated
6060 when @option{-mthumb-interwork} is specified.
6061
6062 @item -mno-sched-prolog
6063 @opindex mno-sched-prolog
6064 Prevent the reordering of instructions in the function prolog, or the
6065 merging of those instruction with the instructions in the function's
6066 body.  This means that all functions will start with a recognizable set
6067 of instructions (or in fact one of a choice from a small set of
6068 different function prologues), and this information can be used to
6069 locate the start if functions inside an executable piece of code.  The
6070 default is @option{-msched-prolog}.
6071
6072 @item -mhard-float
6073 @opindex mhard-float
6074 Generate output containing floating point instructions.  This is the
6075 default.
6076
6077 @item -msoft-float
6078 @opindex msoft-float
6079 Generate output containing library calls for floating point.
6080 @strong{Warning:} the requisite libraries are not available for all ARM
6081 targets.  Normally the facilities of the machine's usual C compiler are
6082 used, but this cannot be done directly in cross-compilation.  You must make
6083 your own arrangements to provide suitable library functions for
6084 cross-compilation.
6085
6086 @option{-msoft-float} changes the calling convention in the output file;
6087 therefore, it is only useful if you compile @emph{all} of a program with
6088 this option.  In particular, you need to compile @file{libgcc.a}, the
6089 library that comes with GCC, with @option{-msoft-float} in order for
6090 this to work.
6091
6092 @item -mlittle-endian
6093 @opindex mlittle-endian
6094 Generate code for a processor running in little-endian mode.  This is
6095 the default for all standard configurations.
6096
6097 @item -mbig-endian
6098 @opindex mbig-endian
6099 Generate code for a processor running in big-endian mode; the default is
6100 to compile code for a little-endian processor.
6101
6102 @item -mwords-little-endian
6103 @opindex mwords-little-endian
6104 This option only applies when generating code for big-endian processors.
6105 Generate code for a little-endian word order but a big-endian byte
6106 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6107 option should only be used if you require compatibility with code for
6108 big-endian ARM processors generated by versions of the compiler prior to
6109 2.8.
6110
6111 @item -malignment-traps
6112 @opindex malignment-traps
6113 Generate code that will not trap if the MMU has alignment traps enabled.
6114 On ARM architectures prior to ARMv4, there were no instructions to
6115 access half-word objects stored in memory.  However, when reading from
6116 memory a feature of the ARM architecture allows a word load to be used,
6117 even if the address is unaligned, and the processor core will rotate the
6118 data as it is being loaded.  This option tells the compiler that such
6119 misaligned accesses will cause a MMU trap and that it should instead
6120 synthesize the access as a series of byte accesses.  The compiler can
6121 still use word accesses to load half-word data if it knows that the
6122 address is aligned to a word boundary.
6123
6124 This option is ignored when compiling for ARM architecture 4 or later,
6125 since these processors have instructions to directly access half-word
6126 objects in memory.
6127
6128 @item -mno-alignment-traps
6129 @opindex mno-alignment-traps
6130 Generate code that assumes that the MMU will not trap unaligned
6131 accesses.  This produces better code when the target instruction set
6132 does not have half-word memory operations (i.e.@: implementations prior to
6133 ARMv4).
6134
6135 Note that you cannot use this option to access unaligned word objects,
6136 since the processor will only fetch one 32-bit aligned object from
6137 memory.
6138
6139 The default setting for most targets is @option{-mno-alignment-traps}, since
6140 this produces better code when there are no half-word memory
6141 instructions available.
6142
6143 @item -mshort-load-bytes
6144 @itemx -mno-short-load-words
6145 @opindex mshort-load-bytes
6146 @opindex mno-short-load-words
6147 These are deprecated aliases for @option{-malignment-traps}.
6148
6149 @item -mno-short-load-bytes
6150 @itemx -mshort-load-words
6151 @opindex mno-short-load-bytes
6152 @opindex mshort-load-words
6153 This are deprecated aliases for @option{-mno-alignment-traps}.
6154
6155 @item -mbsd
6156 @opindex mbsd
6157 This option only applies to RISC iX@.  Emulate the native BSD-mode
6158 compiler.  This is the default if @option{-ansi} is not specified.
6159
6160 @item -mxopen
6161 @opindex mxopen
6162 This option only applies to RISC iX@.  Emulate the native X/Open-mode
6163 compiler.
6164
6165 @item -mno-symrename
6166 @opindex mno-symrename
6167 This option only applies to RISC iX@.  Do not run the assembler
6168 post-processor, @samp{symrename}, after code has been assembled.
6169 Normally it is necessary to modify some of the standard symbols in
6170 preparation for linking with the RISC iX C library; this option
6171 suppresses this pass.  The post-processor is never run when the
6172 compiler is built for cross-compilation.
6173
6174 @item -mcpu=@var{name}
6175 @opindex mcpu
6176 This specifies the name of the target ARM processor.  GCC uses this name
6177 to determine what kind of instructions it can emit when generating
6178 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6179 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6180 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6181 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6182 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6183 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6184 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6185 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6186 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6187 @samp{arm1020t}, @samp{xscale}.
6188
6189 @itemx -mtune=@var{name}
6190 @opindex mtune
6191 This option is very similar to the @option{-mcpu=} option, except that
6192 instead of specifying the actual target processor type, and hence
6193 restricting which instructions can be used, it specifies that GCC should
6194 tune the performance of the code as if the target were of the type
6195 specified in this option, but still choosing the instructions that it
6196 will generate based on the cpu specified by a @option{-mcpu=} option.
6197 For some ARM implementations better performance can be obtained by using
6198 this option.
6199
6200 @item -march=@var{name}
6201 @opindex march
6202 This specifies the name of the target ARM architecture.  GCC uses this
6203 name to determine what kind of instructions it can emit when generating
6204 assembly code.  This option can be used in conjunction with or instead
6205 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6206 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6207 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
6208
6209 @item -mfpe=@var{number}
6210 @itemx -mfp=@var{number}
6211 @opindex mfpe
6212 @opindex mfp
6213 This specifies the version of the floating point emulation available on
6214 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6215 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6216
6217 @item -mstructure-size-boundary=@var{n}
6218 @opindex mstructure-size-boundary
6219 The size of all structures and unions will be rounded up to a multiple
6220 of the number of bits set by this option.  Permissible values are 8 and
6221 32.  The default value varies for different toolchains.  For the COFF
6222 targeted toolchain the default value is 8.  Specifying the larger number
6223 can produce faster, more efficient code, but can also increase the size
6224 of the program.  The two values are potentially incompatible.  Code
6225 compiled with one value cannot necessarily expect to work with code or
6226 libraries compiled with the other value, if they exchange information
6227 using structures or unions.
6228
6229 @item -mabort-on-noreturn
6230 @opindex mabort-on-noreturn
6231 Generate a call to the function @code{abort} at the end of a
6232 @code{noreturn} function.  It will be executed if the function tries to
6233 return.
6234
6235 @item -mlong-calls
6236 @itemx -mno-long-calls
6237 @opindex mlong-calls
6238 @opindex mno-long-calls
6239 Tells the compiler to perform function calls by first loading the
6240 address of the function into a register and then performing a subroutine
6241 call on this register.  This switch is needed if the target function
6242 will lie outside of the 64 megabyte addressing range of the offset based
6243 version of subroutine call instruction.
6244
6245 Even if this switch is enabled, not all function calls will be turned
6246 into long calls.  The heuristic is that static functions, functions
6247 which have the @samp{short-call} attribute, functions that are inside
6248 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6249 definitions have already been compiled within the current compilation
6250 unit, will not be turned into long calls.  The exception to this rule is
6251 that weak function definitions, functions with the @samp{long-call}
6252 attribute or the @samp{section} attribute, and functions that are within
6253 the scope of a @samp{#pragma long_calls} directive, will always be
6254 turned into long calls.
6255
6256 This feature is not enabled by default.  Specifying
6257 @option{-mno-long-calls} will restore the default behavior, as will
6258 placing the function calls within the scope of a @samp{#pragma
6259 long_calls_off} directive.  Note these switches have no effect on how
6260 the compiler generates code to handle function calls via function
6261 pointers.
6262
6263 @item -mnop-fun-dllimport
6264 @opindex mnop-fun-dllimport
6265 Disable support for the @code{dllimport} attribute.
6266
6267 @item -msingle-pic-base
6268 @opindex msingle-pic-base
6269 Treat the register used for PIC addressing as read-only, rather than
6270 loading it in the prologue for each function.  The run-time system is
6271 responsible for initializing this register with an appropriate value
6272 before execution begins.
6273
6274 @item -mpic-register=@var{reg}
6275 @opindex mpic-register
6276 Specify the register to be used for PIC addressing.  The default is R10
6277 unless stack-checking is enabled, when R9 is used.
6278
6279 @item -mpoke-function-name
6280 @opindex mpoke-function-name
6281 Write the name of each function into the text section, directly
6282 preceding the function prologue.  The generated code is similar to this:
6283
6284 @smallexample
6285      t0
6286          .ascii "arm_poke_function_name", 0
6287          .align
6288      t1
6289          .word 0xff000000 + (t1 - t0)
6290      arm_poke_function_name
6291          mov     ip, sp
6292          stmfd   sp!, @{fp, ip, lr, pc@}
6293          sub     fp, ip, #4
6294 @end smallexample
6295
6296 When performing a stack backtrace, code can inspect the value of
6297 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6298 location @code{pc - 12} and the top 8 bits are set, then we know that
6299 there is a function name embedded immediately preceding this location
6300 and has length @code{((pc[-3]) & 0xff000000)}.
6301
6302 @item -mthumb
6303 @opindex mthumb
6304 Generate code for the 16-bit Thumb instruction set.  The default is to
6305 use the 32-bit ARM instruction set.
6306
6307 @item -mtpcs-frame
6308 @opindex mtpcs-frame
6309 Generate a stack frame that is compliant with the Thumb Procedure Call
6310 Standard for all non-leaf functions.  (A leaf function is one that does
6311 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6312
6313 @item -mtpcs-leaf-frame
6314 @opindex mtpcs-leaf-frame
6315 Generate a stack frame that is compliant with the Thumb Procedure Call
6316 Standard for all leaf functions.  (A leaf function is one that does
6317 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6318
6319 @item -mcallee-super-interworking
6320 @opindex mcallee-super-interworking
6321 Gives all externally visible functions in the file being compiled an ARM
6322 instruction set header which switches to Thumb mode before executing the
6323 rest of the function.  This allows these functions to be called from
6324 non-interworking code.
6325
6326 @item -mcaller-super-interworking
6327 @opindex mcaller-super-interworking
6328 Allows calls via function pointers (including virtual functions) to
6329 execute correctly regardless of whether the target code has been
6330 compiled for interworking or not.  There is a small overhead in the cost
6331 of executing a function pointer if this option is enabled.
6332
6333 @end table
6334
6335 @node MN10200 Options
6336 @subsection MN10200 Options
6337 @cindex MN10200 options
6338 These @option{-m} options are defined for Matsushita MN10200 architectures:
6339 @table @gcctabopt
6340
6341 @item -mrelax
6342 @opindex mrelax
6343 Indicate to the linker that it should perform a relaxation optimization pass
6344 to shorten branches, calls and absolute memory addresses.  This option only
6345 has an effect when used on the command line for the final link step.
6346
6347 This option makes symbolic debugging impossible.
6348 @end table
6349
6350 @node MN10300 Options
6351 @subsection MN10300 Options
6352 @cindex MN10300 options
6353 These @option{-m} options are defined for Matsushita MN10300 architectures:
6354
6355 @table @gcctabopt
6356 @item -mmult-bug
6357 @opindex mmult-bug
6358 Generate code to avoid bugs in the multiply instructions for the MN10300
6359 processors.  This is the default.
6360
6361 @item -mno-mult-bug
6362 @opindex mno-mult-bug
6363 Do not generate code to avoid bugs in the multiply instructions for the
6364 MN10300 processors.
6365
6366 @item -mam33
6367 @opindex mam33
6368 Generate code which uses features specific to the AM33 processor.
6369
6370 @item -mno-am33
6371 @opindex mno-am33
6372 Do not generate code which uses features specific to the AM33 processor.  This
6373 is the default.
6374
6375 @item -mno-crt0
6376 @opindex mno-crt0
6377 Do not link in the C run-time initialization object file.
6378
6379 @item -mrelax
6380 @opindex mrelax
6381 Indicate to the linker that it should perform a relaxation optimization pass
6382 to shorten branches, calls and absolute memory addresses.  This option only
6383 has an effect when used on the command line for the final link step.
6384
6385 This option makes symbolic debugging impossible.
6386 @end table
6387
6388
6389 @node M32R/D Options
6390 @subsection M32R/D Options
6391 @cindex M32R/D options
6392
6393 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6394
6395 @table @gcctabopt
6396 @item -m32rx
6397 @opindex m32rx
6398 Generate code for the M32R/X@.
6399
6400 @item -m32r
6401 @opindex m32r
6402 Generate code for the M32R@.  This is the default.
6403
6404 @item -mcode-model=small
6405 @opindex mcode-model=small
6406 Assume all objects live in the lower 16MB of memory (so that their addresses
6407 can be loaded with the @code{ld24} instruction), and assume all subroutines
6408 are reachable with the @code{bl} instruction.
6409 This is the default.
6410
6411 The addressability of a particular object can be set with the
6412 @code{model} attribute.
6413
6414 @item -mcode-model=medium
6415 @opindex mcode-model=medium
6416 Assume objects may be anywhere in the 32-bit address space (the compiler
6417 will generate @code{seth/add3} instructions to load their addresses), and
6418 assume all subroutines are reachable with the @code{bl} instruction.
6419
6420 @item -mcode-model=large
6421 @opindex mcode-model=large
6422 Assume objects may be anywhere in the 32-bit address space (the compiler
6423 will generate @code{seth/add3} instructions to load their addresses), and
6424 assume subroutines may not be reachable with the @code{bl} instruction
6425 (the compiler will generate the much slower @code{seth/add3/jl}
6426 instruction sequence).
6427
6428 @item -msdata=none
6429 @opindex msdata=none
6430 Disable use of the small data area.  Variables will be put into
6431 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6432 @code{section} attribute has been specified).
6433 This is the default.
6434
6435 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6436 Objects may be explicitly put in the small data area with the
6437 @code{section} attribute using one of these sections.
6438
6439 @item -msdata=sdata
6440 @opindex msdata=sdata
6441 Put small global and static data in the small data area, but do not
6442 generate special code to reference them.
6443
6444 @item -msdata=use
6445 @opindex msdata=use
6446 Put small global and static data in the small data area, and generate
6447 special instructions to reference them.
6448
6449 @item -G @var{num}
6450 @opindex G
6451 @cindex smaller data references
6452 Put global and static objects less than or equal to @var{num} bytes
6453 into the small data or bss sections instead of the normal data or bss
6454 sections.  The default value of @var{num} is 8.
6455 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6456 for this option to have any effect.
6457
6458 All modules should be compiled with the same @option{-G @var{num}} value.
6459 Compiling with different values of @var{num} may or may not work; if it
6460 doesn't the linker will give an error message---incorrect code will not be
6461 generated.
6462
6463 @end table
6464
6465 @node M88K Options
6466 @subsection M88K Options
6467 @cindex M88k options
6468
6469 These @samp{-m} options are defined for Motorola 88k architectures:
6470
6471 @table @gcctabopt
6472 @item -m88000
6473 @opindex m88000
6474 Generate code that works well on both the m88100 and the
6475 m88110.
6476
6477 @item -m88100
6478 @opindex m88100
6479 Generate code that works best for the m88100, but that also
6480 runs on the m88110.
6481
6482 @item -m88110
6483 @opindex m88110
6484 Generate code that works best for the m88110, and may not run
6485 on the m88100.
6486
6487 @item -mbig-pic
6488 @opindex mbig-pic
6489 Obsolete option to be removed from the next revision.
6490 Use @option{-fPIC}.
6491
6492 @item -midentify-revision
6493 @opindex midentify-revision
6494 @cindex identifying source, compiler (88k)
6495 Include an @code{ident} directive in the assembler output recording the
6496 source file name, compiler name and version, timestamp, and compilation
6497 flags used.
6498
6499 @item -mno-underscores
6500 @opindex mno-underscores
6501 @cindex underscores, avoiding (88k)
6502 In assembler output, emit symbol names without adding an underscore
6503 character at the beginning of each name.  The default is to use an
6504 underscore as prefix on each name.
6505
6506 @item -mocs-debug-info
6507 @itemx -mno-ocs-debug-info
6508 @opindex mocs-debug-info
6509 @opindex mno-ocs-debug-info
6510 @cindex OCS (88k)
6511 @cindex debugging, 88k OCS
6512 Include (or omit) additional debugging information (about registers used
6513 in each stack frame) as specified in the 88open Object Compatibility
6514 Standard, ``OCS''@.  This extra information allows debugging of code that
6515 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6516 Delta 88 SVr3.2 is to include this information; other 88k configurations
6517 omit this information by default.
6518
6519 @item -mocs-frame-position
6520 @opindex mocs-frame-position
6521 @cindex register positions in frame (88k)
6522 When emitting COFF debugging information for automatic variables and
6523 parameters stored on the stack, use the offset from the canonical frame
6524 address, which is the stack pointer (register 31) on entry to the
6525 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6526 @option{-mocs-frame-position}; other 88k configurations have the default
6527 @option{-mno-ocs-frame-position}.
6528
6529 @item -mno-ocs-frame-position
6530 @opindex mno-ocs-frame-position
6531 @cindex register positions in frame (88k)
6532 When emitting COFF debugging information for automatic variables and
6533 parameters stored on the stack, use the offset from the frame pointer
6534 register (register 30).  When this option is in effect, the frame
6535 pointer is not eliminated when debugging information is selected by the
6536 -g switch.
6537
6538 @item -moptimize-arg-area
6539 @opindex moptimize-arg-area
6540 @cindex arguments in frame (88k)
6541 Save space by reorganizing the stack frame.  This option generates code
6542 that does not agree with the 88open specifications, but uses less
6543 memory.
6544
6545 @itemx -mno-optimize-arg-area
6546 @opindex mno-optimize-arg-area
6547 Do not reorganize the stack frame to save space.  This is the default.
6548 The generated conforms to the specification, but uses more memory.
6549
6550 @item -mshort-data-@var{num}
6551 @opindex mshort-data
6552 @cindex smaller data references (88k)
6553 @cindex r0-relative references (88k)
6554 Generate smaller data references by making them relative to @code{r0},
6555 which allows loading a value using a single instruction (rather than the
6556 usual two).  You control which data references are affected by
6557 specifying @var{num} with this option.  For example, if you specify
6558 @option{-mshort-data-512}, then the data references affected are those
6559 involving displacements of less than 512 bytes.
6560 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6561 than 64k.
6562
6563 @item -mserialize-volatile
6564 @opindex mserialize-volatile
6565 @itemx -mno-serialize-volatile
6566 @opindex mno-serialize-volatile
6567 @cindex sequential consistency on 88k
6568 Do, or don't, generate code to guarantee sequential consistency
6569 of volatile memory references.  By default, consistency is
6570 guaranteed.
6571
6572 The order of memory references made by the MC88110 processor does
6573 not always match the order of the instructions requesting those
6574 references.  In particular, a load instruction may execute before
6575 a preceding store instruction.  Such reordering violates
6576 sequential consistency of volatile memory references, when there
6577 are multiple processors.   When consistency must be guaranteed,
6578 GCC generates special instructions, as needed, to force
6579 execution in the proper order.
6580
6581 The MC88100 processor does not reorder memory references and so
6582 always provides sequential consistency.  However, by default, GCC
6583 generates the special instructions to guarantee consistency
6584 even when you use @option{-m88100}, so that the code may be run on an
6585 MC88110 processor.  If you intend to run your code only on the
6586 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6587
6588 The extra code generated to guarantee consistency may affect the
6589 performance of your application.  If you know that you can safely
6590 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6591
6592 @item -msvr4
6593 @itemx -msvr3
6594 @opindex msvr4
6595 @opindex msvr3
6596 @cindex assembler syntax, 88k
6597 @cindex SVr4
6598 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6599 related to System V release 4 (SVr4).  This controls the following:
6600
6601 @enumerate
6602 @item
6603 Which variant of the assembler syntax to emit.
6604 @item
6605 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6606 that is used on System V release 4.
6607 @item
6608 @option{-msvr4} makes GCC issue additional declaration directives used in
6609 SVr4.
6610 @end enumerate
6611
6612 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6613 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6614 other m88k configurations.
6615
6616 @item -mversion-03.00
6617 @opindex mversion-03.00
6618 This option is obsolete, and is ignored.
6619 @c ??? which asm syntax better for GAS?  option there too?
6620
6621 @item -mno-check-zero-division
6622 @itemx -mcheck-zero-division
6623 @opindex mno-check-zero-division
6624 @opindex mcheck-zero-division
6625 @cindex zero division on 88k
6626 Do, or don't, generate code to guarantee that integer division by
6627 zero will be detected.  By default, detection is guaranteed.
6628
6629 Some models of the MC88100 processor fail to trap upon integer
6630 division by zero under certain conditions.  By default, when
6631 compiling code that might be run on such a processor, GCC
6632 generates code that explicitly checks for zero-valued divisors
6633 and traps with exception number 503 when one is detected.  Use of
6634 @option{-mno-check-zero-division} suppresses such checking for code
6635 generated to run on an MC88100 processor.
6636
6637 GCC assumes that the MC88110 processor correctly detects all instances
6638 of integer division by zero.  When @option{-m88110} is specified, no
6639 explicit checks for zero-valued divisors are generated, and both
6640 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6641 ignored.
6642
6643 @item -muse-div-instruction
6644 @opindex muse-div-instruction
6645 @cindex divide instruction, 88k
6646 Use the div instruction for signed integer division on the
6647 MC88100 processor.  By default, the div instruction is not used.
6648
6649 On the MC88100 processor the signed integer division instruction
6650 div) traps to the operating system on a negative operand.  The
6651 operating system transparently completes the operation, but at a
6652 large cost in execution time.  By default, when compiling code
6653 that might be run on an MC88100 processor, GCC emulates signed
6654 integer division using the unsigned integer division instruction
6655 divu), thereby avoiding the large penalty of a trap to the
6656 operating system.  Such emulation has its own, smaller, execution
6657 cost in both time and space.  To the extent that your code's
6658 important signed integer division operations are performed on two
6659 nonnegative operands, it may be desirable to use the div
6660 instruction directly.
6661
6662 On the MC88110 processor the div instruction (also known as the
6663 divs instruction) processes negative operands without trapping to
6664 the operating system.  When @option{-m88110} is specified,
6665 @option{-muse-div-instruction} is ignored, and the div instruction is used
6666 for signed integer division.
6667
6668 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6669 particular, the behavior of such a division with and without
6670 @option{-muse-div-instruction} may differ.
6671
6672 @item -mtrap-large-shift
6673 @itemx -mhandle-large-shift
6674 @opindex mtrap-large-shift
6675 @opindex mhandle-large-shift
6676 @cindex bit shift overflow (88k)
6677 @cindex large bit shifts (88k)
6678 Include code to detect bit-shifts of more than 31 bits; respectively,
6679 trap such shifts or emit code to handle them properly.  By default GCC
6680 makes no special provision for large bit shifts.
6681
6682 @item -mwarn-passed-structs
6683 @opindex mwarn-passed-structs
6684 @cindex structure passing (88k)
6685 Warn when a function passes a struct as an argument or result.
6686 Structure-passing conventions have changed during the evolution of the C
6687 language, and are often the source of portability problems.  By default,
6688 GCC issues no such warning.
6689 @end table
6690
6691 @c break page here to avoid unsightly interparagraph stretch.
6692 @c -zw, 2001-8-17
6693 @page
6694
6695 @node RS/6000 and PowerPC Options
6696 @subsection IBM RS/6000 and PowerPC Options
6697 @cindex RS/6000 and PowerPC Options
6698 @cindex IBM RS/6000 and PowerPC Options
6699
6700 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6701 @table @gcctabopt
6702 @item -mpower
6703 @itemx -mno-power
6704 @itemx -mpower2
6705 @itemx -mno-power2
6706 @itemx -mpowerpc
6707 @itemx -mno-powerpc
6708 @itemx -mpowerpc-gpopt
6709 @itemx -mno-powerpc-gpopt
6710 @itemx -mpowerpc-gfxopt
6711 @itemx -mno-powerpc-gfxopt
6712 @itemx -mpowerpc64
6713 @itemx -mno-powerpc64
6714 @opindex mpower
6715 @opindex mno-power
6716 @opindex mpower2
6717 @opindex mno-power2
6718 @opindex mpowerpc
6719 @opindex mno-powerpc
6720 @opindex mpowerpc-gpopt
6721 @opindex mno-powerpc-gpopt
6722 @opindex mpowerpc-gfxopt
6723 @opindex mno-powerpc-gfxopt
6724 @opindex mpowerpc64
6725 @opindex mno-powerpc64
6726 GCC supports two related instruction set architectures for the
6727 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6728 instructions supported by the @samp{rios} chip set used in the original
6729 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6730 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6731 the IBM 4xx microprocessors.
6732
6733 Neither architecture is a subset of the other.  However there is a
6734 large common subset of instructions supported by both.  An MQ
6735 register is included in processors supporting the POWER architecture.
6736
6737 You use these options to specify which instructions are available on the
6738 processor you are using.  The default value of these options is
6739 determined when configuring GCC@.  Specifying the
6740 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6741 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6742 rather than the options listed above.
6743
6744 The @option{-mpower} option allows GCC to generate instructions that
6745 are found only in the POWER architecture and to use the MQ register.
6746 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6747 to generate instructions that are present in the POWER2 architecture but
6748 not the original POWER architecture.
6749
6750 The @option{-mpowerpc} option allows GCC to generate instructions that
6751 are found only in the 32-bit subset of the PowerPC architecture.
6752 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6753 GCC to use the optional PowerPC architecture instructions in the
6754 General Purpose group, including floating-point square root.  Specifying
6755 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6756 use the optional PowerPC architecture instructions in the Graphics
6757 group, including floating-point select.
6758
6759 The @option{-mpowerpc64} option allows GCC to generate the additional
6760 64-bit instructions that are found in the full PowerPC64 architecture
6761 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6762 @option{-mno-powerpc64}.
6763
6764 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6765 will use only the instructions in the common subset of both
6766 architectures plus some special AIX common-mode calls, and will not use
6767 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6768 permits GCC to use any instruction from either architecture and to
6769 allow use of the MQ register; specify this for the Motorola MPC601.
6770
6771 @item -mnew-mnemonics
6772 @itemx -mold-mnemonics
6773 @opindex mnew-mnemonics
6774 @opindex mold-mnemonics
6775 Select which mnemonics to use in the generated assembler code.  With
6776 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6777 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6778 assembler mnemonics defined for the POWER architecture.  Instructions
6779 defined in only one architecture have only one mnemonic; GCC uses that
6780 mnemonic irrespective of which of these options is specified.
6781
6782 GCC defaults to the mnemonics appropriate for the architecture in
6783 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6784 value of these option.  Unless you are building a cross-compiler, you
6785 should normally not specify either @option{-mnew-mnemonics} or
6786 @option{-mold-mnemonics}, but should instead accept the default.
6787
6788 @item -mcpu=@var{cpu_type}
6789 @opindex mcpu
6790 Set architecture type, register usage, choice of mnemonics, and
6791 instruction scheduling parameters for machine type @var{cpu_type}.
6792 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6793 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6794 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6795 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6796 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6797 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6798
6799 @option{-mcpu=common} selects a completely generic processor.  Code
6800 generated under this option will run on any POWER or PowerPC processor.
6801 GCC will use only the instructions in the common subset of both
6802 architectures, and will not use the MQ register.  GCC assumes a generic
6803 processor model for scheduling purposes.
6804
6805 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6806 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6807 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6808 types, with an appropriate, generic processor model assumed for
6809 scheduling purposes.
6810
6811 The other options specify a specific processor.  Code generated under
6812 those options will run best on that processor, and may not run at all on
6813 others.
6814
6815 The @option{-mcpu} options automatically enable or disable other
6816 @option{-m} options as follows:
6817
6818 @table @samp
6819 @item common
6820 @option{-mno-power}, @option{-mno-powerpc}
6821
6822 @item power
6823 @itemx power2
6824 @itemx rios1
6825 @itemx rios2
6826 @itemx rsc
6827 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6828
6829 @item powerpc
6830 @itemx rs64a
6831 @itemx 602
6832 @itemx 603
6833 @itemx 603e
6834 @itemx 604
6835 @itemx 620
6836 @itemx 630
6837 @itemx 740
6838 @itemx 7400
6839 @itemx 7450
6840 @itemx 750
6841 @itemx 505
6842 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6843
6844 @item 601
6845 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6846
6847 @item 403
6848 @itemx 821
6849 @itemx 860
6850 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6851 @end table
6852
6853 @item -mtune=@var{cpu_type}
6854 @opindex mtune
6855 Set the instruction scheduling parameters for machine type
6856 @var{cpu_type}, but do not set the architecture type, register usage, or
6857 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6858 values for @var{cpu_type} are used for @option{-mtune} as for
6859 @option{-mcpu}.  If both are specified, the code generated will use the
6860 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6861 scheduling parameters set by @option{-mtune}.
6862
6863 @item -maltivec
6864 @itemx -mno-altivec
6865 @opindex maltivec
6866 @opindex mno-altivec
6867 These switches enable or disable the use of built-in functions that
6868 allow access to the AltiVec instruction set.  You may also need to set
6869 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6870 enhancements.
6871
6872 @item -mabi=spe
6873 @opindex mabi=spe
6874 Extend the current ABI with SPE ABI extensions.  This does not change
6875 the default ABI, instead it adds the SPE ABI extensions to the current
6876 ABI@.
6877
6878 @item -mabi=no-spe
6879 @opindex mabi=no-spe
6880 Disable Booke SPE ABI extensions for the current ABI.
6881
6882 @item -misel=@var{yes/no}
6883 @itemx -misel
6884 @opindex misel
6885 This switch enables or disables the generation of ISEL instructions.
6886
6887 @item -mfull-toc
6888 @itemx -mno-fp-in-toc
6889 @itemx -mno-sum-in-toc
6890 @itemx -mminimal-toc
6891 @opindex mfull-toc
6892 @opindex mno-fp-in-toc
6893 @opindex mno-sum-in-toc
6894 @opindex mminimal-toc
6895 Modify generation of the TOC (Table Of Contents), which is created for
6896 every executable file.  The @option{-mfull-toc} option is selected by
6897 default.  In that case, GCC will allocate at least one TOC entry for
6898 each unique non-automatic variable reference in your program.  GCC
6899 will also place floating-point constants in the TOC@.  However, only
6900 16,384 entries are available in the TOC@.
6901
6902 If you receive a linker error message that saying you have overflowed
6903 the available TOC space, you can reduce the amount of TOC space used
6904 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6905 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6906 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6907 generate code to calculate the sum of an address and a constant at
6908 run-time instead of putting that sum into the TOC@.  You may specify one
6909 or both of these options.  Each causes GCC to produce very slightly
6910 slower and larger code at the expense of conserving TOC space.
6911
6912 If you still run out of space in the TOC even when you specify both of
6913 these options, specify @option{-mminimal-toc} instead.  This option causes
6914 GCC to make only one TOC entry for every file.  When you specify this
6915 option, GCC will produce code that is slower and larger but which
6916 uses extremely little TOC space.  You may wish to use this option
6917 only on files that contain less frequently executed code.
6918
6919 @item -maix64
6920 @itemx -maix32
6921 @opindex maix64
6922 @opindex maix32
6923 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6924 @code{long} type, and the infrastructure needed to support them.
6925 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6926 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6927 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6928
6929 @item -mxl-call
6930 @itemx -mno-xl-call
6931 @opindex mxl-call
6932 @opindex mno-xl-call
6933 On AIX, pass floating-point arguments to prototyped functions beyond the
6934 register save area (RSA) on the stack in addition to argument FPRs.  The
6935 AIX calling convention was extended but not initially documented to
6936 handle an obscure K&R C case of calling a function that takes the
6937 address of its arguments with fewer arguments than declared.  AIX XL
6938 compilers access floating point arguments which do not fit in the
6939 RSA from the stack when a subroutine is compiled without
6940 optimization.  Because always storing floating-point arguments on the
6941 stack is inefficient and rarely needed, this option is not enabled by
6942 default and only is necessary when calling subroutines compiled by AIX
6943 XL compilers without optimization.
6944
6945 @item -mpe
6946 @opindex mpe
6947 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6948 application written to use message passing with special startup code to
6949 enable the application to run.  The system must have PE installed in the
6950 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6951 must be overridden with the @option{-specs=} option to specify the
6952 appropriate directory location.  The Parallel Environment does not
6953 support threads, so the @option{-mpe} option and the @option{-pthread}
6954 option are incompatible.
6955
6956 @item -msoft-float
6957 @itemx -mhard-float
6958 @opindex msoft-float
6959 @opindex mhard-float
6960 Generate code that does not use (uses) the floating-point register set.
6961 Software floating point emulation is provided if you use the
6962 @option{-msoft-float} option, and pass the option to GCC when linking.
6963
6964 @item -mmultiple
6965 @itemx -mno-multiple
6966 @opindex mmultiple
6967 @opindex mno-multiple
6968 Generate code that uses (does not use) the load multiple word
6969 instructions and the store multiple word instructions.  These
6970 instructions are generated by default on POWER systems, and not
6971 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6972 endian PowerPC systems, since those instructions do not work when the
6973 processor is in little endian mode.  The exceptions are PPC740 and
6974 PPC750 which permit the instructions usage in little endian mode.
6975
6976 @item -mstring
6977 @itemx -mno-string
6978 @opindex mstring
6979 @opindex mno-string
6980 Generate code that uses (does not use) the load string instructions
6981 and the store string word instructions to save multiple registers and
6982 do small block moves.  These instructions are generated by default on
6983 POWER systems, and not generated on PowerPC systems.  Do not use
6984 @option{-mstring} on little endian PowerPC systems, since those
6985 instructions do not work when the processor is in little endian mode.
6986 The exceptions are PPC740 and PPC750 which permit the instructions
6987 usage in little endian mode.
6988
6989 @item -mupdate
6990 @itemx -mno-update
6991 @opindex mupdate
6992 @opindex mno-update
6993 Generate code that uses (does not use) the load or store instructions
6994 that update the base register to the address of the calculated memory
6995 location.  These instructions are generated by default.  If you use
6996 @option{-mno-update}, there is a small window between the time that the
6997 stack pointer is updated and the address of the previous frame is
6998 stored, which means code that walks the stack frame across interrupts or
6999 signals may get corrupted data.
7000
7001 @item -mfused-madd
7002 @itemx -mno-fused-madd
7003 @opindex mfused-madd
7004 @opindex mno-fused-madd
7005 Generate code that uses (does not use) the floating point multiply and
7006 accumulate instructions.  These instructions are generated by default if
7007 hardware floating is used.
7008
7009 @item -mno-bit-align
7010 @itemx -mbit-align
7011 @opindex mno-bit-align
7012 @opindex mbit-align
7013 On System V.4 and embedded PowerPC systems do not (do) force structures
7014 and unions that contain bit-fields to be aligned to the base type of the
7015 bit-field.
7016
7017 For example, by default a structure containing nothing but 8
7018 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7019 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7020 the structure would be aligned to a 1 byte boundary and be one byte in
7021 size.
7022
7023 @item -mno-strict-align
7024 @itemx -mstrict-align
7025 @opindex mno-strict-align
7026 @opindex mstrict-align
7027 On System V.4 and embedded PowerPC systems do not (do) assume that
7028 unaligned memory references will be handled by the system.
7029
7030 @item -mrelocatable
7031 @itemx -mno-relocatable
7032 @opindex mrelocatable
7033 @opindex mno-relocatable
7034 On embedded PowerPC systems generate code that allows (does not allow)
7035 the program to be relocated to a different address at runtime.  If you
7036 use @option{-mrelocatable} on any module, all objects linked together must
7037 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7038
7039 @item -mrelocatable-lib
7040 @itemx -mno-relocatable-lib
7041 @opindex mrelocatable-lib
7042 @opindex mno-relocatable-lib
7043 On embedded PowerPC systems generate code that allows (does not allow)
7044 the program to be relocated to a different address at runtime.  Modules
7045 compiled with @option{-mrelocatable-lib} can be linked with either modules
7046 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7047 with modules compiled with the @option{-mrelocatable} options.
7048
7049 @item -mno-toc
7050 @itemx -mtoc
7051 @opindex mno-toc
7052 @opindex mtoc
7053 On System V.4 and embedded PowerPC systems do not (do) assume that
7054 register 2 contains a pointer to a global area pointing to the addresses
7055 used in the program.
7056
7057 @item -mlittle
7058 @itemx -mlittle-endian
7059 @opindex mlittle
7060 @opindex mlittle-endian
7061 On System V.4 and embedded PowerPC systems compile code for the
7062 processor in little endian mode.  The @option{-mlittle-endian} option is
7063 the same as @option{-mlittle}.
7064
7065 @item -mbig
7066 @itemx -mbig-endian
7067 @opindex mbig
7068 @opindex mbig-endian
7069 On System V.4 and embedded PowerPC systems compile code for the
7070 processor in big endian mode.  The @option{-mbig-endian} option is
7071 the same as @option{-mbig}.
7072
7073 @item -mcall-sysv
7074 @opindex mcall-sysv
7075 On System V.4 and embedded PowerPC systems compile code using calling
7076 conventions that adheres to the March 1995 draft of the System V
7077 Application Binary Interface, PowerPC processor supplement.  This is the
7078 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7079
7080 @item -mcall-sysv-eabi
7081 @opindex mcall-sysv-eabi
7082 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7083
7084 @item -mcall-sysv-noeabi
7085 @opindex mcall-sysv-noeabi
7086 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7087
7088 @item -mcall-aix
7089 @opindex mcall-aix
7090 On System V.4 and embedded PowerPC systems compile code using calling
7091 conventions that are similar to those used on AIX@.  This is the
7092 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7093
7094 @item -mcall-solaris
7095 @opindex mcall-solaris
7096 On System V.4 and embedded PowerPC systems compile code for the Solaris
7097 operating system.
7098
7099 @item -mcall-linux
7100 @opindex mcall-linux
7101 On System V.4 and embedded PowerPC systems compile code for the
7102 Linux-based GNU system.
7103
7104 @item -mcall-gnu
7105 @opindex mcall-gnu
7106 On System V.4 and embedded PowerPC systems compile code for the
7107 Hurd-based GNU system.
7108
7109 @item -mcall-netbsd
7110 @opindex mcall-netbsd
7111 On System V.4 and embedded PowerPC systems compile code for the
7112 NetBSD operating system.
7113
7114 @item -maix-struct-return
7115 @opindex maix-struct-return
7116 Return all structures in memory (as specified by the AIX ABI)@.
7117
7118 @item -msvr4-struct-return
7119 @opindex msvr4-struct-return
7120 Return structures smaller than 8 bytes in registers (as specified by the
7121 SVR4 ABI)@.
7122
7123 @item -mabi=altivec
7124 @opindex mabi=altivec
7125 Extend the current ABI with AltiVec ABI extensions.  This does not
7126 change the default ABI, instead it adds the AltiVec ABI extensions to
7127 the current ABI@.
7128
7129 @item -mabi=no-altivec
7130 @opindex mabi=no-altivec
7131 Disable AltiVec ABI extensions for the current ABI.
7132
7133 @item -mprototype
7134 @itemx -mno-prototype
7135 @opindex mprototype
7136 @opindex mno-prototype
7137 On System V.4 and embedded PowerPC systems assume that all calls to
7138 variable argument functions are properly prototyped.  Otherwise, the
7139 compiler must insert an instruction before every non prototyped call to
7140 set or clear bit 6 of the condition code register (@var{CR}) to
7141 indicate whether floating point values were passed in the floating point
7142 registers in case the function takes a variable arguments.  With
7143 @option{-mprototype}, only calls to prototyped variable argument functions
7144 will set or clear the bit.
7145
7146 @item -msim
7147 @opindex msim
7148 On embedded PowerPC systems, assume that the startup module is called
7149 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7150 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7151 configurations.
7152
7153 @item -mmvme
7154 @opindex mmvme
7155 On embedded PowerPC systems, assume that the startup module is called
7156 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7157 @file{libc.a}.
7158
7159 @item -mads
7160 @opindex mads
7161 On embedded PowerPC systems, assume that the startup module is called
7162 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7163 @file{libc.a}.
7164
7165 @item -myellowknife
7166 @opindex myellowknife
7167 On embedded PowerPC systems, assume that the startup module is called
7168 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7169 @file{libc.a}.
7170
7171 @item -mvxworks
7172 @opindex mvxworks
7173 On System V.4 and embedded PowerPC systems, specify that you are
7174 compiling for a VxWorks system.
7175
7176 @item -mwindiss
7177 @opindex mwindiss
7178 Specify that you are compiling for the WindISS simulation environment.
7179
7180 @item -memb
7181 @opindex memb
7182 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7183 header to indicate that @samp{eabi} extended relocations are used.
7184
7185 @item -meabi
7186 @itemx -mno-eabi
7187 @opindex meabi
7188 @opindex mno-eabi
7189 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7190 Embedded Applications Binary Interface (eabi) which is a set of
7191 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7192 means that the stack is aligned to an 8 byte boundary, a function
7193 @code{__eabi} is called to from @code{main} to set up the eabi
7194 environment, and the @option{-msdata} option can use both @code{r2} and
7195 @code{r13} to point to two separate small data areas.  Selecting
7196 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7197 do not call an initialization function from @code{main}, and the
7198 @option{-msdata} option will only use @code{r13} to point to a single
7199 small data area.  The @option{-meabi} option is on by default if you
7200 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7201
7202 @item -msdata=eabi
7203 @opindex msdata=eabi
7204 On System V.4 and embedded PowerPC systems, put small initialized
7205 @code{const} global and static data in the @samp{.sdata2} section, which
7206 is pointed to by register @code{r2}.  Put small initialized
7207 non-@code{const} global and static data in the @samp{.sdata} section,
7208 which is pointed to by register @code{r13}.  Put small uninitialized
7209 global and static data in the @samp{.sbss} section, which is adjacent to
7210 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7211 incompatible with the @option{-mrelocatable} option.  The
7212 @option{-msdata=eabi} option also sets the @option{-memb} option.
7213
7214 @item -msdata=sysv
7215 @opindex msdata=sysv
7216 On System V.4 and embedded PowerPC systems, put small global and static
7217 data in the @samp{.sdata} section, which is pointed to by register
7218 @code{r13}.  Put small uninitialized global and static data in the
7219 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7220 The @option{-msdata=sysv} option is incompatible with the
7221 @option{-mrelocatable} option.
7222
7223 @item -msdata=default
7224 @itemx -msdata
7225 @opindex msdata=default
7226 @opindex msdata
7227 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7228 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7229 same as @option{-msdata=sysv}.
7230
7231 @item -msdata-data
7232 @opindex msdata-data
7233 On System V.4 and embedded PowerPC systems, put small global and static
7234 data in the @samp{.sdata} section.  Put small uninitialized global and
7235 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7236 to address small data however.  This is the default behavior unless
7237 other @option{-msdata} options are used.
7238
7239 @item -msdata=none
7240 @itemx -mno-sdata
7241 @opindex msdata=none
7242 @opindex mno-sdata
7243 On embedded PowerPC systems, put all initialized global and static data
7244 in the @samp{.data} section, and all uninitialized data in the
7245 @samp{.bss} section.
7246
7247 @item -G @var{num}
7248 @opindex G
7249 @cindex smaller data references (PowerPC)
7250 @cindex .sdata/.sdata2 references (PowerPC)
7251 On embedded PowerPC systems, put global and static items less than or
7252 equal to @var{num} bytes into the small data or bss sections instead of
7253 the normal data or bss section.  By default, @var{num} is 8.  The
7254 @option{-G @var{num}} switch is also passed to the linker.
7255 All modules should be compiled with the same @option{-G @var{num}} value.
7256
7257 @item -mregnames
7258 @itemx -mno-regnames
7259 @opindex mregnames
7260 @opindex mno-regnames
7261 On System V.4 and embedded PowerPC systems do (do not) emit register
7262 names in the assembly language output using symbolic forms.
7263
7264 @item -mlongcall
7265 @itemx -mno-longcall
7266 @opindex mlongcall
7267 @opindex mno-longcall
7268 Default to making all function calls via pointers, so that functions
7269 which reside further than 64 megabytes (67,108,864 bytes) from the
7270 current location can be called.  This setting can be overridden by the
7271 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7272
7273 Some linkers are capable of detecting out-of-range calls and generating
7274 glue code on the fly.  On these systems, long calls are unnecessary and
7275 generate slower code.  As of this writing, the AIX linker can do this,
7276 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7277 to the GNU linker for 32-bit PowerPC systems as well.
7278
7279 In the future, we may cause GCC to ignore all longcall specifications
7280 when the linker is known to generate glue.
7281
7282 @item -pthread
7283 @opindex pthread
7284 Adds support for multithreading with the @dfn{pthreads} library.
7285 This option sets flags for both the preprocessor and linker.
7286
7287 @end table
7288
7289 @node Darwin Options
7290 @subsection Darwin Options
7291 @cindex Darwin options
7292 @table @gcctabopt
7293 @item -all_load    
7294 @opindex all_load   
7295 Loads all members of static archive libraries.
7296 See man ld(1) for more information.
7297
7298 @item -arch_errors_fatal
7299 @opindex arch_errors_fatal
7300 Cause the errors having to do with files that have the wrong architecture
7301 to be fatal.
7302
7303 @item -bind_at_load
7304 @opindex bind_at_load
7305 Causes the output file to be marked such that the dynamic linker will
7306 bind all undefined references when the file is loaded or launched.
7307
7308 @item -bundle     
7309 @opindex bundle
7310 Produce a Mach-o bundle format file.
7311 See man ld(1) for more information.
7312
7313 @item -bundle_loader @var{executable}
7314 @opindex bundle_loader
7315 This specifies the @var{executable} that will be loading the build
7316 output file being linked. See man ld(1) for more information.
7317
7318 @item -allowable_client  @var{client_name}
7319 @item -arch_only
7320
7321 @item -client_name       
7322 @item -compatibility_version
7323 @item -current_version    
7324 @item -dependency-file
7325 @item -dylib_file    
7326 @item -dylinker_install_name
7327 @item -dynamic
7328 @item -dynamiclib   
7329 @item -exported_symbols_list  
7330 @item -filelist
7331 @item -flat_namespace   
7332 @item -force_cpusubtype_ALL
7333 @item -force_flat_namespace   
7334 @item -headerpad_max_install_names
7335 @item -image_base  
7336 @item -init
7337 @item -install_name
7338 @item -keep_private_externs
7339 @item -multi_module
7340 @item -multiply_defined      
7341 @item -multiply_defined_unused      
7342 @item -noall_load  
7343 @item -nomultidefs
7344 @item -noprebind     
7345 @item -noseglinkedit
7346 @item -pagezero_size    
7347 @item -prebind
7348 @item -prebind_all_twolevel_modules
7349 @item -private_bundle
7350 @item -read_only_relocs
7351 @item -sectalign  
7352 @item -sectobjectsymbols    
7353 @item -whyload
7354 @item -seg1addr 
7355 @item -sectcreate
7356 @item -sectobjectsymbols
7357 @item -sectorder
7358 @item -seg_addr_table
7359 @item -seg_addr_table_filename
7360 @item -seglinkedit
7361 @item -segprot   
7362 @item -segs_read_only_addr
7363 @item -segs_read_write_addr
7364 @item -single_module   
7365 @item -static
7366 @item -sub_library
7367 @item -sub_umbrella 
7368 @item -twolevel_namespace
7369 @item -umbrella
7370 @item -undefined
7371 @item -unexported_symbols_list
7372 @item -weak_reference_mismatches
7373 @item -whatsloaded  
7374
7375 @opindex allowable_client
7376 @opindex arch_only    
7377 @opindex client_name
7378 @opindex compatibility_version
7379 @opindex current_version
7380 @opindex dependency-file
7381 @opindex dylib_file
7382 @opindex dylinker_install_name
7383 @opindex dynamic
7384 @opindex dynamiclib
7385 @opindex exported_symbols_list
7386 @opindex filelist  
7387 @opindex flat_namespace    
7388 @opindex force_cpusubtype_ALL
7389 @opindex force_flat_namespace
7390 @opindex headerpad_max_install_names
7391 @opindex image_base
7392 @opindex init     
7393 @opindex install_name
7394 @opindex keep_private_externs
7395 @opindex multi_module   
7396 @opindex multiply_defined
7397 @opindex multiply_defined_unused   
7398 @opindex noall_load  
7399 @opindex nomultidefs   
7400 @opindex noprebind
7401 @opindex noseglinkedit      
7402 @opindex pagezero_size
7403 @opindex prebind
7404 @opindex prebind_all_twolevel_modules
7405 @opindex private_bundle 
7406 @opindex read_only_relocs
7407 @opindex sectalign   
7408 @opindex sectobjectsymbols    
7409 @opindex whyload  
7410 @opindex seg1addr
7411 @opindex sectcreate       
7412 @opindex sectobjectsymbols 
7413 @opindex sectorder     
7414 @opindex seg_addr_table
7415 @opindex seg_addr_table_filename
7416 @opindex seglinkedit
7417 @opindex segprot
7418 @opindex segs_read_only_addr
7419 @opindex segs_read_write_addr
7420 @opindex single_module
7421 @opindex static
7422 @opindex sub_library
7423 @opindex sub_umbrella
7424 @opindex twolevel_namespace
7425 @opindex umbrella
7426 @opindex undefined
7427 @opindex unexported_symbols_list
7428 @opindex weak_reference_mismatches
7429 @opindex whatsloaded
7430
7431 This options are available for Darwin linker. Darwin linker man page
7432 describes them in detail.
7433 @end table
7434
7435
7436 @node RT Options
7437 @subsection IBM RT Options
7438 @cindex RT options
7439 @cindex IBM RT options
7440
7441 These @samp{-m} options are defined for the IBM RT PC:
7442
7443 @table @gcctabopt
7444 @item -min-line-mul
7445 @opindex min-line-mul
7446 Use an in-line code sequence for integer multiplies.  This is the
7447 default.
7448
7449 @item -mcall-lib-mul
7450 @opindex mcall-lib-mul
7451 Call @code{lmul$$} for integer multiples.
7452
7453 @item -mfull-fp-blocks
7454 @opindex mfull-fp-blocks
7455 Generate full-size floating point data blocks, including the minimum
7456 amount of scratch space recommended by IBM@.  This is the default.
7457
7458 @item -mminimum-fp-blocks
7459 @opindex mminimum-fp-blocks
7460 Do not include extra scratch space in floating point data blocks.  This
7461 results in smaller code, but slower execution, since scratch space must
7462 be allocated dynamically.
7463
7464 @cindex @file{stdarg.h} and RT PC
7465 @item -mfp-arg-in-fpregs
7466 @opindex mfp-arg-in-fpregs
7467 Use a calling sequence incompatible with the IBM calling convention in
7468 which floating point arguments are passed in floating point registers.
7469 Note that @code{stdarg.h} will not work with floating point operands
7470 if this option is specified.
7471
7472 @item -mfp-arg-in-gregs
7473 @opindex mfp-arg-in-gregs
7474 Use the normal calling convention for floating point arguments.  This is
7475 the default.
7476
7477 @item -mhc-struct-return
7478 @opindex mhc-struct-return
7479 Return structures of more than one word in memory, rather than in a
7480 register.  This provides compatibility with the MetaWare HighC (hc)
7481 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7482 with the Portable C Compiler (pcc).
7483
7484 @item -mnohc-struct-return
7485 @opindex mnohc-struct-return
7486 Return some structures of more than one word in registers, when
7487 convenient.  This is the default.  For compatibility with the
7488 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7489 option @option{-mhc-struct-return}.
7490 @end table
7491
7492 @node MIPS Options
7493 @subsection MIPS Options
7494 @cindex MIPS options
7495
7496 These @samp{-m} options are defined for the MIPS family of computers:
7497
7498 @table @gcctabopt
7499
7500 @item -march=@var{arch}
7501 @opindex march
7502 Generate code that will run on @var{arch}, which can be the name of a
7503 generic MIPS ISA, or the name of a particular processor.  The ISA names
7504 are: @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4}, @samp{mips32}
7505 and @samp{mips64}.  The processor names are: @samp{r2000},
7506 @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{vr4100}, @samp{vr4300},
7507 @samp{r4400}, @samp{r4600}, @samp{r4650}, @samp{vr5000}, @samp{r6000},
7508 @samp{r8000}, @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7509 @samp{orion}, and @samp{sb1}.  The special value @samp{from-abi} selects the
7510 most compatible architecture for the selected ABI (that is,
7511 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7512
7513 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7514 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7515 @samp{vr} may be written @samp{r}.
7516
7517 GCC defines two macros based on the value of this option.  The first
7518 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7519 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7520 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7521 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7522 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7523
7524 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7525 above.  In other words, it will have the full prefix and will not
7526 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7527 the macro names the resolved architecture (either @samp{"mips1"} or
7528 @samp{"mips3"}).  It names the default architecture when no
7529 @option{-march} option is given.
7530
7531 @item -mtune=@var{arch}
7532 @opindex mtune
7533 Optimize for @var{arch}.  Among other things, this option controls
7534 the way instructions are scheduled, and the perceived cost of arithmetic
7535 operations.  The list of @var{arch} values is the same as for
7536 @option{-march}.
7537
7538 When this option is not used, GCC will optimize for the processor
7539 specified by @option{-march}.  By using @option{-march} and
7540 @option{-mtune} together, it is possible to generate code that will
7541 run on a family of processors, but optimize the code for one
7542 particular member of that family.
7543
7544 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7545 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7546 @samp{-march} ones described above.
7547
7548 @item -mips1
7549 @opindex mips1
7550 Equivalent to @samp{-march=mips1}.
7551
7552 @item -mips2
7553 @opindex mips2
7554 Equivalent to @samp{-march=mips2}.
7555
7556 @item -mips3
7557 @opindex mips3
7558 Equivalent to @samp{-march=mips3}.
7559
7560 @item -mips4
7561 @opindex mips4
7562 Equivalent to @samp{-march=mips4}.
7563
7564 @item -mips32
7565 @opindex mips32
7566 Equivalent to @samp{-march=mips32}.
7567
7568 @item -mips64
7569 @opindex mips64
7570 Equivalent to @samp{-march=mips64}.
7571
7572 @item -mfused-madd
7573 @itemx -mno-fused-madd
7574 @opindex mfused-madd
7575 @opindex mno-fused-madd
7576 Generate code that uses (does not use) the floating point multiply and
7577 accumulate instructions, when they are available.  These instructions
7578 are generated by default if they are available, but this may be
7579 undesirable if the extra precision causes problems or on certain chips
7580 in the mode where denormals are rounded to zero where denormals
7581 generated by multiply and accumulate instructions cause exceptions
7582 anyway.
7583
7584 @item -mfp32
7585 @opindex mfp32
7586 Assume that floating point registers are 32 bits wide.
7587
7588 @item -mfp64
7589 @opindex mfp64
7590 Assume that floating point registers are 64 bits wide.
7591
7592 @item -mgp32
7593 @opindex mgp32
7594 Assume that general purpose registers are 32 bits wide.
7595
7596 @item -mgp64
7597 @opindex mgp64
7598 Assume that general purpose registers are 64 bits wide.
7599
7600 @item -mint64
7601 @opindex mint64
7602 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7603 explanation of the default, and the width of pointers.
7604
7605 @item -mlong64
7606 @opindex mlong64
7607 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7608 explanation of the default, and the width of pointers.
7609
7610 @item -mlong32
7611 @opindex mlong32
7612 Force long, int, and pointer types to be 32 bits wide.
7613
7614 The default size of ints, longs and pointers depends on the ABI@.  All
7615 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7616 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7617 are the same size as longs, or the same size as integer registers,
7618 whichever is smaller.
7619
7620 @item -mabi=32
7621 @itemx -mabi=o64
7622 @itemx -mabi=n32
7623 @itemx -mabi=64
7624 @itemx -mabi=eabi
7625 @itemx -mabi=meabi
7626 @opindex mabi=32
7627 @opindex mabi=o64
7628 @opindex mabi=n32
7629 @opindex mabi=64
7630 @opindex mabi=eabi
7631 @opindex mabi=meabi
7632 Generate code for the given ABI@.
7633
7634 Note that there are two embedded ABIs: @option{-mabi=eabi}
7635 selects the one defined by Cygnus while @option{-meabi=meabi}
7636 selects the one defined by MIPS@.  Both these ABIs have
7637 32-bit and 64-bit variants.  Normally, GCC will generate
7638 64-bit code when you select a 64-bit architecture, but you
7639 can use @option{-mgp32} to get 32-bit code instead.
7640
7641 @item -mmips-as
7642 @opindex mmips-as
7643 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7644 add normal debug information.  This is the default for all
7645 platforms except for the OSF/1 reference platform, using the OSF/rose
7646 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7647 switches are used, the @file{mips-tfile} program will encapsulate the
7648 stabs within MIPS ECOFF@.
7649
7650 @item -mgas
7651 @opindex mgas
7652 Generate code for the GNU assembler.  This is the default on the OSF/1
7653 reference platform, using the OSF/rose object format.  Also, this is
7654 the default if the configure option @option{--with-gnu-as} is used.
7655
7656 @item -msplit-addresses
7657 @itemx -mno-split-addresses
7658 @opindex msplit-addresses
7659 @opindex mno-split-addresses
7660 Generate code to load the high and low parts of address constants separately.
7661 This allows GCC to optimize away redundant loads of the high order
7662 bits of addresses.  This optimization requires GNU as and GNU ld.
7663 This optimization is enabled by default for some embedded targets where
7664 GNU as and GNU ld are standard.
7665
7666 @item -mrnames
7667 @itemx -mno-rnames
7668 @opindex mrnames
7669 @opindex mno-rnames
7670 The @option{-mrnames} switch says to output code using the MIPS software
7671 names for the registers, instead of the hardware names (ie, @var{a0}
7672 instead of @var{$4}).  The only known assembler that supports this option
7673 is the Algorithmics assembler.
7674
7675 @item -mgpopt
7676 @itemx -mno-gpopt
7677 @opindex mgpopt
7678 @opindex mno-gpopt
7679 The @option{-mgpopt} switch says to write all of the data declarations
7680 before the instructions in the text section, this allows the MIPS
7681 assembler to generate one word memory references instead of using two
7682 words for short global or static data items.  This is on by default if
7683 optimization is selected.
7684
7685 @item -mstats
7686 @itemx -mno-stats
7687 @opindex mstats
7688 @opindex mno-stats
7689 For each non-inline function processed, the @option{-mstats} switch
7690 causes the compiler to emit one line to the standard error file to
7691 print statistics about the program (number of registers saved, stack
7692 size, etc.).
7693
7694 @item -mmemcpy
7695 @itemx -mno-memcpy
7696 @opindex mmemcpy
7697 @opindex mno-memcpy
7698 The @option{-mmemcpy} switch makes all block moves call the appropriate
7699 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7700 generating inline code.
7701
7702 @item -mmips-tfile
7703 @itemx -mno-mips-tfile
7704 @opindex mmips-tfile
7705 @opindex mno-mips-tfile
7706 The @option{-mno-mips-tfile} switch causes the compiler not
7707 postprocess the object file with the @file{mips-tfile} program,
7708 after the MIPS assembler has generated it to add debug support.  If
7709 @file{mips-tfile} is not run, then no local variables will be
7710 available to the debugger.  In addition, @file{stage2} and
7711 @file{stage3} objects will have the temporary file names passed to the
7712 assembler embedded in the object file, which means the objects will
7713 not compare the same.  The @option{-mno-mips-tfile} switch should only
7714 be used when there are bugs in the @file{mips-tfile} program that
7715 prevents compilation.
7716
7717 @item -msoft-float
7718 @opindex msoft-float
7719 Generate output containing library calls for floating point.
7720 @strong{Warning:} the requisite libraries are not part of GCC@.
7721 Normally the facilities of the machine's usual C compiler are used, but
7722 this can't be done directly in cross-compilation.  You must make your
7723 own arrangements to provide suitable library functions for
7724 cross-compilation.
7725
7726 @item -mhard-float
7727 @opindex mhard-float
7728 Generate output containing floating point instructions.  This is the
7729 default if you use the unmodified sources.
7730
7731 @item -mabicalls
7732 @itemx -mno-abicalls
7733 @opindex mabicalls
7734 @opindex mno-abicalls
7735 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7736 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7737 position independent code.
7738
7739 @item -mlong-calls
7740 @itemx -mno-long-calls
7741 @opindex mlong-calls
7742 @opindex mno-long-calls
7743 Do all calls with the @samp{JALR} instruction, which requires
7744 loading up a function's address into a register before the call.
7745 You need to use this switch, if you call outside of the current
7746 512 megabyte segment to functions that are not through pointers.
7747
7748 @item -mhalf-pic
7749 @itemx -mno-half-pic
7750 @opindex mhalf-pic
7751 @opindex mno-half-pic
7752 Put pointers to extern references into the data section and load them
7753 up, rather than put the references in the text section.
7754
7755 @item -membedded-pic
7756 @itemx -mno-embedded-pic
7757 @opindex membedded-pic
7758 @opindex mno-embedded-pic
7759 Generate PIC code suitable for some embedded systems.  All calls are
7760 made using PC relative address, and all data is addressed using the $gp
7761 register.  No more than 65536 bytes of global data may be used.  This
7762 requires GNU as and GNU ld which do most of the work.  This currently
7763 only works on targets which use ECOFF; it does not work with ELF@.
7764
7765 @item -membedded-data
7766 @itemx -mno-embedded-data
7767 @opindex membedded-data
7768 @opindex mno-embedded-data
7769 Allocate variables to the read-only data section first if possible, then
7770 next in the small data section if possible, otherwise in data.  This gives
7771 slightly slower code than the default, but reduces the amount of RAM required
7772 when executing, and thus may be preferred for some embedded systems.
7773
7774 @item -muninit-const-in-rodata
7775 @itemx -mno-uninit-const-in-rodata
7776 @opindex muninit-const-in-rodata
7777 @opindex mno-uninit-const-in-rodata
7778 When used together with @option{-membedded-data}, it will always store uninitialized
7779 const variables in the read-only data section.
7780
7781 @item -msingle-float
7782 @itemx -mdouble-float
7783 @opindex msingle-float
7784 @opindex mdouble-float
7785 The @option{-msingle-float} switch tells gcc to assume that the floating
7786 point coprocessor only supports single precision operations, as on the
7787 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7788 double precision operations.  This is the default.
7789
7790 @item -mmad
7791 @itemx -mno-mad
7792 @opindex mmad
7793 @opindex mno-mad
7794 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7795 as on the @samp{r4650} chip.
7796
7797 @item -m4650
7798 @opindex m4650
7799 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7800 @option{-mcpu=r4650}.
7801
7802 @item -mips16
7803 @itemx -mno-mips16
7804 @opindex mips16
7805 @opindex mno-mips16
7806 Enable 16-bit instructions.
7807
7808 @item -mentry
7809 @opindex mentry
7810 Use the entry and exit pseudo ops.  This option can only be used with
7811 @option{-mips16}.
7812
7813 @item -EL
7814 @opindex EL
7815 Compile code for the processor in little endian mode.
7816 The requisite libraries are assumed to exist.
7817
7818 @item -EB
7819 @opindex EB
7820 Compile code for the processor in big endian mode.
7821 The requisite libraries are assumed to exist.
7822
7823 @item -G @var{num}
7824 @opindex G
7825 @cindex smaller data references (MIPS)
7826 @cindex gp-relative references (MIPS)
7827 Put global and static items less than or equal to @var{num} bytes into
7828 the small data or bss sections instead of the normal data or bss
7829 section.  This allows the assembler to emit one word memory reference
7830 instructions based on the global pointer (@var{gp} or @var{$28}),
7831 instead of the normal two words used.  By default, @var{num} is 8 when
7832 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7833 @option{-G @var{num}} switch is also passed to the assembler and linker.
7834 All modules should be compiled with the same @option{-G @var{num}}
7835 value.
7836
7837 @item -nocpp
7838 @opindex nocpp
7839 Tell the MIPS assembler to not run its preprocessor over user
7840 assembler files (with a @samp{.s} suffix) when assembling them.
7841
7842 @item -mfix7000
7843 @opindex mfix7000
7844 Pass an option to gas which will cause nops to be inserted if
7845 the read of the destination register of an mfhi or mflo instruction
7846 occurs in the following two instructions.
7847
7848 @item -no-crt0
7849 @opindex no-crt0
7850 Do not include the default crt0.
7851
7852 @item -mflush-func=@var{func}
7853 @itemx -mno-flush-func
7854 @opindex mflush-func
7855 Specifies the function to call to flush the I and D caches, or to not
7856 call any such function.  If called, the function must take the same
7857 arguments as the common @code{_flush_func()}, that is, the address of the
7858 memory range for which the cache is being flushed, the size of the
7859 memory range, and the number 3 (to flush both caches).  The default
7860 depends on the target gcc was configured for, but commonly is either
7861 @samp{_flush_func} or @samp{__cpu_flush}.
7862
7863 @item -mbranch-likely
7864 @itemx -mno-branch-likely
7865 @opindex mbranch-likely
7866 @opindex mno-branch-likely
7867 Enable or disable use of Branch Likely instructions, regardless of the
7868 default for the selected architecture.  By default, Branch Likely
7869 instructions may be generated if they are supported by the selected
7870 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7871 and processors which implement those architectures; for those, Branch
7872 Likely instructions will not be generated by default because the MIPS32
7873 and MIPS64 architectures specifically deprecate their use.
7874 @end table
7875
7876 @node i386 and x86-64 Options
7877 @subsection Intel 386 and AMD x86-64 Options
7878 @cindex i386 Options
7879 @cindex x86-64 Options
7880 @cindex Intel 386 Options
7881 @cindex AMD x86-64 Options
7882
7883 These @samp{-m} options are defined for the i386 and x86-64 family of
7884 computers:
7885
7886 @table @gcctabopt
7887 @item -mcpu=@var{cpu-type}
7888 @opindex mcpu
7889 Tune to @var{cpu-type} everything applicable about the generated code, except
7890 for the ABI and the set of available instructions.  The choices for
7891 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7892 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7893 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7894 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7895 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8} and @samp{c3}.
7896
7897 While picking a specific @var{cpu-type} will schedule things appropriately
7898 for that particular chip, the compiler will not generate any code that
7899 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7900 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7901 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7902 AMD chips as opposed to the Intel ones.
7903
7904 @item -march=@var{cpu-type}
7905 @opindex march
7906 Generate instructions for the machine type @var{cpu-type}.  The choices
7907 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7908 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7909
7910 @item -m386
7911 @itemx -m486
7912 @itemx -mpentium
7913 @itemx -mpentiumpro
7914 @opindex m386
7915 @opindex m486
7916 @opindex mpentium
7917 @opindex mpentiumpro
7918 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7919 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7920 These synonyms are deprecated.
7921
7922 @item -mfpmath=@var{unit}
7923 @opindex march
7924 generate floating point arithmetics for selected unit @var{unit}.  the choices
7925 for @var{unit} are:
7926
7927 @table @samp
7928 @item 387
7929 Use the standard 387 floating point coprocessor present majority of chips and
7930 emulated otherwise.  Code compiled with this option will run almost everywhere.
7931 The temporary results are computed in 80bit precision instead of precision
7932 specified by the type resulting in slightly different results compared to most
7933 of other chips. See @option{-ffloat-store} for more detailed description.
7934
7935 This is the default choice for i386 compiler.
7936
7937 @item sse
7938 Use scalar floating point instructions present in the SSE instruction set.
7939 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7940 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7941 instruction set supports only single precision arithmetics, thus the double and
7942 extended precision arithmetics is still done using 387.  Later version, present
7943 only in Pentium4 and the future AMD x86-64 chips supports double precision
7944 arithmetics too.
7945
7946 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7947 @option{-msse2} switches to enable SSE extensions and make this option
7948 effective.  For x86-64 compiler, these extensions are enabled by default.
7949
7950 The resulting code should be considerably faster in majority of cases and avoid
7951 the numerical instability problems of 387 code, but may break some existing
7952 code that expects temporaries to be 80bit.
7953
7954 This is the default choice for x86-64 compiler.
7955
7956 @item sse,387
7957 Attempt to utilize both instruction sets at once.  This effectively double the
7958 amount of available registers and on chips with separate execution units for
7959 387 and SSE the execution resources too.  Use this option with care, as it is
7960 still experimental, because gcc register allocator does not model separate
7961 functional units well resulting in instable performance.
7962 @end table
7963
7964 @item -masm=@var{dialect}
7965 @opindex masm=@var{dialect}
7966 Output asm instructions using selected @var{dialect}. Supported choices are
7967 @samp{intel} or @samp{att} (the default one).
7968
7969 @item -mieee-fp
7970 @itemx -mno-ieee-fp
7971 @opindex mieee-fp
7972 @opindex mno-ieee-fp
7973 Control whether or not the compiler uses IEEE floating point
7974 comparisons.  These handle correctly the case where the result of a
7975 comparison is unordered.
7976
7977 @item -msoft-float
7978 @opindex msoft-float
7979 Generate output containing library calls for floating point.
7980 @strong{Warning:} the requisite libraries are not part of GCC@.
7981 Normally the facilities of the machine's usual C compiler are used, but
7982 this can't be done directly in cross-compilation.  You must make your
7983 own arrangements to provide suitable library functions for
7984 cross-compilation.
7985
7986 On machines where a function returns floating point results in the 80387
7987 register stack, some floating point opcodes may be emitted even if
7988 @option{-msoft-float} is used.
7989
7990 @item -mno-fp-ret-in-387
7991 @opindex mno-fp-ret-in-387
7992 Do not use the FPU registers for return values of functions.
7993
7994 The usual calling convention has functions return values of types
7995 @code{float} and @code{double} in an FPU register, even if there
7996 is no FPU@.  The idea is that the operating system should emulate
7997 an FPU@.
7998
7999 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8000 in ordinary CPU registers instead.
8001
8002 @item -mno-fancy-math-387
8003 @opindex mno-fancy-math-387
8004 Some 387 emulators do not support the @code{sin}, @code{cos} and
8005 @code{sqrt} instructions for the 387.  Specify this option to avoid
8006 generating those instructions.  This option is the default on FreeBSD,
8007 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8008 indicates that the target cpu will always have an FPU and so the
8009 instruction will not need emulation.  As of revision 2.6.1, these
8010 instructions are not generated unless you also use the
8011 @option{-funsafe-math-optimizations} switch.
8012
8013 @item -malign-double
8014 @itemx -mno-align-double
8015 @opindex malign-double
8016 @opindex mno-align-double
8017 Control whether GCC aligns @code{double}, @code{long double}, and
8018 @code{long long} variables on a two word boundary or a one word
8019 boundary.  Aligning @code{double} variables on a two word boundary will
8020 produce code that runs somewhat faster on a @samp{Pentium} at the
8021 expense of more memory.
8022
8023 @strong{Warning:} if you use the @samp{-malign-double} switch,
8024 structures containing the above types will be aligned differently than
8025 the published application binary interface specifications for the 386.
8026
8027 @item -m128bit-long-double
8028 @opindex m128bit-long-double
8029 Control the size of @code{long double} type. i386 application binary interface
8030 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8031 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8032 impossible to reach with 12 byte long doubles in the array accesses.
8033
8034 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8035 structures and arrays containing @code{long double} will change their size as
8036 well as function calling convention for function taking @code{long double}
8037 will be modified.
8038
8039 @item -m96bit-long-double
8040 @opindex m96bit-long-double
8041 Set the size of @code{long double} to 96 bits as required by the i386
8042 application binary interface.  This is the default.
8043
8044 @item -msvr3-shlib
8045 @itemx -mno-svr3-shlib
8046 @opindex msvr3-shlib
8047 @opindex mno-svr3-shlib
8048 Control whether GCC places uninitialized local variables into the
8049 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8050 into @code{bss}.  These options are meaningful only on System V Release 3.
8051
8052 @item -mrtd
8053 @opindex mrtd
8054 Use a different function-calling convention, in which functions that
8055 take a fixed number of arguments return with the @code{ret} @var{num}
8056 instruction, which pops their arguments while returning.  This saves one
8057 instruction in the caller since there is no need to pop the arguments
8058 there.
8059
8060 You can specify that an individual function is called with this calling
8061 sequence with the function attribute @samp{stdcall}.  You can also
8062 override the @option{-mrtd} option by using the function attribute
8063 @samp{cdecl}.  @xref{Function Attributes}.
8064
8065 @strong{Warning:} this calling convention is incompatible with the one
8066 normally used on Unix, so you cannot use it if you need to call
8067 libraries compiled with the Unix compiler.
8068
8069 Also, you must provide function prototypes for all functions that
8070 take variable numbers of arguments (including @code{printf});
8071 otherwise incorrect code will be generated for calls to those
8072 functions.
8073
8074 In addition, seriously incorrect code will result if you call a
8075 function with too many arguments.  (Normally, extra arguments are
8076 harmlessly ignored.)
8077
8078 @item -mregparm=@var{num}
8079 @opindex mregparm
8080 Control how many registers are used to pass integer arguments.  By
8081 default, no registers are used to pass arguments, and at most 3
8082 registers can be used.  You can control this behavior for a specific
8083 function by using the function attribute @samp{regparm}.
8084 @xref{Function Attributes}.
8085
8086 @strong{Warning:} if you use this switch, and
8087 @var{num} is nonzero, then you must build all modules with the same
8088 value, including any libraries.  This includes the system libraries and
8089 startup modules.
8090
8091 @item -mpreferred-stack-boundary=@var{num}
8092 @opindex mpreferred-stack-boundary
8093 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8094 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8095 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8096 size (@option{-Os}), in which case the default is the minimum correct
8097 alignment (4 bytes for x86, and 8 bytes for x86-64).
8098
8099 On Pentium and PentiumPro, @code{double} and @code{long double} values
8100 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8101 suffer significant run time performance penalties.  On Pentium III, the
8102 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8103 penalties if it is not 16 byte aligned.
8104
8105 To ensure proper alignment of this values on the stack, the stack boundary
8106 must be as aligned as that required by any value stored on the stack.
8107 Further, every function must be generated such that it keeps the stack
8108 aligned.  Thus calling a function compiled with a higher preferred
8109 stack boundary from a function compiled with a lower preferred stack
8110 boundary will most likely misalign the stack.  It is recommended that
8111 libraries that use callbacks always use the default setting.
8112
8113 This extra alignment does consume extra stack space, and generally
8114 increases code size.  Code that is sensitive to stack space usage, such
8115 as embedded systems and operating system kernels, may want to reduce the
8116 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8117
8118 @item -mmmx
8119 @itemx -mno-mmx
8120 @item -msse
8121 @itemx -mno-sse
8122 @item -msse2
8123 @itemx -mno-sse2
8124 @item -m3dnow
8125 @itemx -mno-3dnow
8126 @opindex mmmx
8127 @opindex mno-mmx
8128 @opindex msse
8129 @opindex mno-sse
8130 @opindex m3dnow
8131 @opindex mno-3dnow
8132 These switches enable or disable the use of built-in functions that allow
8133 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8134
8135 @xref{X86 Built-in Functions}, for details of the functions enabled
8136 and disabled by these switches.
8137
8138 To have SSE/SSE2 instructions generated automatically from floating-point
8139 code, see @option{-mfpmath=sse}.
8140
8141 @item -mpush-args
8142 @itemx -mno-push-args
8143 @opindex mpush-args
8144 @opindex mno-push-args
8145 Use PUSH operations to store outgoing parameters.  This method is shorter
8146 and usually equally fast as method using SUB/MOV operations and is enabled
8147 by default.  In some cases disabling it may improve performance because of
8148 improved scheduling and reduced dependencies.
8149
8150 @item -maccumulate-outgoing-args
8151 @opindex maccumulate-outgoing-args
8152 If enabled, the maximum amount of space required for outgoing arguments will be
8153 computed in the function prologue.  This is faster on most modern CPUs
8154 because of reduced dependencies, improved scheduling and reduced stack usage
8155 when preferred stack boundary is not equal to 2.  The drawback is a notable
8156 increase in code size.  This switch implies @option{-mno-push-args}.
8157
8158 @item -mthreads
8159 @opindex mthreads
8160 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8161 on thread-safe exception handling must compile and link all code with the
8162 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8163 @option{-D_MT}; when linking, it links in a special thread helper library
8164 @option{-lmingwthrd} which cleans up per thread exception handling data.
8165
8166 @item -mno-align-stringops
8167 @opindex mno-align-stringops
8168 Do not align destination of inlined string operations.  This switch reduces
8169 code size and improves performance in case the destination is already aligned,
8170 but gcc don't know about it.
8171
8172 @item -minline-all-stringops
8173 @opindex minline-all-stringops
8174 By default GCC inlines string operations only when destination is known to be
8175 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8176 size, but may improve performance of code that depends on fast memcpy, strlen
8177 and memset for short lengths.
8178
8179 @item -momit-leaf-frame-pointer
8180 @opindex momit-leaf-frame-pointer
8181 Don't keep the frame pointer in a register for leaf functions.  This
8182 avoids the instructions to save, set up and restore frame pointers and
8183 makes an extra register available in leaf functions.  The option
8184 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8185 which might make debugging harder.
8186 @end table
8187
8188 These @samp{-m} switches are supported in addition to the above
8189 on AMD x86-64 processors in 64-bit environments.
8190
8191 @table @gcctabopt
8192 @item -m32
8193 @itemx -m64
8194 @opindex m32
8195 @opindex m64
8196 Generate code for a 32-bit or 64-bit environment.
8197 The 32-bit environment sets int, long and pointer to 32 bits and
8198 generates code that runs on any i386 system.
8199 The 64-bit environment sets int to 32 bits and long and pointer
8200 to 64 bits and generates code for AMD's x86-64 architecture.
8201
8202 @item -mno-red-zone
8203 @opindex no-red-zone
8204 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8205 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8206 stack pointer that will not be modified by signal or interrupt handlers
8207 and therefore can be used for temporary data without adjusting the stack
8208 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8209
8210 @item -mcmodel=small
8211 @opindex mcmodel=small
8212 Generate code for the small code model: the program and its symbols must
8213 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8214 Programs can be statically or dynamically linked.  This is the default
8215 code model.
8216
8217 @item -mcmodel=kernel
8218 @opindex mcmodel=kernel
8219 Generate code for the kernel code model.  The kernel runs in the
8220 negative 2 GB of the address space.
8221 This model has to be used for Linux kernel code.
8222
8223 @item -mcmodel=medium
8224 @opindex mcmodel=medium
8225 Generate code for the medium model: The program is linked in the lower 2
8226 GB of the address space but symbols can be located anywhere in the
8227 address space.  Programs can be statically or dynamically linked, but
8228 building of shared libraries are not supported with the medium model.
8229
8230 @item -mcmodel=large
8231 @opindex mcmodel=large
8232 Generate code for the large model: This model makes no assumptions
8233 about addresses and sizes of sections.  Currently GCC does not implement
8234 this model.
8235 @end table
8236
8237 @node HPPA Options
8238 @subsection HPPA Options
8239 @cindex HPPA Options
8240
8241 These @samp{-m} options are defined for the HPPA family of computers:
8242
8243 @table @gcctabopt
8244 @item -march=@var{architecture-type}
8245 @opindex march
8246 Generate code for the specified architecture.  The choices for
8247 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8248 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8249 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8250 architecture option for your machine.  Code compiled for lower numbered
8251 architectures will run on higher numbered architectures, but not the
8252 other way around.
8253
8254 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8255 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8256 support.
8257
8258 @item -mpa-risc-1-0
8259 @itemx -mpa-risc-1-1
8260 @itemx -mpa-risc-2-0
8261 @opindex mpa-risc-1-0
8262 @opindex mpa-risc-1-1
8263 @opindex mpa-risc-2-0
8264 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8265
8266 @item -mbig-switch
8267 @opindex mbig-switch
8268 Generate code suitable for big switch tables.  Use this option only if
8269 the assembler/linker complain about out of range branches within a switch
8270 table.
8271
8272 @item -mjump-in-delay
8273 @opindex mjump-in-delay
8274 Fill delay slots of function calls with unconditional jump instructions
8275 by modifying the return pointer for the function call to be the target
8276 of the conditional jump.
8277
8278 @item -mdisable-fpregs
8279 @opindex mdisable-fpregs
8280 Prevent floating point registers from being used in any manner.  This is
8281 necessary for compiling kernels which perform lazy context switching of
8282 floating point registers.  If you use this option and attempt to perform
8283 floating point operations, the compiler will abort.
8284
8285 @item -mdisable-indexing
8286 @opindex mdisable-indexing
8287 Prevent the compiler from using indexing address modes.  This avoids some
8288 rather obscure problems when compiling MIG generated code under MACH@.
8289
8290 @item -mno-space-regs
8291 @opindex mno-space-regs
8292 Generate code that assumes the target has no space registers.  This allows
8293 GCC to generate faster indirect calls and use unscaled index address modes.
8294
8295 Such code is suitable for level 0 PA systems and kernels.
8296
8297 @item -mfast-indirect-calls
8298 @opindex mfast-indirect-calls
8299 Generate code that assumes calls never cross space boundaries.  This
8300 allows GCC to emit code which performs faster indirect calls.
8301
8302 This option will not work in the presence of shared libraries or nested
8303 functions.
8304
8305 @item -mlong-load-store
8306 @opindex mlong-load-store
8307 Generate 3-instruction load and store sequences as sometimes required by
8308 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8309 the HP compilers.
8310
8311 @item -mportable-runtime
8312 @opindex mportable-runtime
8313 Use the portable calling conventions proposed by HP for ELF systems.
8314
8315 @item -mgas
8316 @opindex mgas
8317 Enable the use of assembler directives only GAS understands.
8318
8319 @item -mschedule=@var{cpu-type}
8320 @opindex mschedule
8321 Schedule code according to the constraints for the machine type
8322 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8323 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8324 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8325 proper scheduling option for your machine.  The default scheduling is
8326 @samp{8000}.
8327
8328 @item -mlinker-opt
8329 @opindex mlinker-opt
8330 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8331 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8332 linkers in which they give bogus error messages when linking some programs.
8333
8334 @item -msoft-float
8335 @opindex msoft-float
8336 Generate output containing library calls for floating point.
8337 @strong{Warning:} the requisite libraries are not available for all HPPA
8338 targets.  Normally the facilities of the machine's usual C compiler are
8339 used, but this cannot be done directly in cross-compilation.  You must make
8340 your own arrangements to provide suitable library functions for
8341 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8342 does provide software floating point support.
8343
8344 @option{-msoft-float} changes the calling convention in the output file;
8345 therefore, it is only useful if you compile @emph{all} of a program with
8346 this option.  In particular, you need to compile @file{libgcc.a}, the
8347 library that comes with GCC, with @option{-msoft-float} in order for
8348 this to work.
8349
8350 @item -msio
8351 @opindex msio
8352 Generate the predefine, @code{_SIO}, for server IO.  The default is
8353 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8354 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8355 options are available under HP-UX and HI-UX.
8356
8357 @item -mgnu-ld
8358 @opindex gnu-ld
8359 Use GNU ld specific options.  This passes @option{-shared} to ld when
8360 building a shared library.  It is the default when GCC is configured,
8361 explicitly or implicitly, with the GNU linker.  This option does not
8362 have any affect on which ld is called, it only changes what parameters
8363 are passed to that ld.  The ld that is called is determined by the
8364 @option{--with-ld} configure option, gcc's program search path, and
8365 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8366 using @samp{which `gcc -print-prog-name=ld`}.
8367
8368 @item -mhp-ld
8369 @opindex hp-ld
8370 Use HP ld specific options.  This passes @option{-b} to ld when building
8371 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8372 links.  It is the default when GCC is configured, explicitly or
8373 implicitly, with the HP linker.  This option does not have any affect on
8374 which ld is called, it only changes what parameters are passed to that
8375 ld.  The ld that is called is determined by the @option{--with-ld}
8376 configure option, gcc's program search path, and finally by the user's
8377 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8378 `gcc -print-prog-name=ld`}.
8379
8380 @item -mlong-calls
8381 @opindex mno-long-calls
8382 Generate code that uses long call sequences.  This ensures that a call
8383 is always able to reach linker generated stubs.  The default is to generate
8384 long calls only when the distance from the call site to the beginning
8385 of the function or translation unit, as the case may be, exceeds a
8386 predefined limit set by the branch type being used.  The limits for
8387 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8388 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8389 240,000 bytes.
8390
8391 Distances are measured from the beginning of functions when using the
8392 @option{-ffunction-sections} option, or when using the @option{-mgas}
8393 and @option{-mno-portable-runtime} options together under HP-UX with
8394 the SOM linker.
8395
8396 It is normally not desirable to use this option as it will degrade
8397 performance.  However, it may be useful in large applications,
8398 particularly when partial linking is used to build the application.
8399
8400 The types of long calls used depends on the capabilities of the
8401 assembler and linker, and the type of code being generated.  The
8402 impact on systems that support long absolute calls, and long pic
8403 symbol-difference or pc-relative calls should be relatively small.
8404 However, an indirect call is used on 32-bit ELF systems in pic code
8405 and it is quite long.
8406
8407 @end table
8408
8409 @node Intel 960 Options
8410 @subsection Intel 960 Options
8411
8412 These @samp{-m} options are defined for the Intel 960 implementations:
8413
8414 @table @gcctabopt
8415 @item -m@var{cpu-type}
8416 @opindex mka
8417 @opindex mkb
8418 @opindex mmc
8419 @opindex mca
8420 @opindex mcf
8421 @opindex msa
8422 @opindex msb
8423 Assume the defaults for the machine type @var{cpu-type} for some of
8424 the other options, including instruction scheduling, floating point
8425 support, and addressing modes.  The choices for @var{cpu-type} are
8426 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8427 @samp{sa}, and @samp{sb}.
8428 The default is
8429 @samp{kb}.
8430
8431 @item -mnumerics
8432 @itemx -msoft-float
8433 @opindex mnumerics
8434 @opindex msoft-float
8435 The @option{-mnumerics} option indicates that the processor does support
8436 floating-point instructions.  The @option{-msoft-float} option indicates
8437 that floating-point support should not be assumed.
8438
8439 @item -mleaf-procedures
8440 @itemx -mno-leaf-procedures
8441 @opindex mleaf-procedures
8442 @opindex mno-leaf-procedures
8443 Do (or do not) attempt to alter leaf procedures to be callable with the
8444 @code{bal} instruction as well as @code{call}.  This will result in more
8445 efficient code for explicit calls when the @code{bal} instruction can be
8446 substituted by the assembler or linker, but less efficient code in other
8447 cases, such as calls via function pointers, or using a linker that doesn't
8448 support this optimization.
8449
8450 @item -mtail-call
8451 @itemx -mno-tail-call
8452 @opindex mtail-call
8453 @opindex mno-tail-call
8454 Do (or do not) make additional attempts (beyond those of the
8455 machine-independent portions of the compiler) to optimize tail-recursive
8456 calls into branches.  You may not want to do this because the detection of
8457 cases where this is not valid is not totally complete.  The default is
8458 @option{-mno-tail-call}.
8459
8460 @item -mcomplex-addr
8461 @itemx -mno-complex-addr
8462 @opindex mcomplex-addr
8463 @opindex mno-complex-addr
8464 Assume (or do not assume) that the use of a complex addressing mode is a
8465 win on this implementation of the i960.  Complex addressing modes may not
8466 be worthwhile on the K-series, but they definitely are on the C-series.
8467 The default is currently @option{-mcomplex-addr} for all processors except
8468 the CB and CC@.
8469
8470 @item -mcode-align
8471 @itemx -mno-code-align
8472 @opindex mcode-align
8473 @opindex mno-code-align
8474 Align code to 8-byte boundaries for faster fetching (or don't bother).
8475 Currently turned on by default for C-series implementations only.
8476
8477 @ignore
8478 @item -mclean-linkage
8479 @itemx -mno-clean-linkage
8480 @opindex mclean-linkage
8481 @opindex mno-clean-linkage
8482 These options are not fully implemented.
8483 @end ignore
8484
8485 @item -mic-compat
8486 @itemx -mic2.0-compat
8487 @itemx -mic3.0-compat
8488 @opindex mic-compat
8489 @opindex mic2.0-compat
8490 @opindex mic3.0-compat
8491 Enable compatibility with iC960 v2.0 or v3.0.
8492
8493 @item -masm-compat
8494 @itemx -mintel-asm
8495 @opindex masm-compat
8496 @opindex mintel-asm
8497 Enable compatibility with the iC960 assembler.
8498
8499 @item -mstrict-align
8500 @itemx -mno-strict-align
8501 @opindex mstrict-align
8502 @opindex mno-strict-align
8503 Do not permit (do permit) unaligned accesses.
8504
8505 @item -mold-align
8506 @opindex mold-align
8507 Enable structure-alignment compatibility with Intel's gcc release version
8508 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8509
8510 @item -mlong-double-64
8511 @opindex mlong-double-64
8512 Implement type @samp{long double} as 64-bit floating point numbers.
8513 Without the option @samp{long double} is implemented by 80-bit
8514 floating point numbers.  The only reason we have it because there is
8515 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8516 is only useful for people using soft-float targets.  Otherwise, we
8517 should recommend against use of it.
8518
8519 @end table
8520
8521 @node DEC Alpha Options
8522 @subsection DEC Alpha Options
8523
8524 These @samp{-m} options are defined for the DEC Alpha implementations:
8525
8526 @table @gcctabopt
8527 @item -mno-soft-float
8528 @itemx -msoft-float
8529 @opindex mno-soft-float
8530 @opindex msoft-float
8531 Use (do not use) the hardware floating-point instructions for
8532 floating-point operations.  When @option{-msoft-float} is specified,
8533 functions in @file{libgcc.a} will be used to perform floating-point
8534 operations.  Unless they are replaced by routines that emulate the
8535 floating-point operations, or compiled in such a way as to call such
8536 emulations routines, these routines will issue floating-point
8537 operations.   If you are compiling for an Alpha without floating-point
8538 operations, you must ensure that the library is built so as not to call
8539 them.
8540
8541 Note that Alpha implementations without floating-point operations are
8542 required to have floating-point registers.
8543
8544 @item -mfp-reg
8545 @itemx -mno-fp-regs
8546 @opindex mfp-reg
8547 @opindex mno-fp-regs
8548 Generate code that uses (does not use) the floating-point register set.
8549 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8550 register set is not used, floating point operands are passed in integer
8551 registers as if they were integers and floating-point results are passed
8552 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8553 so any function with a floating-point argument or return value called by code
8554 compiled with @option{-mno-fp-regs} must also be compiled with that
8555 option.
8556
8557 A typical use of this option is building a kernel that does not use,
8558 and hence need not save and restore, any floating-point registers.
8559
8560 @item -mieee
8561 @opindex mieee
8562 The Alpha architecture implements floating-point hardware optimized for
8563 maximum performance.  It is mostly compliant with the IEEE floating
8564 point standard.  However, for full compliance, software assistance is
8565 required.  This option generates code fully IEEE compliant code
8566 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8567 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8568 defined during compilation.  The resulting code is less efficient but is
8569 able to correctly support denormalized numbers and exceptional IEEE
8570 values such as not-a-number and plus/minus infinity.  Other Alpha
8571 compilers call this option @option{-ieee_with_no_inexact}.
8572
8573 @item -mieee-with-inexact
8574 @opindex mieee-with-inexact
8575 This is like @option{-mieee} except the generated code also maintains
8576 the IEEE @var{inexact-flag}.  Turning on this option causes the
8577 generated code to implement fully-compliant IEEE math.  In addition to
8578 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8579 macro.  On some Alpha implementations the resulting code may execute
8580 significantly slower than the code generated by default.  Since there is
8581 very little code that depends on the @var{inexact-flag}, you should
8582 normally not specify this option.  Other Alpha compilers call this
8583 option @option{-ieee_with_inexact}.
8584
8585 @item -mfp-trap-mode=@var{trap-mode}
8586 @opindex mfp-trap-mode
8587 This option controls what floating-point related traps are enabled.
8588 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8589 The trap mode can be set to one of four values:
8590
8591 @table @samp
8592 @item n
8593 This is the default (normal) setting.  The only traps that are enabled
8594 are the ones that cannot be disabled in software (e.g., division by zero
8595 trap).
8596
8597 @item u
8598 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8599 as well.
8600
8601 @item su
8602 Like @samp{su}, but the instructions are marked to be safe for software
8603 completion (see Alpha architecture manual for details).
8604
8605 @item sui
8606 Like @samp{su}, but inexact traps are enabled as well.
8607 @end table
8608
8609 @item -mfp-rounding-mode=@var{rounding-mode}
8610 @opindex mfp-rounding-mode
8611 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8612 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8613 of:
8614
8615 @table @samp
8616 @item n
8617 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8618 the nearest machine number or towards the even machine number in case
8619 of a tie.
8620
8621 @item m
8622 Round towards minus infinity.
8623
8624 @item c
8625 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8626
8627 @item d
8628 Dynamic rounding mode.  A field in the floating point control register
8629 (@var{fpcr}, see Alpha architecture reference manual) controls the
8630 rounding mode in effect.  The C library initializes this register for
8631 rounding towards plus infinity.  Thus, unless your program modifies the
8632 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8633 @end table
8634
8635 @item -mtrap-precision=@var{trap-precision}
8636 @opindex mtrap-precision
8637 In the Alpha architecture, floating point traps are imprecise.  This
8638 means without software assistance it is impossible to recover from a
8639 floating trap and program execution normally needs to be terminated.
8640 GCC can generate code that can assist operating system trap handlers
8641 in determining the exact location that caused a floating point trap.
8642 Depending on the requirements of an application, different levels of
8643 precisions can be selected:
8644
8645 @table @samp
8646 @item p
8647 Program precision.  This option is the default and means a trap handler
8648 can only identify which program caused a floating point exception.
8649
8650 @item f
8651 Function precision.  The trap handler can determine the function that
8652 caused a floating point exception.
8653
8654 @item i
8655 Instruction precision.  The trap handler can determine the exact
8656 instruction that caused a floating point exception.
8657 @end table
8658
8659 Other Alpha compilers provide the equivalent options called
8660 @option{-scope_safe} and @option{-resumption_safe}.
8661
8662 @item -mieee-conformant
8663 @opindex mieee-conformant
8664 This option marks the generated code as IEEE conformant.  You must not
8665 use this option unless you also specify @option{-mtrap-precision=i} and either
8666 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8667 is to emit the line @samp{.eflag 48} in the function prologue of the
8668 generated assembly file.  Under DEC Unix, this has the effect that
8669 IEEE-conformant math library routines will be linked in.
8670
8671 @item -mbuild-constants
8672 @opindex mbuild-constants
8673 Normally GCC examines a 32- or 64-bit integer constant to
8674 see if it can construct it from smaller constants in two or three
8675 instructions.  If it cannot, it will output the constant as a literal and
8676 generate code to load it from the data segment at runtime.
8677
8678 Use this option to require GCC to construct @emph{all} integer constants
8679 using code, even if it takes more instructions (the maximum is six).
8680
8681 You would typically use this option to build a shared library dynamic
8682 loader.  Itself a shared library, it must relocate itself in memory
8683 before it can find the variables and constants in its own data segment.
8684
8685 @item -malpha-as
8686 @itemx -mgas
8687 @opindex malpha-as
8688 @opindex mgas
8689 Select whether to generate code to be assembled by the vendor-supplied
8690 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8691
8692 @item -mbwx
8693 @itemx -mno-bwx
8694 @itemx -mcix
8695 @itemx -mno-cix
8696 @itemx -mfix
8697 @itemx -mno-fix
8698 @itemx -mmax
8699 @itemx -mno-max
8700 @opindex mbwx
8701 @opindex mno-bwx
8702 @opindex mcix
8703 @opindex mno-cix
8704 @opindex mfix
8705 @opindex mno-fix
8706 @opindex mmax
8707 @opindex mno-max
8708 Indicate whether GCC should generate code to use the optional BWX,
8709 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8710 sets supported by the CPU type specified via @option{-mcpu=} option or that
8711 of the CPU on which GCC was built if none was specified.
8712
8713 @item -mfloat-vax
8714 @itemx -mfloat-ieee
8715 @opindex mfloat-vax
8716 @opindex mfloat-ieee
8717 Generate code that uses (does not use) VAX F and G floating point
8718 arithmetic instead of IEEE single and double precision.
8719
8720 @item -mexplicit-relocs
8721 @itemx -mno-explicit-relocs
8722 @opindex mexplicit-relocs
8723 @opindex mno-explicit-relocs
8724 Older Alpha assemblers provided no way to generate symbol relocations
8725 except via assembler macros.  Use of these macros does not allow
8726 optimal instruction scheduling.  GNU binutils as of version 2.12
8727 supports a new syntax that allows the compiler to explicitly mark
8728 which relocations should apply to which instructions.  This option
8729 is mostly useful for debugging, as GCC detects the capabilities of
8730 the assembler when it is built and sets the default accordingly.
8731
8732 @item -msmall-data
8733 @itemx -mlarge-data
8734 @opindex msmall-data
8735 @opindex mlarge-data
8736 When @option{-mexplicit-relocs} is in effect, static data is
8737 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8738 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8739 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8740 16-bit relocations off of the @code{$gp} register.  This limits the
8741 size of the small data area to 64KB, but allows the variables to be
8742 directly accessed via a single instruction.
8743
8744 The default is @option{-mlarge-data}.  With this option the data area
8745 is limited to just below 2GB.  Programs that require more than 2GB of
8746 data must use @code{malloc} or @code{mmap} to allocate the data in the
8747 heap instead of in the program's data segment.
8748
8749 When generating code for shared libraries, @option{-fpic} implies
8750 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8751
8752 @item -mcpu=@var{cpu_type}
8753 @opindex mcpu
8754 Set the instruction set and instruction scheduling parameters for
8755 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8756 style name or the corresponding chip number.  GCC supports scheduling
8757 parameters for the EV4, EV5 and EV6 family of processors and will
8758 choose the default values for the instruction set from the processor
8759 you specify.  If you do not specify a processor type, GCC will default
8760 to the processor on which the compiler was built.
8761
8762 Supported values for @var{cpu_type} are
8763
8764 @table @samp
8765 @item ev4
8766 @item ev45
8767 @itemx 21064
8768 Schedules as an EV4 and has no instruction set extensions.
8769
8770 @item ev5
8771 @itemx 21164
8772 Schedules as an EV5 and has no instruction set extensions.
8773
8774 @item ev56
8775 @itemx 21164a
8776 Schedules as an EV5 and supports the BWX extension.
8777
8778 @item pca56
8779 @itemx 21164pc
8780 @itemx 21164PC
8781 Schedules as an EV5 and supports the BWX and MAX extensions.
8782
8783 @item ev6
8784 @itemx 21264
8785 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8786
8787 @item ev67
8788 @item 21264a
8789 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8790 @end table
8791
8792 @item -mtune=@var{cpu_type}
8793 @opindex mtune
8794 Set only the instruction scheduling parameters for machine type
8795 @var{cpu_type}.  The instruction set is not changed.
8796
8797 @item -mmemory-latency=@var{time}
8798 @opindex mmemory-latency
8799 Sets the latency the scheduler should assume for typical memory
8800 references as seen by the application.  This number is highly
8801 dependent on the memory access patterns used by the application
8802 and the size of the external cache on the machine.
8803
8804 Valid options for @var{time} are
8805
8806 @table @samp
8807 @item @var{number}
8808 A decimal number representing clock cycles.
8809
8810 @item L1
8811 @itemx L2
8812 @itemx L3
8813 @itemx main
8814 The compiler contains estimates of the number of clock cycles for
8815 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8816 (also called Dcache, Scache, and Bcache), as well as to main memory.
8817 Note that L3 is only valid for EV5.
8818
8819 @end table
8820 @end table
8821
8822 @node DEC Alpha/VMS Options
8823 @subsection DEC Alpha/VMS Options
8824
8825 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8826
8827 @table @gcctabopt
8828 @item -mvms-return-codes
8829 @opindex mvms-return-codes
8830 Return VMS condition codes from main.  The default is to return POSIX
8831 style condition (e.g.@ error) codes.
8832 @end table
8833
8834 @node Clipper Options
8835 @subsection Clipper Options
8836
8837 These @samp{-m} options are defined for the Clipper implementations:
8838
8839 @table @gcctabopt
8840 @item -mc300
8841 @opindex mc300
8842 Produce code for a C300 Clipper processor.  This is the default.
8843
8844 @item -mc400
8845 @opindex mc400
8846 Produce code for a C400 Clipper processor, i.e.@: use floating point
8847 registers f8--f15.
8848 @end table
8849
8850 @node H8/300 Options
8851 @subsection H8/300 Options
8852
8853 These @samp{-m} options are defined for the H8/300 implementations:
8854
8855 @table @gcctabopt
8856 @item -mrelax
8857 @opindex mrelax
8858 Shorten some address references at link time, when possible; uses the
8859 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8860 ld.info, Using ld}, for a fuller description.
8861
8862 @item -mh
8863 @opindex mh
8864 Generate code for the H8/300H@.
8865
8866 @item -ms
8867 @opindex ms
8868 Generate code for the H8S@.
8869
8870 @item -mn
8871 @opindex mn
8872 Generate code for the H8S and H8/300H in the normal mode.  This switch
8873 must be used either with -mh or -ms.
8874
8875 @item -ms2600
8876 @opindex ms2600
8877 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8878
8879 @item -mint32
8880 @opindex mint32
8881 Make @code{int} data 32 bits by default.
8882
8883 @item -malign-300
8884 @opindex malign-300
8885 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8886 The default for the H8/300H and H8S is to align longs and floats on 4
8887 byte boundaries.
8888 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8889 This option has no effect on the H8/300.
8890 @end table
8891
8892 @node SH Options
8893 @subsection SH Options
8894
8895 These @samp{-m} options are defined for the SH implementations:
8896
8897 @table @gcctabopt
8898 @item -m1
8899 @opindex m1
8900 Generate code for the SH1.
8901
8902 @item -m2
8903 @opindex m2
8904 Generate code for the SH2.
8905
8906 @item -m3
8907 @opindex m3
8908 Generate code for the SH3.
8909
8910 @item -m3e
8911 @opindex m3e
8912 Generate code for the SH3e.
8913
8914 @item -m4-nofpu
8915 @opindex m4-nofpu
8916 Generate code for the SH4 without a floating-point unit.
8917
8918 @item -m4-single-only
8919 @opindex m4-single-only
8920 Generate code for the SH4 with a floating-point unit that only
8921 supports single-precision arithmetic.
8922
8923 @item -m4-single
8924 @opindex m4-single
8925 Generate code for the SH4 assuming the floating-point unit is in
8926 single-precision mode by default.
8927
8928 @item -m4
8929 @opindex m4
8930 Generate code for the SH4.
8931
8932 @item -mb
8933 @opindex mb
8934 Compile code for the processor in big endian mode.
8935
8936 @item -ml
8937 @opindex ml
8938 Compile code for the processor in little endian mode.
8939
8940 @item -mdalign
8941 @opindex mdalign
8942 Align doubles at 64-bit boundaries.  Note that this changes the calling
8943 conventions, and thus some functions from the standard C library will
8944 not work unless you recompile it first with @option{-mdalign}.
8945
8946 @item -mrelax
8947 @opindex mrelax
8948 Shorten some address references at link time, when possible; uses the
8949 linker option @option{-relax}.
8950
8951 @item -mbigtable
8952 @opindex mbigtable
8953 Use 32-bit offsets in @code{switch} tables.  The default is to use
8954 16-bit offsets.
8955
8956 @item -mfmovd
8957 @opindex mfmovd
8958 Enable the use of the instruction @code{fmovd}.
8959
8960 @item -mhitachi
8961 @opindex mhitachi
8962 Comply with the calling conventions defined by Hitachi.
8963
8964 @item -mnomacsave
8965 @opindex mnomacsave
8966 Mark the @code{MAC} register as call-clobbered, even if
8967 @option{-mhitachi} is given.
8968
8969 @item -mieee
8970 @opindex mieee
8971 Increase IEEE-compliance of floating-point code.
8972
8973 @item -misize
8974 @opindex misize
8975 Dump instruction size and location in the assembly code.
8976
8977 @item -mpadstruct
8978 @opindex mpadstruct
8979 This option is deprecated.  It pads structures to multiple of 4 bytes,
8980 which is incompatible with the SH ABI@.
8981
8982 @item -mspace
8983 @opindex mspace
8984 Optimize for space instead of speed.  Implied by @option{-Os}.
8985
8986 @item -mprefergot
8987 @opindex mprefergot
8988 When generating position-independent code, emit function calls using
8989 the Global Offset Table instead of the Procedure Linkage Table.
8990
8991 @item -musermode
8992 @opindex musermode
8993 Generate a library function call to invalidate instruction cache
8994 entries, after fixing up a trampoline.  This library function call
8995 doesn't assume it can write to the whole memory address space.  This
8996 is the default when the target is @code{sh-*-linux*}.
8997 @end table
8998
8999 @node System V Options
9000 @subsection Options for System V
9001
9002 These additional options are available on System V Release 4 for
9003 compatibility with other compilers on those systems:
9004
9005 @table @gcctabopt
9006 @item -G
9007 @opindex G
9008 Create a shared object.
9009 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9010
9011 @item -Qy
9012 @opindex Qy
9013 Identify the versions of each tool used by the compiler, in a
9014 @code{.ident} assembler directive in the output.
9015
9016 @item -Qn
9017 @opindex Qn
9018 Refrain from adding @code{.ident} directives to the output file (this is
9019 the default).
9020
9021 @item -YP,@var{dirs}
9022 @opindex YP
9023 Search the directories @var{dirs}, and no others, for libraries
9024 specified with @option{-l}.
9025
9026 @item -Ym,@var{dir}
9027 @opindex Ym
9028 Look in the directory @var{dir} to find the M4 preprocessor.
9029 The assembler uses this option.
9030 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9031 @c the generic assembler that comes with Solaris takes just -Ym.
9032 @end table
9033
9034 @node TMS320C3x/C4x Options
9035 @subsection TMS320C3x/C4x Options
9036 @cindex TMS320C3x/C4x Options
9037
9038 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9039
9040 @table @gcctabopt
9041
9042 @item -mcpu=@var{cpu_type}
9043 @opindex mcpu
9044 Set the instruction set, register set, and instruction scheduling
9045 parameters for machine type @var{cpu_type}.  Supported values for
9046 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9047 @samp{c44}.  The default is @samp{c40} to generate code for the
9048 TMS320C40.
9049
9050 @item -mbig-memory
9051 @item -mbig
9052 @itemx -msmall-memory
9053 @itemx -msmall
9054 @opindex mbig-memory
9055 @opindex mbig
9056 @opindex msmall-memory
9057 @opindex msmall
9058 Generates code for the big or small memory model.  The small memory
9059 model assumed that all data fits into one 64K word page.  At run-time
9060 the data page (DP) register must be set to point to the 64K page
9061 containing the .bss and .data program sections.  The big memory model is
9062 the default and requires reloading of the DP register for every direct
9063 memory access.
9064
9065 @item -mbk
9066 @itemx -mno-bk
9067 @opindex mbk
9068 @opindex mno-bk
9069 Allow (disallow) allocation of general integer operands into the block
9070 count register BK@.
9071
9072 @item -mdb
9073 @itemx -mno-db
9074 @opindex mdb
9075 @opindex mno-db
9076 Enable (disable) generation of code using decrement and branch,
9077 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9078 on the safe side, this is disabled for the C3x, since the maximum
9079 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9080 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9081 that it can utilize the decrement and branch instruction, but will give
9082 up if there is more than one memory reference in the loop.  Thus a loop
9083 where the loop counter is decremented can generate slightly more
9084 efficient code, in cases where the RPTB instruction cannot be utilized.
9085
9086 @item -mdp-isr-reload
9087 @itemx -mparanoid
9088 @opindex mdp-isr-reload
9089 @opindex mparanoid
9090 Force the DP register to be saved on entry to an interrupt service
9091 routine (ISR), reloaded to point to the data section, and restored on
9092 exit from the ISR@.  This should not be required unless someone has
9093 violated the small memory model by modifying the DP register, say within
9094 an object library.
9095
9096 @item -mmpyi
9097 @itemx -mno-mpyi
9098 @opindex mmpyi
9099 @opindex mno-mpyi
9100 For the C3x use the 24-bit MPYI instruction for integer multiplies
9101 instead of a library call to guarantee 32-bit results.  Note that if one
9102 of the operands is a constant, then the multiplication will be performed
9103 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9104 then squaring operations are performed inline instead of a library call.
9105
9106 @item -mfast-fix
9107 @itemx -mno-fast-fix
9108 @opindex mfast-fix
9109 @opindex mno-fast-fix
9110 The C3x/C4x FIX instruction to convert a floating point value to an
9111 integer value chooses the nearest integer less than or equal to the
9112 floating point value rather than to the nearest integer.  Thus if the
9113 floating point number is negative, the result will be incorrectly
9114 truncated an additional code is necessary to detect and correct this
9115 case.  This option can be used to disable generation of the additional
9116 code required to correct the result.
9117
9118 @item -mrptb
9119 @itemx -mno-rptb
9120 @opindex mrptb
9121 @opindex mno-rptb
9122 Enable (disable) generation of repeat block sequences using the RPTB
9123 instruction for zero overhead looping.  The RPTB construct is only used
9124 for innermost loops that do not call functions or jump across the loop
9125 boundaries.  There is no advantage having nested RPTB loops due to the
9126 overhead required to save and restore the RC, RS, and RE registers.
9127 This is enabled by default with @option{-O2}.
9128
9129 @item -mrpts=@var{count}
9130 @itemx -mno-rpts
9131 @opindex mrpts
9132 @opindex mno-rpts
9133 Enable (disable) the use of the single instruction repeat instruction
9134 RPTS@.  If a repeat block contains a single instruction, and the loop
9135 count can be guaranteed to be less than the value @var{count}, GCC will
9136 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9137 then a RPTS will be emitted even if the loop count cannot be determined
9138 at compile time.  Note that the repeated instruction following RPTS does
9139 not have to be reloaded from memory each iteration, thus freeing up the
9140 CPU buses for operands.  However, since interrupts are blocked by this
9141 instruction, it is disabled by default.
9142
9143 @item -mloop-unsigned
9144 @itemx -mno-loop-unsigned
9145 @opindex mloop-unsigned
9146 @opindex mno-loop-unsigned
9147 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9148 is @math{2^{31} + 1} since these instructions test if the iteration count is
9149 negative to terminate the loop.  If the iteration count is unsigned
9150 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9151 exceeded.  This switch allows an unsigned iteration count.
9152
9153 @item -mti
9154 @opindex mti
9155 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9156 with.  This also enforces compatibility with the API employed by the TI
9157 C3x C compiler.  For example, long doubles are passed as structures
9158 rather than in floating point registers.
9159
9160 @item -mregparm
9161 @itemx -mmemparm
9162 @opindex mregparm
9163 @opindex mmemparm
9164 Generate code that uses registers (stack) for passing arguments to functions.
9165 By default, arguments are passed in registers where possible rather
9166 than by pushing arguments on to the stack.
9167
9168 @item -mparallel-insns
9169 @itemx -mno-parallel-insns
9170 @opindex mparallel-insns
9171 @opindex mno-parallel-insns
9172 Allow the generation of parallel instructions.  This is enabled by
9173 default with @option{-O2}.
9174
9175 @item -mparallel-mpy
9176 @itemx -mno-parallel-mpy
9177 @opindex mparallel-mpy
9178 @opindex mno-parallel-mpy
9179 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9180 provided @option{-mparallel-insns} is also specified.  These instructions have
9181 tight register constraints which can pessimize the code generation
9182 of large functions.
9183
9184 @end table
9185
9186 @node V850 Options
9187 @subsection V850 Options
9188 @cindex V850 Options
9189
9190 These @samp{-m} options are defined for V850 implementations:
9191
9192 @table @gcctabopt
9193 @item -mlong-calls
9194 @itemx -mno-long-calls
9195 @opindex mlong-calls
9196 @opindex mno-long-calls
9197 Treat all calls as being far away (near).  If calls are assumed to be
9198 far away, the compiler will always load the functions address up into a
9199 register, and call indirect through the pointer.
9200
9201 @item -mno-ep
9202 @itemx -mep
9203 @opindex mno-ep
9204 @opindex mep
9205 Do not optimize (do optimize) basic blocks that use the same index
9206 pointer 4 or more times to copy pointer into the @code{ep} register, and
9207 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9208 option is on by default if you optimize.
9209
9210 @item -mno-prolog-function
9211 @itemx -mprolog-function
9212 @opindex mno-prolog-function
9213 @opindex mprolog-function
9214 Do not use (do use) external functions to save and restore registers at
9215 the prolog and epilog of a function.  The external functions are slower,
9216 but use less code space if more than one function saves the same number
9217 of registers.  The @option{-mprolog-function} option is on by default if
9218 you optimize.
9219
9220 @item -mspace
9221 @opindex mspace
9222 Try to make the code as small as possible.  At present, this just turns
9223 on the @option{-mep} and @option{-mprolog-function} options.
9224
9225 @item -mtda=@var{n}
9226 @opindex mtda
9227 Put static or global variables whose size is @var{n} bytes or less into
9228 the tiny data area that register @code{ep} points to.  The tiny data
9229 area can hold up to 256 bytes in total (128 bytes for byte references).
9230
9231 @item -msda=@var{n}
9232 @opindex msda
9233 Put static or global variables whose size is @var{n} bytes or less into
9234 the small data area that register @code{gp} points to.  The small data
9235 area can hold up to 64 kilobytes.
9236
9237 @item -mzda=@var{n}
9238 @opindex mzda
9239 Put static or global variables whose size is @var{n} bytes or less into
9240 the first 32 kilobytes of memory.
9241
9242 @item -mv850
9243 @opindex mv850
9244 Specify that the target processor is the V850.
9245
9246 @item -mbig-switch
9247 @opindex mbig-switch
9248 Generate code suitable for big switch tables.  Use this option only if
9249 the assembler/linker complain about out of range branches within a switch
9250 table.
9251
9252 @item -mapp-regs
9253 @opindex -mapp-regs
9254 This option will cause r2 and r5 to be used in the code generated by
9255 the compiler.  This setting is the default.
9256
9257 @item -mno-app-regs
9258 @opindex -mno-app-regs
9259 This option will cause r2 and r5 to be treated as fixed registers.
9260   
9261 @item -mv850e
9262 @opindex -mv850e
9263 Specify that the target processor is the V850E.  The preprocessor
9264 constant @samp{__v850e__} will be defined if this option is used.
9265
9266 If neither @option{-mv850} nor @option{-mv850e} are defined
9267 then a default target processor will be chosen and the relevant
9268 @samp{__v850*__} preprocessor constant will be defined.
9269
9270 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9271 defined, regardless of which processor variant is the target.
9272
9273 @item -mdisable-callt
9274 @opindex -mdisable-callt
9275 This option will suppress generation of the CALLT instruction for the
9276 v850e flavors of the v850 architecture.  The default is
9277 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9278
9279 @end table
9280
9281 @node ARC Options
9282 @subsection ARC Options
9283 @cindex ARC Options
9284
9285 These options are defined for ARC implementations:
9286
9287 @table @gcctabopt
9288 @item -EL
9289 @opindex EL
9290 Compile code for little endian mode.  This is the default.
9291
9292 @item -EB
9293 @opindex EB
9294 Compile code for big endian mode.
9295
9296 @item -mmangle-cpu
9297 @opindex mmangle-cpu
9298 Prepend the name of the cpu to all public symbol names.
9299 In multiple-processor systems, there are many ARC variants with different
9300 instruction and register set characteristics.  This flag prevents code
9301 compiled for one cpu to be linked with code compiled for another.
9302 No facility exists for handling variants that are ``almost identical''.
9303 This is an all or nothing option.
9304
9305 @item -mcpu=@var{cpu}
9306 @opindex mcpu
9307 Compile code for ARC variant @var{cpu}.
9308 Which variants are supported depend on the configuration.
9309 All variants support @option{-mcpu=base}, this is the default.
9310
9311 @item -mtext=@var{text-section}
9312 @itemx -mdata=@var{data-section}
9313 @itemx -mrodata=@var{readonly-data-section}
9314 @opindex mtext
9315 @opindex mdata
9316 @opindex mrodata
9317 Put functions, data, and readonly data in @var{text-section},
9318 @var{data-section}, and @var{readonly-data-section} respectively
9319 by default.  This can be overridden with the @code{section} attribute.
9320 @xref{Variable Attributes}.
9321
9322 @end table
9323
9324 @node NS32K Options
9325 @subsection NS32K Options
9326 @cindex NS32K options
9327
9328 These are the @samp{-m} options defined for the 32000 series.  The default
9329 values for these options depends on which style of 32000 was selected when
9330 the compiler was configured; the defaults for the most common choices are
9331 given below.
9332
9333 @table @gcctabopt
9334 @item -m32032
9335 @itemx -m32032
9336 @opindex m32032
9337 @opindex m32032
9338 Generate output for a 32032.  This is the default
9339 when the compiler is configured for 32032 and 32016 based systems.
9340
9341 @item -m32332
9342 @itemx -m32332
9343 @opindex m32332
9344 @opindex m32332
9345 Generate output for a 32332.  This is the default
9346 when the compiler is configured for 32332-based systems.
9347
9348 @item -m32532
9349 @itemx -m32532
9350 @opindex m32532
9351 @opindex m32532
9352 Generate output for a 32532.  This is the default
9353 when the compiler is configured for 32532-based systems.
9354
9355 @item -m32081
9356 @opindex m32081
9357 Generate output containing 32081 instructions for floating point.
9358 This is the default for all systems.
9359
9360 @item -m32381
9361 @opindex m32381
9362 Generate output containing 32381 instructions for floating point.  This
9363 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9364 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9365
9366 @item -mmulti-add
9367 @opindex mmulti-add
9368 Try and generate multiply-add floating point instructions @code{polyF}
9369 and @code{dotF}.  This option is only available if the @option{-m32381}
9370 option is in effect.  Using these instructions requires changes to
9371 register allocation which generally has a negative impact on
9372 performance.  This option should only be enabled when compiling code
9373 particularly likely to make heavy use of multiply-add instructions.
9374
9375 @item -mnomulti-add
9376 @opindex mnomulti-add
9377 Do not try and generate multiply-add floating point instructions
9378 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9379
9380 @item -msoft-float
9381 @opindex msoft-float
9382 Generate output containing library calls for floating point.
9383 @strong{Warning:} the requisite libraries may not be available.
9384
9385 @item -mieee-compare
9386 @itemx -mno-ieee-compare
9387 @opindex mieee-compare
9388 @opindex mno-ieee-compare
9389 Control whether or not the compiler uses IEEE floating point
9390 comparisons.  These handle correctly the case where the result of a
9391 comparison is unordered.
9392 @strong{Warning:} the requisite kernel support may not be available.
9393
9394 @item -mnobitfield
9395 @opindex mnobitfield
9396 Do not use the bit-field instructions.  On some machines it is faster to
9397 use shifting and masking operations.  This is the default for the pc532.
9398
9399 @item -mbitfield
9400 @opindex mbitfield
9401 Do use the bit-field instructions.  This is the default for all platforms
9402 except the pc532.
9403
9404 @item -mrtd
9405 @opindex mrtd
9406 Use a different function-calling convention, in which functions
9407 that take a fixed number of arguments return pop their
9408 arguments on return with the @code{ret} instruction.
9409
9410 This calling convention is incompatible with the one normally
9411 used on Unix, so you cannot use it if you need to call libraries
9412 compiled with the Unix compiler.
9413
9414 Also, you must provide function prototypes for all functions that
9415 take variable numbers of arguments (including @code{printf});
9416 otherwise incorrect code will be generated for calls to those
9417 functions.
9418
9419 In addition, seriously incorrect code will result if you call a
9420 function with too many arguments.  (Normally, extra arguments are
9421 harmlessly ignored.)
9422
9423 This option takes its name from the 680x0 @code{rtd} instruction.
9424
9425
9426 @item -mregparam
9427 @opindex mregparam
9428 Use a different function-calling convention where the first two arguments
9429 are passed in registers.
9430
9431 This calling convention is incompatible with the one normally
9432 used on Unix, so you cannot use it if you need to call libraries
9433 compiled with the Unix compiler.
9434
9435 @item -mnoregparam
9436 @opindex mnoregparam
9437 Do not pass any arguments in registers.  This is the default for all
9438 targets.
9439
9440 @item -msb
9441 @opindex msb
9442 It is OK to use the sb as an index register which is always loaded with
9443 zero.  This is the default for the pc532-netbsd target.
9444
9445 @item -mnosb
9446 @opindex mnosb
9447 The sb register is not available for use or has not been initialized to
9448 zero by the run time system.  This is the default for all targets except
9449 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9450 @option{-fpic} is set.
9451
9452 @item -mhimem
9453 @opindex mhimem
9454 Many ns32000 series addressing modes use displacements of up to 512MB@.
9455 If an address is above 512MB then displacements from zero can not be used.
9456 This option causes code to be generated which can be loaded above 512MB@.
9457 This may be useful for operating systems or ROM code.
9458
9459 @item -mnohimem
9460 @opindex mnohimem
9461 Assume code will be loaded in the first 512MB of virtual address space.
9462 This is the default for all platforms.
9463
9464
9465 @end table
9466
9467 @node AVR Options
9468 @subsection AVR Options
9469 @cindex AVR Options
9470
9471 These options are defined for AVR implementations:
9472
9473 @table @gcctabopt
9474 @item -mmcu=@var{mcu}
9475 @opindex mmcu
9476 Specify ATMEL AVR instruction set or MCU type.
9477
9478 Instruction set avr1 is for the minimal AVR core, not supported by the C
9479 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9480 attiny11, attiny12, attiny15, attiny28).
9481
9482 Instruction set avr2 (default) is for the classic AVR core with up to
9483 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9484 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9485 at90c8534, at90s8535).
9486
9487 Instruction set avr3 is for the classic AVR core with up to 128K program
9488 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9489
9490 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9491 memory space (MCU types: atmega8, atmega83, atmega85).
9492
9493 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9494 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9495 atmega64, atmega128, at43usb355, at94k).
9496
9497 @item -msize
9498 @opindex msize
9499 Output instruction sizes to the asm file.
9500
9501 @item -minit-stack=@var{N}
9502 @opindex minit-stack
9503 Specify the initial stack address, which may be a symbol or numeric value,
9504 @samp{__stack} is the default.
9505
9506 @item -mno-interrupts
9507 @opindex mno-interrupts
9508 Generated code is not compatible with hardware interrupts.
9509 Code size will be smaller.
9510
9511 @item -mcall-prologues
9512 @opindex mcall-prologues
9513 Functions prologues/epilogues expanded as call to appropriate
9514 subroutines.  Code size will be smaller.
9515
9516 @item -mno-tablejump
9517 @opindex mno-tablejump
9518 Do not generate tablejump insns which sometimes increase code size.
9519
9520 @item -mtiny-stack
9521 @opindex mtiny-stack
9522 Change only the low 8 bits of the stack pointer.
9523 @end table
9524
9525 @node MCore Options
9526 @subsection MCore Options
9527 @cindex MCore options
9528
9529 These are the @samp{-m} options defined for the Motorola M*Core
9530 processors.
9531
9532 @table @gcctabopt
9533
9534 @item -mhardlit
9535 @itemx -mhardlit
9536 @itemx -mno-hardlit
9537 @opindex mhardlit
9538 @opindex mhardlit
9539 @opindex mno-hardlit
9540 Inline constants into the code stream if it can be done in two
9541 instructions or less.
9542
9543 @item -mdiv
9544 @itemx -mdiv
9545 @itemx -mno-div
9546 @opindex mdiv
9547 @opindex mdiv
9548 @opindex mno-div
9549 Use the divide instruction.  (Enabled by default).
9550
9551 @item -mrelax-immediate
9552 @itemx -mrelax-immediate
9553 @itemx -mno-relax-immediate
9554 @opindex mrelax-immediate
9555 @opindex mrelax-immediate
9556 @opindex mno-relax-immediate
9557 Allow arbitrary sized immediates in bit operations.
9558
9559 @item -mwide-bitfields
9560 @itemx -mwide-bitfields
9561 @itemx -mno-wide-bitfields
9562 @opindex mwide-bitfields
9563 @opindex mwide-bitfields
9564 @opindex mno-wide-bitfields
9565 Always treat bit-fields as int-sized.
9566
9567 @item -m4byte-functions
9568 @itemx -m4byte-functions
9569 @itemx -mno-4byte-functions
9570 @opindex m4byte-functions
9571 @opindex m4byte-functions
9572 @opindex mno-4byte-functions
9573 Force all functions to be aligned to a four byte boundary.
9574
9575 @item -mcallgraph-data
9576 @itemx -mcallgraph-data
9577 @itemx -mno-callgraph-data
9578 @opindex mcallgraph-data
9579 @opindex mcallgraph-data
9580 @opindex mno-callgraph-data
9581 Emit callgraph information.
9582
9583 @item -mslow-bytes
9584 @itemx -mslow-bytes
9585 @itemx -mno-slow-bytes
9586 @opindex mslow-bytes
9587 @opindex mslow-bytes
9588 @opindex mno-slow-bytes
9589 Prefer word access when reading byte quantities.
9590
9591 @item -mlittle-endian
9592 @itemx -mlittle-endian
9593 @itemx -mbig-endian
9594 @opindex mlittle-endian
9595 @opindex mlittle-endian
9596 @opindex mbig-endian
9597 Generate code for a little endian target.
9598
9599 @item -m210
9600 @itemx -m210
9601 @itemx -m340
9602 @opindex m210
9603 @opindex m210
9604 @opindex m340
9605 Generate code for the 210 processor.
9606 @end table
9607
9608 @node IA-64 Options
9609 @subsection IA-64 Options
9610 @cindex IA-64 Options
9611
9612 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9613
9614 @table @gcctabopt
9615 @item -mbig-endian
9616 @opindex mbig-endian
9617 Generate code for a big endian target.  This is the default for HP-UX@.
9618
9619 @item -mlittle-endian
9620 @opindex mlittle-endian
9621 Generate code for a little endian target.  This is the default for AIX5
9622 and Linux.
9623
9624 @item -mgnu-as
9625 @itemx -mno-gnu-as
9626 @opindex mgnu-as
9627 @opindex mno-gnu-as
9628 Generate (or don't) code for the GNU assembler.  This is the default.
9629 @c Also, this is the default if the configure option @option{--with-gnu-as}
9630 @c is used.
9631
9632 @item -mgnu-ld
9633 @itemx -mno-gnu-ld
9634 @opindex mgnu-ld
9635 @opindex mno-gnu-ld
9636 Generate (or don't) code for the GNU linker.  This is the default.
9637 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9638 @c is used.
9639
9640 @item -mno-pic
9641 @opindex mno-pic
9642 Generate code that does not use a global pointer register.  The result
9643 is not position independent code, and violates the IA-64 ABI@.
9644
9645 @item -mvolatile-asm-stop
9646 @itemx -mno-volatile-asm-stop
9647 @opindex mvolatile-asm-stop
9648 @opindex mno-volatile-asm-stop
9649 Generate (or don't) a stop bit immediately before and after volatile asm
9650 statements.
9651
9652 @item -mb-step
9653 @opindex mb-step
9654 Generate code that works around Itanium B step errata.
9655
9656 @item -mregister-names
9657 @itemx -mno-register-names
9658 @opindex mregister-names
9659 @opindex mno-register-names
9660 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9661 the stacked registers.  This may make assembler output more readable.
9662
9663 @item -mno-sdata
9664 @itemx -msdata
9665 @opindex mno-sdata
9666 @opindex msdata
9667 Disable (or enable) optimizations that use the small data section.  This may
9668 be useful for working around optimizer bugs.
9669
9670 @item -mconstant-gp
9671 @opindex mconstant-gp
9672 Generate code that uses a single constant global pointer value.  This is
9673 useful when compiling kernel code.
9674
9675 @item -mauto-pic
9676 @opindex mauto-pic
9677 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9678 This is useful when compiling firmware code.
9679
9680 @item -minline-float-divide-min-latency
9681 @opindex minline-float-divide-min-latency
9682 Generate code for inline divides of floating point values
9683 using the minimum latency algorithm.
9684
9685 @item -minline-float-divide-max-throughput
9686 @opindex minline-float-divide-max-throughput
9687 Generate code for inline divides of floating point values
9688 using the maximum throughput algorithm.
9689
9690 @item -minline-int-divide-min-latency
9691 @opindex minline-int-divide-min-latency
9692 Generate code for inline divides of integer values
9693 using the minimum latency algorithm.
9694
9695 @item -minline-int-divide-max-throughput
9696 @opindex minline-int-divide-max-throughput
9697 Generate code for inline divides of integer values
9698 using the maximum throughput algorithm.
9699
9700 @item -mno-dwarf2-asm
9701 @itemx -mdwarf2-asm
9702 @opindex mno-dwarf2-asm
9703 @opindex mdwarf2-asm
9704 Don't (or do) generate assembler code for the DWARF2 line number debugging
9705 info.  This may be useful when not using the GNU assembler.
9706
9707 @item -mfixed-range=@var{register-range}
9708 @opindex mfixed-range
9709 Generate code treating the given register range as fixed registers.
9710 A fixed register is one that the register allocator can not use.  This is
9711 useful when compiling kernel code.  A register range is specified as
9712 two registers separated by a dash.  Multiple register ranges can be
9713 specified separated by a comma.
9714 @end table
9715
9716 @node D30V Options
9717 @subsection D30V Options
9718 @cindex D30V Options
9719
9720 These @samp{-m} options are defined for D30V implementations:
9721
9722 @table @gcctabopt
9723 @item -mextmem
9724 @opindex mextmem
9725 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9726 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9727 memory, which starts at location @code{0x80000000}.
9728
9729 @item -mextmemory
9730 @opindex mextmemory
9731 Same as the @option{-mextmem} switch.
9732
9733 @item -monchip
9734 @opindex monchip
9735 Link the @samp{.text} section into onchip text memory, which starts at
9736 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9737 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9738 into onchip data memory, which starts at location @code{0x20000000}.
9739
9740 @item -mno-asm-optimize
9741 @itemx -masm-optimize
9742 @opindex mno-asm-optimize
9743 @opindex masm-optimize
9744 Disable (enable) passing @option{-O} to the assembler when optimizing.
9745 The assembler uses the @option{-O} option to automatically parallelize
9746 adjacent short instructions where possible.
9747
9748 @item -mbranch-cost=@var{n}
9749 @opindex mbranch-cost
9750 Increase the internal costs of branches to @var{n}.  Higher costs means
9751 that the compiler will issue more instructions to avoid doing a branch.
9752 The default is 2.
9753
9754 @item -mcond-exec=@var{n}
9755 @opindex mcond-exec
9756 Specify the maximum number of conditionally executed instructions that
9757 replace a branch.  The default is 4.
9758 @end table
9759
9760 @node S/390 and zSeries Options
9761 @subsection S/390 and zSeries Options
9762 @cindex S/390 and zSeries Options
9763
9764 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9765
9766 @table @gcctabopt
9767 @item -mhard-float
9768 @itemx -msoft-float
9769 @opindex mhard-float
9770 @opindex msoft-float
9771 Use (do not use) the hardware floating-point instructions and registers
9772 for floating-point operations.  When @option{-msoft-float} is specified,
9773 functions in @file{libgcc.a} will be used to perform floating-point
9774 operations.  When @option{-mhard-float} is specified, the compiler
9775 generates IEEE floating-point instructions.  This is the default.
9776
9777 @item -mbackchain
9778 @itemx -mno-backchain
9779 @opindex mbackchain
9780 @opindex mno-backchain
9781 Generate (or do not generate) code which maintains an explicit
9782 backchain within the stack frame that points to the caller's frame.
9783 This is currently needed to allow debugging.  The default is to
9784 generate the backchain.
9785
9786 @item -msmall-exec
9787 @itemx -mno-small-exec
9788 @opindex msmall-exec
9789 @opindex mno-small-exec
9790 Generate (or do not generate) code using the @code{bras} instruction
9791 to do subroutine calls.
9792 This only works reliably if the total executable size does not
9793 exceed 64k.  The default is to use the @code{basr} instruction instead,
9794 which does not have this limitation.
9795
9796 @item -m64
9797 @itemx -m31
9798 @opindex m64
9799 @opindex m31
9800 When @option{-m31} is specified, generate code compliant to the
9801 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9802 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9803 particular to generate 64-bit instructions.  For the @samp{s390}
9804 targets, the default is @option{-m31}, while the @samp{s390x}
9805 targets default to @option{-m64}.
9806
9807 @item -mzarch
9808 @itemx -mesa
9809 @opindex mzarch
9810 @opindex mesa
9811 When @option{-mzarch} is specified, generate code using the 
9812 instructions available on z/Architecture. 
9813 When @option{-mesa} is specified, generate code using the 
9814 instructions available on ESA/390. Note that @option{-mesa} is
9815 not possible with @option{-m64}.
9816 For the @samp{s390} targets, the default is @option{-mesa}, 
9817 while the @samp{s390x} targets default to @option{-mzarch}.
9818
9819 @item -mmvcle
9820 @itemx -mno-mvcle
9821 @opindex mmvcle
9822 @opindex mno-mvcle
9823 Generate (or do not generate) code using the @code{mvcle} instruction
9824 to perform block moves.  When @option{-mno-mvcle} is specified,
9825 use a @code{mvc} loop instead.  This is the default.
9826
9827 @item -mdebug
9828 @itemx -mno-debug
9829 @opindex mdebug
9830 @opindex mno-debug
9831 Print (or do not print) additional debug information when compiling.
9832 The default is to not print debug information.
9833
9834 @item -march=@var{arch}
9835 @opindex march
9836 Generate code that will run on @var{arch}, which is the name of system
9837 representing a certain processor type. Possible values for
9838 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
9839
9840 @item -mcpu=@var{arch}
9841 @opindex mcpu
9842 Tune to @var{cpu-type} everything applicable about the generated code,
9843  except for the ABI and the set of available instructions. 
9844 The list of @var{arch} values is the same as for @option{-march}.
9845
9846 @end table
9847
9848 @node CRIS Options
9849 @subsection CRIS Options
9850 @cindex CRIS Options
9851
9852 These options are defined specifically for the CRIS ports.
9853
9854 @table @gcctabopt
9855 @item -march=@var{architecture-type}
9856 @itemx -mcpu=@var{architecture-type}
9857 @opindex march
9858 @opindex mcpu
9859 Generate code for the specified architecture.  The choices for
9860 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9861 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9862 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9863 @samp{v10}.
9864
9865 @item -mtune=@var{architecture-type}
9866 @opindex mtune
9867 Tune to @var{architecture-type} everything applicable about the generated
9868 code, except for the ABI and the set of available instructions.  The
9869 choices for @var{architecture-type} are the same as for
9870 @option{-march=@var{architecture-type}}.
9871
9872 @item -mmax-stack-frame=@var{n}
9873 @opindex mmax-stack-frame
9874 Warn when the stack frame of a function exceeds @var{n} bytes.
9875
9876 @item -melinux-stacksize=@var{n}
9877 @opindex melinux-stacksize
9878 Only available with the @samp{cris-axis-aout} target.  Arranges for
9879 indications in the program to the kernel loader that the stack of the
9880 program should be set to @var{n} bytes.
9881
9882 @item -metrax4
9883 @itemx -metrax100
9884 @opindex metrax4
9885 @opindex metrax100
9886 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9887 @option{-march=v3} and @option{-march=v8} respectively.
9888
9889 @item -mpdebug
9890 @opindex mpdebug
9891 Enable CRIS-specific verbose debug-related information in the assembly
9892 code.  This option also has the effect to turn off the @samp{#NO_APP}
9893 formatted-code indicator to the assembler at the beginning of the
9894 assembly file.
9895
9896 @item -mcc-init
9897 @opindex mcc-init
9898 Do not use condition-code results from previous instruction; always emit
9899 compare and test instructions before use of condition codes.
9900
9901 @item -mno-side-effects
9902 @opindex mno-side-effects
9903 Do not emit instructions with side-effects in addressing modes other than
9904 post-increment.
9905
9906 @item -mstack-align
9907 @itemx -mno-stack-align
9908 @itemx -mdata-align
9909 @itemx -mno-data-align
9910 @itemx -mconst-align
9911 @itemx -mno-const-align
9912 @opindex mstack-align
9913 @opindex mno-stack-align
9914 @opindex mdata-align
9915 @opindex mno-data-align
9916 @opindex mconst-align
9917 @opindex mno-const-align
9918 These options (no-options) arranges (eliminate arrangements) for the
9919 stack-frame, individual data and constants to be aligned for the maximum
9920 single data access size for the chosen CPU model.  The default is to
9921 arrange for 32-bit alignment.  ABI details such as structure layout are
9922 not affected by these options.
9923
9924 @item -m32-bit
9925 @itemx -m16-bit
9926 @itemx -m8-bit
9927 @opindex m32-bit
9928 @opindex m16-bit
9929 @opindex m8-bit
9930 Similar to the stack- data- and const-align options above, these options
9931 arrange for stack-frame, writable data and constants to all be 32-bit,
9932 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9933
9934 @item -mno-prologue-epilogue
9935 @itemx -mprologue-epilogue
9936 @opindex mno-prologue-epilogue
9937 @opindex mprologue-epilogue
9938 With @option{-mno-prologue-epilogue}, the normal function prologue and
9939 epilogue that sets up the stack-frame are omitted and no return
9940 instructions or return sequences are generated in the code.  Use this
9941 option only together with visual inspection of the compiled code: no
9942 warnings or errors are generated when call-saved registers must be saved,
9943 or storage for local variable needs to be allocated.
9944
9945 @item -mno-gotplt
9946 @itemx -mgotplt
9947 @opindex mno-gotplt
9948 @opindex mgotplt
9949 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9950 instruction sequences that load addresses for functions from the PLT part
9951 of the GOT rather than (traditional on other architectures) calls to the
9952 PLT.  The default is @option{-mgotplt}.
9953
9954 @item -maout
9955 @opindex maout
9956 Legacy no-op option only recognized with the cris-axis-aout target.
9957
9958 @item -melf
9959 @opindex melf
9960 Legacy no-op option only recognized with the cris-axis-elf and
9961 cris-axis-linux-gnu targets.
9962
9963 @item -melinux
9964 @opindex melinux
9965 Only recognized with the cris-axis-aout target, where it selects a
9966 GNU/linux-like multilib, include files and instruction set for
9967 @option{-march=v8}.
9968
9969 @item -mlinux
9970 @opindex mlinux
9971 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9972
9973 @item -sim
9974 @opindex sim
9975 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9976 to link with input-output functions from a simulator library.  Code,
9977 initialized data and zero-initialized data are allocated consecutively.
9978
9979 @item -sim2
9980 @opindex sim2
9981 Like @option{-sim}, but pass linker options to locate initialized data at
9982 0x40000000 and zero-initialized data at 0x80000000.
9983 @end table
9984
9985 @node MMIX Options
9986 @subsection MMIX Options
9987 @cindex MMIX Options
9988
9989 These options are defined for the MMIX:
9990
9991 @table @gcctabopt
9992 @item -mlibfuncs
9993 @itemx -mno-libfuncs
9994 @opindex mlibfuncs
9995 @opindex mno-libfuncs
9996 Specify that intrinsic library functions are being compiled, passing all
9997 values in registers, no matter the size.
9998
9999 @item -mepsilon
10000 @itemx -mno-epsilon
10001 @opindex mepsilon
10002 @opindex mno-epsilon
10003 Generate floating-point comparison instructions that compare with respect
10004 to the @code{rE} epsilon register.
10005
10006 @item -mabi=mmixware
10007 @itemx -mabi=gnu
10008 @opindex mabi-mmixware
10009 @opindex mabi=gnu
10010 Generate code that passes function parameters and return values that (in
10011 the called function) are seen as registers @code{$0} and up, as opposed to
10012 the GNU ABI which uses global registers @code{$231} and up.
10013
10014 @item -mzero-extend
10015 @itemx -mno-zero-extend
10016 @opindex mzero-extend
10017 @opindex mno-zero-extend
10018 When reading data from memory in sizes shorter than 64 bits, use (do not
10019 use) zero-extending load instructions by default, rather than
10020 sign-extending ones.
10021
10022 @item -mknuthdiv
10023 @itemx -mno-knuthdiv
10024 @opindex mknuthdiv
10025 @opindex mno-knuthdiv
10026 Make the result of a division yielding a remainder have the same sign as
10027 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10028 remainder follows the sign of the dividend.  Both methods are
10029 arithmetically valid, the latter being almost exclusively used.
10030
10031 @item -mtoplevel-symbols
10032 @itemx -mno-toplevel-symbols
10033 @opindex mtoplevel-symbols
10034 @opindex mno-toplevel-symbols
10035 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10036 code can be used with the @code{PREFIX} assembly directive.
10037
10038 @item -melf
10039 @opindex melf
10040 Generate an executable in the ELF format, rather than the default
10041 @samp{mmo} format used by the @command{mmix} simulator.
10042
10043 @item -mbranch-predict
10044 @itemx -mno-branch-predict
10045 @opindex mbranch-predict
10046 @opindex mno-branch-predict
10047 Use (do not use) the probable-branch instructions, when static branch
10048 prediction indicates a probable branch.
10049
10050 @item -mbase-addresses
10051 @itemx -mno-base-addresses
10052 @opindex mbase-addresses
10053 @opindex mno-base-addresses
10054 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10055 base address automatically generates a request (handled by the assembler
10056 and the linker) for a constant to be set up in a global register.  The
10057 register is used for one or more base address requests within the range 0
10058 to 255 from the value held in the register.  The generally leads to short
10059 and fast code, but the number of different data items that can be
10060 addressed is limited.  This means that a program that uses lots of static
10061 data may require @option{-mno-base-addresses}.
10062
10063 @item -msingle-exit
10064 @itemx -mno-single-exit
10065 @opindex msingle-exit
10066 @opindex mno-single-exit
10067 Force (do not force) generated code to have a single exit point in each
10068 function.
10069 @end table
10070
10071 @node PDP-11 Options
10072 @subsection PDP-11 Options
10073 @cindex PDP-11 Options
10074
10075 These options are defined for the PDP-11:
10076
10077 @table @gcctabopt
10078 @item -mfpu
10079 @opindex mfpu
10080 Use hardware FPP floating point.  This is the default.  (FIS floating
10081 point on the PDP-11/40 is not supported.)
10082
10083 @item -msoft-float
10084 @opindex msoft-float
10085 Do not use hardware floating point.
10086
10087 @item -mac0
10088 @opindex mac0
10089 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10090
10091 @item -mno-ac0
10092 @opindex mno-ac0
10093 Return floating-point results in memory.  This is the default.
10094
10095 @item -m40
10096 @opindex m40
10097 Generate code for a PDP-11/40.
10098
10099 @item -m45
10100 @opindex m45
10101 Generate code for a PDP-11/45.  This is the default.
10102
10103 @item -m10
10104 @opindex m10
10105 Generate code for a PDP-11/10.
10106
10107 @item -mbcopy-builtin
10108 @opindex bcopy-builtin
10109 Use inline @code{movstrhi} patterns for copying memory.  This is the
10110 default.
10111
10112 @item -mbcopy
10113 @opindex mbcopy
10114 Do not use inline @code{movstrhi} patterns for copying memory.
10115
10116 @item -mint16
10117 @itemx -mno-int32
10118 @opindex mint16
10119 @opindex mno-int32
10120 Use 16-bit @code{int}.  This is the default.
10121
10122 @item -mint32
10123 @itemx -mno-int16
10124 @opindex mint32
10125 @opindex mno-int16
10126 Use 32-bit @code{int}.
10127
10128 @item -mfloat64
10129 @itemx -mno-float32
10130 @opindex mfloat64
10131 @opindex mno-float32
10132 Use 64-bit @code{float}.  This is the default.
10133
10134 @item -mfloat32
10135 @item -mno-float64
10136 @opindex mfloat32
10137 @opindex mno-float64
10138 Use 32-bit @code{float}.
10139
10140 @item -mabshi
10141 @opindex mabshi
10142 Use @code{abshi2} pattern.  This is the default.
10143
10144 @item -mno-abshi
10145 @opindex mno-abshi
10146 Do not use @code{abshi2} pattern.
10147
10148 @item -mbranch-expensive
10149 @opindex mbranch-expensive
10150 Pretend that branches are expensive.  This is for experimenting with
10151 code generation only.
10152
10153 @item -mbranch-cheap
10154 @opindex mbranch-cheap
10155 Do not pretend that branches are expensive.  This is the default.
10156
10157 @item -msplit
10158 @opindex msplit
10159 Generate code for a system with split I&D.
10160
10161 @item -mno-split
10162 @opindex mno-split
10163 Generate code for a system without split I&D.  This is the default.
10164
10165 @item -munix-asm
10166 @opindex munix-asm
10167 Use Unix assembler syntax.  This is the default when configured for
10168 @samp{pdp11-*-bsd}.
10169
10170 @item -mdec-asm
10171 @opindex mdec-asm
10172 Use DEC assembler syntax.  This is the default when configured for any
10173 PDP-11 target other than @samp{pdp11-*-bsd}.
10174 @end table
10175
10176 @node Xstormy16 Options
10177 @subsection Xstormy16 Options
10178 @cindex Xstormy16 Options
10179
10180 These options are defined for Xstormy16:
10181
10182 @table @gcctabopt
10183 @item -msim
10184 @opindex msim
10185 Choose startup files and linker script suitable for the simulator.
10186 @end table
10187
10188 @node FRV Options
10189 @subsection FRV Options
10190 @cindex FRV Options
10191
10192 @table @gcctabopt
10193 @item -mgpr-32
10194 @opindex mgpr-32
10195
10196 Only use the first 32 general purpose registers.
10197
10198 @item -mgpr-64
10199 @opindex mgpr-64
10200
10201 Use all 64 general purpose registers.
10202
10203 @item -mfpr-32
10204 @opindex mfpr-32
10205
10206 Use only the first 32 floating point registers.
10207
10208 @item -mfpr-64
10209 @opindex mfpr-64
10210
10211 Use all 64 floating point registers
10212
10213 @item -mhard-float
10214 @opindex mhard-float
10215
10216 Use hardware instructions for floating point operations.
10217
10218 @item -msoft-float
10219 @opindex msoft-float
10220
10221 Use library routines for floating point operations.
10222
10223 @item -malloc-cc
10224 @opindex malloc-cc
10225
10226 Dynamically allocate condition code registers.
10227
10228 @item -mfixed-cc
10229 @opindex mfixed-cc
10230
10231 Do not try to dynamically allocate condition code registers, only
10232 use @code{icc0} and @code{fcc0}.
10233
10234 @item -mdword
10235 @opindex mdword
10236
10237 Change ABI to use double word insns.
10238
10239 @item -mno-dword
10240 @opindex mno-dword
10241
10242 Do not use double word instructions.
10243
10244 @item -mdouble
10245 @opindex mdouble
10246
10247 Use floating point double instructions.
10248
10249 @item -mno-double
10250 @opindex mno-double
10251
10252 Do not use floating point double instructions.
10253
10254 @item -mmedia
10255 @opindex mmedia
10256
10257 Use media instructions.
10258
10259 @item -mno-media
10260 @opindex mno-media
10261
10262 Do not use media instructions.
10263
10264 @item -mmuladd
10265 @opindex mmuladd
10266
10267 Use multiply and add/subtract instructions.
10268
10269 @item -mno-muladd
10270 @opindex mno-muladd
10271
10272 Do not use multiply and add/subtract instructions.
10273
10274 @item -mlibrary-pic
10275 @opindex mlibrary-pic
10276
10277 Enable PIC support for building libraries
10278
10279 @item -macc-4
10280 @opindex macc-4
10281
10282 Use only the first four media accumulator registers.
10283
10284 @item -macc-8
10285 @opindex macc-8
10286
10287 Use all eight media accumulator registers.
10288
10289 @item -mpack
10290 @opindex mpack
10291
10292 Pack VLIW instructions.
10293
10294 @item -mno-pack
10295 @opindex mno-pack
10296
10297 Do not pack VLIW instructions.
10298
10299 @item -mno-eflags
10300 @opindex mno-eflags
10301
10302 Do not mark ABI switches in e_flags.
10303
10304 @item -mcond-move
10305 @opindex mcond-move
10306
10307 Enable the use of conditional-move instructions (default).
10308
10309 This switch is mainly for debugging the compiler and will likely be removed
10310 in a future version.
10311
10312 @item -mno-cond-move
10313 @opindex mno-cond-move
10314
10315 Disable the use of conditional-move instructions.
10316
10317 This switch is mainly for debugging the compiler and will likely be removed
10318 in a future version.
10319
10320 @item -mscc
10321 @opindex mscc
10322
10323 Enable the use of conditional set instructions (default).
10324
10325 This switch is mainly for debugging the compiler and will likely be removed
10326 in a future version.
10327
10328 @item -mno-scc
10329 @opindex mno-scc
10330
10331 Disable the use of conditional set instructions.
10332
10333 This switch is mainly for debugging the compiler and will likely be removed
10334 in a future version.
10335
10336 @item -mcond-exec
10337 @opindex mcond-exec
10338
10339 Enable the use of conditional execution (default).
10340
10341 This switch is mainly for debugging the compiler and will likely be removed
10342 in a future version.
10343
10344 @item -mno-cond-exec
10345 @opindex mno-cond-exec
10346
10347 Disable the use of conditional execution.
10348
10349 This switch is mainly for debugging the compiler and will likely be removed
10350 in a future version.
10351
10352 @item -mvliw-branch
10353 @opindex mvliw-branch
10354
10355 Run a pass to pack branches into VLIW instructions (default).
10356
10357 This switch is mainly for debugging the compiler and will likely be removed
10358 in a future version.
10359
10360 @item -mno-vliw-branch
10361 @opindex mno-vliw-branch
10362
10363 Do not run a pass to pack branches into VLIW instructions.
10364
10365 This switch is mainly for debugging the compiler and will likely be removed
10366 in a future version.
10367
10368 @item -mmulti-cond-exec
10369 @opindex mmulti-cond-exec
10370
10371 Enable optimization of @code{&&} and @code{||} in conditional execution
10372 (default).
10373
10374 This switch is mainly for debugging the compiler and will likely be removed
10375 in a future version.
10376
10377 @item -mno-multi-cond-exec
10378 @opindex mno-multi-cond-exec
10379
10380 Disable optimization of @code{&&} and @code{||} in conditional execution.
10381
10382 This switch is mainly for debugging the compiler and will likely be removed
10383 in a future version.
10384
10385 @item -mnested-cond-exec
10386 @opindex mnested-cond-exec
10387
10388 Enable nested conditional execution optimizations (default).
10389
10390 This switch is mainly for debugging the compiler and will likely be removed
10391 in a future version.
10392
10393 @item -mno-nested-cond-exec
10394 @opindex mno-nested-cond-exec
10395
10396 Disable nested conditional execution optimizations.
10397
10398 This switch is mainly for debugging the compiler and will likely be removed
10399 in a future version.
10400
10401 @item -mtomcat-stats
10402 @opindex mtomcat-stats
10403
10404 Cause gas to print out tomcat statistics.
10405
10406 @item -mcpu=@var{cpu}
10407 @opindex mcpu
10408
10409 Select the processor type for which to generate code.  Possible values are
10410 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10411 @samp{frv}.
10412
10413 @end table
10414
10415 @node Xtensa Options
10416 @subsection Xtensa Options
10417 @cindex Xtensa Options
10418
10419 The Xtensa architecture is designed to support many different
10420 configurations.  The compiler's default options can be set to match a
10421 particular Xtensa configuration by copying a configuration file into the
10422 GCC sources when building GCC@.  The options below may be used to
10423 override the default options.
10424
10425 @table @gcctabopt
10426 @item -mbig-endian
10427 @itemx -mlittle-endian
10428 @opindex mbig-endian
10429 @opindex mlittle-endian
10430 Specify big-endian or little-endian byte ordering for the target Xtensa
10431 processor.
10432
10433 @item -mdensity
10434 @itemx -mno-density
10435 @opindex mdensity
10436 @opindex mno-density
10437 Enable or disable use of the optional Xtensa code density instructions.
10438
10439 @item -mmac16
10440 @itemx -mno-mac16
10441 @opindex mmac16
10442 @opindex mno-mac16
10443 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10444 will generate MAC16 instructions from standard C code, with the
10445 limitation that it will use neither the MR register file nor any
10446 instruction that operates on the MR registers.  When this option is
10447 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10448 combination of core instructions and library calls, depending on whether
10449 any other multiplier options are enabled.
10450
10451 @item -mmul16
10452 @itemx -mno-mul16
10453 @opindex mmul16
10454 @opindex mno-mul16
10455 Enable or disable use of the 16-bit integer multiplier option.  When
10456 enabled, the compiler will generate 16-bit multiply instructions for
10457 multiplications of 16 bits or smaller in standard C code.  When this
10458 option is disabled, the compiler will either use 32-bit multiply or
10459 MAC16 instructions if they are available or generate library calls to
10460 perform the multiply operations using shifts and adds.
10461
10462 @item -mmul32
10463 @itemx -mno-mul32
10464 @opindex mmul32
10465 @opindex mno-mul32
10466 Enable or disable use of the 32-bit integer multiplier option.  When
10467 enabled, the compiler will generate 32-bit multiply instructions for
10468 multiplications of 32 bits or smaller in standard C code.  When this
10469 option is disabled, the compiler will generate library calls to perform
10470 the multiply operations using either shifts and adds or 16-bit multiply
10471 instructions if they are available.
10472
10473 @item -mnsa
10474 @itemx -mno-nsa
10475 @opindex mnsa
10476 @opindex mno-nsa
10477 Enable or disable use of the optional normalization shift amount
10478 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10479
10480 @item -mminmax
10481 @itemx -mno-minmax
10482 @opindex mminmax
10483 @opindex mno-minmax
10484 Enable or disable use of the optional minimum and maximum value
10485 instructions.
10486
10487 @item -msext
10488 @itemx -mno-sext
10489 @opindex msext
10490 @opindex mno-sext
10491 Enable or disable use of the optional sign extend (@code{SEXT})
10492 instruction.
10493
10494 @item -mbooleans
10495 @itemx -mno-booleans
10496 @opindex mbooleans
10497 @opindex mno-booleans
10498 Enable or disable support for the boolean register file used by Xtensa
10499 coprocessors.  This is not typically useful by itself but may be
10500 required for other options that make use of the boolean registers (e.g.,
10501 the floating-point option).
10502
10503 @item -mhard-float
10504 @itemx -msoft-float
10505 @opindex mhard-float
10506 @opindex msoft-float
10507 Enable or disable use of the floating-point option.  When enabled, GCC
10508 generates floating-point instructions for 32-bit @code{float}
10509 operations.  When this option is disabled, GCC generates library calls
10510 to emulate 32-bit floating-point operations using integer instructions.
10511 Regardless of this option, 64-bit @code{double} operations are always
10512 emulated with calls to library functions.
10513
10514 @item -mfused-madd
10515 @itemx -mno-fused-madd
10516 @opindex mfused-madd
10517 @opindex mno-fused-madd
10518 Enable or disable use of fused multiply/add and multiply/subtract
10519 instructions in the floating-point option.  This has no effect if the
10520 floating-point option is not also enabled.  Disabling fused multiply/add
10521 and multiply/subtract instructions forces the compiler to use separate
10522 instructions for the multiply and add/subtract operations.  This may be
10523 desirable in some cases where strict IEEE 754-compliant results are
10524 required: the fused multiply add/subtract instructions do not round the
10525 intermediate result, thereby producing results with @emph{more} bits of
10526 precision than specified by the IEEE standard.  Disabling fused multiply
10527 add/subtract instructions also ensures that the program output is not
10528 sensitive to the compiler's ability to combine multiply and add/subtract
10529 operations.
10530
10531 @item -mserialize-volatile
10532 @itemx -mno-serialize-volatile
10533 @opindex mserialize-volatile
10534 @opindex mno-serialize-volatile
10535 When this option is enabled, GCC inserts @code{MEMW} instructions before
10536 @code{volatile} memory references to guarantee sequential consistency.
10537 The default is @option{-mserialize-volatile}.  Use
10538 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10539
10540 @item -mtext-section-literals
10541 @itemx -mno-text-section-literals
10542 @opindex mtext-section-literals
10543 @opindex mno-text-section-literals
10544 Control the treatment of literal pools.  The default is
10545 @option{-mno-text-section-literals}, which places literals in a separate
10546 section in the output file.  This allows the literal pool to be placed
10547 in a data RAM/ROM, and it also allows the linker to combine literal
10548 pools from separate object files to remove redundant literals and
10549 improve code size.  With @option{-mtext-section-literals}, the literals
10550 are interspersed in the text section in order to keep them as close as
10551 possible to their references.  This may be necessary for large assembly
10552 files.
10553
10554 @item -mtarget-align
10555 @itemx -mno-target-align
10556 @opindex mtarget-align
10557 @opindex mno-target-align
10558 When this option is enabled, GCC instructs the assembler to
10559 automatically align instructions to reduce branch penalties at the
10560 expense of some code density.  The assembler attempts to widen density
10561 instructions to align branch targets and the instructions following call
10562 instructions.  If there are not enough preceding safe density
10563 instructions to align a target, no widening will be performed.  The
10564 default is @option{-mtarget-align}.  These options do not affect the
10565 treatment of auto-aligned instructions like @code{LOOP}, which the
10566 assembler will always align, either by widening density instructions or
10567 by inserting no-op instructions.
10568
10569 @item -mlongcalls
10570 @itemx -mno-longcalls
10571 @opindex mlongcalls
10572 @opindex mno-longcalls
10573 When this option is enabled, GCC instructs the assembler to translate
10574 direct calls to indirect calls unless it can determine that the target
10575 of a direct call is in the range allowed by the call instruction.  This
10576 translation typically occurs for calls to functions in other source
10577 files.  Specifically, the assembler translates a direct @code{CALL}
10578 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10579 The default is @option{-mno-longcalls}.  This option should be used in
10580 programs where the call target can potentially be out of range.  This
10581 option is implemented in the assembler, not the compiler, so the
10582 assembly code generated by GCC will still show direct call
10583 instructions---look at the disassembled object code to see the actual
10584 instructions.  Note that the assembler will use an indirect call for
10585 every cross-file call, not just those that really will be out of range.
10586 @end table
10587
10588 @node Code Gen Options
10589 @section Options for Code Generation Conventions
10590 @cindex code generation conventions
10591 @cindex options, code generation
10592 @cindex run-time options
10593
10594 These machine-independent options control the interface conventions
10595 used in code generation.
10596
10597 Most of them have both positive and negative forms; the negative form
10598 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10599 one of the forms is listed---the one which is not the default.  You
10600 can figure out the other form by either removing @samp{no-} or adding
10601 it.
10602
10603 @table @gcctabopt
10604 @item -fexceptions
10605 @opindex fexceptions
10606 Enable exception handling.  Generates extra code needed to propagate
10607 exceptions.  For some targets, this implies GCC will generate frame
10608 unwind information for all functions, which can produce significant data
10609 size overhead, although it does not affect execution.  If you do not
10610 specify this option, GCC will enable it by default for languages like
10611 C++ which normally require exception handling, and disable it for
10612 languages like C that do not normally require it.  However, you may need
10613 to enable this option when compiling C code that needs to interoperate
10614 properly with exception handlers written in C++.  You may also wish to
10615 disable this option if you are compiling older C++ programs that don't
10616 use exception handling.
10617
10618 @item -fnon-call-exceptions
10619 @opindex fnon-call-exceptions
10620 Generate code that allows trapping instructions to throw exceptions.
10621 Note that this requires platform-specific runtime support that does
10622 not exist everywhere.  Moreover, it only allows @emph{trapping}
10623 instructions to throw exceptions, i.e.@: memory references or floating
10624 point instructions.  It does not allow exceptions to be thrown from
10625 arbitrary signal handlers such as @code{SIGALRM}.
10626
10627 @item -funwind-tables
10628 @opindex funwind-tables
10629 Similar to @option{-fexceptions}, except that it will just generate any needed
10630 static data, but will not affect the generated code in any other way.
10631 You will normally not enable this option; instead, a language processor
10632 that needs this handling would enable it on your behalf.
10633
10634 @item -fasynchronous-unwind-tables
10635 @opindex funwind-tables
10636 Generate unwind table in dwarf2 format, if supported by target machine.  The
10637 table is exact at each instruction boundary, so it can be used for stack
10638 unwinding from asynchronous events (such as debugger or garbage collector).
10639
10640 @item -fpcc-struct-return
10641 @opindex fpcc-struct-return
10642 Return ``short'' @code{struct} and @code{union} values in memory like
10643 longer ones, rather than in registers.  This convention is less
10644 efficient, but it has the advantage of allowing intercallability between
10645 GCC-compiled files and files compiled with other compilers, particularly
10646 the Portable C Compiler (pcc).
10647
10648 The precise convention for returning structures in memory depends
10649 on the target configuration macros.
10650
10651 Short structures and unions are those whose size and alignment match
10652 that of some integer type.
10653
10654 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10655 switch is not binary compatible with code compiled with the
10656 @option{-freg-struct-return} switch.
10657 Use it to conform to a non-default application binary interface.
10658
10659 @item -freg-struct-return
10660 @opindex freg-struct-return
10661 Return @code{struct} and @code{union} values in registers when possible.
10662 This is more efficient for small structures than
10663 @option{-fpcc-struct-return}.
10664
10665 If you specify neither @option{-fpcc-struct-return} nor
10666 @option{-freg-struct-return}, GCC defaults to whichever convention is
10667 standard for the target.  If there is no standard convention, GCC
10668 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10669 the principal compiler.  In those cases, we can choose the standard, and
10670 we chose the more efficient register return alternative.
10671
10672 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10673 switch is not binary compatible with code compiled with the
10674 @option{-fpcc-struct-return} switch.
10675 Use it to conform to a non-default application binary interface.
10676
10677 @item -fshort-enums
10678 @opindex fshort-enums
10679 Allocate to an @code{enum} type only as many bytes as it needs for the
10680 declared range of possible values.  Specifically, the @code{enum} type
10681 will be equivalent to the smallest integer type which has enough room.
10682
10683 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10684 code that is not binary compatible with code generated without that switch.
10685 Use it to conform to a non-default application binary interface.
10686
10687 @item -fshort-double
10688 @opindex fshort-double
10689 Use the same size for @code{double} as for @code{float}.
10690
10691 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10692 code that is not binary compatible with code generated without that switch.
10693 Use it to conform to a non-default application binary interface.
10694
10695 @item -fshort-wchar
10696 @opindex fshort-wchar
10697 Override the underlying type for @samp{wchar_t} to be @samp{short
10698 unsigned int} instead of the default for the target.  This option is
10699 useful for building programs to run under WINE@.
10700
10701 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10702 code that is not binary compatible with code generated without that switch.
10703 Use it to conform to a non-default application binary interface.
10704
10705 @item -fshared-data
10706 @opindex fshared-data
10707 Requests that the data and non-@code{const} variables of this
10708 compilation be shared data rather than private data.  The distinction
10709 makes sense only on certain operating systems, where shared data is
10710 shared between processes running the same program, while private data
10711 exists in one copy per process.
10712
10713 @item -fno-common
10714 @opindex fno-common
10715 In C, allocate even uninitialized global variables in the data section of the
10716 object file, rather than generating them as common blocks.  This has the
10717 effect that if the same variable is declared (without @code{extern}) in
10718 two different compilations, you will get an error when you link them.
10719 The only reason this might be useful is if you wish to verify that the
10720 program will work on other systems which always work this way.
10721
10722 @item -fno-ident
10723 @opindex fno-ident
10724 Ignore the @samp{#ident} directive.
10725
10726 @item -fno-gnu-linker
10727 @opindex fno-gnu-linker
10728 Do not output global initializations (such as C++ constructors and
10729 destructors) in the form used by the GNU linker (on systems where the GNU
10730 linker is the standard method of handling them).  Use this option when
10731 you want to use a non-GNU linker, which also requires using the
10732 @command{collect2} program to make sure the system linker includes
10733 constructors and destructors.  (@command{collect2} is included in the GCC
10734 distribution.)  For systems which @emph{must} use @command{collect2}, the
10735 compiler driver @command{gcc} is configured to do this automatically.
10736
10737 @item -finhibit-size-directive
10738 @opindex finhibit-size-directive
10739 Don't output a @code{.size} assembler directive, or anything else that
10740 would cause trouble if the function is split in the middle, and the
10741 two halves are placed at locations far apart in memory.  This option is
10742 used when compiling @file{crtstuff.c}; you should not need to use it
10743 for anything else.
10744
10745 @item -fverbose-asm
10746 @opindex fverbose-asm
10747 Put extra commentary information in the generated assembly code to
10748 make it more readable.  This option is generally only of use to those
10749 who actually need to read the generated assembly code (perhaps while
10750 debugging the compiler itself).
10751
10752 @option{-fno-verbose-asm}, the default, causes the
10753 extra information to be omitted and is useful when comparing two assembler
10754 files.
10755
10756 @item -fvolatile
10757 @opindex fvolatile
10758 Consider all memory references through pointers to be volatile.
10759
10760 @item -fvolatile-global
10761 @opindex fvolatile-global
10762 Consider all memory references to extern and global data items to
10763 be volatile.  GCC does not consider static data items to be volatile
10764 because of this switch.
10765
10766 @item -fvolatile-static
10767 @opindex fvolatile-static
10768 Consider all memory references to static data to be volatile.
10769
10770 @item -fpic
10771 @opindex fpic
10772 @cindex global offset table
10773 @cindex PIC
10774 Generate position-independent code (PIC) suitable for use in a shared
10775 library, if supported for the target machine.  Such code accesses all
10776 constant addresses through a global offset table (GOT)@.  The dynamic
10777 loader resolves the GOT entries when the program starts (the dynamic
10778 loader is not part of GCC; it is part of the operating system).  If
10779 the GOT size for the linked executable exceeds a machine-specific
10780 maximum size, you get an error message from the linker indicating that
10781 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10782 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10783 on the m68k and RS/6000.  The 386 has no such limit.)
10784
10785 Position-independent code requires special support, and therefore works
10786 only on certain machines.  For the 386, GCC supports PIC for System V
10787 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10788 position-independent.
10789
10790 @item -fPIC
10791 @opindex fPIC
10792 If supported for the target machine, emit position-independent code,
10793 suitable for dynamic linking and avoiding any limit on the size of the
10794 global offset table.  This option makes a difference on the m68k, m88k,
10795 and the SPARC.
10796
10797 Position-independent code requires special support, and therefore works
10798 only on certain machines.
10799
10800 @item -ffixed-@var{reg}
10801 @opindex ffixed
10802 Treat the register named @var{reg} as a fixed register; generated code
10803 should never refer to it (except perhaps as a stack pointer, frame
10804 pointer or in some other fixed role).
10805
10806 @var{reg} must be the name of a register.  The register names accepted
10807 are machine-specific and are defined in the @code{REGISTER_NAMES}
10808 macro in the machine description macro file.
10809
10810 This flag does not have a negative form, because it specifies a
10811 three-way choice.
10812
10813 @item -fcall-used-@var{reg}
10814 @opindex fcall-used
10815 Treat the register named @var{reg} as an allocable register that is
10816 clobbered by function calls.  It may be allocated for temporaries or
10817 variables that do not live across a call.  Functions compiled this way
10818 will not save and restore the register @var{reg}.
10819
10820 It is an error to used this flag with the frame pointer or stack pointer.
10821 Use of this flag for other registers that have fixed pervasive roles in
10822 the machine's execution model will produce disastrous results.
10823
10824 This flag does not have a negative form, because it specifies a
10825 three-way choice.
10826
10827 @item -fcall-saved-@var{reg}
10828 @opindex fcall-saved
10829 Treat the register named @var{reg} as an allocable register saved by
10830 functions.  It may be allocated even for temporaries or variables that
10831 live across a call.  Functions compiled this way will save and restore
10832 the register @var{reg} if they use it.
10833
10834 It is an error to used this flag with the frame pointer or stack pointer.
10835 Use of this flag for other registers that have fixed pervasive roles in
10836 the machine's execution model will produce disastrous results.
10837
10838 A different sort of disaster will result from the use of this flag for
10839 a register in which function values may be returned.
10840
10841 This flag does not have a negative form, because it specifies a
10842 three-way choice.
10843
10844 @item -fpack-struct
10845 @opindex fpack-struct
10846 Pack all structure members together without holes.
10847
10848 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10849 code that is not binary compatible with code generated without that switch.
10850 Additionally, it makes the code suboptimal.
10851 Use it to conform to a non-default application binary interface.
10852
10853 @item -finstrument-functions
10854 @opindex finstrument-functions
10855 Generate instrumentation calls for entry and exit to functions.  Just
10856 after function entry and just before function exit, the following
10857 profiling functions will be called with the address of the current
10858 function and its call site.  (On some platforms,
10859 @code{__builtin_return_address} does not work beyond the current
10860 function, so the call site information may not be available to the
10861 profiling functions otherwise.)
10862
10863 @example
10864 void __cyg_profile_func_enter (void *this_fn,
10865                                void *call_site);
10866 void __cyg_profile_func_exit  (void *this_fn,
10867                                void *call_site);
10868 @end example
10869
10870 The first argument is the address of the start of the current function,
10871 which may be looked up exactly in the symbol table.
10872
10873 This instrumentation is also done for functions expanded inline in other
10874 functions.  The profiling calls will indicate where, conceptually, the
10875 inline function is entered and exited.  This means that addressable
10876 versions of such functions must be available.  If all your uses of a
10877 function are expanded inline, this may mean an additional expansion of
10878 code size.  If you use @samp{extern inline} in your C code, an
10879 addressable version of such functions must be provided.  (This is
10880 normally the case anyways, but if you get lucky and the optimizer always
10881 expands the functions inline, you might have gotten away without
10882 providing static copies.)
10883
10884 A function may be given the attribute @code{no_instrument_function}, in
10885 which case this instrumentation will not be done.  This can be used, for
10886 example, for the profiling functions listed above, high-priority
10887 interrupt routines, and any functions from which the profiling functions
10888 cannot safely be called (perhaps signal handlers, if the profiling
10889 routines generate output or allocate memory).
10890
10891 @item -fstack-check
10892 @opindex fstack-check
10893 Generate code to verify that you do not go beyond the boundary of the
10894 stack.  You should specify this flag if you are running in an
10895 environment with multiple threads, but only rarely need to specify it in
10896 a single-threaded environment since stack overflow is automatically
10897 detected on nearly all systems if there is only one stack.
10898
10899 Note that this switch does not actually cause checking to be done; the
10900 operating system must do that.  The switch causes generation of code
10901 to ensure that the operating system sees the stack being extended.
10902
10903 @item -fstack-limit-register=@var{reg}
10904 @itemx -fstack-limit-symbol=@var{sym}
10905 @itemx -fno-stack-limit
10906 @opindex fstack-limit-register
10907 @opindex fstack-limit-symbol
10908 @opindex fno-stack-limit
10909 Generate code to ensure that the stack does not grow beyond a certain value,
10910 either the value of a register or the address of a symbol.  If the stack
10911 would grow beyond the value, a signal is raised.  For most targets,
10912 the signal is raised before the stack overruns the boundary, so
10913 it is possible to catch the signal without taking special precautions.
10914
10915 For instance, if the stack starts at absolute address @samp{0x80000000}
10916 and grows downwards, you can use the flags
10917 @option{-fstack-limit-symbol=__stack_limit} and
10918 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10919 of 128KB@.  Note that this may only work with the GNU linker.
10920
10921 @cindex aliasing of parameters
10922 @cindex parameters, aliased
10923 @item -fargument-alias
10924 @itemx -fargument-noalias
10925 @itemx -fargument-noalias-global
10926 @opindex fargument-alias
10927 @opindex fargument-noalias
10928 @opindex fargument-noalias-global
10929 Specify the possible relationships among parameters and between
10930 parameters and global data.
10931
10932 @option{-fargument-alias} specifies that arguments (parameters) may
10933 alias each other and may alias global storage.@*
10934 @option{-fargument-noalias} specifies that arguments do not alias
10935 each other, but may alias global storage.@*
10936 @option{-fargument-noalias-global} specifies that arguments do not
10937 alias each other and do not alias global storage.
10938
10939 Each language will automatically use whatever option is required by
10940 the language standard.  You should not need to use these options yourself.
10941
10942 @item -fleading-underscore
10943 @opindex fleading-underscore
10944 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10945 change the way C symbols are represented in the object file.  One use
10946 is to help link with legacy assembly code.
10947
10948 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
10949 generate code that is not binary compatible with code generated without that
10950 switch.  Use it to conform to a non-default application binary interface.
10951 Not all targets provide complete support for this switch.
10952
10953 @item -ftls-model=@var{model}
10954 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10955 The @var{model} argument should be one of @code{global-dynamic},
10956 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10957
10958 The default without @option{-fpic} is @code{initial-exec}; with
10959 @option{-fpic} the default is @code{global-dynamic}.
10960 @end table
10961
10962 @c man end
10963
10964 @node Environment Variables
10965 @section Environment Variables Affecting GCC
10966 @cindex environment variables
10967
10968 @c man begin ENVIRONMENT
10969
10970 This section describes several environment variables that affect how GCC
10971 operates.  Some of them work by specifying directories or prefixes to use
10972 when searching for various kinds of files.  Some are used to specify other
10973 aspects of the compilation environment.
10974
10975 Note that you can also specify places to search using options such as
10976 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10977 take precedence over places specified using environment variables, which
10978 in turn take precedence over those specified by the configuration of GCC@.
10979 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10980 GNU Compiler Collection (GCC) Internals}.
10981
10982 @table @env
10983 @item LANG
10984 @itemx LC_CTYPE
10985 @c @itemx LC_COLLATE
10986 @itemx LC_MESSAGES
10987 @c @itemx LC_MONETARY
10988 @c @itemx LC_NUMERIC
10989 @c @itemx LC_TIME
10990 @itemx LC_ALL
10991 @findex LANG
10992 @findex LC_CTYPE
10993 @c @findex LC_COLLATE
10994 @findex LC_MESSAGES
10995 @c @findex LC_MONETARY
10996 @c @findex LC_NUMERIC
10997 @c @findex LC_TIME
10998 @findex LC_ALL
10999 @cindex locale
11000 These environment variables control the way that GCC uses
11001 localization information that allow GCC to work with different
11002 national conventions.  GCC inspects the locale categories
11003 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11004 so.  These locale categories can be set to any value supported by your
11005 installation.  A typical value is @samp{en_UK} for English in the United
11006 Kingdom.
11007
11008 The @env{LC_CTYPE} environment variable specifies character
11009 classification.  GCC uses it to determine the character boundaries in
11010 a string; this is needed for some multibyte encodings that contain quote
11011 and escape characters that would otherwise be interpreted as a string
11012 end or escape.
11013
11014 The @env{LC_MESSAGES} environment variable specifies the language to
11015 use in diagnostic messages.
11016
11017 If the @env{LC_ALL} environment variable is set, it overrides the value
11018 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11019 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11020 environment variable.  If none of these variables are set, GCC
11021 defaults to traditional C English behavior.
11022
11023 @item TMPDIR
11024 @findex TMPDIR
11025 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11026 files.  GCC uses temporary files to hold the output of one stage of
11027 compilation which is to be used as input to the next stage: for example,
11028 the output of the preprocessor, which is the input to the compiler
11029 proper.
11030
11031 @item GCC_EXEC_PREFIX
11032 @findex GCC_EXEC_PREFIX
11033 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11034 names of the subprograms executed by the compiler.  No slash is added
11035 when this prefix is combined with the name of a subprogram, but you can
11036 specify a prefix that ends with a slash if you wish.
11037
11038 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11039 an appropriate prefix to use based on the pathname it was invoked with.
11040
11041 If GCC cannot find the subprogram using the specified prefix, it
11042 tries looking in the usual places for the subprogram.
11043
11044 The default value of @env{GCC_EXEC_PREFIX} is
11045 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11046 of @code{prefix} when you ran the @file{configure} script.
11047
11048 Other prefixes specified with @option{-B} take precedence over this prefix.
11049
11050 This prefix is also used for finding files such as @file{crt0.o} that are
11051 used for linking.
11052
11053 In addition, the prefix is used in an unusual way in finding the
11054 directories to search for header files.  For each of the standard
11055 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11056 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11057 replacing that beginning with the specified prefix to produce an
11058 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11059 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11060 These alternate directories are searched first; the standard directories
11061 come next.
11062
11063 @item COMPILER_PATH
11064 @findex COMPILER_PATH
11065 The value of @env{COMPILER_PATH} is a colon-separated list of
11066 directories, much like @env{PATH}.  GCC tries the directories thus
11067 specified when searching for subprograms, if it can't find the
11068 subprograms using @env{GCC_EXEC_PREFIX}.
11069
11070 @item LIBRARY_PATH
11071 @findex LIBRARY_PATH
11072 The value of @env{LIBRARY_PATH} is a colon-separated list of
11073 directories, much like @env{PATH}.  When configured as a native compiler,
11074 GCC tries the directories thus specified when searching for special
11075 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11076 using GCC also uses these directories when searching for ordinary
11077 libraries for the @option{-l} option (but directories specified with
11078 @option{-L} come first).
11079
11080 @item LANG
11081 @findex LANG
11082 @cindex locale definition
11083 This variable is used to pass locale information to the compiler.  One way in
11084 which this information is used is to determine the character set to be used
11085 when character literals, string literals and comments are parsed in C and C++.
11086 When the compiler is configured to allow multibyte characters,
11087 the following values for @env{LANG} are recognized:
11088
11089 @table @samp
11090 @item C-JIS
11091 Recognize JIS characters.
11092 @item C-SJIS
11093 Recognize SJIS characters.
11094 @item C-EUCJP
11095 Recognize EUCJP characters.
11096 @end table
11097
11098 If @env{LANG} is not defined, or if it has some other value, then the
11099 compiler will use mblen and mbtowc as defined by the default locale to
11100 recognize and translate multibyte characters.
11101 @end table
11102
11103 @noindent
11104 Some additional environments variables affect the behavior of the
11105 preprocessor.
11106
11107 @include cppenv.texi
11108
11109 @c man end
11110
11111 @node Running Protoize
11112 @section Running Protoize
11113
11114 The program @code{protoize} is an optional part of GCC@.  You can use
11115 it to add prototypes to a program, thus converting the program to ISO
11116 C in one respect.  The companion program @code{unprotoize} does the
11117 reverse: it removes argument types from any prototypes that are found.
11118
11119 When you run these programs, you must specify a set of source files as
11120 command line arguments.  The conversion programs start out by compiling
11121 these files to see what functions they define.  The information gathered
11122 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11123
11124 After scanning comes actual conversion.  The specified files are all
11125 eligible to be converted; any files they include (whether sources or
11126 just headers) are eligible as well.
11127
11128 But not all the eligible files are converted.  By default,
11129 @code{protoize} and @code{unprotoize} convert only source and header
11130 files in the current directory.  You can specify additional directories
11131 whose files should be converted with the @option{-d @var{directory}}
11132 option.  You can also specify particular files to exclude with the
11133 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11134 directory name matches one of the specified directory names, and its
11135 name within the directory has not been excluded.
11136
11137 Basic conversion with @code{protoize} consists of rewriting most
11138 function definitions and function declarations to specify the types of
11139 the arguments.  The only ones not rewritten are those for varargs
11140 functions.
11141
11142 @code{protoize} optionally inserts prototype declarations at the
11143 beginning of the source file, to make them available for any calls that
11144 precede the function's definition.  Or it can insert prototype
11145 declarations with block scope in the blocks where undeclared functions
11146 are called.
11147
11148 Basic conversion with @code{unprotoize} consists of rewriting most
11149 function declarations to remove any argument types, and rewriting
11150 function definitions to the old-style pre-ISO form.
11151
11152 Both conversion programs print a warning for any function declaration or
11153 definition that they can't convert.  You can suppress these warnings
11154 with @option{-q}.
11155
11156 The output from @code{protoize} or @code{unprotoize} replaces the
11157 original source file.  The original file is renamed to a name ending
11158 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11159 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11160 for DOS) file already exists, then the source file is simply discarded.
11161
11162 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11163 scan the program and collect information about the functions it uses.
11164 So neither of these programs will work until GCC is installed.
11165
11166 Here is a table of the options you can use with @code{protoize} and
11167 @code{unprotoize}.  Each option works with both programs unless
11168 otherwise stated.
11169
11170 @table @code
11171 @item -B @var{directory}
11172 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11173 usual directory (normally @file{/usr/local/lib}).  This file contains
11174 prototype information about standard system functions.  This option
11175 applies only to @code{protoize}.
11176
11177 @item -c @var{compilation-options}
11178 Use  @var{compilation-options} as the options when running @code{gcc} to
11179 produce the @samp{.X} files.  The special option @option{-aux-info} is
11180 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
11181
11182 Note that the compilation options must be given as a single argument to
11183 @code{protoize} or @code{unprotoize}.  If you want to specify several
11184 @code{gcc} options, you must quote the entire set of compilation options
11185 to make them a single word in the shell.
11186
11187 There are certain @code{gcc} arguments that you cannot use, because they
11188 would produce the wrong kind of output.  These include @option{-g},
11189 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11190 the @var{compilation-options}, they are ignored.
11191
11192 @item -C
11193 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11194 systems) instead of @samp{.c}.  This is convenient if you are converting
11195 a C program to C++.  This option applies only to @code{protoize}.
11196
11197 @item -g
11198 Add explicit global declarations.  This means inserting explicit
11199 declarations at the beginning of each source file for each function
11200 that is called in the file and was not declared.  These declarations
11201 precede the first function definition that contains a call to an
11202 undeclared function.  This option applies only to @code{protoize}.
11203
11204 @item -i @var{string}
11205 Indent old-style parameter declarations with the string @var{string}.
11206 This option applies only to @code{protoize}.
11207
11208 @code{unprotoize} converts prototyped function definitions to old-style
11209 function definitions, where the arguments are declared between the
11210 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11211 uses five spaces as the indentation.  If you want to indent with just
11212 one space instead, use @option{-i " "}.
11213
11214 @item -k
11215 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11216 is finished.
11217
11218 @item -l
11219 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11220 a prototype declaration for each function in each block which calls the
11221 function without any declaration.  This option applies only to
11222 @code{protoize}.
11223
11224 @item -n
11225 Make no real changes.  This mode just prints information about the conversions
11226 that would have been done without @option{-n}.
11227
11228 @item -N
11229 Make no @samp{.save} files.  The original files are simply deleted.
11230 Use this option with caution.
11231
11232 @item -p @var{program}
11233 Use the program @var{program} as the compiler.  Normally, the name
11234 @file{gcc} is used.
11235
11236 @item -q
11237 Work quietly.  Most warnings are suppressed.
11238
11239 @item -v
11240 Print the version number, just like @option{-v} for @code{gcc}.
11241 @end table
11242
11243 If you need special compiler options to compile one of your program's
11244 source files, then you should generate that file's @samp{.X} file
11245 specially, by running @code{gcc} on that source file with the
11246 appropriate options and the option @option{-aux-info}.  Then run
11247 @code{protoize} on the entire set of files.  @code{protoize} will use
11248 the existing @samp{.X} file because it is newer than the source file.
11249 For example:
11250
11251 @example
11252 gcc -Dfoo=bar file1.c -aux-info file1.X
11253 protoize *.c
11254 @end example
11255
11256 @noindent
11257 You need to include the special files along with the rest in the
11258 @code{protoize} command, even though their @samp{.X} files already
11259 exist, because otherwise they won't get converted.
11260
11261 @xref{Protoize Caveats}, for more information on how to use
11262 @code{protoize} successfully.