OSDN Git Service

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