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