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