9a8fa2afa5129cd4edca293c55f1a194751c7f80
[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  -###  --target-help  --help}
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  -Wmissing-declarations @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  -Wswitch  -Wswitch-default -Wswitch-enum @gol
232 -Wsystem-headers -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings}
236
237 @item C-only Warning Options
238 @gccoptlist{
239 -Wbad-function-cast  -Wmissing-prototypes  -Wnested-externs @gol
240 -Wstrict-prototypes  -Wtraditional}
241
242 @item Debugging Options
243 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
244 @gccoptlist{
245 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
246 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
250 -fmem-report @gol
251 -fprofile-arcs  -ftest-coverage  -ftime-report @gol
252 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
253 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
254 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
255 -print-multi-directory  -print-multi-lib @gol
256 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
257 -save-temps  -time}
258
259 @item Optimization Options
260 @xref{Optimize Options,,Options that Control Optimization}.
261 @gccoptlist{
262 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
263 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
264 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
265 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
266 -fdelayed-branch  -fdelete-null-pointer-checks @gol
267 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
268 -fforce-addr  -fforce-mem  -ffunction-sections @gol
269 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
270 -fif-conversion -fif-conversion2 @gol
271 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
272 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
273 -fmove-all-movables  -fnew-ra  -fno-default-inline @gol
274 -fno-defer-pop @gol
275 -fno-function-cse  -fno-guess-branch-probability @gol
276 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
277 -funsafe-math-optimizations -ffinite-math-only @gol
278 -fno-trapping-math -fno-zero-initialized-in-bss @gol
279 -fomit-frame-pointer  -foptimize-register-move @gol
280 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
281 -freduce-all-givs -fregmove  -frename-registers @gol
282 -freorder-blocks -freorder-functions @gol
283 -frerun-cse-after-loop  -frerun-loop-opt @gol
284 -fschedule-insns  -fschedule-insns2 -fsignaling-nans @gol
285 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
286 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
287 -ftrapv -funroll-all-loops  -funroll-loops  @gol
288 --param @var{name}=@var{value}
289 -O  -O0  -O1  -O2  -O3  -Os}
290
291 @item Preprocessor Options
292 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
293 @gccoptlist{
294 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
295 -C  -dD  -dI  -dM  -dN @gol
296 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
297 -idirafter @var{dir} @gol
298 -include @var{file}  -imacros @var{file} @gol
299 -iprefix @var{file}  -iwithprefix @var{dir} @gol
300 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
301 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
302 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option}}
303
304 @item Assembler Option
305 @xref{Assembler Options,,Passing Options to the Assembler}.
306 @gccoptlist{
307 -Wa,@var{option}}
308
309 @item Linker Options
310 @xref{Link Options,,Options for Linking}.
311 @gccoptlist{
312 @var{object-file-name}  -l@var{library} @gol
313 -nostartfiles  -nodefaultlibs  -nostdlib @gol
314 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
315 -Wl,@var{option}  -Xlinker @var{option} @gol
316 -u @var{symbol}}
317
318 @item Directory Options
319 @xref{Directory Options,,Options for Directory Search}.
320 @gccoptlist{
321 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
322
323 @item Target Options
324 @c I wrote this xref this way to avoid overfull hbox. -- rms
325 @xref{Target Options}.
326 @gccoptlist{
327 -V @var{version} -b @var{machine}}
328
329 @item Machine Dependent Options
330 @xref{Submodel Options,,Hardware Models and Configurations}.
331
332 @emph{M680x0 Options}
333 @gccoptlist{
334 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
335 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
336 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
337 -malign-int  -mstrict-align}
338
339 @emph{M68hc1x Options}
340 @gccoptlist{
341 -m6811  -m6812  -m68hc11  -m68hc12 @gol
342 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
343 -msoft-reg-count=@var{count}}
344
345 @emph{VAX Options}
346 @gccoptlist{
347 -mg  -mgnu  -munix}
348
349 @emph{SPARC Options}
350 @gccoptlist{
351 -mcpu=@var{cpu-type} @gol
352 -mtune=@var{cpu-type} @gol
353 -mcmodel=@var{code-model} @gol
354 -m32  -m64 @gol
355 -mapp-regs  -mbroken-saverestore  -mcypress @gol
356 -mfaster-structs  -mflat @gol
357 -mfpu  -mhard-float  -mhard-quad-float @gol
358 -mimpure-text  -mlive-g0  -mno-app-regs @gol
359 -mno-faster-structs  -mno-flat  -mno-fpu @gol
360 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
361 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
362 -msupersparc  -munaligned-doubles  -mv8}
363
364 @emph{Convex Options}
365 @gccoptlist{
366 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
367 -margcount  -mnoargcount @gol
368 -mlong32  -mlong64 @gol
369 -mvolatile-cache  -mvolatile-nocache}
370
371 @emph{AMD29K Options}
372 @gccoptlist{
373 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
374 -mlarge  -mnormal  -msmall @gol
375 -mkernel-registers  -mno-reuse-arg-regs @gol
376 -mno-stack-check  -mno-storem-bug @gol
377 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
378 -mstorem-bug  -muser-registers}
379
380 @emph{ARM Options}
381 @gccoptlist{
382 -mapcs-frame  -mno-apcs-frame @gol
383 -mapcs-26  -mapcs-32 @gol
384 -mapcs-stack-check  -mno-apcs-stack-check @gol
385 -mapcs-float  -mno-apcs-float @gol
386 -mapcs-reentrant  -mno-apcs-reentrant @gol
387 -msched-prolog  -mno-sched-prolog @gol
388 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
389 -malignment-traps  -mno-alignment-traps @gol
390 -msoft-float  -mhard-float  -mfpe @gol
391 -mthumb-interwork  -mno-thumb-interwork @gol
392 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
393 -mstructure-size-boundary=@var{n} @gol
394 -mbsd -mxopen  -mno-symrename @gol
395 -mabort-on-noreturn @gol
396 -mlong-calls  -mno-long-calls @gol
397 -msingle-pic-base  -mno-single-pic-base @gol
398 -mpic-register=@var{reg} @gol
399 -mnop-fun-dllimport @gol
400 -mpoke-function-name @gol
401 -mthumb  -marm @gol
402 -mtpcs-frame  -mtpcs-leaf-frame @gol
403 -mcaller-super-interworking  -mcallee-super-interworking }
404
405 @emph{MN10200 Options}
406 @gccoptlist{
407 -mrelax}
408
409 @emph{MN10300 Options}
410 @gccoptlist{
411 -mmult-bug  -mno-mult-bug @gol
412 -mam33  -mno-am33 @gol
413 -mno-crt0  -mrelax}
414
415 @emph{M32R/D Options}
416 @gccoptlist{
417 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
418 -G @var{num}}
419
420 @emph{M88K Options}
421 @gccoptlist{
422 -m88000  -m88100  -m88110  -mbig-pic @gol
423 -mcheck-zero-division  -mhandle-large-shift @gol
424 -midentify-revision  -mno-check-zero-division @gol
425 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
426 -mno-optimize-arg-area  -mno-serialize-volatile @gol
427 -mno-underscores  -mocs-debug-info @gol
428 -mocs-frame-position  -moptimize-arg-area @gol
429 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
430 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
431 -mversion-03.00  -mwarn-passed-structs}
432
433 @emph{RS/6000 and PowerPC Options}
434 @gccoptlist{
435 -mcpu=@var{cpu-type} @gol
436 -mtune=@var{cpu-type} @gol
437 -mpower  -mno-power  -mpower2  -mno-power2 @gol
438 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
439 -maltivec -mno-altivec @gol
440 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
441 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
442 -mnew-mnemonics  -mold-mnemonics @gol
443 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
444 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
445 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
446 -mstring  -mno-string  -mupdate  -mno-update @gol
447 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
448 -mstrict-align  -mno-strict-align  -mrelocatable @gol
449 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
450 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
451 -mcall-aix -mcall-sysv -mcall-netbsd @gol
452 -maix-struct-return -msvr4-struct-return @gol
453 -mabi=altivec -mabi=no-altivec @gol
454 -mabi=spe -mabi=no-spe @gol
455 -misel=yes -misel=no @gol
456 -mprototype  -mno-prototype @gol
457 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
458 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
459
460 @emph{RT Options}
461 @gccoptlist{
462 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
463 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
464 -mminimum-fp-blocks  -mnohc-struct-return}
465
466 @emph{MIPS Options}
467 @gccoptlist{
468 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
469 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
470 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
471 -mgas  -mgp32  -mgp64 @gol
472 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
473 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
474 -mmips-as  -mmips-tfile  -mno-abicalls @gol
475 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
476 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
477 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
478 -mrnames  -msoft-float @gol
479 -m4650  -msingle-float  -mmad @gol
480 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
481 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
482 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
483 -mbranch-likely -mno-branch-likely}
484
485 @emph{i386 and x86-64 Options}
486 @gccoptlist{
487 -mcpu=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
488 -masm=@var{dialect}  -mno-fancy-math-387 @gol
489 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
490 -mno-wide-multiply  -mrtd  -malign-double @gol
491 -mpreferred-stack-boundary=@var{num} @gol
492 -mmmx  -msse -msse2 -msse-math -m3dnow @gol
493 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
494 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
495 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
496 -mno-red-zone@gol
497 -mcmodel=@var{code-model} @gol
498 -m32 -m64}
499
500 @emph{HPPA Options}
501 @gccoptlist{
502 -march=@var{architecture-type} @gol
503 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
504 -mfast-indirect-calls  -mgas  -mjump-in-delay @gol
505 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
506 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
507 -mno-jump-in-delay  -mno-long-load-store @gol
508 -mno-portable-runtime  -mno-soft-float @gol
509 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
510 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
511 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
512
513 @emph{Intel 960 Options}
514 @gccoptlist{
515 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
516 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
517 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
518 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
519 -mno-complex-addr  -mno-leaf-procedures @gol
520 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
521 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
522 -mtail-call}
523
524 @emph{DEC Alpha Options}
525 @gccoptlist{
526 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
527 -mieee  -mieee-with-inexact  -mieee-conformant @gol
528 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
529 -mtrap-precision=@var{mode}  -mbuild-constants @gol
530 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
531 -mbwx  -mmax  -mfix  -mcix @gol
532 -mfloat-vax  -mfloat-ieee @gol
533 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
534 -mmemory-latency=@var{time}}
535
536 @emph{DEC Alpha/VMS Options}
537 @gccoptlist{
538 -mvms-return-codes}
539
540 @emph{Clipper Options}
541 @gccoptlist{
542 -mc300  -mc400}
543
544 @emph{H8/300 Options}
545 @gccoptlist{
546 -mrelax  -mh  -ms  -mint32  -malign-300}
547
548 @emph{SH Options}
549 @gccoptlist{
550 -m1  -m2  -m3  -m3e @gol
551 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
552 -m5-64media -m5-64media-nofpu @gol
553 -m5-32media -m5-32media-nofpu @gol
554 -m5-compact -m5-compact-nofpu @gol
555 -mb  -ml  -mdalign  -mrelax @gol
556 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
557 -mieee  -misize  -mpadstruct  -mspace @gol
558 -mprefergot  -musermode}
559
560 @emph{System V Options}
561 @gccoptlist{
562 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
563
564 @emph{ARC Options}
565 @gccoptlist{
566 -EB  -EL @gol
567 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
568 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
569
570 @emph{TMS320C3x/C4x Options}
571 @gccoptlist{
572 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
573 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
574 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
575 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
576
577 @emph{V850 Options}
578 @gccoptlist{
579 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
580 -mprolog-function  -mno-prolog-function  -mspace @gol
581 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
582 -mapp-regs -mno-app-regs @gol
583 -mdisable-callt -mno-disable-callt @gol
584 -mv850e @gol
585 -mv850  -mbig-switch}
586
587 @emph{NS32K Options}
588 @gccoptlist{
589 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
590 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
591 -mregparam  -mnoregparam  -msb  -mnosb @gol
592 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
593
594 @emph{AVR Options}
595 @gccoptlist{
596 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
597 -mcall-prologues  -mno-tablejump  -mtiny-stack}
598
599 @emph{MCore Options}
600 @gccoptlist{
601 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
602 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
603 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
604 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
605 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
606
607 @emph{MMIX Options}
608 @gccoptlist{
609 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
610 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
611 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
612 -mno-base-addresses -msingle-exit -mno-single-exit}
613
614 @emph{IA-64 Options}
615 @gccoptlist{
616 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
617 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
618 -mconstant-gp  -mauto-pic  -minline-divide-min-latency @gol
619 -minline-divide-max-throughput  -mno-dwarf2-asm @gol
620 -mfixed-range=@var{register-range}}
621
622 @emph{D30V Options}
623 @gccoptlist{
624 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
625 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
626
627 @emph{S/390 and zSeries Options}
628 @gccoptlist{
629 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
630 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
631 -m64 -m31 -mdebug -mno-debug}
632
633 @emph{CRIS Options}
634 @gccoptlist{
635 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
636 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
637 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
638 -mstack-align -mdata-align -mconst-align @gol
639 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
640 -melf -maout -melinux -mlinux -sim -sim2}
641
642 @emph{PDP-11 Options}
643 @gccoptlist{
644 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
645 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
646 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
647 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
648 -mbranch-expensive  -mbranch-cheap @gol
649 -msplit  -mno-split  -munix-asm  -mdec-asm}
650
651 @emph{Xstormy16 Options}
652 @gccoptlist{
653 -msim}
654
655 @emph{Xtensa Options}
656 @gccoptlist{
657 -mbig-endian -mlittle-endian @gol
658 -mdensity -mno-density @gol
659 -mmac16 -mno-mac16 @gol
660 -mmul16 -mno-mul16 @gol
661 -mmul32 -mno-mul32 @gol
662 -mnsa -mno-nsa @gol
663 -mminmax -mno-minmax @gol
664 -msext -mno-sext @gol
665 -mbooleans -mno-booleans @gol
666 -mhard-float -msoft-float @gol
667 -mfused-madd -mno-fused-madd @gol
668 -mserialize-volatile -mno-serialize-volatile @gol
669 -mtext-section-literals -mno-text-section-literals @gol
670 -mtarget-align -mno-target-align @gol
671 -mlongcalls -mno-longcalls}
672
673 @item Code Generation Options
674 @xref{Code Gen Options,,Options for Code Generation Conventions}.
675 @gccoptlist{
676 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
677 -ffixed-@var{reg} -fexceptions @gol
678 -fnon-call-exceptions  -funwind-tables @gol
679 -fasynchronous-unwind-tables @gol
680 -finhibit-size-directive  -finstrument-functions @gol
681 -fno-common  -fno-ident  -fno-gnu-linker @gol
682 -fpcc-struct-return  -fpic  -fPIC @gol
683 -freg-struct-return  -fshared-data  -fshort-enums @gol
684 -fshort-double  -fshort-wchar -fvolatile @gol
685 -fvolatile-global  -fvolatile-static @gol
686 -fverbose-asm  -fpack-struct  -fstack-check @gol
687 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
688 -fargument-alias  -fargument-noalias @gol
689 -fargument-noalias-global  -fleading-underscore @gol
690 -ftls-model=@var{model}}
691 @end table
692
693 @menu
694 * Overall Options::     Controlling the kind of output:
695                         an executable, object files, assembler files,
696                         or preprocessed source.
697 * C Dialect Options::   Controlling the variant of C language compiled.
698 * C++ Dialect Options:: Variations on C++.
699 * Objective-C Dialect Options:: Variations on Objective-C.
700 * Language Independent Options:: Controlling how diagnostics should be
701                         formatted.
702 * Warning Options::     How picky should the compiler be?
703 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
704 * Optimize Options::    How much optimization?
705 * Preprocessor Options:: Controlling header files and macro definitions.
706                          Also, getting dependency information for Make.
707 * Assembler Options::   Passing options to the assembler.
708 * Link Options::        Specifying libraries and so on.
709 * Directory Options::   Where to find header files and libraries.
710                         Where to find the compiler executable files.
711 * Spec Files::          How to pass switches to sub-processes.
712 * Target Options::      Running a cross-compiler, or an old version of GCC.
713 @end menu
714
715 @node Overall Options
716 @section Options Controlling the Kind of Output
717
718 Compilation can involve up to four stages: preprocessing, compilation
719 proper, assembly and linking, always in that order.  The first three
720 stages apply to an individual source file, and end by producing an
721 object file; linking combines all the object files (those newly
722 compiled, and those specified as input) into an executable file.
723
724 @cindex file name suffix
725 For any given input file, the file name suffix determines what kind of
726 compilation is done:
727
728 @table @gcctabopt
729 @item @var{file}.c
730 C source code which must be preprocessed.
731
732 @item @var{file}.i
733 C source code which should not be preprocessed.
734
735 @item @var{file}.ii
736 C++ source code which should not be preprocessed.
737
738 @item @var{file}.m
739 Objective-C source code.  Note that you must link with the library
740 @file{libobjc.a} to make an Objective-C program work.
741
742 @item @var{file}.mi
743 Objective-C source code which should not be preprocessed.
744
745 @item @var{file}.h
746 C header file (not to be compiled or linked).
747
748 @item @var{file}.cc
749 @itemx @var{file}.cp
750 @itemx @var{file}.cxx
751 @itemx @var{file}.cpp
752 @itemx @var{file}.c++
753 @itemx @var{file}.C
754 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
755 the last two letters must both be literally @samp{x}.  Likewise,
756 @samp{.C} refers to a literal capital C@.
757
758 @item @var{file}.f
759 @itemx @var{file}.for
760 @itemx @var{file}.FOR
761 Fortran source code which should not be preprocessed.
762
763 @item @var{file}.F
764 @itemx @var{file}.fpp
765 @itemx @var{file}.FPP
766 Fortran source code which must be preprocessed (with the traditional
767 preprocessor).
768
769 @item @var{file}.r
770 Fortran source code which must be preprocessed with a RATFOR
771 preprocessor (not included with GCC)@.
772
773 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
774 Using and Porting GNU Fortran}, for more details of the handling of
775 Fortran input files.
776
777 @c FIXME: Descriptions of Java file types.
778 @c @var{file}.java
779 @c @var{file}.class
780 @c @var{file}.zip
781 @c @var{file}.jar
782
783 @item @var{file}.ads
784 Ada source code file which contains a library unit declaration (a
785 declaration of a package, subprogram, or generic, or a generic
786 instantiation), or a library unit renaming declaration (a package,
787 generic, or subprogram renaming declaration).  Such files are also
788 called @dfn{specs}.
789
790 @itemx @var{file}.adb
791 Ada source code file containing a library unit body (a subprogram or
792 package body).  Such files are also called @dfn{bodies}.
793
794 @c GCC also knows about some suffixes for languages not yet included:
795 @c Pascal:
796 @c @var{file}.p
797 @c @var{file}.pas
798
799 @item @var{file}.s
800 Assembler code.
801
802 @item @var{file}.S
803 Assembler code which must be preprocessed.
804
805 @item @var{other}
806 An object file to be fed straight into linking.
807 Any file name with no recognized suffix is treated this way.
808 @end table
809
810 @opindex x
811 You can specify the input language explicitly with the @option{-x} option:
812
813 @table @gcctabopt
814 @item -x @var{language}
815 Specify explicitly the @var{language} for the following input files
816 (rather than letting the compiler choose a default based on the file
817 name suffix).  This option applies to all following input files until
818 the next @option{-x} option.  Possible values for @var{language} are:
819 @example
820 c  c-header  cpp-output
821 c++  c++-cpp-output
822 objective-c  objc-cpp-output
823 assembler  assembler-with-cpp
824 ada
825 f77  f77-cpp-input  ratfor
826 java
827 treelang
828 @end example
829
830 @item -x none
831 Turn off any specification of a language, so that subsequent files are
832 handled according to their file name suffixes (as they are if @option{-x}
833 has not been used at all).
834
835 @item -pass-exit-codes
836 @opindex pass-exit-codes
837 Normally the @command{gcc} program will exit with the code of 1 if any
838 phase of the compiler returns a non-success return code.  If you specify
839 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
840 numerically highest error produced by any phase that returned an error
841 indication.
842 @end table
843
844 If you only want some of the stages of compilation, you can use
845 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
846 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
847 @command{gcc} is to stop.  Note that some combinations (for example,
848 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
849
850 @table @gcctabopt
851 @item -c
852 @opindex c
853 Compile or assemble the source files, but do not link.  The linking
854 stage simply is not done.  The ultimate output is in the form of an
855 object file for each source file.
856
857 By default, the object file name for a source file is made by replacing
858 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
859
860 Unrecognized input files, not requiring compilation or assembly, are
861 ignored.
862
863 @item -S
864 @opindex S
865 Stop after the stage of compilation proper; do not assemble.  The output
866 is in the form of an assembler code file for each non-assembler input
867 file specified.
868
869 By default, the assembler file name for a source file is made by
870 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
871
872 Input files that don't require compilation are ignored.
873
874 @item -E
875 @opindex E
876 Stop after the preprocessing stage; do not run the compiler proper.  The
877 output is in the form of preprocessed source code, which is sent to the
878 standard output.
879
880 Input files which don't require preprocessing are ignored.
881
882 @cindex output file option
883 @item -o @var{file}
884 @opindex o
885 Place output in file @var{file}.  This applies regardless to whatever
886 sort of output is being produced, whether it be an executable file,
887 an object file, an assembler file or preprocessed C code.
888
889 Since only one output file can be specified, it does not make sense to
890 use @option{-o} when compiling more than one input file, unless you are
891 producing an executable file as output.
892
893 If @option{-o} is not specified, the default is to put an executable file
894 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
895 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
896 all preprocessed C source on standard output.
897
898 @item -v
899 @opindex v
900 Print (on standard error output) the commands executed to run the stages
901 of compilation.  Also print the version number of the compiler driver
902 program and of the preprocessor and the compiler proper.
903
904 @item -###
905 @opindex ###
906 Like @option{-v} except the commands are not executed and all command
907 arguments are quoted.  This is useful for shell scripts to capture the
908 driver-generated command lines.
909
910 @item -pipe
911 @opindex pipe
912 Use pipes rather than temporary files for communication between the
913 various stages of compilation.  This fails to work on some systems where
914 the assembler is unable to read from a pipe; but the GNU assembler has
915 no trouble.
916
917 @item --help
918 @opindex help
919 Print (on the standard output) a description of the command line options
920 understood by @command{gcc}.  If the @option{-v} option is also specified
921 then @option{--help} will also be passed on to the various processes
922 invoked by @command{gcc}, so that they can display the command line options
923 they accept.  If the @option{-W} option is also specified then command
924 line options which have no documentation associated with them will also
925 be displayed.
926
927 @item --target-help
928 @opindex target-help
929 Print (on the standard output) a description of target specific command
930 line options for each tool.
931 @end table
932
933 @node Invoking G++
934 @section Compiling C++ Programs
935
936 @cindex suffixes for C++ source
937 @cindex C++ source file suffixes
938 C++ source files conventionally use one of the suffixes @samp{.C},
939 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
940 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
941 files with these names and compiles them as C++ programs even if you
942 call the compiler the same way as for compiling C programs (usually with
943 the name @command{gcc}).
944
945 @findex g++
946 @findex c++
947 However, C++ programs often require class libraries as well as a
948 compiler that understands the C++ language---and under some
949 circumstances, you might want to compile programs from standard input,
950 or otherwise without a suffix that flags them as C++ programs.
951 @command{g++} is a program that calls GCC with the default language
952 set to C++, and automatically specifies linking against the C++
953 library.  On many systems, @command{g++} is also
954 installed with the name @command{c++}.
955
956 @cindex invoking @command{g++}
957 When you compile C++ programs, you may specify many of the same
958 command-line options that you use for compiling programs in any
959 language; or command-line options meaningful for C and related
960 languages; or options that are meaningful only for C++ programs.
961 @xref{C Dialect Options,,Options Controlling C Dialect}, for
962 explanations of options for languages related to C@.
963 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
964 explanations of options that are meaningful only for C++ programs.
965
966 @node C Dialect Options
967 @section Options Controlling C Dialect
968 @cindex dialect options
969 @cindex language dialect options
970 @cindex options, dialect
971
972 The following options control the dialect of C (or languages derived
973 from C, such as C++ and Objective-C) that the compiler accepts:
974
975 @table @gcctabopt
976 @cindex ANSI support
977 @cindex ISO support
978 @item -ansi
979 @opindex ansi
980 In C mode, support all ISO C90 programs.  In C++ mode,
981 remove GNU extensions that conflict with ISO C++.
982
983 This turns off certain features of GCC that are incompatible with ISO
984 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
985 such as the @code{asm} and @code{typeof} keywords, and
986 predefined macros such as @code{unix} and @code{vax} that identify the
987 type of system you are using.  It also enables the undesirable and
988 rarely used ISO trigraph feature.  For the C compiler,
989 it disables recognition of C++ style @samp{//} comments as well as
990 the @code{inline} keyword.
991
992 The alternate keywords @code{__asm__}, @code{__extension__},
993 @code{__inline__} and @code{__typeof__} continue to work despite
994 @option{-ansi}.  You would not want to use them in an ISO C program, of
995 course, but it is useful to put them in header files that might be included
996 in compilations done with @option{-ansi}.  Alternate predefined macros
997 such as @code{__unix__} and @code{__vax__} are also available, with or
998 without @option{-ansi}.
999
1000 The @option{-ansi} option does not cause non-ISO programs to be
1001 rejected gratuitously.  For that, @option{-pedantic} is required in
1002 addition to @option{-ansi}.  @xref{Warning Options}.
1003
1004 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1005 option is used.  Some header files may notice this macro and refrain
1006 from declaring certain functions or defining certain macros that the
1007 ISO standard doesn't call for; this is to avoid interfering with any
1008 programs that might use these names for other things.
1009
1010 Functions which would normally be built in but do not have semantics
1011 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1012 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1013 built-in functions provided by GCC}, for details of the functions
1014 affected.
1015
1016 @item -std=
1017 @opindex std
1018 Determine the language standard.  This option is currently only
1019 supported when compiling C or C++.  A value for this option must be
1020 provided; possible values are
1021
1022 @table @samp
1023 @item c89
1024 @itemx iso9899:1990
1025 ISO C90 (same as @option{-ansi}).
1026
1027 @item iso9899:199409
1028 ISO C90 as modified in amendment 1.
1029
1030 @item c99
1031 @itemx c9x
1032 @itemx iso9899:1999
1033 @itemx iso9899:199x
1034 ISO C99.  Note that this standard is not yet fully supported; see
1035 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1036 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1037
1038 @item gnu89
1039 Default, ISO C90 plus GNU extensions (including some C99 features).
1040
1041 @item gnu99
1042 @item gnu9x
1043 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1044 this will become the default.  The name @samp{gnu9x} is deprecated.
1045
1046 @item c++98
1047 The 1998 ISO C++ standard plus amendments.
1048
1049 @item gnu++98
1050 The same as @option{-std=c++98} plus GNU extensions.  This is the
1051 default for C++ code.
1052 @end table
1053
1054 Even when this option is not specified, you can still use some of the
1055 features of newer standards in so far as they do not conflict with
1056 previous C standards.  For example, you may use @code{__restrict__} even
1057 when @option{-std=c99} is not specified.
1058
1059 The @option{-std} options specifying some version of ISO C have the same
1060 effects as @option{-ansi}, except that features that were not in ISO C90
1061 but are in the specified version (for example, @samp{//} comments and
1062 the @code{inline} keyword in ISO C99) are not disabled.
1063
1064 @xref{Standards,,Language Standards Supported by GCC}, for details of
1065 these standard versions.
1066
1067 @item -aux-info @var{filename}
1068 @opindex aux-info
1069 Output to the given filename prototyped declarations for all functions
1070 declared and/or defined in a translation unit, including those in header
1071 files.  This option is silently ignored in any language other than C@.
1072
1073 Besides declarations, the file indicates, in comments, the origin of
1074 each declaration (source file and line), whether the declaration was
1075 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1076 @samp{O} for old, respectively, in the first character after the line
1077 number and the colon), and whether it came from a declaration or a
1078 definition (@samp{C} or @samp{F}, respectively, in the following
1079 character).  In the case of function definitions, a K&R-style list of
1080 arguments followed by their declarations is also provided, inside
1081 comments, after the declaration.
1082
1083 @item -fno-asm
1084 @opindex fno-asm
1085 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1086 keyword, so that code can use these words as identifiers.  You can use
1087 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1088 instead.  @option{-ansi} implies @option{-fno-asm}.
1089
1090 In C++, this switch only affects the @code{typeof} keyword, since
1091 @code{asm} and @code{inline} are standard keywords.  You may want to
1092 use the @option{-fno-gnu-keywords} flag instead, which has the same
1093 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1094 switch only affects the @code{asm} and @code{typeof} keywords, since
1095 @code{inline} is a standard keyword in ISO C99.
1096
1097 @item -fno-builtin
1098 @itemx -fno-builtin-@var{function}
1099 @opindex fno-builtin
1100 @cindex built-in functions
1101 Don't recognize built-in functions that do not begin with
1102 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1103 functions provided by GCC}, for details of the functions affected,
1104 including those which are not built-in functions when @option{-ansi} or
1105 @option{-std} options for strict ISO C conformance are used because they
1106 do not have an ISO standard meaning.
1107
1108 GCC normally generates special code to handle certain built-in functions
1109 more efficiently; for instance, calls to @code{alloca} may become single
1110 instructions that adjust the stack directly, and calls to @code{memcpy}
1111 may become inline copy loops.  The resulting code is often both smaller
1112 and faster, but since the function calls no longer appear as such, you
1113 cannot set a breakpoint on those calls, nor can you change the behavior
1114 of the functions by linking with a different library.
1115
1116 With the @option{-fno-builtin-@var{function}} option
1117 only the built-in function @var{function} is
1118 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1119 function is named this is not built-in in this version of GCC, this
1120 option is ignored.  There is no corresponding
1121 @option{-fbuiltin-@var{function}} option; if you wish to enable
1122 built-in functions selectively when using @option{-fno-builtin} or
1123 @option{-ffreestanding}, you may define macros such as:
1124
1125 @smallexample
1126 #define abs(n)          __builtin_abs ((n))
1127 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1128 @end smallexample
1129
1130 @item -fhosted
1131 @opindex fhosted
1132 @cindex hosted environment
1133
1134 Assert that compilation takes place in a hosted environment.  This implies
1135 @option{-fbuiltin}.  A hosted environment is one in which the
1136 entire standard library is available, and in which @code{main} has a return
1137 type of @code{int}.  Examples are nearly everything except a kernel.
1138 This is equivalent to @option{-fno-freestanding}.
1139
1140 @item -ffreestanding
1141 @opindex ffreestanding
1142 @cindex hosted environment
1143
1144 Assert that compilation takes place in a freestanding environment.  This
1145 implies @option{-fno-builtin}.  A freestanding environment
1146 is one in which the standard library may not exist, and program startup may
1147 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1148 This is equivalent to @option{-fno-hosted}.
1149
1150 @xref{Standards,,Language Standards Supported by GCC}, for details of
1151 freestanding and hosted environments.
1152
1153 @item -fms-extensions
1154 @opindex fms-extensions
1155 Accept some non-standard constructs used in Microsoft header files.
1156
1157 @item -trigraphs
1158 @opindex trigraphs
1159 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1160 options for strict ISO C conformance) implies @option{-trigraphs}.
1161
1162 @cindex traditional C language
1163 @cindex C language, traditional
1164 @item -traditional
1165 @itemx -traditional-cpp
1166 @opindex traditional-cpp
1167 @opindex traditional
1168 Formerly, these options caused GCC to attempt to emulate a pre-standard
1169 C compiler.  They are now only supported with the @option{-E} switch.
1170 The preprocessor continues to support a pre-standard mode.  See the GNU
1171 CPP manual for details.
1172
1173 @item -fcond-mismatch
1174 @opindex fcond-mismatch
1175 Allow conditional expressions with mismatched types in the second and
1176 third arguments.  The value of such an expression is void.  This option
1177 is not supported for C++.
1178
1179 @item -funsigned-char
1180 @opindex funsigned-char
1181 Let the type @code{char} be unsigned, like @code{unsigned char}.
1182
1183 Each kind of machine has a default for what @code{char} should
1184 be.  It is either like @code{unsigned char} by default or like
1185 @code{signed char} by default.
1186
1187 Ideally, a portable program should always use @code{signed char} or
1188 @code{unsigned char} when it depends on the signedness of an object.
1189 But many programs have been written to use plain @code{char} and
1190 expect it to be signed, or expect it to be unsigned, depending on the
1191 machines they were written for.  This option, and its inverse, let you
1192 make such a program work with the opposite default.
1193
1194 The type @code{char} is always a distinct type from each of
1195 @code{signed char} or @code{unsigned char}, even though its behavior
1196 is always just like one of those two.
1197
1198 @item -fsigned-char
1199 @opindex fsigned-char
1200 Let the type @code{char} be signed, like @code{signed char}.
1201
1202 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1203 the negative form of @option{-funsigned-char}.  Likewise, the option
1204 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1205
1206 @item -fsigned-bitfields
1207 @itemx -funsigned-bitfields
1208 @itemx -fno-signed-bitfields
1209 @itemx -fno-unsigned-bitfields
1210 @opindex fsigned-bitfields
1211 @opindex funsigned-bitfields
1212 @opindex fno-signed-bitfields
1213 @opindex fno-unsigned-bitfields
1214 These options control whether a bit-field is signed or unsigned, when the
1215 declaration does not use either @code{signed} or @code{unsigned}.  By
1216 default, such a bit-field is signed, because this is consistent: the
1217 basic integer types such as @code{int} are signed types.
1218
1219 @item -fwritable-strings
1220 @opindex fwritable-strings
1221 Store string constants in the writable data segment and don't uniquize
1222 them.  This is for compatibility with old programs which assume they can
1223 write into string constants.
1224
1225 Writing into string constants is a very bad idea; ``constants'' should
1226 be constant.
1227 @end table
1228
1229 @node C++ Dialect Options
1230 @section Options Controlling C++ Dialect
1231
1232 @cindex compiler options, C++
1233 @cindex C++ options, command line
1234 @cindex options, C++
1235 This section describes the command-line options that are only meaningful
1236 for C++ programs; but you can also use most of the GNU compiler options
1237 regardless of what language your program is in.  For example, you
1238 might compile a file @code{firstClass.C} like this:
1239
1240 @example
1241 g++ -g -frepo -O -c firstClass.C
1242 @end example
1243
1244 @noindent
1245 In this example, only @option{-frepo} is an option meant
1246 only for C++ programs; you can use the other options with any
1247 language supported by GCC@.
1248
1249 Here is a list of options that are @emph{only} for compiling C++ programs:
1250
1251 @table @gcctabopt
1252
1253 @item -fabi-version=@var{n}
1254 @opindex fabi-version
1255 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1256 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1257 version that conforms most closely to the C++ ABI specification.
1258 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1259 fixed.
1260
1261 The default is version 1.
1262
1263 @item -fno-access-control
1264 @opindex fno-access-control
1265 Turn off all access checking.  This switch is mainly useful for working
1266 around bugs in the access control code.
1267
1268 @item -fcheck-new
1269 @opindex fcheck-new
1270 Check that the pointer returned by @code{operator new} is non-null
1271 before attempting to modify the storage allocated.  The current Working
1272 Paper requires that @code{operator new} never return a null pointer, so
1273 this check is normally unnecessary.
1274
1275 An alternative to using this option is to specify that your
1276 @code{operator new} does not throw any exceptions; if you declare it
1277 @samp{throw()}, G++ will check the return value.  See also @samp{new
1278 (nothrow)}.
1279
1280 @item -fconserve-space
1281 @opindex fconserve-space
1282 Put uninitialized or runtime-initialized global variables into the
1283 common segment, as C does.  This saves space in the executable at the
1284 cost of not diagnosing duplicate definitions.  If you compile with this
1285 flag and your program mysteriously crashes after @code{main()} has
1286 completed, you may have an object that is being destroyed twice because
1287 two definitions were merged.
1288
1289 This option is no longer useful on most targets, now that support has
1290 been added for putting variables into BSS without making them common.
1291
1292 @item -fno-const-strings
1293 @opindex fno-const-strings
1294 Give string constants type @code{char *} instead of type @code{const
1295 char *}.  By default, G++ uses type @code{const char *} as required by
1296 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1297 actually modify the value of a string constant, unless you also use
1298 @option{-fwritable-strings}.
1299
1300 This option might be removed in a future release of G++.  For maximum
1301 portability, you should structure your code so that it works with
1302 string constants that have type @code{const char *}.
1303
1304 @item -fdollars-in-identifiers
1305 @opindex fdollars-in-identifiers
1306 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1307 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1308 @samp{$} by default on most target systems, but there are a few exceptions.)
1309 Traditional C allowed the character @samp{$} to form part of
1310 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1311
1312 @item -fno-elide-constructors
1313 @opindex fno-elide-constructors
1314 The C++ standard allows an implementation to omit creating a temporary
1315 which is only used to initialize another object of the same type.
1316 Specifying this option disables that optimization, and forces G++ to
1317 call the copy constructor in all cases.
1318
1319 @item -fno-enforce-eh-specs
1320 @opindex fno-enforce-eh-specs
1321 Don't check for violation of exception specifications at runtime.  This
1322 option violates the C++ standard, but may be useful for reducing code
1323 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1324 will still optimize based on the exception specifications.
1325
1326 @item -fexternal-templates
1327 @opindex fexternal-templates
1328
1329 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1330 template instantiation; template instances are emitted or not according
1331 to the location of the template definition.  @xref{Template
1332 Instantiation}, for more information.
1333
1334 This option is deprecated.
1335
1336 @item -falt-external-templates
1337 @opindex falt-external-templates
1338 Similar to @option{-fexternal-templates}, but template instances are
1339 emitted or not according to the place where they are first instantiated.
1340 @xref{Template Instantiation}, for more information.
1341
1342 This option is deprecated.
1343
1344 @item -ffor-scope
1345 @itemx -fno-for-scope
1346 @opindex ffor-scope
1347 @opindex fno-for-scope
1348 If @option{-ffor-scope} is specified, the scope of variables declared in
1349 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1350 as specified by the C++ standard.
1351 If @option{-fno-for-scope} is specified, the scope of variables declared in
1352 a @i{for-init-statement} extends to the end of the enclosing scope,
1353 as was the case in old versions of G++, and other (traditional)
1354 implementations of C++.
1355
1356 The default if neither flag is given to follow the standard,
1357 but to allow and give a warning for old-style code that would
1358 otherwise be invalid, or have different behavior.
1359
1360 @item -fno-gnu-keywords
1361 @opindex fno-gnu-keywords
1362 Do not recognize @code{typeof} as a keyword, so that code can use this
1363 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1364 @option{-ansi} implies @option{-fno-gnu-keywords}.
1365
1366 @item -fno-implicit-templates
1367 @opindex fno-implicit-templates
1368 Never emit code for non-inline templates which are instantiated
1369 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1370 @xref{Template Instantiation}, for more information.
1371
1372 @item -fno-implicit-inline-templates
1373 @opindex fno-implicit-inline-templates
1374 Don't emit code for implicit instantiations of inline templates, either.
1375 The default is to handle inlines differently so that compiles with and
1376 without optimization will need the same set of explicit instantiations.
1377
1378 @item -fno-implement-inlines
1379 @opindex fno-implement-inlines
1380 To save space, do not emit out-of-line copies of inline functions
1381 controlled by @samp{#pragma implementation}.  This will cause linker
1382 errors if these functions are not inlined everywhere they are called.
1383
1384 @item -fms-extensions
1385 @opindex fms-extensions
1386 Disable pedantic warnings about constructs used in MFC, such as implicit
1387 int and getting a pointer to member function via non-standard syntax.
1388
1389 @item -fno-nonansi-builtins
1390 @opindex fno-nonansi-builtins
1391 Disable built-in declarations of functions that are not mandated by
1392 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1393 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1394
1395 @item -fno-operator-names
1396 @opindex fno-operator-names
1397 Do not treat the operator name keywords @code{and}, @code{bitand},
1398 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1399 synonyms as keywords.
1400
1401 @item -fno-optional-diags
1402 @opindex fno-optional-diags
1403 Disable diagnostics that the standard says a compiler does not need to
1404 issue.  Currently, the only such diagnostic issued by G++ is the one for
1405 a name having multiple meanings within a class.
1406
1407 @item -fpermissive
1408 @opindex fpermissive
1409 Downgrade messages about nonconformant code from errors to warnings.  By
1410 default, G++ effectively sets @option{-pedantic-errors} without
1411 @option{-pedantic}; this option reverses that.  This behavior and this
1412 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1413
1414 @item -frepo
1415 @opindex frepo
1416 Enable automatic template instantiation at link time.  This option also
1417 implies @option{-fno-implicit-templates}.  @xref{Template
1418 Instantiation}, for more information.
1419
1420 @item -fno-rtti
1421 @opindex fno-rtti
1422 Disable generation of information about every class with virtual
1423 functions for use by the C++ runtime type identification features
1424 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1425 of the language, you can save some space by using this flag.  Note that
1426 exception handling uses the same information, but it will generate it as
1427 needed.
1428
1429 @item -fstats
1430 @opindex fstats
1431 Emit statistics about front-end processing at the end of the compilation.
1432 This information is generally only useful to the G++ development team.
1433
1434 @item -ftemplate-depth-@var{n}
1435 @opindex ftemplate-depth
1436 Set the maximum instantiation depth for template classes to @var{n}.
1437 A limit on the template instantiation depth is needed to detect
1438 endless recursions during template class instantiation.  ANSI/ISO C++
1439 conforming programs must not rely on a maximum depth greater than 17.
1440
1441 @item -fuse-cxa-atexit
1442 @opindex fuse-cxa-atexit
1443 Register destructors for objects with static storage duration with the
1444 @code{__cxa_atexit} function rather than the @code{atexit} function.
1445 This option is required for fully standards-compliant handling of static
1446 destructors, but will only work if your C library supports
1447 @code{__cxa_atexit}.
1448
1449 @item -fvtable-gc
1450 @opindex fvtable-gc
1451 Emit special relocations for vtables and virtual function references
1452 so that the linker can identify unused virtual functions and zero out
1453 vtable slots that refer to them.  This is most useful with
1454 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1455 also discard the functions themselves.
1456
1457 This optimization requires GNU as and GNU ld.  Not all systems support
1458 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1459
1460 @item -fno-weak
1461 @opindex fno-weak
1462 Do not use weak symbol support, even if it is provided by the linker.
1463 By default, G++ will use weak symbols if they are available.  This
1464 option exists only for testing, and should not be used by end-users;
1465 it will result in inferior code and has no benefits.  This option may
1466 be removed in a future release of G++.
1467
1468 @item -nostdinc++
1469 @opindex nostdinc++
1470 Do not search for header files in the standard directories specific to
1471 C++, but do still search the other standard directories.  (This option
1472 is used when building the C++ library.)
1473 @end table
1474
1475 In addition, these optimization, warning, and code generation options
1476 have meanings only for C++ programs:
1477
1478 @table @gcctabopt
1479 @item -fno-default-inline
1480 @opindex fno-default-inline
1481 Do not assume @samp{inline} for functions defined inside a class scope.
1482 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1483 functions will have linkage like inline functions; they just won't be
1484 inlined by default.
1485
1486 @item -Wabi @r{(C++ only)}
1487 @opindex Wabi
1488 Warn when G++ generates code that is probably not compatible with the
1489 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1490 all such cases, there are probably some cases that are not warned about, 
1491 even though G++ is generating incompatible code.  There may also be
1492 cases where warnings are emitted even though the code that is generated
1493 will be compatible.
1494
1495 You should rewrite your code to avoid these warnings if you are
1496 concerned about the fact that code generated by G++ may not be binary
1497 compatible with code generated by other compilers.
1498
1499 The known incompatibilites at this point include:
1500
1501 @itemize @bullet
1502
1503 @item
1504 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1505 pack data into the same byte as a base class.  For example:
1506
1507 @smallexample
1508 struct A @{ virtual void f(); int f1 : 1; @};
1509 struct B : public A @{ int f2 : 1; @};
1510 @end smallexample
1511
1512 @noindent
1513 In this case, G++ will place @code{B::f2} into the same byte
1514 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1515 by explicitly padding @code{A} so that its size is a multiple of the
1516 byte size on your platform; that will cause G++ and other compilers to
1517 layout @code{B} identically.
1518
1519 @item
1520 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1521 tail padding when laying out virtual bases.  For example:
1522
1523 @smallexample
1524 struct A @{ virtual void f(); char c1; @};
1525 struct B @{ B(); char c2; @};
1526 struct C : public A, public virtual B @{@};
1527 @end smallexample
1528
1529 @noindent
1530 In this case, G++ will not place @code{B} into the tail-padding for
1531 @code{A}; other compilers will.  You can avoid this problem by
1532 explicitly padding @code{A} so that its size is a multiple of its
1533 alignment (ignoring virtual base classes); that will cause G++ and other
1534 compilers to layout @code{C} identically.
1535
1536 @item
1537 Incorrect handling of bit-fields with declared widths greater than that
1538 of their underlying types, when the bit-fields appear in a union.  For
1539 example:
1540
1541 @smallexample
1542 union U @{ int i : 4096; @};
1543 @end smallexample
1544
1545 @noindent
1546 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1547 union too small by the number of bits in an @code{int}.
1548
1549 @item
1550 Empty classes can be placed at incorrect offsets.  For example:
1551  
1552 @smallexample
1553 struct A @{@};
1554
1555 struct B @{
1556   A a;
1557   virtual void f ();
1558 @};
1559
1560 struct C : public B, public A @{@};
1561 @end smallexample
1562
1563 @noindent
1564 G++ will place the @code{A} base class of @code{C} at a non-zero offset;
1565 it should be placed at offset zero.  G++ mistakenly believes that the
1566 @code{A} data member of @code{B} is already at offset zero.
1567
1568 @end itemize
1569
1570 @item -Wctor-dtor-privacy @r{(C++ only)}
1571 @opindex Wctor-dtor-privacy
1572 Warn when a class seems unusable, because all the constructors or
1573 destructors in a class are private and the class has no friends or
1574 public static member functions.  This warning is enabled by default.
1575
1576 @item -Wnon-virtual-dtor @r{(C++ only)}
1577 @opindex Wnon-virtual-dtor
1578 Warn when a class declares a non-virtual destructor that should probably
1579 be virtual, because it looks like the class will be used polymorphically.
1580 This warning is enabled by @option{-Wall}.
1581
1582 @item -Wreorder @r{(C++ only)}
1583 @opindex Wreorder
1584 @cindex reordering, warning
1585 @cindex warning for reordering of member initializers
1586 Warn when the order of member initializers given in the code does not
1587 match the order in which they must be executed.  For instance:
1588
1589 @smallexample
1590 struct A @{
1591   int i;
1592   int j;
1593   A(): j (0), i (1) @{ @}
1594 @};
1595 @end smallexample
1596
1597 Here the compiler will warn that the member initializers for @samp{i}
1598 and @samp{j} will be rearranged to match the declaration order of the
1599 members.  This warning is enabled by @option{-Wall}.
1600 @end table
1601
1602 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1603
1604 @table @gcctabopt
1605 @item -Weffc++ @r{(C++ only)}
1606 @opindex Weffc++
1607 Warn about violations of the following style guidelines from Scott Meyers'
1608 @cite{Effective C++} book:
1609
1610 @itemize @bullet
1611 @item
1612 Item 11:  Define a copy constructor and an assignment operator for classes
1613 with dynamically allocated memory.
1614
1615 @item
1616 Item 12:  Prefer initialization to assignment in constructors.
1617
1618 @item
1619 Item 14:  Make destructors virtual in base classes.
1620
1621 @item
1622 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1623
1624 @item
1625 Item 23:  Don't try to return a reference when you must return an object.
1626
1627 @end itemize
1628
1629 and about violations of the following style guidelines from Scott Meyers'
1630 @cite{More Effective C++} book:
1631
1632 @itemize @bullet
1633 @item
1634 Item 6:  Distinguish between prefix and postfix forms of increment and
1635 decrement operators.
1636
1637 @item
1638 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1639
1640 @end itemize
1641
1642 If you use this option, you should be aware that the standard library
1643 headers do not obey all of these guidelines; you can use @samp{grep -v}
1644 to filter out those warnings.
1645
1646 @item -Wno-deprecated @r{(C++ only)}
1647 @opindex Wno-deprecated
1648 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1649
1650 @item -Wno-non-template-friend @r{(C++ only)}
1651 @opindex Wno-non-template-friend
1652 Disable warnings when non-templatized friend functions are declared
1653 within a template.  With the advent of explicit template specification
1654 support in G++, if the name of the friend is an unqualified-id (i.e.,
1655 @samp{friend foo(int)}), the C++ language specification demands that the
1656 friend declare or define an ordinary, nontemplate function.  (Section
1657 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1658 could be interpreted as a particular specialization of a templatized
1659 function.  Because this non-conforming behavior is no longer the default
1660 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1661 check existing code for potential trouble spots, and is on by default.
1662 This new compiler behavior can be turned off with
1663 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1664 but disables the helpful warning.
1665
1666 @item -Wold-style-cast @r{(C++ only)}
1667 @opindex Wold-style-cast
1668 Warn if an old-style (C-style) cast to a non-void type is used within
1669 a C++ program.  The new-style casts (@samp{static_cast},
1670 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1671 unintended effects, and much easier to grep for.
1672
1673 @item -Woverloaded-virtual @r{(C++ only)}
1674 @opindex Woverloaded-virtual
1675 @cindex overloaded virtual fn, warning
1676 @cindex warning for overloaded virtual fn
1677 Warn when a function declaration hides virtual functions from a
1678 base class.  For example, in:
1679
1680 @smallexample
1681 struct A @{
1682   virtual void f();
1683 @};
1684
1685 struct B: public A @{
1686   void f(int);
1687 @};
1688 @end smallexample
1689
1690 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1691 like this:
1692
1693 @smallexample
1694 B* b;
1695 b->f();
1696 @end smallexample
1697
1698 will fail to compile.
1699
1700 @item -Wno-pmf-conversions @r{(C++ only)}
1701 @opindex Wno-pmf-conversions
1702 Disable the diagnostic for converting a bound pointer to member function
1703 to a plain pointer.
1704
1705 @item -Wsign-promo @r{(C++ only)}
1706 @opindex Wsign-promo
1707 Warn when overload resolution chooses a promotion from unsigned or
1708 enumeral type to a signed type over a conversion to an unsigned type of
1709 the same size.  Previous versions of G++ would try to preserve
1710 unsignedness, but the standard mandates the current behavior.
1711
1712 @item -Wsynth @r{(C++ only)}
1713 @opindex Wsynth
1714 @cindex warning for synthesized methods
1715 @cindex synthesized methods, warning
1716 Warn when G++'s synthesis behavior does not match that of cfront.  For
1717 instance:
1718
1719 @smallexample
1720 struct A @{
1721   operator int ();
1722   A& operator = (int);
1723 @};
1724
1725 main ()
1726 @{
1727   A a,b;
1728   a = b;
1729 @}
1730 @end smallexample
1731
1732 In this example, G++ will synthesize a default @samp{A& operator =
1733 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1734 @end table
1735
1736 @node Objective-C Dialect Options
1737 @section Options Controlling Objective-C Dialect
1738
1739 @cindex compiler options, Objective-C
1740 @cindex Objective-C options, command line
1741 @cindex options, Objective-C
1742 This section describes the command-line options that are only meaningful
1743 for Objective-C programs; but you can also use most of the GNU compiler
1744 options regardless of what language your program is in.  For example,
1745 you might compile a file @code{some_class.m} like this:
1746
1747 @example
1748 gcc -g -fgnu-runtime -O -c some_class.m
1749 @end example
1750
1751 @noindent
1752 In this example, only @option{-fgnu-runtime} is an option meant only for
1753 Objective-C programs; you can use the other options with any language
1754 supported by GCC@.
1755
1756 Here is a list of options that are @emph{only} for compiling Objective-C
1757 programs:
1758
1759 @table @gcctabopt
1760 @item -fconstant-string-class=@var{class-name}
1761 @opindex fconstant-string-class
1762 Use @var{class-name} as the name of the class to instantiate for each
1763 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1764 class name is @code{NXConstantString}.
1765
1766 @item -fgnu-runtime
1767 @opindex fgnu-runtime
1768 Generate object code compatible with the standard GNU Objective-C
1769 runtime.  This is the default for most types of systems.
1770
1771 @item -fnext-runtime
1772 @opindex fnext-runtime
1773 Generate output compatible with the NeXT runtime.  This is the default
1774 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1775 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1776 used.
1777
1778 @item -gen-decls
1779 @opindex gen-decls
1780 Dump interface declarations for all classes seen in the source file to a
1781 file named @file{@var{sourcename}.decl}.
1782
1783 @item -Wno-protocol
1784 @opindex Wno-protocol
1785 If a class is declared to implement a protocol, a warning is issued for
1786 every method in the protocol that is not implemented by the class.  The
1787 default behaviour is to issue a warning for every method not explicitly
1788 implemented in the class, even if a method implementation is inherited
1789 from the superclass.  If you use the @code{-Wno-protocol} option, then
1790 methods inherited from the superclass are considered to be implemented,
1791 and no warning is issued for them.
1792
1793 @item -Wselector
1794 @opindex Wselector
1795 Warn if multiple methods of different types for the same selector are
1796 found during compilation.  The check is performed on the list of methods
1797 in the final stage of compilation.  Additionally, a check is performed
1798 that for each selector appearing in a @code{@@selector(@dots{})}
1799 expression, a corresponding method with that selector has been found
1800 during compilation.  Because these checks scan the method table only at
1801 the end of compilation, these warnings are not produced if the final
1802 stage of compilation is not reached, for example because an error is
1803 found during compilation, or because the @code{-fsyntax-only} option is
1804 being used.
1805
1806 @item -Wundeclared-selector
1807 @opindex Wundeclared-selector
1808 Warn if a @code{@@selector(@dots{})} expression referring to an
1809 undeclared selector is found.  A selector is considered undeclared if no
1810 method with that name has been declared (explicitly, in an
1811 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1812 an @code{@@implementation} section) before the
1813 @code{@@selector(@dots{})} expression.  This option always performs its
1814 checks as soon as a @code{@@selector(@dots{})} expression is found
1815 (while @code{-Wselector} only performs its checks in the final stage of
1816 compilation), and so additionally enforces the coding style convention
1817 that methods and selectors must be declared before being used.
1818
1819 @c not documented because only avail via -Wp
1820 @c @item -print-objc-runtime-info
1821
1822 @end table
1823
1824 @node Language Independent Options
1825 @section Options to Control Diagnostic Messages Formatting
1826 @cindex options to control diagnostics formatting
1827 @cindex diagnostic messages
1828 @cindex message formatting
1829
1830 Traditionally, diagnostic messages have been formatted irrespective of
1831 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1832 below can be used to control the diagnostic messages formatting
1833 algorithm, e.g.@: how many characters per line, how often source location
1834 information should be reported.  Right now, only the C++ front end can
1835 honor these options.  However it is expected, in the near future, that
1836 the remaining front ends would be able to digest them correctly.
1837
1838 @table @gcctabopt
1839 @item -fmessage-length=@var{n}
1840 @opindex fmessage-length
1841 Try to format error messages so that they fit on lines of about @var{n}
1842 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1843 the front ends supported by GCC@.  If @var{n} is zero, then no
1844 line-wrapping will be done; each error message will appear on a single
1845 line.
1846
1847 @opindex fdiagnostics-show-location
1848 @item -fdiagnostics-show-location=once
1849 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1850 reporter to emit @emph{once} source location information; that is, in
1851 case the message is too long to fit on a single physical line and has to
1852 be wrapped, the source location won't be emitted (as prefix) again,
1853 over and over, in subsequent continuation lines.  This is the default
1854 behavior.
1855
1856 @item -fdiagnostics-show-location=every-line
1857 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1858 messages reporter to emit the same source location information (as
1859 prefix) for physical lines that result from the process of breaking
1860 a message which is too long to fit on a single line.
1861
1862 @end table
1863
1864 @node Warning Options
1865 @section Options to Request or Suppress Warnings
1866 @cindex options to control warnings
1867 @cindex warning messages
1868 @cindex messages, warning
1869 @cindex suppressing warnings
1870
1871 Warnings are diagnostic messages that report constructions which
1872 are not inherently erroneous but which are risky or suggest there
1873 may have been an error.
1874
1875 You can request many specific warnings with options beginning @samp{-W},
1876 for example @option{-Wimplicit} to request warnings on implicit
1877 declarations.  Each of these specific warning options also has a
1878 negative form beginning @samp{-Wno-} to turn off warnings;
1879 for example, @option{-Wno-implicit}.  This manual lists only one of the
1880 two forms, whichever is not the default.
1881
1882 The following options control the amount and kinds of warnings produced
1883 by GCC; for further, language-specific options also refer to
1884 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1885
1886 @table @gcctabopt
1887 @cindex syntax checking
1888 @item -fsyntax-only
1889 @opindex fsyntax-only
1890 Check the code for syntax errors, but don't do anything beyond that.
1891
1892 @item -pedantic
1893 @opindex pedantic
1894 Issue all the warnings demanded by strict ISO C and ISO C++;
1895 reject all programs that use forbidden extensions, and some other
1896 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1897 version of the ISO C standard specified by any @option{-std} option used.
1898
1899 Valid ISO C and ISO C++ programs should compile properly with or without
1900 this option (though a rare few will require @option{-ansi} or a
1901 @option{-std} option specifying the required version of ISO C)@.  However,
1902 without this option, certain GNU extensions and traditional C and C++
1903 features are supported as well.  With this option, they are rejected.
1904
1905 @option{-pedantic} does not cause warning messages for use of the
1906 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1907 warnings are also disabled in the expression that follows
1908 @code{__extension__}.  However, only system header files should use
1909 these escape routes; application programs should avoid them.
1910 @xref{Alternate Keywords}.
1911
1912 Some users try to use @option{-pedantic} to check programs for strict ISO
1913 C conformance.  They soon find that it does not do quite what they want:
1914 it finds some non-ISO practices, but not all---only those for which
1915 ISO C @emph{requires} a diagnostic, and some others for which
1916 diagnostics have been added.
1917
1918 A feature to report any failure to conform to ISO C might be useful in
1919 some instances, but would require considerable additional work and would
1920 be quite different from @option{-pedantic}.  We don't have plans to
1921 support such a feature in the near future.
1922
1923 Where the standard specified with @option{-std} represents a GNU
1924 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1925 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1926 extended dialect is based.  Warnings from @option{-pedantic} are given
1927 where they are required by the base standard.  (It would not make sense
1928 for such warnings to be given only for features not in the specified GNU
1929 C dialect, since by definition the GNU dialects of C include all
1930 features the compiler supports with the given option, and there would be
1931 nothing to warn about.)
1932
1933 @item -pedantic-errors
1934 @opindex pedantic-errors
1935 Like @option{-pedantic}, except that errors are produced rather than
1936 warnings.
1937
1938 @item -w
1939 @opindex w
1940 Inhibit all warning messages.
1941
1942 @item -Wno-import
1943 @opindex Wno-import
1944 Inhibit warning messages about the use of @samp{#import}.
1945
1946 @item -Wchar-subscripts
1947 @opindex Wchar-subscripts
1948 Warn if an array subscript has type @code{char}.  This is a common cause
1949 of error, as programmers often forget that this type is signed on some
1950 machines.
1951
1952 @item -Wcomment
1953 @opindex Wcomment
1954 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1955 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1956
1957 @item -Wformat
1958 @opindex Wformat
1959 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1960 the arguments supplied have types appropriate to the format string
1961 specified, and that the conversions specified in the format string make
1962 sense.  This includes standard functions, and others specified by format
1963 attributes (@pxref{Function Attributes}), in the @code{printf},
1964 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1965 not in the C standard) families.
1966
1967 The formats are checked against the format features supported by GNU
1968 libc version 2.2.  These include all ISO C90 and C99 features, as well
1969 as features from the Single Unix Specification and some BSD and GNU
1970 extensions.  Other library implementations may not support all these
1971 features; GCC does not support warning about features that go beyond a
1972 particular library's limitations.  However, if @option{-pedantic} is used
1973 with @option{-Wformat}, warnings will be given about format features not
1974 in the selected standard version (but not for @code{strfmon} formats,
1975 since those are not in any version of the C standard).  @xref{C Dialect
1976 Options,,Options Controlling C Dialect}.
1977
1978 Since @option{-Wformat} also checks for null format arguments for
1979 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
1980
1981 @option{-Wformat} is included in @option{-Wall}.  For more control over some
1982 aspects of format checking, the options @option{-Wno-format-y2k},
1983 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
1984 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
1985 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
1986
1987 @item -Wno-format-y2k
1988 @opindex Wno-format-y2k
1989 If @option{-Wformat} is specified, do not warn about @code{strftime}
1990 formats which may yield only a two-digit year.
1991
1992 @item -Wno-format-extra-args
1993 @opindex Wno-format-extra-args
1994 If @option{-Wformat} is specified, do not warn about excess arguments to a
1995 @code{printf} or @code{scanf} format function.  The C standard specifies
1996 that such arguments are ignored.
1997
1998 Where the unused arguments lie between used arguments that are
1999 specified with @samp{$} operand number specifications, normally
2000 warnings are still given, since the implementation could not know what
2001 type to pass to @code{va_arg} to skip the unused arguments.  However,
2002 in the case of @code{scanf} formats, this option will suppress the
2003 warning if the unused arguments are all pointers, since the Single
2004 Unix Specification says that such unused arguments are allowed.
2005
2006 @item -Wno-format-zero-length
2007 @opindex Wno-format-zero-length
2008 If @option{-Wformat} is specified, do not warn about zero-length formats.
2009 The C standard specifies that zero-length formats are allowed.
2010
2011 @item -Wformat-nonliteral
2012 @opindex Wformat-nonliteral
2013 If @option{-Wformat} is specified, also warn if the format string is not a
2014 string literal and so cannot be checked, unless the format function
2015 takes its format arguments as a @code{va_list}.
2016
2017 @item -Wformat-security
2018 @opindex Wformat-security
2019 If @option{-Wformat} is specified, also warn about uses of format
2020 functions that represent possible security problems.  At present, this
2021 warns about calls to @code{printf} and @code{scanf} functions where the
2022 format string is not a string literal and there are no format arguments,
2023 as in @code{printf (foo);}.  This may be a security hole if the format
2024 string came from untrusted input and contains @samp{%n}.  (This is
2025 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2026 in future warnings may be added to @option{-Wformat-security} that are not
2027 included in @option{-Wformat-nonliteral}.)
2028
2029 @item -Wformat=2
2030 @opindex Wformat=2
2031 Enable @option{-Wformat} plus format checks not included in
2032 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2033 -Wformat-nonliteral -Wformat-security}.
2034
2035 @item -Wnonnull
2036 @opindex Wnonnull
2037 Enable warning about passing a null pointer for arguments marked as
2038 requiring a non-null value by the @code{nonnull} function attribute.
2039
2040 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2041 can be disabled with the @option{-Wno-nonnull} option.
2042
2043 @item -Wimplicit-int
2044 @opindex Wimplicit-int
2045 Warn when a declaration does not specify a type.
2046
2047 @item -Wimplicit-function-declaration
2048 @itemx -Werror-implicit-function-declaration
2049 @opindex Wimplicit-function-declaration
2050 @opindex Werror-implicit-function-declaration
2051 Give a warning (or error) whenever a function is used before being
2052 declared.
2053
2054 @item -Wimplicit
2055 @opindex Wimplicit
2056 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2057
2058 @item -Wmain
2059 @opindex Wmain
2060 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2061 function with external linkage, returning int, taking either zero
2062 arguments, two, or three arguments of appropriate types.
2063
2064 @item -Wmissing-braces
2065 @opindex Wmissing-braces
2066 Warn if an aggregate or union initializer is not fully bracketed.  In
2067 the following example, the initializer for @samp{a} is not fully
2068 bracketed, but that for @samp{b} is fully bracketed.
2069
2070 @smallexample
2071 int a[2][2] = @{ 0, 1, 2, 3 @};
2072 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2073 @end smallexample
2074
2075 @item -Wparentheses
2076 @opindex Wparentheses
2077 Warn if parentheses are omitted in certain contexts, such
2078 as when there is an assignment in a context where a truth value
2079 is expected, or when operators are nested whose precedence people
2080 often get confused about.
2081
2082 Also warn about constructions where there may be confusion to which
2083 @code{if} statement an @code{else} branch belongs.  Here is an example of
2084 such a case:
2085
2086 @smallexample
2087 @group
2088 @{
2089   if (a)
2090     if (b)
2091       foo ();
2092   else
2093     bar ();
2094 @}
2095 @end group
2096 @end smallexample
2097
2098 In C, every @code{else} branch belongs to the innermost possible @code{if}
2099 statement, which in this example is @code{if (b)}.  This is often not
2100 what the programmer expected, as illustrated in the above example by
2101 indentation the programmer chose.  When there is the potential for this
2102 confusion, GCC will issue a warning when this flag is specified.
2103 To eliminate the warning, add explicit braces around the innermost
2104 @code{if} statement so there is no way the @code{else} could belong to
2105 the enclosing @code{if}.  The resulting code would look like this:
2106
2107 @smallexample
2108 @group
2109 @{
2110   if (a)
2111     @{
2112       if (b)
2113         foo ();
2114       else
2115         bar ();
2116     @}
2117 @}
2118 @end group
2119 @end smallexample
2120
2121 @item -Wsequence-point
2122 @opindex Wsequence-point
2123 Warn about code that may have undefined semantics because of violations
2124 of sequence point rules in the C standard.
2125
2126 The C standard defines the order in which expressions in a C program are
2127 evaluated in terms of @dfn{sequence points}, which represent a partial
2128 ordering between the execution of parts of the program: those executed
2129 before the sequence point, and those executed after it.  These occur
2130 after the evaluation of a full expression (one which is not part of a
2131 larger expression), after the evaluation of the first operand of a
2132 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2133 function is called (but after the evaluation of its arguments and the
2134 expression denoting the called function), and in certain other places.
2135 Other than as expressed by the sequence point rules, the order of
2136 evaluation of subexpressions of an expression is not specified.  All
2137 these rules describe only a partial order rather than a total order,
2138 since, for example, if two functions are called within one expression
2139 with no sequence point between them, the order in which the functions
2140 are called is not specified.  However, the standards committee have
2141 ruled that function calls do not overlap.
2142
2143 It is not specified when between sequence points modifications to the
2144 values of objects take effect.  Programs whose behavior depends on this
2145 have undefined behavior; the C standard specifies that ``Between the
2146 previous and next sequence point an object shall have its stored value
2147 modified at most once by the evaluation of an expression.  Furthermore,
2148 the prior value shall be read only to determine the value to be
2149 stored.''.  If a program breaks these rules, the results on any
2150 particular implementation are entirely unpredictable.
2151
2152 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2153 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2154 diagnosed by this option, and it may give an occasional false positive
2155 result, but in general it has been found fairly effective at detecting
2156 this sort of problem in programs.
2157
2158 The present implementation of this option only works for C programs.  A
2159 future implementation may also work for C++ programs.
2160
2161 The C standard is worded confusingly, therefore there is some debate
2162 over the precise meaning of the sequence point rules in subtle cases.
2163 Links to discussions of the problem, including proposed formal
2164 definitions, may be found on our readings page, at
2165 @w{@uref{http://gcc.gnu.org/readings.html}}.
2166
2167 @item -Wreturn-type
2168 @opindex Wreturn-type
2169 Warn whenever a function is defined with a return-type that defaults to
2170 @code{int}.  Also warn about any @code{return} statement with no
2171 return-value in a function whose return-type is not @code{void}.
2172
2173 For C++, a function without return type always produces a diagnostic
2174 message, even when @option{-Wno-return-type} is specified.  The only
2175 exceptions are @samp{main} and functions defined in system headers.
2176
2177 @item -Wswitch
2178 @opindex Wswitch
2179 Warn whenever a @code{switch} statement has an index of enumeral type
2180 and lacks a @code{case} for one or more of the named codes of that
2181 enumeration.  (The presence of a @code{default} label prevents this
2182 warning.)  @code{case} labels outside the enumeration range also
2183 provoke warnings when this option is used.
2184
2185 @item -Wswitch-default
2186 @opindex Wswitch-switch
2187 Warn whenever a @code{switch} statement does not have a @code{default}
2188 case.
2189
2190 @item -Wswitch-enum
2191 @opindex Wswitch-enum
2192 Warn whenever a @code{switch} statement has an index of enumeral type
2193 and lacks a @code{case} for one or more of the named codes of that
2194 enumeration.  @code{case} labels outside the enumeration range also
2195 provoke warnings when this option is used.
2196
2197 @item -Wtrigraphs
2198 @opindex Wtrigraphs
2199 Warn if any trigraphs are encountered that might change the meaning of
2200 the program (trigraphs within comments are not warned about).
2201
2202 @item -Wunused-function
2203 @opindex Wunused-function
2204 Warn whenever a static function is declared but not defined or a
2205 non\-inline static function is unused.
2206
2207 @item -Wunused-label
2208 @opindex Wunused-label
2209 Warn whenever a label is declared but not used.
2210
2211 To suppress this warning use the @samp{unused} attribute
2212 (@pxref{Variable Attributes}).
2213
2214 @item -Wunused-parameter
2215 @opindex Wunused-parameter
2216 Warn whenever a function parameter is unused aside from its declaration.
2217
2218 To suppress this warning use the @samp{unused} attribute
2219 (@pxref{Variable Attributes}).
2220
2221 @item -Wunused-variable
2222 @opindex Wunused-variable
2223 Warn whenever a local variable or non-constant static variable is unused
2224 aside from its declaration
2225
2226 To suppress this warning use the @samp{unused} attribute
2227 (@pxref{Variable Attributes}).
2228
2229 @item -Wunused-value
2230 @opindex Wunused-value
2231 Warn whenever a statement computes a result that is explicitly not used.
2232
2233 To suppress this warning cast the expression to @samp{void}.
2234
2235 @item -Wunused
2236 @opindex Wunused
2237 All the above @option{-Wunused} options combined.
2238
2239 In order to get a warning about an unused function parameter, you must
2240 either specify @samp{-W -Wunused} or separately specify
2241 @option{-Wunused-parameter}.
2242
2243 @item -Wuninitialized
2244 @opindex Wuninitialized
2245 Warn if an automatic variable is used without first being initialized or
2246 if a variable may be clobbered by a @code{setjmp} call.
2247
2248 These warnings are possible only in optimizing compilation,
2249 because they require data flow information that is computed only
2250 when optimizing.  If you don't specify @option{-O}, you simply won't
2251 get these warnings.
2252
2253 These warnings occur only for variables that are candidates for
2254 register allocation.  Therefore, they do not occur for a variable that
2255 is declared @code{volatile}, or whose address is taken, or whose size
2256 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2257 structures, unions or arrays, even when they are in registers.
2258
2259 Note that there may be no warning about a variable that is used only
2260 to compute a value that itself is never used, because such
2261 computations may be deleted by data flow analysis before the warnings
2262 are printed.
2263
2264 These warnings are made optional because GCC is not smart
2265 enough to see all the reasons why the code might be correct
2266 despite appearing to have an error.  Here is one example of how
2267 this can happen:
2268
2269 @smallexample
2270 @group
2271 @{
2272   int x;
2273   switch (y)
2274     @{
2275     case 1: x = 1;
2276       break;
2277     case 2: x = 4;
2278       break;
2279     case 3: x = 5;
2280     @}
2281   foo (x);
2282 @}
2283 @end group
2284 @end smallexample
2285
2286 @noindent
2287 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2288 always initialized, but GCC doesn't know this.  Here is
2289 another common case:
2290
2291 @smallexample
2292 @{
2293   int save_y;
2294   if (change_y) save_y = y, y = new_y;
2295   @dots{}
2296   if (change_y) y = save_y;
2297 @}
2298 @end smallexample
2299
2300 @noindent
2301 This has no bug because @code{save_y} is used only if it is set.
2302
2303 @cindex @code{longjmp} warnings
2304 This option also warns when a non-volatile automatic variable might be
2305 changed by a call to @code{longjmp}.  These warnings as well are possible
2306 only in optimizing compilation.
2307
2308 The compiler sees only the calls to @code{setjmp}.  It cannot know
2309 where @code{longjmp} will be called; in fact, a signal handler could
2310 call it at any point in the code.  As a result, you may get a warning
2311 even when there is in fact no problem because @code{longjmp} cannot
2312 in fact be called at the place which would cause a problem.
2313
2314 Some spurious warnings can be avoided if you declare all the functions
2315 you use that never return as @code{noreturn}.  @xref{Function
2316 Attributes}.
2317
2318 @item -Wunknown-pragmas
2319 @opindex Wunknown-pragmas
2320 @cindex warning for unknown pragmas
2321 @cindex unknown pragmas, warning
2322 @cindex pragmas, warning of unknown
2323 Warn when a #pragma directive is encountered which is not understood by
2324 GCC@.  If this command line option is used, warnings will even be issued
2325 for unknown pragmas in system header files.  This is not the case if
2326 the warnings were only enabled by the @option{-Wall} command line option.
2327
2328 @item -Wall
2329 @opindex Wall
2330 All of the above @samp{-W} options combined.  This enables all the
2331 warnings about constructions that some users consider questionable, and
2332 that are easy to avoid (or modify to prevent the warning), even in
2333 conjunction with macros.  This also enables some language-specific
2334 warnings described in @ref{C++ Dialect Options} and
2335 @ref{Objective-C Dialect Options}.
2336 @end table
2337
2338 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2339 Some of them warn about constructions that users generally do not
2340 consider questionable, but which occasionally you might wish to check
2341 for; others warn about constructions that are necessary or hard to avoid
2342 in some cases, and there is no simple way to modify the code to suppress
2343 the warning.
2344
2345 @table @gcctabopt
2346 @item -W
2347 @opindex W
2348 Print extra warning messages for these events:
2349
2350 @itemize @bullet
2351 @item
2352 A function can return either with or without a value.  (Falling
2353 off the end of the function body is considered returning without
2354 a value.)  For example, this function would evoke such a
2355 warning:
2356
2357 @smallexample
2358 @group
2359 foo (a)
2360 @{
2361   if (a > 0)
2362     return a;
2363 @}
2364 @end group
2365 @end smallexample
2366
2367 @item
2368 An expression-statement or the left-hand side of a comma expression
2369 contains no side effects.
2370 To suppress the warning, cast the unused expression to void.
2371 For example, an expression such as @samp{x[i,j]} will cause a warning,
2372 but @samp{x[(void)i,j]} will not.
2373
2374 @item
2375 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2376
2377 @item
2378 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2379 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2380 that of ordinary mathematical notation.
2381
2382 @item
2383 Storage-class specifiers like @code{static} are not the first things in
2384 a declaration.  According to the C Standard, this usage is obsolescent.
2385
2386 @item
2387 The return type of a function has a type qualifier such as @code{const}.
2388 Such a type qualifier has no effect, since the value returned by a
2389 function is not an lvalue.  (But don't warn about the GNU extension of
2390 @code{volatile void} return types.  That extension will be warned about
2391 if @option{-pedantic} is specified.)
2392
2393 @item
2394 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2395 arguments.
2396
2397 @item
2398 A comparison between signed and unsigned values could produce an
2399 incorrect result when the signed value is converted to unsigned.
2400 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2401
2402 @item
2403 An aggregate has a partly bracketed initializer.
2404 For example, the following code would evoke such a warning,
2405 because braces are missing around the initializer for @code{x.h}:
2406
2407 @smallexample
2408 struct s @{ int f, g; @};
2409 struct t @{ struct s h; int i; @};
2410 struct t x = @{ 1, 2, 3 @};
2411 @end smallexample
2412
2413 @item
2414 An aggregate has an initializer which does not initialize all members.
2415 For example, the following code would cause such a warning, because
2416 @code{x.h} would be implicitly initialized to zero:
2417
2418 @smallexample
2419 struct s @{ int f, g, h; @};
2420 struct s x = @{ 3, 4 @};
2421 @end smallexample
2422 @end itemize
2423
2424 @item -Wno-div-by-zero
2425 @opindex Wno-div-by-zero
2426 @opindex Wdiv-by-zero
2427 Do not warn about compile-time integer division by zero.  Floating point
2428 division by zero is not warned about, as it can be a legitimate way of
2429 obtaining infinities and NaNs.
2430
2431 @item -Wsystem-headers
2432 @opindex Wsystem-headers
2433 @cindex warnings from system headers
2434 @cindex system headers, warnings from
2435 Print warning messages for constructs found in system header files.
2436 Warnings from system headers are normally suppressed, on the assumption
2437 that they usually do not indicate real problems and would only make the
2438 compiler output harder to read.  Using this command line option tells
2439 GCC to emit warnings from system headers as if they occurred in user
2440 code.  However, note that using @option{-Wall} in conjunction with this
2441 option will @emph{not} warn about unknown pragmas in system
2442 headers---for that, @option{-Wunknown-pragmas} must also be used.
2443
2444 @item -Wfloat-equal
2445 @opindex Wfloat-equal
2446 Warn if floating point values are used in equality comparisons.
2447
2448 The idea behind this is that sometimes it is convenient (for the
2449 programmer) to consider floating-point values as approximations to
2450 infinitely precise real numbers.  If you are doing this, then you need
2451 to compute (by analysing the code, or in some other way) the maximum or
2452 likely maximum error that the computation introduces, and allow for it
2453 when performing comparisons (and when producing output, but that's a
2454 different problem).  In particular, instead of testing for equality, you
2455 would check to see whether the two values have ranges that overlap; and
2456 this is done with the relational operators, so equality comparisons are
2457 probably mistaken.
2458
2459 @item -Wtraditional @r{(C only)}
2460 @opindex Wtraditional
2461 Warn about certain constructs that behave differently in traditional and
2462 ISO C@.  Also warn about ISO C constructs that have no traditional C
2463 equivalent, and/or problematic constructs which should be avoided.
2464
2465 @itemize @bullet
2466 @item
2467 Macro parameters that appear within string literals in the macro body.
2468 In traditional C macro replacement takes place within string literals,
2469 but does not in ISO C@.
2470
2471 @item
2472 In traditional C, some preprocessor directives did not exist.
2473 Traditional preprocessors would only consider a line to be a directive
2474 if the @samp{#} appeared in column 1 on the line.  Therefore
2475 @option{-Wtraditional} warns about directives that traditional C
2476 understands but would ignore because the @samp{#} does not appear as the
2477 first character on the line.  It also suggests you hide directives like
2478 @samp{#pragma} not understood by traditional C by indenting them.  Some
2479 traditional implementations would not recognize @samp{#elif}, so it
2480 suggests avoiding it altogether.
2481
2482 @item
2483 A function-like macro that appears without arguments.
2484
2485 @item
2486 The unary plus operator.
2487
2488 @item
2489 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2490 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2491 constants.)  Note, these suffixes appear in macros defined in the system
2492 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2493 Use of these macros in user code might normally lead to spurious
2494 warnings, however gcc's integrated preprocessor has enough context to
2495 avoid warning in these cases.
2496
2497 @item
2498 A function declared external in one block and then used after the end of
2499 the block.
2500
2501 @item
2502 A @code{switch} statement has an operand of type @code{long}.
2503
2504 @item
2505 A non-@code{static} function declaration follows a @code{static} one.
2506 This construct is not accepted by some traditional C compilers.
2507
2508 @item
2509 The ISO type of an integer constant has a different width or
2510 signedness from its traditional type.  This warning is only issued if
2511 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2512 typically represent bit patterns, are not warned about.
2513
2514 @item
2515 Usage of ISO string concatenation is detected.
2516
2517 @item
2518 Initialization of automatic aggregates.
2519
2520 @item
2521 Identifier conflicts with labels.  Traditional C lacks a separate
2522 namespace for labels.
2523
2524 @item
2525 Initialization of unions.  If the initializer is zero, the warning is
2526 omitted.  This is done under the assumption that the zero initializer in
2527 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2528 initializer warnings and relies on default initialization to zero in the
2529 traditional C case.
2530
2531 @item
2532 Conversions by prototypes between fixed/floating point values and vice
2533 versa.  The absence of these prototypes when compiling with traditional
2534 C would cause serious problems.  This is a subset of the possible
2535 conversion warnings, for the full set use @option{-Wconversion}.
2536
2537 @item
2538 Use of ISO C style function definitions.  This warning intentionally is
2539 @emph{not} issued for prototype declarations or variadic functions
2540 because these ISO C features will appear in your code when using
2541 libiberty's traditional C compatibility macros, @code{PARAMS} and
2542 @code{VPARAMS}.  This warning is also bypassed for nested functions
2543 because that feature is already a gcc extension and thus not relevant to
2544 traditional C compatibility.
2545 @end itemize
2546
2547 @item -Wundef
2548 @opindex Wundef
2549 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2550
2551 @item -Wendif-labels
2552 @opindex Wendif-labels
2553 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2554
2555 @item -Wshadow
2556 @opindex Wshadow
2557 Warn whenever a local variable shadows another local variable, parameter or
2558 global variable or whenever a built-in function is shadowed.
2559
2560 @item -Wlarger-than-@var{len}
2561 @opindex Wlarger-than
2562 Warn whenever an object of larger than @var{len} bytes is defined.
2563
2564 @item -Wpointer-arith
2565 @opindex Wpointer-arith
2566 Warn about anything that depends on the ``size of'' a function type or
2567 of @code{void}.  GNU C assigns these types a size of 1, for
2568 convenience in calculations with @code{void *} pointers and pointers
2569 to functions.
2570
2571 @item -Wbad-function-cast @r{(C only)}
2572 @opindex Wbad-function-cast
2573 Warn whenever a function call is cast to a non-matching type.
2574 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2575
2576 @item -Wcast-qual
2577 @opindex Wcast-qual
2578 Warn whenever a pointer is cast so as to remove a type qualifier from
2579 the target type.  For example, warn if a @code{const char *} is cast
2580 to an ordinary @code{char *}.
2581
2582 @item -Wcast-align
2583 @opindex Wcast-align
2584 Warn whenever a pointer is cast such that the required alignment of the
2585 target is increased.  For example, warn if a @code{char *} is cast to
2586 an @code{int *} on machines where integers can only be accessed at
2587 two- or four-byte boundaries.
2588
2589 @item -Wwrite-strings
2590 @opindex Wwrite-strings
2591 When compiling C, give string constants the type @code{const
2592 char[@var{length}]} so that
2593 copying the address of one into a non-@code{const} @code{char *}
2594 pointer will get a warning; when compiling C++, warn about the
2595 deprecated conversion from string constants to @code{char *}.
2596 These warnings will help you find at
2597 compile time code that can try to write into a string constant, but
2598 only if you have been very careful about using @code{const} in
2599 declarations and prototypes.  Otherwise, it will just be a nuisance;
2600 this is why we did not make @option{-Wall} request these warnings.
2601
2602 @item -Wconversion
2603 @opindex Wconversion
2604 Warn if a prototype causes a type conversion that is different from what
2605 would happen to the same argument in the absence of a prototype.  This
2606 includes conversions of fixed point to floating and vice versa, and
2607 conversions changing the width or signedness of a fixed point argument
2608 except when the same as the default promotion.
2609
2610 Also, warn if a negative integer constant expression is implicitly
2611 converted to an unsigned type.  For example, warn about the assignment
2612 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2613 casts like @code{(unsigned) -1}.
2614
2615 @item -Wsign-compare
2616 @opindex Wsign-compare
2617 @cindex warning for comparison of signed and unsigned values
2618 @cindex comparison of signed and unsigned values, warning
2619 @cindex signed and unsigned values, comparison warning
2620 Warn when a comparison between signed and unsigned values could produce
2621 an incorrect result when the signed value is converted to unsigned.
2622 This warning is also enabled by @option{-W}; to get the other warnings
2623 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2624
2625 @item -Waggregate-return
2626 @opindex Waggregate-return
2627 Warn if any functions that return structures or unions are defined or
2628 called.  (In languages where you can return an array, this also elicits
2629 a warning.)
2630
2631 @item -Wstrict-prototypes @r{(C only)}
2632 @opindex Wstrict-prototypes
2633 Warn if a function is declared or defined without specifying the
2634 argument types.  (An old-style function definition is permitted without
2635 a warning if preceded by a declaration which specifies the argument
2636 types.)
2637
2638 @item -Wmissing-prototypes @r{(C only)}
2639 @opindex Wmissing-prototypes
2640 Warn if a global function is defined without a previous prototype
2641 declaration.  This warning is issued even if the definition itself
2642 provides a prototype.  The aim is to detect global functions that fail
2643 to be declared in header files.
2644
2645 @item -Wmissing-declarations
2646 @opindex Wmissing-declarations
2647 Warn if a global function is defined without a previous declaration.
2648 Do so even if the definition itself provides a prototype.
2649 Use this option to detect global functions that are not declared in
2650 header files.
2651
2652 @item -Wmissing-noreturn
2653 @opindex Wmissing-noreturn
2654 Warn about functions which might be candidates for attribute @code{noreturn}.
2655 Note these are only possible candidates, not absolute ones.  Care should
2656 be taken to manually verify functions actually do not ever return before
2657 adding the @code{noreturn} attribute, otherwise subtle code generation
2658 bugs could be introduced.  You will not get a warning for @code{main} in
2659 hosted C environments.
2660
2661 @item -Wmissing-format-attribute
2662 @opindex Wmissing-format-attribute
2663 @opindex Wformat
2664 If @option{-Wformat} is enabled, also warn about functions which might be
2665 candidates for @code{format} attributes.  Note these are only possible
2666 candidates, not absolute ones.  GCC will guess that @code{format}
2667 attributes might be appropriate for any function that calls a function
2668 like @code{vprintf} or @code{vscanf}, but this might not always be the
2669 case, and some functions for which @code{format} attributes are
2670 appropriate may not be detected.  This option has no effect unless
2671 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2672
2673 @item -Wno-multichar
2674 @opindex Wno-multichar
2675 @opindex Wmultichar
2676 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2677 Usually they indicate a typo in the user's code, as they have
2678 implementation-defined values, and should not be used in portable code.
2679
2680 @item -Wno-deprecated-declarations
2681 @opindex Wno-deprecated-declarations
2682 Do not warn about uses of functions, variables, and types marked as
2683 deprecated by using the @code{deprecated} attribute.
2684 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2685 @pxref{Type Attributes}.)
2686
2687 @item -Wpacked
2688 @opindex Wpacked
2689 Warn if a structure is given the packed attribute, but the packed
2690 attribute has no effect on the layout or size of the structure.
2691 Such structures may be mis-aligned for little benefit.  For
2692 instance, in this code, the variable @code{f.x} in @code{struct bar}
2693 will be misaligned even though @code{struct bar} does not itself
2694 have the packed attribute:
2695
2696 @smallexample
2697 @group
2698 struct foo @{
2699   int x;
2700   char a, b, c, d;
2701 @} __attribute__((packed));
2702 struct bar @{
2703   char z;
2704   struct foo f;
2705 @};
2706 @end group
2707 @end smallexample
2708
2709 @item -Wpadded
2710 @opindex Wpadded
2711 Warn if padding is included in a structure, either to align an element
2712 of the structure or to align the whole structure.  Sometimes when this
2713 happens it is possible to rearrange the fields of the structure to
2714 reduce the padding and so make the structure smaller.
2715
2716 @item -Wredundant-decls
2717 @opindex Wredundant-decls
2718 Warn if anything is declared more than once in the same scope, even in
2719 cases where multiple declaration is valid and changes nothing.
2720
2721 @item -Wnested-externs @r{(C only)}
2722 @opindex Wnested-externs
2723 Warn if an @code{extern} declaration is encountered within a function.
2724
2725 @item -Wunreachable-code
2726 @opindex Wunreachable-code
2727 Warn if the compiler detects that code will never be executed.
2728
2729 This option is intended to warn when the compiler detects that at
2730 least a whole line of source code will never be executed, because
2731 some condition is never satisfied or because it is after a
2732 procedure that never returns.
2733
2734 It is possible for this option to produce a warning even though there
2735 are circumstances under which part of the affected line can be executed,
2736 so care should be taken when removing apparently-unreachable code.
2737
2738 For instance, when a function is inlined, a warning may mean that the
2739 line is unreachable in only one inlined copy of the function.
2740
2741 This option is not made part of @option{-Wall} because in a debugging
2742 version of a program there is often substantial code which checks
2743 correct functioning of the program and is, hopefully, unreachable
2744 because the program does work.  Another common use of unreachable
2745 code is to provide behavior which is selectable at compile-time.
2746
2747 @item -Winline
2748 @opindex Winline
2749 Warn if a function can not be inlined and it was declared as inline.
2750
2751 @item -Wlong-long
2752 @opindex Wlong-long
2753 @opindex Wno-long-long
2754 Warn if @samp{long long} type is used.  This is default.  To inhibit
2755 the warning messages, use @option{-Wno-long-long}.  Flags
2756 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2757 only when @option{-pedantic} flag is used.
2758
2759 @item -Wdisabled-optimization
2760 @opindex Wdisabled-optimization
2761 Warn if a requested optimization pass is disabled.  This warning does
2762 not generally indicate that there is anything wrong with your code; it
2763 merely indicates that GCC's optimizers were unable to handle the code
2764 effectively.  Often, the problem is that your code is too big or too
2765 complex; GCC will refuse to optimize programs when the optimization
2766 itself is likely to take inordinate amounts of time.
2767
2768 @item -Werror
2769 @opindex Werror
2770 Make all warnings into errors.
2771 @end table
2772
2773 @node Debugging Options
2774 @section Options for Debugging Your Program or GCC
2775 @cindex options, debugging
2776 @cindex debugging information options
2777
2778 GCC has various special options that are used for debugging
2779 either your program or GCC:
2780
2781 @table @gcctabopt
2782 @item -g
2783 @opindex g
2784 Produce debugging information in the operating system's native format
2785 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2786 information.
2787
2788 On most systems that use stabs format, @option{-g} enables use of extra
2789 debugging information that only GDB can use; this extra information
2790 makes debugging work better in GDB but will probably make other debuggers
2791 crash or
2792 refuse to read the program.  If you want to control for certain whether
2793 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2794 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2795 or @option{-gvms} (see below).
2796
2797 Unlike most other C compilers, GCC allows you to use @option{-g} with
2798 @option{-O}.  The shortcuts taken by optimized code may occasionally
2799 produce surprising results: some variables you declared may not exist
2800 at all; flow of control may briefly move where you did not expect it;
2801 some statements may not be executed because they compute constant
2802 results or their values were already at hand; some statements may
2803 execute in different places because they were moved out of loops.
2804
2805 Nevertheless it proves possible to debug optimized output.  This makes
2806 it reasonable to use the optimizer for programs that might have bugs.
2807
2808 The following options are useful when GCC is generated with the
2809 capability for more than one debugging format.
2810
2811 @item -ggdb
2812 @opindex ggdb
2813 Produce debugging information for use by GDB@.  This means to use the
2814 most expressive format available (DWARF 2, stabs, or the native format
2815 if neither of those are supported), including GDB extensions if at all
2816 possible.
2817
2818 @item -gstabs
2819 @opindex gstabs
2820 Produce debugging information in stabs format (if that is supported),
2821 without GDB extensions.  This is the format used by DBX on most BSD
2822 systems.  On MIPS, Alpha and System V Release 4 systems this option
2823 produces stabs debugging output which is not understood by DBX or SDB@.
2824 On System V Release 4 systems this option requires the GNU assembler.
2825
2826 @item -gstabs+
2827 @opindex gstabs+
2828 Produce debugging information in stabs format (if that is supported),
2829 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2830 use of these extensions is likely to make other debuggers crash or
2831 refuse to read the program.
2832
2833 @item -gcoff
2834 @opindex gcoff
2835 Produce debugging information in COFF format (if that is supported).
2836 This is the format used by SDB on most System V systems prior to
2837 System V Release 4.
2838
2839 @item -gxcoff
2840 @opindex gxcoff
2841 Produce debugging information in XCOFF format (if that is supported).
2842 This is the format used by the DBX debugger on IBM RS/6000 systems.
2843
2844 @item -gxcoff+
2845 @opindex gxcoff+
2846 Produce debugging information in XCOFF format (if that is supported),
2847 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2848 use of these extensions is likely to make other debuggers crash or
2849 refuse to read the program, and may cause assemblers other than the GNU
2850 assembler (GAS) to fail with an error.
2851
2852 @item -gdwarf
2853 @opindex gdwarf
2854 Produce debugging information in DWARF version 1 format (if that is
2855 supported).  This is the format used by SDB on most System V Release 4
2856 systems.
2857
2858 This option is deprecated.
2859
2860 @item -gdwarf+
2861 @opindex gdwarf+
2862 Produce debugging information in DWARF version 1 format (if that is
2863 supported), using GNU extensions understood only by the GNU debugger
2864 (GDB)@.  The use of these extensions is likely to make other debuggers
2865 crash or refuse to read the program.
2866
2867 This option is deprecated.
2868
2869 @item -gdwarf-2
2870 @opindex gdwarf-2
2871 Produce debugging information in DWARF version 2 format (if that is
2872 supported).  This is the format used by DBX on IRIX 6.
2873
2874 @item -gvms
2875 @opindex gvms
2876 Produce debugging information in VMS debug format (if that is
2877 supported).  This is the format used by DEBUG on VMS systems.
2878
2879 @item -g@var{level}
2880 @itemx -ggdb@var{level}
2881 @itemx -gstabs@var{level}
2882 @itemx -gcoff@var{level}
2883 @itemx -gxcoff@var{level}
2884 @itemx -gvms@var{level}
2885 Request debugging information and also use @var{level} to specify how
2886 much information.  The default level is 2.
2887
2888 Level 1 produces minimal information, enough for making backtraces in
2889 parts of the program that you don't plan to debug.  This includes
2890 descriptions of functions and external variables, but no information
2891 about local variables and no line numbers.
2892
2893 Level 3 includes extra information, such as all the macro definitions
2894 present in the program.  Some debuggers support macro expansion when
2895 you use @option{-g3}.
2896
2897 Note that in order to avoid confusion between DWARF1 debug level 2,
2898 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2899 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2900 option to change the debug level for DWARF1 or DWARF2.
2901
2902 @cindex @code{prof}
2903 @item -p
2904 @opindex p
2905 Generate extra code to write profile information suitable for the
2906 analysis program @code{prof}.  You must use this option when compiling
2907 the source files you want data about, and you must also use it when
2908 linking.
2909
2910 @cindex @code{gprof}
2911 @item -pg
2912 @opindex pg
2913 Generate extra code to write profile information suitable for the
2914 analysis program @code{gprof}.  You must use this option when compiling
2915 the source files you want data about, and you must also use it when
2916 linking.
2917
2918 @item -Q
2919 @opindex Q
2920 Makes the compiler print out each function name as it is compiled, and
2921 print some statistics about each pass when it finishes.
2922
2923 @item -ftime-report
2924 @opindex ftime-report
2925 Makes the compiler print some statistics about the time consumed by each
2926 pass when it finishes.
2927
2928 @item -fmem-report
2929 @opindex fmem-report
2930 Makes the compiler print some statistics about permanent memory
2931 allocation when it finishes.
2932
2933 @item -fprofile-arcs
2934 @opindex fprofile-arcs
2935 Instrument @dfn{arcs} during compilation to generate coverage data or
2936 for profile-directed block ordering.  During execution the program
2937 records how many times each branch is executed and how many times it is
2938 taken.  When the compiled program exits it saves this data to a file
2939 called @file{@var{auxname}.da} for each source file.  @var{auxname} is
2940 generated from the name of the output file, if explicitly specified and
2941 it is not the final executable, otherwise it is the basename of the
2942 source file. In both cases any suffix is removed (e.g.  @file{foo.da}
2943 for input file @file{dir/foo.c}, or @file{dir/foo.da} for output file
2944 specified as @option{-o dir/foo.o}).
2945
2946 For profile-directed block ordering, compile the program with
2947 @option{-fprofile-arcs} plus optimization and code generation options,
2948 generate the arc profile information by running the program on a
2949 selected workload, and then compile the program again with the same
2950 optimization and code generation options plus
2951 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2952 Control Optimization}).
2953
2954 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2955 when it is used with the @option{-ftest-coverage} option.
2956
2957 With @option{-fprofile-arcs}, for each function of your program GCC
2958 creates a program flow graph, then finds a spanning tree for the graph.
2959 Only arcs that are not on the spanning tree have to be instrumented: the
2960 compiler adds code to count the number of times that these arcs are
2961 executed.  When an arc is the only exit or only entrance to a block, the
2962 instrumentation code can be added to the block; otherwise, a new basic
2963 block must be created to hold the instrumentation code.
2964
2965 @need 2000
2966 @item -ftest-coverage
2967 @opindex ftest-coverage
2968 Create data files for the @code{gcov} code-coverage utility
2969 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).  See
2970 @option{-fprofile-arcs} option above for a description of @var{auxname}.
2971
2972 @table @gcctabopt
2973 @item @var{auxname}.bb
2974 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2975 associate basic block execution counts with line numbers.
2976
2977 @item @var{auxname}.bbg
2978 A list of all arcs in the program flow graph.  This allows @code{gcov}
2979 to reconstruct the program flow graph, so that it can compute all basic
2980 block and arc execution counts from the information in the
2981 @file{@var{auxname}.da} file.
2982 @end table
2983
2984 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2985 option adds instrumentation to the program, which then writes
2986 execution counts to another data file:
2987
2988 @table @gcctabopt
2989 @item @var{auxname}.da
2990 Runtime arc execution counts, used in conjunction with the arc
2991 information in the file @file{@var{auxname}.bbg}.
2992 @end table
2993
2994 Coverage data will map better to the source files if
2995 @option{-ftest-coverage} is used without optimization.
2996
2997 @item -d@var{letters}
2998 @opindex d
2999 Says to make debugging dumps during compilation at times specified by
3000 @var{letters}.  This is used for debugging the compiler.  The file names
3001 for most of the dumps are made by appending a pass number and a word to
3002 the @var{dumpname}. @var{dumpname} is generated from the name of the
3003 output file, if explicitly specified and it is not an executable,
3004 otherwise it is the basename of the source file. In both cases any
3005 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3006 Here are the possible letters for use in @var{letters}, and their
3007 meanings:
3008
3009 @table @samp
3010 @item A
3011 @opindex dA
3012 Annotate the assembler output with miscellaneous debugging information.
3013 @item b
3014 @opindex db
3015 Dump after computing branch probabilities, to @file{@var{file}.15.bp}.
3016 @item B
3017 @opindex dB
3018 Dump after block reordering, to @file{@var{file}.30.bbro}.
3019 @item c
3020 @opindex dc
3021 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3022 @item C
3023 @opindex dC
3024 Dump after the first if conversion, to the file @file{@var{file}.18.ce}.
3025 @item d
3026 @opindex dd
3027 Dump after delayed branch scheduling, to @file{@var{file}.32.dbr}.
3028 @item D
3029 @opindex dD
3030 Dump all macro definitions, at the end of preprocessing, in addition to
3031 normal output.
3032 @item e
3033 @opindex de
3034 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3035 @file{@var{file}.07.ussa}.
3036 @item E
3037 @opindex dE
3038 Dump after the second if conversion, to @file{@var{file}.27.ce2}.
3039 @item f
3040 @opindex df
3041 Dump after life analysis, to @file{@var{file}.16.life}.
3042 @item F
3043 @opindex dF
3044 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3045 @item g
3046 @opindex dg
3047 Dump after global register allocation, to @file{@var{file}.22.greg}.
3048 @item h
3049 @opindex dh
3050 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3051 @item k
3052 @opindex dk
3053 Dump after reg-to-stack conversion, to @file{@var{file}.29.stack}.
3054 @item o
3055 @opindex do
3056 Dump after post-reload optimizations, to @file{@var{file}.23.postreload}.
3057 @item G
3058 @opindex dG
3059 Dump after GCSE, to @file{@var{file}.11.gcse}.
3060 @item i
3061 @opindex di
3062 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3063 @item j
3064 @opindex dj
3065 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3066 @item k
3067 @opindex dk
3068 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3069 @item l
3070 @opindex dl
3071 Dump after local register allocation, to @file{@var{file}.21.lreg}.
3072 @item L
3073 @opindex dL
3074 Dump after loop optimization, to @file{@var{file}.12.loop}.
3075 @item M
3076 @opindex dM
3077 Dump after performing the machine dependent reorganisation pass, to
3078 @file{@var{file}.31.mach}.
3079 @item n
3080 @opindex dn
3081 Dump after register renumbering, to @file{@var{file}.26.rnreg}.
3082 @item N
3083 @opindex dN
3084 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3085 @item r
3086 @opindex dr
3087 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3088 @item R
3089 @opindex dR
3090 Dump after the second scheduling pass, to @file{@var{file}.28.sched2}.
3091 @item s
3092 @opindex ds
3093 Dump after CSE (including the jump optimization that sometimes follows
3094 CSE), to @file{@var{file}.09.cse}.
3095 @item S
3096 @opindex dS
3097 Dump after the first scheduling pass, to @file{@var{file}.20.sched}.
3098 @item t
3099 @opindex dt
3100 Dump after the second CSE pass (including the jump optimization that
3101 sometimes follows CSE), to @file{@var{file}.13.cse2}.
3102 @item u
3103 @opindex du
3104 Dump after null pointer ellimination pass ti @file{@var{file}.08.null}.
3105 @item w
3106 @opindex dw
3107 Dump after the second flow pass, to @file{@var{file}.24.flow2}.
3108 @item X
3109 @opindex dX
3110 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3111 @item z
3112 @opindex dz
3113 Dump after the peephole pass, to @file{@var{file}.25.peephole2}.
3114 @item a
3115 @opindex da
3116 Produce all the dumps listed above.
3117 @item m
3118 @opindex dm
3119 Print statistics on memory usage, at the end of the run, to
3120 standard error.
3121 @item p
3122 @opindex dp
3123 Annotate the assembler output with a comment indicating which
3124 pattern and alternative was used.  The length of each instruction is
3125 also printed.
3126 @item P
3127 @opindex dP
3128 Dump the RTL in the assembler output as a comment before each instruction.
3129 Also turns on @option{-dp} annotation.
3130 @item v
3131 @opindex dv
3132 For each of the other indicated dump files (except for
3133 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3134 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3135 @item x
3136 @opindex dx
3137 Just generate RTL for a function instead of compiling it.  Usually used
3138 with @samp{r}.
3139 @item y
3140 @opindex dy
3141 Dump debugging information during parsing, to standard error.
3142 @end table
3143
3144 @item -fdump-unnumbered
3145 @opindex fdump-unnumbered
3146 When doing debugging dumps (see @option{-d} option above), suppress instruction
3147 numbers and line number note output.  This makes it more feasible to
3148 use diff on debugging dumps for compiler invocations with different
3149 options, in particular with and without @option{-g}.
3150
3151 @item -fdump-translation-unit @r{(C and C++ only)}
3152 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3153 @opindex fdump-translation-unit
3154 Dump a representation of the tree structure for the entire translation
3155 unit to a file.  The file name is made by appending @file{.tu} to the
3156 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3157 controls the details of the dump as described for the
3158 @option{-fdump-tree} options.
3159
3160 @item -fdump-class-hierarchy @r{(C++ only)}
3161 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3162 @opindex fdump-class-hierarchy
3163 Dump a representation of each class's hierarchy and virtual function
3164 table layout to a file.  The file name is made by appending @file{.class}
3165 to the source file name.  If the @samp{-@var{options}} form is used,
3166 @var{options} controls the details of the dump as described for the
3167 @option{-fdump-tree} options.
3168
3169 @item -fdump-tree-@var{switch} @r{(C++ only)}
3170 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3171 @opindex fdump-tree
3172 Control the dumping at various stages of processing the intermediate
3173 language tree to a file.  The file name is generated by appending a switch
3174 specific suffix to the source file name.  If the @samp{-@var{options}}
3175 form is used, @var{options} is a list of @samp{-} separated options that
3176 control the details of the dump. Not all options are applicable to all
3177 dumps, those which are not meaningful will be ignored. The following
3178 options are available
3179
3180 @table @samp
3181 @item address
3182 Print the address of each node.  Usually this is not meaningful as it
3183 changes according to the environment and source file. Its primary use
3184 is for tying up a dump file with a debug environment.
3185 @item slim
3186 Inhibit dumping of members of a scope or body of a function merely
3187 because that scope has been reached. Only dump such items when they
3188 are directly reachable by some other path.
3189 @item all
3190 Turn on all options.
3191 @end table
3192
3193 The following tree dumps are possible:
3194 @table @samp
3195 @item original
3196 Dump before any tree based optimization, to @file{@var{file}.original}.
3197 @item optimized
3198 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3199 @item inlined
3200 Dump after function inlining, to @file{@var{file}.inlined}.
3201 @end table
3202
3203 @item -save-temps
3204 @opindex save-temps
3205 Store the usual ``temporary'' intermediate files permanently; place them
3206 in the current directory and name them based on the source file.  Thus,
3207 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3208 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3209 preprocessed @file{foo.i} output file even though the compiler now
3210 normally uses an integrated preprocessor.
3211
3212 @item -time
3213 @opindex time
3214 Report the CPU time taken by each subprocess in the compilation
3215 sequence.  For C source files, this is the compiler proper and assembler
3216 (plus the linker if linking is done).  The output looks like this:
3217
3218 @smallexample
3219 # cc1 0.12 0.01
3220 # as 0.00 0.01
3221 @end smallexample
3222
3223 The first number on each line is the ``user time,'' that is time spent
3224 executing the program itself.  The second number is ``system time,''
3225 time spent executing operating system routines on behalf of the program.
3226 Both numbers are in seconds.
3227
3228 @item -print-file-name=@var{library}
3229 @opindex print-file-name
3230 Print the full absolute name of the library file @var{library} that
3231 would be used when linking---and don't do anything else.  With this
3232 option, GCC does not compile or link anything; it just prints the
3233 file name.
3234
3235 @item -print-multi-directory
3236 @opindex print-multi-directory
3237 Print the directory name corresponding to the multilib selected by any
3238 other switches present in the command line.  This directory is supposed
3239 to exist in @env{GCC_EXEC_PREFIX}.
3240
3241 @item -print-multi-lib
3242 @opindex print-multi-lib
3243 Print the mapping from multilib directory names to compiler switches
3244 that enable them.  The directory name is separated from the switches by
3245 @samp{;}, and each switch starts with an @samp{@@} instead of the
3246 @samp{-}, without spaces between multiple switches.  This is supposed to
3247 ease shell-processing.
3248
3249 @item -print-prog-name=@var{program}
3250 @opindex print-prog-name
3251 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3252
3253 @item -print-libgcc-file-name
3254 @opindex print-libgcc-file-name
3255 Same as @option{-print-file-name=libgcc.a}.
3256
3257 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3258 but you do want to link with @file{libgcc.a}.  You can do
3259
3260 @example
3261 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3262 @end example
3263
3264 @item -print-search-dirs
3265 @opindex print-search-dirs
3266 Print the name of the configured installation directory and a list of
3267 program and library directories gcc will search---and don't do anything else.
3268
3269 This is useful when gcc prints the error message
3270 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3271 To resolve this you either need to put @file{cpp0} and the other compiler
3272 components where gcc expects to find them, or you can set the environment
3273 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3274 Don't forget the trailing '/'.
3275 @xref{Environment Variables}.
3276
3277 @item -dumpmachine
3278 @opindex dumpmachine
3279 Print the compiler's target machine (for example,
3280 @samp{i686-pc-linux-gnu})---and don't do anything else.
3281
3282 @item -dumpversion
3283 @opindex dumpversion
3284 Print the compiler version (for example, @samp{3.0})---and don't do
3285 anything else.
3286
3287 @item -dumpspecs
3288 @opindex dumpspecs
3289 Print the compiler's built-in specs---and don't do anything else.  (This
3290 is used when GCC itself is being built.)  @xref{Spec Files}.
3291 @end table
3292
3293 @node Optimize Options
3294 @section Options That Control Optimization
3295 @cindex optimize options
3296 @cindex options, optimization
3297
3298 These options control various sorts of optimizations:
3299
3300 @table @gcctabopt
3301 @item -O
3302 @itemx -O1
3303 @opindex O
3304 @opindex O1
3305 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3306 more memory for a large function.
3307
3308 Without @option{-O}, the compiler's goal is to reduce the cost of
3309 compilation and to make debugging produce the expected results.
3310 Statements are independent: if you stop the program with a breakpoint
3311 between statements, you can then assign a new value to any variable or
3312 change the program counter to any other statement in the function and
3313 get exactly the results you would expect from the source code.
3314
3315 With @option{-O}, the compiler tries to reduce code size and execution
3316 time, without performing any optimizations that take a great deal of
3317 compilation time.
3318
3319 @item -O2
3320 @opindex O2
3321 Optimize even more.  GCC performs nearly all supported optimizations
3322 that do not involve a space-speed tradeoff.  The compiler does not
3323 perform loop unrolling or function inlining when you specify @option{-O2}.
3324 As compared to @option{-O}, this option increases both compilation time
3325 and the performance of the generated code.
3326
3327 @option{-O2} turns on all optional optimizations except for loop
3328 unrolling, function inlining, and register renaming.  It also turns on
3329 the @option{-fforce-mem} and @option{-fstrict-aliasing} option on all
3330 machines and frame pointer elimination on machines where doing so does
3331 not interfere with debugging.
3332
3333 Please note the warning under @option{-fgcse} about
3334 invoking @option{-O2} on programs that use computed gotos.
3335
3336 @item -O3
3337 @opindex O3
3338 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3339 @option{-O2} and also turns on the @option{-finline-functions} and
3340 @option{-frename-registers} options.
3341
3342 @item -O0
3343 @opindex O0
3344 Do not optimize.
3345
3346 @item -Os
3347 @opindex Os
3348 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3349 do not typically increase code size.  It also performs further
3350 optimizations designed to reduce code size.
3351
3352 If you use multiple @option{-O} options, with or without level numbers,
3353 the last such option is the one that is effective.
3354 @end table
3355
3356 Options of the form @option{-f@var{flag}} specify machine-independent
3357 flags.  Most flags have both positive and negative forms; the negative
3358 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3359 only one of the forms is listed---the one which is not the default.
3360 You can figure out the other form by either removing @samp{no-} or
3361 adding it.
3362
3363 @table @gcctabopt
3364 @item -ffloat-store
3365 @opindex ffloat-store
3366 Do not store floating point variables in registers, and inhibit other
3367 options that might change whether a floating point value is taken from a
3368 register or memory.
3369
3370 @cindex floating point precision
3371 This option prevents undesirable excess precision on machines such as
3372 the 68000 where the floating registers (of the 68881) keep more
3373 precision than a @code{double} is supposed to have.  Similarly for the
3374 x86 architecture.  For most programs, the excess precision does only
3375 good, but a few programs rely on the precise definition of IEEE floating
3376 point.  Use @option{-ffloat-store} for such programs, after modifying
3377 them to store all pertinent intermediate computations into variables.
3378
3379 @item -fno-default-inline
3380 @opindex fno-default-inline
3381 Do not make member functions inline by default merely because they are
3382 defined inside the class scope (C++ only).  Otherwise, when you specify
3383 @w{@option{-O}}, member functions defined inside class scope are compiled
3384 inline by default; i.e., you don't need to add @samp{inline} in front of
3385 the member function name.
3386
3387 @item -fno-defer-pop
3388 @opindex fno-defer-pop
3389 Always pop the arguments to each function call as soon as that function
3390 returns.  For machines which must pop arguments after a function call,
3391 the compiler normally lets arguments accumulate on the stack for several
3392 function calls and pops them all at once.
3393
3394 @item -fforce-mem
3395 @opindex fforce-mem
3396 Force memory operands to be copied into registers before doing
3397 arithmetic on them.  This produces better code by making all memory
3398 references potential common subexpressions.  When they are not common
3399 subexpressions, instruction combination should eliminate the separate
3400 register-load.  The @option{-O2} option turns on this option.
3401
3402 @item -fforce-addr
3403 @opindex fforce-addr
3404 Force memory address constants to be copied into registers before
3405 doing arithmetic on them.  This may produce better code just as
3406 @option{-fforce-mem} may.
3407
3408 @item -fomit-frame-pointer
3409 @opindex fomit-frame-pointer
3410 Don't keep the frame pointer in a register for functions that
3411 don't need one.  This avoids the instructions to save, set up and
3412 restore frame pointers; it also makes an extra register available
3413 in many functions.  @strong{It also makes debugging impossible on
3414 some machines.}
3415
3416 On some machines, such as the VAX, this flag has no effect, because
3417 the standard calling sequence automatically handles the frame pointer
3418 and nothing is saved by pretending it doesn't exist.  The
3419 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3420 whether a target machine supports this flag.  @xref{Registers,,Register
3421 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3422
3423 @item -foptimize-sibling-calls
3424 @opindex foptimize-sibling-calls
3425 Optimize sibling and tail recursive calls.
3426
3427 @item -ftrapv
3428 @opindex ftrapv
3429 This option generates traps for signed overflow on addition, subtraction,
3430 multiplication operations.
3431
3432 @item -fno-inline
3433 @opindex fno-inline
3434 Don't pay attention to the @code{inline} keyword.  Normally this option
3435 is used to keep the compiler from expanding any functions inline.
3436 Note that if you are not optimizing, no functions can be expanded inline.
3437
3438 @item -finline-functions
3439 @opindex finline-functions
3440 Integrate all simple functions into their callers.  The compiler
3441 heuristically decides which functions are simple enough to be worth
3442 integrating in this way.
3443
3444 If all calls to a given function are integrated, and the function is
3445 declared @code{static}, then the function is normally not output as
3446 assembler code in its own right.
3447
3448 @item -finline-limit=@var{n}
3449 @opindex finline-limit
3450 By default, gcc limits the size of functions that can be inlined.  This flag
3451 allows the control of this limit for functions that are explicitly marked as
3452 inline (ie marked with the inline keyword or defined within the class
3453 definition in c++).  @var{n} is the size of functions that can be inlined in
3454 number of pseudo instructions (not counting parameter handling).  The default
3455 value of @var{n} is 600.
3456 Increasing this value can result in more inlined code at
3457 the cost of compilation time and memory consumption.  Decreasing usually makes
3458 the compilation faster and less code will be inlined (which presumably
3459 means slower programs).  This option is particularly useful for programs that
3460 use inlining heavily such as those based on recursive templates with C++.
3461
3462 @emph{Note:} pseudo instruction represents, in this particular context, an
3463 abstract measurement of function's size.  In no way, it represents a count
3464 of assembly instructions and as such its exact meaning might change from one
3465 release to an another.
3466
3467 @item -fkeep-inline-functions
3468 @opindex fkeep-inline-functions
3469 Even if all calls to a given function are integrated, and the function
3470 is declared @code{static}, nevertheless output a separate run-time
3471 callable version of the function.  This switch does not affect
3472 @code{extern inline} functions.
3473
3474 @item -fkeep-static-consts
3475 @opindex fkeep-static-consts
3476 Emit variables declared @code{static const} when optimization isn't turned
3477 on, even if the variables aren't referenced.
3478
3479 GCC enables this option by default.  If you want to force the compiler to
3480 check if the variable was referenced, regardless of whether or not
3481 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3482
3483 @item -fmerge-constants
3484 Attempt to merge identical constants (string constants and floating point
3485 constants) accross compilation units.
3486
3487 This option is default for optimized compilation if assembler and linker
3488 support it.  Use @option{-fno-merge-constants} to inhibit this behavior.
3489
3490 @item -fmerge-all-constants
3491 Attempt to merge identical constants and identical variables.
3492
3493 This option implies @option{-fmerge-constants}.  In addition to
3494 @option{-fmerge-constants} this considers e.g. even constant initialized
3495 arrays or initialized constant variables with integral or floating point
3496 types.  Languages like C or C++ require each non-automatic variable to
3497 have distinct location, so using this option will result in non-conforming
3498 behavior.
3499
3500 @item -fnew-ra
3501 @opindex fnew-ra
3502 Use a graph coloring register allocator.  Currently this option is meant
3503 for testing, so we are interested to hear about miscompilations with
3504 @option{-fnew-ra}.
3505
3506 @item -fno-function-cse
3507 @opindex fno-function-cse
3508 Do not put function addresses in registers; make each instruction that
3509 calls a constant function contain the function's address explicitly.
3510
3511 This option results in less efficient code, but some strange hacks
3512 that alter the assembler output may be confused by the optimizations
3513 performed when this option is not used.
3514
3515 @item -ffast-math
3516 @opindex ffast-math
3517 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
3518 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
3519 @option{-fno-signaling-nans}.
3520
3521 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3522
3523 This option should never be turned on by any @option{-O} option since
3524 it can result in incorrect output for programs which depend on
3525 an exact implementation of IEEE or ISO rules/specifications for
3526 math functions.
3527
3528 @item -fno-math-errno
3529 @opindex fno-math-errno
3530 Do not set ERRNO after calling math functions that are executed
3531 with a single instruction, e.g., sqrt.  A program that relies on
3532 IEEE exceptions for math error handling may want to use this flag
3533 for speed while maintaining IEEE arithmetic compatibility.
3534
3535 This option should never be turned on by any @option{-O} option since
3536 it can result in incorrect output for programs which depend on
3537 an exact implementation of IEEE or ISO rules/specifications for
3538 math functions.
3539
3540 The default is @option{-fmath-errno}.
3541
3542 @item -funsafe-math-optimizations
3543 @opindex funsafe-math-optimizations
3544 Allow optimizations for floating-point arithmetic that (a) assume
3545 that arguments and results are valid and (b) may violate IEEE or
3546 ANSI standards.  When used at link-time, it may include libraries
3547 or startup files that change the default FPU control word or other
3548 similar optimizations.
3549
3550 This option should never be turned on by any @option{-O} option since
3551 it can result in incorrect output for programs which depend on
3552 an exact implementation of IEEE or ISO rules/specifications for
3553 math functions.
3554
3555 The default is @option{-fno-unsafe-math-optimizations}.
3556
3557 @item -ffinite-math-only
3558 @opindex ffinite-math-only
3559 Allow optimizations for floating-point arithmetic that assume
3560 that arguments and results are not NaNs or +-Infs.
3561
3562 This option should never be turned on by any @option{-O} option since
3563 it can result in incorrect output for programs which depend on
3564 an exact implementation of IEEE or ISO rules/specifications.
3565
3566 The default is @option{-fno-finite-math-only}.
3567
3568 @item -fno-trapping-math
3569 @opindex fno-trapping-math
3570 Compile code assuming that floating-point operations cannot generate
3571 user-visible traps.  These traps include division by zero, overflow,
3572 underflow, inexact result and invalid operation.  This option implies
3573 @option{-fno-signaling-nans}.  Setting this option may allow faster
3574 code if one relies on ``non-stop'' IEEE arithmetic, for example.
3575
3576 This option should never be turned on by any @option{-O} option since
3577 it can result in incorrect output for programs which depend on
3578 an exact implementation of IEEE or ISO rules/specifications for
3579 math functions.
3580
3581 The default is @option{-ftrapping-math}.
3582
3583 @item -fsignaling-nans
3584 @opindex fsignaling-nans
3585 Compile code assuming that IEEE signaling NaNs may generate user-visible
3586 traps during floating-point operations.  Setting this option disables
3587 optimizations that may change the number of exceptions visible with
3588 signaling NaNs.  This option implies @option{-ftrapping-math}.
3589
3590 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
3591 be defined.
3592
3593 The default is @option{-fno-signaling-nans}.
3594
3595 This option is experimental and does not currently guarantee to
3596 disable all GCC optimizations that affect signaling NaN behavior.
3597
3598 @item -fno-zero-initialized-in-bss
3599 @opindex fno-zero-initialized-in-bss
3600 If the target supports a BSS section, GCC by default puts variables that
3601 are initialized to zero into BSS@.  This can save space in the resulting
3602 code.
3603
3604 This option turns off this behavior because some programs explicitly
3605 rely on variables going to the data section.  E.g., so that the
3606 resulting executable can find the beginning of that section and/or make
3607 assumptions based on that.
3608
3609 The default is @option{-fzero-initialized-in-bss}.
3610 @end table
3611
3612 The following options control specific optimizations.  The @option{-O2}
3613 option turns on all of these optimizations except @option{-funroll-loops}
3614 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3615 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3616 but specific machines may handle it differently.
3617
3618 You can use the following flags in the rare cases when ``fine-tuning''
3619 of optimizations to be performed is desired.
3620
3621 Not all of the optimizations performed by GCC have @option{-f} options
3622 to control them.
3623
3624 @table @gcctabopt
3625 @item -fstrength-reduce
3626 @opindex fstrength-reduce
3627 Perform the optimizations of loop strength reduction and
3628 elimination of iteration variables.
3629
3630 @item -fthread-jumps
3631 @opindex fthread-jumps
3632 Perform optimizations where we check to see if a jump branches to a
3633 location where another comparison subsumed by the first is found.  If
3634 so, the first branch is redirected to either the destination of the
3635 second branch or a point immediately following it, depending on whether
3636 the condition is known to be true or false.
3637
3638 @item -fcse-follow-jumps
3639 @opindex fcse-follow-jumps
3640 In common subexpression elimination, scan through jump instructions
3641 when the target of the jump is not reached by any other path.  For
3642 example, when CSE encounters an @code{if} statement with an
3643 @code{else} clause, CSE will follow the jump when the condition
3644 tested is false.
3645
3646 @item -fcse-skip-blocks
3647 @opindex fcse-skip-blocks
3648 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3649 follow jumps which conditionally skip over blocks.  When CSE
3650 encounters a simple @code{if} statement with no else clause,
3651 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3652 body of the @code{if}.
3653
3654 @item -frerun-cse-after-loop
3655 @opindex frerun-cse-after-loop
3656 Re-run common subexpression elimination after loop optimizations has been
3657 performed.
3658
3659 @item -frerun-loop-opt
3660 @opindex frerun-loop-opt
3661 Run the loop optimizer twice.
3662
3663 @item -fgcse
3664 @opindex fgcse
3665 Perform a global common subexpression elimination pass.
3666 This pass also performs global constant and copy propagation.
3667
3668 @emph{Note:} When compiling a program using computed gotos, a GCC
3669 extension, you may get better runtime performance if you disable
3670 the global common subexpression elmination pass by adding
3671 @option{-fno-gcse} to the command line.
3672
3673 @item -fgcse-lm
3674 @opindex fgcse-lm
3675 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3676 attempt to move loads which are only killed by stores into themselves.  This
3677 allows a loop containing a load/store sequence to be changed to a load outside
3678 the loop, and a copy/store within the loop.
3679
3680 @item -fgcse-sm
3681 @opindex fgcse-sm
3682 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3683 subexpression elimination.  This pass will attempt to move stores out of loops.
3684 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3685 can be changed to a load before the loop and a store after the loop.
3686
3687 @item -floop-optimize
3688 @opindex floop-optimize
3689 Perform loop optimizations: move constant expressions out of loops, simplify
3690 exit test conditions and optionally do strength-reduction and loop unrolling as
3691 well.
3692
3693 @item -fcrossjumping
3694 @opindex crossjumping
3695 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3696 resulting code may or may not perform better than without cross-jumping.
3697
3698 @item -fif-conversion
3699 @opindex if-conversion
3700 Attempt to transform conditional jumps into branch-less equivalents.  This
3701 include use of conditional moves, min, max, set flags and abs instructions, and
3702 some tricks doable by standard arithmetics.  The use of conditional execution
3703 on chips where it is available is controlled by @code{if-conversion2}.
3704
3705 @item -fif-conversion2
3706 @opindex if-conversion2
3707 Use conditional execution (where available) to transform conditional jumps into
3708 branch-less equivalents.
3709
3710 @item -fdelete-null-pointer-checks
3711 @opindex fdelete-null-pointer-checks
3712 Use global dataflow analysis to identify and eliminate useless checks
3713 for null pointers.  The compiler assumes that dereferencing a null
3714 pointer would have halted the program.  If a pointer is checked after
3715 it has already been dereferenced, it cannot be null.
3716
3717 In some environments, this assumption is not true, and programs can
3718 safely dereference null pointers.  Use
3719 @option{-fno-delete-null-pointer-checks} to disable this optimization
3720 for programs which depend on that behavior.
3721
3722 @item -fexpensive-optimizations
3723 @opindex fexpensive-optimizations
3724 Perform a number of minor optimizations that are relatively expensive.
3725
3726 @item -foptimize-register-move
3727 @itemx -fregmove
3728 @opindex foptimize-register-move
3729 @opindex fregmove
3730 Attempt to reassign register numbers in move instructions and as
3731 operands of other simple instructions in order to maximize the amount of
3732 register tying.  This is especially helpful on machines with two-operand
3733 instructions.  GCC enables this optimization by default with @option{-O2}
3734 or higher.
3735
3736 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3737 optimization.
3738
3739 @item -fdelayed-branch
3740 @opindex fdelayed-branch
3741 If supported for the target machine, attempt to reorder instructions
3742 to exploit instruction slots available after delayed branch
3743 instructions.
3744
3745 @item -fschedule-insns
3746 @opindex fschedule-insns
3747 If supported for the target machine, attempt to reorder instructions to
3748 eliminate execution stalls due to required data being unavailable.  This
3749 helps machines that have slow floating point or memory load instructions
3750 by allowing other instructions to be issued until the result of the load
3751 or floating point instruction is required.
3752
3753 @item -fschedule-insns2
3754 @opindex fschedule-insns2
3755 Similar to @option{-fschedule-insns}, but requests an additional pass of
3756 instruction scheduling after register allocation has been done.  This is
3757 especially useful on machines with a relatively small number of
3758 registers and where memory load instructions take more than one cycle.
3759
3760 @item -ffunction-sections
3761 @itemx -fdata-sections
3762 @opindex ffunction-sections
3763 @opindex fdata-sections
3764 Place each function or data item into its own section in the output
3765 file if the target supports arbitrary sections.  The name of the
3766 function or the name of the data item determines the section's name
3767 in the output file.
3768
3769 Use these options on systems where the linker can perform optimizations
3770 to improve locality of reference in the instruction space.  HPPA
3771 processors running HP-UX and SPARC processors running Solaris 2 have
3772 linkers with such optimizations.  Other systems using the ELF object format
3773 as well as AIX may have these optimizations in the future.
3774
3775 Only use these options when there are significant benefits from doing
3776 so.  When you specify these options, the assembler and linker will
3777 create larger object and executable files and will also be slower.
3778 You will not be able to use @code{gprof} on all systems if you
3779 specify this option and you may have problems with debugging if
3780 you specify both this option and @option{-g}.
3781
3782 @item -fcaller-saves
3783 @opindex fcaller-saves
3784 Enable values to be allocated in registers that will be clobbered by
3785 function calls, by emitting extra instructions to save and restore the
3786 registers around such calls.  Such allocation is done only when it
3787 seems to result in better code than would otherwise be produced.
3788
3789 This option is always enabled by default on certain machines, usually
3790 those which have no call-preserved registers to use instead.
3791
3792 For all machines, optimization level 2 and higher enables this flag by
3793 default.
3794
3795 @item -ftracer
3796 @opindex ftracer
3797 Perform tail duplication to enlarge superblock size. This transformation
3798 simplifies the control flow of the function allowing other optimizations to do
3799 better job.
3800
3801 @item -funroll-loops
3802 @opindex funroll-loops
3803 Unroll loops whose number of iterations can be determined at compile
3804 time or upon entry to the loop.  @option{-funroll-loops} implies both
3805 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3806 option makes code larger, and may or may not make it run faster.
3807
3808 @item -funroll-all-loops
3809 @opindex funroll-all-loops
3810 Unroll all loops, even if their number of iterations is uncertain when
3811 the loop is entered.  This usually makes programs run more slowly.
3812 @option{-funroll-all-loops} implies the same options as
3813 @option{-funroll-loops},
3814
3815 @item -fprefetch-loop-arrays
3816 @opindex fprefetch-loop-arrays
3817 If supported by the target machine, generate instructions to prefetch
3818 memory to improve the performance of loops that access large arrays.
3819
3820 @item -fmove-all-movables
3821 @opindex fmove-all-movables
3822 Forces all invariant computations in loops to be moved
3823 outside the loop.
3824
3825 @item -freduce-all-givs
3826 @opindex freduce-all-givs
3827 Forces all general-induction variables in loops to be
3828 strength-reduced.
3829
3830 @emph{Note:} When compiling programs written in Fortran,
3831 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3832 by default when you use the optimizer.
3833
3834 These options may generate better or worse code; results are highly
3835 dependent on the structure of loops within the source code.
3836
3837 These two options are intended to be removed someday, once
3838 they have helped determine the efficacy of various
3839 approaches to improving loop optimizations.
3840
3841 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3842 know how use of these options affects
3843 the performance of your production code.
3844 We're very interested in code that runs @emph{slower}
3845 when these options are @emph{enabled}.
3846
3847 @item -fno-peephole
3848 @itemx -fno-peephole2
3849 @opindex fno-peephole
3850 @opindex fno-peephole2
3851 Disable any machine-specific peephole optimizations.  The difference
3852 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3853 are implemented in the compiler; some targets use one, some use the
3854 other, a few use both.
3855
3856 @item -fbranch-probabilities
3857 @opindex fbranch-probabilities
3858 After running a program compiled with @option{-fprofile-arcs}
3859 (@pxref{Debugging Options,, Options for Debugging Your Program or
3860 @command{gcc}}), you can compile it a second time using
3861 @option{-fbranch-probabilities}, to improve optimizations based on
3862 the number of times each branch was taken.  When the program
3863 compiled with @option{-fprofile-arcs} exits it saves arc execution
3864 counts to a file called @file{@var{sourcename}.da} for each source
3865 file  The information in this data file is very dependent on the
3866 structure of the generated code, so you must use the same source code
3867 and the same optimization options for both compilations.
3868
3869 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3870 note on the first instruction of each basic block, and a
3871 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3872 These can be used to improve optimization.  Currently, they are only
3873 used in one place: in @file{reorg.c}, instead of guessing which path a
3874 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3875 exactly determine which path is taken more often.
3876
3877 @item -fno-guess-branch-probability
3878 @opindex fno-guess-branch-probability
3879 Do not guess branch probabilities using a randomized model.
3880
3881 Sometimes gcc will opt to use a randomized model to guess branch
3882 probabilities, when none are available from either profiling feedback
3883 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3884 different runs of the compiler on the same program may produce different
3885 object code.
3886
3887 In a hard real-time system, people don't want different runs of the
3888 compiler to produce code that has different behavior; minimizing
3889 non-determinism is of paramount import.  This switch allows users to
3890 reduce non-determinism, possibly at the expense of inferior
3891 optimization.
3892
3893 @item -freorder-blocks
3894 @opindex freorder-blocks
3895 Reorder basic blocks in the compiled function in order to reduce number of
3896 taken branches and improve code locality.
3897
3898 @item -freorder-functions
3899 @opindex freorder-functions
3900 Reorder basic blocks in the compiled function in order to reduce number of
3901 taken branches and improve code locality. This is implemented by using special
3902 subsections @code{text.hot} for most frequently executed functions and
3903 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
3904 the linker so object file format must support named sections and linker must
3905 place them in resonable way.
3906
3907 Also profile feedback must be available in to make this option effective.  See
3908 @option{-fprofile-arcs} for details.
3909
3910 @item -fstrict-aliasing
3911 @opindex fstrict-aliasing
3912 Allows the compiler to assume the strictest aliasing rules applicable to
3913 the language being compiled.  For C (and C++), this activates
3914 optimizations based on the type of expressions.  In particular, an
3915 object of one type is assumed never to reside at the same address as an
3916 object of a different type, unless the types are almost the same.  For
3917 example, an @code{unsigned int} can alias an @code{int}, but not a
3918 @code{void*} or a @code{double}.  A character type may alias any other
3919 type.
3920
3921 Pay special attention to code like this:
3922 @example
3923 union a_union @{
3924   int i;
3925   double d;
3926 @};
3927
3928 int f() @{
3929   a_union t;
3930   t.d = 3.0;
3931   return t.i;
3932 @}
3933 @end example
3934 The practice of reading from a different union member than the one most
3935 recently written to (called ``type-punning'') is common.  Even with
3936 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
3937 is accessed through the union type.  So, the code above will work as
3938 expected.  However, this code might not:
3939 @example
3940 int f() @{
3941   a_union t;
3942   int* ip;
3943   t.d = 3.0;
3944   ip = &t.i;
3945   return *ip;
3946 @}
3947 @end example
3948
3949 Every language that wishes to perform language-specific alias analysis
3950 should define a function that computes, given an @code{tree}
3951 node, an alias set for the node.  Nodes in different alias sets are not
3952 allowed to alias.  For an example, see the C front-end function
3953 @code{c_get_alias_set}.
3954
3955 For all machines, optimization level 2 and higher enables this flag by
3956 default.
3957
3958 @item -falign-functions
3959 @itemx -falign-functions=@var{n}
3960 @opindex falign-functions
3961 Align the start of functions to the next power-of-two greater than
3962 @var{n}, skipping up to @var{n} bytes.  For instance,
3963 @option{-falign-functions=32} aligns functions to the next 32-byte
3964 boundary, but @option{-falign-functions=24} would align to the next
3965 32-byte boundary only if this can be done by skipping 23 bytes or less.
3966
3967 @option{-fno-align-functions} and @option{-falign-functions=1} are
3968 equivalent and mean that functions will not be aligned.
3969
3970 Some assemblers only support this flag when @var{n} is a power of two;
3971 in that case, it is rounded up.
3972
3973 If @var{n} is not specified, use a machine-dependent default.
3974
3975 @item -falign-labels
3976 @itemx -falign-labels=@var{n}
3977 @opindex falign-labels
3978 Align all branch targets to a power-of-two boundary, skipping up to
3979 @var{n} bytes like @option{-falign-functions}.  This option can easily
3980 make code slower, because it must insert dummy operations for when the
3981 branch target is reached in the usual flow of the code.
3982
3983 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
3984 are greater than this value, then their values are used instead.
3985
3986 If @var{n} is not specified, use a machine-dependent default which is
3987 very likely to be @samp{1}, meaning no alignment.
3988
3989 @item -falign-loops
3990 @itemx -falign-loops=@var{n}
3991 @opindex falign-loops
3992 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3993 like @option{-falign-functions}.  The hope is that the loop will be
3994 executed many times, which will make up for any execution of the dummy
3995 operations.
3996
3997 If @var{n} is not specified, use a machine-dependent default.
3998
3999 @item -falign-jumps
4000 @itemx -falign-jumps=@var{n}
4001 @opindex falign-jumps
4002 Align branch targets to a power-of-two boundary, for branch targets
4003 where the targets can only be reached by jumping, skipping up to @var{n}
4004 bytes like @option{-falign-functions}.  In this case, no dummy operations
4005 need be executed.
4006
4007 If @var{n} is not specified, use a machine-dependent default.
4008
4009 @item -fssa
4010 @opindex fssa
4011 Perform optimizations in static single assignment form.  Each function's
4012 flow graph is translated into SSA form, optimizations are performed, and
4013 the flow graph is translated back from SSA form.  Users should not
4014 specify this option, since it is not yet ready for production use.
4015
4016 @item -fssa-ccp
4017 @opindex fssa-ccp
4018 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4019 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4020
4021 @item -fssa-dce
4022 @opindex fssa-dce
4023 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4024 Like @option{-fssa}, this is an experimental feature.
4025
4026 @item -fsingle-precision-constant
4027 @opindex fsingle-precision-constant
4028 Treat floating point constant as single precision constant instead of
4029 implicitly converting it to double precision constant.
4030
4031 @item -frename-registers
4032 @opindex frename-registers
4033 Attempt to avoid false dependencies in scheduled code by making use
4034 of registers left over after register allocation.  This optimization
4035 will most benefit processors with lots of registers.  It can, however,
4036 make debugging impossible, since variables will no longer stay in
4037 a ``home register''.
4038
4039 @item -fno-cprop-registers
4040 @opindex fno-cprop-registers
4041 After register allocation and post-register allocation instruction splitting,
4042 we perform a copy-propagation pass to try to reduce scheduling dependencies
4043 and occasionally eliminate the copy.
4044
4045 @item --param @var{name}=@var{value}
4046 @opindex param
4047 In some places, GCC uses various constants to control the amount of
4048 optimization that is done.  For example, GCC will not inline functions
4049 that contain more that a certain number of instructions.  You can
4050 control some of these constants on the command-line using the
4051 @option{--param} option.
4052
4053 In each case, the @var{value} is an integer.  The allowable choices for
4054 @var{name} are given in the following table:
4055
4056 @table @gcctabopt
4057 @item max-delay-slot-insn-search
4058 The maximum number of instructions to consider when looking for an
4059 instruction to fill a delay slot.  If more than this arbitrary number of
4060 instructions is searched, the time savings from filling the delay slot
4061 will be minimal so stop searching.  Increasing values mean more
4062 aggressive optimization, making the compile time increase with probably
4063 small improvement in executable run time.
4064
4065 @item max-delay-slot-live-search
4066 When trying to fill delay slots, the maximum number of instructions to
4067 consider when searching for a block with valid live register
4068 information.  Increasing this arbitrarily chosen value means more
4069 aggressive optimization, increasing the compile time.  This parameter
4070 should be removed when the delay slot code is rewritten to maintain the
4071 control-flow graph.
4072
4073 @item max-gcse-memory
4074 The approximate maximum amount of memory that will be allocated in
4075 order to perform the global common subexpression elimination
4076 optimization.  If more memory than specified is required, the
4077 optimization will not be done.
4078
4079 @item max-gcse-passes
4080 The maximum number of passes of GCSE to run.
4081
4082 @item max-pending-list-length
4083 The maximum number of pending dependencies scheduling will allow
4084 before flushing the current state and starting over.  Large functions
4085 with few branches or calls can create excessively large lists which
4086 needlessly consume memory and resources.
4087
4088 @item max-inline-insns
4089 If an function contains more than this many instructions, it
4090 will not be inlined.  This option is precisely equivalent to
4091 @option{-finline-limit}.
4092
4093 @item max-unrolled-insns
4094 The maximum number of instructions that a loop should have if that loop
4095 is unrolled, and if the loop is unrolled, it determines how many times
4096 the loop code is unrolled.
4097
4098 @item hot-bb-count-fraction
4099 Select fraction of the maximal count of repetitions of basic block in program
4100 given basic block needs to have to be considered hot.
4101
4102 @item hot-bb-frequency-fraction
4103 Select fraction of the maximal frequency of executions of basic block in
4104 function given basic block needs to have to be considered hot
4105
4106 @item tracer-dynamic-coverage
4107 @itemx tracer-dynamic-coverage-feedback
4108
4109 This value is used to limit superblock formation once given percentage of
4110 executed instructions is covered.  This limits unnecesary code size expansion.
4111
4112 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4113 feedback is available.  The real profiles (as opposed to statically estimated
4114 ones) are much less balanced allowing the threshold to be larger value.
4115
4116 @item tracer-max-code-growth
4117 Stop tail duplication once code growth has reached given percentage.  This is
4118 rather hokey argument, as most of the duplicates will be elliminated later in
4119 cross jumping, so it may be set to much higher values than is the desired code
4120 growth.
4121
4122 @item tracer-min-branch-ratio
4123
4124 Stop reverse growth when the reverse probability of best edge is less than this
4125 threshold (in percent).
4126
4127 @item tracer-min-branch-ratio
4128 @itemx tracer-min-branch-ratio-feedback
4129
4130 Stop forward growth if the best edge do have probability lower than this
4131 threshold.
4132
4133 Similary to @option{tracer-dynamic-coverage} two values are present, one for
4134 compilation for profile feedback and one for compilation without.  The value
4135 for compilation with profile feedback needs to be more conservative (higher) in
4136 order to make tracer effective.
4137
4138 @end table
4139 @end table
4140
4141 @node Preprocessor Options
4142 @section Options Controlling the Preprocessor
4143 @cindex preprocessor options
4144 @cindex options, preprocessor
4145
4146 These options control the C preprocessor, which is run on each C source
4147 file before actual compilation.
4148
4149 If you use the @option{-E} option, nothing is done except preprocessing.
4150 Some of these options make sense only together with @option{-E} because
4151 they cause the preprocessor output to be unsuitable for actual
4152 compilation.
4153
4154 @opindex Wp
4155 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4156 and pass @var{option} directly through to the preprocessor.  If
4157 @var{option} contains commas, it is split into multiple options at the
4158 commas.  However, many options are modified, translated or interpreted
4159 by the compiler driver before being passed to the preprocessor, and
4160 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4161 interface is undocumented and subject to change, so whenever possible
4162 you should avoid using @option{-Wp} and let the driver handle the
4163 options instead.
4164
4165 @include cppopts.texi
4166
4167 @node Assembler Options
4168 @section Passing Options to the Assembler
4169
4170 @c prevent bad page break with this line
4171 You can pass options to the assembler.
4172
4173 @table @gcctabopt
4174 @item -Wa,@var{option}
4175 @opindex Wa
4176 Pass @var{option} as an option to the assembler.  If @var{option}
4177 contains commas, it is split into multiple options at the commas.
4178 @end table
4179
4180 @node Link Options
4181 @section Options for Linking
4182 @cindex link options
4183 @cindex options, linking
4184
4185 These options come into play when the compiler links object files into
4186 an executable output file.  They are meaningless if the compiler is
4187 not doing a link step.
4188
4189 @table @gcctabopt
4190 @cindex file names
4191 @item @var{object-file-name}
4192 A file name that does not end in a special recognized suffix is
4193 considered to name an object file or library.  (Object files are
4194 distinguished from libraries by the linker according to the file
4195 contents.)  If linking is done, these object files are used as input
4196 to the linker.
4197
4198 @item -c
4199 @itemx -S
4200 @itemx -E
4201 @opindex c
4202 @opindex S
4203 @opindex E
4204 If any of these options is used, then the linker is not run, and
4205 object file names should not be used as arguments.  @xref{Overall
4206 Options}.
4207
4208 @cindex Libraries
4209 @item -l@var{library}
4210 @itemx -l @var{library}
4211 @opindex l
4212 Search the library named @var{library} when linking.  (The second
4213 alternative with the library as a separate argument is only for
4214 POSIX compliance and is not recommended.)
4215
4216 It makes a difference where in the command you write this option; the
4217 linker searches and processes libraries and object files in the order they
4218 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4219 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4220 to functions in @samp{z}, those functions may not be loaded.
4221
4222 The linker searches a standard list of directories for the library,
4223 which is actually a file named @file{lib@var{library}.a}.  The linker
4224 then uses this file as if it had been specified precisely by name.
4225
4226 The directories searched include several standard system directories
4227 plus any that you specify with @option{-L}.
4228
4229 Normally the files found this way are library files---archive files
4230 whose members are object files.  The linker handles an archive file by
4231 scanning through it for members which define symbols that have so far
4232 been referenced but not defined.  But if the file that is found is an
4233 ordinary object file, it is linked in the usual fashion.  The only
4234 difference between using an @option{-l} option and specifying a file name
4235 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4236 and searches several directories.
4237
4238 @item -lobjc
4239 @opindex lobjc
4240 You need this special case of the @option{-l} option in order to
4241 link an Objective-C program.
4242
4243 @item -nostartfiles
4244 @opindex nostartfiles
4245 Do not use the standard system startup files when linking.
4246 The standard system libraries are used normally, unless @option{-nostdlib}
4247 or @option{-nodefaultlibs} is used.
4248
4249 @item -nodefaultlibs
4250 @opindex nodefaultlibs
4251 Do not use the standard system libraries when linking.
4252 Only the libraries you specify will be passed to the linker.
4253 The standard startup files are used normally, unless @option{-nostartfiles}
4254 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4255 for System V (and ISO C) environments or to bcopy and bzero for
4256 BSD environments.  These entries are usually resolved by entries in
4257 libc.  These entry points should be supplied through some other
4258 mechanism when this option is specified.
4259
4260 @item -nostdlib
4261 @opindex nostdlib
4262 Do not use the standard system startup files or libraries when linking.
4263 No startup files and only the libraries you specify will be passed to
4264 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4265 for System V (and ISO C) environments or to bcopy and bzero for
4266 BSD environments.  These entries are usually resolved by entries in
4267 libc.  These entry points should be supplied through some other
4268 mechanism when this option is specified.
4269
4270 @cindex @option{-lgcc}, use with @option{-nostdlib}
4271 @cindex @option{-nostdlib} and unresolved references
4272 @cindex unresolved references and @option{-nostdlib}
4273 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4274 @cindex @option{-nodefaultlibs} and unresolved references
4275 @cindex unresolved references and @option{-nodefaultlibs}
4276 One of the standard libraries bypassed by @option{-nostdlib} and
4277 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4278 that GCC uses to overcome shortcomings of particular machines, or special
4279 needs for some languages.
4280 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4281 Collection (GCC) Internals},
4282 for more discussion of @file{libgcc.a}.)
4283 In most cases, you need @file{libgcc.a} even when you want to avoid
4284 other standard libraries.  In other words, when you specify @option{-nostdlib}
4285 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4286 This ensures that you have no unresolved references to internal GCC
4287 library subroutines.  (For example, @samp{__main}, used to ensure C++
4288 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4289 GNU Compiler Collection (GCC) Internals}.)
4290
4291 @item -s
4292 @opindex s
4293 Remove all symbol table and relocation information from the executable.
4294
4295 @item -static
4296 @opindex static
4297 On systems that support dynamic linking, this prevents linking with the shared
4298 libraries.  On other systems, this option has no effect.
4299
4300 @item -shared
4301 @opindex shared
4302 Produce a shared object which can then be linked with other objects to
4303 form an executable.  Not all systems support this option.  For predictable
4304 results, you must also specify the same set of options that were used to
4305 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4306 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4307 needs to build supplementary stub code for constructors to work.  On
4308 multi-libbed systems, @samp{gcc -shared} must select the correct support
4309 libraries to link against.  Failing to supply the correct flags may lead
4310 to subtle defects.  Supplying them in cases where they are not necessary
4311 is innocuous.}
4312
4313 @item -shared-libgcc
4314 @itemx -static-libgcc
4315 @opindex shared-libgcc
4316 @opindex static-libgcc
4317 On systems that provide @file{libgcc} as a shared library, these options
4318 force the use of either the shared or static version respectively.
4319 If no shared version of @file{libgcc} was built when the compiler was
4320 configured, these options have no effect.
4321
4322 There are several situations in which an application should use the
4323 shared @file{libgcc} instead of the static version.  The most common
4324 of these is when the application wishes to throw and catch exceptions
4325 across different shared libraries.  In that case, each of the libraries
4326 as well as the application itself should use the shared @file{libgcc}.
4327
4328 Therefore, the G++ and GCJ drivers automatically add
4329 @option{-shared-libgcc} whenever you build a shared library or a main
4330 executable, because C++ and Java programs typically use exceptions, so
4331 this is the right thing to do.
4332
4333 If, instead, you use the GCC driver to create shared libraries, you may
4334 find that they will not always be linked with the shared @file{libgcc}.
4335 If GCC finds, at its configuration time, that you have a GNU linker that
4336 does not support option @option{--eh-frame-hdr}, it will link the shared
4337 version of @file{libgcc} into shared libraries by default.  Otherwise,
4338 it will take advantage of the linker and optimize away the linking with
4339 the shared version of @file{libgcc}, linking with the static version of
4340 libgcc by default.  This allows exceptions to propagate through such
4341 shared libraries, without incurring relocation costs at library load
4342 time.
4343
4344 However, if a library or main executable is supposed to throw or catch
4345 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4346 for the languages used in the program, or using the option
4347 @option{-shared-libgcc}, such that it is linked with the shared
4348 @file{libgcc}.
4349
4350 @item -symbolic
4351 @opindex symbolic
4352 Bind references to global symbols when building a shared object.  Warn
4353 about any unresolved references (unless overridden by the link editor
4354 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4355 this option.
4356
4357 @item -Xlinker @var{option}
4358 @opindex Xlinker
4359 Pass @var{option} as an option to the linker.  You can use this to
4360 supply system-specific linker options which GCC does not know how to
4361 recognize.
4362
4363 If you want to pass an option that takes an argument, you must use
4364 @option{-Xlinker} twice, once for the option and once for the argument.
4365 For example, to pass @option{-assert definitions}, you must write
4366 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4367 @option{-Xlinker "-assert definitions"}, because this passes the entire
4368 string as a single argument, which is not what the linker expects.
4369
4370 @item -Wl,@var{option}
4371 @opindex Wl
4372 Pass @var{option} as an option to the linker.  If @var{option} contains
4373 commas, it is split into multiple options at the commas.
4374
4375 @item -u @var{symbol}
4376 @opindex u
4377 Pretend the symbol @var{symbol} is undefined, to force linking of
4378 library modules to define it.  You can use @option{-u} multiple times with
4379 different symbols to force loading of additional library modules.
4380 @end table
4381
4382 @node Directory Options
4383 @section Options for Directory Search
4384 @cindex directory options
4385 @cindex options, directory search
4386 @cindex search path
4387
4388 These options specify directories to search for header files, for
4389 libraries and for parts of the compiler:
4390
4391 @table @gcctabopt
4392 @item -I@var{dir}
4393 @opindex I
4394 Add the directory @var{dir} to the head of the list of directories to be
4395 searched for header files.  This can be used to override a system header
4396 file, substituting your own version, since these directories are
4397 searched before the system header file directories.  However, you should
4398 not use this option to add directories that contain vendor-supplied
4399 system header files (use @option{-isystem} for that).  If you use more than
4400 one @option{-I} option, the directories are scanned in left-to-right
4401 order; the standard system directories come after.
4402
4403 If a standard system include directory, or a directory specified with
4404 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4405 option will be ignored.  The directory will still be searched but as a
4406 system directory at its normal position in the system include chain.
4407 This is to ensure that GCC's procedure to fix buggy system headers and
4408 the ordering for the include_next directive are not inadvertantly changed.
4409 If you really need to change the search order for system directories,
4410 use the @option{-nostdinc} and/or @option{-isystem} options.
4411
4412 @item -I-
4413 @opindex I-
4414 Any directories you specify with @option{-I} options before the @option{-I-}
4415 option are searched only for the case of @samp{#include "@var{file}"};
4416 they are not searched for @samp{#include <@var{file}>}.
4417
4418 If additional directories are specified with @option{-I} options after
4419 the @option{-I-}, these directories are searched for all @samp{#include}
4420 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4421 this way.)
4422
4423 In addition, the @option{-I-} option inhibits the use of the current
4424 directory (where the current input file came from) as the first search
4425 directory for @samp{#include "@var{file}"}.  There is no way to
4426 override this effect of @option{-I-}.  With @option{-I.} you can specify
4427 searching the directory which was current when the compiler was
4428 invoked.  That is not exactly the same as what the preprocessor does
4429 by default, but it is often satisfactory.
4430
4431 @option{-I-} does not inhibit the use of the standard system directories
4432 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4433 independent.
4434
4435 @item -L@var{dir}
4436 @opindex L
4437 Add directory @var{dir} to the list of directories to be searched
4438 for @option{-l}.
4439
4440 @item -B@var{prefix}
4441 @opindex B
4442 This option specifies where to find the executables, libraries,
4443 include files, and data files of the compiler itself.
4444
4445 The compiler driver program runs one or more of the subprograms
4446 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4447 @var{prefix} as a prefix for each program it tries to run, both with and
4448 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4449
4450 For each subprogram to be run, the compiler driver first tries the
4451 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4452 was not specified, the driver tries two standard prefixes, which are
4453 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4454 those results in a file name that is found, the unmodified program
4455 name is searched for using the directories specified in your
4456 @env{PATH} environment variable.
4457
4458 The compiler will check to see if the path provided by the @option{-B}
4459 refers to a directory, and if necessary it will add a directory
4460 separator character at the end of the path.
4461
4462 @option{-B} prefixes that effectively specify directory names also apply
4463 to libraries in the linker, because the compiler translates these
4464 options into @option{-L} options for the linker.  They also apply to
4465 includes files in the preprocessor, because the compiler translates these
4466 options into @option{-isystem} options for the preprocessor.  In this case,
4467 the compiler appends @samp{include} to the prefix.
4468
4469 The run-time support file @file{libgcc.a} can also be searched for using
4470 the @option{-B} prefix, if needed.  If it is not found there, the two
4471 standard prefixes above are tried, and that is all.  The file is left
4472 out of the link if it is not found by those means.
4473
4474 Another way to specify a prefix much like the @option{-B} prefix is to use
4475 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4476 Variables}.
4477
4478 As a special kludge, if the path provided by @option{-B} is
4479 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4480 9, then it will be replaced by @file{[dir/]include}.  This is to help
4481 with boot-strapping the compiler.
4482
4483 @item -specs=@var{file}
4484 @opindex specs
4485 Process @var{file} after the compiler reads in the standard @file{specs}
4486 file, in order to override the defaults that the @file{gcc} driver
4487 program uses when determining what switches to pass to @file{cc1},
4488 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4489 @option{-specs=@var{file}} can be specified on the command line, and they
4490 are processed in order, from left to right.
4491 @end table
4492
4493 @c man end
4494
4495 @node Spec Files
4496 @section Specifying subprocesses and the switches to pass to them
4497 @cindex Spec Files
4498 @command{gcc} is a driver program.  It performs its job by invoking a
4499 sequence of other programs to do the work of compiling, assembling and
4500 linking.  GCC interprets its command-line parameters and uses these to
4501 deduce which programs it should invoke, and which command-line options
4502 it ought to place on their command lines.  This behavior is controlled
4503 by @dfn{spec strings}.  In most cases there is one spec string for each
4504 program that GCC can invoke, but a few programs have multiple spec
4505 strings to control their behavior.  The spec strings built into GCC can
4506 be overridden by using the @option{-specs=} command-line switch to specify
4507 a spec file.
4508
4509 @dfn{Spec files} are plaintext files that are used to construct spec
4510 strings.  They consist of a sequence of directives separated by blank
4511 lines.  The type of directive is determined by the first non-whitespace
4512 character on the line and it can be one of the following:
4513
4514 @table @code
4515 @item %@var{command}
4516 Issues a @var{command} to the spec file processor.  The commands that can
4517 appear here are:
4518
4519 @table @code
4520 @item %include <@var{file}>
4521 @cindex %include
4522 Search for @var{file} and insert its text at the current point in the
4523 specs file.
4524
4525 @item %include_noerr <@var{file}>
4526 @cindex %include_noerr
4527 Just like @samp{%include}, but do not generate an error message if the include
4528 file cannot be found.
4529
4530 @item %rename @var{old_name} @var{new_name}
4531 @cindex %rename
4532 Rename the spec string @var{old_name} to @var{new_name}.
4533
4534 @end table
4535
4536 @item *[@var{spec_name}]:
4537 This tells the compiler to create, override or delete the named spec
4538 string.  All lines after this directive up to the next directive or
4539 blank line are considered to be the text for the spec string.  If this
4540 results in an empty string then the spec will be deleted.  (Or, if the
4541 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4542 does not currently exist a new spec will be created.  If the spec does
4543 exist then its contents will be overridden by the text of this
4544 directive, unless the first character of that text is the @samp{+}
4545 character, in which case the text will be appended to the spec.
4546
4547 @item [@var{suffix}]:
4548 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4549 and up to the next directive or blank line are considered to make up the
4550 spec string for the indicated suffix.  When the compiler encounters an
4551 input file with the named suffix, it will processes the spec string in
4552 order to work out how to compile that file.  For example:
4553
4554 @smallexample
4555 .ZZ:
4556 z-compile -input %i
4557 @end smallexample
4558
4559 This says that any input file whose name ends in @samp{.ZZ} should be
4560 passed to the program @samp{z-compile}, which should be invoked with the
4561 command-line switch @option{-input} and with the result of performing the
4562 @samp{%i} substitution.  (See below.)
4563
4564 As an alternative to providing a spec string, the text that follows a
4565 suffix directive can be one of the following:
4566
4567 @table @code
4568 @item @@@var{language}
4569 This says that the suffix is an alias for a known @var{language}.  This is
4570 similar to using the @option{-x} command-line switch to GCC to specify a
4571 language explicitly.  For example:
4572
4573 @smallexample
4574 .ZZ:
4575 @@c++
4576 @end smallexample
4577
4578 Says that .ZZ files are, in fact, C++ source files.
4579
4580 @item #@var{name}
4581 This causes an error messages saying:
4582
4583 @smallexample
4584 @var{name} compiler not installed on this system.
4585 @end smallexample
4586 @end table
4587
4588 GCC already has an extensive list of suffixes built into it.
4589 This directive will add an entry to the end of the list of suffixes, but
4590 since the list is searched from the end backwards, it is effectively
4591 possible to override earlier entries using this technique.
4592
4593 @end table
4594
4595 GCC has the following spec strings built into it.  Spec files can
4596 override these strings or create their own.  Note that individual
4597 targets can also add their own spec strings to this list.
4598
4599 @smallexample
4600 asm          Options to pass to the assembler
4601 asm_final    Options to pass to the assembler post-processor
4602 cpp          Options to pass to the C preprocessor
4603 cc1          Options to pass to the C compiler
4604 cc1plus      Options to pass to the C++ compiler
4605 endfile      Object files to include at the end of the link
4606 link         Options to pass to the linker
4607 lib          Libraries to include on the command line to the linker
4608 libgcc       Decides which GCC support library to pass to the linker
4609 linker       Sets the name of the linker
4610 predefines   Defines to be passed to the C preprocessor
4611 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4612              by default
4613 startfile    Object files to include at the start of the link
4614 @end smallexample
4615
4616 Here is a small example of a spec file:
4617
4618 @smallexample
4619 %rename lib                 old_lib
4620
4621 *lib:
4622 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4623 @end smallexample
4624
4625 This example renames the spec called @samp{lib} to @samp{old_lib} and
4626 then overrides the previous definition of @samp{lib} with a new one.
4627 The new definition adds in some extra command-line options before
4628 including the text of the old definition.
4629
4630 @dfn{Spec strings} are a list of command-line options to be passed to their
4631 corresponding program.  In addition, the spec strings can contain
4632 @samp{%}-prefixed sequences to substitute variable text or to
4633 conditionally insert text into the command line.  Using these constructs
4634 it is possible to generate quite complex command lines.
4635
4636 Here is a table of all defined @samp{%}-sequences for spec
4637 strings.  Note that spaces are not generated automatically around the
4638 results of expanding these sequences.  Therefore you can concatenate them
4639 together or combine them with constant text in a single argument.
4640
4641 @table @code
4642 @item %%
4643 Substitute one @samp{%} into the program name or argument.
4644
4645 @item %i
4646 Substitute the name of the input file being processed.
4647
4648 @item %b
4649 Substitute the basename of the input file being processed.
4650 This is the substring up to (and not including) the last period
4651 and not including the directory.
4652
4653 @item %B
4654 This is the same as @samp{%b}, but include the file suffix (text after
4655 the last period).
4656
4657 @item %d
4658 Marks the argument containing or following the @samp{%d} as a
4659 temporary file name, so that that file will be deleted if GCC exits
4660 successfully.  Unlike @samp{%g}, this contributes no text to the
4661 argument.
4662
4663 @item %g@var{suffix}
4664 Substitute a file name that has suffix @var{suffix} and is chosen
4665 once per compilation, and mark the argument in the same way as
4666 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4667 name is now chosen in a way that is hard to predict even when previously
4668 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4669 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4670 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4671 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4672 was simply substituted with a file name chosen once per compilation,
4673 without regard to any appended suffix (which was therefore treated
4674 just like ordinary text), making such attacks more likely to succeed.
4675
4676 @item %u@var{suffix}
4677 Like @samp{%g}, but generates a new temporary file name even if
4678 @samp{%u@var{suffix}} was already seen.
4679
4680 @item %U@var{suffix}
4681 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4682 new one if there is no such last file name.  In the absence of any
4683 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4684 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4685 would involve the generation of two distinct file names, one
4686 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4687 simply substituted with a file name chosen for the previous @samp{%u},
4688 without regard to any appended suffix.
4689
4690 @item %j@var{SUFFIX}
4691 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4692 writable, and if save-temps is off; otherwise, substitute the name
4693 of a temporary file, just like @samp{%u}.  This temporary file is not
4694 meant for communication between processes, but rather as a junk
4695 disposal mechanism.
4696
4697 @item %.@var{SUFFIX}
4698 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4699 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4700 terminated by the next space or %.
4701
4702 @item %w
4703 Marks the argument containing or following the @samp{%w} as the
4704 designated output file of this compilation.  This puts the argument
4705 into the sequence of arguments that @samp{%o} will substitute later.
4706
4707 @item %o
4708 Substitutes the names of all the output files, with spaces
4709 automatically placed around them.  You should write spaces
4710 around the @samp{%o} as well or the results are undefined.
4711 @samp{%o} is for use in the specs for running the linker.
4712 Input files whose names have no recognized suffix are not compiled
4713 at all, but they are included among the output files, so they will
4714 be linked.
4715
4716 @item %O
4717 Substitutes the suffix for object files.  Note that this is
4718 handled specially when it immediately follows @samp{%g, %u, or %U},
4719 because of the need for those to form complete file names.  The
4720 handling is such that @samp{%O} is treated exactly as if it had already
4721 been substituted, except that @samp{%g, %u, and %U} do not currently
4722 support additional @var{suffix} characters following @samp{%O} as they would
4723 following, for example, @samp{.o}.
4724
4725 @item %p
4726 Substitutes the standard macro predefinitions for the
4727 current target machine.  Use this when running @code{cpp}.
4728
4729 @item %P
4730 Like @samp{%p}, but puts @samp{__} before and after the name of each
4731 predefined macro, except for macros that start with @samp{__} or with
4732 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4733 C@.
4734
4735 @item %I
4736 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4737
4738 @item %s
4739 Current argument is the name of a library or startup file of some sort.
4740 Search for that file in a standard list of directories and substitute
4741 the full name found.
4742
4743 @item %e@var{str}
4744 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4745 Use this when inconsistent options are detected.
4746
4747 @item %|
4748 Output @samp{-} if the input for the current command is coming from a pipe.
4749
4750 @item %(@var{name})
4751 Substitute the contents of spec string @var{name} at this point.
4752
4753 @item %[@var{name}]
4754 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4755
4756 @item %x@{@var{option}@}
4757 Accumulate an option for @samp{%X}.
4758
4759 @item %X
4760 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4761 spec string.
4762
4763 @item %Y
4764 Output the accumulated assembler options specified by @option{-Wa}.
4765
4766 @item %Z
4767 Output the accumulated preprocessor options specified by @option{-Wp}.
4768
4769 @item %v1
4770 Substitute the major version number of GCC@.
4771 (For version 2.9.5, this is 2.)
4772
4773 @item %v2
4774 Substitute the minor version number of GCC@.
4775 (For version 2.9.5, this is 9.)
4776
4777 @item %v3
4778 Substitute the patch level number of GCC@.
4779 (For version 2.9.5, this is 5.)
4780
4781 @item %a
4782 Process the @code{asm} spec.  This is used to compute the
4783 switches to be passed to the assembler.
4784
4785 @item %A
4786 Process the @code{asm_final} spec.  This is a spec string for
4787 passing switches to an assembler post-processor, if such a program is
4788 needed.
4789
4790 @item %l
4791 Process the @code{link} spec.  This is the spec for computing the
4792 command line passed to the linker.  Typically it will make use of the
4793 @samp{%L %G %S %D and %E} sequences.
4794
4795 @item %D
4796 Dump out a @option{-L} option for each directory that GCC believes might
4797 contain startup files.  If the target supports multilibs then the
4798 current multilib directory will be prepended to each of these paths.
4799
4800 @item %M
4801 Output the multilib directory with directory separators replaced with
4802 @samp{_}.  If multilib directories are not set, or the multilib directory is
4803 @file{.} then this option emits nothing.
4804
4805 @item %L
4806 Process the @code{lib} spec.  This is a spec string for deciding which
4807 libraries should be included on the command line to the linker.
4808
4809 @item %G
4810 Process the @code{libgcc} spec.  This is a spec string for deciding
4811 which GCC support library should be included on the command line to the linker.
4812
4813 @item %S
4814 Process the @code{startfile} spec.  This is a spec for deciding which
4815 object files should be the first ones passed to the linker.  Typically
4816 this might be a file named @file{crt0.o}.
4817
4818 @item %E
4819 Process the @code{endfile} spec.  This is a spec string that specifies
4820 the last object files that will be passed to the linker.
4821
4822 @item %C
4823 Process the @code{cpp} spec.  This is used to construct the arguments
4824 to be passed to the C preprocessor.
4825
4826 @item %c
4827 Process the @code{signed_char} spec.  This is intended to be used
4828 to tell cpp whether a char is signed.  It typically has the definition:
4829 @smallexample
4830 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4831 @end smallexample
4832
4833 @item %1
4834 Process the @code{cc1} spec.  This is used to construct the options to be
4835 passed to the actual C compiler (@samp{cc1}).
4836
4837 @item %2
4838 Process the @code{cc1plus} spec.  This is used to construct the options to be
4839 passed to the actual C++ compiler (@samp{cc1plus}).
4840
4841 @item %*
4842 Substitute the variable part of a matched option.  See below.
4843 Note that each comma in the substituted string is replaced by
4844 a single space.
4845
4846 @item %@{@code{S}@}
4847 Substitutes the @code{-S} switch, if that switch was given to GCC@.
4848 If that switch was not specified, this substitutes nothing.  Note that
4849 the leading dash is omitted when specifying this option, and it is
4850 automatically inserted if the substitution is performed.  Thus the spec
4851 string @samp{%@{foo@}} would match the command-line option @option{-foo}
4852 and would output the command line option @option{-foo}.
4853
4854 @item %W@{@code{S}@}
4855 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4856 deleted on failure.
4857
4858 @item %@{@code{S}*@}
4859 Substitutes all the switches specified to GCC whose names start
4860 with @code{-S}, but which also take an argument.  This is used for
4861 switches like @option{-o}, @option{-D}, @option{-I}, etc.
4862 GCC considers @option{-o foo} as being
4863 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4864 text, including the space.  Thus two arguments would be generated.
4865
4866 @item %@{^@code{S}*@}
4867 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4868 argument.  Thus %@{^o*@} would only generate one argument, not two.
4869
4870 @item %@{@code{S}*&@code{T}*@}
4871 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4872 (the order of @code{S} and @code{T} in the spec is not significant).
4873 There can be any number of ampersand-separated variables; for each the
4874 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4875
4876 @item %@{<@code{S}@}
4877 Remove all occurrences of @code{-S} from the command line.  Note---this
4878 command is position dependent.  @samp{%} commands in the spec string
4879 before this option will see @code{-S}, @samp{%} commands in the spec
4880 string after this option will not.
4881
4882 @item %@{@code{S}*:@code{X}@}
4883 Substitutes @code{X} if one or more switches whose names start with
4884 @code{-S} are specified to GCC@.  Note that the tail part of the
4885 @code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
4886 for each occurrence of @samp{%*} within @code{X}.
4887
4888 @item %@{@code{S}:@code{X}@}
4889 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
4890
4891 @item %@{!@code{S}:@code{X}@}
4892 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
4893
4894 @item %@{|@code{S}:@code{X}@}
4895 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4896
4897 @item %@{|!@code{S}:@code{X}@}
4898 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4899
4900 @item %@{.@code{S}:@code{X}@}
4901 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4902
4903 @item %@{!.@code{S}:@code{X}@}
4904 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4905
4906 @item %@{@code{S}|@code{P}:@code{X}@}
4907 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.  This may be
4908 combined with @samp{!} and @samp{.} sequences as well, although they
4909 have a stronger binding than the @samp{|}.  For example a spec string
4910 like this:
4911
4912 @smallexample
4913 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4914 @end smallexample
4915
4916 will output the following command-line options from the following input
4917 command-line options:
4918
4919 @smallexample
4920 fred.c        -foo -baz
4921 jim.d         -bar -boggle
4922 -d fred.c     -foo -baz -boggle
4923 -d jim.d      -bar -baz -boggle
4924 @end smallexample
4925
4926 @end table
4927
4928 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4929 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4930 or spaces, or even newlines.  They are processed as usual, as described
4931 above.
4932
4933 The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4934 switches are handled specifically in these
4935 constructs.  If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4936 @option{-W} switch is found later in the command line, the earlier switch
4937 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4938 letter, which passes all matching options.
4939
4940 The character @samp{|} at the beginning of the predicate text is used to indicate
4941 that a command should be piped to the following command, but only if @option{-pipe}
4942 is specified.
4943
4944 It is built into GCC which switches take arguments and which do not.
4945 (You might think it would be useful to generalize this to allow each
4946 compiler's spec to say which switches take arguments.  But this cannot
4947 be done in a consistent fashion.  GCC cannot even decide which input
4948 files have been specified without knowing which switches take arguments,
4949 and it must know which input files to compile in order to tell which
4950 compilers to run).
4951
4952 GCC also knows implicitly that arguments starting in @option{-l} are to be
4953 treated as compiler output files, and passed to the linker in their
4954 proper position among the other output files.
4955
4956 @c man begin OPTIONS
4957
4958 @node Target Options
4959 @section Specifying Target Machine and Compiler Version
4960 @cindex target options
4961 @cindex cross compiling
4962 @cindex specifying machine version
4963 @cindex specifying compiler version and target machine
4964 @cindex compiler version, specifying
4965 @cindex target machine, specifying
4966
4967 The usual way to run GCC is to run the executable called @file{gcc}, or
4968 @file{<machine>-gcc} when cross-compiling, or
4969 @file{<machine>-gcc-<version>} to run a version other than the one that
4970 was installed last.  Sometimes this is inconvenient, so GCC provides
4971 options that will switch to another cross-compiler or version.
4972
4973 @table @gcctabopt
4974 @item -b @var{machine}
4975 @opindex b
4976 The argument @var{machine} specifies the target machine for compilation.
4977
4978 The value to use for @var{machine} is the same as was specified as the
4979 machine type when configuring GCC as a cross-compiler.  For
4980 example, if a cross-compiler was configured with @samp{configure
4981 i386v}, meaning to compile for an 80386 running System V, then you
4982 would specify @option{-b i386v} to run that cross compiler.
4983
4984 @item -V @var{version}
4985 @opindex V
4986 The argument @var{version} specifies which version of GCC to run.
4987 This is useful when multiple versions are installed.  For example,
4988 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4989 @end table
4990
4991 The @option{-V} and @option{-b} options work by running the
4992 @file{<machine>-gcc-<version>} executable, so there's no real reason to
4993 use them if you can just run that directly.
4994
4995 @node Submodel Options
4996 @section Hardware Models and Configurations
4997 @cindex submodel options
4998 @cindex specifying hardware config
4999 @cindex hardware models and configurations, specifying
5000 @cindex machine dependent options
5001
5002 Earlier we discussed the standard option @option{-b} which chooses among
5003 different installed compilers for completely different target
5004 machines, such as VAX vs.@: 68000 vs.@: 80386.
5005
5006 In addition, each of these target machine types can have its own
5007 special options, starting with @samp{-m}, to choose among various
5008 hardware models or configurations---for example, 68010 vs 68020,
5009 floating coprocessor or none.  A single installed version of the
5010 compiler can compile for any model or configuration, according to the
5011 options specified.
5012
5013 Some configurations of the compiler also support additional special
5014 options, usually for compatibility with other compilers on the same
5015 platform.
5016
5017 These options are defined by the macro @code{TARGET_SWITCHES} in the
5018 machine description.  The default for the options is also defined by
5019 that macro, which enables you to change the defaults.
5020
5021 @menu
5022 * M680x0 Options::
5023 * M68hc1x Options::
5024 * VAX Options::
5025 * SPARC Options::
5026 * Convex Options::
5027 * AMD29K Options::
5028 * ARM Options::
5029 * MN10200 Options::
5030 * MN10300 Options::
5031 * M32R/D Options::
5032 * M88K Options::
5033 * RS/6000 and PowerPC Options::
5034 * RT Options::
5035 * MIPS Options::
5036 * i386 and x86-64 Options::
5037 * HPPA Options::
5038 * Intel 960 Options::
5039 * DEC Alpha Options::
5040 * DEC Alpha/VMS Options::
5041 * Clipper Options::
5042 * H8/300 Options::
5043 * SH Options::
5044 * System V Options::
5045 * TMS320C3x/C4x Options::
5046 * V850 Options::
5047 * ARC Options::
5048 * NS32K Options::
5049 * AVR Options::
5050 * MCore Options::
5051 * IA-64 Options::
5052 * D30V Options::
5053 * S/390 and zSeries Options::
5054 * CRIS Options::
5055 * MMIX Options::
5056 * PDP-11 Options::
5057 * Xstormy16 Options::
5058 * Xtensa Options::
5059 @end menu
5060
5061 @node M680x0 Options
5062 @subsection M680x0 Options
5063 @cindex M680x0 options
5064
5065 These are the @samp{-m} options defined for the 68000 series.  The default
5066 values for these options depends on which style of 68000 was selected when
5067 the compiler was configured; the defaults for the most common choices are
5068 given below.
5069
5070 @table @gcctabopt
5071 @item -m68000
5072 @itemx -mc68000
5073 @opindex m68000
5074 @opindex mc68000
5075 Generate output for a 68000.  This is the default
5076 when the compiler is configured for 68000-based systems.
5077
5078 Use this option for microcontrollers with a 68000 or EC000 core,
5079 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5080
5081 @item -m68020
5082 @itemx -mc68020
5083 @opindex m68020
5084 @opindex mc68020
5085 Generate output for a 68020.  This is the default
5086 when the compiler is configured for 68020-based systems.
5087
5088 @item -m68881
5089 @opindex m68881
5090 Generate output containing 68881 instructions for floating point.
5091 This is the default for most 68020 systems unless @option{--nfp} was
5092 specified when the compiler was configured.
5093
5094 @item -m68030
5095 @opindex m68030
5096 Generate output for a 68030.  This is the default when the compiler is
5097 configured for 68030-based systems.
5098
5099 @item -m68040
5100 @opindex m68040
5101 Generate output for a 68040.  This is the default when the compiler is
5102 configured for 68040-based systems.
5103
5104 This option inhibits the use of 68881/68882 instructions that have to be
5105 emulated by software on the 68040.  Use this option if your 68040 does not
5106 have code to emulate those instructions.
5107
5108 @item -m68060
5109 @opindex m68060
5110 Generate output for a 68060.  This is the default when the compiler is
5111 configured for 68060-based systems.
5112
5113 This option inhibits the use of 68020 and 68881/68882 instructions that
5114 have to be emulated by software on the 68060.  Use this option if your 68060
5115 does not have code to emulate those instructions.
5116
5117 @item -mcpu32
5118 @opindex mcpu32
5119 Generate output for a CPU32.  This is the default
5120 when the compiler is configured for CPU32-based systems.
5121
5122 Use this option for microcontrollers with a
5123 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5124 68336, 68340, 68341, 68349 and 68360.
5125
5126 @item -m5200
5127 @opindex m5200
5128 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5129 when the compiler is configured for 520X-based systems.
5130
5131 Use this option for microcontroller with a 5200 core, including
5132 the MCF5202, MCF5203, MCF5204 and MCF5202.
5133
5134
5135 @item -m68020-40
5136 @opindex m68020-40
5137 Generate output for a 68040, without using any of the new instructions.
5138 This results in code which can run relatively efficiently on either a
5139 68020/68881 or a 68030 or a 68040.  The generated code does use the
5140 68881 instructions that are emulated on the 68040.
5141
5142 @item -m68020-60
5143 @opindex m68020-60
5144 Generate output for a 68060, without using any of the new instructions.
5145 This results in code which can run relatively efficiently on either a
5146 68020/68881 or a 68030 or a 68040.  The generated code does use the
5147 68881 instructions that are emulated on the 68060.
5148
5149 @item -mfpa
5150 @opindex mfpa
5151 Generate output containing Sun FPA instructions for floating point.
5152
5153 @item -msoft-float
5154 @opindex msoft-float
5155 Generate output containing library calls for floating point.
5156 @strong{Warning:} the requisite libraries are not available for all m68k
5157 targets.  Normally the facilities of the machine's usual C compiler are
5158 used, but this can't be done directly in cross-compilation.  You must
5159 make your own arrangements to provide suitable library functions for
5160 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5161 @samp{m68k-*-coff} do provide software floating point support.
5162
5163 @item -mshort
5164 @opindex mshort
5165 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5166
5167 @item -mnobitfield
5168 @opindex mnobitfield
5169 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5170 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5171
5172 @item -mbitfield
5173 @opindex mbitfield
5174 Do use the bit-field instructions.  The @option{-m68020} option implies
5175 @option{-mbitfield}.  This is the default if you use a configuration
5176 designed for a 68020.
5177
5178 @item -mrtd
5179 @opindex mrtd
5180 Use a different function-calling convention, in which functions
5181 that take a fixed number of arguments return with the @code{rtd}
5182 instruction, which pops their arguments while returning.  This
5183 saves one instruction in the caller since there is no need to pop
5184 the arguments there.
5185
5186 This calling convention is incompatible with the one normally
5187 used on Unix, so you cannot use it if you need to call libraries
5188 compiled with the Unix compiler.
5189
5190 Also, you must provide function prototypes for all functions that
5191 take variable numbers of arguments (including @code{printf});
5192 otherwise incorrect code will be generated for calls to those
5193 functions.
5194
5195 In addition, seriously incorrect code will result if you call a
5196 function with too many arguments.  (Normally, extra arguments are
5197 harmlessly ignored.)
5198
5199 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5200 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5201
5202 @item -malign-int
5203 @itemx -mno-align-int
5204 @opindex malign-int
5205 @opindex mno-align-int
5206 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5207 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5208 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5209 Aligning variables on 32-bit boundaries produces code that runs somewhat
5210 faster on processors with 32-bit busses at the expense of more memory.
5211
5212 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5213 align structures containing the above types  differently than
5214 most published application binary interface specifications for the m68k.
5215
5216 @item -mpcrel
5217 @opindex mpcrel
5218 Use the pc-relative addressing mode of the 68000 directly, instead of
5219 using a global offset table.  At present, this option implies @option{-fpic},
5220 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5221 not presently supported with @option{-mpcrel}, though this could be supported for
5222 68020 and higher processors.
5223
5224 @item -mno-strict-align
5225 @itemx -mstrict-align
5226 @opindex mno-strict-align
5227 @opindex mstrict-align
5228 Do not (do) assume that unaligned memory references will be handled by
5229 the system.
5230
5231 @end table
5232
5233 @node M68hc1x Options
5234 @subsection M68hc1x Options
5235 @cindex M68hc1x options
5236
5237 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5238 microcontrollers.  The default values for these options depends on
5239 which style of microcontroller was selected when the compiler was configured;
5240 the defaults for the most common choices are given below.
5241
5242 @table @gcctabopt
5243 @item -m6811
5244 @itemx -m68hc11
5245 @opindex m6811
5246 @opindex m68hc11
5247 Generate output for a 68HC11.  This is the default
5248 when the compiler is configured for 68HC11-based systems.
5249
5250 @item -m6812
5251 @itemx -m68hc12
5252 @opindex m6812
5253 @opindex m68hc12
5254 Generate output for a 68HC12.  This is the default
5255 when the compiler is configured for 68HC12-based systems.
5256
5257 @item -mauto-incdec
5258 @opindex mauto-incdec
5259 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5260 addressing modes.
5261
5262 @item -minmax
5263 @itemx -nominmax
5264 @opindex minmax
5265 @opindex mnominmax
5266 Enable the use of 68HC12 min and max instructions.
5267
5268 @item -mlong-calls
5269 @itemx -mno-long-calls
5270 @opindex mlong-calls
5271 @opindex mno-long-calls
5272 Treat all calls as being far away (near).  If calls are assumed to be
5273 far away, the compiler will use the @code{call} instruction to
5274 call a function and the @code{rtc} instruction for returning.
5275
5276 @item -mshort
5277 @opindex mshort
5278 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5279
5280 @item -msoft-reg-count=@var{count}
5281 @opindex msoft-reg-count
5282 Specify the number of pseudo-soft registers which are used for the
5283 code generation.  The maximum number is 32.  Using more pseudo-soft
5284 register may or may not result in better code depending on the program.
5285 The default is 4 for 68HC11 and 2 for 68HC12.
5286
5287 @end table
5288
5289 @node VAX Options
5290 @subsection VAX Options
5291 @cindex VAX options
5292
5293 These @samp{-m} options are defined for the VAX:
5294
5295 @table @gcctabopt
5296 @item -munix
5297 @opindex munix
5298 Do not output certain jump instructions (@code{aobleq} and so on)
5299 that the Unix assembler for the VAX cannot handle across long
5300 ranges.
5301
5302 @item -mgnu
5303 @opindex mgnu
5304 Do output those jump instructions, on the assumption that you
5305 will assemble with the GNU assembler.
5306
5307 @item -mg
5308 @opindex mg
5309 Output code for g-format floating point numbers instead of d-format.
5310 @end table
5311
5312 @node SPARC Options
5313 @subsection SPARC Options
5314 @cindex SPARC options
5315
5316 These @samp{-m} switches are supported on the SPARC:
5317
5318 @table @gcctabopt
5319 @item -mno-app-regs
5320 @itemx -mapp-regs
5321 @opindex mno-app-regs
5322 @opindex mapp-regs
5323 Specify @option{-mapp-regs} to generate output using the global registers
5324 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5325 is the default.
5326
5327 To be fully SVR4 ABI compliant at the cost of some performance loss,
5328 specify @option{-mno-app-regs}.  You should compile libraries and system
5329 software with this option.
5330
5331 @item -mfpu
5332 @itemx -mhard-float
5333 @opindex mfpu
5334 @opindex mhard-float
5335 Generate output containing floating point instructions.  This is the
5336 default.
5337
5338 @item -mno-fpu
5339 @itemx -msoft-float
5340 @opindex mno-fpu
5341 @opindex msoft-float
5342 Generate output containing library calls for floating point.
5343 @strong{Warning:} the requisite libraries are not available for all SPARC
5344 targets.  Normally the facilities of the machine's usual C compiler are
5345 used, but this cannot be done directly in cross-compilation.  You must make
5346 your own arrangements to provide suitable library functions for
5347 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5348 @samp{sparclite-*-*} do provide software floating point support.
5349
5350 @option{-msoft-float} changes the calling convention in the output file;
5351 therefore, it is only useful if you compile @emph{all} of a program with
5352 this option.  In particular, you need to compile @file{libgcc.a}, the
5353 library that comes with GCC, with @option{-msoft-float} in order for
5354 this to work.
5355
5356 @item -mhard-quad-float
5357 @opindex mhard-quad-float
5358 Generate output containing quad-word (long double) floating point
5359 instructions.
5360
5361 @item -msoft-quad-float
5362 @opindex msoft-quad-float
5363 Generate output containing library calls for quad-word (long double)
5364 floating point instructions.  The functions called are those specified
5365 in the SPARC ABI@.  This is the default.
5366
5367 As of this writing, there are no sparc implementations that have hardware
5368 support for the quad-word floating point instructions.  They all invoke
5369 a trap handler for one of these instructions, and then the trap handler
5370 emulates the effect of the instruction.  Because of the trap handler overhead,
5371 this is much slower than calling the ABI library routines.  Thus the
5372 @option{-msoft-quad-float} option is the default.
5373
5374 @item -mno-flat
5375 @itemx -mflat
5376 @opindex mno-flat
5377 @opindex mflat
5378 With @option{-mflat}, the compiler does not generate save/restore instructions
5379 and will use a ``flat'' or single register window calling convention.
5380 This model uses %i7 as the frame pointer and is compatible with the normal
5381 register window model.  Code from either may be intermixed.
5382 The local registers and the input registers (0--5) are still treated as
5383 ``call saved'' registers and will be saved on the stack as necessary.
5384
5385 With @option{-mno-flat} (the default), the compiler emits save/restore
5386 instructions (except for leaf functions) and is the normal mode of operation.
5387
5388 @item -mno-unaligned-doubles
5389 @itemx -munaligned-doubles
5390 @opindex mno-unaligned-doubles
5391 @opindex munaligned-doubles
5392 Assume that doubles have 8 byte alignment.  This is the default.
5393
5394 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5395 alignment only if they are contained in another type, or if they have an
5396 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5397 Specifying this option avoids some rare compatibility problems with code
5398 generated by other compilers.  It is not the default because it results
5399 in a performance loss, especially for floating point code.
5400
5401 @item -mno-faster-structs
5402 @itemx -mfaster-structs
5403 @opindex mno-faster-structs
5404 @opindex mfaster-structs
5405 With @option{-mfaster-structs}, the compiler assumes that structures
5406 should have 8 byte alignment.  This enables the use of pairs of
5407 @code{ldd} and @code{std} instructions for copies in structure
5408 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5409 However, the use of this changed alignment directly violates the SPARC
5410 ABI@.  Thus, it's intended only for use on targets where the developer
5411 acknowledges that their resulting code will not be directly in line with
5412 the rules of the ABI@.
5413
5414 @item -mv8
5415 @itemx -msparclite
5416 @opindex mv8
5417 @opindex msparclite
5418 These two options select variations on the SPARC architecture.
5419
5420 By default (unless specifically configured for the Fujitsu SPARClite),
5421 GCC generates code for the v7 variant of the SPARC architecture.
5422
5423 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5424 code is that the compiler emits the integer multiply and integer
5425 divide instructions which exist in SPARC v8 but not in SPARC v7.
5426
5427 @option{-msparclite} will give you SPARClite code.  This adds the integer
5428 multiply, integer divide step and scan (@code{ffs}) instructions which
5429 exist in SPARClite but not in SPARC v7.
5430
5431 These options are deprecated and will be deleted in a future GCC release.
5432 They have been replaced with @option{-mcpu=xxx}.
5433
5434 @item -mcypress
5435 @itemx -msupersparc
5436 @opindex mcypress
5437 @opindex msupersparc
5438 These two options select the processor for which the code is optimized.
5439
5440 With @option{-mcypress} (the default), the compiler optimizes code for the
5441 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5442 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5443
5444 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5445 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5446 of the full SPARC v8 instruction set.
5447
5448 These options are deprecated and will be deleted in a future GCC release.
5449 They have been replaced with @option{-mcpu=xxx}.
5450
5451 @item -mcpu=@var{cpu_type}
5452 @opindex mcpu
5453 Set the instruction set, register set, and instruction scheduling parameters
5454 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5455 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5456 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5457 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
5458
5459 Default instruction scheduling parameters are used for values that select
5460 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5461 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5462
5463 Here is a list of each supported architecture and their supported
5464 implementations.
5465
5466 @smallexample
5467     v7:             cypress
5468     v8:             supersparc, hypersparc
5469     sparclite:      f930, f934, sparclite86x
5470     sparclet:       tsc701
5471     v9:             ultrasparc
5472 @end smallexample
5473
5474 @item -mtune=@var{cpu_type}
5475 @opindex mtune
5476 Set the instruction scheduling parameters for machine type
5477 @var{cpu_type}, but do not set the instruction set or register set that the
5478 option @option{-mcpu=@var{cpu_type}} would.
5479
5480 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5481 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5482 that select a particular cpu implementation.  Those are @samp{cypress},
5483 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5484 @samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
5485
5486 @end table
5487
5488 These @samp{-m} switches are supported in addition to the above
5489 on the SPARCLET processor.
5490
5491 @table @gcctabopt
5492 @item -mlittle-endian
5493 @opindex mlittle-endian
5494 Generate code for a processor running in little-endian mode.
5495
5496 @item -mlive-g0
5497 @opindex mlive-g0
5498 Treat register @code{%g0} as a normal register.
5499 GCC will continue to clobber it as necessary but will not assume
5500 it always reads as 0.
5501
5502 @item -mbroken-saverestore
5503 @opindex mbroken-saverestore
5504 Generate code that does not use non-trivial forms of the @code{save} and
5505 @code{restore} instructions.  Early versions of the SPARCLET processor do
5506 not correctly handle @code{save} and @code{restore} instructions used with
5507 arguments.  They correctly handle them used without arguments.  A @code{save}
5508 instruction used without arguments increments the current window pointer
5509 but does not allocate a new stack frame.  It is assumed that the window
5510 overflow trap handler will properly handle this case as will interrupt
5511 handlers.
5512 @end table
5513
5514 These @samp{-m} switches are supported in addition to the above
5515 on SPARC V9 processors in 64-bit environments.
5516
5517 @table @gcctabopt
5518 @item -mlittle-endian
5519 @opindex mlittle-endian
5520 Generate code for a processor running in little-endian mode.
5521
5522 @item -m32
5523 @itemx -m64
5524 @opindex m32
5525 @opindex m64
5526 Generate code for a 32-bit or 64-bit environment.
5527 The 32-bit environment sets int, long and pointer to 32 bits.
5528 The 64-bit environment sets int to 32 bits and long and pointer
5529 to 64 bits.
5530
5531 @item -mcmodel=medlow
5532 @opindex mcmodel=medlow
5533 Generate code for the Medium/Low code model: the program must be linked
5534 in the low 32 bits of the address space.  Pointers are 64 bits.
5535 Programs can be statically or dynamically linked.
5536
5537 @item -mcmodel=medmid
5538 @opindex mcmodel=medmid
5539 Generate code for the Medium/Middle code model: the program must be linked
5540 in the low 44 bits of the address space, the text segment must be less than
5541 2G bytes, and data segment must be within 2G of the text segment.
5542 Pointers are 64 bits.
5543
5544 @item -mcmodel=medany
5545 @opindex mcmodel=medany
5546 Generate code for the Medium/Anywhere code model: the program may be linked
5547 anywhere in the address space, the text segment must be less than
5548 2G bytes, and data segment must be within 2G of the text segment.
5549 Pointers are 64 bits.
5550
5551 @item -mcmodel=embmedany
5552 @opindex mcmodel=embmedany
5553 Generate code for the Medium/Anywhere code model for embedded systems:
5554 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5555 (determined at link time).  Register %g4 points to the base of the
5556 data segment.  Pointers are still 64 bits.
5557 Programs are statically linked, PIC is not supported.
5558
5559 @item -mstack-bias
5560 @itemx -mno-stack-bias
5561 @opindex mstack-bias
5562 @opindex mno-stack-bias
5563 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5564 frame pointer if present, are offset by @minus{}2047 which must be added back
5565 when making stack frame references.
5566 Otherwise, assume no such offset is present.
5567 @end table
5568
5569 @node Convex Options
5570 @subsection Convex Options
5571 @cindex Convex options
5572
5573 These @samp{-m} options are defined for Convex:
5574
5575 @table @gcctabopt
5576 @item -mc1
5577 @opindex mc1
5578 Generate output for C1.  The code will run on any Convex machine.
5579 The preprocessor symbol @code{__convex__c1__} is defined.
5580
5581 @item -mc2
5582 @opindex mc2
5583 Generate output for C2.  Uses instructions not available on C1.
5584 Scheduling and other optimizations are chosen for max performance on C2.
5585 The preprocessor symbol @code{__convex_c2__} is defined.
5586
5587 @item -mc32
5588 @opindex mc32
5589 Generate output for C32xx.  Uses instructions not available on C1.
5590 Scheduling and other optimizations are chosen for max performance on C32.
5591 The preprocessor symbol @code{__convex_c32__} is defined.
5592
5593 @item -mc34
5594 @opindex mc34
5595 Generate output for C34xx.  Uses instructions not available on C1.
5596 Scheduling and other optimizations are chosen for max performance on C34.
5597 The preprocessor symbol @code{__convex_c34__} is defined.
5598
5599 @item -mc38
5600 @opindex mc38
5601 Generate output for C38xx.  Uses instructions not available on C1.
5602 Scheduling and other optimizations are chosen for max performance on C38.
5603 The preprocessor symbol @code{__convex_c38__} is defined.
5604
5605 @item -margcount
5606 @opindex margcount
5607 Generate code which puts an argument count in the word preceding each
5608 argument list.  This is compatible with regular CC, and a few programs
5609 may need the argument count word.  GDB and other source-level debuggers
5610 do not need it; this info is in the symbol table.
5611
5612 @item -mnoargcount
5613 @opindex mnoargcount
5614 Omit the argument count word.  This is the default.
5615
5616 @item -mvolatile-cache
5617 @opindex mvolatile-cache
5618 Allow volatile references to be cached.  This is the default.
5619
5620 @item -mvolatile-nocache
5621 @opindex mvolatile-nocache
5622 Volatile references bypass the data cache, going all the way to memory.
5623 This is only needed for multi-processor code that does not use standard
5624 synchronization instructions.  Making non-volatile references to volatile
5625 locations will not necessarily work.
5626
5627 @item -mlong32
5628 @opindex mlong32
5629 Type long is 32 bits, the same as type int.  This is the default.
5630
5631 @item -mlong64
5632 @opindex mlong64
5633 Type long is 64 bits, the same as type long long.  This option is useless,
5634 because no library support exists for it.
5635 @end table
5636
5637 @node AMD29K Options
5638 @subsection AMD29K Options
5639 @cindex AMD29K options
5640
5641 These @samp{-m} options are defined for the AMD Am29000:
5642
5643 @table @gcctabopt
5644 @item -mdw
5645 @opindex mdw
5646 @cindex DW bit (29k)
5647 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5648 halfword operations are directly supported by the hardware.  This is the
5649 default.
5650
5651 @item -mndw
5652 @opindex mndw
5653 Generate code that assumes the @code{DW} bit is not set.
5654
5655 @item -mbw
5656 @opindex mbw
5657 @cindex byte writes (29k)
5658 Generate code that assumes the system supports byte and halfword write
5659 operations.  This is the default.
5660
5661 @item -mnbw
5662 @opindex mnbw
5663 Generate code that assumes the systems does not support byte and
5664 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5665
5666 @item -msmall
5667 @opindex msmall
5668 @cindex memory model (29k)
5669 Use a small memory model that assumes that all function addresses are
5670 either within a single 256 KB segment or at an absolute address of less
5671 than 256k.  This allows the @code{call} instruction to be used instead
5672 of a @code{const}, @code{consth}, @code{calli} sequence.
5673
5674 @item -mnormal
5675 @opindex mnormal
5676 Use the normal memory model: Generate @code{call} instructions only when
5677 calling functions in the same file and @code{calli} instructions
5678 otherwise.  This works if each file occupies less than 256 KB but allows
5679 the entire executable to be larger than 256 KB@.  This is the default.
5680
5681 @item -mlarge
5682 @opindex mlarge
5683 Always use @code{calli} instructions.  Specify this option if you expect
5684 a single file to compile into more than 256 KB of code.
5685
5686 @item -m29050
5687 @opindex m29050
5688 @cindex processor selection (29k)
5689 Generate code for the Am29050.
5690
5691 @item -m29000
5692 @opindex m29000
5693 Generate code for the Am29000.  This is the default.
5694
5695 @item -mkernel-registers
5696 @opindex mkernel-registers
5697 @cindex kernel and user registers (29k)
5698 Generate references to registers @code{gr64-gr95} instead of to
5699 registers @code{gr96-gr127}.  This option can be used when compiling
5700 kernel code that wants a set of global registers disjoint from that used
5701 by user-mode code.
5702
5703 Note that when this option is used, register names in @samp{-f} flags
5704 must use the normal, user-mode, names.
5705
5706 @item -muser-registers
5707 @opindex muser-registers
5708 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5709 default.
5710
5711 @item -mstack-check
5712 @itemx -mno-stack-check
5713 @opindex mstack-check
5714 @opindex mno-stack-check
5715 @cindex stack checks (29k)
5716 Insert (or do not insert) a call to @code{__msp_check} after each stack
5717 adjustment.  This is often used for kernel code.
5718
5719 @item -mstorem-bug
5720 @itemx -mno-storem-bug
5721 @opindex mstorem-bug
5722 @opindex mno-storem-bug
5723 @cindex storem bug (29k)
5724 @option{-mstorem-bug} handles 29k processors which cannot handle the
5725 separation of a mtsrim insn and a storem instruction (most 29000 chips
5726 to date, but not the 29050).
5727
5728 @item -mno-reuse-arg-regs
5729 @itemx -mreuse-arg-regs
5730 @opindex mno-reuse-arg-regs
5731 @opindex mreuse-arg-regs
5732 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5733 registers for copying out arguments.  This helps detect calling a function
5734 with fewer arguments than it was declared with.
5735
5736 @item -mno-impure-text
5737 @itemx -mimpure-text
5738 @opindex mno-impure-text
5739 @opindex mimpure-text
5740 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5741 not pass @option{-assert pure-text} to the linker when linking a shared object.
5742
5743 @item -msoft-float
5744 @opindex msoft-float
5745 Generate output containing library calls for floating point.
5746 @strong{Warning:} the requisite libraries are not part of GCC@.
5747 Normally the facilities of the machine's usual C compiler are used, but
5748 this can't be done directly in cross-compilation.  You must make your
5749 own arrangements to provide suitable library functions for
5750 cross-compilation.
5751
5752 @item -mno-multm
5753 @opindex mno-multm
5754 Do not generate multm or multmu instructions.  This is useful for some embedded
5755 systems which do not have trap handlers for these instructions.
5756 @end table
5757
5758 @node ARM Options
5759 @subsection ARM Options
5760 @cindex ARM options
5761
5762 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5763 architectures:
5764
5765 @table @gcctabopt
5766 @item -mapcs-frame
5767 @opindex mapcs-frame
5768 Generate a stack frame that is compliant with the ARM Procedure Call
5769 Standard for all functions, even if this is not strictly necessary for
5770 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5771 with this option will cause the stack frames not to be generated for
5772 leaf functions.  The default is @option{-mno-apcs-frame}.
5773
5774 @item -mapcs
5775 @opindex mapcs
5776 This is a synonym for @option{-mapcs-frame}.
5777
5778 @item -mapcs-26
5779 @opindex mapcs-26
5780 Generate code for a processor running with a 26-bit program counter,
5781 and conforming to the function calling standards for the APCS 26-bit
5782 option.  This option replaces the @option{-m2} and @option{-m3} options
5783 of previous releases of the compiler.
5784
5785 @item -mapcs-32
5786 @opindex mapcs-32
5787 Generate code for a processor running with a 32-bit program counter,
5788 and conforming to the function calling standards for the APCS 32-bit
5789 option.  This option replaces the @option{-m6} option of previous releases
5790 of the compiler.
5791
5792 @ignore
5793 @c not currently implemented
5794 @item -mapcs-stack-check
5795 @opindex mapcs-stack-check
5796 Generate code to check the amount of stack space available upon entry to
5797 every function (that actually uses some stack space).  If there is
5798 insufficient space available then either the function
5799 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5800 called, depending upon the amount of stack space required.  The run time
5801 system is required to provide these functions.  The default is
5802 @option{-mno-apcs-stack-check}, since this produces smaller code.
5803
5804 @c not currently implemented
5805 @item -mapcs-float
5806 @opindex mapcs-float
5807 Pass floating point arguments using the float point registers.  This is
5808 one of the variants of the APCS@.  This option is recommended if the
5809 target hardware has a floating point unit or if a lot of floating point
5810 arithmetic is going to be performed by the code.  The default is
5811 @option{-mno-apcs-float}, since integer only code is slightly increased in
5812 size if @option{-mapcs-float} is used.
5813
5814 @c not currently implemented
5815 @item -mapcs-reentrant
5816 @opindex mapcs-reentrant
5817 Generate reentrant, position independent code.  The default is
5818 @option{-mno-apcs-reentrant}.
5819 @end ignore
5820
5821 @item -mthumb-interwork
5822 @opindex mthumb-interwork
5823 Generate code which supports calling between the ARM and Thumb
5824 instruction sets.  Without this option the two instruction sets cannot
5825 be reliably used inside one program.  The default is
5826 @option{-mno-thumb-interwork}, since slightly larger code is generated
5827 when @option{-mthumb-interwork} is specified.
5828
5829 @item -mno-sched-prolog
5830 @opindex mno-sched-prolog
5831 Prevent the reordering of instructions in the function prolog, or the
5832 merging of those instruction with the instructions in the function's
5833 body.  This means that all functions will start with a recognizable set
5834 of instructions (or in fact one of a choice from a small set of
5835 different function prologues), and this information can be used to
5836 locate the start if functions inside an executable piece of code.  The
5837 default is @option{-msched-prolog}.
5838
5839 @item -mhard-float
5840 @opindex mhard-float
5841 Generate output containing floating point instructions.  This is the
5842 default.
5843
5844 @item -msoft-float
5845 @opindex msoft-float
5846 Generate output containing library calls for floating point.
5847 @strong{Warning:} the requisite libraries are not available for all ARM
5848 targets.  Normally the facilities of the machine's usual C compiler are
5849 used, but this cannot be done directly in cross-compilation.  You must make
5850 your own arrangements to provide suitable library functions for
5851 cross-compilation.
5852
5853 @option{-msoft-float} changes the calling convention in the output file;
5854 therefore, it is only useful if you compile @emph{all} of a program with
5855 this option.  In particular, you need to compile @file{libgcc.a}, the
5856 library that comes with GCC, with @option{-msoft-float} in order for
5857 this to work.
5858
5859 @item -mlittle-endian
5860 @opindex mlittle-endian
5861 Generate code for a processor running in little-endian mode.  This is
5862 the default for all standard configurations.
5863
5864 @item -mbig-endian
5865 @opindex mbig-endian
5866 Generate code for a processor running in big-endian mode; the default is
5867 to compile code for a little-endian processor.
5868
5869 @item -mwords-little-endian
5870 @opindex mwords-little-endian
5871 This option only applies when generating code for big-endian processors.
5872 Generate code for a little-endian word order but a big-endian byte
5873 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5874 option should only be used if you require compatibility with code for
5875 big-endian ARM processors generated by versions of the compiler prior to
5876 2.8.
5877
5878 @item -malignment-traps
5879 @opindex malignment-traps
5880 Generate code that will not trap if the MMU has alignment traps enabled.
5881 On ARM architectures prior to ARMv4, there were no instructions to
5882 access half-word objects stored in memory.  However, when reading from
5883 memory a feature of the ARM architecture allows a word load to be used,
5884 even if the address is unaligned, and the processor core will rotate the
5885 data as it is being loaded.  This option tells the compiler that such
5886 misaligned accesses will cause a MMU trap and that it should instead
5887 synthesize the access as a series of byte accesses.  The compiler can
5888 still use word accesses to load half-word data if it knows that the
5889 address is aligned to a word boundary.
5890
5891 This option is ignored when compiling for ARM architecture 4 or later,
5892 since these processors have instructions to directly access half-word
5893 objects in memory.
5894
5895 @item -mno-alignment-traps
5896 @opindex mno-alignment-traps
5897 Generate code that assumes that the MMU will not trap unaligned
5898 accesses.  This produces better code when the target instruction set
5899 does not have half-word memory operations (i.e.@: implementations prior to
5900 ARMv4).
5901
5902 Note that you cannot use this option to access unaligned word objects,
5903 since the processor will only fetch one 32-bit aligned object from
5904 memory.
5905
5906 The default setting for most targets is @option{-mno-alignment-traps}, since
5907 this produces better code when there are no half-word memory
5908 instructions available.
5909
5910 @item -mshort-load-bytes
5911 @itemx -mno-short-load-words
5912 @opindex mshort-load-bytes
5913 @opindex mno-short-load-words
5914 These are deprecated aliases for @option{-malignment-traps}.
5915
5916 @item -mno-short-load-bytes
5917 @itemx -mshort-load-words
5918 @opindex mno-short-load-bytes
5919 @opindex mshort-load-words
5920 This are deprecated aliases for @option{-mno-alignment-traps}.
5921
5922 @item -mbsd
5923 @opindex mbsd
5924 This option only applies to RISC iX@.  Emulate the native BSD-mode
5925 compiler.  This is the default if @option{-ansi} is not specified.
5926
5927 @item -mxopen
5928 @opindex mxopen
5929 This option only applies to RISC iX@.  Emulate the native X/Open-mode
5930 compiler.
5931
5932 @item -mno-symrename
5933 @opindex mno-symrename
5934 This option only applies to RISC iX@.  Do not run the assembler
5935 post-processor, @samp{symrename}, after code has been assembled.
5936 Normally it is necessary to modify some of the standard symbols in
5937 preparation for linking with the RISC iX C library; this option
5938 suppresses this pass.  The post-processor is never run when the
5939 compiler is built for cross-compilation.
5940
5941 @item -mcpu=@var{name}
5942 @opindex mcpu
5943 This specifies the name of the target ARM processor.  GCC uses this name
5944 to determine what kind of instructions it can emit when generating
5945 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
5946 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
5947 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
5948 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
5949 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
5950 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
5951 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
5952 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
5953 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
5954 @samp{arm1020t}, @samp{xscale}.
5955
5956 @itemx -mtune=@var{name}
5957 @opindex mtune
5958 This option is very similar to the @option{-mcpu=} option, except that
5959 instead of specifying the actual target processor type, and hence
5960 restricting which instructions can be used, it specifies that GCC should
5961 tune the performance of the code as if the target were of the type
5962 specified in this option, but still choosing the instructions that it
5963 will generate based on the cpu specified by a @option{-mcpu=} option.
5964 For some ARM implementations better performance can be obtained by using
5965 this option.
5966
5967 @item -march=@var{name}
5968 @opindex march
5969 This specifies the name of the target ARM architecture.  GCC uses this
5970 name to determine what kind of instructions it can emit when generating
5971 assembly code.  This option can be used in conjunction with or instead
5972 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
5973 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
5974 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
5975
5976 @item -mfpe=@var{number}
5977 @itemx -mfp=@var{number}
5978 @opindex mfpe
5979 @opindex mfp
5980 This specifies the version of the floating point emulation available on
5981 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
5982 for @option{-mfpe=}, for compatibility with older versions of GCC@.
5983
5984 @item -mstructure-size-boundary=@var{n}
5985 @opindex mstructure-size-boundary
5986 The size of all structures and unions will be rounded up to a multiple
5987 of the number of bits set by this option.  Permissible values are 8 and
5988 32.  The default value varies for different toolchains.  For the COFF
5989 targeted toolchain the default value is 8.  Specifying the larger number
5990 can produce faster, more efficient code, but can also increase the size
5991 of the program.  The two values are potentially incompatible.  Code
5992 compiled with one value cannot necessarily expect to work with code or
5993 libraries compiled with the other value, if they exchange information
5994 using structures or unions.
5995
5996 @item -mabort-on-noreturn
5997 @opindex mabort-on-noreturn
5998 Generate a call to the function @code{abort} at the end of a
5999 @code{noreturn} function.  It will be executed if the function tries to
6000 return.
6001
6002 @item -mlong-calls
6003 @itemx -mno-long-calls
6004 @opindex mlong-calls
6005 @opindex mno-long-calls
6006 Tells the compiler to perform function calls by first loading the
6007 address of the function into a register and then performing a subroutine
6008 call on this register.  This switch is needed if the target function
6009 will lie outside of the 64 megabyte addressing range of the offset based
6010 version of subroutine call instruction.
6011
6012 Even if this switch is enabled, not all function calls will be turned
6013 into long calls.  The heuristic is that static functions, functions
6014 which have the @samp{short-call} attribute, functions that are inside
6015 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6016 definitions have already been compiled within the current compilation
6017 unit, will not be turned into long calls.  The exception to this rule is
6018 that weak function definitions, functions with the @samp{long-call}
6019 attribute or the @samp{section} attribute, and functions that are within
6020 the scope of a @samp{#pragma long_calls} directive, will always be
6021 turned into long calls.
6022
6023 This feature is not enabled by default.  Specifying
6024 @option{-mno-long-calls} will restore the default behavior, as will
6025 placing the function calls within the scope of a @samp{#pragma
6026 long_calls_off} directive.  Note these switches have no effect on how
6027 the compiler generates code to handle function calls via function
6028 pointers.
6029
6030 @item -mnop-fun-dllimport
6031 @opindex mnop-fun-dllimport
6032 Disable support for the @code{dllimport} attribute.
6033
6034 @item -msingle-pic-base
6035 @opindex msingle-pic-base
6036 Treat the register used for PIC addressing as read-only, rather than
6037 loading it in the prologue for each function.  The run-time system is
6038 responsible for initializing this register with an appropriate value
6039 before execution begins.
6040
6041 @item -mpic-register=@var{reg}
6042 @opindex mpic-register
6043 Specify the register to be used for PIC addressing.  The default is R10
6044 unless stack-checking is enabled, when R9 is used.
6045
6046 @item -mpoke-function-name
6047 @opindex mpoke-function-name
6048 Write the name of each function into the text section, directly
6049 preceding the function prologue.  The generated code is similar to this:
6050
6051 @smallexample
6052      t0
6053          .ascii "arm_poke_function_name", 0
6054          .align
6055      t1
6056          .word 0xff000000 + (t1 - t0)
6057      arm_poke_function_name
6058          mov     ip, sp
6059          stmfd   sp!, @{fp, ip, lr, pc@}
6060          sub     fp, ip, #4
6061 @end smallexample
6062
6063 When performing a stack backtrace, code can inspect the value of
6064 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6065 location @code{pc - 12} and the top 8 bits are set, then we know that
6066 there is a function name embedded immediately preceding this location
6067 and has length @code{((pc[-3]) & 0xff000000)}.
6068
6069 @item -mthumb
6070 @opindex mthumb
6071 Generate code for the 16-bit Thumb instruction set.  The default is to
6072 use the 32-bit ARM instruction set.
6073
6074 @item -mtpcs-frame
6075 @opindex mtpcs-frame
6076 Generate a stack frame that is compliant with the Thumb Procedure Call
6077 Standard for all non-leaf functions.  (A leaf function is one that does
6078 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6079
6080 @item -mtpcs-leaf-frame
6081 @opindex mtpcs-leaf-frame
6082 Generate a stack frame that is compliant with the Thumb Procedure Call
6083 Standard for all leaf functions.  (A leaf function is one that does
6084 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6085
6086 @item -mcallee-super-interworking
6087 @opindex mcallee-super-interworking
6088 Gives all externally visible functions in the file being compiled an ARM
6089 instruction set header which switches to Thumb mode before executing the
6090 rest of the function.  This allows these functions to be called from
6091 non-interworking code.
6092
6093 @item -mcaller-super-interworking
6094 @opindex mcaller-super-interworking
6095 Allows calls via function pointers (including virtual functions) to
6096 execute correctly regardless of whether the target code has been
6097 compiled for interworking or not.  There is a small overhead in the cost
6098 of executing a function pointer if this option is enabled.
6099
6100 @end table
6101
6102 @node MN10200 Options
6103 @subsection MN10200 Options
6104 @cindex MN10200 options
6105 These @option{-m} options are defined for Matsushita MN10200 architectures:
6106 @table @gcctabopt
6107
6108 @item -mrelax
6109 @opindex mrelax
6110 Indicate to the linker that it should perform a relaxation optimization pass
6111 to shorten branches, calls and absolute memory addresses.  This option only
6112 has an effect when used on the command line for the final link step.
6113
6114 This option makes symbolic debugging impossible.
6115 @end table
6116
6117 @node MN10300 Options
6118 @subsection MN10300 Options
6119 @cindex MN10300 options
6120 These @option{-m} options are defined for Matsushita MN10300 architectures:
6121
6122 @table @gcctabopt
6123 @item -mmult-bug
6124 @opindex mmult-bug
6125 Generate code to avoid bugs in the multiply instructions for the MN10300
6126 processors.  This is the default.
6127
6128 @item -mno-mult-bug
6129 @opindex mno-mult-bug
6130 Do not generate code to avoid bugs in the multiply instructions for the
6131 MN10300 processors.
6132
6133 @item -mam33
6134 @opindex mam33
6135 Generate code which uses features specific to the AM33 processor.
6136
6137 @item -mno-am33
6138 @opindex mno-am33
6139 Do not generate code which uses features specific to the AM33 processor.  This
6140 is the default.
6141
6142 @item -mno-crt0
6143 @opindex mno-crt0
6144 Do not link in the C run-time initialization object file.
6145
6146 @item -mrelax
6147 @opindex mrelax
6148 Indicate to the linker that it should perform a relaxation optimization pass
6149 to shorten branches, calls and absolute memory addresses.  This option only
6150 has an effect when used on the command line for the final link step.
6151
6152 This option makes symbolic debugging impossible.
6153 @end table
6154
6155
6156 @node M32R/D Options
6157 @subsection M32R/D Options
6158 @cindex M32R/D options
6159
6160 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6161
6162 @table @gcctabopt
6163 @item -m32rx
6164 @opindex m32rx
6165 Generate code for the M32R/X@.
6166
6167 @item -m32r
6168 @opindex m32r
6169 Generate code for the M32R@.  This is the default.
6170
6171 @item -mcode-model=small
6172 @opindex mcode-model=small
6173 Assume all objects live in the lower 16MB of memory (so that their addresses
6174 can be loaded with the @code{ld24} instruction), and assume all subroutines
6175 are reachable with the @code{bl} instruction.
6176 This is the default.
6177
6178 The addressability of a particular object can be set with the
6179 @code{model} attribute.
6180
6181 @item -mcode-model=medium
6182 @opindex mcode-model=medium
6183 Assume objects may be anywhere in the 32-bit address space (the compiler
6184 will generate @code{seth/add3} instructions to load their addresses), and
6185 assume all subroutines are reachable with the @code{bl} instruction.
6186
6187 @item -mcode-model=large
6188 @opindex mcode-model=large
6189 Assume objects may be anywhere in the 32-bit address space (the compiler
6190 will generate @code{seth/add3} instructions to load their addresses), and
6191 assume subroutines may not be reachable with the @code{bl} instruction
6192 (the compiler will generate the much slower @code{seth/add3/jl}
6193 instruction sequence).
6194
6195 @item -msdata=none
6196 @opindex msdata=none
6197 Disable use of the small data area.  Variables will be put into
6198 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6199 @code{section} attribute has been specified).
6200 This is the default.
6201
6202 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6203 Objects may be explicitly put in the small data area with the
6204 @code{section} attribute using one of these sections.
6205
6206 @item -msdata=sdata
6207 @opindex msdata=sdata
6208 Put small global and static data in the small data area, but do not
6209 generate special code to reference them.
6210
6211 @item -msdata=use
6212 @opindex msdata=use
6213 Put small global and static data in the small data area, and generate
6214 special instructions to reference them.
6215
6216 @item -G @var{num}
6217 @opindex G
6218 @cindex smaller data references
6219 Put global and static objects less than or equal to @var{num} bytes
6220 into the small data or bss sections instead of the normal data or bss
6221 sections.  The default value of @var{num} is 8.
6222 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6223 for this option to have any effect.
6224
6225 All modules should be compiled with the same @option{-G @var{num}} value.
6226 Compiling with different values of @var{num} may or may not work; if it
6227 doesn't the linker will give an error message---incorrect code will not be
6228 generated.
6229
6230 @end table
6231
6232 @node M88K Options
6233 @subsection M88K Options
6234 @cindex M88k options
6235
6236 These @samp{-m} options are defined for Motorola 88k architectures:
6237
6238 @table @gcctabopt
6239 @item -m88000
6240 @opindex m88000
6241 Generate code that works well on both the m88100 and the
6242 m88110.
6243
6244 @item -m88100
6245 @opindex m88100
6246 Generate code that works best for the m88100, but that also
6247 runs on the m88110.
6248
6249 @item -m88110
6250 @opindex m88110
6251 Generate code that works best for the m88110, and may not run
6252 on the m88100.
6253
6254 @item -mbig-pic
6255 @opindex mbig-pic
6256 Obsolete option to be removed from the next revision.
6257 Use @option{-fPIC}.
6258
6259 @item -midentify-revision
6260 @opindex midentify-revision
6261 @cindex identifying source, compiler (88k)
6262 Include an @code{ident} directive in the assembler output recording the
6263 source file name, compiler name and version, timestamp, and compilation
6264 flags used.
6265
6266 @item -mno-underscores
6267 @opindex mno-underscores
6268 @cindex underscores, avoiding (88k)
6269 In assembler output, emit symbol names without adding an underscore
6270 character at the beginning of each name.  The default is to use an
6271 underscore as prefix on each name.
6272
6273 @item -mocs-debug-info
6274 @itemx -mno-ocs-debug-info
6275 @opindex mocs-debug-info
6276 @opindex mno-ocs-debug-info
6277 @cindex OCS (88k)
6278 @cindex debugging, 88k OCS
6279 Include (or omit) additional debugging information (about registers used
6280 in each stack frame) as specified in the 88open Object Compatibility
6281 Standard, ``OCS''@.  This extra information allows debugging of code that
6282 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6283 Delta 88 SVr3.2 is to include this information; other 88k configurations
6284 omit this information by default.
6285
6286 @item -mocs-frame-position
6287 @opindex mocs-frame-position
6288 @cindex register positions in frame (88k)
6289 When emitting COFF debugging information for automatic variables and
6290 parameters stored on the stack, use the offset from the canonical frame
6291 address, which is the stack pointer (register 31) on entry to the
6292 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6293 @option{-mocs-frame-position}; other 88k configurations have the default
6294 @option{-mno-ocs-frame-position}.
6295
6296 @item -mno-ocs-frame-position
6297 @opindex mno-ocs-frame-position
6298 @cindex register positions in frame (88k)
6299 When emitting COFF debugging information for automatic variables and
6300 parameters stored on the stack, use the offset from the frame pointer
6301 register (register 30).  When this option is in effect, the frame
6302 pointer is not eliminated when debugging information is selected by the
6303 -g switch.
6304
6305 @item -moptimize-arg-area
6306 @opindex moptimize-arg-area
6307 @cindex arguments in frame (88k)
6308 Save space by reorganizing the stack frame.  This option generates code
6309 that does not agree with the 88open specifications, but uses less
6310 memory.
6311
6312 @itemx -mno-optimize-arg-area
6313 @opindex mno-optimize-arg-area
6314 Do not reorganize the stack frame to save space.  This is the default.
6315 The generated conforms to the specification, but uses more memory.
6316
6317 @item -mshort-data-@var{num}
6318 @opindex mshort-data
6319 @cindex smaller data references (88k)
6320 @cindex r0-relative references (88k)
6321 Generate smaller data references by making them relative to @code{r0},
6322 which allows loading a value using a single instruction (rather than the
6323 usual two).  You control which data references are affected by
6324 specifying @var{num} with this option.  For example, if you specify
6325 @option{-mshort-data-512}, then the data references affected are those
6326 involving displacements of less than 512 bytes.
6327 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6328 than 64k.
6329
6330 @item -mserialize-volatile
6331 @opindex mserialize-volatile
6332 @itemx -mno-serialize-volatile
6333 @opindex mno-serialize-volatile
6334 @cindex sequential consistency on 88k
6335 Do, or don't, generate code to guarantee sequential consistency
6336 of volatile memory references.  By default, consistency is
6337 guaranteed.
6338
6339 The order of memory references made by the MC88110 processor does
6340 not always match the order of the instructions requesting those
6341 references.  In particular, a load instruction may execute before
6342 a preceding store instruction.  Such reordering violates
6343 sequential consistency of volatile memory references, when there
6344 are multiple processors.   When consistency must be guaranteed,
6345 GCC generates special instructions, as needed, to force
6346 execution in the proper order.
6347
6348 The MC88100 processor does not reorder memory references and so
6349 always provides sequential consistency.  However, by default, GCC
6350 generates the special instructions to guarantee consistency
6351 even when you use @option{-m88100}, so that the code may be run on an
6352 MC88110 processor.  If you intend to run your code only on the
6353 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6354
6355 The extra code generated to guarantee consistency may affect the
6356 performance of your application.  If you know that you can safely
6357 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6358
6359 @item -msvr4
6360 @itemx -msvr3
6361 @opindex msvr4
6362 @opindex msvr3
6363 @cindex assembler syntax, 88k
6364 @cindex SVr4
6365 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6366 related to System V release 4 (SVr4).  This controls the following:
6367
6368 @enumerate
6369 @item
6370 Which variant of the assembler syntax to emit.
6371 @item
6372 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6373 that is used on System V release 4.
6374 @item
6375 @option{-msvr4} makes GCC issue additional declaration directives used in
6376 SVr4.
6377 @end enumerate
6378
6379 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6380 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6381 other m88k configurations.
6382
6383 @item -mversion-03.00
6384 @opindex mversion-03.00
6385 This option is obsolete, and is ignored.
6386 @c ??? which asm syntax better for GAS?  option there too?
6387
6388 @item -mno-check-zero-division
6389 @itemx -mcheck-zero-division
6390 @opindex mno-check-zero-division
6391 @opindex mcheck-zero-division
6392 @cindex zero division on 88k
6393 Do, or don't, generate code to guarantee that integer division by
6394 zero will be detected.  By default, detection is guaranteed.
6395
6396 Some models of the MC88100 processor fail to trap upon integer
6397 division by zero under certain conditions.  By default, when
6398 compiling code that might be run on such a processor, GCC
6399 generates code that explicitly checks for zero-valued divisors
6400 and traps with exception number 503 when one is detected.  Use of
6401 @option{-mno-check-zero-division} suppresses such checking for code
6402 generated to run on an MC88100 processor.
6403
6404 GCC assumes that the MC88110 processor correctly detects all instances
6405 of integer division by zero.  When @option{-m88110} is specified, no
6406 explicit checks for zero-valued divisors are generated, and both
6407 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6408 ignored.
6409
6410 @item -muse-div-instruction
6411 @opindex muse-div-instruction
6412 @cindex divide instruction, 88k
6413 Use the div instruction for signed integer division on the
6414 MC88100 processor.  By default, the div instruction is not used.
6415
6416 On the MC88100 processor the signed integer division instruction
6417 div) traps to the operating system on a negative operand.  The
6418 operating system transparently completes the operation, but at a
6419 large cost in execution time.  By default, when compiling code
6420 that might be run on an MC88100 processor, GCC emulates signed
6421 integer division using the unsigned integer division instruction
6422 divu), thereby avoiding the large penalty of a trap to the
6423 operating system.  Such emulation has its own, smaller, execution
6424 cost in both time and space.  To the extent that your code's
6425 important signed integer division operations are performed on two
6426 nonnegative operands, it may be desirable to use the div
6427 instruction directly.
6428
6429 On the MC88110 processor the div instruction (also known as the
6430 divs instruction) processes negative operands without trapping to
6431 the operating system.  When @option{-m88110} is specified,
6432 @option{-muse-div-instruction} is ignored, and the div instruction is used
6433 for signed integer division.
6434
6435 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6436 particular, the behavior of such a division with and without
6437 @option{-muse-div-instruction} may differ.
6438
6439 @item -mtrap-large-shift
6440 @itemx -mhandle-large-shift
6441 @opindex mtrap-large-shift
6442 @opindex mhandle-large-shift
6443 @cindex bit shift overflow (88k)
6444 @cindex large bit shifts (88k)
6445 Include code to detect bit-shifts of more than 31 bits; respectively,
6446 trap such shifts or emit code to handle them properly.  By default GCC
6447 makes no special provision for large bit shifts.
6448
6449 @item -mwarn-passed-structs
6450 @opindex mwarn-passed-structs
6451 @cindex structure passing (88k)
6452 Warn when a function passes a struct as an argument or result.
6453 Structure-passing conventions have changed during the evolution of the C
6454 language, and are often the source of portability problems.  By default,
6455 GCC issues no such warning.
6456 @end table
6457
6458 @c break page here to avoid unsightly interparagraph stretch.
6459 @c -zw, 2001-8-17
6460 @page
6461
6462 @node RS/6000 and PowerPC Options
6463 @subsection IBM RS/6000 and PowerPC Options
6464 @cindex RS/6000 and PowerPC Options
6465 @cindex IBM RS/6000 and PowerPC Options
6466
6467 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6468 @table @gcctabopt
6469 @item -mpower
6470 @itemx -mno-power
6471 @itemx -mpower2
6472 @itemx -mno-power2
6473 @itemx -mpowerpc
6474 @itemx -mno-powerpc
6475 @itemx -mpowerpc-gpopt
6476 @itemx -mno-powerpc-gpopt
6477 @itemx -mpowerpc-gfxopt
6478 @itemx -mno-powerpc-gfxopt
6479 @itemx -mpowerpc64
6480 @itemx -mno-powerpc64
6481 @opindex mpower
6482 @opindex mno-power
6483 @opindex mpower2
6484 @opindex mno-power2
6485 @opindex mpowerpc
6486 @opindex mno-powerpc
6487 @opindex mpowerpc-gpopt
6488 @opindex mno-powerpc-gpopt
6489 @opindex mpowerpc-gfxopt
6490 @opindex mno-powerpc-gfxopt
6491 @opindex mpowerpc64
6492 @opindex mno-powerpc64
6493 GCC supports two related instruction set architectures for the
6494 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6495 instructions supported by the @samp{rios} chip set used in the original
6496 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6497 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6498 the IBM 4xx microprocessors.
6499
6500 Neither architecture is a subset of the other.  However there is a
6501 large common subset of instructions supported by both.  An MQ
6502 register is included in processors supporting the POWER architecture.
6503
6504 You use these options to specify which instructions are available on the
6505 processor you are using.  The default value of these options is
6506 determined when configuring GCC@.  Specifying the
6507 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6508 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6509 rather than the options listed above.
6510
6511 The @option{-mpower} option allows GCC to generate instructions that
6512 are found only in the POWER architecture and to use the MQ register.
6513 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6514 to generate instructions that are present in the POWER2 architecture but
6515 not the original POWER architecture.
6516
6517 The @option{-mpowerpc} option allows GCC to generate instructions that
6518 are found only in the 32-bit subset of the PowerPC architecture.
6519 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6520 GCC to use the optional PowerPC architecture instructions in the
6521 General Purpose group, including floating-point square root.  Specifying
6522 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6523 use the optional PowerPC architecture instructions in the Graphics
6524 group, including floating-point select.
6525
6526 The @option{-mpowerpc64} option allows GCC to generate the additional
6527 64-bit instructions that are found in the full PowerPC64 architecture
6528 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6529 @option{-mno-powerpc64}.
6530
6531 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6532 will use only the instructions in the common subset of both
6533 architectures plus some special AIX common-mode calls, and will not use
6534 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6535 permits GCC to use any instruction from either architecture and to
6536 allow use of the MQ register; specify this for the Motorola MPC601.
6537
6538 @item -mnew-mnemonics
6539 @itemx -mold-mnemonics
6540 @opindex mnew-mnemonics
6541 @opindex mold-mnemonics
6542 Select which mnemonics to use in the generated assembler code.  With
6543 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6544 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6545 assembler mnemonics defined for the POWER architecture.  Instructions
6546 defined in only one architecture have only one mnemonic; GCC uses that
6547 mnemonic irrespective of which of these options is specified.
6548
6549 GCC defaults to the mnemonics appropriate for the architecture in
6550 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6551 value of these option.  Unless you are building a cross-compiler, you
6552 should normally not specify either @option{-mnew-mnemonics} or
6553 @option{-mold-mnemonics}, but should instead accept the default.
6554
6555 @item -mcpu=@var{cpu_type}
6556 @opindex mcpu
6557 Set architecture type, register usage, choice of mnemonics, and
6558 instruction scheduling parameters for machine type @var{cpu_type}.
6559 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6560 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6561 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6562 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6563 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6564 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6565
6566 @option{-mcpu=common} selects a completely generic processor.  Code
6567 generated under this option will run on any POWER or PowerPC processor.
6568 GCC will use only the instructions in the common subset of both
6569 architectures, and will not use the MQ register.  GCC assumes a generic
6570 processor model for scheduling purposes.
6571
6572 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6573 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6574 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6575 types, with an appropriate, generic processor model assumed for
6576 scheduling purposes.
6577
6578 The other options specify a specific processor.  Code generated under
6579 those options will run best on that processor, and may not run at all on
6580 others.
6581
6582 The @option{-mcpu} options automatically enable or disable other
6583 @option{-m} options as follows:
6584
6585 @table @samp
6586 @item common
6587 @option{-mno-power}, @option{-mno-powerc}
6588
6589 @item power
6590 @itemx power2
6591 @itemx rios1
6592 @itemx rios2
6593 @itemx rsc
6594 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6595
6596 @item powerpc
6597 @itemx rs64a
6598 @itemx 602
6599 @itemx 603
6600 @itemx 603e
6601 @itemx 604
6602 @itemx 620
6603 @itemx 630
6604 @itemx 740
6605 @itemx 7400
6606 @itemx 7450
6607 @itemx 750
6608 @itemx 505
6609 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6610
6611 @item 601
6612 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6613
6614 @item 403
6615 @itemx 821
6616 @itemx 860
6617 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6618 @end table
6619
6620 @item -mtune=@var{cpu_type}
6621 @opindex mtune
6622 Set the instruction scheduling parameters for machine type
6623 @var{cpu_type}, but do not set the architecture type, register usage, or
6624 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6625 values for @var{cpu_type} are used for @option{-mtune} as for
6626 @option{-mcpu}.  If both are specified, the code generated will use the
6627 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6628 scheduling parameters set by @option{-mtune}.
6629
6630 @item -maltivec
6631 @itemx -mno-altivec
6632 @opindex maltivec
6633 @opindex mno-altivec
6634 These switches enable or disable the use of built-in functions that
6635 allow access to the AltiVec instruction set.  You may also need to set
6636 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6637 enhancements.
6638
6639 @item -mabi=spe
6640 @opindex mabi=spe
6641 Extend the current ABI with SPE ABI extensions.  This does not change
6642 the default ABI, instead it adds the SPE ABI extensions to the current
6643 ABI@.
6644
6645 @item -mabi=no-spe
6646 @opindex mabi=no-spe
6647 Disable Booke SPE ABI extensions for the current ABI.
6648
6649 @item -misel=@var{yes/no}
6650 @itemx -misel
6651 @opindex misel
6652 This switch enables or disables the generation of ISEL instructions.
6653
6654 @item -mfull-toc
6655 @itemx -mno-fp-in-toc
6656 @itemx -mno-sum-in-toc
6657 @itemx -mminimal-toc
6658 @opindex mfull-toc
6659 @opindex mno-fp-in-toc
6660 @opindex mno-sum-in-toc
6661 @opindex mminimal-toc
6662 Modify generation of the TOC (Table Of Contents), which is created for
6663 every executable file.  The @option{-mfull-toc} option is selected by
6664 default.  In that case, GCC will allocate at least one TOC entry for
6665 each unique non-automatic variable reference in your program.  GCC
6666 will also place floating-point constants in the TOC@.  However, only
6667 16,384 entries are available in the TOC@.
6668
6669 If you receive a linker error message that saying you have overflowed
6670 the available TOC space, you can reduce the amount of TOC space used
6671 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6672 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6673 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6674 generate code to calculate the sum of an address and a constant at
6675 run-time instead of putting that sum into the TOC@.  You may specify one
6676 or both of these options.  Each causes GCC to produce very slightly
6677 slower and larger code at the expense of conserving TOC space.
6678
6679 If you still run out of space in the TOC even when you specify both of
6680 these options, specify @option{-mminimal-toc} instead.  This option causes
6681 GCC to make only one TOC entry for every file.  When you specify this
6682 option, GCC will produce code that is slower and larger but which
6683 uses extremely little TOC space.  You may wish to use this option
6684 only on files that contain less frequently executed code.
6685
6686 @item -maix64
6687 @itemx -maix32
6688 @opindex maix64
6689 @opindex maix32
6690 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6691 @code{long} type, and the infrastructure needed to support them.
6692 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6693 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6694 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6695
6696 @item -mxl-call
6697 @itemx -mno-xl-call
6698 @opindex mxl-call
6699 @opindex mno-xl-call
6700 On AIX, pass floating-point arguments to prototyped functions beyond the
6701 register save area (RSA) on the stack in addition to argument FPRs.  The
6702 AIX calling convention was extended but not initially documented to
6703 handle an obscure K&R C case of calling a function that takes the
6704 address of its arguments with fewer arguments than declared.  AIX XL
6705 compilers access floating point arguments which do not fit in the
6706 RSA from the stack when a subroutine is compiled without
6707 optimization.  Because always storing floating-point arguments on the
6708 stack is inefficient and rarely needed, this option is not enabled by
6709 default and only is necessary when calling subroutines compiled by AIX
6710 XL compilers without optimization.
6711
6712 @item -mpe
6713 @opindex mpe
6714 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6715 application written to use message passing with special startup code to
6716 enable the application to run.  The system must have PE installed in the
6717 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6718 must be overridden with the @option{-specs=} option to specify the
6719 appropriate directory location.  The Parallel Environment does not
6720 support threads, so the @option{-mpe} option and the @option{-pthread}
6721 option are incompatible.
6722
6723 @item -msoft-float
6724 @itemx -mhard-float
6725 @opindex msoft-float
6726 @opindex mhard-float
6727 Generate code that does not use (uses) the floating-point register set.
6728 Software floating point emulation is provided if you use the
6729 @option{-msoft-float} option, and pass the option to GCC when linking.
6730
6731 @item -mmultiple
6732 @itemx -mno-multiple
6733 @opindex mmultiple
6734 @opindex mno-multiple
6735 Generate code that uses (does not use) the load multiple word
6736 instructions and the store multiple word instructions.  These
6737 instructions are generated by default on POWER systems, and not
6738 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6739 endian PowerPC systems, since those instructions do not work when the
6740 processor is in little endian mode.  The exceptions are PPC740 and
6741 PPC750 which permit the instructions usage in little endian mode.
6742
6743 @item -mstring
6744 @itemx -mno-string
6745 @opindex mstring
6746 @opindex mno-string
6747 Generate code that uses (does not use) the load string instructions
6748 and the store string word instructions to save multiple registers and
6749 do small block moves.  These instructions are generated by default on
6750 POWER systems, and not generated on PowerPC systems.  Do not use
6751 @option{-mstring} on little endian PowerPC systems, since those
6752 instructions do not work when the processor is in little endian mode.
6753 The exceptions are PPC740 and PPC750 which permit the instructions
6754 usage in little endian mode.
6755
6756 @item -mupdate
6757 @itemx -mno-update
6758 @opindex mupdate
6759 @opindex mno-update
6760 Generate code that uses (does not use) the load or store instructions
6761 that update the base register to the address of the calculated memory
6762 location.  These instructions are generated by default.  If you use
6763 @option{-mno-update}, there is a small window between the time that the
6764 stack pointer is updated and the address of the previous frame is
6765 stored, which means code that walks the stack frame across interrupts or
6766 signals may get corrupted data.
6767
6768 @item -mfused-madd
6769 @itemx -mno-fused-madd
6770 @opindex mfused-madd
6771 @opindex mno-fused-madd
6772 Generate code that uses (does not use) the floating point multiply and
6773 accumulate instructions.  These instructions are generated by default if
6774 hardware floating is used.
6775
6776 @item -mno-bit-align
6777 @itemx -mbit-align
6778 @opindex mno-bit-align
6779 @opindex mbit-align
6780 On System V.4 and embedded PowerPC systems do not (do) force structures
6781 and unions that contain bit-fields to be aligned to the base type of the
6782 bit-field.
6783
6784 For example, by default a structure containing nothing but 8
6785 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6786 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6787 the structure would be aligned to a 1 byte boundary and be one byte in
6788 size.
6789
6790 @item -mno-strict-align
6791 @itemx -mstrict-align
6792 @opindex mno-strict-align
6793 @opindex mstrict-align
6794 On System V.4 and embedded PowerPC systems do not (do) assume that
6795 unaligned memory references will be handled by the system.
6796
6797 @item -mrelocatable
6798 @itemx -mno-relocatable
6799 @opindex mrelocatable
6800 @opindex mno-relocatable
6801 On embedded PowerPC systems generate code that allows (does not allow)
6802 the program to be relocated to a different address at runtime.  If you
6803 use @option{-mrelocatable} on any module, all objects linked together must
6804 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6805
6806 @item -mrelocatable-lib
6807 @itemx -mno-relocatable-lib
6808 @opindex mrelocatable-lib
6809 @opindex mno-relocatable-lib
6810 On embedded PowerPC systems generate code that allows (does not allow)
6811 the program to be relocated to a different address at runtime.  Modules
6812 compiled with @option{-mrelocatable-lib} can be linked with either modules
6813 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6814 with modules compiled with the @option{-mrelocatable} options.
6815
6816 @item -mno-toc
6817 @itemx -mtoc
6818 @opindex mno-toc
6819 @opindex mtoc
6820 On System V.4 and embedded PowerPC systems do not (do) assume that
6821 register 2 contains a pointer to a global area pointing to the addresses
6822 used in the program.
6823
6824 @item -mlittle
6825 @itemx -mlittle-endian
6826 @opindex mlittle
6827 @opindex mlittle-endian
6828 On System V.4 and embedded PowerPC systems compile code for the
6829 processor in little endian mode.  The @option{-mlittle-endian} option is
6830 the same as @option{-mlittle}.
6831
6832 @item -mbig
6833 @itemx -mbig-endian
6834 @opindex mbig
6835 @opindex mbig-endian
6836 On System V.4 and embedded PowerPC systems compile code for the
6837 processor in big endian mode.  The @option{-mbig-endian} option is
6838 the same as @option{-mbig}.
6839
6840 @item -mcall-sysv
6841 @opindex mcall-sysv
6842 On System V.4 and embedded PowerPC systems compile code using calling
6843 conventions that adheres to the March 1995 draft of the System V
6844 Application Binary Interface, PowerPC processor supplement.  This is the
6845 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6846
6847 @item -mcall-sysv-eabi
6848 @opindex mcall-sysv-eabi
6849 Specify both @option{-mcall-sysv} and @option{-meabi} options.
6850
6851 @item -mcall-sysv-noeabi
6852 @opindex mcall-sysv-noeabi
6853 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
6854
6855 @item -mcall-aix
6856 @opindex mcall-aix
6857 On System V.4 and embedded PowerPC systems compile code using calling
6858 conventions that are similar to those used on AIX@.  This is the
6859 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6860
6861 @item -mcall-solaris
6862 @opindex mcall-solaris
6863 On System V.4 and embedded PowerPC systems compile code for the Solaris
6864 operating system.
6865
6866 @item -mcall-linux
6867 @opindex mcall-linux
6868 On System V.4 and embedded PowerPC systems compile code for the
6869 Linux-based GNU system.
6870
6871 @item -mcall-gnu
6872 @opindex mcall-gnu
6873 On System V.4 and embedded PowerPC systems compile code for the
6874 Hurd-based GNU system.
6875
6876 @item -mcall-netbsd
6877 @opindex mcall-netbsd
6878 On System V.4 and embedded PowerPC systems compile code for the
6879 NetBSD operating system.
6880
6881 @item -maix-struct-return
6882 @opindex maix-struct-return
6883 Return all structures in memory (as specified by the AIX ABI)@.
6884
6885 @item -msvr4-struct-return
6886 @opindex msvr4-struct-return
6887 Return structures smaller than 8 bytes in registers (as specified by the
6888 SVR4 ABI)@.
6889
6890 @item -mabi=altivec
6891 @opindex mabi=altivec
6892 Extend the current ABI with AltiVec ABI extensions.  This does not
6893 change the default ABI, instead it adds the AltiVec ABI extensions to
6894 the current ABI@.
6895
6896 @item -mabi=no-altivec
6897 @opindex mabi=no-altivec
6898 Disable AltiVec ABI extensions for the current ABI.
6899
6900 @item -mprototype
6901 @itemx -mno-prototype
6902 @opindex mprototype
6903 @opindex mno-prototype
6904 On System V.4 and embedded PowerPC systems assume that all calls to
6905 variable argument functions are properly prototyped.  Otherwise, the
6906 compiler must insert an instruction before every non prototyped call to
6907 set or clear bit 6 of the condition code register (@var{CR}) to
6908 indicate whether floating point values were passed in the floating point
6909 registers in case the function takes a variable arguments.  With
6910 @option{-mprototype}, only calls to prototyped variable argument functions
6911 will set or clear the bit.
6912
6913 @item -msim
6914 @opindex msim
6915 On embedded PowerPC systems, assume that the startup module is called
6916 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6917 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6918 configurations.
6919
6920 @item -mmvme
6921 @opindex mmvme
6922 On embedded PowerPC systems, assume that the startup module is called
6923 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6924 @file{libc.a}.
6925
6926 @item -mads
6927 @opindex mads
6928 On embedded PowerPC systems, assume that the startup module is called
6929 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6930 @file{libc.a}.
6931
6932 @item -myellowknife
6933 @opindex myellowknife
6934 On embedded PowerPC systems, assume that the startup module is called
6935 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6936 @file{libc.a}.
6937
6938 @item -mvxworks
6939 @opindex mvxworks
6940 On System V.4 and embedded PowerPC systems, specify that you are
6941 compiling for a VxWorks system.
6942
6943 @item -mwindiss
6944 @opindex mwindiss
6945 Specify that you are compiling for the WindISS simulation environment.
6946
6947 @item -memb
6948 @opindex memb
6949 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6950 header to indicate that @samp{eabi} extended relocations are used.
6951
6952 @item -meabi
6953 @itemx -mno-eabi
6954 @opindex meabi
6955 @opindex mno-eabi
6956 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6957 Embedded Applications Binary Interface (eabi) which is a set of
6958 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6959 means that the stack is aligned to an 8 byte boundary, a function
6960 @code{__eabi} is called to from @code{main} to set up the eabi
6961 environment, and the @option{-msdata} option can use both @code{r2} and
6962 @code{r13} to point to two separate small data areas.  Selecting
6963 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6964 do not call an initialization function from @code{main}, and the
6965 @option{-msdata} option will only use @code{r13} to point to a single
6966 small data area.  The @option{-meabi} option is on by default if you
6967 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6968
6969 @item -msdata=eabi
6970 @opindex msdata=eabi
6971 On System V.4 and embedded PowerPC systems, put small initialized
6972 @code{const} global and static data in the @samp{.sdata2} section, which
6973 is pointed to by register @code{r2}.  Put small initialized
6974 non-@code{const} global and static data in the @samp{.sdata} section,
6975 which is pointed to by register @code{r13}.  Put small uninitialized
6976 global and static data in the @samp{.sbss} section, which is adjacent to
6977 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
6978 incompatible with the @option{-mrelocatable} option.  The
6979 @option{-msdata=eabi} option also sets the @option{-memb} option.
6980
6981 @item -msdata=sysv
6982 @opindex msdata=sysv
6983 On System V.4 and embedded PowerPC systems, put small global and static
6984 data in the @samp{.sdata} section, which is pointed to by register
6985 @code{r13}.  Put small uninitialized global and static data in the
6986 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6987 The @option{-msdata=sysv} option is incompatible with the
6988 @option{-mrelocatable} option.
6989
6990 @item -msdata=default
6991 @itemx -msdata
6992 @opindex msdata=default
6993 @opindex msdata
6994 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
6995 compile code the same as @option{-msdata=eabi}, otherwise compile code the
6996 same as @option{-msdata=sysv}.
6997
6998 @item -msdata-data
6999 @opindex msdata-data
7000 On System V.4 and embedded PowerPC systems, put small global and static
7001 data in the @samp{.sdata} section.  Put small uninitialized global and
7002 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7003 to address small data however.  This is the default behavior unless
7004 other @option{-msdata} options are used.
7005
7006 @item -msdata=none
7007 @itemx -mno-sdata
7008 @opindex msdata=none
7009 @opindex mno-sdata
7010 On embedded PowerPC systems, put all initialized global and static data
7011 in the @samp{.data} section, and all uninitialized data in the
7012 @samp{.bss} section.
7013
7014 @item -G @var{num}
7015 @opindex G
7016 @cindex smaller data references (PowerPC)
7017 @cindex .sdata/.sdata2 references (PowerPC)
7018 On embedded PowerPC systems, put global and static items less than or
7019 equal to @var{num} bytes into the small data or bss sections instead of
7020 the normal data or bss section.  By default, @var{num} is 8.  The
7021 @option{-G @var{num}} switch is also passed to the linker.
7022 All modules should be compiled with the same @option{-G @var{num}} value.
7023
7024 @item -mregnames
7025 @itemx -mno-regnames
7026 @opindex mregnames
7027 @opindex mno-regnames
7028 On System V.4 and embedded PowerPC systems do (do not) emit register
7029 names in the assembly language output using symbolic forms.
7030
7031 @item -mlongcall
7032 @itemx -mno-longcall
7033 @opindex mlongcall
7034 @opindex mno-longcall
7035 Default to making all function calls via pointers, so that functions
7036 which reside further than 64 megabytes (67,108,864 bytes) from the
7037 current location can be called.  This setting can be overridden by the
7038 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7039
7040 Some linkers are capable of detecting out-of-range calls and generating
7041 glue code on the fly.  On these systems, long calls are unnecessary and
7042 generate slower code.  As of this writing, the AIX linker can do this,
7043 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7044 to the GNU linker for 32-bit PowerPC systems as well.
7045
7046 In the future, we may cause GCC to ignore all longcall specifications
7047 when the linker is known to generate glue.
7048
7049 @item -pthread
7050 @opindex pthread
7051 Adds support for multithreading with the @dfn{pthreads} library.
7052 This option sets flags for both the preprocessor and linker.
7053
7054 @end table
7055
7056 @node RT Options
7057 @subsection IBM RT Options
7058 @cindex RT options
7059 @cindex IBM RT options
7060
7061 These @samp{-m} options are defined for the IBM RT PC:
7062
7063 @table @gcctabopt
7064 @item -min-line-mul
7065 @opindex min-line-mul
7066 Use an in-line code sequence for integer multiplies.  This is the
7067 default.
7068
7069 @item -mcall-lib-mul
7070 @opindex mcall-lib-mul
7071 Call @code{lmul$$} for integer multiples.
7072
7073 @item -mfull-fp-blocks
7074 @opindex mfull-fp-blocks
7075 Generate full-size floating point data blocks, including the minimum
7076 amount of scratch space recommended by IBM@.  This is the default.
7077
7078 @item -mminimum-fp-blocks
7079 @opindex mminimum-fp-blocks
7080 Do not include extra scratch space in floating point data blocks.  This
7081 results in smaller code, but slower execution, since scratch space must
7082 be allocated dynamically.
7083
7084 @cindex @file{stdarg.h} and RT PC
7085 @item -mfp-arg-in-fpregs
7086 @opindex mfp-arg-in-fpregs
7087 Use a calling sequence incompatible with the IBM calling convention in
7088 which floating point arguments are passed in floating point registers.
7089 Note that @code{stdarg.h} will not work with floating point operands
7090 if this option is specified.
7091
7092 @item -mfp-arg-in-gregs
7093 @opindex mfp-arg-in-gregs
7094 Use the normal calling convention for floating point arguments.  This is
7095 the default.
7096
7097 @item -mhc-struct-return
7098 @opindex mhc-struct-return
7099 Return structures of more than one word in memory, rather than in a
7100 register.  This provides compatibility with the MetaWare HighC (hc)
7101 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7102 with the Portable C Compiler (pcc).
7103
7104 @item -mnohc-struct-return
7105 @opindex mnohc-struct-return
7106 Return some structures of more than one word in registers, when
7107 convenient.  This is the default.  For compatibility with the
7108 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7109 option @option{-mhc-struct-return}.
7110 @end table
7111
7112 @node MIPS Options
7113 @subsection MIPS Options
7114 @cindex MIPS options
7115
7116 These @samp{-m} options are defined for the MIPS family of computers:
7117
7118 @table @gcctabopt
7119
7120 @item -march=@var{arch}
7121 @opindex march
7122 Generate code that will run on @var{arch}, which can be the name of a
7123 generic MIPS ISA, or the name of a particular processor.  The ISA names
7124 are: @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4}, @samp{mips32}
7125 and @samp{mips64}.  The processor names are: @samp{r2000},
7126 @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{vr4100}, @samp{vr4300},
7127 @samp{r4400}, @samp{r4600}, @samp{r4650}, @samp{vr5000}, @samp{r6000},
7128 @samp{r8000}, @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7129 @samp{orion}, and @samp{sb1}.  The special value @samp{from-abi} selects the
7130 most compatible architecture for the selected ABI (that is,
7131 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7132
7133 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7134 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7135 @samp{vr} may be written @samp{r}.
7136
7137 GCC defines two macros based on the value of this option.  The first
7138 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7139 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7140 where @var{foo} is the capitialized value of @samp{_MIPS_ARCH}@.
7141 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7142 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7143
7144 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7145 above.  In other words, it will have the full prefix and will not
7146 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7147 the macro names the resolved architecture (either @samp{"mips1"} or
7148 @samp{"mips3"}).  It names the default architecture when no
7149 @option{-march} option is given.
7150
7151 @item -mtune=@var{arch}
7152 @opindex mtune
7153 Optimize for @var{arch}.  Among other things, this option controls
7154 the way instructions are scheduled, and the perceived cost of arithmetic
7155 operations.  The list of @var{arch} values is the same as for
7156 @option{-march}.
7157
7158 When this option is not used, GCC will optimize for the processor
7159 specified by @option{-march}.  By using @option{-march} and
7160 @option{-mtune} together, it is possible to generate code that will
7161 run on a family of processors, but optimize the code for one
7162 particular member of that family.
7163
7164 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7165 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7166 @samp{-march} ones described above.
7167
7168 @item -mips1
7169 @opindex mips1
7170 Equivalent to @samp{-march=mips1}.
7171
7172 @item -mips2
7173 @opindex mips2
7174 Equivalent to @samp{-march=mips2}.
7175
7176 @item -mips3
7177 @opindex mips3
7178 Equivalent to @samp{-march=mips3}.
7179
7180 @item -mips4
7181 @opindex mips4
7182 Equivalent to @samp{-march=mips4}.
7183
7184 @item -mips32
7185 @opindex mips32
7186 Equivalent to @samp{-march=mips32}.
7187
7188 @item -mips64
7189 @opindex mips64
7190 Equivalent to @samp{-march=mips64}.
7191
7192 @item -mfused-madd
7193 @itemx -mno-fused-madd
7194 @opindex mfused-madd
7195 @opindex mno-fused-madd
7196 Generate code that uses (does not use) the floating point multiply and
7197 accumulate instructions, when they are available.  These instructions
7198 are generated by default if they are available, but this may be
7199 undesirable if the extra precision causes problems or on certain chips
7200 in the mode where denormals are rounded to zero where denormals
7201 generated by multiply and accumulate instructions cause exceptions
7202 anyway.
7203
7204 @item -mfp32
7205 @opindex mfp32
7206 Assume that floating point registers are 32 bits wide.
7207
7208 @item -mfp64
7209 @opindex mfp64
7210 Assume that floating point registers are 64 bits wide.
7211
7212 @item -mgp32
7213 @opindex mgp32
7214 Assume that general purpose registers are 32 bits wide.
7215
7216 @item -mgp64
7217 @opindex mgp64
7218 Assume that general purpose registers are 64 bits wide.
7219
7220 @item -mint64
7221 @opindex mint64
7222 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7223 explanation of the default, and the width of pointers.
7224
7225 @item -mlong64
7226 @opindex mlong64
7227 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7228 explanation of the default, and the width of pointers.
7229
7230 @item -mlong32
7231 @opindex mlong32
7232 Force long, int, and pointer types to be 32 bits wide.
7233
7234 The default size of ints, longs and pointers depends on the ABI@.  All
7235 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7236 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7237 are the same size as longs, or the same size as integer registers,
7238 whichever is smaller.
7239
7240 @item -mabi=32
7241 @itemx -mabi=o64
7242 @itemx -mabi=n32
7243 @itemx -mabi=64
7244 @itemx -mabi=eabi
7245 @itemx -mabi=meabi
7246 @opindex mabi=32
7247 @opindex mabi=o64
7248 @opindex mabi=n32
7249 @opindex mabi=64
7250 @opindex mabi=eabi
7251 @opindex mabi=meabi
7252 Generate code for the given ABI@.
7253
7254 Note that there are two embedded ABIs: @option{-mabi=eabi}
7255 selects the one defined by Cygnus while @option{-meabi=meabi}
7256 selects the one defined by MIPS@.  Both these ABIs have
7257 32-bit and 64-bit variants.  Normally, GCC will generate
7258 64-bit code when you select a 64-bit architecture, but you
7259 can use @option{-mgp32} to get 32-bit code instead.
7260
7261 @item -mmips-as
7262 @opindex mmips-as
7263 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7264 add normal debug information.  This is the default for all
7265 platforms except for the OSF/1 reference platform, using the OSF/rose
7266 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7267 switches are used, the @file{mips-tfile} program will encapsulate the
7268 stabs within MIPS ECOFF@.
7269
7270 @item -mgas
7271 @opindex mgas
7272 Generate code for the GNU assembler.  This is the default on the OSF/1
7273 reference platform, using the OSF/rose object format.  Also, this is
7274 the default if the configure option @option{--with-gnu-as} is used.
7275
7276 @item -msplit-addresses
7277 @itemx -mno-split-addresses
7278 @opindex msplit-addresses
7279 @opindex mno-split-addresses
7280 Generate code to load the high and low parts of address constants separately.
7281 This allows GCC to optimize away redundant loads of the high order
7282 bits of addresses.  This optimization requires GNU as and GNU ld.
7283 This optimization is enabled by default for some embedded targets where
7284 GNU as and GNU ld are standard.
7285
7286 @item -mrnames
7287 @itemx -mno-rnames
7288 @opindex mrnames
7289 @opindex mno-rnames
7290 The @option{-mrnames} switch says to output code using the MIPS software
7291 names for the registers, instead of the hardware names (ie, @var{a0}
7292 instead of @var{$4}).  The only known assembler that supports this option
7293 is the Algorithmics assembler.
7294
7295 @item -mgpopt
7296 @itemx -mno-gpopt
7297 @opindex mgpopt
7298 @opindex mno-gpopt
7299 The @option{-mgpopt} switch says to write all of the data declarations
7300 before the instructions in the text section, this allows the MIPS
7301 assembler to generate one word memory references instead of using two
7302 words for short global or static data items.  This is on by default if
7303 optimization is selected.
7304
7305 @item -mstats
7306 @itemx -mno-stats
7307 @opindex mstats
7308 @opindex mno-stats
7309 For each non-inline function processed, the @option{-mstats} switch
7310 causes the compiler to emit one line to the standard error file to
7311 print statistics about the program (number of registers saved, stack
7312 size, etc.).
7313
7314 @item -mmemcpy
7315 @itemx -mno-memcpy
7316 @opindex mmemcpy
7317 @opindex mno-memcpy
7318 The @option{-mmemcpy} switch makes all block moves call the appropriate
7319 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7320 generating inline code.
7321
7322 @item -mmips-tfile
7323 @itemx -mno-mips-tfile
7324 @opindex mmips-tfile
7325 @opindex mno-mips-tfile
7326 The @option{-mno-mips-tfile} switch causes the compiler not
7327 postprocess the object file with the @file{mips-tfile} program,
7328 after the MIPS assembler has generated it to add debug support.  If
7329 @file{mips-tfile} is not run, then no local variables will be
7330 available to the debugger.  In addition, @file{stage2} and
7331 @file{stage3} objects will have the temporary file names passed to the
7332 assembler embedded in the object file, which means the objects will
7333 not compare the same.  The @option{-mno-mips-tfile} switch should only
7334 be used when there are bugs in the @file{mips-tfile} program that
7335 prevents compilation.
7336
7337 @item -msoft-float
7338 @opindex msoft-float
7339 Generate output containing library calls for floating point.
7340 @strong{Warning:} the requisite libraries are not part of GCC@.
7341 Normally the facilities of the machine's usual C compiler are used, but
7342 this can't be done directly in cross-compilation.  You must make your
7343 own arrangements to provide suitable library functions for
7344 cross-compilation.
7345
7346 @item -mhard-float
7347 @opindex mhard-float
7348 Generate output containing floating point instructions.  This is the
7349 default if you use the unmodified sources.
7350
7351 @item -mabicalls
7352 @itemx -mno-abicalls
7353 @opindex mabicalls
7354 @opindex mno-abicalls
7355 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7356 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7357 position independent code.
7358
7359 @item -mlong-calls
7360 @itemx -mno-long-calls
7361 @opindex mlong-calls
7362 @opindex mno-long-calls
7363 Do all calls with the @samp{JALR} instruction, which requires
7364 loading up a function's address into a register before the call.
7365 You need to use this switch, if you call outside of the current
7366 512 megabyte segment to functions that are not through pointers.
7367
7368 @item -mhalf-pic
7369 @itemx -mno-half-pic
7370 @opindex mhalf-pic
7371 @opindex mno-half-pic
7372 Put pointers to extern references into the data section and load them
7373 up, rather than put the references in the text section.
7374
7375 @item -membedded-pic
7376 @itemx -mno-embedded-pic
7377 @opindex membedded-pic
7378 @opindex mno-embedded-pic
7379 Generate PIC code suitable for some embedded systems.  All calls are
7380 made using PC relative address, and all data is addressed using the $gp
7381 register.  No more than 65536 bytes of global data may be used.  This
7382 requires GNU as and GNU ld which do most of the work.  This currently
7383 only works on targets which use ECOFF; it does not work with ELF@.
7384
7385 @item -membedded-data
7386 @itemx -mno-embedded-data
7387 @opindex membedded-data
7388 @opindex mno-embedded-data
7389 Allocate variables to the read-only data section first if possible, then
7390 next in the small data section if possible, otherwise in data.  This gives
7391 slightly slower code than the default, but reduces the amount of RAM required
7392 when executing, and thus may be preferred for some embedded systems.
7393
7394 @item -muninit-const-in-rodata
7395 @itemx -mno-uninit-const-in-rodata
7396 @opindex muninit-const-in-rodata
7397 @opindex mno-uninit-const-in-rodata
7398 When used together with @option{-membedded-data}, it will always store uninitialized
7399 const variables in the read-only data section.
7400
7401 @item -msingle-float
7402 @itemx -mdouble-float
7403 @opindex msingle-float
7404 @opindex mdouble-float
7405 The @option{-msingle-float} switch tells gcc to assume that the floating
7406 point coprocessor only supports single precision operations, as on the
7407 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7408 double precision operations.  This is the default.
7409
7410 @item -mmad
7411 @itemx -mno-mad
7412 @opindex mmad
7413 @opindex mno-mad
7414 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7415 as on the @samp{r4650} chip.
7416
7417 @item -m4650
7418 @opindex m4650
7419 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7420 @option{-mcpu=r4650}.
7421
7422 @item -mips16
7423 @itemx -mno-mips16
7424 @opindex mips16
7425 @opindex mno-mips16
7426 Enable 16-bit instructions.
7427
7428 @item -mentry
7429 @opindex mentry
7430 Use the entry and exit pseudo ops.  This option can only be used with
7431 @option{-mips16}.
7432
7433 @item -EL
7434 @opindex EL
7435 Compile code for the processor in little endian mode.
7436 The requisite libraries are assumed to exist.
7437
7438 @item -EB
7439 @opindex EB
7440 Compile code for the processor in big endian mode.
7441 The requisite libraries are assumed to exist.
7442
7443 @item -G @var{num}
7444 @opindex G
7445 @cindex smaller data references (MIPS)
7446 @cindex gp-relative references (MIPS)
7447 Put global and static items less than or equal to @var{num} bytes into
7448 the small data or bss sections instead of the normal data or bss
7449 section.  This allows the assembler to emit one word memory reference
7450 instructions based on the global pointer (@var{gp} or @var{$28}),
7451 instead of the normal two words used.  By default, @var{num} is 8 when
7452 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7453 @option{-G @var{num}} switch is also passed to the assembler and linker.
7454 All modules should be compiled with the same @option{-G @var{num}}
7455 value.
7456
7457 @item -nocpp
7458 @opindex nocpp
7459 Tell the MIPS assembler to not run its preprocessor over user
7460 assembler files (with a @samp{.s} suffix) when assembling them.
7461
7462 @item -mfix7000
7463 @opindex mfix7000
7464 Pass an option to gas which will cause nops to be inserted if
7465 the read of the destination register of an mfhi or mflo instruction
7466 occurs in the following two instructions.
7467
7468 @item -no-crt0
7469 @opindex no-crt0
7470 Do not include the default crt0.
7471
7472 @item -mflush-func=@var{func}
7473 @itemx -mno-flush-func
7474 @opindex mflush-func
7475 Specifies the function to call to flush the I and D caches, or to not
7476 call any such function.  If called, the function must take the same
7477 arguments as the common @code{_flush_func()}, that is, the address of the
7478 memory range for which the cache is being flushed, the size of the
7479 memory range, and the number 3 (to flush both caches).  The default
7480 depends on the target gcc was configured for, but commonly is either
7481 @samp{_flush_func} or @samp{__cpu_flush}.
7482
7483 @item -mbranch-likely
7484 @itemx -mno-branch-likely
7485 @opindex mbranch-likely
7486 @opindex mno-branch-likely
7487 Enable or disable use of Branch Likely instructions, regardless of the
7488 default for the selected architecture.  By default, Branch Likely
7489 instructions may be generated if they are supported by the selected
7490 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7491 and processors which implement those architectures; for those, Branch
7492 Likely instructions will not be generated by default because the MIPS32
7493 and MIPS64 architectures specifically deprecate their use.
7494 @end table
7495
7496 @node i386 and x86-64 Options
7497 @subsection Intel 386 and AMD x86-64 Options
7498 @cindex i386 Options
7499 @cindex x86-64 Options
7500 @cindex Intel 386 Options
7501 @cindex AMD x86-64 Options
7502
7503 These @samp{-m} options are defined for the i386 and x86-64 family of
7504 computers:
7505
7506 @table @gcctabopt
7507 @item -mcpu=@var{cpu-type}
7508 @opindex mcpu
7509 Tune to @var{cpu-type} everything applicable about the generated code, except
7510 for the ABI and the set of available instructions.  The choices for
7511 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7512 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7513 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7514 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7515 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2} and @samp{c3}.
7516
7517 While picking a specific @var{cpu-type} will schedule things appropriately
7518 for that particular chip, the compiler will not generate any code that
7519 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7520 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7521 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7522 AMD chips as opposed to the Intel ones.
7523
7524 @item -march=@var{cpu-type}
7525 @opindex march
7526 Generate instructions for the machine type @var{cpu-type}.  The choices
7527 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7528 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7529
7530 @item -m386
7531 @itemx -m486
7532 @itemx -mpentium
7533 @itemx -mpentiumpro
7534 @opindex m386
7535 @opindex m486
7536 @opindex mpentium
7537 @opindex mpentiumpro
7538 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7539 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7540 These synonyms are deprecated.
7541
7542 @item -mfpmath=@var{unit}
7543 @opindex march
7544 generate floating point arithmetics for selected unit @var{unit}.  the choices
7545 for @var{unit} are:
7546
7547 @table @samp
7548 @item 387
7549 Use the standard 387 floating point coprocessor present majority of chips and
7550 emulated otherwise.  Code compiled with this option will run almost everywhere.
7551 The temporary results are computed in 80bit precesion instead of precision
7552 specified by the type resulting in slightly different results compared to most
7553 of other chips. See @option{-ffloat-store} for more detailed description.
7554
7555 This is the default choice for i386 compiler.
7556
7557 @item sse
7558 Use scalar floating point instructions present in the SSE instruction set.
7559 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7560 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7561 instruction set supports only single precision arithmetics, thus the double and
7562 extended precision arithmetics is still done using 387.  Later version, present
7563 only in Pentium4 and the future AMD x86-64 chips supports double precision
7564 arithmetics too.
7565
7566 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7567 @option{-msse2} switches to enable SSE extensions and make this option
7568 effective.  For x86-64 compiler, these extensions are enabled by default.
7569
7570 The resulting code should be considerably faster in majority of cases and avoid
7571 the numerical instability problems of 387 code, but may break some existing
7572 code that expects temporaries to be 80bit.
7573
7574 This is the default choice for x86-64 compiler.
7575
7576 @item sse,387
7577 Attempt to utilize both instruction sets at once.  This effectivly double the
7578 amount of available registers and on chips with separate execution units for
7579 387 and SSE the execution resources too.  Use this option with care, as it is
7580 still experimental, because gcc register allocator does not model separate
7581 functional units well resulting in instable performance.
7582 @end table
7583
7584 @item -masm=@var{dialect}
7585 @opindex masm=@var{dialect}
7586 Output asm instructions using selected @var{dialect}. Supported choices are
7587 @samp{intel} or @samp{att} (the default one).
7588
7589 @item -mieee-fp
7590 @itemx -mno-ieee-fp
7591 @opindex mieee-fp
7592 @opindex mno-ieee-fp
7593 Control whether or not the compiler uses IEEE floating point
7594 comparisons.  These handle correctly the case where the result of a
7595 comparison is unordered.
7596
7597 @item -msoft-float
7598 @opindex msoft-float
7599 Generate output containing library calls for floating point.
7600 @strong{Warning:} the requisite libraries are not part of GCC@.
7601 Normally the facilities of the machine's usual C compiler are used, but
7602 this can't be done directly in cross-compilation.  You must make your
7603 own arrangements to provide suitable library functions for
7604 cross-compilation.
7605
7606 On machines where a function returns floating point results in the 80387
7607 register stack, some floating point opcodes may be emitted even if
7608 @option{-msoft-float} is used.
7609
7610 @item -mno-fp-ret-in-387
7611 @opindex mno-fp-ret-in-387
7612 Do not use the FPU registers for return values of functions.
7613
7614 The usual calling convention has functions return values of types
7615 @code{float} and @code{double} in an FPU register, even if there
7616 is no FPU@.  The idea is that the operating system should emulate
7617 an FPU@.
7618
7619 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7620 in ordinary CPU registers instead.
7621
7622 @item -mno-fancy-math-387
7623 @opindex mno-fancy-math-387
7624 Some 387 emulators do not support the @code{sin}, @code{cos} and
7625 @code{sqrt} instructions for the 387.  Specify this option to avoid
7626 generating those instructions.  This option is the default on FreeBSD,
7627 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
7628 indicates that the target cpu will always have an FPU and so the
7629 instruction will not need emulation.  As of revision 2.6.1, these
7630 instructions are not generated unless you also use the
7631 @option{-funsafe-math-optimizations} switch.
7632
7633 @item -malign-double
7634 @itemx -mno-align-double
7635 @opindex malign-double
7636 @opindex mno-align-double
7637 Control whether GCC aligns @code{double}, @code{long double}, and
7638 @code{long long} variables on a two word boundary or a one word
7639 boundary.  Aligning @code{double} variables on a two word boundary will
7640 produce code that runs somewhat faster on a @samp{Pentium} at the
7641 expense of more memory.
7642
7643 @strong{Warning:} if you use the @samp{-malign-double} switch,
7644 structures containing the above types will be aligned differently than
7645 the published application binary interface specifications for the 386.
7646
7647 @item -m128bit-long-double
7648 @opindex m128bit-long-double
7649 Control the size of @code{long double} type. i386 application binary interface
7650 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
7651 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
7652 impossible to reach with 12 byte long doubles in the array accesses.
7653
7654 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
7655 structures and arrays containing @code{long double} will change their size as
7656 well as function calling convention for function taking @code{long double}
7657 will be modified.
7658
7659 @item -m96bit-long-double
7660 @opindex m96bit-long-double
7661 Set the size of @code{long double} to 96 bits as required by the i386
7662 application binary interface.  This is the default.
7663
7664 @item -msvr3-shlib
7665 @itemx -mno-svr3-shlib
7666 @opindex msvr3-shlib
7667 @opindex mno-svr3-shlib
7668 Control whether GCC places uninitialized local variables into the
7669 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
7670 into @code{bss}.  These options are meaningful only on System V Release 3.
7671
7672 @item -mrtd
7673 @opindex mrtd
7674 Use a different function-calling convention, in which functions that
7675 take a fixed number of arguments return with the @code{ret} @var{num}
7676 instruction, which pops their arguments while returning.  This saves one
7677 instruction in the caller since there is no need to pop the arguments
7678 there.
7679
7680 You can specify that an individual function is called with this calling
7681 sequence with the function attribute @samp{stdcall}.  You can also
7682 override the @option{-mrtd} option by using the function attribute
7683 @samp{cdecl}.  @xref{Function Attributes}.
7684
7685 @strong{Warning:} this calling convention is incompatible with the one
7686 normally used on Unix, so you cannot use it if you need to call
7687 libraries compiled with the Unix compiler.
7688
7689 Also, you must provide function prototypes for all functions that
7690 take variable numbers of arguments (including @code{printf});
7691 otherwise incorrect code will be generated for calls to those
7692 functions.
7693
7694 In addition, seriously incorrect code will result if you call a
7695 function with too many arguments.  (Normally, extra arguments are
7696 harmlessly ignored.)
7697
7698 @item -mregparm=@var{num}
7699 @opindex mregparm
7700 Control how many registers are used to pass integer arguments.  By
7701 default, no registers are used to pass arguments, and at most 3
7702 registers can be used.  You can control this behavior for a specific
7703 function by using the function attribute @samp{regparm}.
7704 @xref{Function Attributes}.
7705
7706 @strong{Warning:} if you use this switch, and
7707 @var{num} is nonzero, then you must build all modules with the same
7708 value, including any libraries.  This includes the system libraries and
7709 startup modules.
7710
7711 @item -mpreferred-stack-boundary=@var{num}
7712 @opindex mpreferred-stack-boundary
7713 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
7714 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
7715 the default is 4 (16 bytes or 128 bits), except when optimizing for code
7716 size (@option{-Os}), in which case the default is the minimum correct
7717 alignment (4 bytes for x86, and 8 bytes for x86-64).
7718
7719 On Pentium and PentiumPro, @code{double} and @code{long double} values
7720 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
7721 suffer significant run time performance penalties.  On Pentium III, the
7722 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
7723 penalties if it is not 16 byte aligned.
7724
7725 To ensure proper alignment of this values on the stack, the stack boundary
7726 must be as aligned as that required by any value stored on the stack.
7727 Further, every function must be generated such that it keeps the stack
7728 aligned.  Thus calling a function compiled with a higher preferred
7729 stack boundary from a function compiled with a lower preferred stack
7730 boundary will most likely misalign the stack.  It is recommended that
7731 libraries that use callbacks always use the default setting.
7732
7733 This extra alignment does consume extra stack space, and generally
7734 increases code size.  Code that is sensitive to stack space usage, such
7735 as embedded systems and operating system kernels, may want to reduce the
7736 preferred alignment to @option{-mpreferred-stack-boundary=2}.
7737
7738 @item -mmmx
7739 @itemx -mno-mmx
7740 @item -msse
7741 @itemx -mno-sse
7742 @item -msse2
7743 @itemx -mno-sse2
7744 @item -m3dnow
7745 @itemx -mno-3dnow
7746 @opindex mmmx
7747 @opindex mno-mmx
7748 @opindex msse
7749 @opindex mno-sse
7750 @opindex m3dnow
7751 @opindex mno-3dnow
7752 These switches enable or disable the use of built-in functions that allow
7753 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
7754
7755 @xref{X86 Built-in Functions}, for details of the functions enabled
7756 and disabled by these switches.
7757
7758 @item -mpush-args
7759 @itemx -mno-push-args
7760 @opindex mpush-args
7761 @opindex mno-push-args
7762 Use PUSH operations to store outgoing parameters.  This method is shorter
7763 and usually equally fast as method using SUB/MOV operations and is enabled
7764 by default.  In some cases disabling it may improve performance because of
7765 improved scheduling and reduced dependencies.
7766
7767 @item -maccumulate-outgoing-args
7768 @opindex maccumulate-outgoing-args
7769 If enabled, the maximum amount of space required for outgoing arguments will be
7770 computed in the function prologue.  This is faster on most modern CPUs
7771 because of reduced dependencies, improved scheduling and reduced stack usage
7772 when preferred stack boundary is not equal to 2.  The drawback is a notable
7773 increase in code size.  This switch implies @option{-mno-push-args}.
7774
7775 @item -mthreads
7776 @opindex mthreads
7777 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
7778 on thread-safe exception handling must compile and link all code with the
7779 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
7780 @option{-D_MT}; when linking, it links in a special thread helper library
7781 @option{-lmingwthrd} which cleans up per thread exception handling data.
7782
7783 @item -mno-align-stringops
7784 @opindex mno-align-stringops
7785 Do not align destination of inlined string operations.  This switch reduces
7786 code size and improves performance in case the destination is already aligned,
7787 but gcc don't know about it.
7788
7789 @item -minline-all-stringops
7790 @opindex minline-all-stringops
7791 By default GCC inlines string operations only when destination is known to be
7792 aligned at least to 4 byte boundary.  This enables more inlining, increase code
7793 size, but may improve performance of code that depends on fast memcpy, strlen
7794 and memset for short lengths.
7795
7796 @item -momit-leaf-frame-pointer
7797 @opindex momit-leaf-frame-pointer
7798 Don't keep the frame pointer in a register for leaf functions.  This
7799 avoids the instructions to save, set up and restore frame pointers and
7800 makes an extra register available in leaf functions.  The option
7801 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7802 which might make debugging harder.
7803 @end table
7804
7805 These @samp{-m} switches are supported in addition to the above
7806 on AMD x86-64 processors in 64-bit environments.
7807
7808 @table @gcctabopt
7809 @item -m32
7810 @itemx -m64
7811 @opindex m32
7812 @opindex m64
7813 Generate code for a 32-bit or 64-bit environment.
7814 The 32-bit environment sets int, long and pointer to 32 bits and
7815 generates code that runs on any i386 system.
7816 The 64-bit environment sets int to 32 bits and long and pointer
7817 to 64 bits and generates code for AMD's x86-64 architecture.
7818
7819 @item -mno-red-zone
7820 @opindex no-red-zone
7821 Do not use a so called red zone for x86-64 code.  The red zone is mandated
7822 by the x86-64 ABI, it is a 128-byte area beyond the location of the
7823 stack pointer that will not be modified by signal or interrupt handlers
7824 and therefore can be used for temporary data without adjusting the stack
7825 pointer.  The flag @option{-mno-red-zone} disables this red zone.
7826
7827 @item -mcmodel=small
7828 @opindex mcmodel=small
7829 Generate code for the small code model: the program and its symbols must
7830 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
7831 Programs can be statically or dynamically linked.  This is the default
7832 code model.
7833
7834 @item -mcmodel=kernel
7835 @opindex mcmodel=kernel
7836 Generate code for the kernel code model.  The kernel runs in the
7837 negative 2 GB of the address space.
7838 This model has to be used for Linux kernel code.
7839
7840 @item -mcmodel=medium
7841 @opindex mcmodel=medium
7842 Generate code for the medium model: The program is linked in the lower 2
7843 GB of the address space but symbols can be located anywhere in the
7844 address space.  Programs can be statically or dynamically linked, but
7845 building of shared libraries are not supported with the medium model.
7846
7847 @item -mcmodel=large
7848 @opindex mcmodel=large
7849 Generate code for the large model: This model makes no assumptions
7850 about addresses and sizes of sections.  Currently GCC does not implement
7851 this model.
7852 @end table
7853
7854 @node HPPA Options
7855 @subsection HPPA Options
7856 @cindex HPPA Options
7857
7858 These @samp{-m} options are defined for the HPPA family of computers:
7859
7860 @table @gcctabopt
7861 @item -march=@var{architecture-type}
7862 @opindex march
7863 Generate code for the specified architecture.  The choices for
7864 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7865 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7866 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7867 architecture option for your machine.  Code compiled for lower numbered
7868 architectures will run on higher numbered architectures, but not the
7869 other way around.
7870
7871 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
7872 next release of binutils (current is 2.9.1) will probably contain PA 2.0
7873 support.
7874
7875 @item -mpa-risc-1-0
7876 @itemx -mpa-risc-1-1
7877 @itemx -mpa-risc-2-0
7878 @opindex mpa-risc-1-0
7879 @opindex mpa-risc-1-1
7880 @opindex mpa-risc-2-0
7881 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7882
7883 @item -mbig-switch
7884 @opindex mbig-switch
7885 Generate code suitable for big switch tables.  Use this option only if
7886 the assembler/linker complain about out of range branches within a switch
7887 table.
7888
7889 @item -mjump-in-delay
7890 @opindex mjump-in-delay
7891 Fill delay slots of function calls with unconditional jump instructions
7892 by modifying the return pointer for the function call to be the target
7893 of the conditional jump.
7894
7895 @item -mdisable-fpregs
7896 @opindex mdisable-fpregs
7897 Prevent floating point registers from being used in any manner.  This is
7898 necessary for compiling kernels which perform lazy context switching of
7899 floating point registers.  If you use this option and attempt to perform
7900 floating point operations, the compiler will abort.
7901
7902 @item -mdisable-indexing
7903 @opindex mdisable-indexing
7904 Prevent the compiler from using indexing address modes.  This avoids some
7905 rather obscure problems when compiling MIG generated code under MACH@.
7906
7907 @item -mno-space-regs
7908 @opindex mno-space-regs
7909 Generate code that assumes the target has no space registers.  This allows
7910 GCC to generate faster indirect calls and use unscaled index address modes.
7911
7912 Such code is suitable for level 0 PA systems and kernels.
7913
7914 @item -mfast-indirect-calls
7915 @opindex mfast-indirect-calls
7916 Generate code that assumes calls never cross space boundaries.  This
7917 allows GCC to emit code which performs faster indirect calls.
7918
7919 This option will not work in the presence of shared libraries or nested
7920 functions.
7921
7922 @item -mlong-load-store
7923 @opindex mlong-load-store
7924 Generate 3-instruction load and store sequences as sometimes required by
7925 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7926 the HP compilers.
7927
7928 @item -mportable-runtime
7929 @opindex mportable-runtime
7930 Use the portable calling conventions proposed by HP for ELF systems.
7931
7932 @item -mgas
7933 @opindex mgas
7934 Enable the use of assembler directives only GAS understands.
7935
7936 @item -mschedule=@var{cpu-type}
7937 @opindex mschedule
7938 Schedule code according to the constraints for the machine type
7939 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7940 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
7941 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7942 proper scheduling option for your machine.  The default scheduling is
7943 @samp{8000}.
7944
7945 @item -mlinker-opt
7946 @opindex mlinker-opt
7947 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
7948 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
7949 linkers in which they give bogus error messages when linking some programs.
7950
7951 @item -msoft-float
7952 @opindex msoft-float
7953 Generate output containing library calls for floating point.
7954 @strong{Warning:} the requisite libraries are not available for all HPPA
7955 targets.  Normally the facilities of the machine's usual C compiler are
7956 used, but this cannot be done directly in cross-compilation.  You must make
7957 your own arrangements to provide suitable library functions for
7958 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7959 does provide software floating point support.
7960
7961 @option{-msoft-float} changes the calling convention in the output file;
7962 therefore, it is only useful if you compile @emph{all} of a program with
7963 this option.  In particular, you need to compile @file{libgcc.a}, the
7964 library that comes with GCC, with @option{-msoft-float} in order for
7965 this to work.
7966
7967 @item -msio
7968 @opindex msio
7969 Generate the predefine, @code{_SIO}, for server IO.  The default is
7970 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
7971 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
7972 options are available under HP-UX and HI-UX.
7973 @end table
7974
7975 @node Intel 960 Options
7976 @subsection Intel 960 Options
7977
7978 These @samp{-m} options are defined for the Intel 960 implementations:
7979
7980 @table @gcctabopt
7981 @item -m@var{cpu-type}
7982 @opindex mka
7983 @opindex mkb
7984 @opindex mmc
7985 @opindex mca
7986 @opindex mcf
7987 @opindex msa
7988 @opindex msb
7989 Assume the defaults for the machine type @var{cpu-type} for some of
7990 the other options, including instruction scheduling, floating point
7991 support, and addressing modes.  The choices for @var{cpu-type} are
7992 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
7993 @samp{sa}, and @samp{sb}.
7994 The default is
7995 @samp{kb}.
7996
7997 @item -mnumerics
7998 @itemx -msoft-float
7999 @opindex mnumerics
8000 @opindex msoft-float
8001 The @option{-mnumerics} option indicates that the processor does support
8002 floating-point instructions.  The @option{-msoft-float} option indicates
8003 that floating-point support should not be assumed.
8004
8005 @item -mleaf-procedures
8006 @itemx -mno-leaf-procedures
8007 @opindex mleaf-procedures
8008 @opindex mno-leaf-procedures
8009 Do (or do not) attempt to alter leaf procedures to be callable with the
8010 @code{bal} instruction as well as @code{call}.  This will result in more
8011 efficient code for explicit calls when the @code{bal} instruction can be
8012 substituted by the assembler or linker, but less efficient code in other
8013 cases, such as calls via function pointers, or using a linker that doesn't
8014 support this optimization.
8015
8016 @item -mtail-call
8017 @itemx -mno-tail-call
8018 @opindex mtail-call
8019 @opindex mno-tail-call
8020 Do (or do not) make additional attempts (beyond those of the
8021 machine-independent portions of the compiler) to optimize tail-recursive
8022 calls into branches.  You may not want to do this because the detection of
8023 cases where this is not valid is not totally complete.  The default is
8024 @option{-mno-tail-call}.
8025
8026 @item -mcomplex-addr
8027 @itemx -mno-complex-addr
8028 @opindex mcomplex-addr
8029 @opindex mno-complex-addr
8030 Assume (or do not assume) that the use of a complex addressing mode is a
8031 win on this implementation of the i960.  Complex addressing modes may not
8032 be worthwhile on the K-series, but they definitely are on the C-series.
8033 The default is currently @option{-mcomplex-addr} for all processors except
8034 the CB and CC@.
8035
8036 @item -mcode-align
8037 @itemx -mno-code-align
8038 @opindex mcode-align
8039 @opindex mno-code-align
8040 Align code to 8-byte boundaries for faster fetching (or don't bother).
8041 Currently turned on by default for C-series implementations only.
8042
8043 @ignore
8044 @item -mclean-linkage
8045 @itemx -mno-clean-linkage
8046 @opindex mclean-linkage
8047 @opindex mno-clean-linkage
8048 These options are not fully implemented.
8049 @end ignore
8050
8051 @item -mic-compat
8052 @itemx -mic2.0-compat
8053 @itemx -mic3.0-compat
8054 @opindex mic-compat
8055 @opindex mic2.0-compat
8056 @opindex mic3.0-compat
8057 Enable compatibility with iC960 v2.0 or v3.0.
8058
8059 @item -masm-compat
8060 @itemx -mintel-asm
8061 @opindex masm-compat
8062 @opindex mintel-asm
8063 Enable compatibility with the iC960 assembler.
8064
8065 @item -mstrict-align
8066 @itemx -mno-strict-align
8067 @opindex mstrict-align
8068 @opindex mno-strict-align
8069 Do not permit (do permit) unaligned accesses.
8070
8071 @item -mold-align
8072 @opindex mold-align
8073 Enable structure-alignment compatibility with Intel's gcc release version
8074 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8075
8076 @item -mlong-double-64
8077 @opindex mlong-double-64
8078 Implement type @samp{long double} as 64-bit floating point numbers.
8079 Without the option @samp{long double} is implemented by 80-bit
8080 floating point numbers.  The only reason we have it because there is
8081 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8082 is only useful for people using soft-float targets.  Otherwise, we
8083 should recommend against use of it.
8084
8085 @end table
8086
8087 @node DEC Alpha Options
8088 @subsection DEC Alpha Options
8089
8090 These @samp{-m} options are defined for the DEC Alpha implementations:
8091
8092 @table @gcctabopt
8093 @item -mno-soft-float
8094 @itemx -msoft-float
8095 @opindex mno-soft-float
8096 @opindex msoft-float
8097 Use (do not use) the hardware floating-point instructions for
8098 floating-point operations.  When @option{-msoft-float} is specified,
8099 functions in @file{libgcc.a} will be used to perform floating-point
8100 operations.  Unless they are replaced by routines that emulate the
8101 floating-point operations, or compiled in such a way as to call such
8102 emulations routines, these routines will issue floating-point
8103 operations.   If you are compiling for an Alpha without floating-point
8104 operations, you must ensure that the library is built so as not to call
8105 them.
8106
8107 Note that Alpha implementations without floating-point operations are
8108 required to have floating-point registers.
8109
8110 @item -mfp-reg
8111 @itemx -mno-fp-regs
8112 @opindex mfp-reg
8113 @opindex mno-fp-regs
8114 Generate code that uses (does not use) the floating-point register set.
8115 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8116 register set is not used, floating point operands are passed in integer
8117 registers as if they were integers and floating-point results are passed
8118 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8119 so any function with a floating-point argument or return value called by code
8120 compiled with @option{-mno-fp-regs} must also be compiled with that
8121 option.
8122
8123 A typical use of this option is building a kernel that does not use,
8124 and hence need not save and restore, any floating-point registers.
8125
8126 @item -mieee
8127 @opindex mieee
8128 The Alpha architecture implements floating-point hardware optimized for
8129 maximum performance.  It is mostly compliant with the IEEE floating
8130 point standard.  However, for full compliance, software assistance is
8131 required.  This option generates code fully IEEE compliant code
8132 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8133 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8134 defined during compilation.  The resulting code is less efficient but is
8135 able to correctly support denormalized numbers and exceptional IEEE
8136 values such as not-a-number and plus/minus infinity.  Other Alpha
8137 compilers call this option @option{-ieee_with_no_inexact}.
8138
8139 @item -mieee-with-inexact
8140 @opindex mieee-with-inexact
8141 This is like @option{-mieee} except the generated code also maintains
8142 the IEEE @var{inexact-flag}.  Turning on this option causes the
8143 generated code to implement fully-compliant IEEE math.  In addition to
8144 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8145 macro.  On some Alpha implementations the resulting code may execute
8146 significantly slower than the code generated by default.  Since there is
8147 very little code that depends on the @var{inexact-flag}, you should
8148 normally not specify this option.  Other Alpha compilers call this
8149 option @option{-ieee_with_inexact}.
8150
8151 @item -mfp-trap-mode=@var{trap-mode}
8152 @opindex mfp-trap-mode
8153 This option controls what floating-point related traps are enabled.
8154 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8155 The trap mode can be set to one of four values:
8156
8157 @table @samp
8158 @item n
8159 This is the default (normal) setting.  The only traps that are enabled
8160 are the ones that cannot be disabled in software (e.g., division by zero
8161 trap).
8162
8163 @item u
8164 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8165 as well.
8166
8167 @item su
8168 Like @samp{su}, but the instructions are marked to be safe for software
8169 completion (see Alpha architecture manual for details).
8170
8171 @item sui
8172 Like @samp{su}, but inexact traps are enabled as well.
8173 @end table
8174
8175 @item -mfp-rounding-mode=@var{rounding-mode}
8176 @opindex mfp-rounding-mode
8177 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8178 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8179 of:
8180
8181 @table @samp
8182 @item n
8183 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8184 the nearest machine number or towards the even machine number in case
8185 of a tie.
8186
8187 @item m
8188 Round towards minus infinity.
8189
8190 @item c
8191 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8192
8193 @item d
8194 Dynamic rounding mode.  A field in the floating point control register
8195 (@var{fpcr}, see Alpha architecture reference manual) controls the
8196 rounding mode in effect.  The C library initializes this register for
8197 rounding towards plus infinity.  Thus, unless your program modifies the
8198 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8199 @end table
8200
8201 @item -mtrap-precision=@var{trap-precision}
8202 @opindex mtrap-precision
8203 In the Alpha architecture, floating point traps are imprecise.  This
8204 means without software assistance it is impossible to recover from a
8205 floating trap and program execution normally needs to be terminated.
8206 GCC can generate code that can assist operating system trap handlers
8207 in determining the exact location that caused a floating point trap.
8208 Depending on the requirements of an application, different levels of
8209 precisions can be selected:
8210
8211 @table @samp
8212 @item p
8213 Program precision.  This option is the default and means a trap handler
8214 can only identify which program caused a floating point exception.
8215
8216 @item f
8217 Function precision.  The trap handler can determine the function that
8218 caused a floating point exception.
8219
8220 @item i
8221 Instruction precision.  The trap handler can determine the exact
8222 instruction that caused a floating point exception.
8223 @end table
8224
8225 Other Alpha compilers provide the equivalent options called
8226 @option{-scope_safe} and @option{-resumption_safe}.
8227
8228 @item -mieee-conformant
8229 @opindex mieee-conformant
8230 This option marks the generated code as IEEE conformant.  You must not
8231 use this option unless you also specify @option{-mtrap-precision=i} and either
8232 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8233 is to emit the line @samp{.eflag 48} in the function prologue of the
8234 generated assembly file.  Under DEC Unix, this has the effect that
8235 IEEE-conformant math library routines will be linked in.
8236
8237 @item -mbuild-constants
8238 @opindex mbuild-constants
8239 Normally GCC examines a 32- or 64-bit integer constant to
8240 see if it can construct it from smaller constants in two or three
8241 instructions.  If it cannot, it will output the constant as a literal and
8242 generate code to load it from the data segment at runtime.
8243
8244 Use this option to require GCC to construct @emph{all} integer constants
8245 using code, even if it takes more instructions (the maximum is six).
8246
8247 You would typically use this option to build a shared library dynamic
8248 loader.  Itself a shared library, it must relocate itself in memory
8249 before it can find the variables and constants in its own data segment.
8250
8251 @item -malpha-as
8252 @itemx -mgas
8253 @opindex malpha-as
8254 @opindex mgas
8255 Select whether to generate code to be assembled by the vendor-supplied
8256 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8257
8258 @item -mbwx
8259 @itemx -mno-bwx
8260 @itemx -mcix
8261 @itemx -mno-cix
8262 @itemx -mfix
8263 @itemx -mno-fix
8264 @itemx -mmax
8265 @itemx -mno-max
8266 @opindex mbwx
8267 @opindex mno-bwx
8268 @opindex mcix
8269 @opindex mno-cix
8270 @opindex mfix
8271 @opindex mno-fix
8272 @opindex mmax
8273 @opindex mno-max
8274 Indicate whether GCC should generate code to use the optional BWX,
8275 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8276 sets supported by the CPU type specified via @option{-mcpu=} option or that
8277 of the CPU on which GCC was built if none was specified.
8278
8279 @item -mfloat-vax
8280 @itemx -mfloat-ieee
8281 @opindex mfloat-vax
8282 @opindex mfloat-ieee
8283 Generate code that uses (does not use) VAX F and G floating point
8284 arithmetic instead of IEEE single and double precision.
8285
8286 @item -mexplicit-relocs
8287 @itemx -mno-explicit-relocs
8288 @opindex mexplicit-relocs
8289 @opindex mno-explicit-relocs
8290 Older Alpha assemblers provided no way to generate symbol relocations
8291 except via assembler macros.  Use of these macros does not allow
8292 optimial instruction scheduling.  GNU binutils as of version 2.12
8293 supports a new syntax that allows the compiler to explicitly mark
8294 which relocations should apply to which instructions.  This option
8295 is mostly useful for debugging, as GCC detects the capabilities of
8296 the assembler when it is built and sets the default accordingly.
8297
8298 @item -msmall-data
8299 @itemx -mlarge-data
8300 @opindex msmall-data
8301 @opindex mlarge-data
8302 When @option{-mexplicit-relocs} is in effect, static data is
8303 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8304 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8305 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8306 16-bit relocations off of the @code{$gp} register.  This limits the
8307 size of the small data area to 64KB, but allows the variables to be
8308 directly accessed via a single instruction.
8309
8310 The default is @option{-mlarge-data}.  With this option the data area
8311 is limited to just below 2GB.  Programs that require more than 2GB of
8312 data must use @code{malloc} or @code{mmap} to allocate the data in the
8313 heap instead of in the program's data segment.
8314
8315 When generating code for shared libraries, @option{-fpic} implies
8316 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8317
8318 @item -mcpu=@var{cpu_type}
8319 @opindex mcpu
8320 Set the instruction set and instruction scheduling parameters for
8321 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8322 style name or the corresponding chip number.  GCC supports scheduling
8323 parameters for the EV4, EV5 and EV6 family of processors and will
8324 choose the default values for the instruction set from the processor
8325 you specify.  If you do not specify a processor type, GCC will default
8326 to the processor on which the compiler was built.
8327
8328 Supported values for @var{cpu_type} are
8329
8330 @table @samp
8331 @item ev4
8332 @item ev45
8333 @itemx 21064
8334 Schedules as an EV4 and has no instruction set extensions.
8335
8336 @item ev5
8337 @itemx 21164
8338 Schedules as an EV5 and has no instruction set extensions.
8339
8340 @item ev56
8341 @itemx 21164a
8342 Schedules as an EV5 and supports the BWX extension.
8343
8344 @item pca56
8345 @itemx 21164pc
8346 @itemx 21164PC
8347 Schedules as an EV5 and supports the BWX and MAX extensions.
8348
8349 @item ev6
8350 @itemx 21264
8351 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8352
8353 @item ev67
8354 @item 21264a
8355 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8356 @end table
8357
8358 @item -mtune=@var{cpu_type}
8359 @opindex mtune
8360 Set only the instruction scheduling parameters for machine type
8361 @var{cpu_type}.  The instruction set is not changed.
8362
8363 @item -mmemory-latency=@var{time}
8364 @opindex mmemory-latency
8365 Sets the latency the scheduler should assume for typical memory
8366 references as seen by the application.  This number is highly
8367 dependent on the memory access patterns used by the application
8368 and the size of the external cache on the machine.
8369
8370 Valid options for @var{time} are
8371
8372 @table @samp
8373 @item @var{number}
8374 A decimal number representing clock cycles.
8375
8376 @item L1
8377 @itemx L2
8378 @itemx L3
8379 @itemx main
8380 The compiler contains estimates of the number of clock cycles for
8381 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8382 (also called Dcache, Scache, and Bcache), as well as to main memory.
8383 Note that L3 is only valid for EV5.
8384
8385 @end table
8386 @end table
8387
8388 @node DEC Alpha/VMS Options
8389 @subsection DEC Alpha/VMS Options
8390
8391 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8392
8393 @table @gcctabopt
8394 @item -mvms-return-codes
8395 @opindex mvms-return-codes
8396 Return VMS condition codes from main.  The default is to return POSIX
8397 style condition (e.g.@ error) codes.
8398 @end table
8399
8400 @node Clipper Options
8401 @subsection Clipper Options
8402
8403 These @samp{-m} options are defined for the Clipper implementations:
8404
8405 @table @gcctabopt
8406 @item -mc300
8407 @opindex mc300
8408 Produce code for a C300 Clipper processor.  This is the default.
8409
8410 @item -mc400
8411 @opindex mc400
8412 Produce code for a C400 Clipper processor, i.e.@: use floating point
8413 registers f8--f15.
8414 @end table
8415
8416 @node H8/300 Options
8417 @subsection H8/300 Options
8418
8419 These @samp{-m} options are defined for the H8/300 implementations:
8420
8421 @table @gcctabopt
8422 @item -mrelax
8423 @opindex mrelax
8424 Shorten some address references at link time, when possible; uses the
8425 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8426 ld.info, Using ld}, for a fuller description.
8427
8428 @item -mh
8429 @opindex mh
8430 Generate code for the H8/300H@.
8431
8432 @item -ms
8433 @opindex ms
8434 Generate code for the H8S@.
8435
8436 @item -ms2600
8437 @opindex ms2600
8438 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8439
8440 @item -mint32
8441 @opindex mint32
8442 Make @code{int} data 32 bits by default.
8443
8444 @item -malign-300
8445 @opindex malign-300
8446 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8447 The default for the H8/300H and H8S is to align longs and floats on 4
8448 byte boundaries.
8449 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8450 This option has no effect on the H8/300.
8451 @end table
8452
8453 @node SH Options
8454 @subsection SH Options
8455
8456 These @samp{-m} options are defined for the SH implementations:
8457
8458 @table @gcctabopt
8459 @item -m1
8460 @opindex m1
8461 Generate code for the SH1.
8462
8463 @item -m2
8464 @opindex m2
8465 Generate code for the SH2.
8466
8467 @item -m3
8468 @opindex m3
8469 Generate code for the SH3.
8470
8471 @item -m3e
8472 @opindex m3e
8473 Generate code for the SH3e.
8474
8475 @item -m4-nofpu
8476 @opindex m4-nofpu
8477 Generate code for the SH4 without a floating-point unit.
8478
8479 @item -m4-single-only
8480 @opindex m4-single-only
8481 Generate code for the SH4 with a floating-point unit that only
8482 supports single-precision arithmetic.
8483
8484 @item -m4-single
8485 @opindex m4-single
8486 Generate code for the SH4 assuming the floating-point unit is in
8487 single-precision mode by default.
8488
8489 @item -m4
8490 @opindex m4
8491 Generate code for the SH4.
8492
8493 @item -mb
8494 @opindex mb
8495 Compile code for the processor in big endian mode.
8496
8497 @item -ml
8498 @opindex ml
8499 Compile code for the processor in little endian mode.
8500
8501 @item -mdalign
8502 @opindex mdalign
8503 Align doubles at 64-bit boundaries.  Note that this changes the calling
8504 conventions, and thus some functions from the standard C library will
8505 not work unless you recompile it first with @option{-mdalign}.
8506
8507 @item -mrelax
8508 @opindex mrelax
8509 Shorten some address references at link time, when possible; uses the
8510 linker option @option{-relax}.
8511
8512 @item -mbigtable
8513 @opindex mbigtable
8514 Use 32-bit offsets in @code{switch} tables.  The default is to use
8515 16-bit offsets.
8516
8517 @item -mfmovd
8518 @opindex mfmovd
8519 Enable the use of the instruction @code{fmovd}.
8520
8521 @item -mhitachi
8522 @opindex mhitachi
8523 Comply with the calling conventions defined by Hitachi.
8524
8525 @item -mnomacsave
8526 @opindex mnomacsave
8527 Mark the @code{MAC} register as call-clobbered, even if
8528 @option{-mhitachi} is given.
8529
8530 @item -mieee
8531 @opindex mieee
8532 Increase IEEE-compliance of floating-point code.
8533
8534 @item -misize
8535 @opindex misize
8536 Dump instruction size and location in the assembly code.
8537
8538 @item -mpadstruct
8539 @opindex mpadstruct
8540 This option is deprecated.  It pads structures to multiple of 4 bytes,
8541 which is incompatible with the SH ABI@.
8542
8543 @item -mspace
8544 @opindex mspace
8545 Optimize for space instead of speed.  Implied by @option{-Os}.
8546
8547 @item -mprefergot
8548 @opindex mprefergot
8549 When generating position-independent code, emit function calls using
8550 the Global Offset Table instead of the Procedure Linkage Table.
8551
8552 @item -musermode
8553 @opindex musermode
8554 Generate a library function call to invalidate instruction cache
8555 entries, after fixing up a trampoline.  This library function call
8556 doesn't assume it can write to the whole memory address space.  This
8557 is the default when the target is @code{sh-*-linux*}.
8558 @end table
8559
8560 @node System V Options
8561 @subsection Options for System V
8562
8563 These additional options are available on System V Release 4 for
8564 compatibility with other compilers on those systems:
8565
8566 @table @gcctabopt
8567 @item -G
8568 @opindex G
8569 Create a shared object.
8570 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8571
8572 @item -Qy
8573 @opindex Qy
8574 Identify the versions of each tool used by the compiler, in a
8575 @code{.ident} assembler directive in the output.
8576
8577 @item -Qn
8578 @opindex Qn
8579 Refrain from adding @code{.ident} directives to the output file (this is
8580 the default).
8581
8582 @item -YP,@var{dirs}
8583 @opindex YP
8584 Search the directories @var{dirs}, and no others, for libraries
8585 specified with @option{-l}.
8586
8587 @item -Ym,@var{dir}
8588 @opindex Ym
8589 Look in the directory @var{dir} to find the M4 preprocessor.
8590 The assembler uses this option.
8591 @c This is supposed to go with a -Yd for predefined M4 macro files, but
8592 @c the generic assembler that comes with Solaris takes just -Ym.
8593 @end table
8594
8595 @node TMS320C3x/C4x Options
8596 @subsection TMS320C3x/C4x Options
8597 @cindex TMS320C3x/C4x Options
8598
8599 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8600
8601 @table @gcctabopt
8602
8603 @item -mcpu=@var{cpu_type}
8604 @opindex mcpu
8605 Set the instruction set, register set, and instruction scheduling
8606 parameters for machine type @var{cpu_type}.  Supported values for
8607 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8608 @samp{c44}.  The default is @samp{c40} to generate code for the
8609 TMS320C40.
8610
8611 @item -mbig-memory
8612 @item -mbig
8613 @itemx -msmall-memory
8614 @itemx -msmall
8615 @opindex mbig-memory
8616 @opindex mbig
8617 @opindex msmall-memory
8618 @opindex msmall
8619 Generates code for the big or small memory model.  The small memory
8620 model assumed that all data fits into one 64K word page.  At run-time
8621 the data page (DP) register must be set to point to the 64K page
8622 containing the .bss and .data program sections.  The big memory model is
8623 the default and requires reloading of the DP register for every direct
8624 memory access.
8625
8626 @item -mbk
8627 @itemx -mno-bk
8628 @opindex mbk
8629 @opindex mno-bk
8630 Allow (disallow) allocation of general integer operands into the block
8631 count register BK@.
8632
8633 @item -mdb
8634 @itemx -mno-db
8635 @opindex mdb
8636 @opindex mno-db
8637 Enable (disable) generation of code using decrement and branch,
8638 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
8639 on the safe side, this is disabled for the C3x, since the maximum
8640 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
8641 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
8642 that it can utilize the decrement and branch instruction, but will give
8643 up if there is more than one memory reference in the loop.  Thus a loop
8644 where the loop counter is decremented can generate slightly more
8645 efficient code, in cases where the RPTB instruction cannot be utilized.
8646
8647 @item -mdp-isr-reload
8648 @itemx -mparanoid
8649 @opindex mdp-isr-reload
8650 @opindex mparanoid
8651 Force the DP register to be saved on entry to an interrupt service
8652 routine (ISR), reloaded to point to the data section, and restored on
8653 exit from the ISR@.  This should not be required unless someone has
8654 violated the small memory model by modifying the DP register, say within
8655 an object library.
8656
8657 @item -mmpyi
8658 @itemx -mno-mpyi
8659 @opindex mmpyi
8660 @opindex mno-mpyi
8661 For the C3x use the 24-bit MPYI instruction for integer multiplies
8662 instead of a library call to guarantee 32-bit results.  Note that if one
8663 of the operands is a constant, then the multiplication will be performed
8664 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
8665 then squaring operations are performed inline instead of a library call.
8666
8667 @item -mfast-fix
8668 @itemx -mno-fast-fix
8669 @opindex mfast-fix
8670 @opindex mno-fast-fix
8671 The C3x/C4x FIX instruction to convert a floating point value to an
8672 integer value chooses the nearest integer less than or equal to the
8673 floating point value rather than to the nearest integer.  Thus if the
8674 floating point number is negative, the result will be incorrectly
8675 truncated an additional code is necessary to detect and correct this
8676 case.  This option can be used to disable generation of the additional
8677 code required to correct the result.
8678
8679 @item -mrptb
8680 @itemx -mno-rptb
8681 @opindex mrptb
8682 @opindex mno-rptb
8683 Enable (disable) generation of repeat block sequences using the RPTB
8684 instruction for zero overhead looping.  The RPTB construct is only used
8685 for innermost loops that do not call functions or jump across the loop
8686 boundaries.  There is no advantage having nested RPTB loops due to the
8687 overhead required to save and restore the RC, RS, and RE registers.
8688 This is enabled by default with @option{-O2}.
8689
8690 @item -mrpts=@var{count}
8691 @itemx -mno-rpts
8692 @opindex mrpts
8693 @opindex mno-rpts
8694 Enable (disable) the use of the single instruction repeat instruction
8695 RPTS@.  If a repeat block contains a single instruction, and the loop
8696 count can be guaranteed to be less than the value @var{count}, GCC will
8697 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
8698 then a RPTS will be emitted even if the loop count cannot be determined
8699 at compile time.  Note that the repeated instruction following RPTS does
8700 not have to be reloaded from memory each iteration, thus freeing up the
8701 CPU buses for operands.  However, since interrupts are blocked by this
8702 instruction, it is disabled by default.
8703
8704 @item -mloop-unsigned
8705 @itemx -mno-loop-unsigned
8706 @opindex mloop-unsigned
8707 @opindex mno-loop-unsigned
8708 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
8709 is @math{2^{31} + 1} since these instructions test if the iteration count is
8710 negative to terminate the loop.  If the iteration count is unsigned
8711 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
8712 exceeded.  This switch allows an unsigned iteration count.
8713
8714 @item -mti
8715 @opindex mti
8716 Try to emit an assembler syntax that the TI assembler (asm30) is happy
8717 with.  This also enforces compatibility with the API employed by the TI
8718 C3x C compiler.  For example, long doubles are passed as structures
8719 rather than in floating point registers.
8720
8721 @item -mregparm
8722 @itemx -mmemparm
8723 @opindex mregparm
8724 @opindex mmemparm
8725 Generate code that uses registers (stack) for passing arguments to functions.
8726 By default, arguments are passed in registers where possible rather
8727 than by pushing arguments on to the stack.
8728
8729 @item -mparallel-insns
8730 @itemx -mno-parallel-insns
8731 @opindex mparallel-insns
8732 @opindex mno-parallel-insns
8733 Allow the generation of parallel instructions.  This is enabled by
8734 default with @option{-O2}.
8735
8736 @item -mparallel-mpy
8737 @itemx -mno-parallel-mpy
8738 @opindex mparallel-mpy
8739 @opindex mno-parallel-mpy
8740 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
8741 provided @option{-mparallel-insns} is also specified.  These instructions have
8742 tight register constraints which can pessimize the code generation
8743 of large functions.
8744
8745 @end table
8746
8747 @node V850 Options
8748 @subsection V850 Options
8749 @cindex V850 Options
8750
8751 These @samp{-m} options are defined for V850 implementations:
8752
8753 @table @gcctabopt
8754 @item -mlong-calls
8755 @itemx -mno-long-calls
8756 @opindex mlong-calls
8757 @opindex mno-long-calls
8758 Treat all calls as being far away (near).  If calls are assumed to be
8759 far away, the compiler will always load the functions address up into a
8760 register, and call indirect through the pointer.
8761
8762 @item -mno-ep
8763 @itemx -mep
8764 @opindex mno-ep
8765 @opindex mep
8766 Do not optimize (do optimize) basic blocks that use the same index
8767 pointer 4 or more times to copy pointer into the @code{ep} register, and
8768 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
8769 option is on by default if you optimize.
8770
8771 @item -mno-prolog-function
8772 @itemx -mprolog-function
8773 @opindex mno-prolog-function
8774 @opindex mprolog-function
8775 Do not use (do use) external functions to save and restore registers at
8776 the prolog and epilog of a function.  The external functions are slower,
8777 but use less code space if more than one function saves the same number
8778 of registers.  The @option{-mprolog-function} option is on by default if
8779 you optimize.
8780
8781 @item -mspace
8782 @opindex mspace
8783 Try to make the code as small as possible.  At present, this just turns
8784 on the @option{-mep} and @option{-mprolog-function} options.
8785
8786 @item -mtda=@var{n}
8787 @opindex mtda
8788 Put static or global variables whose size is @var{n} bytes or less into
8789 the tiny data area that register @code{ep} points to.  The tiny data
8790 area can hold up to 256 bytes in total (128 bytes for byte references).
8791
8792 @item -msda=@var{n}
8793 @opindex msda
8794 Put static or global variables whose size is @var{n} bytes or less into
8795 the small data area that register @code{gp} points to.  The small data
8796 area can hold up to 64 kilobytes.
8797
8798 @item -mzda=@var{n}
8799 @opindex mzda
8800 Put static or global variables whose size is @var{n} bytes or less into
8801 the first 32 kilobytes of memory.
8802
8803 @item -mv850
8804 @opindex mv850
8805 Specify that the target processor is the V850.
8806
8807 @item -mbig-switch
8808 @opindex mbig-switch
8809 Generate code suitable for big switch tables.  Use this option only if
8810 the assembler/linker complain about out of range branches within a switch
8811 table.
8812
8813 @item -mapp-regs
8814 @opindex -mapp-regs
8815 This option will cause r2 and r5 to be used in the code generated by
8816 the compiler.  This setting is the default.
8817
8818 @item -mno-app-regs
8819 @opindex -mno-app-regs
8820 This option will cause r2 and r5 to be treated as fixed registers.
8821   
8822 @item -mv850e
8823 @opindex -mv850e
8824 Specify that the target processor is the V850E.  The preprocessor
8825 constant @samp{__v850e__} will be defined if this option is used.
8826
8827 If neither @option{-mv850} nor @option{-mv850e} are defined
8828 then a default target processor will be chosen and the relevant
8829 @samp{__v850*__} preprocessor constant will be defined.
8830
8831 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
8832 defined, regardless of which processor variant is the target.
8833
8834 @item -mdisable-callt
8835 @opindex -mdisable-callt
8836 This option will suppress generation of the CALLT instruction for the
8837 v850e flavors of the v850 architecture.  The default is
8838 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
8839
8840 @end table
8841
8842 @node ARC Options
8843 @subsection ARC Options
8844 @cindex ARC Options
8845
8846 These options are defined for ARC implementations:
8847
8848 @table @gcctabopt
8849 @item -EL
8850 @opindex EL
8851 Compile code for little endian mode.  This is the default.
8852
8853 @item -EB
8854 @opindex EB
8855 Compile code for big endian mode.
8856
8857 @item -mmangle-cpu
8858 @opindex mmangle-cpu
8859 Prepend the name of the cpu to all public symbol names.
8860 In multiple-processor systems, there are many ARC variants with different
8861 instruction and register set characteristics.  This flag prevents code
8862 compiled for one cpu to be linked with code compiled for another.
8863 No facility exists for handling variants that are ``almost identical''.
8864 This is an all or nothing option.
8865
8866 @item -mcpu=@var{cpu}
8867 @opindex mcpu
8868 Compile code for ARC variant @var{cpu}.
8869 Which variants are supported depend on the configuration.
8870 All variants support @option{-mcpu=base}, this is the default.
8871
8872 @item -mtext=@var{text-section}
8873 @itemx -mdata=@var{data-section}
8874 @itemx -mrodata=@var{readonly-data-section}
8875 @opindex mtext
8876 @opindex mdata
8877 @opindex mrodata
8878 Put functions, data, and readonly data in @var{text-section},
8879 @var{data-section}, and @var{readonly-data-section} respectively
8880 by default.  This can be overridden with the @code{section} attribute.
8881 @xref{Variable Attributes}.
8882
8883 @end table
8884
8885 @node NS32K Options
8886 @subsection NS32K Options
8887 @cindex NS32K options
8888
8889 These are the @samp{-m} options defined for the 32000 series.  The default
8890 values for these options depends on which style of 32000 was selected when
8891 the compiler was configured; the defaults for the most common choices are
8892 given below.
8893
8894 @table @gcctabopt
8895 @item -m32032
8896 @itemx -m32032
8897 @opindex m32032
8898 @opindex m32032
8899 Generate output for a 32032.  This is the default
8900 when the compiler is configured for 32032 and 32016 based systems.
8901
8902 @item -m32332
8903 @itemx -m32332
8904 @opindex m32332
8905 @opindex m32332
8906 Generate output for a 32332.  This is the default
8907 when the compiler is configured for 32332-based systems.
8908
8909 @item -m32532
8910 @itemx -m32532
8911 @opindex m32532
8912 @opindex m32532
8913 Generate output for a 32532.  This is the default
8914 when the compiler is configured for 32532-based systems.
8915
8916 @item -m32081
8917 @opindex m32081
8918 Generate output containing 32081 instructions for floating point.
8919 This is the default for all systems.
8920
8921 @item -m32381
8922 @opindex m32381
8923 Generate output containing 32381 instructions for floating point.  This
8924 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
8925 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
8926
8927 @item -mmulti-add
8928 @opindex mmulti-add
8929 Try and generate multiply-add floating point instructions @code{polyF}
8930 and @code{dotF}.  This option is only available if the @option{-m32381}
8931 option is in effect.  Using these instructions requires changes to
8932 register allocation which generally has a negative impact on
8933 performance.  This option should only be enabled when compiling code
8934 particularly likely to make heavy use of multiply-add instructions.
8935
8936 @item -mnomulti-add
8937 @opindex mnomulti-add
8938 Do not try and generate multiply-add floating point instructions
8939 @code{polyF} and @code{dotF}.  This is the default on all platforms.
8940
8941 @item -msoft-float
8942 @opindex msoft-float
8943 Generate output containing library calls for floating point.
8944 @strong{Warning:} the requisite libraries may not be available.
8945
8946 @item -mieee-compare
8947 @itemx -mno-ieee-compare
8948 @opindex mieee-compare
8949 @opindex mno-ieee-compare
8950 Control whether or not the compiler uses IEEE floating point
8951 comparisons.  These handle correctly the case where the result of a
8952 comparison is unordered.
8953 @strong{Warning:} the requisite kernel support may not be available.
8954
8955 @item -mnobitfield
8956 @opindex mnobitfield
8957 Do not use the bit-field instructions.  On some machines it is faster to
8958 use shifting and masking operations.  This is the default for the pc532.
8959
8960 @item -mbitfield
8961 @opindex mbitfield
8962 Do use the bit-field instructions.  This is the default for all platforms
8963 except the pc532.
8964
8965 @item -mrtd
8966 @opindex mrtd
8967 Use a different function-calling convention, in which functions
8968 that take a fixed number of arguments return pop their
8969 arguments on return with the @code{ret} instruction.
8970
8971 This calling convention is incompatible with the one normally
8972 used on Unix, so you cannot use it if you need to call libraries
8973 compiled with the Unix compiler.
8974
8975 Also, you must provide function prototypes for all functions that
8976 take variable numbers of arguments (including @code{printf});
8977 otherwise incorrect code will be generated for calls to those
8978 functions.
8979
8980 In addition, seriously incorrect code will result if you call a
8981 function with too many arguments.  (Normally, extra arguments are
8982 harmlessly ignored.)
8983
8984 This option takes its name from the 680x0 @code{rtd} instruction.
8985
8986
8987 @item -mregparam
8988 @opindex mregparam
8989 Use a different function-calling convention where the first two arguments
8990 are passed in registers.
8991
8992 This calling convention is incompatible with the one normally
8993 used on Unix, so you cannot use it if you need to call libraries
8994 compiled with the Unix compiler.
8995
8996 @item -mnoregparam
8997 @opindex mnoregparam
8998 Do not pass any arguments in registers.  This is the default for all
8999 targets.
9000
9001 @item -msb
9002 @opindex msb
9003 It is OK to use the sb as an index register which is always loaded with
9004 zero.  This is the default for the pc532-netbsd target.
9005
9006 @item -mnosb
9007 @opindex mnosb
9008 The sb register is not available for use or has not been initialized to
9009 zero by the run time system.  This is the default for all targets except
9010 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9011 @option{-fpic} is set.
9012
9013 @item -mhimem
9014 @opindex mhimem
9015 Many ns32000 series addressing modes use displacements of up to 512MB@.
9016 If an address is above 512MB then displacements from zero can not be used.
9017 This option causes code to be generated which can be loaded above 512MB@.
9018 This may be useful for operating systems or ROM code.
9019
9020 @item -mnohimem
9021 @opindex mnohimem
9022 Assume code will be loaded in the first 512MB of virtual address space.
9023 This is the default for all platforms.
9024
9025
9026 @end table
9027
9028 @node AVR Options
9029 @subsection AVR Options
9030 @cindex AVR Options
9031
9032 These options are defined for AVR implementations:
9033
9034 @table @gcctabopt
9035 @item -mmcu=@var{mcu}
9036 @opindex mmcu
9037 Specify ATMEL AVR instruction set or MCU type.
9038
9039 Instruction set avr1 is for the minimal AVR core, not supported by the C
9040 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9041 attiny11, attiny12, attiny15, attiny28).
9042
9043 Instruction set avr2 (default) is for the classic AVR core with up to
9044 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9045 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9046 at90c8534, at90s8535).
9047
9048 Instruction set avr3 is for the classic AVR core with up to 128K program
9049 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9050
9051 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9052 memory space (MCU types: atmega8, atmega83, atmega85).
9053
9054 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9055 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9056 atmega64, atmega128, at43usb355, at94k).
9057
9058 @item -msize
9059 @opindex msize
9060 Output instruction sizes to the asm file.
9061
9062 @item -minit-stack=@var{N}
9063 @opindex minit-stack
9064 Specify the initial stack address, which may be a symbol or numeric value,
9065 @samp{__stack} is the default.
9066
9067 @item -mno-interrupts
9068 @opindex mno-interrupts
9069 Generated code is not compatible with hardware interrupts.
9070 Code size will be smaller.
9071
9072 @item -mcall-prologues
9073 @opindex mcall-prologues
9074 Functions prologues/epilogues expanded as call to appropriate
9075 subroutines.  Code size will be smaller.
9076
9077 @item -mno-tablejump
9078 @opindex mno-tablejump
9079 Do not generate tablejump insns which sometimes increase code size.
9080
9081 @item -mtiny-stack
9082 @opindex mtiny-stack
9083 Change only the low 8 bits of the stack pointer.
9084 @end table
9085
9086 @node MCore Options
9087 @subsection MCore Options
9088 @cindex MCore options
9089
9090 These are the @samp{-m} options defined for the Motorola M*Core
9091 processors.
9092
9093 @table @gcctabopt
9094
9095 @item -mhardlit
9096 @itemx -mhardlit
9097 @itemx -mno-hardlit
9098 @opindex mhardlit
9099 @opindex mhardlit
9100 @opindex mno-hardlit
9101 Inline constants into the code stream if it can be done in two
9102 instructions or less.
9103
9104 @item -mdiv
9105 @itemx -mdiv
9106 @itemx -mno-div
9107 @opindex mdiv
9108 @opindex mdiv
9109 @opindex mno-div
9110 Use the divide instruction.  (Enabled by default).
9111
9112 @item -mrelax-immediate
9113 @itemx -mrelax-immediate
9114 @itemx -mno-relax-immediate
9115 @opindex mrelax-immediate
9116 @opindex mrelax-immediate
9117 @opindex mno-relax-immediate
9118 Allow arbitrary sized immediates in bit operations.
9119
9120 @item -mwide-bitfields
9121 @itemx -mwide-bitfields
9122 @itemx -mno-wide-bitfields
9123 @opindex mwide-bitfields
9124 @opindex mwide-bitfields
9125 @opindex mno-wide-bitfields
9126 Always treat bit-fields as int-sized.
9127
9128 @item -m4byte-functions
9129 @itemx -m4byte-functions
9130 @itemx -mno-4byte-functions
9131 @opindex m4byte-functions
9132 @opindex m4byte-functions
9133 @opindex mno-4byte-functions
9134 Force all functions to be aligned to a four byte boundary.
9135
9136 @item -mcallgraph-data
9137 @itemx -mcallgraph-data
9138 @itemx -mno-callgraph-data
9139 @opindex mcallgraph-data
9140 @opindex mcallgraph-data
9141 @opindex mno-callgraph-data
9142 Emit callgraph information.
9143
9144 @item -mslow-bytes
9145 @itemx -mslow-bytes
9146 @itemx -mno-slow-bytes
9147 @opindex mslow-bytes
9148 @opindex mslow-bytes
9149 @opindex mno-slow-bytes
9150 Prefer word access when reading byte quantities.
9151
9152 @item -mlittle-endian
9153 @itemx -mlittle-endian
9154 @itemx -mbig-endian
9155 @opindex mlittle-endian
9156 @opindex mlittle-endian
9157 @opindex mbig-endian
9158 Generate code for a little endian target.
9159
9160 @item -m210
9161 @itemx -m210
9162 @itemx -m340
9163 @opindex m210
9164 @opindex m210
9165 @opindex m340
9166 Generate code for the 210 processor.
9167 @end table
9168
9169 @node IA-64 Options
9170 @subsection IA-64 Options
9171 @cindex IA-64 Options
9172
9173 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9174
9175 @table @gcctabopt
9176 @item -mbig-endian
9177 @opindex mbig-endian
9178 Generate code for a big endian target.  This is the default for HP-UX@.
9179
9180 @item -mlittle-endian
9181 @opindex mlittle-endian
9182 Generate code for a little endian target.  This is the default for AIX5
9183 and Linux.
9184
9185 @item -mgnu-as
9186 @itemx -mno-gnu-as
9187 @opindex mgnu-as
9188 @opindex mno-gnu-as
9189 Generate (or don't) code for the GNU assembler.  This is the default.
9190 @c Also, this is the default if the configure option @option{--with-gnu-as}
9191 @c is used.
9192
9193 @item -mgnu-ld
9194 @itemx -mno-gnu-ld
9195 @opindex mgnu-ld
9196 @opindex mno-gnu-ld
9197 Generate (or don't) code for the GNU linker.  This is the default.
9198 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9199 @c is used.
9200
9201 @item -mno-pic
9202 @opindex mno-pic
9203 Generate code that does not use a global pointer register.  The result
9204 is not position independent code, and violates the IA-64 ABI@.
9205
9206 @item -mvolatile-asm-stop
9207 @itemx -mno-volatile-asm-stop
9208 @opindex mvolatile-asm-stop
9209 @opindex mno-volatile-asm-stop
9210 Generate (or don't) a stop bit immediately before and after volatile asm
9211 statements.
9212
9213 @item -mb-step
9214 @opindex mb-step
9215 Generate code that works around Itanium B step errata.
9216
9217 @item -mregister-names
9218 @itemx -mno-register-names
9219 @opindex mregister-names
9220 @opindex mno-register-names
9221 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9222 the stacked registers.  This may make assembler output more readable.
9223
9224 @item -mno-sdata
9225 @itemx -msdata
9226 @opindex mno-sdata
9227 @opindex msdata
9228 Disable (or enable) optimizations that use the small data section.  This may
9229 be useful for working around optimizer bugs.
9230
9231 @item -mconstant-gp
9232 @opindex mconstant-gp
9233 Generate code that uses a single constant global pointer value.  This is
9234 useful when compiling kernel code.
9235
9236 @item -mauto-pic
9237 @opindex mauto-pic
9238 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9239 This is useful when compiling firmware code.
9240
9241 @item -minline-divide-min-latency
9242 @opindex minline-divide-min-latency
9243 Generate code for inline divides using the minimum latency algorithm.
9244
9245 @item -minline-divide-max-throughput
9246 @opindex minline-divide-max-throughput
9247 Generate code for inline divides using the maximum throughput algorithm.
9248
9249 @item -mno-dwarf2-asm
9250 @itemx -mdwarf2-asm
9251 @opindex mno-dwarf2-asm
9252 @opindex mdwarf2-asm
9253 Don't (or do) generate assembler code for the DWARF2 line number debugging
9254 info.  This may be useful when not using the GNU assembler.
9255
9256 @item -mfixed-range=@var{register-range}
9257 @opindex mfixed-range
9258 Generate code treating the given register range as fixed registers.
9259 A fixed register is one that the register allocator can not use.  This is
9260 useful when compiling kernel code.  A register range is specified as
9261 two registers separated by a dash.  Multiple register ranges can be
9262 specified separated by a comma.
9263 @end table
9264
9265 @node D30V Options
9266 @subsection D30V Options
9267 @cindex D30V Options
9268
9269 These @samp{-m} options are defined for D30V implementations:
9270
9271 @table @gcctabopt
9272 @item -mextmem
9273 @opindex mextmem
9274 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9275 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9276 memory, which starts at location @code{0x80000000}.
9277
9278 @item -mextmemory
9279 @opindex mextmemory
9280 Same as the @option{-mextmem} switch.
9281
9282 @item -monchip
9283 @opindex monchip
9284 Link the @samp{.text} section into onchip text memory, which starts at
9285 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9286 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9287 into onchip data memory, which starts at location @code{0x20000000}.
9288
9289 @item -mno-asm-optimize
9290 @itemx -masm-optimize
9291 @opindex mno-asm-optimize
9292 @opindex masm-optimize
9293 Disable (enable) passing @option{-O} to the assembler when optimizing.
9294 The assembler uses the @option{-O} option to automatically parallelize
9295 adjacent short instructions where possible.
9296
9297 @item -mbranch-cost=@var{n}
9298 @opindex mbranch-cost
9299 Increase the internal costs of branches to @var{n}.  Higher costs means
9300 that the compiler will issue more instructions to avoid doing a branch.
9301 The default is 2.
9302
9303 @item -mcond-exec=@var{n}
9304 @opindex mcond-exec
9305 Specify the maximum number of conditionally executed instructions that
9306 replace a branch.  The default is 4.
9307 @end table
9308
9309 @node S/390 and zSeries Options
9310 @subsection S/390 and zSeries Options
9311 @cindex S/390 and zSeries Options
9312
9313 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9314
9315 @table @gcctabopt
9316 @item -mhard-float
9317 @itemx -msoft-float
9318 @opindex mhard-float
9319 @opindex msoft-float
9320 Use (do not use) the hardware floating-point instructions and registers
9321 for floating-point operations.  When @option{-msoft-float} is specified,
9322 functions in @file{libgcc.a} will be used to perform floating-point
9323 operations.  When @option{-mhard-float} is specified, the compiler
9324 generates IEEE floating-point instructions.  This is the default.
9325
9326 @item -mbackchain
9327 @itemx -mno-backchain
9328 @opindex mbackchain
9329 @opindex mno-backchain
9330 Generate (or do not generate) code which maintains an explicit
9331 backchain within the stack frame that points to the caller's frame.
9332 This is currently needed to allow debugging.  The default is to
9333 generate the backchain.
9334
9335 @item -msmall-exec
9336 @itemx -mno-small-exec
9337 @opindex msmall-exec
9338 @opindex mno-small-exec
9339 Generate (or do not generate) code using the @code{bras} instruction
9340 to do subroutine calls.
9341 This only works reliably if the total executable size does not
9342 exceed 64k.  The default is to use the @code{basr} instruction instead,
9343 which does not have this limitation.
9344
9345 @item -m64
9346 @itemx -m31
9347 @opindex m64
9348 @opindex m31
9349 When @option{-m31} is specified, generate code compliant to the
9350 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9351 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9352 particular to generate 64-bit instructions.  For the @samp{s390}
9353 targets, the default is @option{-m31}, while the @samp{s390x}
9354 targets default to @option{-m64}.
9355
9356 @item -mmvcle
9357 @itemx -mno-mvcle
9358 @opindex mmvcle
9359 @opindex mno-mvcle
9360 Generate (or do not generate) code using the @code{mvcle} instruction
9361 to perform block moves.  When @option{-mno-mvcle} is specifed,
9362 use a @code{mvc} loop instead.  This is the default.
9363
9364 @item -mdebug
9365 @itemx -mno-debug
9366 @opindex mdebug
9367 @opindex mno-debug
9368 Print (or do not print) additional debug information when compiling.
9369 The default is to not print debug information.
9370
9371 @end table
9372
9373 @node CRIS Options
9374 @subsection CRIS Options
9375 @cindex CRIS Options
9376
9377 These options are defined specifically for the CRIS ports.
9378
9379 @table @gcctabopt
9380 @item -march=@var{architecture-type}
9381 @itemx -mcpu=@var{architecture-type}
9382 @opindex march
9383 @opindex mcpu
9384 Generate code for the specified architecture.  The choices for
9385 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9386 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9387 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9388 @samp{v10}.
9389
9390 @item -mtune=@var{architecture-type}
9391 @opindex mtune
9392 Tune to @var{architecture-type} everything applicable about the generated
9393 code, except for the ABI and the set of available instructions.  The
9394 choices for @var{architecture-type} are the same as for
9395 @option{-march=@var{architecture-type}}.
9396
9397 @item -mmax-stack-frame=@var{n}
9398 @opindex mmax-stack-frame
9399 Warn when the stack frame of a function exceeds @var{n} bytes.
9400
9401 @item -melinux-stacksize=@var{n}
9402 @opindex melinux-stacksize
9403 Only available with the @samp{cris-axis-aout} target.  Arranges for
9404 indications in the program to the kernel loader that the stack of the
9405 program should be set to @var{n} bytes.
9406
9407 @item -metrax4
9408 @itemx -metrax100
9409 @opindex metrax4
9410 @opindex metrax100
9411 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9412 @option{-march=v3} and @option{-march=v8} respectively.
9413
9414 @item -mpdebug
9415 @opindex mpdebug
9416 Enable CRIS-specific verbose debug-related information in the assembly
9417 code.  This option also has the effect to turn off the @samp{#NO_APP}
9418 formatted-code indicator to the assembler at the beginning of the
9419 assembly file.
9420
9421 @item -mcc-init
9422 @opindex mcc-init
9423 Do not use condition-code results from previous instruction; always emit
9424 compare and test instructions before use of condition codes.
9425
9426 @item -mno-side-effects
9427 @opindex mno-side-effects
9428 Do not emit instructions with side-effects in addressing modes other than
9429 post-increment.
9430
9431 @item -mstack-align
9432 @itemx -mno-stack-align
9433 @itemx -mdata-align
9434 @itemx -mno-data-align
9435 @itemx -mconst-align
9436 @itemx -mno-const-align
9437 @opindex mstack-align
9438 @opindex mno-stack-align
9439 @opindex mdata-align
9440 @opindex mno-data-align
9441 @opindex mconst-align
9442 @opindex mno-const-align
9443 These options (no-options) arranges (eliminate arrangements) for the
9444 stack-frame, individual data and constants to be aligned for the maximum
9445 single data access size for the chosen CPU model.  The default is to
9446 arrange for 32-bit alignment.  ABI details such as structure layout are
9447 not affected by these options.
9448
9449 @item -m32-bit
9450 @itemx -m16-bit
9451 @itemx -m8-bit
9452 @opindex m32-bit
9453 @opindex m16-bit
9454 @opindex m8-bit
9455 Similar to the stack- data- and const-align options above, these options
9456 arrange for stack-frame, writable data and constants to all be 32-bit,
9457 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9458
9459 @item -mno-prologue-epilogue
9460 @itemx -mprologue-epilogue
9461 @opindex mno-prologue-epilogue
9462 @opindex mprologue-epilogue
9463 With @option{-mno-prologue-epilogue}, the normal function prologue and
9464 epilogue that sets up the stack-frame are omitted and no return
9465 instructions or return sequences are generated in the code.  Use this
9466 option only together with visual inspection of the compiled code: no
9467 warnings or errors are generated when call-saved registers must be saved,
9468 or storage for local variable needs to be allocated.
9469
9470 @item -mno-gotplt
9471 @itemx -mgotplt
9472 @opindex mno-gotplt
9473 @opindex mgotplt
9474 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9475 instruction sequences that load addresses for functions from the PLT part
9476 of the GOT rather than (traditional on other architectures) calls to the
9477 PLT.  The default is @option{-mgotplt}.
9478
9479 @item -maout
9480 @opindex maout
9481 Legacy no-op option only recognized with the cris-axis-aout target.
9482
9483 @item -melf
9484 @opindex melf
9485 Legacy no-op option only recognized with the cris-axis-elf and
9486 cris-axis-linux-gnu targets.
9487
9488 @item -melinux
9489 @opindex melinux
9490 Only recognized with the cris-axis-aout target, where it selects a
9491 GNU/linux-like multilib, include files and instruction set for
9492 @option{-march=v8}.
9493
9494 @item -mlinux
9495 @opindex mlinux
9496 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9497
9498 @item -sim
9499 @opindex sim
9500 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9501 to link with input-output functions from a simulator library.  Code,
9502 initialized data and zero-initialized data are allocated consecutively.
9503
9504 @item -sim2
9505 @opindex sim2
9506 Like @option{-sim}, but pass linker options to locate initialized data at
9507 0x40000000 and zero-initialized data at 0x80000000.
9508 @end table
9509
9510 @node MMIX Options
9511 @subsection MMIX Options
9512 @cindex MMIX Options
9513
9514 These options are defined for the MMIX:
9515
9516 @table @gcctabopt
9517 @item -mlibfuncs
9518 @itemx -mno-libfuncs
9519 @opindex mlibfuncs
9520 @opindex mno-libfuncs
9521 Specify that intrinsic library functions are being compiled, passing all
9522 values in registers, no matter the size.
9523
9524 @item -mepsilon
9525 @itemx -mno-epsilon
9526 @opindex mepsilon
9527 @opindex mno-epsilon
9528 Generate floating-point comparison instructions that compare with respect
9529 to the @code{rE} epsilon register.
9530
9531 @item -mabi=mmixware
9532 @itemx -mabi=gnu
9533 @opindex mabi-mmixware
9534 @opindex mabi=gnu
9535 Generate code that passes function parameters and return values that (in
9536 the called function) are seen as registers @code{$0} and up, as opposed to
9537 the GNU ABI which uses global registers @code{$231} and up.
9538
9539 @item -mzero-extend
9540 @itemx -mno-zero-extend
9541 @opindex mzero-extend
9542 @opindex mno-zero-extend
9543 When reading data from memory in sizes shorter than 64 bits, use (do not
9544 use) zero-extending load instructions by default, rather than
9545 sign-extending ones.
9546
9547 @item -mknuthdiv
9548 @itemx -mno-knuthdiv
9549 @opindex mknuthdiv
9550 @opindex mno-knuthdiv
9551 Make the result of a division yielding a remainder have the same sign as
9552 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9553 remainder follows the sign of the dividend.  Both methods are
9554 arithmetically valid, the latter being almost exclusively used.
9555
9556 @item -mtoplevel-symbols
9557 @itemx -mno-toplevel-symbols
9558 @opindex mtoplevel-symbols
9559 @opindex mno-toplevel-symbols
9560 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9561 code can be used with the @code{PREFIX} assembly directive.
9562
9563 @item -melf
9564 @opindex melf
9565 Generate an executable in the ELF format, rather than the default
9566 @samp{mmo} format used by the @command{mmix} simulator.
9567
9568 @item -mbranch-predict
9569 @itemx -mno-branch-predict
9570 @opindex mbranch-predict
9571 @opindex mno-branch-predict
9572 Use (do not use) the probable-branch instructions, when static branch
9573 prediction indicates a probable branch.
9574
9575 @item -mbase-addresses
9576 @itemx -mno-base-addresses
9577 @opindex mbase-addresses
9578 @opindex mno-base-addresses
9579 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9580 base address automatically generates a request (handled by the assembler
9581 and the linker) for a constant to be set up in a global register.  The
9582 register is used for one or more base address requests within the range 0
9583 to 255 from the value held in the register.  The generally leads to short
9584 and fast code, but the number of different data items that can be
9585 addressed is limited.  This means that a program that uses lots of static
9586 data may require @option{-mno-base-addresses}.
9587
9588 @item -msingle-exit
9589 @itemx -mno-single-exit
9590 @opindex msingle-exit
9591 @opindex mno-single-exit
9592 Force (do not force) generated code to have a single exit point in each
9593 function.
9594 @end table
9595
9596 @node PDP-11 Options
9597 @subsection PDP-11 Options
9598 @cindex PDP-11 Options
9599
9600 These options are defined for the PDP-11:
9601
9602 @table @gcctabopt
9603 @item -mfpu
9604 @opindex mfpu
9605 Use hardware FPP floating point.  This is the default.  (FIS floating
9606 point on the PDP-11/40 is not supported.)
9607
9608 @item -msoft-float
9609 @opindex msoft-float
9610 Do not use hardware floating point.
9611
9612 @item -mac0
9613 @opindex mac0
9614 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9615
9616 @item -mno-ac0
9617 @opindex mno-ac0
9618 Return floating-point results in memory.  This is the default.
9619
9620 @item -m40
9621 @opindex m40
9622 Generate code for a PDP-11/40.
9623
9624 @item -m45
9625 @opindex m45
9626 Generate code for a PDP-11/45.  This is the default.
9627
9628 @item -m10
9629 @opindex m10
9630 Generate code for a PDP-11/10.
9631
9632 @item -mbcopy-builtin
9633 @opindex bcopy-builtin
9634 Use inline @code{movstrhi} patterns for copying memory.  This is the
9635 default.
9636
9637 @item -mbcopy
9638 @opindex mbcopy
9639 Do not use inline @code{movstrhi} patterns for copying memory.
9640
9641 @item -mint16
9642 @itemx -mno-int32
9643 @opindex mint16
9644 @opindex mno-int32
9645 Use 16-bit @code{int}.  This is the default.
9646
9647 @item -mint32
9648 @itemx -mno-int16
9649 @opindex mint32
9650 @opindex mno-int16
9651 Use 32-bit @code{int}.
9652
9653 @item -mfloat64
9654 @itemx -mno-float32
9655 @opindex mfloat64
9656 @opindex mno-float32
9657 Use 64-bit @code{float}.  This is the default.
9658
9659 @item -mfloat32
9660 @item -mno-float64
9661 @opindex mfloat32
9662 @opindex mno-float64
9663 Use 32-bit @code{float}.
9664
9665 @item -mabshi
9666 @opindex mabshi
9667 Use @code{abshi2} pattern.  This is the default.
9668
9669 @item -mno-abshi
9670 @opindex mno-abshi
9671 Do not use @code{abshi2} pattern.
9672
9673 @item -mbranch-expensive
9674 @opindex mbranch-expensive
9675 Pretend that branches are expensive.  This is for experimenting with
9676 code generation only.
9677
9678 @item -mbranch-cheap
9679 @opindex mbranch-cheap
9680 Do not pretend that branches are expensive.  This is the default.
9681
9682 @item -msplit
9683 @opindex msplit
9684 Generate code for a system with split I&D.
9685
9686 @item -mno-split
9687 @opindex mno-split
9688 Generate code for a system without split I&D.  This is the default.
9689
9690 @item -munix-asm
9691 @opindex munix-asm
9692 Use Unix assembler syntax.  This is the default when configured for
9693 @samp{pdp11-*-bsd}.
9694
9695 @item -mdec-asm
9696 @opindex mdec-asm
9697 Use DEC assembler syntax.  This is the default when configured for any
9698 PDP-11 target other than @samp{pdp11-*-bsd}.
9699 @end table
9700
9701 @node Xstormy16 Options
9702 @subsection Xstormy16 Options
9703 @cindex Xstormy16 Options
9704
9705 These options are defined for Xstormy16:
9706
9707 @table @gcctabopt
9708 @item -msim
9709 @opindex msim
9710 Choose startup files and linker script suitable for the simulator.
9711 @end table
9712
9713 @node Xtensa Options
9714 @subsection Xtensa Options
9715 @cindex Xtensa Options
9716
9717 The Xtensa architecture is designed to support many different
9718 configurations.  The compiler's default options can be set to match a
9719 particular Xtensa configuration by copying a configuration file into the
9720 GCC sources when building GCC@.  The options below may be used to
9721 override the default options.
9722
9723 @table @gcctabopt
9724 @item -mbig-endian
9725 @itemx -mlittle-endian
9726 @opindex mbig-endian
9727 @opindex mlittle-endian
9728 Specify big-endian or little-endian byte ordering for the target Xtensa
9729 processor.
9730
9731 @item -mdensity
9732 @itemx -mno-density
9733 @opindex mdensity
9734 @opindex mno-density
9735 Enable or disable use of the optional Xtensa code density instructions.
9736
9737 @item -mmac16
9738 @itemx -mno-mac16
9739 @opindex mmac16
9740 @opindex mno-mac16
9741 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
9742 will generate MAC16 instructions from standard C code, with the
9743 limitation that it will use neither the MR register file nor any
9744 instruction that operates on the MR registers.  When this option is
9745 disabled, GCC will translate 16-bit multiply/accumulate operations to a
9746 combination of core instructions and library calls, depending on whether
9747 any other multiplier options are enabled.
9748
9749 @item -mmul16
9750 @itemx -mno-mul16
9751 @opindex mmul16
9752 @opindex mno-mul16
9753 Enable or disable use of the 16-bit integer multiplier option.  When
9754 enabled, the compiler will generate 16-bit multiply instructions for
9755 multiplications of 16 bits or smaller in standard C code.  When this
9756 option is disabled, the compiler will either use 32-bit multiply or
9757 MAC16 instructions if they are available or generate library calls to
9758 perform the multiply operations using shifts and adds.
9759
9760 @item -mmul32
9761 @itemx -mno-mul32
9762 @opindex mmul32
9763 @opindex mno-mul32
9764 Enable or disable use of the 32-bit integer multiplier option.  When
9765 enabled, the compiler will generate 32-bit multiply instructions for
9766 multiplications of 32 bits or smaller in standard C code.  When this
9767 option is disabled, the compiler will generate library calls to perform
9768 the multiply operations using either shifts and adds or 16-bit multiply
9769 instructions if they are available.
9770
9771 @item -mnsa
9772 @itemx -mno-nsa
9773 @opindex mnsa
9774 @opindex mno-nsa
9775 Enable or disable use of the optional normalization shift amount
9776 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
9777
9778 @item -mminmax
9779 @itemx -mno-minmax
9780 @opindex mminmax
9781 @opindex mno-minmax
9782 Enable or disable use of the optional minimum and maximum value
9783 instructions.
9784
9785 @item -msext
9786 @itemx -mno-sext
9787 @opindex msext
9788 @opindex mno-sext
9789 Enable or disable use of the optional sign extend (@code{SEXT})
9790 instruction.
9791
9792 @item -mbooleans
9793 @itemx -mno-booleans
9794 @opindex mbooleans
9795 @opindex mno-booleans
9796 Enable or disable support for the boolean register file used by Xtensa
9797 coprocessors.  This is not typically useful by itself but may be
9798 required for other options that make use of the boolean registers (e.g.,
9799 the floating-point option).
9800
9801 @item -mhard-float
9802 @itemx -msoft-float
9803 @opindex mhard-float
9804 @opindex msoft-float
9805 Enable or disable use of the floating-point option.  When enabled, GCC
9806 generates floating-point instructions for 32-bit @code{float}
9807 operations.  When this option is disabled, GCC generates library calls
9808 to emulate 32-bit floating-point operations using integer instructions.
9809 Regardless of this option, 64-bit @code{double} operations are always
9810 emulated with calls to library functions.
9811
9812 @item -mfused-madd
9813 @itemx -mno-fused-madd
9814 @opindex mfused-madd
9815 @opindex mno-fused-madd
9816 Enable or disable use of fused multiply/add and multiply/subtract
9817 instructions in the floating-point option.  This has no effect if the
9818 floating-point option is not also enabled.  Disabling fused multiply/add
9819 and multiply/subtract instructions forces the compiler to use separate
9820 instructions for the multiply and add/subtract operations.  This may be
9821 desirable in some cases where strict IEEE 754-compliant results are
9822 required: the fused multiply add/subtract instructions do not round the
9823 intermediate result, thereby producing results with @emph{more} bits of
9824 precision than specified by the IEEE standard.  Disabling fused multiply
9825 add/subtract instructions also ensures that the program output is not
9826 sensitive to the compiler's ability to combine multiply and add/subtract
9827 operations.
9828
9829 @item -mserialize-volatile
9830 @itemx -mno-serialize-volatile
9831 @opindex mserialize-volatile
9832 @opindex mno-serialize-volatile
9833 When this option is enabled, GCC inserts @code{MEMW} instructions before
9834 @code{volatile} memory references to guarantee sequential consistency.
9835 The default is @option{-mserialize-volatile}.  Use
9836 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
9837
9838 @item -mtext-section-literals
9839 @itemx -mno-text-section-literals
9840 @opindex mtext-section-literals
9841 @opindex mno-text-section-literals
9842 Control the treatment of literal pools.  The default is
9843 @option{-mno-text-section-literals}, which places literals in a separate
9844 section in the output file.  This allows the literal pool to be placed
9845 in a data RAM/ROM, and it also allows the linker to combine literal
9846 pools from separate object files to remove redundant literals and
9847 improve code size.  With @option{-mtext-section-literals}, the literals
9848 are interspersed in the text section in order to keep them as close as
9849 possible to their references.  This may be necessary for large assembly
9850 files.
9851
9852 @item -mtarget-align
9853 @itemx -mno-target-align
9854 @opindex mtarget-align
9855 @opindex mno-target-align
9856 When this option is enabled, GCC instructs the assembler to
9857 automatically align instructions to reduce branch penalties at the
9858 expense of some code density.  The assembler attempts to widen density
9859 instructions to align branch targets and the instructions following call
9860 instructions.  If there are not enough preceding safe density
9861 instructions to align a target, no widening will be performed.  The
9862 default is @option{-mtarget-align}.  These options do not affect the
9863 treatment of auto-aligned instructions like @code{LOOP}, which the
9864 assembler will always align, either by widening density instructions or
9865 by inserting no-op instructions.
9866
9867 @item -mlongcalls
9868 @itemx -mno-longcalls
9869 @opindex mlongcalls
9870 @opindex mno-longcalls
9871 When this option is enabled, GCC instructs the assembler to translate
9872 direct calls to indirect calls unless it can determine that the target
9873 of a direct call is in the range allowed by the call instruction.  This
9874 translation typically occurs for calls to functions in other source
9875 files.  Specifically, the assembler translates a direct @code{CALL}
9876 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
9877 The default is @option{-mno-longcalls}.  This option should be used in
9878 programs where the call target can potentially be out of range.  This
9879 option is implemented in the assembler, not the compiler, so the
9880 assembly code generated by GCC will still show direct call
9881 instructions---look at the disassembled object code to see the actual
9882 instructions.  Note that the assembler will use an indirect call for
9883 every cross-file call, not just those that really will be out of range.
9884 @end table
9885
9886 @node Code Gen Options
9887 @section Options for Code Generation Conventions
9888 @cindex code generation conventions
9889 @cindex options, code generation
9890 @cindex run-time options
9891
9892 These machine-independent options control the interface conventions
9893 used in code generation.
9894
9895 Most of them have both positive and negative forms; the negative form
9896 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
9897 one of the forms is listed---the one which is not the default.  You
9898 can figure out the other form by either removing @samp{no-} or adding
9899 it.
9900
9901 @table @gcctabopt
9902 @item -fexceptions
9903 @opindex fexceptions
9904 Enable exception handling.  Generates extra code needed to propagate
9905 exceptions.  For some targets, this implies GCC will generate frame
9906 unwind information for all functions, which can produce significant data
9907 size overhead, although it does not affect execution.  If you do not
9908 specify this option, GCC will enable it by default for languages like
9909 C++ which normally require exception handling, and disable it for
9910 languages like C that do not normally require it.  However, you may need
9911 to enable this option when compiling C code that needs to interoperate
9912 properly with exception handlers written in C++.  You may also wish to
9913 disable this option if you are compiling older C++ programs that don't
9914 use exception handling.
9915
9916 @item -fnon-call-exceptions
9917 @opindex fnon-call-exceptions
9918 Generate code that allows trapping instructions to throw exceptions.
9919 Note that this requires platform-specific runtime support that does
9920 not exist everywhere.  Moreover, it only allows @emph{trapping}
9921 instructions to throw exceptions, i.e.@: memory references or floating
9922 point instructions.  It does not allow exceptions to be thrown from
9923 arbitrary signal handlers such as @code{SIGALRM}.
9924
9925 @item -funwind-tables
9926 @opindex funwind-tables
9927 Similar to @option{-fexceptions}, except that it will just generate any needed
9928 static data, but will not affect the generated code in any other way.
9929 You will normally not enable this option; instead, a language processor
9930 that needs this handling would enable it on your behalf.
9931
9932 @item -fasynchronous-unwind-tables
9933 @opindex funwind-tables
9934 Generate unwind table in dwarf2 format, if supported by target machine.  The
9935 table is exact at each instruction boundary, so it can be used for stack
9936 unwinding from asynchronous events (such as debugger or garbage collector).
9937
9938 @item -fpcc-struct-return
9939 @opindex fpcc-struct-return
9940 Return ``short'' @code{struct} and @code{union} values in memory like
9941 longer ones, rather than in registers.  This convention is less
9942 efficient, but it has the advantage of allowing intercallability between
9943 GCC-compiled files and files compiled with other compilers, particularly
9944 the Portable C Compiler (pcc).
9945
9946 The precise convention for returning structures in memory depends
9947 on the target configuration macros.
9948
9949 Short structures and unions are those whose size and alignment match
9950 that of some integer type.
9951
9952 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
9953 switch is not binary compatible with code compiled with the
9954 @option{-freg-struct-return} switch.
9955 Use it to conform to a non-default application binary interface.
9956
9957 @item -freg-struct-return
9958 @opindex freg-struct-return
9959 Return @code{struct} and @code{union} values in registers when possible.
9960 This is more efficient for small structures than
9961 @option{-fpcc-struct-return}.
9962
9963 If you specify neither @option{-fpcc-struct-return} nor
9964 @option{-freg-struct-return}, GCC defaults to whichever convention is
9965 standard for the target.  If there is no standard convention, GCC
9966 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9967 the principal compiler.  In those cases, we can choose the standard, and
9968 we chose the more efficient register return alternative.
9969
9970 @strong{Warning:} code compiled with the @option{-freg-struct-return}
9971 switch is not binary compatible with code compiled with the
9972 @option{-fpcc-struct-return} switch.
9973 Use it to conform to a non-default application binary interface.
9974
9975 @item -fshort-enums
9976 @opindex fshort-enums
9977 Allocate to an @code{enum} type only as many bytes as it needs for the
9978 declared range of possible values.  Specifically, the @code{enum} type
9979 will be equivalent to the smallest integer type which has enough room.
9980
9981 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
9982 code that is not binary compatible with code generated without that switch.
9983 Use it to conform to a non-default application binary interface.
9984
9985 @item -fshort-double
9986 @opindex fshort-double
9987 Use the same size for @code{double} as for @code{float}.
9988
9989 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
9990 code that is not binary compatible with code generated without that switch.
9991 Use it to conform to a non-default application binary interface.
9992
9993 @item -fshort-wchar
9994 @opindex fshort-wchar
9995 Override the underlying type for @samp{wchar_t} to be @samp{short
9996 unsigned int} instead of the default for the target.  This option is
9997 useful for building programs to run under WINE@.
9998
9999 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10000 code that is not binary compatible with code generated without that switch.
10001 Use it to conform to a non-default application binary interface.
10002
10003 @item -fshared-data
10004 @opindex fshared-data
10005 Requests that the data and non-@code{const} variables of this
10006 compilation be shared data rather than private data.  The distinction
10007 makes sense only on certain operating systems, where shared data is
10008 shared between processes running the same program, while private data
10009 exists in one copy per process.
10010
10011 @item -fno-common
10012 @opindex fno-common
10013 In C, allocate even uninitialized global variables in the data section of the
10014 object file, rather than generating them as common blocks.  This has the
10015 effect that if the same variable is declared (without @code{extern}) in
10016 two different compilations, you will get an error when you link them.
10017 The only reason this might be useful is if you wish to verify that the
10018 program will work on other systems which always work this way.
10019
10020 @item -fno-ident
10021 @opindex fno-ident
10022 Ignore the @samp{#ident} directive.
10023
10024 @item -fno-gnu-linker
10025 @opindex fno-gnu-linker
10026 Do not output global initializations (such as C++ constructors and
10027 destructors) in the form used by the GNU linker (on systems where the GNU
10028 linker is the standard method of handling them).  Use this option when
10029 you want to use a non-GNU linker, which also requires using the
10030 @command{collect2} program to make sure the system linker includes
10031 constructors and destructors.  (@command{collect2} is included in the GCC
10032 distribution.)  For systems which @emph{must} use @command{collect2}, the
10033 compiler driver @command{gcc} is configured to do this automatically.
10034
10035 @item -finhibit-size-directive
10036 @opindex finhibit-size-directive
10037 Don't output a @code{.size} assembler directive, or anything else that
10038 would cause trouble if the function is split in the middle, and the
10039 two halves are placed at locations far apart in memory.  This option is
10040 used when compiling @file{crtstuff.c}; you should not need to use it
10041 for anything else.
10042
10043 @item -fverbose-asm
10044 @opindex fverbose-asm
10045 Put extra commentary information in the generated assembly code to
10046 make it more readable.  This option is generally only of use to those
10047 who actually need to read the generated assembly code (perhaps while
10048 debugging the compiler itself).
10049
10050 @option{-fno-verbose-asm}, the default, causes the
10051 extra information to be omitted and is useful when comparing two assembler
10052 files.
10053
10054 @item -fvolatile
10055 @opindex fvolatile
10056 Consider all memory references through pointers to be volatile.
10057
10058 @item -fvolatile-global
10059 @opindex fvolatile-global
10060 Consider all memory references to extern and global data items to
10061 be volatile.  GCC does not consider static data items to be volatile
10062 because of this switch.
10063
10064 @item -fvolatile-static
10065 @opindex fvolatile-static
10066 Consider all memory references to static data to be volatile.
10067
10068 @item -fpic
10069 @opindex fpic
10070 @cindex global offset table
10071 @cindex PIC
10072 Generate position-independent code (PIC) suitable for use in a shared
10073 library, if supported for the target machine.  Such code accesses all
10074 constant addresses through a global offset table (GOT)@.  The dynamic
10075 loader resolves the GOT entries when the program starts (the dynamic
10076 loader is not part of GCC; it is part of the operating system).  If
10077 the GOT size for the linked executable exceeds a machine-specific
10078 maximum size, you get an error message from the linker indicating that
10079 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10080 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10081 on the m68k and RS/6000.  The 386 has no such limit.)
10082
10083 Position-independent code requires special support, and therefore works
10084 only on certain machines.  For the 386, GCC supports PIC for System V
10085 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10086 position-independent.
10087
10088 @item -fPIC
10089 @opindex fPIC
10090 If supported for the target machine, emit position-independent code,
10091 suitable for dynamic linking and avoiding any limit on the size of the
10092 global offset table.  This option makes a difference on the m68k, m88k,
10093 and the SPARC.
10094
10095 Position-independent code requires special support, and therefore works
10096 only on certain machines.
10097
10098 @item -ffixed-@var{reg}
10099 @opindex ffixed
10100 Treat the register named @var{reg} as a fixed register; generated code
10101 should never refer to it (except perhaps as a stack pointer, frame
10102 pointer or in some other fixed role).
10103
10104 @var{reg} must be the name of a register.  The register names accepted
10105 are machine-specific and are defined in the @code{REGISTER_NAMES}
10106 macro in the machine description macro file.
10107
10108 This flag does not have a negative form, because it specifies a
10109 three-way choice.
10110
10111 @item -fcall-used-@var{reg}
10112 @opindex fcall-used
10113 Treat the register named @var{reg} as an allocable register that is
10114 clobbered by function calls.  It may be allocated for temporaries or
10115 variables that do not live across a call.  Functions compiled this way
10116 will not save and restore the register @var{reg}.
10117
10118 It is an error to used this flag with the frame pointer or stack pointer.
10119 Use of this flag for other registers that have fixed pervasive roles in
10120 the machine's execution model will produce disastrous results.
10121
10122 This flag does not have a negative form, because it specifies a
10123 three-way choice.
10124
10125 @item -fcall-saved-@var{reg}
10126 @opindex fcall-saved
10127 Treat the register named @var{reg} as an allocable register saved by
10128 functions.  It may be allocated even for temporaries or variables that
10129 live across a call.  Functions compiled this way will save and restore
10130 the register @var{reg} if they use it.
10131
10132 It is an error to used this flag with the frame pointer or stack pointer.
10133 Use of this flag for other registers that have fixed pervasive roles in
10134 the machine's execution model will produce disastrous results.
10135
10136 A different sort of disaster will result from the use of this flag for
10137 a register in which function values may be returned.
10138
10139 This flag does not have a negative form, because it specifies a
10140 three-way choice.
10141
10142 @item -fpack-struct
10143 @opindex fpack-struct
10144 Pack all structure members together without holes.
10145
10146 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10147 code that is not binary compatible with code generated without that switch.
10148 Additionally, it makes the code suboptimial.
10149 Use it to conform to a non-default application binary interface.
10150
10151 @item -finstrument-functions
10152 @opindex finstrument-functions
10153 Generate instrumentation calls for entry and exit to functions.  Just
10154 after function entry and just before function exit, the following
10155 profiling functions will be called with the address of the current
10156 function and its call site.  (On some platforms,
10157 @code{__builtin_return_address} does not work beyond the current
10158 function, so the call site information may not be available to the
10159 profiling functions otherwise.)
10160
10161 @example
10162 void __cyg_profile_func_enter (void *this_fn,
10163                                void *call_site);
10164 void __cyg_profile_func_exit  (void *this_fn,
10165                                void *call_site);
10166 @end example
10167
10168 The first argument is the address of the start of the current function,
10169 which may be looked up exactly in the symbol table.
10170
10171 This instrumentation is also done for functions expanded inline in other
10172 functions.  The profiling calls will indicate where, conceptually, the
10173 inline function is entered and exited.  This means that addressable
10174 versions of such functions must be available.  If all your uses of a
10175 function are expanded inline, this may mean an additional expansion of
10176 code size.  If you use @samp{extern inline} in your C code, an
10177 addressable version of such functions must be provided.  (This is
10178 normally the case anyways, but if you get lucky and the optimizer always
10179 expands the functions inline, you might have gotten away without
10180 providing static copies.)
10181
10182 A function may be given the attribute @code{no_instrument_function}, in
10183 which case this instrumentation will not be done.  This can be used, for
10184 example, for the profiling functions listed above, high-priority
10185 interrupt routines, and any functions from which the profiling functions
10186 cannot safely be called (perhaps signal handlers, if the profiling
10187 routines generate output or allocate memory).
10188
10189 @item -fstack-check
10190 @opindex fstack-check
10191 Generate code to verify that you do not go beyond the boundary of the
10192 stack.  You should specify this flag if you are running in an
10193 environment with multiple threads, but only rarely need to specify it in
10194 a single-threaded environment since stack overflow is automatically
10195 detected on nearly all systems if there is only one stack.
10196
10197 Note that this switch does not actually cause checking to be done; the
10198 operating system must do that.  The switch causes generation of code
10199 to ensure that the operating system sees the stack being extended.
10200
10201 @item -fstack-limit-register=@var{reg}
10202 @itemx -fstack-limit-symbol=@var{sym}
10203 @itemx -fno-stack-limit
10204 @opindex fstack-limit-register
10205 @opindex fstack-limit-symbol
10206 @opindex fno-stack-limit
10207 Generate code to ensure that the stack does not grow beyond a certain value,
10208 either the value of a register or the address of a symbol.  If the stack
10209 would grow beyond the value, a signal is raised.  For most targets,
10210 the signal is raised before the stack overruns the boundary, so
10211 it is possible to catch the signal without taking special precautions.
10212
10213 For instance, if the stack starts at absolute address @samp{0x80000000}
10214 and grows downwards, you can use the flags
10215 @option{-fstack-limit-symbol=__stack_limit} and
10216 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10217 of 128KB@.  Note that this may only work with the GNU linker.
10218
10219 @cindex aliasing of parameters
10220 @cindex parameters, aliased
10221 @item -fargument-alias
10222 @itemx -fargument-noalias
10223 @itemx -fargument-noalias-global
10224 @opindex fargument-alias
10225 @opindex fargument-noalias
10226 @opindex fargument-noalias-global
10227 Specify the possible relationships among parameters and between
10228 parameters and global data.
10229
10230 @option{-fargument-alias} specifies that arguments (parameters) may
10231 alias each other and may alias global storage.@*
10232 @option{-fargument-noalias} specifies that arguments do not alias
10233 each other, but may alias global storage.@*
10234 @option{-fargument-noalias-global} specifies that arguments do not
10235 alias each other and do not alias global storage.
10236
10237 Each language will automatically use whatever option is required by
10238 the language standard.  You should not need to use these options yourself.
10239
10240 @item -fleading-underscore
10241 @opindex fleading-underscore
10242 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10243 change the way C symbols are represented in the object file.  One use
10244 is to help link with legacy assembly code.
10245
10246 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
10247 generate code that is not binary compatible with code generated without that
10248 switch.  Use it to conform to a non-default application binary interface.
10249 Not all targets provide complete support for this switch.
10250
10251 @item -ftls-model=@var{model}
10252 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10253 The @var{model} argument should be one of @code{global-dynamic},
10254 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10255
10256 The default without @option{-fpic} is @code{initial-exec}; with
10257 @option{-fpic} the default is @code{global-dynamic}.
10258 @end table
10259
10260 @c man end
10261
10262 @node Environment Variables
10263 @section Environment Variables Affecting GCC
10264 @cindex environment variables
10265
10266 @c man begin ENVIRONMENT
10267
10268 This section describes several environment variables that affect how GCC
10269 operates.  Some of them work by specifying directories or prefixes to use
10270 when searching for various kinds of files.  Some are used to specify other
10271 aspects of the compilation environment.
10272
10273 Note that you can also specify places to search using options such as
10274 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10275 take precedence over places specified using environment variables, which
10276 in turn take precedence over those specified by the configuration of GCC@.
10277 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10278 GNU Compiler Collection (GCC) Internals}.
10279
10280 @table @env
10281 @item LANG
10282 @itemx LC_CTYPE
10283 @c @itemx LC_COLLATE
10284 @itemx LC_MESSAGES
10285 @c @itemx LC_MONETARY
10286 @c @itemx LC_NUMERIC
10287 @c @itemx LC_TIME
10288 @itemx LC_ALL
10289 @findex LANG
10290 @findex LC_CTYPE
10291 @c @findex LC_COLLATE
10292 @findex LC_MESSAGES
10293 @c @findex LC_MONETARY
10294 @c @findex LC_NUMERIC
10295 @c @findex LC_TIME
10296 @findex LC_ALL
10297 @cindex locale
10298 These environment variables control the way that GCC uses
10299 localization information that allow GCC to work with different
10300 national conventions.  GCC inspects the locale categories
10301 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10302 so.  These locale categories can be set to any value supported by your
10303 installation.  A typical value is @samp{en_UK} for English in the United
10304 Kingdom.
10305
10306 The @env{LC_CTYPE} environment variable specifies character
10307 classification.  GCC uses it to determine the character boundaries in
10308 a string; this is needed for some multibyte encodings that contain quote
10309 and escape characters that would otherwise be interpreted as a string
10310 end or escape.
10311
10312 The @env{LC_MESSAGES} environment variable specifies the language to
10313 use in diagnostic messages.
10314
10315 If the @env{LC_ALL} environment variable is set, it overrides the value
10316 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10317 and @env{LC_MESSAGES} default to the value of the @env{LANG}
10318 environment variable.  If none of these variables are set, GCC
10319 defaults to traditional C English behavior.
10320
10321 @item TMPDIR
10322 @findex TMPDIR
10323 If @env{TMPDIR} is set, it specifies the directory to use for temporary
10324 files.  GCC uses temporary files to hold the output of one stage of
10325 compilation which is to be used as input to the next stage: for example,
10326 the output of the preprocessor, which is the input to the compiler
10327 proper.
10328
10329 @item GCC_EXEC_PREFIX
10330 @findex GCC_EXEC_PREFIX
10331 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
10332 names of the subprograms executed by the compiler.  No slash is added
10333 when this prefix is combined with the name of a subprogram, but you can
10334 specify a prefix that ends with a slash if you wish.
10335
10336 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
10337 an appropriate prefix to use based on the pathname it was invoked with.
10338
10339 If GCC cannot find the subprogram using the specified prefix, it
10340 tries looking in the usual places for the subprogram.
10341
10342 The default value of @env{GCC_EXEC_PREFIX} is
10343 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
10344 of @code{prefix} when you ran the @file{configure} script.
10345
10346 Other prefixes specified with @option{-B} take precedence over this prefix.
10347
10348 This prefix is also used for finding files such as @file{crt0.o} that are
10349 used for linking.
10350
10351 In addition, the prefix is used in an unusual way in finding the
10352 directories to search for header files.  For each of the standard
10353 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
10354 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
10355 replacing that beginning with the specified prefix to produce an
10356 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
10357 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
10358 These alternate directories are searched first; the standard directories
10359 come next.
10360
10361 @item COMPILER_PATH
10362 @findex COMPILER_PATH
10363 The value of @env{COMPILER_PATH} is a colon-separated list of
10364 directories, much like @env{PATH}.  GCC tries the directories thus
10365 specified when searching for subprograms, if it can't find the
10366 subprograms using @env{GCC_EXEC_PREFIX}.
10367
10368 @item LIBRARY_PATH
10369 @findex LIBRARY_PATH
10370 The value of @env{LIBRARY_PATH} is a colon-separated list of
10371 directories, much like @env{PATH}.  When configured as a native compiler,
10372 GCC tries the directories thus specified when searching for special
10373 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
10374 using GCC also uses these directories when searching for ordinary
10375 libraries for the @option{-l} option (but directories specified with
10376 @option{-L} come first).
10377
10378 @item LANG
10379 @findex LANG
10380 @cindex locale definition
10381 This variable is used to pass locale information to the compiler.  One way in
10382 which this information is used is to determine the character set to be used
10383 when character literals, string literals and comments are parsed in C and C++.
10384 When the compiler is configured to allow multibyte characters,
10385 the following values for @env{LANG} are recognized:
10386
10387 @table @samp
10388 @item C-JIS
10389 Recognize JIS characters.
10390 @item C-SJIS
10391 Recognize SJIS characters.
10392 @item C-EUCJP
10393 Recognize EUCJP characters.
10394 @end table
10395
10396 If @env{LANG} is not defined, or if it has some other value, then the
10397 compiler will use mblen and mbtowc as defined by the default locale to
10398 recognize and translate multibyte characters.
10399 @end table
10400
10401 @noindent
10402 Some additional environments variables affect the behavior of the
10403 preprocessor.
10404
10405 @include cppenv.texi
10406
10407 @c man end
10408
10409 @node Running Protoize
10410 @section Running Protoize
10411
10412 The program @code{protoize} is an optional part of GCC@.  You can use
10413 it to add prototypes to a program, thus converting the program to ISO
10414 C in one respect.  The companion program @code{unprotoize} does the
10415 reverse: it removes argument types from any prototypes that are found.
10416
10417 When you run these programs, you must specify a set of source files as
10418 command line arguments.  The conversion programs start out by compiling
10419 these files to see what functions they define.  The information gathered
10420 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
10421
10422 After scanning comes actual conversion.  The specified files are all
10423 eligible to be converted; any files they include (whether sources or
10424 just headers) are eligible as well.
10425
10426 But not all the eligible files are converted.  By default,
10427 @code{protoize} and @code{unprotoize} convert only source and header
10428 files in the current directory.  You can specify additional directories
10429 whose files should be converted with the @option{-d @var{directory}}
10430 option.  You can also specify particular files to exclude with the
10431 @option{-x @var{file}} option.  A file is converted if it is eligible, its
10432 directory name matches one of the specified directory names, and its
10433 name within the directory has not been excluded.
10434
10435 Basic conversion with @code{protoize} consists of rewriting most
10436 function definitions and function declarations to specify the types of
10437 the arguments.  The only ones not rewritten are those for varargs
10438 functions.
10439
10440 @code{protoize} optionally inserts prototype declarations at the
10441 beginning of the source file, to make them available for any calls that
10442 precede the function's definition.  Or it can insert prototype
10443 declarations with block scope in the blocks where undeclared functions
10444 are called.
10445
10446 Basic conversion with @code{unprotoize} consists of rewriting most
10447 function declarations to remove any argument types, and rewriting
10448 function definitions to the old-style pre-ISO form.
10449
10450 Both conversion programs print a warning for any function declaration or
10451 definition that they can't convert.  You can suppress these warnings
10452 with @option{-q}.
10453
10454 The output from @code{protoize} or @code{unprotoize} replaces the
10455 original source file.  The original file is renamed to a name ending
10456 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
10457 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
10458 for DOS) file already exists, then the source file is simply discarded.
10459
10460 @code{protoize} and @code{unprotoize} both depend on GCC itself to
10461 scan the program and collect information about the functions it uses.
10462 So neither of these programs will work until GCC is installed.
10463
10464 Here is a table of the options you can use with @code{protoize} and
10465 @code{unprotoize}.  Each option works with both programs unless
10466 otherwise stated.
10467
10468 @table @code
10469 @item -B @var{directory}
10470 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
10471 usual directory (normally @file{/usr/local/lib}).  This file contains
10472 prototype information about standard system functions.  This option
10473 applies only to @code{protoize}.
10474
10475 @item -c @var{compilation-options}
10476 Use  @var{compilation-options} as the options when running @code{gcc} to
10477 produce the @samp{.X} files.  The special option @option{-aux-info} is
10478 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
10479
10480 Note that the compilation options must be given as a single argument to
10481 @code{protoize} or @code{unprotoize}.  If you want to specify several
10482 @code{gcc} options, you must quote the entire set of compilation options
10483 to make them a single word in the shell.
10484
10485 There are certain @code{gcc} arguments that you cannot use, because they
10486 would produce the wrong kind of output.  These include @option{-g},
10487 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
10488 the @var{compilation-options}, they are ignored.
10489
10490 @item -C
10491 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
10492 systems) instead of @samp{.c}.  This is convenient if you are converting
10493 a C program to C++.  This option applies only to @code{protoize}.
10494
10495 @item -g
10496 Add explicit global declarations.  This means inserting explicit
10497 declarations at the beginning of each source file for each function
10498 that is called in the file and was not declared.  These declarations
10499 precede the first function definition that contains a call to an
10500 undeclared function.  This option applies only to @code{protoize}.
10501
10502 @item -i @var{string}
10503 Indent old-style parameter declarations with the string @var{string}.
10504 This option applies only to @code{protoize}.
10505
10506 @code{unprotoize} converts prototyped function definitions to old-style
10507 function definitions, where the arguments are declared between the
10508 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
10509 uses five spaces as the indentation.  If you want to indent with just
10510 one space instead, use @option{-i " "}.
10511
10512 @item -k
10513 Keep the @samp{.X} files.  Normally, they are deleted after conversion
10514 is finished.
10515
10516 @item -l
10517 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
10518 a prototype declaration for each function in each block which calls the
10519 function without any declaration.  This option applies only to
10520 @code{protoize}.
10521
10522 @item -n
10523 Make no real changes.  This mode just prints information about the conversions
10524 that would have been done without @option{-n}.
10525
10526 @item -N
10527 Make no @samp{.save} files.  The original files are simply deleted.
10528 Use this option with caution.
10529
10530 @item -p @var{program}
10531 Use the program @var{program} as the compiler.  Normally, the name
10532 @file{gcc} is used.
10533
10534 @item -q
10535 Work quietly.  Most warnings are suppressed.
10536
10537 @item -v
10538 Print the version number, just like @option{-v} for @code{gcc}.
10539 @end table
10540
10541 If you need special compiler options to compile one of your program's
10542 source files, then you should generate that file's @samp{.X} file
10543 specially, by running @code{gcc} on that source file with the
10544 appropriate options and the option @option{-aux-info}.  Then run
10545 @code{protoize} on the entire set of files.  @code{protoize} will use
10546 the existing @samp{.X} file because it is newer than the source file.
10547 For example:
10548
10549 @example
10550 gcc -Dfoo=bar file1.c -aux-info file1.X
10551 protoize *.c
10552 @end example
10553
10554 @noindent
10555 You need to include the special files along with the rest in the
10556 @code{protoize} command, even though their @samp{.X} files already
10557 exist, because otherwise they won't get converted.
10558
10559 @xref{Protoize Caveats}, for more information on how to use
10560 @code{protoize} successfully.