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