* cse.c (count_reg_usage): Fix handling of REG_EQUAL notes.
[official-gcc.git] / gcc / doc / invoke.texi
blob747f003695738671cb161ae4794ff917aa64f86f
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 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, 2003 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.2 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 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
148 @c man begin OPTIONS
150 @node Option Summary
151 @section Option Summary
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{
160 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
161 -v  -###  --help  --target-help  --version}
163 @item C Language Options
164 @xref{C Dialect Options,,Options Controlling C Dialect}.
165 @gccoptlist{
166 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
167 -fno-asm  -fno-builtin -fno-builtin-@var{function} @gol
168 -fhosted  -ffreestanding  -fms-extensions @gol
169 -trigraphs  -traditional  -traditional-cpp @gol
170 -fallow-single-precision  -fcond-mismatch @gol
171 -fsigned-bitfields  -fsigned-char @gol
172 -funsigned-bitfields  -funsigned-char @gol
173 -fwritable-strings}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{
178 -fabi-version=@var{n} -fno-access-control  -fcheck-new @gol
179 -fconserve-space -fno-const-strings  -fdollars-in-identifiers @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs  -fexternal-templates @gol
182 -falt-external-templates @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
190 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
191 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor  -Wreorder @gol
193 -Weffc++  -Wno-deprecated @gol
194 -Wno-non-template-friend  -Wold-style-cast @gol
195 -Woverloaded-virtual  -Wno-pmf-conversions @gol
196 -Wsign-promo  -Wsynth}
198 @item Objective-C Language Options
199 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{
208 -fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{
214 -fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
219 -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wformat-nonliteral  -Wformat-security @gol
221 -Wimplicit  -Wimplicit-int  @gol
222 -Wimplicit-function-declaration @gol
223 -Werror-implicit-function-declaration @gol
224 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces @gol
227 -Wmissing-format-attribute  -Wmissing-noreturn @gol
228 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
229 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
230 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
231 -Wreturn-type  -Wsequence-point  -Wshadow @gol
232 -Wsign-compare  -Wstrict-aliasing @gol
233 -Wswitch  -Wswitch-default -Wswitch-enum @gol
234 -Wsystem-headers -Wtrigraphs  -Wundef  -Wuninitialized @gol
235 -Wunknown-pragmas  -Wunreachable-code @gol
236 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
237 -Wunused-value  -Wunused-variable  -Wwrite-strings}
239 @item C-only Warning Options
240 @gccoptlist{
241 -Wbad-function-cast  -Wmissing-declarations @gol
242 -Wmissing-prototypes  -Wnested-externs @gol
243 -Wstrict-prototypes  -Wtraditional}
245 @item Debugging Options
246 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
247 @gccoptlist{
248 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
249 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
250 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
253 -feliminate-dwarf2-dups  -fmem-report @gol
254 -fprofile-arcs  -fsched-verbose=@var{n} @gol
255 -ftest-coverage  -ftime-report @gol
256 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
257 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
258 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
259 -print-multi-directory  -print-multi-lib @gol
260 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
261 -save-temps  -time}
263 @item Optimization Options
264 @xref{Optimize Options,,Options that Control Optimization}.
265 @gccoptlist{
266 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
267 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
268 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
274 -fif-conversion -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations -ffinite-math-only @gol
282 -fno-trapping-math -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -freduce-all-givs -fregmove  -frename-registers @gol
286 -freorder-blocks -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
291 -fsched2-use-traces  -fsignaling-nans @gol
292 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
293 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
294 -funroll-all-loops  -funroll-loops -fpeel-loops -funswitch-loops @gol
295 -fold-unroll-loops -fold-unroll-all-loops @gol
296 --param @var{name}=@var{value}
297 -O  -O0  -O1  -O2  -O3  -Os}
299 @item Preprocessor Options
300 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
301 @gccoptlist{
302 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
303 -C  -dD  -dI  -dM  -dN @gol
304 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
305 -idirafter @var{dir} @gol
306 -include @var{file}  -imacros @var{file} @gol
307 -iprefix @var{file}  -iwithprefix @var{dir} @gol
308 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
309 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
310 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
312 @item Assembler Option
313 @xref{Assembler Options,,Passing Options to the Assembler}.
314 @gccoptlist{
315 -Wa,@var{option} -Xassembler @var{option}}
317 @item Linker Options
318 @xref{Link Options,,Options for Linking}.
319 @gccoptlist{
320 @var{object-file-name}  -l@var{library} @gol
321 -nostartfiles  -nodefaultlibs  -nostdlib @gol
322 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
323 -Wl,@var{option}  -Xlinker @var{option} @gol
324 -u @var{symbol}}
326 @item Directory Options
327 @xref{Directory Options,,Options for Directory Search}.
328 @gccoptlist{
329 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
331 @item Target Options
332 @c I wrote this xref this way to avoid overfull hbox. -- rms
333 @xref{Target Options}.
334 @gccoptlist{
335 -V @var{version} -b @var{machine}}
337 @item Machine Dependent Options
338 @xref{Submodel Options,,Hardware Models and Configurations}.
340 @emph{M680x0 Options}
341 @gccoptlist{
342 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
343 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
344 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
345 -malign-int  -mstrict-align}
347 @emph{M68hc1x Options}
348 @gccoptlist{
349 -m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
350 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
351 -msoft-reg-count=@var{count}}
353 @emph{VAX Options}
354 @gccoptlist{
355 -mg  -mgnu  -munix}
357 @emph{SPARC Options}
358 @gccoptlist{
359 -mcpu=@var{cpu-type} @gol
360 -mtune=@var{cpu-type} @gol
361 -mcmodel=@var{code-model} @gol
362 -m32  -m64 @gol
363 -mapp-regs  -mbroken-saverestore  -mcypress @gol
364 -mfaster-structs  -mflat @gol
365 -mfpu  -mhard-float  -mhard-quad-float @gol
366 -mimpure-text  -mlive-g0  -mno-app-regs @gol
367 -mno-faster-structs  -mno-flat  -mno-fpu @gol
368 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
369 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
370 -msupersparc  -munaligned-doubles  -mv8}
372 @emph{ARM Options}
373 @gccoptlist{
374 -mapcs-frame  -mno-apcs-frame @gol
375 -mapcs-26  -mapcs-32 @gol
376 -mapcs-stack-check  -mno-apcs-stack-check @gol
377 -mapcs-float  -mno-apcs-float @gol
378 -mapcs-reentrant  -mno-apcs-reentrant @gol
379 -msched-prolog  -mno-sched-prolog @gol
380 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
381 -malignment-traps  -mno-alignment-traps @gol
382 -msoft-float  -mhard-float  -mfpe @gol
383 -mthumb-interwork  -mno-thumb-interwork @gol
384 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
385 -mstructure-size-boundary=@var{n} @gol
386 -mabort-on-noreturn @gol
387 -mlong-calls  -mno-long-calls @gol
388 -msingle-pic-base  -mno-single-pic-base @gol
389 -mpic-register=@var{reg} @gol
390 -mnop-fun-dllimport @gol
391 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
392 -mpoke-function-name @gol
393 -mthumb  -marm @gol
394 -mtpcs-frame  -mtpcs-leaf-frame @gol
395 -mcaller-super-interworking  -mcallee-super-interworking }
397 @emph{MN10200 Options}
398 @gccoptlist{
399 -mrelax}
401 @emph{MN10300 Options}
402 @gccoptlist{
403 -mmult-bug  -mno-mult-bug @gol
404 -mam33  -mno-am33 @gol
405 -mno-crt0  -mrelax}
407 @emph{M32R/D Options}
408 @gccoptlist{
409 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
410 -G @var{num}}
412 @emph{M88K Options}
413 @gccoptlist{
414 -m88000  -m88100  -m88110  -mbig-pic @gol
415 -mcheck-zero-division  -mhandle-large-shift @gol
416 -midentify-revision  -mno-check-zero-division @gol
417 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
418 -mno-optimize-arg-area  -mno-serialize-volatile @gol
419 -mno-underscores  -mocs-debug-info @gol
420 -mocs-frame-position  -moptimize-arg-area @gol
421 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
422 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
423 -mversion-03.00  -mwarn-passed-structs}
425 @emph{RS/6000 and PowerPC Options}
426 @gccoptlist{
427 -mcpu=@var{cpu-type} @gol
428 -mtune=@var{cpu-type} @gol
429 -mpower  -mno-power  -mpower2  -mno-power2 @gol
430 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
431 -maltivec -mno-altivec @gol
432 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
433 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
434 -mnew-mnemonics  -mold-mnemonics @gol
435 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
436 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
437 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
438 -mstring  -mno-string  -mupdate  -mno-update @gol
439 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
440 -mstrict-align  -mno-strict-align  -mrelocatable @gol
441 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
442 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
443 -mcall-aix -mcall-sysv -mcall-netbsd @gol
444 -maix-struct-return -msvr4-struct-return @gol
445 -mabi=altivec -mabi=no-altivec @gol
446 -mabi=spe -mabi=no-spe @gol
447 -misel=yes -misel=no @gol
448 -mprototype  -mno-prototype @gol
449 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
450 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
452 @emph{Darwin Options}
453 @gccoptlist{
454 -all_load -allowable_client -arch -arch_errors_fatal @gol
455 -arch_only -bind_at_load -bundle -bundle_loader @gol
456 -client_name -compatibility_version -current_version @gol
457 -dependency-file -dylib_file -dylinker_install_name @gol
458 -dynamic -dynamiclib -exported_symbols_list @gol
459 -filelist -flat_namespace -force_cpusubtype_ALL @gol
460 -force_flat_namespace -headerpad_max_install_names @gol
461 -image_base -init -install_name -keep_private_externs @gol
462 -multi_module -multiply_defined -multiply_defined_unused @gol
463 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
464 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
465 -private_bundle -read_only_relocs -sectalign @gol
466 -sectobjectsymbols -whyload -seg1addr @gol
467 -sectcreate -sectobjectsymbols -sectorder @gol
468 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
469 -segprot -segs_read_only_addr -segs_read_write_addr @gol
470 -single_module -static -sub_library -sub_umbrella @gol
471 -twolevel_namespace -umbrella -undefined @gol
472 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
474 @emph{RT Options}
475 @gccoptlist{
476 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
477 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
478 -mminimum-fp-blocks  -mnohc-struct-return}
480 @emph{MIPS Options}
481 @gccoptlist{
482 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
483 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
484 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
485 -mgas  -mgp32  -mgp64 @gol
486 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
487 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
488 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
489 -mmips-as  -mmips-tfile  -mno-abicalls @gol
490 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
491 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
492 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
493 -mrnames  -msoft-float @gol
494 -m4650  -msingle-float  -mmad @gol
495 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
496 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
497 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
498 -mbranch-likely -mno-branch-likely}
500 @emph{i386 and x86-64 Options}
501 @gccoptlist{
502 -mtune=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
503 -masm=@var{dialect}  -mno-fancy-math-387 @gol
504 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
505 -mno-wide-multiply  -mrtd  -malign-double @gol
506 -mpreferred-stack-boundary=@var{num} @gol
507 -mmmx  -msse -msse2 -m3dnow @gol
508 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
509 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
510 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
511 -mno-red-zone@gol
512 -mcmodel=@var{code-model} @gol
513 -m32 -m64}
515 @emph{HPPA Options}
516 @gccoptlist{
517 -march=@var{architecture-type} @gol
518 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
519 -mfast-indirect-calls  -mgas  -mgnu-ld -mhp-ld @gol
520 -mjump-in-delay -mlinker-opt -mlong-calls @gol
521 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
522 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
523 -mno-jump-in-delay  -mno-long-load-store @gol
524 -mno-portable-runtime  -mno-soft-float @gol
525 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
526 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
527 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
529 @emph{Intel 960 Options}
530 @gccoptlist{
531 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
532 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
533 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
534 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
535 -mno-complex-addr  -mno-leaf-procedures @gol
536 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
537 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
538 -mtail-call}
540 @emph{DEC Alpha Options}
541 @gccoptlist{
542 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
543 -mieee  -mieee-with-inexact  -mieee-conformant @gol
544 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
545 -mtrap-precision=@var{mode}  -mbuild-constants @gol
546 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
547 -mbwx  -mmax  -mfix  -mcix @gol
548 -mfloat-vax  -mfloat-ieee @gol
549 -mexplicit-relocs  -msmall-data  -mlarge-data -msmall-text -mlarge-text @gol
550 -mmemory-latency=@var{time}}
552 @emph{DEC Alpha/VMS Options}
553 @gccoptlist{
554 -mvms-return-codes}
556 @emph{H8/300 Options}
557 @gccoptlist{
558 -mrelax  -mh  -ms  -mn  -mint32  -malign-300}
560 @emph{SH Options}
561 @gccoptlist{
562 -m1  -m2  -m2e  -m3  -m3e @gol
563 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
564 -m5-64media -m5-64media-nofpu @gol
565 -m5-32media -m5-32media-nofpu @gol
566 -m5-compact -m5-compact-nofpu @gol
567 -mb  -ml  -mdalign  -mrelax @gol
568 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
569 -mieee  -misize  -mpadstruct  -mspace @gol
570 -mprefergot  -musermode}
572 @emph{System V Options}
573 @gccoptlist{
574 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
576 @emph{ARC Options}
577 @gccoptlist{
578 -EB  -EL @gol
579 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
580 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
582 @emph{TMS320C3x/C4x Options}
583 @gccoptlist{
584 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
585 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
586 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
587 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
589 @emph{V850 Options}
590 @gccoptlist{
591 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
592 -mprolog-function  -mno-prolog-function  -mspace @gol
593 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
594 -mapp-regs -mno-app-regs @gol
595 -mdisable-callt -mno-disable-callt @gol
596 -mv850e @gol
597 -mv850  -mbig-switch}
599 @emph{NS32K Options}
600 @gccoptlist{
601 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
602 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
603 -mregparam  -mnoregparam  -msb  -mnosb @gol
604 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
606 @emph{AVR Options}
607 @gccoptlist{
608 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
609 -mcall-prologues  -mno-tablejump  -mtiny-stack}
611 @emph{MCore Options}
612 @gccoptlist{
613 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
614 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
615 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
616 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
617 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
619 @emph{MMIX Options}
620 @gccoptlist{
621 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
622 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
623 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
624 -mno-base-addresses -msingle-exit -mno-single-exit}
626 @emph{IA-64 Options}
627 @gccoptlist{
628 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
629 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
630 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
631 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
632 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
633 -mfixed-range=@var{register-range}}
635 @emph{D30V Options}
636 @gccoptlist{
637 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
638 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
640 @emph{S/390 and zSeries Options}
641 @gccoptlist{
642 -mtune=@var{cpu-type} -march=@var{cpu-type} @gol
643 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
644 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
645 -m64 -m31 -mdebug -mno-debug -mesa -mzarch}
647 @emph{CRIS Options}
648 @gccoptlist{
649 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
650 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
651 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
652 -mstack-align -mdata-align -mconst-align @gol
653 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
654 -melf -maout -melinux -mlinux -sim -sim2}
656 @emph{PDP-11 Options}
657 @gccoptlist{
658 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
659 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
660 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
661 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
662 -mbranch-expensive  -mbranch-cheap @gol
663 -msplit  -mno-split  -munix-asm  -mdec-asm}
665 @emph{Xstormy16 Options}
666 @gccoptlist{
667 -msim}
669 @emph{Xtensa Options}
670 @gccoptlist{
671 -mbig-endian -mlittle-endian @gol
672 -mdensity -mno-density @gol
673 -mmac16 -mno-mac16 @gol
674 -mmul16 -mno-mul16 @gol
675 -mmul32 -mno-mul32 @gol
676 -mnsa -mno-nsa @gol
677 -mminmax -mno-minmax @gol
678 -msext -mno-sext @gol
679 -mbooleans -mno-booleans @gol
680 -mhard-float -msoft-float @gol
681 -mfused-madd -mno-fused-madd @gol
682 -mserialize-volatile -mno-serialize-volatile @gol
683 -mtext-section-literals -mno-text-section-literals @gol
684 -mtarget-align -mno-target-align @gol
685 -mlongcalls -mno-longcalls}
687 @emph{FRV Options}
688 @gccoptlist{
689 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
690 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
691 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
692 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
693 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
694 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
695 -mno-nested-cond-exec -mtomcat-stats @gol
696 -mcpu=@var{cpu}}
700 @item Code Generation Options
701 @xref{Code Gen Options,,Options for Code Generation Conventions}.
702 @gccoptlist{
703 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
704 -ffixed-@var{reg} -fexceptions @gol
705 -fnon-call-exceptions  -funwind-tables @gol
706 -fasynchronous-unwind-tables @gol
707 -finhibit-size-directive  -finstrument-functions @gol
708 -fno-common  -fno-ident  -fno-gnu-linker @gol
709 -fpcc-struct-return  -fpic  -fPIC @gol
710 -freg-struct-return  -fshared-data  -fshort-enums @gol
711 -fshort-double  -fshort-wchar @gol
712 -fverbose-asm  -fpack-struct  -fstack-check @gol
713 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
714 -fargument-alias  -fargument-noalias @gol
715 -fargument-noalias-global  -fleading-underscore @gol
716 -ftls-model=@var{model} @gol
717 -ftrapv -fbounds-check}
718 @end table
720 @menu
721 * Overall Options::     Controlling the kind of output:
722                         an executable, object files, assembler files,
723                         or preprocessed source.
724 * C Dialect Options::   Controlling the variant of C language compiled.
725 * C++ Dialect Options:: Variations on C++.
726 * Objective-C Dialect Options:: Variations on Objective-C.
727 * Language Independent Options:: Controlling how diagnostics should be
728                         formatted.
729 * Warning Options::     How picky should the compiler be?
730 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
731 * Optimize Options::    How much optimization?
732 * Preprocessor Options:: Controlling header files and macro definitions.
733                          Also, getting dependency information for Make.
734 * Assembler Options::   Passing options to the assembler.
735 * Link Options::        Specifying libraries and so on.
736 * Directory Options::   Where to find header files and libraries.
737                         Where to find the compiler executable files.
738 * Spec Files::          How to pass switches to sub-processes.
739 * Target Options::      Running a cross-compiler, or an old version of GCC.
740 @end menu
742 @node Overall Options
743 @section Options Controlling the Kind of Output
745 Compilation can involve up to four stages: preprocessing, compilation
746 proper, assembly and linking, always in that order.  The first three
747 stages apply to an individual source file, and end by producing an
748 object file; linking combines all the object files (those newly
749 compiled, and those specified as input) into an executable file.
751 @cindex file name suffix
752 For any given input file, the file name suffix determines what kind of
753 compilation is done:
755 @table @gcctabopt
756 @item @var{file}.c
757 C source code which must be preprocessed.
759 @item @var{file}.i
760 C source code which should not be preprocessed.
762 @item @var{file}.ii
763 C++ source code which should not be preprocessed.
765 @item @var{file}.m
766 Objective-C source code.  Note that you must link with the library
767 @file{libobjc.a} to make an Objective-C program work.
769 @item @var{file}.mi
770 Objective-C source code which should not be preprocessed.
772 @item @var{file}.h
773 C or C++ header file to be turned into a precompiled header.
775 @item @var{file}.cc
776 @itemx @var{file}.cp
777 @itemx @var{file}.cxx
778 @itemx @var{file}.cpp
779 @itemx @var{file}.CPP
780 @itemx @var{file}.c++
781 @itemx @var{file}.C
782 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
783 the last two letters must both be literally @samp{x}.  Likewise,
784 @samp{.C} refers to a literal capital C@.
786 @item @var{file}.hh
787 @itemx @var{file}.H
788 C++ header file to be turned into a precompiled header.
790 @item @var{file}.f
791 @itemx @var{file}.for
792 @itemx @var{file}.FOR
793 Fortran source code which should not be preprocessed.
795 @item @var{file}.F
796 @itemx @var{file}.fpp
797 @itemx @var{file}.FPP
798 Fortran source code which must be preprocessed (with the traditional
799 preprocessor).
801 @item @var{file}.r
802 Fortran source code which must be preprocessed with a RATFOR
803 preprocessor (not included with GCC)@.
805 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
806 Using and Porting GNU Fortran}, for more details of the handling of
807 Fortran input files.
809 @c FIXME: Descriptions of Java file types.
810 @c @var{file}.java
811 @c @var{file}.class
812 @c @var{file}.zip
813 @c @var{file}.jar
815 @item @var{file}.ads
816 Ada source code file which contains a library unit declaration (a
817 declaration of a package, subprogram, or generic, or a generic
818 instantiation), or a library unit renaming declaration (a package,
819 generic, or subprogram renaming declaration).  Such files are also
820 called @dfn{specs}.
822 @itemx @var{file}.adb
823 Ada source code file containing a library unit body (a subprogram or
824 package body).  Such files are also called @dfn{bodies}.
826 @c GCC also knows about some suffixes for languages not yet included:
827 @c Pascal:
828 @c @var{file}.p
829 @c @var{file}.pas
831 @item @var{file}.s
832 Assembler code.
834 @item @var{file}.S
835 Assembler code which must be preprocessed.
837 @item @var{other}
838 An object file to be fed straight into linking.
839 Any file name with no recognized suffix is treated this way.
840 @end table
842 @opindex x
843 You can specify the input language explicitly with the @option{-x} option:
845 @table @gcctabopt
846 @item -x @var{language}
847 Specify explicitly the @var{language} for the following input files
848 (rather than letting the compiler choose a default based on the file
849 name suffix).  This option applies to all following input files until
850 the next @option{-x} option.  Possible values for @var{language} are:
851 @example
852 c  c-header  cpp-output
853 c++  c++-header  c++-cpp-output
854 objective-c  objc-cpp-output
855 assembler  assembler-with-cpp
857 f77  f77-cpp-input  ratfor
858 java
859 treelang
860 @end example
862 @item -x none
863 Turn off any specification of a language, so that subsequent files are
864 handled according to their file name suffixes (as they are if @option{-x}
865 has not been used at all).
867 @item -pass-exit-codes
868 @opindex pass-exit-codes
869 Normally the @command{gcc} program will exit with the code of 1 if any
870 phase of the compiler returns a non-success return code.  If you specify
871 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
872 numerically highest error produced by any phase that returned an error
873 indication.
874 @end table
876 If you only want some of the stages of compilation, you can use
877 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
878 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
879 @command{gcc} is to stop.  Note that some combinations (for example,
880 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
882 @table @gcctabopt
883 @item -c
884 @opindex c
885 Compile or assemble the source files, but do not link.  The linking
886 stage simply is not done.  The ultimate output is in the form of an
887 object file for each source file.
889 By default, the object file name for a source file is made by replacing
890 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
892 Unrecognized input files, not requiring compilation or assembly, are
893 ignored.
895 @item -S
896 @opindex S
897 Stop after the stage of compilation proper; do not assemble.  The output
898 is in the form of an assembler code file for each non-assembler input
899 file specified.
901 By default, the assembler file name for a source file is made by
902 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
904 Input files that don't require compilation are ignored.
906 @item -E
907 @opindex E
908 Stop after the preprocessing stage; do not run the compiler proper.  The
909 output is in the form of preprocessed source code, which is sent to the
910 standard output.
912 Input files which don't require preprocessing are ignored.
914 @cindex output file option
915 @item -o @var{file}
916 @opindex o
917 Place output in file @var{file}.  This applies regardless to whatever
918 sort of output is being produced, whether it be an executable file,
919 an object file, an assembler file or preprocessed C code.
921 Since only one output file can be specified, it does not make sense to
922 use @option{-o} when compiling more than one input file, unless you are
923 producing an executable file as output.
925 If @option{-o} is not specified, the default is to put an executable file
926 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
927 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
928 all preprocessed C source on standard output.
930 @item -v
931 @opindex v
932 Print (on standard error output) the commands executed to run the stages
933 of compilation.  Also print the version number of the compiler driver
934 program and of the preprocessor and the compiler proper.
936 @item -###
937 @opindex ###
938 Like @option{-v} except the commands are not executed and all command
939 arguments are quoted.  This is useful for shell scripts to capture the
940 driver-generated command lines.
942 @item -pipe
943 @opindex pipe
944 Use pipes rather than temporary files for communication between the
945 various stages of compilation.  This fails to work on some systems where
946 the assembler is unable to read from a pipe; but the GNU assembler has
947 no trouble.
949 @item --help
950 @opindex help
951 Print (on the standard output) a description of the command line options
952 understood by @command{gcc}.  If the @option{-v} option is also specified
953 then @option{--help} will also be passed on to the various processes
954 invoked by @command{gcc}, so that they can display the command line options
955 they accept.  If the @option{-Wextra} option is also specified then command
956 line options which have no documentation associated with them will also
957 be displayed.
959 @item --target-help
960 @opindex target-help
961 Print (on the standard output) a description of target specific command
962 line options for each tool.
964 @item --version
965 @opindex version
966 Display the version number and copyrights of the invoked GCC.
967 @end table
969 @node Invoking G++
970 @section Compiling C++ Programs
972 @cindex suffixes for C++ source
973 @cindex C++ source file suffixes
974 C++ source files conventionally use one of the suffixes @samp{.C},
975 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
976 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
977 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
978 files with these names and compiles them as C++ programs even if you
979 call the compiler the same way as for compiling C programs (usually
980 with the name @command{gcc}).
982 @findex g++
983 @findex c++
984 However, C++ programs often require class libraries as well as a
985 compiler that understands the C++ language---and under some
986 circumstances, you might want to compile programs or header files from
987 standard input, or otherwise without a suffix that flags them as C++
988 programs.  You might also like to precompile a C header file with a
989 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
990 program that calls GCC with the default language set to C++, and
991 automatically specifies linking against the C++ library.  On many
992 systems, @command{g++} is also installed with the name @command{c++}.
994 @cindex invoking @command{g++}
995 When you compile C++ programs, you may specify many of the same
996 command-line options that you use for compiling programs in any
997 language; or command-line options meaningful for C and related
998 languages; or options that are meaningful only for C++ programs.
999 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1000 explanations of options for languages related to C@.
1001 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1002 explanations of options that are meaningful only for C++ programs.
1004 @node C Dialect Options
1005 @section Options Controlling C Dialect
1006 @cindex dialect options
1007 @cindex language dialect options
1008 @cindex options, dialect
1010 The following options control the dialect of C (or languages derived
1011 from C, such as C++ and Objective-C) that the compiler accepts:
1013 @table @gcctabopt
1014 @cindex ANSI support
1015 @cindex ISO support
1016 @item -ansi
1017 @opindex ansi
1018 In C mode, support all ISO C90 programs.  In C++ mode,
1019 remove GNU extensions that conflict with ISO C++.
1021 This turns off certain features of GCC that are incompatible with ISO
1022 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1023 such as the @code{asm} and @code{typeof} keywords, and
1024 predefined macros such as @code{unix} and @code{vax} that identify the
1025 type of system you are using.  It also enables the undesirable and
1026 rarely used ISO trigraph feature.  For the C compiler,
1027 it disables recognition of C++ style @samp{//} comments as well as
1028 the @code{inline} keyword.
1030 The alternate keywords @code{__asm__}, @code{__extension__},
1031 @code{__inline__} and @code{__typeof__} continue to work despite
1032 @option{-ansi}.  You would not want to use them in an ISO C program, of
1033 course, but it is useful to put them in header files that might be included
1034 in compilations done with @option{-ansi}.  Alternate predefined macros
1035 such as @code{__unix__} and @code{__vax__} are also available, with or
1036 without @option{-ansi}.
1038 The @option{-ansi} option does not cause non-ISO programs to be
1039 rejected gratuitously.  For that, @option{-pedantic} is required in
1040 addition to @option{-ansi}.  @xref{Warning Options}.
1042 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1043 option is used.  Some header files may notice this macro and refrain
1044 from declaring certain functions or defining certain macros that the
1045 ISO standard doesn't call for; this is to avoid interfering with any
1046 programs that might use these names for other things.
1048 Functions which would normally be built in but do not have semantics
1049 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1050 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1051 built-in functions provided by GCC}, for details of the functions
1052 affected.
1054 @item -std=
1055 @opindex std
1056 Determine the language standard.  This option is currently only
1057 supported when compiling C or C++.  A value for this option must be
1058 provided; possible values are
1060 @table @samp
1061 @item c89
1062 @itemx iso9899:1990
1063 ISO C90 (same as @option{-ansi}).
1065 @item iso9899:199409
1066 ISO C90 as modified in amendment 1.
1068 @item c99
1069 @itemx c9x
1070 @itemx iso9899:1999
1071 @itemx iso9899:199x
1072 ISO C99.  Note that this standard is not yet fully supported; see
1073 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1074 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1076 @item gnu89
1077 Default, ISO C90 plus GNU extensions (including some C99 features).
1079 @item gnu99
1080 @item gnu9x
1081 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1082 this will become the default.  The name @samp{gnu9x} is deprecated.
1084 @item c++98
1085 The 1998 ISO C++ standard plus amendments.
1087 @item gnu++98
1088 The same as @option{-std=c++98} plus GNU extensions.  This is the
1089 default for C++ code.
1090 @end table
1092 Even when this option is not specified, you can still use some of the
1093 features of newer standards in so far as they do not conflict with
1094 previous C standards.  For example, you may use @code{__restrict__} even
1095 when @option{-std=c99} is not specified.
1097 The @option{-std} options specifying some version of ISO C have the same
1098 effects as @option{-ansi}, except that features that were not in ISO C90
1099 but are in the specified version (for example, @samp{//} comments and
1100 the @code{inline} keyword in ISO C99) are not disabled.
1102 @xref{Standards,,Language Standards Supported by GCC}, for details of
1103 these standard versions.
1105 @item -aux-info @var{filename}
1106 @opindex aux-info
1107 Output to the given filename prototyped declarations for all functions
1108 declared and/or defined in a translation unit, including those in header
1109 files.  This option is silently ignored in any language other than C@.
1111 Besides declarations, the file indicates, in comments, the origin of
1112 each declaration (source file and line), whether the declaration was
1113 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1114 @samp{O} for old, respectively, in the first character after the line
1115 number and the colon), and whether it came from a declaration or a
1116 definition (@samp{C} or @samp{F}, respectively, in the following
1117 character).  In the case of function definitions, a K&R-style list of
1118 arguments followed by their declarations is also provided, inside
1119 comments, after the declaration.
1121 @item -fno-asm
1122 @opindex fno-asm
1123 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1124 keyword, so that code can use these words as identifiers.  You can use
1125 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1126 instead.  @option{-ansi} implies @option{-fno-asm}.
1128 In C++, this switch only affects the @code{typeof} keyword, since
1129 @code{asm} and @code{inline} are standard keywords.  You may want to
1130 use the @option{-fno-gnu-keywords} flag instead, which has the same
1131 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1132 switch only affects the @code{asm} and @code{typeof} keywords, since
1133 @code{inline} is a standard keyword in ISO C99.
1135 @item -fno-builtin
1136 @itemx -fno-builtin-@var{function}
1137 @opindex fno-builtin
1138 @cindex built-in functions
1139 Don't recognize built-in functions that do not begin with
1140 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1141 functions provided by GCC}, for details of the functions affected,
1142 including those which are not built-in functions when @option{-ansi} or
1143 @option{-std} options for strict ISO C conformance are used because they
1144 do not have an ISO standard meaning.
1146 GCC normally generates special code to handle certain built-in functions
1147 more efficiently; for instance, calls to @code{alloca} may become single
1148 instructions that adjust the stack directly, and calls to @code{memcpy}
1149 may become inline copy loops.  The resulting code is often both smaller
1150 and faster, but since the function calls no longer appear as such, you
1151 cannot set a breakpoint on those calls, nor can you change the behavior
1152 of the functions by linking with a different library.
1154 With the @option{-fno-builtin-@var{function}} option
1155 only the built-in function @var{function} is
1156 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1157 function is named this is not built-in in this version of GCC, this
1158 option is ignored.  There is no corresponding
1159 @option{-fbuiltin-@var{function}} option; if you wish to enable
1160 built-in functions selectively when using @option{-fno-builtin} or
1161 @option{-ffreestanding}, you may define macros such as:
1163 @smallexample
1164 #define abs(n)          __builtin_abs ((n))
1165 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1166 @end smallexample
1168 @item -fhosted
1169 @opindex fhosted
1170 @cindex hosted environment
1172 Assert that compilation takes place in a hosted environment.  This implies
1173 @option{-fbuiltin}.  A hosted environment is one in which the
1174 entire standard library is available, and in which @code{main} has a return
1175 type of @code{int}.  Examples are nearly everything except a kernel.
1176 This is equivalent to @option{-fno-freestanding}.
1178 @item -ffreestanding
1179 @opindex ffreestanding
1180 @cindex hosted environment
1182 Assert that compilation takes place in a freestanding environment.  This
1183 implies @option{-fno-builtin}.  A freestanding environment
1184 is one in which the standard library may not exist, and program startup may
1185 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1186 This is equivalent to @option{-fno-hosted}.
1188 @xref{Standards,,Language Standards Supported by GCC}, for details of
1189 freestanding and hosted environments.
1191 @item -fms-extensions
1192 @opindex fms-extensions
1193 Accept some non-standard constructs used in Microsoft header files.
1195 @item -trigraphs
1196 @opindex trigraphs
1197 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1198 options for strict ISO C conformance) implies @option{-trigraphs}.
1200 @cindex traditional C language
1201 @cindex C language, traditional
1202 @item -traditional
1203 @itemx -traditional-cpp
1204 @opindex traditional-cpp
1205 @opindex traditional
1206 Formerly, these options caused GCC to attempt to emulate a pre-standard
1207 C compiler.  They are now only supported with the @option{-E} switch.
1208 The preprocessor continues to support a pre-standard mode.  See the GNU
1209 CPP manual for details.
1211 @item -fcond-mismatch
1212 @opindex fcond-mismatch
1213 Allow conditional expressions with mismatched types in the second and
1214 third arguments.  The value of such an expression is void.  This option
1215 is not supported for C++.
1217 @item -funsigned-char
1218 @opindex funsigned-char
1219 Let the type @code{char} be unsigned, like @code{unsigned char}.
1221 Each kind of machine has a default for what @code{char} should
1222 be.  It is either like @code{unsigned char} by default or like
1223 @code{signed char} by default.
1225 Ideally, a portable program should always use @code{signed char} or
1226 @code{unsigned char} when it depends on the signedness of an object.
1227 But many programs have been written to use plain @code{char} and
1228 expect it to be signed, or expect it to be unsigned, depending on the
1229 machines they were written for.  This option, and its inverse, let you
1230 make such a program work with the opposite default.
1232 The type @code{char} is always a distinct type from each of
1233 @code{signed char} or @code{unsigned char}, even though its behavior
1234 is always just like one of those two.
1236 @item -fsigned-char
1237 @opindex fsigned-char
1238 Let the type @code{char} be signed, like @code{signed char}.
1240 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1241 the negative form of @option{-funsigned-char}.  Likewise, the option
1242 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1244 @item -fsigned-bitfields
1245 @itemx -funsigned-bitfields
1246 @itemx -fno-signed-bitfields
1247 @itemx -fno-unsigned-bitfields
1248 @opindex fsigned-bitfields
1249 @opindex funsigned-bitfields
1250 @opindex fno-signed-bitfields
1251 @opindex fno-unsigned-bitfields
1252 These options control whether a bit-field is signed or unsigned, when the
1253 declaration does not use either @code{signed} or @code{unsigned}.  By
1254 default, such a bit-field is signed, because this is consistent: the
1255 basic integer types such as @code{int} are signed types.
1257 @item -fwritable-strings
1258 @opindex fwritable-strings
1259 Store string constants in the writable data segment and don't uniquize
1260 them.  This is for compatibility with old programs which assume they can
1261 write into string constants.
1263 Writing into string constants is a very bad idea; ``constants'' should
1264 be constant.
1265 @end table
1267 @node C++ Dialect Options
1268 @section Options Controlling C++ Dialect
1270 @cindex compiler options, C++
1271 @cindex C++ options, command line
1272 @cindex options, C++
1273 This section describes the command-line options that are only meaningful
1274 for C++ programs; but you can also use most of the GNU compiler options
1275 regardless of what language your program is in.  For example, you
1276 might compile a file @code{firstClass.C} like this:
1278 @example
1279 g++ -g -frepo -O -c firstClass.C
1280 @end example
1282 @noindent
1283 In this example, only @option{-frepo} is an option meant
1284 only for C++ programs; you can use the other options with any
1285 language supported by GCC@.
1287 Here is a list of options that are @emph{only} for compiling C++ programs:
1289 @table @gcctabopt
1291 @item -fabi-version=@var{n}
1292 @opindex fabi-version
1293 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1294 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1295 version that conforms most closely to the C++ ABI specification.
1296 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1297 fixed.
1299 The default is version 1.
1301 @item -fno-access-control
1302 @opindex fno-access-control
1303 Turn off all access checking.  This switch is mainly useful for working
1304 around bugs in the access control code.
1306 @item -fcheck-new
1307 @opindex fcheck-new
1308 Check that the pointer returned by @code{operator new} is non-null
1309 before attempting to modify the storage allocated.  The current Working
1310 Paper requires that @code{operator new} never return a null pointer, so
1311 this check is normally unnecessary.
1313 An alternative to using this option is to specify that your
1314 @code{operator new} does not throw any exceptions; if you declare it
1315 @samp{throw()}, G++ will check the return value.  See also @samp{new
1316 (nothrow)}.
1318 @item -fconserve-space
1319 @opindex fconserve-space
1320 Put uninitialized or runtime-initialized global variables into the
1321 common segment, as C does.  This saves space in the executable at the
1322 cost of not diagnosing duplicate definitions.  If you compile with this
1323 flag and your program mysteriously crashes after @code{main()} has
1324 completed, you may have an object that is being destroyed twice because
1325 two definitions were merged.
1327 This option is no longer useful on most targets, now that support has
1328 been added for putting variables into BSS without making them common.
1330 @item -fno-const-strings
1331 @opindex fno-const-strings
1332 Give string constants type @code{char *} instead of type @code{const
1333 char *}.  By default, G++ uses type @code{const char *} as required by
1334 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1335 actually modify the value of a string constant, unless you also use
1336 @option{-fwritable-strings}.
1338 This option might be removed in a future release of G++.  For maximum
1339 portability, you should structure your code so that it works with
1340 string constants that have type @code{const char *}.
1342 @item -fdollars-in-identifiers
1343 @opindex fdollars-in-identifiers
1344 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1345 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1346 @samp{$} by default on most target systems, but there are a few exceptions.)
1347 Traditional C allowed the character @samp{$} to form part of
1348 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1350 @item -fno-elide-constructors
1351 @opindex fno-elide-constructors
1352 The C++ standard allows an implementation to omit creating a temporary
1353 which is only used to initialize another object of the same type.
1354 Specifying this option disables that optimization, and forces G++ to
1355 call the copy constructor in all cases.
1357 @item -fno-enforce-eh-specs
1358 @opindex fno-enforce-eh-specs
1359 Don't check for violation of exception specifications at runtime.  This
1360 option violates the C++ standard, but may be useful for reducing code
1361 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1362 will still optimize based on the exception specifications.
1364 @item -fexternal-templates
1365 @opindex fexternal-templates
1367 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1368 template instantiation; template instances are emitted or not according
1369 to the location of the template definition.  @xref{Template
1370 Instantiation}, for more information.
1372 This option is deprecated.
1374 @item -falt-external-templates
1375 @opindex falt-external-templates
1376 Similar to @option{-fexternal-templates}, but template instances are
1377 emitted or not according to the place where they are first instantiated.
1378 @xref{Template Instantiation}, for more information.
1380 This option is deprecated.
1382 @item -ffor-scope
1383 @itemx -fno-for-scope
1384 @opindex ffor-scope
1385 @opindex fno-for-scope
1386 If @option{-ffor-scope} is specified, the scope of variables declared in
1387 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1388 as specified by the C++ standard.
1389 If @option{-fno-for-scope} is specified, the scope of variables declared in
1390 a @i{for-init-statement} extends to the end of the enclosing scope,
1391 as was the case in old versions of G++, and other (traditional)
1392 implementations of C++.
1394 The default if neither flag is given to follow the standard,
1395 but to allow and give a warning for old-style code that would
1396 otherwise be invalid, or have different behavior.
1398 @item -fno-gnu-keywords
1399 @opindex fno-gnu-keywords
1400 Do not recognize @code{typeof} as a keyword, so that code can use this
1401 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1402 @option{-ansi} implies @option{-fno-gnu-keywords}.
1404 @item -fno-implicit-templates
1405 @opindex fno-implicit-templates
1406 Never emit code for non-inline templates which are instantiated
1407 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1408 @xref{Template Instantiation}, for more information.
1410 @item -fno-implicit-inline-templates
1411 @opindex fno-implicit-inline-templates
1412 Don't emit code for implicit instantiations of inline templates, either.
1413 The default is to handle inlines differently so that compiles with and
1414 without optimization will need the same set of explicit instantiations.
1416 @item -fno-implement-inlines
1417 @opindex fno-implement-inlines
1418 To save space, do not emit out-of-line copies of inline functions
1419 controlled by @samp{#pragma implementation}.  This will cause linker
1420 errors if these functions are not inlined everywhere they are called.
1422 @item -fms-extensions
1423 @opindex fms-extensions
1424 Disable pedantic warnings about constructs used in MFC, such as implicit
1425 int and getting a pointer to member function via non-standard syntax.
1427 @item -fno-nonansi-builtins
1428 @opindex fno-nonansi-builtins
1429 Disable built-in declarations of functions that are not mandated by
1430 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1431 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1433 @item -fno-operator-names
1434 @opindex fno-operator-names
1435 Do not treat the operator name keywords @code{and}, @code{bitand},
1436 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1437 synonyms as keywords.
1439 @item -fno-optional-diags
1440 @opindex fno-optional-diags
1441 Disable diagnostics that the standard says a compiler does not need to
1442 issue.  Currently, the only such diagnostic issued by G++ is the one for
1443 a name having multiple meanings within a class.
1445 @item -fpermissive
1446 @opindex fpermissive
1447 Downgrade messages about nonconformant code from errors to warnings.  By
1448 default, G++ effectively sets @option{-pedantic-errors} without
1449 @option{-pedantic}; this option reverses that.  This behavior and this
1450 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1452 @item -frepo
1453 @opindex frepo
1454 Enable automatic template instantiation at link time.  This option also
1455 implies @option{-fno-implicit-templates}.  @xref{Template
1456 Instantiation}, for more information.
1458 @item -fno-rtti
1459 @opindex fno-rtti
1460 Disable generation of information about every class with virtual
1461 functions for use by the C++ runtime type identification features
1462 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1463 of the language, you can save some space by using this flag.  Note that
1464 exception handling uses the same information, but it will generate it as
1465 needed.
1467 @item -fstats
1468 @opindex fstats
1469 Emit statistics about front-end processing at the end of the compilation.
1470 This information is generally only useful to the G++ development team.
1472 @item -ftemplate-depth-@var{n}
1473 @opindex ftemplate-depth
1474 Set the maximum instantiation depth for template classes to @var{n}.
1475 A limit on the template instantiation depth is needed to detect
1476 endless recursions during template class instantiation.  ANSI/ISO C++
1477 conforming programs must not rely on a maximum depth greater than 17.
1479 @item -fuse-cxa-atexit
1480 @opindex fuse-cxa-atexit
1481 Register destructors for objects with static storage duration with the
1482 @code{__cxa_atexit} function rather than the @code{atexit} function.
1483 This option is required for fully standards-compliant handling of static
1484 destructors, but will only work if your C library supports
1485 @code{__cxa_atexit}.
1487 @item -fvtable-gc
1488 @opindex fvtable-gc
1489 Emit special relocations for vtables and virtual function references
1490 so that the linker can identify unused virtual functions and zero out
1491 vtable slots that refer to them.  This is most useful with
1492 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1493 also discard the functions themselves.
1495 This optimization requires GNU as and GNU ld.  Not all systems support
1496 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1498 @item -fno-weak
1499 @opindex fno-weak
1500 Do not use weak symbol support, even if it is provided by the linker.
1501 By default, G++ will use weak symbols if they are available.  This
1502 option exists only for testing, and should not be used by end-users;
1503 it will result in inferior code and has no benefits.  This option may
1504 be removed in a future release of G++.
1506 @item -nostdinc++
1507 @opindex nostdinc++
1508 Do not search for header files in the standard directories specific to
1509 C++, but do still search the other standard directories.  (This option
1510 is used when building the C++ library.)
1511 @end table
1513 In addition, these optimization, warning, and code generation options
1514 have meanings only for C++ programs:
1516 @table @gcctabopt
1517 @item -fno-default-inline
1518 @opindex fno-default-inline
1519 Do not assume @samp{inline} for functions defined inside a class scope.
1520 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1521 functions will have linkage like inline functions; they just won't be
1522 inlined by default.
1524 @item -Wabi @r{(C++ only)}
1525 @opindex Wabi
1526 Warn when G++ generates code that is probably not compatible with the
1527 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1528 all such cases, there are probably some cases that are not warned about, 
1529 even though G++ is generating incompatible code.  There may also be
1530 cases where warnings are emitted even though the code that is generated
1531 will be compatible.
1533 You should rewrite your code to avoid these warnings if you are
1534 concerned about the fact that code generated by G++ may not be binary
1535 compatible with code generated by other compilers.
1537 The known incompatibilities at this point include:
1539 @itemize @bullet
1541 @item
1542 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1543 pack data into the same byte as a base class.  For example:
1545 @smallexample
1546 struct A @{ virtual void f(); int f1 : 1; @};
1547 struct B : public A @{ int f2 : 1; @};
1548 @end smallexample
1550 @noindent
1551 In this case, G++ will place @code{B::f2} into the same byte
1552 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1553 by explicitly padding @code{A} so that its size is a multiple of the
1554 byte size on your platform; that will cause G++ and other compilers to
1555 layout @code{B} identically.
1557 @item
1558 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1559 tail padding when laying out virtual bases.  For example:
1561 @smallexample
1562 struct A @{ virtual void f(); char c1; @};
1563 struct B @{ B(); char c2; @};
1564 struct C : public A, public virtual B @{@};
1565 @end smallexample
1567 @noindent
1568 In this case, G++ will not place @code{B} into the tail-padding for
1569 @code{A}; other compilers will.  You can avoid this problem by
1570 explicitly padding @code{A} so that its size is a multiple of its
1571 alignment (ignoring virtual base classes); that will cause G++ and other
1572 compilers to layout @code{C} identically.
1574 @item
1575 Incorrect handling of bit-fields with declared widths greater than that
1576 of their underlying types, when the bit-fields appear in a union.  For
1577 example:
1579 @smallexample
1580 union U @{ int i : 4096; @};
1581 @end smallexample
1583 @noindent
1584 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1585 union too small by the number of bits in an @code{int}.
1587 @item
1588 Empty classes can be placed at incorrect offsets.  For example:
1590 @smallexample
1591 struct A @{@};
1593 struct B @{
1594   A a;
1595   virtual void f ();
1598 struct C : public B, public A @{@};
1599 @end smallexample
1601 @noindent
1602 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1603 it should be placed at offset zero.  G++ mistakenly believes that the
1604 @code{A} data member of @code{B} is already at offset zero.
1606 @item
1607 Names of template functions whose types involve @code{typename} or
1608 template template parameters can be mangled incorrectly.
1610 @smallexample
1611 template <typename Q>
1612 void f(typename Q::X) @{@}
1614 template <template <typename> class Q>
1615 void f(typename Q<int>::X) @{@}
1616 @end smallexample
1618 @noindent
1619 Instantiations of these templates may be mangled incorrectly.
1621 @end itemize
1623 @item -Wctor-dtor-privacy @r{(C++ only)}
1624 @opindex Wctor-dtor-privacy
1625 Warn when a class seems unusable, because all the constructors or
1626 destructors in a class are private and the class has no friends or
1627 public static member functions.  This warning is enabled by default.
1629 @item -Wnon-virtual-dtor @r{(C++ only)}
1630 @opindex Wnon-virtual-dtor
1631 Warn when a class declares a non-virtual destructor that should probably
1632 be virtual, because it looks like the class will be used polymorphically.
1633 This warning is enabled by @option{-Wall}.
1635 @item -Wreorder @r{(C++ only)}
1636 @opindex Wreorder
1637 @cindex reordering, warning
1638 @cindex warning for reordering of member initializers
1639 Warn when the order of member initializers given in the code does not
1640 match the order in which they must be executed.  For instance:
1642 @smallexample
1643 struct A @{
1644   int i;
1645   int j;
1646   A(): j (0), i (1) @{ @}
1648 @end smallexample
1650 Here the compiler will warn that the member initializers for @samp{i}
1651 and @samp{j} will be rearranged to match the declaration order of the
1652 members.  This warning is enabled by @option{-Wall}.
1653 @end table
1655 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1657 @table @gcctabopt
1658 @item -Weffc++ @r{(C++ only)}
1659 @opindex Weffc++
1660 Warn about violations of the following style guidelines from Scott Meyers'
1661 @cite{Effective C++} book:
1663 @itemize @bullet
1664 @item
1665 Item 11:  Define a copy constructor and an assignment operator for classes
1666 with dynamically allocated memory.
1668 @item
1669 Item 12:  Prefer initialization to assignment in constructors.
1671 @item
1672 Item 14:  Make destructors virtual in base classes.
1674 @item
1675 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1677 @item
1678 Item 23:  Don't try to return a reference when you must return an object.
1680 @end itemize
1682 and about violations of the following style guidelines from Scott Meyers'
1683 @cite{More Effective C++} book:
1685 @itemize @bullet
1686 @item
1687 Item 6:  Distinguish between prefix and postfix forms of increment and
1688 decrement operators.
1690 @item
1691 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1693 @end itemize
1695 If you use this option, you should be aware that the standard library
1696 headers do not obey all of these guidelines; you can use @samp{grep -v}
1697 to filter out those warnings.
1699 @item -Wno-deprecated @r{(C++ only)}
1700 @opindex Wno-deprecated
1701 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1703 @item -Wno-non-template-friend @r{(C++ only)}
1704 @opindex Wno-non-template-friend
1705 Disable warnings when non-templatized friend functions are declared
1706 within a template.  With the advent of explicit template specification
1707 support in G++, if the name of the friend is an unqualified-id (i.e.,
1708 @samp{friend foo(int)}), the C++ language specification demands that the
1709 friend declare or define an ordinary, nontemplate function.  (Section
1710 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1711 could be interpreted as a particular specialization of a templatized
1712 function.  Because this non-conforming behavior is no longer the default
1713 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1714 check existing code for potential trouble spots, and is on by default.
1715 This new compiler behavior can be turned off with
1716 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1717 but disables the helpful warning.
1719 @item -Wold-style-cast @r{(C++ only)}
1720 @opindex Wold-style-cast
1721 Warn if an old-style (C-style) cast to a non-void type is used within
1722 a C++ program.  The new-style casts (@samp{static_cast},
1723 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1724 unintended effects, and much easier to grep for.
1726 @item -Woverloaded-virtual @r{(C++ only)}
1727 @opindex Woverloaded-virtual
1728 @cindex overloaded virtual fn, warning
1729 @cindex warning for overloaded virtual fn
1730 Warn when a function declaration hides virtual functions from a
1731 base class.  For example, in:
1733 @smallexample
1734 struct A @{
1735   virtual void f();
1738 struct B: public A @{
1739   void f(int);
1741 @end smallexample
1743 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1744 like this:
1746 @smallexample
1747 B* b;
1748 b->f();
1749 @end smallexample
1751 will fail to compile.
1753 @item -Wno-pmf-conversions @r{(C++ only)}
1754 @opindex Wno-pmf-conversions
1755 Disable the diagnostic for converting a bound pointer to member function
1756 to a plain pointer.
1758 @item -Wsign-promo @r{(C++ only)}
1759 @opindex Wsign-promo
1760 Warn when overload resolution chooses a promotion from unsigned or
1761 enumeral type to a signed type over a conversion to an unsigned type of
1762 the same size.  Previous versions of G++ would try to preserve
1763 unsignedness, but the standard mandates the current behavior.
1765 @item -Wsynth @r{(C++ only)}
1766 @opindex Wsynth
1767 @cindex warning for synthesized methods
1768 @cindex synthesized methods, warning
1769 Warn when G++'s synthesis behavior does not match that of cfront.  For
1770 instance:
1772 @smallexample
1773 struct A @{
1774   operator int ();
1775   A& operator = (int);
1778 main ()
1780   A a,b;
1781   a = b;
1783 @end smallexample
1785 In this example, G++ will synthesize a default @samp{A& operator =
1786 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1787 @end table
1789 @node Objective-C Dialect Options
1790 @section Options Controlling Objective-C Dialect
1792 @cindex compiler options, Objective-C
1793 @cindex Objective-C options, command line
1794 @cindex options, Objective-C
1795 This section describes the command-line options that are only meaningful
1796 for Objective-C programs; but you can also use most of the GNU compiler
1797 options regardless of what language your program is in.  For example,
1798 you might compile a file @code{some_class.m} like this:
1800 @example
1801 gcc -g -fgnu-runtime -O -c some_class.m
1802 @end example
1804 @noindent
1805 In this example, only @option{-fgnu-runtime} is an option meant only for
1806 Objective-C programs; you can use the other options with any language
1807 supported by GCC@.
1809 Here is a list of options that are @emph{only} for compiling Objective-C
1810 programs:
1812 @table @gcctabopt
1813 @item -fconstant-string-class=@var{class-name}
1814 @opindex fconstant-string-class
1815 Use @var{class-name} as the name of the class to instantiate for each
1816 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1817 class name is @code{NXConstantString}.
1819 @item -fgnu-runtime
1820 @opindex fgnu-runtime
1821 Generate object code compatible with the standard GNU Objective-C
1822 runtime.  This is the default for most types of systems.
1824 @item -fnext-runtime
1825 @opindex fnext-runtime
1826 Generate output compatible with the NeXT runtime.  This is the default
1827 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1828 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1829 used.
1831 @item -gen-decls
1832 @opindex gen-decls
1833 Dump interface declarations for all classes seen in the source file to a
1834 file named @file{@var{sourcename}.decl}.
1836 @item -Wno-protocol
1837 @opindex Wno-protocol
1838 If a class is declared to implement a protocol, a warning is issued for
1839 every method in the protocol that is not implemented by the class.  The
1840 default behavior is to issue a warning for every method not explicitly
1841 implemented in the class, even if a method implementation is inherited
1842 from the superclass.  If you use the @code{-Wno-protocol} option, then
1843 methods inherited from the superclass are considered to be implemented,
1844 and no warning is issued for them.
1846 @item -Wselector
1847 @opindex Wselector
1848 Warn if multiple methods of different types for the same selector are
1849 found during compilation.  The check is performed on the list of methods
1850 in the final stage of compilation.  Additionally, a check is performed
1851 that for each selector appearing in a @code{@@selector(@dots{})}
1852 expression, a corresponding method with that selector has been found
1853 during compilation.  Because these checks scan the method table only at
1854 the end of compilation, these warnings are not produced if the final
1855 stage of compilation is not reached, for example because an error is
1856 found during compilation, or because the @code{-fsyntax-only} option is
1857 being used.
1859 @item -Wundeclared-selector
1860 @opindex Wundeclared-selector
1861 Warn if a @code{@@selector(@dots{})} expression referring to an
1862 undeclared selector is found.  A selector is considered undeclared if no
1863 method with that name has been declared (explicitly, in an
1864 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1865 an @code{@@implementation} section) before the
1866 @code{@@selector(@dots{})} expression.  This option always performs its
1867 checks as soon as a @code{@@selector(@dots{})} expression is found
1868 (while @code{-Wselector} only performs its checks in the final stage of
1869 compilation), and so additionally enforces the coding style convention
1870 that methods and selectors must be declared before being used.
1872 @c not documented because only avail via -Wp
1873 @c @item -print-objc-runtime-info
1875 @end table
1877 @node Language Independent Options
1878 @section Options to Control Diagnostic Messages Formatting
1879 @cindex options to control diagnostics formatting
1880 @cindex diagnostic messages
1881 @cindex message formatting
1883 Traditionally, diagnostic messages have been formatted irrespective of
1884 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1885 below can be used to control the diagnostic messages formatting
1886 algorithm, e.g.@: how many characters per line, how often source location
1887 information should be reported.  Right now, only the C++ front end can
1888 honor these options.  However it is expected, in the near future, that
1889 the remaining front ends would be able to digest them correctly.
1891 @table @gcctabopt
1892 @item -fmessage-length=@var{n}
1893 @opindex fmessage-length
1894 Try to format error messages so that they fit on lines of about @var{n}
1895 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1896 the front ends supported by GCC@.  If @var{n} is zero, then no
1897 line-wrapping will be done; each error message will appear on a single
1898 line.
1900 @opindex fdiagnostics-show-location
1901 @item -fdiagnostics-show-location=once
1902 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1903 reporter to emit @emph{once} source location information; that is, in
1904 case the message is too long to fit on a single physical line and has to
1905 be wrapped, the source location won't be emitted (as prefix) again,
1906 over and over, in subsequent continuation lines.  This is the default
1907 behavior.
1909 @item -fdiagnostics-show-location=every-line
1910 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1911 messages reporter to emit the same source location information (as
1912 prefix) for physical lines that result from the process of breaking
1913 a message which is too long to fit on a single line.
1915 @end table
1917 @node Warning Options
1918 @section Options to Request or Suppress Warnings
1919 @cindex options to control warnings
1920 @cindex warning messages
1921 @cindex messages, warning
1922 @cindex suppressing warnings
1924 Warnings are diagnostic messages that report constructions which
1925 are not inherently erroneous but which are risky or suggest there
1926 may have been an error.
1928 You can request many specific warnings with options beginning @samp{-W},
1929 for example @option{-Wimplicit} to request warnings on implicit
1930 declarations.  Each of these specific warning options also has a
1931 negative form beginning @samp{-Wno-} to turn off warnings;
1932 for example, @option{-Wno-implicit}.  This manual lists only one of the
1933 two forms, whichever is not the default.
1935 The following options control the amount and kinds of warnings produced
1936 by GCC; for further, language-specific options also refer to
1937 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1939 @table @gcctabopt
1940 @cindex syntax checking
1941 @item -fsyntax-only
1942 @opindex fsyntax-only
1943 Check the code for syntax errors, but don't do anything beyond that.
1945 @item -pedantic
1946 @opindex pedantic
1947 Issue all the warnings demanded by strict ISO C and ISO C++;
1948 reject all programs that use forbidden extensions, and some other
1949 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1950 version of the ISO C standard specified by any @option{-std} option used.
1952 Valid ISO C and ISO C++ programs should compile properly with or without
1953 this option (though a rare few will require @option{-ansi} or a
1954 @option{-std} option specifying the required version of ISO C)@.  However,
1955 without this option, certain GNU extensions and traditional C and C++
1956 features are supported as well.  With this option, they are rejected.
1958 @option{-pedantic} does not cause warning messages for use of the
1959 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1960 warnings are also disabled in the expression that follows
1961 @code{__extension__}.  However, only system header files should use
1962 these escape routes; application programs should avoid them.
1963 @xref{Alternate Keywords}.
1965 Some users try to use @option{-pedantic} to check programs for strict ISO
1966 C conformance.  They soon find that it does not do quite what they want:
1967 it finds some non-ISO practices, but not all---only those for which
1968 ISO C @emph{requires} a diagnostic, and some others for which
1969 diagnostics have been added.
1971 A feature to report any failure to conform to ISO C might be useful in
1972 some instances, but would require considerable additional work and would
1973 be quite different from @option{-pedantic}.  We don't have plans to
1974 support such a feature in the near future.
1976 Where the standard specified with @option{-std} represents a GNU
1977 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1978 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1979 extended dialect is based.  Warnings from @option{-pedantic} are given
1980 where they are required by the base standard.  (It would not make sense
1981 for such warnings to be given only for features not in the specified GNU
1982 C dialect, since by definition the GNU dialects of C include all
1983 features the compiler supports with the given option, and there would be
1984 nothing to warn about.)
1986 @item -pedantic-errors
1987 @opindex pedantic-errors
1988 Like @option{-pedantic}, except that errors are produced rather than
1989 warnings.
1991 @item -w
1992 @opindex w
1993 Inhibit all warning messages.
1995 @item -Wno-import
1996 @opindex Wno-import
1997 Inhibit warning messages about the use of @samp{#import}.
1999 @item -Wchar-subscripts
2000 @opindex Wchar-subscripts
2001 Warn if an array subscript has type @code{char}.  This is a common cause
2002 of error, as programmers often forget that this type is signed on some
2003 machines.
2005 @item -Wcomment
2006 @opindex Wcomment
2007 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2008 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2010 @item -Wformat
2011 @opindex Wformat
2012 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2013 the arguments supplied have types appropriate to the format string
2014 specified, and that the conversions specified in the format string make
2015 sense.  This includes standard functions, and others specified by format
2016 attributes (@pxref{Function Attributes}), in the @code{printf},
2017 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2018 not in the C standard) families.
2020 The formats are checked against the format features supported by GNU
2021 libc version 2.2.  These include all ISO C90 and C99 features, as well
2022 as features from the Single Unix Specification and some BSD and GNU
2023 extensions.  Other library implementations may not support all these
2024 features; GCC does not support warning about features that go beyond a
2025 particular library's limitations.  However, if @option{-pedantic} is used
2026 with @option{-Wformat}, warnings will be given about format features not
2027 in the selected standard version (but not for @code{strfmon} formats,
2028 since those are not in any version of the C standard).  @xref{C Dialect
2029 Options,,Options Controlling C Dialect}.
2031 Since @option{-Wformat} also checks for null format arguments for
2032 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2034 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2035 aspects of format checking, the options @option{-Wno-format-y2k},
2036 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2037 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2038 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2040 @item -Wno-format-y2k
2041 @opindex Wno-format-y2k
2042 If @option{-Wformat} is specified, do not warn about @code{strftime}
2043 formats which may yield only a two-digit year.
2045 @item -Wno-format-extra-args
2046 @opindex Wno-format-extra-args
2047 If @option{-Wformat} is specified, do not warn about excess arguments to a
2048 @code{printf} or @code{scanf} format function.  The C standard specifies
2049 that such arguments are ignored.
2051 Where the unused arguments lie between used arguments that are
2052 specified with @samp{$} operand number specifications, normally
2053 warnings are still given, since the implementation could not know what
2054 type to pass to @code{va_arg} to skip the unused arguments.  However,
2055 in the case of @code{scanf} formats, this option will suppress the
2056 warning if the unused arguments are all pointers, since the Single
2057 Unix Specification says that such unused arguments are allowed.
2059 @item -Wno-format-zero-length
2060 @opindex Wno-format-zero-length
2061 If @option{-Wformat} is specified, do not warn about zero-length formats.
2062 The C standard specifies that zero-length formats are allowed.
2064 @item -Wformat-nonliteral
2065 @opindex Wformat-nonliteral
2066 If @option{-Wformat} is specified, also warn if the format string is not a
2067 string literal and so cannot be checked, unless the format function
2068 takes its format arguments as a @code{va_list}.
2070 @item -Wformat-security
2071 @opindex Wformat-security
2072 If @option{-Wformat} is specified, also warn about uses of format
2073 functions that represent possible security problems.  At present, this
2074 warns about calls to @code{printf} and @code{scanf} functions where the
2075 format string is not a string literal and there are no format arguments,
2076 as in @code{printf (foo);}.  This may be a security hole if the format
2077 string came from untrusted input and contains @samp{%n}.  (This is
2078 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2079 in future warnings may be added to @option{-Wformat-security} that are not
2080 included in @option{-Wformat-nonliteral}.)
2082 @item -Wformat=2
2083 @opindex Wformat=2
2084 Enable @option{-Wformat} plus format checks not included in
2085 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2086 -Wformat-nonliteral -Wformat-security}.
2088 @item -Wnonnull
2089 @opindex Wnonnull
2090 Enable warning about passing a null pointer for arguments marked as
2091 requiring a non-null value by the @code{nonnull} function attribute.
2093 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2094 can be disabled with the @option{-Wno-nonnull} option.
2096 @item -Wimplicit-int
2097 @opindex Wimplicit-int
2098 Warn when a declaration does not specify a type.
2100 @item -Wimplicit-function-declaration
2101 @itemx -Werror-implicit-function-declaration
2102 @opindex Wimplicit-function-declaration
2103 @opindex Werror-implicit-function-declaration
2104 Give a warning (or error) whenever a function is used before being
2105 declared.
2107 @item -Wimplicit
2108 @opindex Wimplicit
2109 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2111 @item -Wmain
2112 @opindex Wmain
2113 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2114 function with external linkage, returning int, taking either zero
2115 arguments, two, or three arguments of appropriate types.
2117 @item -Wmissing-braces
2118 @opindex Wmissing-braces
2119 Warn if an aggregate or union initializer is not fully bracketed.  In
2120 the following example, the initializer for @samp{a} is not fully
2121 bracketed, but that for @samp{b} is fully bracketed.
2123 @smallexample
2124 int a[2][2] = @{ 0, 1, 2, 3 @};
2125 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2126 @end smallexample
2128 @item -Wparentheses
2129 @opindex Wparentheses
2130 Warn if parentheses are omitted in certain contexts, such
2131 as when there is an assignment in a context where a truth value
2132 is expected, or when operators are nested whose precedence people
2133 often get confused about.
2135 Also warn about constructions where there may be confusion to which
2136 @code{if} statement an @code{else} branch belongs.  Here is an example of
2137 such a case:
2139 @smallexample
2140 @group
2142   if (a)
2143     if (b)
2144       foo ();
2145   else
2146     bar ();
2148 @end group
2149 @end smallexample
2151 In C, every @code{else} branch belongs to the innermost possible @code{if}
2152 statement, which in this example is @code{if (b)}.  This is often not
2153 what the programmer expected, as illustrated in the above example by
2154 indentation the programmer chose.  When there is the potential for this
2155 confusion, GCC will issue a warning when this flag is specified.
2156 To eliminate the warning, add explicit braces around the innermost
2157 @code{if} statement so there is no way the @code{else} could belong to
2158 the enclosing @code{if}.  The resulting code would look like this:
2160 @smallexample
2161 @group
2163   if (a)
2164     @{
2165       if (b)
2166         foo ();
2167       else
2168         bar ();
2169     @}
2171 @end group
2172 @end smallexample
2174 @item -Wsequence-point
2175 @opindex Wsequence-point
2176 Warn about code that may have undefined semantics because of violations
2177 of sequence point rules in the C standard.
2179 The C standard defines the order in which expressions in a C program are
2180 evaluated in terms of @dfn{sequence points}, which represent a partial
2181 ordering between the execution of parts of the program: those executed
2182 before the sequence point, and those executed after it.  These occur
2183 after the evaluation of a full expression (one which is not part of a
2184 larger expression), after the evaluation of the first operand of a
2185 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2186 function is called (but after the evaluation of its arguments and the
2187 expression denoting the called function), and in certain other places.
2188 Other than as expressed by the sequence point rules, the order of
2189 evaluation of subexpressions of an expression is not specified.  All
2190 these rules describe only a partial order rather than a total order,
2191 since, for example, if two functions are called within one expression
2192 with no sequence point between them, the order in which the functions
2193 are called is not specified.  However, the standards committee have
2194 ruled that function calls do not overlap.
2196 It is not specified when between sequence points modifications to the
2197 values of objects take effect.  Programs whose behavior depends on this
2198 have undefined behavior; the C standard specifies that ``Between the
2199 previous and next sequence point an object shall have its stored value
2200 modified at most once by the evaluation of an expression.  Furthermore,
2201 the prior value shall be read only to determine the value to be
2202 stored.''.  If a program breaks these rules, the results on any
2203 particular implementation are entirely unpredictable.
2205 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2206 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2207 diagnosed by this option, and it may give an occasional false positive
2208 result, but in general it has been found fairly effective at detecting
2209 this sort of problem in programs.
2211 The present implementation of this option only works for C programs.  A
2212 future implementation may also work for C++ programs.
2214 The C standard is worded confusingly, therefore there is some debate
2215 over the precise meaning of the sequence point rules in subtle cases.
2216 Links to discussions of the problem, including proposed formal
2217 definitions, may be found on our readings page, at
2218 @w{@uref{http://gcc.gnu.org/readings.html}}.
2220 @item -Wreturn-type
2221 @opindex Wreturn-type
2222 Warn whenever a function is defined with a return-type that defaults to
2223 @code{int}.  Also warn about any @code{return} statement with no
2224 return-value in a function whose return-type is not @code{void}.
2226 For C++, a function without return type always produces a diagnostic
2227 message, even when @option{-Wno-return-type} is specified.  The only
2228 exceptions are @samp{main} and functions defined in system headers.
2230 @item -Wswitch
2231 @opindex Wswitch
2232 Warn whenever a @code{switch} statement has an index of enumeral type
2233 and lacks a @code{case} for one or more of the named codes of that
2234 enumeration.  (The presence of a @code{default} label prevents this
2235 warning.)  @code{case} labels outside the enumeration range also
2236 provoke warnings when this option is used.
2238 @item -Wswitch-default
2239 @opindex Wswitch-switch
2240 Warn whenever a @code{switch} statement does not have a @code{default}
2241 case.
2243 @item -Wswitch-enum
2244 @opindex Wswitch-enum
2245 Warn whenever a @code{switch} statement has an index of enumeral type
2246 and lacks a @code{case} for one or more of the named codes of that
2247 enumeration.  @code{case} labels outside the enumeration range also
2248 provoke warnings when this option is used.
2250 @item -Wtrigraphs
2251 @opindex Wtrigraphs
2252 Warn if any trigraphs are encountered that might change the meaning of
2253 the program (trigraphs within comments are not warned about).
2255 @item -Wunused-function
2256 @opindex Wunused-function
2257 Warn whenever a static function is declared but not defined or a
2258 non\-inline static function is unused.
2260 @item -Wunused-label
2261 @opindex Wunused-label
2262 Warn whenever a label is declared but not used.
2264 To suppress this warning use the @samp{unused} attribute
2265 (@pxref{Variable Attributes}).
2267 @item -Wunused-parameter
2268 @opindex Wunused-parameter
2269 Warn whenever a function parameter is unused aside from its declaration.
2271 To suppress this warning use the @samp{unused} attribute
2272 (@pxref{Variable Attributes}).
2274 @item -Wunused-variable
2275 @opindex Wunused-variable
2276 Warn whenever a local variable or non-constant static variable is unused
2277 aside from its declaration
2279 To suppress this warning use the @samp{unused} attribute
2280 (@pxref{Variable Attributes}).
2282 @item -Wunused-value
2283 @opindex Wunused-value
2284 Warn whenever a statement computes a result that is explicitly not used.
2286 To suppress this warning cast the expression to @samp{void}.
2288 @item -Wunused
2289 @opindex Wunused
2290 All the above @option{-Wunused} options combined.
2292 In order to get a warning about an unused function parameter, you must
2293 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2294 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2296 @item -Wuninitialized
2297 @opindex Wuninitialized
2298 Warn if an automatic variable is used without first being initialized or
2299 if a variable may be clobbered by a @code{setjmp} call.
2301 These warnings are possible only in optimizing compilation,
2302 because they require data flow information that is computed only
2303 when optimizing.  If you don't specify @option{-O}, you simply won't
2304 get these warnings.
2306 These warnings occur only for variables that are candidates for
2307 register allocation.  Therefore, they do not occur for a variable that
2308 is declared @code{volatile}, or whose address is taken, or whose size
2309 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2310 structures, unions or arrays, even when they are in registers.
2312 Note that there may be no warning about a variable that is used only
2313 to compute a value that itself is never used, because such
2314 computations may be deleted by data flow analysis before the warnings
2315 are printed.
2317 These warnings are made optional because GCC is not smart
2318 enough to see all the reasons why the code might be correct
2319 despite appearing to have an error.  Here is one example of how
2320 this can happen:
2322 @smallexample
2323 @group
2325   int x;
2326   switch (y)
2327     @{
2328     case 1: x = 1;
2329       break;
2330     case 2: x = 4;
2331       break;
2332     case 3: x = 5;
2333     @}
2334   foo (x);
2336 @end group
2337 @end smallexample
2339 @noindent
2340 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2341 always initialized, but GCC doesn't know this.  Here is
2342 another common case:
2344 @smallexample
2346   int save_y;
2347   if (change_y) save_y = y, y = new_y;
2348   @dots{}
2349   if (change_y) y = save_y;
2351 @end smallexample
2353 @noindent
2354 This has no bug because @code{save_y} is used only if it is set.
2356 @cindex @code{longjmp} warnings
2357 This option also warns when a non-volatile automatic variable might be
2358 changed by a call to @code{longjmp}.  These warnings as well are possible
2359 only in optimizing compilation.
2361 The compiler sees only the calls to @code{setjmp}.  It cannot know
2362 where @code{longjmp} will be called; in fact, a signal handler could
2363 call it at any point in the code.  As a result, you may get a warning
2364 even when there is in fact no problem because @code{longjmp} cannot
2365 in fact be called at the place which would cause a problem.
2367 Some spurious warnings can be avoided if you declare all the functions
2368 you use that never return as @code{noreturn}.  @xref{Function
2369 Attributes}.
2371 @item -Wunknown-pragmas
2372 @opindex Wunknown-pragmas
2373 @cindex warning for unknown pragmas
2374 @cindex unknown pragmas, warning
2375 @cindex pragmas, warning of unknown
2376 Warn when a #pragma directive is encountered which is not understood by
2377 GCC@.  If this command line option is used, warnings will even be issued
2378 for unknown pragmas in system header files.  This is not the case if
2379 the warnings were only enabled by the @option{-Wall} command line option.
2381 @item -Wstrict-aliasing
2382 @opindex Wstrict-aliasing
2383 This option is only active when @option{-fstrict-aliasing} is active.
2384 It warns about code which might break the strict aliasing rules that the
2385 compiler is using for optimization. The warning does not catch all
2386 cases, but does attempt to catch the more common pitfalls. It is
2387 included in @option{-Wall}.
2389 @item -Wall
2390 @opindex Wall
2391 All of the above @samp{-W} options combined.  This enables all the
2392 warnings about constructions that some users consider questionable, and
2393 that are easy to avoid (or modify to prevent the warning), even in
2394 conjunction with macros.  This also enables some language-specific
2395 warnings described in @ref{C++ Dialect Options} and
2396 @ref{Objective-C Dialect Options}.
2397 @end table
2399 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2400 Some of them warn about constructions that users generally do not
2401 consider questionable, but which occasionally you might wish to check
2402 for; others warn about constructions that are necessary or hard to avoid
2403 in some cases, and there is no simple way to modify the code to suppress
2404 the warning.
2406 @table @gcctabopt
2407 @item -Wextra
2408 @opindex W
2409 @opindex Wextra
2410 (This option used to be called @option{-W}.  The older name is still
2411 supported, but the newer name is more descriptive.)  Print extra warning
2412 messages for these events:
2414 @itemize @bullet
2415 @item
2416 A function can return either with or without a value.  (Falling
2417 off the end of the function body is considered returning without
2418 a value.)  For example, this function would evoke such a
2419 warning:
2421 @smallexample
2422 @group
2423 foo (a)
2425   if (a > 0)
2426     return a;
2428 @end group
2429 @end smallexample
2431 @item
2432 An expression-statement or the left-hand side of a comma expression
2433 contains no side effects.
2434 To suppress the warning, cast the unused expression to void.
2435 For example, an expression such as @samp{x[i,j]} will cause a warning,
2436 but @samp{x[(void)i,j]} will not.
2438 @item
2439 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2441 @item
2442 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2443 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2444 that of ordinary mathematical notation.
2446 @item
2447 Storage-class specifiers like @code{static} are not the first things in
2448 a declaration.  According to the C Standard, this usage is obsolescent.
2450 @item
2451 The return type of a function has a type qualifier such as @code{const}.
2452 Such a type qualifier has no effect, since the value returned by a
2453 function is not an lvalue.  (But don't warn about the GNU extension of
2454 @code{volatile void} return types.  That extension will be warned about
2455 if @option{-pedantic} is specified.)
2457 @item
2458 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2459 arguments.
2461 @item
2462 A comparison between signed and unsigned values could produce an
2463 incorrect result when the signed value is converted to unsigned.
2464 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2466 @item
2467 An aggregate has an initializer which does not initialize all members.
2468 For example, the following code would cause such a warning, because
2469 @code{x.h} would be implicitly initialized to zero:
2471 @smallexample
2472 struct s @{ int f, g, h; @};
2473 struct s x = @{ 3, 4 @};
2474 @end smallexample
2476 @item
2477 A function parameter is declared without a type specifier in K&R-style
2478 functions:
2480 @smallexample
2481 void foo(bar) @{ @}
2482 @end smallexample
2484 @item
2485 An empty body occurs in an @samp{if} or @samp{else} statement.
2487 @item
2488 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2489 @samp{>}, or @samp{>=}.
2491 @item
2492 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2494 @item
2495 Any of several floating-point events that often indicate errors, such as
2496 overflow, underflow, loss of precision, etc.
2498 @item @r{(C++ only)}
2499 An enumerator and a non-enumerator both appear in a conditional expression.
2501 @item @r{(C++ only)}
2502 A non-static reference or non-static @samp{const} member appears in a
2503 class without constructors.
2505 @item @r{(C++ only)}
2506 Ambiguous virtual bases.
2508 @item @r{(C++ only)}
2509 Subscripting an array which has been declared @samp{register}.
2511 @item @r{(C++ only)}
2512 Taking the address of a variable which has been declared @samp{register}.
2514 @item @r{(C++ only)}
2515 A base class is not initialized in a derived class' copy constrcutor.
2516 @end itemize
2518 @item -Wno-div-by-zero
2519 @opindex Wno-div-by-zero
2520 @opindex Wdiv-by-zero
2521 Do not warn about compile-time integer division by zero.  Floating point
2522 division by zero is not warned about, as it can be a legitimate way of
2523 obtaining infinities and NaNs.
2525 @item -Wsystem-headers
2526 @opindex Wsystem-headers
2527 @cindex warnings from system headers
2528 @cindex system headers, warnings from
2529 Print warning messages for constructs found in system header files.
2530 Warnings from system headers are normally suppressed, on the assumption
2531 that they usually do not indicate real problems and would only make the
2532 compiler output harder to read.  Using this command line option tells
2533 GCC to emit warnings from system headers as if they occurred in user
2534 code.  However, note that using @option{-Wall} in conjunction with this
2535 option will @emph{not} warn about unknown pragmas in system
2536 headers---for that, @option{-Wunknown-pragmas} must also be used.
2538 @item -Wfloat-equal
2539 @opindex Wfloat-equal
2540 Warn if floating point values are used in equality comparisons.
2542 The idea behind this is that sometimes it is convenient (for the
2543 programmer) to consider floating-point values as approximations to
2544 infinitely precise real numbers.  If you are doing this, then you need
2545 to compute (by analyzing the code, or in some other way) the maximum or
2546 likely maximum error that the computation introduces, and allow for it
2547 when performing comparisons (and when producing output, but that's a
2548 different problem).  In particular, instead of testing for equality, you
2549 would check to see whether the two values have ranges that overlap; and
2550 this is done with the relational operators, so equality comparisons are
2551 probably mistaken.
2553 @item -Wtraditional @r{(C only)}
2554 @opindex Wtraditional
2555 Warn about certain constructs that behave differently in traditional and
2556 ISO C@.  Also warn about ISO C constructs that have no traditional C
2557 equivalent, and/or problematic constructs which should be avoided.
2559 @itemize @bullet
2560 @item
2561 Macro parameters that appear within string literals in the macro body.
2562 In traditional C macro replacement takes place within string literals,
2563 but does not in ISO C@.
2565 @item
2566 In traditional C, some preprocessor directives did not exist.
2567 Traditional preprocessors would only consider a line to be a directive
2568 if the @samp{#} appeared in column 1 on the line.  Therefore
2569 @option{-Wtraditional} warns about directives that traditional C
2570 understands but would ignore because the @samp{#} does not appear as the
2571 first character on the line.  It also suggests you hide directives like
2572 @samp{#pragma} not understood by traditional C by indenting them.  Some
2573 traditional implementations would not recognize @samp{#elif}, so it
2574 suggests avoiding it altogether.
2576 @item
2577 A function-like macro that appears without arguments.
2579 @item
2580 The unary plus operator.
2582 @item
2583 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2584 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2585 constants.)  Note, these suffixes appear in macros defined in the system
2586 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2587 Use of these macros in user code might normally lead to spurious
2588 warnings, however gcc's integrated preprocessor has enough context to
2589 avoid warning in these cases.
2591 @item
2592 A function declared external in one block and then used after the end of
2593 the block.
2595 @item
2596 A @code{switch} statement has an operand of type @code{long}.
2598 @item
2599 A non-@code{static} function declaration follows a @code{static} one.
2600 This construct is not accepted by some traditional C compilers.
2602 @item
2603 The ISO type of an integer constant has a different width or
2604 signedness from its traditional type.  This warning is only issued if
2605 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2606 typically represent bit patterns, are not warned about.
2608 @item
2609 Usage of ISO string concatenation is detected.
2611 @item
2612 Initialization of automatic aggregates.
2614 @item
2615 Identifier conflicts with labels.  Traditional C lacks a separate
2616 namespace for labels.
2618 @item
2619 Initialization of unions.  If the initializer is zero, the warning is
2620 omitted.  This is done under the assumption that the zero initializer in
2621 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2622 initializer warnings and relies on default initialization to zero in the
2623 traditional C case.
2625 @item
2626 Conversions by prototypes between fixed/floating point values and vice
2627 versa.  The absence of these prototypes when compiling with traditional
2628 C would cause serious problems.  This is a subset of the possible
2629 conversion warnings, for the full set use @option{-Wconversion}.
2631 @item
2632 Use of ISO C style function definitions.  This warning intentionally is
2633 @emph{not} issued for prototype declarations or variadic functions
2634 because these ISO C features will appear in your code when using
2635 libiberty's traditional C compatibility macros, @code{PARAMS} and
2636 @code{VPARAMS}.  This warning is also bypassed for nested functions
2637 because that feature is already a gcc extension and thus not relevant to
2638 traditional C compatibility.
2639 @end itemize
2641 @item -Wundef
2642 @opindex Wundef
2643 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2645 @item -Wendif-labels
2646 @opindex Wendif-labels
2647 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2649 @item -Wshadow
2650 @opindex Wshadow
2651 Warn whenever a local variable shadows another local variable, parameter or
2652 global variable or whenever a built-in function is shadowed.
2654 @item -Wlarger-than-@var{len}
2655 @opindex Wlarger-than
2656 Warn whenever an object of larger than @var{len} bytes is defined.
2658 @item -Wpointer-arith
2659 @opindex Wpointer-arith
2660 Warn about anything that depends on the ``size of'' a function type or
2661 of @code{void}.  GNU C assigns these types a size of 1, for
2662 convenience in calculations with @code{void *} pointers and pointers
2663 to functions.
2665 @item -Wbad-function-cast @r{(C only)}
2666 @opindex Wbad-function-cast
2667 Warn whenever a function call is cast to a non-matching type.
2668 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2670 @item -Wcast-qual
2671 @opindex Wcast-qual
2672 Warn whenever a pointer is cast so as to remove a type qualifier from
2673 the target type.  For example, warn if a @code{const char *} is cast
2674 to an ordinary @code{char *}.
2676 @item -Wcast-align
2677 @opindex Wcast-align
2678 Warn whenever a pointer is cast such that the required alignment of the
2679 target is increased.  For example, warn if a @code{char *} is cast to
2680 an @code{int *} on machines where integers can only be accessed at
2681 two- or four-byte boundaries.
2683 @item -Wwrite-strings
2684 @opindex Wwrite-strings
2685 When compiling C, give string constants the type @code{const
2686 char[@var{length}]} so that
2687 copying the address of one into a non-@code{const} @code{char *}
2688 pointer will get a warning; when compiling C++, warn about the
2689 deprecated conversion from string constants to @code{char *}.
2690 These warnings will help you find at
2691 compile time code that can try to write into a string constant, but
2692 only if you have been very careful about using @code{const} in
2693 declarations and prototypes.  Otherwise, it will just be a nuisance;
2694 this is why we did not make @option{-Wall} request these warnings.
2696 @item -Wconversion
2697 @opindex Wconversion
2698 Warn if a prototype causes a type conversion that is different from what
2699 would happen to the same argument in the absence of a prototype.  This
2700 includes conversions of fixed point to floating and vice versa, and
2701 conversions changing the width or signedness of a fixed point argument
2702 except when the same as the default promotion.
2704 Also, warn if a negative integer constant expression is implicitly
2705 converted to an unsigned type.  For example, warn about the assignment
2706 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2707 casts like @code{(unsigned) -1}.
2709 @item -Wsign-compare
2710 @opindex Wsign-compare
2711 @cindex warning for comparison of signed and unsigned values
2712 @cindex comparison of signed and unsigned values, warning
2713 @cindex signed and unsigned values, comparison warning
2714 Warn when a comparison between signed and unsigned values could produce
2715 an incorrect result when the signed value is converted to unsigned.
2716 This warning is also enabled by @option{-Wextra}; to get the other warnings
2717 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2719 @item -Waggregate-return
2720 @opindex Waggregate-return
2721 Warn if any functions that return structures or unions are defined or
2722 called.  (In languages where you can return an array, this also elicits
2723 a warning.)
2725 @item -Wstrict-prototypes @r{(C only)}
2726 @opindex Wstrict-prototypes
2727 Warn if a function is declared or defined without specifying the
2728 argument types.  (An old-style function definition is permitted without
2729 a warning if preceded by a declaration which specifies the argument
2730 types.)
2732 @item -Wmissing-prototypes @r{(C only)}
2733 @opindex Wmissing-prototypes
2734 Warn if a global function is defined without a previous prototype
2735 declaration.  This warning is issued even if the definition itself
2736 provides a prototype.  The aim is to detect global functions that fail
2737 to be declared in header files.
2739 @item -Wmissing-declarations
2740 @opindex Wmissing-declarations
2741 Warn if a global function is defined without a previous declaration.
2742 Do so even if the definition itself provides a prototype.
2743 Use this option to detect global functions that are not declared in
2744 header files.
2746 @item -Wmissing-noreturn
2747 @opindex Wmissing-noreturn
2748 Warn about functions which might be candidates for attribute @code{noreturn}.
2749 Note these are only possible candidates, not absolute ones.  Care should
2750 be taken to manually verify functions actually do not ever return before
2751 adding the @code{noreturn} attribute, otherwise subtle code generation
2752 bugs could be introduced.  You will not get a warning for @code{main} in
2753 hosted C environments.
2755 @item -Wmissing-format-attribute
2756 @opindex Wmissing-format-attribute
2757 @opindex Wformat
2758 If @option{-Wformat} is enabled, also warn about functions which might be
2759 candidates for @code{format} attributes.  Note these are only possible
2760 candidates, not absolute ones.  GCC will guess that @code{format}
2761 attributes might be appropriate for any function that calls a function
2762 like @code{vprintf} or @code{vscanf}, but this might not always be the
2763 case, and some functions for which @code{format} attributes are
2764 appropriate may not be detected.  This option has no effect unless
2765 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2767 @item -Wno-multichar
2768 @opindex Wno-multichar
2769 @opindex Wmultichar
2770 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2771 Usually they indicate a typo in the user's code, as they have
2772 implementation-defined values, and should not be used in portable code.
2774 @item -Wno-deprecated-declarations
2775 @opindex Wno-deprecated-declarations
2776 Do not warn about uses of functions, variables, and types marked as
2777 deprecated by using the @code{deprecated} attribute.
2778 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2779 @pxref{Type Attributes}.)
2781 @item -Wpacked
2782 @opindex Wpacked
2783 Warn if a structure is given the packed attribute, but the packed
2784 attribute has no effect on the layout or size of the structure.
2785 Such structures may be mis-aligned for little benefit.  For
2786 instance, in this code, the variable @code{f.x} in @code{struct bar}
2787 will be misaligned even though @code{struct bar} does not itself
2788 have the packed attribute:
2790 @smallexample
2791 @group
2792 struct foo @{
2793   int x;
2794   char a, b, c, d;
2795 @} __attribute__((packed));
2796 struct bar @{
2797   char z;
2798   struct foo f;
2800 @end group
2801 @end smallexample
2803 @item -Wpadded
2804 @opindex Wpadded
2805 Warn if padding is included in a structure, either to align an element
2806 of the structure or to align the whole structure.  Sometimes when this
2807 happens it is possible to rearrange the fields of the structure to
2808 reduce the padding and so make the structure smaller.
2810 @item -Wredundant-decls
2811 @opindex Wredundant-decls
2812 Warn if anything is declared more than once in the same scope, even in
2813 cases where multiple declaration is valid and changes nothing.
2815 @item -Wnested-externs @r{(C only)}
2816 @opindex Wnested-externs
2817 Warn if an @code{extern} declaration is encountered within a function.
2819 @item -Wunreachable-code
2820 @opindex Wunreachable-code
2821 Warn if the compiler detects that code will never be executed.
2823 This option is intended to warn when the compiler detects that at
2824 least a whole line of source code will never be executed, because
2825 some condition is never satisfied or because it is after a
2826 procedure that never returns.
2828 It is possible for this option to produce a warning even though there
2829 are circumstances under which part of the affected line can be executed,
2830 so care should be taken when removing apparently-unreachable code.
2832 For instance, when a function is inlined, a warning may mean that the
2833 line is unreachable in only one inlined copy of the function.
2835 This option is not made part of @option{-Wall} because in a debugging
2836 version of a program there is often substantial code which checks
2837 correct functioning of the program and is, hopefully, unreachable
2838 because the program does work.  Another common use of unreachable
2839 code is to provide behavior which is selectable at compile-time.
2841 @item -Winline
2842 @opindex Winline
2843 Warn if a function can not be inlined and it was declared as inline.
2845 @item -Winvalid-pch
2846 @opindex Winvalid-pch
2847 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2848 the search path but can't be used.
2850 @item -Wlong-long
2851 @opindex Wlong-long
2852 @opindex Wno-long-long
2853 Warn if @samp{long long} type is used.  This is default.  To inhibit
2854 the warning messages, use @option{-Wno-long-long}.  Flags
2855 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2856 only when @option{-pedantic} flag is used.
2858 @item -Wdisabled-optimization
2859 @opindex Wdisabled-optimization
2860 Warn if a requested optimization pass is disabled.  This warning does
2861 not generally indicate that there is anything wrong with your code; it
2862 merely indicates that GCC's optimizers were unable to handle the code
2863 effectively.  Often, the problem is that your code is too big or too
2864 complex; GCC will refuse to optimize programs when the optimization
2865 itself is likely to take inordinate amounts of time.
2867 @item -Werror
2868 @opindex Werror
2869 Make all warnings into errors.
2870 @end table
2872 @node Debugging Options
2873 @section Options for Debugging Your Program or GCC
2874 @cindex options, debugging
2875 @cindex debugging information options
2877 GCC has various special options that are used for debugging
2878 either your program or GCC:
2880 @table @gcctabopt
2881 @item -g
2882 @opindex g
2883 Produce debugging information in the operating system's native format
2884 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2885 information.
2887 On most systems that use stabs format, @option{-g} enables use of extra
2888 debugging information that only GDB can use; this extra information
2889 makes debugging work better in GDB but will probably make other debuggers
2890 crash or
2891 refuse to read the program.  If you want to control for certain whether
2892 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2893 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2894 or @option{-gvms} (see below).
2896 Unlike most other C compilers, GCC allows you to use @option{-g} with
2897 @option{-O}.  The shortcuts taken by optimized code may occasionally
2898 produce surprising results: some variables you declared may not exist
2899 at all; flow of control may briefly move where you did not expect it;
2900 some statements may not be executed because they compute constant
2901 results or their values were already at hand; some statements may
2902 execute in different places because they were moved out of loops.
2904 Nevertheless it proves possible to debug optimized output.  This makes
2905 it reasonable to use the optimizer for programs that might have bugs.
2907 The following options are useful when GCC is generated with the
2908 capability for more than one debugging format.
2910 @item -ggdb
2911 @opindex ggdb
2912 Produce debugging information for use by GDB@.  This means to use the
2913 most expressive format available (DWARF 2, stabs, or the native format
2914 if neither of those are supported), including GDB extensions if at all
2915 possible.
2917 @item -gstabs
2918 @opindex gstabs
2919 Produce debugging information in stabs format (if that is supported),
2920 without GDB extensions.  This is the format used by DBX on most BSD
2921 systems.  On MIPS, Alpha and System V Release 4 systems this option
2922 produces stabs debugging output which is not understood by DBX or SDB@.
2923 On System V Release 4 systems this option requires the GNU assembler.
2925 @item -gstabs+
2926 @opindex gstabs+
2927 Produce debugging information in stabs format (if that is supported),
2928 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2929 use of these extensions is likely to make other debuggers crash or
2930 refuse to read the program.
2932 @item -gcoff
2933 @opindex gcoff
2934 Produce debugging information in COFF format (if that is supported).
2935 This is the format used by SDB on most System V systems prior to
2936 System V Release 4.
2938 @item -gxcoff
2939 @opindex gxcoff
2940 Produce debugging information in XCOFF format (if that is supported).
2941 This is the format used by the DBX debugger on IBM RS/6000 systems.
2943 @item -gxcoff+
2944 @opindex gxcoff+
2945 Produce debugging information in XCOFF format (if that is supported),
2946 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2947 use of these extensions is likely to make other debuggers crash or
2948 refuse to read the program, and may cause assemblers other than the GNU
2949 assembler (GAS) to fail with an error.
2951 @item -gdwarf
2952 @opindex gdwarf
2953 Produce debugging information in DWARF version 1 format (if that is
2954 supported).  This is the format used by SDB on most System V Release 4
2955 systems.
2957 This option is deprecated.
2959 @item -gdwarf+
2960 @opindex gdwarf+
2961 Produce debugging information in DWARF version 1 format (if that is
2962 supported), using GNU extensions understood only by the GNU debugger
2963 (GDB)@.  The use of these extensions is likely to make other debuggers
2964 crash or refuse to read the program.
2966 This option is deprecated.
2968 @item -gdwarf-2
2969 @opindex gdwarf-2
2970 Produce debugging information in DWARF version 2 format (if that is
2971 supported).  This is the format used by DBX on IRIX 6.
2973 @item -gvms
2974 @opindex gvms
2975 Produce debugging information in VMS debug format (if that is
2976 supported).  This is the format used by DEBUG on VMS systems.
2978 @item -g@var{level}
2979 @itemx -ggdb@var{level}
2980 @itemx -gstabs@var{level}
2981 @itemx -gcoff@var{level}
2982 @itemx -gxcoff@var{level}
2983 @itemx -gvms@var{level}
2984 Request debugging information and also use @var{level} to specify how
2985 much information.  The default level is 2.
2987 Level 1 produces minimal information, enough for making backtraces in
2988 parts of the program that you don't plan to debug.  This includes
2989 descriptions of functions and external variables, but no information
2990 about local variables and no line numbers.
2992 Level 3 includes extra information, such as all the macro definitions
2993 present in the program.  Some debuggers support macro expansion when
2994 you use @option{-g3}.
2996 Note that in order to avoid confusion between DWARF1 debug level 2,
2997 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2998 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2999 option to change the debug level for DWARF1 or DWARF2.
3001 @item -feliminate-dwarf2-dups
3002 @opindex feliminate-dwarf2-dups
3003 Compress DWARF2 debugging information by eliminating duplicated
3004 information about each symbol.  This option only makes sense when
3005 generating DWARF2 debugging information with @option{-gdwarf-2}.
3007 @cindex @command{prof}
3008 @item -p
3009 @opindex p
3010 Generate extra code to write profile information suitable for the
3011 analysis program @command{prof}.  You must use this option when compiling
3012 the source files you want data about, and you must also use it when
3013 linking.
3015 @cindex @command{gprof}
3016 @item -pg
3017 @opindex pg
3018 Generate extra code to write profile information suitable for the
3019 analysis program @command{gprof}.  You must use this option when compiling
3020 the source files you want data about, and you must also use it when
3021 linking.
3023 @item -Q
3024 @opindex Q
3025 Makes the compiler print out each function name as it is compiled, and
3026 print some statistics about each pass when it finishes.
3028 @item -ftime-report
3029 @opindex ftime-report
3030 Makes the compiler print some statistics about the time consumed by each
3031 pass when it finishes.
3033 @item -fmem-report
3034 @opindex fmem-report
3035 Makes the compiler print some statistics about permanent memory
3036 allocation when it finishes.
3038 @item -fprofile-arcs
3039 @opindex fprofile-arcs
3040 Add code so that program flow @dfn{arcs} are instrumented.  During
3041 execution the program records how many times each branch and call is
3042 executed and how many times it is taken or returns.  When the compiled
3043 program exits it saves this data to a file called
3044 @file{@var{auxname}.da} for each source file. The data may be used for
3045 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3046 test coverage analysis (@option{-ftest-coverage}). Each object file's
3047 @var{auxname} is generated from the name of the output file, if
3048 explicitly specified and it is not the final executable, otherwise it is
3049 the basename of the source file. In both cases any suffix is removed
3050 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3051 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3053 @itemize
3055 @item
3056 Compile the source files with @option{-fprofile-arcs} plus optimization
3057 and code generation options. For test coverage analysis, use the
3058 additional @option{-ftest-coverage} option. You do not need to profile
3059 every source file in a program.
3061 @item
3062 Link your object files as normal.
3064 @item
3065 Run the program on a representative workload to generate the arc profile
3066 information. This may be repeated any number of times.
3068 @item
3069 For profile-directed optimizations, compile the source files again with
3070 the same optimization and code generation options plus
3071 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3072 Control Optimization}).
3074 @item
3075 For test coverage analysis, use @command{gcov} to produce human readable
3076 information from the @file{.bbg} and @file{.da} files. Refer to the
3077 @command{gcov} documentation for further information.
3079 @end itemize
3081 With @option{-fprofile-arcs}, for each function of your program GCC
3082 creates a program flow graph, then finds a spanning tree for the graph.
3083 Only arcs that are not on the spanning tree have to be instrumented: the
3084 compiler adds code to count the number of times that these arcs are
3085 executed.  When an arc is the only exit or only entrance to a block, the
3086 instrumentation code can be added to the block; otherwise, a new basic
3087 block must be created to hold the instrumentation code.
3089 @need 2000
3090 @item -ftest-coverage
3091 @opindex ftest-coverage
3092 Produce a graph file that the @command{gcov} code-coverage utility
3093 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3094 show program coverage. Each source file's data file is called
3095 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3096 above for a description of @var{auxname} and instructions on how to
3097 generate test coverage data. Coverage data will match the source files
3098 more closely, if you do not optimize.
3100 @item -d@var{letters}
3101 @opindex d
3102 Says to make debugging dumps during compilation at times specified by
3103 @var{letters}.  This is used for debugging the compiler.  The file names
3104 for most of the dumps are made by appending a pass number and a word to
3105 the @var{dumpname}. @var{dumpname} is generated from the name of the
3106 output file, if explicitly specified and it is not an executable,
3107 otherwise it is the basename of the source file. In both cases any
3108 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3109 Here are the possible letters for use in @var{letters}, and their
3110 meanings:
3112 @table @samp
3113 @item A
3114 @opindex dA
3115 Annotate the assembler output with miscellaneous debugging information.
3116 @item b
3117 @opindex db
3118 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3119 @item B
3120 @opindex dB
3121 Dump after block reordering, to @file{@var{file}.32.bbro}.
3122 @item c
3123 @opindex dc
3124 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3125 @item C
3126 @opindex dC
3127 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3128 @item d
3129 @opindex dd
3130 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3131 @item D
3132 @opindex dD
3133 Dump all macro definitions, at the end of preprocessing, in addition to
3134 normal output.
3135 @item e
3136 @opindex de
3137 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3138 @file{@var{file}.07.ussa}.
3139 @item E
3140 @opindex dE
3141 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3142 @item f
3143 @opindex df
3144 Dump after life analysis, to @file{@var{file}.18.life}.
3145 @item F
3146 @opindex dF
3147 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3148 @item g
3149 @opindex dg
3150 Dump after global register allocation, to @file{@var{file}.24.greg}.
3151 @item h
3152 @opindex dh
3153 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3154 @item k
3155 @opindex dk
3156 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3157 @item o
3158 @opindex do
3159 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3160 @item G
3161 @opindex dG
3162 Dump after GCSE, to @file{@var{file}.11.gcse}.
3163 @item i
3164 @opindex di
3165 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3166 @item j
3167 @opindex dj
3168 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3169 @item k
3170 @opindex dk
3171 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3172 @item l
3173 @opindex dl
3174 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3175 @item L
3176 @opindex dL
3177 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3178 @file{@var{file}.18.loop2}.
3179 @item M
3180 @opindex dM
3181 Dump after performing the machine dependent reorganization pass, to
3182 @file{@var{file}.33.mach}.
3183 @item n
3184 @opindex dn
3185 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3186 @item N
3187 @opindex dN
3188 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3189 @item r
3190 @opindex dr
3191 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3192 @item R
3193 @opindex dR
3194 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3195 @item s
3196 @opindex ds
3197 Dump after CSE (including the jump optimization that sometimes follows
3198 CSE), to @file{@var{file}.09.cse}.
3199 @item S
3200 @opindex dS
3201 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3202 @item t
3203 @opindex dt
3204 Dump after the second CSE pass (including the jump optimization that
3205 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3206 @item u
3207 @opindex du
3208 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3209 @item w
3210 @opindex dw
3211 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3212 @item X
3213 @opindex dX
3214 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3215 @item z
3216 @opindex dz
3217 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3218 @item a
3219 @opindex da
3220 Produce all the dumps listed above.
3221 @item H
3222 @opindex dH
3223 Produce a core dump whenever an error occurs.
3224 @item m
3225 @opindex dm
3226 Print statistics on memory usage, at the end of the run, to
3227 standard error.
3228 @item p
3229 @opindex dp
3230 Annotate the assembler output with a comment indicating which
3231 pattern and alternative was used.  The length of each instruction is
3232 also printed.
3233 @item P
3234 @opindex dP
3235 Dump the RTL in the assembler output as a comment before each instruction.
3236 Also turns on @option{-dp} annotation.
3237 @item v
3238 @opindex dv
3239 For each of the other indicated dump files (except for
3240 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3241 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3242 @item x
3243 @opindex dx
3244 Just generate RTL for a function instead of compiling it.  Usually used
3245 with @samp{r}.
3246 @item y
3247 @opindex dy
3248 Dump debugging information during parsing, to standard error.
3249 @end table
3251 @item -fdump-unnumbered
3252 @opindex fdump-unnumbered
3253 When doing debugging dumps (see @option{-d} option above), suppress instruction
3254 numbers and line number note output.  This makes it more feasible to
3255 use diff on debugging dumps for compiler invocations with different
3256 options, in particular with and without @option{-g}.
3258 @item -fdump-translation-unit @r{(C and C++ only)}
3259 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3260 @opindex fdump-translation-unit
3261 Dump a representation of the tree structure for the entire translation
3262 unit to a file.  The file name is made by appending @file{.tu} to the
3263 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3264 controls the details of the dump as described for the
3265 @option{-fdump-tree} options.
3267 @item -fdump-class-hierarchy @r{(C++ only)}
3268 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3269 @opindex fdump-class-hierarchy
3270 Dump a representation of each class's hierarchy and virtual function
3271 table layout to a file.  The file name is made by appending @file{.class}
3272 to the source file name.  If the @samp{-@var{options}} form is used,
3273 @var{options} controls the details of the dump as described for the
3274 @option{-fdump-tree} options.
3276 @item -fdump-tree-@var{switch} @r{(C++ only)}
3277 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3278 @opindex fdump-tree
3279 Control the dumping at various stages of processing the intermediate
3280 language tree to a file.  The file name is generated by appending a switch
3281 specific suffix to the source file name.  If the @samp{-@var{options}}
3282 form is used, @var{options} is a list of @samp{-} separated options that
3283 control the details of the dump. Not all options are applicable to all
3284 dumps, those which are not meaningful will be ignored. The following
3285 options are available
3287 @table @samp
3288 @item address
3289 Print the address of each node.  Usually this is not meaningful as it
3290 changes according to the environment and source file. Its primary use
3291 is for tying up a dump file with a debug environment.
3292 @item slim
3293 Inhibit dumping of members of a scope or body of a function merely
3294 because that scope has been reached. Only dump such items when they
3295 are directly reachable by some other path.
3296 @item all
3297 Turn on all options.
3298 @end table
3300 The following tree dumps are possible:
3301 @table @samp
3302 @item original
3303 Dump before any tree based optimization, to @file{@var{file}.original}.
3304 @item optimized
3305 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3306 @item inlined
3307 Dump after function inlining, to @file{@var{file}.inlined}.
3308 @end table
3310 @item -fsched-verbose=@var{n}
3311 @opindex fsched-verbose
3312 On targets that use instruction scheduling, this option controls the
3313 amount of debugging output the scheduler prints.  This information is
3314 written to standard error, unless @option{-dS} or @option{-dR} is
3315 specified, in which case it is output to the usual dump
3316 listing file, @file{.sched} or @file{.sched2} respectively.  However
3317 for @var{n} greater than nine, the output is always printed to standard
3318 error.
3320 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3321 same information as @option{-dRS}.  For @var{n} greater than one, it
3322 also output basic block probabilities, detailed ready list information
3323 and unit/insn info.  For @var{n} greater than two, it includes RTL
3324 at abort point, control-flow and regions info.  And for @var{n} over
3325 four, @option{-fsched-verbose} also includes dependence info.
3327 @item -save-temps
3328 @opindex save-temps
3329 Store the usual ``temporary'' intermediate files permanently; place them
3330 in the current directory and name them based on the source file.  Thus,
3331 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3332 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3333 preprocessed @file{foo.i} output file even though the compiler now
3334 normally uses an integrated preprocessor.
3336 @item -time
3337 @opindex time
3338 Report the CPU time taken by each subprocess in the compilation
3339 sequence.  For C source files, this is the compiler proper and assembler
3340 (plus the linker if linking is done).  The output looks like this:
3342 @smallexample
3343 # cc1 0.12 0.01
3344 # as 0.00 0.01
3345 @end smallexample
3347 The first number on each line is the ``user time,'' that is time spent
3348 executing the program itself.  The second number is ``system time,''
3349 time spent executing operating system routines on behalf of the program.
3350 Both numbers are in seconds.
3352 @item -print-file-name=@var{library}
3353 @opindex print-file-name
3354 Print the full absolute name of the library file @var{library} that
3355 would be used when linking---and don't do anything else.  With this
3356 option, GCC does not compile or link anything; it just prints the
3357 file name.
3359 @item -print-multi-directory
3360 @opindex print-multi-directory
3361 Print the directory name corresponding to the multilib selected by any
3362 other switches present in the command line.  This directory is supposed
3363 to exist in @env{GCC_EXEC_PREFIX}.
3365 @item -print-multi-lib
3366 @opindex print-multi-lib
3367 Print the mapping from multilib directory names to compiler switches
3368 that enable them.  The directory name is separated from the switches by
3369 @samp{;}, and each switch starts with an @samp{@@} instead of the
3370 @samp{-}, without spaces between multiple switches.  This is supposed to
3371 ease shell-processing.
3373 @item -print-prog-name=@var{program}
3374 @opindex print-prog-name
3375 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3377 @item -print-libgcc-file-name
3378 @opindex print-libgcc-file-name
3379 Same as @option{-print-file-name=libgcc.a}.
3381 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3382 but you do want to link with @file{libgcc.a}.  You can do
3384 @example
3385 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3386 @end example
3388 @item -print-search-dirs
3389 @opindex print-search-dirs
3390 Print the name of the configured installation directory and a list of
3391 program and library directories gcc will search---and don't do anything else.
3393 This is useful when gcc prints the error message
3394 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3395 To resolve this you either need to put @file{cpp0} and the other compiler
3396 components where gcc expects to find them, or you can set the environment
3397 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3398 Don't forget the trailing '/'.
3399 @xref{Environment Variables}.
3401 @item -dumpmachine
3402 @opindex dumpmachine
3403 Print the compiler's target machine (for example,
3404 @samp{i686-pc-linux-gnu})---and don't do anything else.
3406 @item -dumpversion
3407 @opindex dumpversion
3408 Print the compiler version (for example, @samp{3.0})---and don't do
3409 anything else.
3411 @item -dumpspecs
3412 @opindex dumpspecs
3413 Print the compiler's built-in specs---and don't do anything else.  (This
3414 is used when GCC itself is being built.)  @xref{Spec Files}.
3415 @end table
3417 @node Optimize Options
3418 @section Options That Control Optimization
3419 @cindex optimize options
3420 @cindex options, optimization
3422 These options control various sorts of optimizations.
3424 Without any optimization option, the compiler's goal is to reduce the
3425 cost of compilation and to make debugging produce the expected
3426 results.  Statements are independent: if you stop the program with a
3427 breakpoint between statements, you can then assign a new value to any
3428 variable or change the program counter to any other statement in the
3429 function and get exactly the results you would expect from the source
3430 code.
3432 Turning on optimization flags makes the compiler attempt to improve
3433 the performance and/or code size at the expense of compilation time
3434 and possibly the ability to debug the program.
3436 Not all optimizations are controlled directly by a flag.  Only
3437 optimizations that have a flag are listed.
3439 @table @gcctabopt
3440 @item -O
3441 @itemx -O1
3442 @opindex O
3443 @opindex O1
3444 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3445 more memory for a large function.
3447 With @option{-O}, the compiler tries to reduce code size and execution
3448 time, without performing any optimizations that take a great deal of
3449 compilation time.
3451 @option{-O} turns on the following optimization flags: 
3452 @gccoptlist{-fdefer-pop 
3453 -fmerge-constants
3454 -fthread-jumps
3455 -floop-optimize
3456 -fcrossjumping
3457 -fif-conversion
3458 -fif-conversion2
3459 -fdelayed-branch
3460 -fguess-branch-probability
3461 -fcprop-registers}
3463 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3464 where doing so does not interfere with debugging.
3466 @item -O2
3467 @opindex O2
3468 Optimize even more.  GCC performs nearly all supported optimizations
3469 that do not involve a space-speed tradeoff.  The compiler does not
3470 perform loop unrolling or function inlining when you specify @option{-O2}.
3471 As compared to @option{-O}, this option increases both compilation time
3472 and the performance of the generated code.
3474 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3475 also turns on the following optimization flags:
3476 @gccoptlist{-fforce-mem
3477 -foptimize-sibling-calls
3478 -fstrength-reduce
3479 -fcse-follow-jumps  -fcse-skip-blocks
3480 -frerun-cse-after-loop  -frerun-loop-opt
3481 -fgcse   -fgcse-lm   -fgcse-sm
3482 -fdelete-null-pointer-checks
3483 -fexpensive-optimizations
3484 -fregmove
3485 -fschedule-insns  -fschedule-insns2
3486 -fsched-interblock -fsched-spec
3487 -fcaller-saves
3488 -fpeephole2
3489 -freorder-blocks  -freorder-functions
3490 -fstrict-aliasing
3491 -falign-functions  -falign-jumps
3492 -falign-loops  -falign-labels}
3494 Please note the warning under @option{-fgcse} about
3495 invoking @option{-O2} on programs that use computed gotos.
3497 @item -O3
3498 @opindex O3
3499 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3500 @option{-O2} and also turns on the @option{-finline-functions} and
3501 @option{-frename-registers} options.
3503 @item -O0
3504 @opindex O0
3505 Do not optimize.  This is the default.
3507 @item -Os
3508 @opindex Os
3509 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3510 do not typically increase code size.  It also performs further
3511 optimizations designed to reduce code size.
3513 @option{-Os} disables the following optimization flags:
3514 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops
3515 -falign-labels  -freorder-blocks -fprefetch-loop-arrays}
3517 If you use multiple @option{-O} options, with or without level numbers,
3518 the last such option is the one that is effective.
3519 @end table
3521 Options of the form @option{-f@var{flag}} specify machine-independent
3522 flags.  Most flags have both positive and negative forms; the negative
3523 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3524 below, only one of the forms is listed---the one you typically will
3525 use.  You can figure out the other form by either removing @samp{no-}
3526 or adding it.
3528 The following options control specific optimizations.  They are either
3529 activated by @option{-O} options or are related to ones that are.  You
3530 can use the following flags in the rare cases when ``fine-tuning'' of
3531 optimizations to be performed is desired.
3533 @table @gcctabopt
3534 @item -fno-default-inline
3535 @opindex fno-default-inline
3536 Do not make member functions inline by default merely because they are
3537 defined inside the class scope (C++ only).  Otherwise, when you specify
3538 @w{@option{-O}}, member functions defined inside class scope are compiled
3539 inline by default; i.e., you don't need to add @samp{inline} in front of
3540 the member function name.
3542 @item -fno-defer-pop
3543 @opindex fno-defer-pop
3544 Always pop the arguments to each function call as soon as that function
3545 returns.  For machines which must pop arguments after a function call,
3546 the compiler normally lets arguments accumulate on the stack for several
3547 function calls and pops them all at once.
3549 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3551 @item -fforce-mem
3552 @opindex fforce-mem
3553 Force memory operands to be copied into registers before doing
3554 arithmetic on them.  This produces better code by making all memory
3555 references potential common subexpressions.  When they are not common
3556 subexpressions, instruction combination should eliminate the separate
3557 register-load.
3559 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3561 @item -fforce-addr
3562 @opindex fforce-addr
3563 Force memory address constants to be copied into registers before
3564 doing arithmetic on them.  This may produce better code just as
3565 @option{-fforce-mem} may.
3567 @item -fomit-frame-pointer
3568 @opindex fomit-frame-pointer
3569 Don't keep the frame pointer in a register for functions that
3570 don't need one.  This avoids the instructions to save, set up and
3571 restore frame pointers; it also makes an extra register available
3572 in many functions.  @strong{It also makes debugging impossible on
3573 some machines.}
3575 On some machines, such as the VAX, this flag has no effect, because
3576 the standard calling sequence automatically handles the frame pointer
3577 and nothing is saved by pretending it doesn't exist.  The
3578 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3579 whether a target machine supports this flag.  @xref{Registers,,Register
3580 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3582 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3584 @item -foptimize-sibling-calls
3585 @opindex foptimize-sibling-calls
3586 Optimize sibling and tail recursive calls.
3588 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3590 @item -fno-inline
3591 @opindex fno-inline
3592 Don't pay attention to the @code{inline} keyword.  Normally this option
3593 is used to keep the compiler from expanding any functions inline.
3594 Note that if you are not optimizing, no functions can be expanded inline.
3596 @item -finline-functions
3597 @opindex finline-functions
3598 Integrate all simple functions into their callers.  The compiler
3599 heuristically decides which functions are simple enough to be worth
3600 integrating in this way.
3602 If all calls to a given function are integrated, and the function is
3603 declared @code{static}, then the function is normally not output as
3604 assembler code in its own right.
3606 Enabled at level @option{-O3}.
3608 @item -finline-limit=@var{n}
3609 @opindex finline-limit
3610 By default, gcc limits the size of functions that can be inlined.  This flag
3611 allows the control of this limit for functions that are explicitly marked as
3612 inline (i.e., marked with the inline keyword or defined within the class
3613 definition in c++).  @var{n} is the size of functions that can be inlined in
3614 number of pseudo instructions (not counting parameter handling).  The default
3615 value of @var{n} is 600.
3616 Increasing this value can result in more inlined code at
3617 the cost of compilation time and memory consumption.  Decreasing usually makes
3618 the compilation faster and less code will be inlined (which presumably
3619 means slower programs).  This option is particularly useful for programs that
3620 use inlining heavily such as those based on recursive templates with C++.
3622 @emph{Note:} pseudo instruction represents, in this particular context, an
3623 abstract measurement of function's size.  In no way, it represents a count
3624 of assembly instructions and as such its exact meaning might change from one
3625 release to an another.
3627 @item -fkeep-inline-functions
3628 @opindex fkeep-inline-functions
3629 Even if all calls to a given function are integrated, and the function
3630 is declared @code{static}, nevertheless output a separate run-time
3631 callable version of the function.  This switch does not affect
3632 @code{extern inline} functions.
3634 @item -fkeep-static-consts
3635 @opindex fkeep-static-consts
3636 Emit variables declared @code{static const} when optimization isn't turned
3637 on, even if the variables aren't referenced.
3639 GCC enables this option by default.  If you want to force the compiler to
3640 check if the variable was referenced, regardless of whether or not
3641 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3643 @item -fmerge-constants
3644 Attempt to merge identical constants (string constants and floating point
3645 constants) across compilation units.
3647 This option is the default for optimized compilation if the assembler and
3648 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3649 behavior.
3651 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3653 @item -fmerge-all-constants
3654 Attempt to merge identical constants and identical variables.
3656 This option implies @option{-fmerge-constants}.  In addition to
3657 @option{-fmerge-constants} this considers e.g. even constant initialized
3658 arrays or initialized constant variables with integral or floating point
3659 types.  Languages like C or C++ require each non-automatic variable to
3660 have distinct location, so using this option will result in non-conforming
3661 behavior.
3663 @item -fnew-ra
3664 @opindex fnew-ra
3665 Use a graph coloring register allocator.  Currently this option is meant
3666 for testing, so we are interested to hear about miscompilations with
3667 @option{-fnew-ra}.
3669 @item -fno-branch-count-reg
3670 @opindex fno-branch-count-reg
3671 Do not use ``decrement and branch'' instructions on a count register,
3672 but instead generate a sequence of instructions that decrement a
3673 register, compare it against zero, then branch based upon the result.
3674 This option is only meaningful on architectures that support such
3675 instructions, which include x86, PowerPC, IA-64 and S/390.
3677 The default is @option{-fbranch-count-reg}, enabled when
3678 @option{-fstrength-reduce} is enabled.
3680 @item -fno-function-cse
3681 @opindex fno-function-cse
3682 Do not put function addresses in registers; make each instruction that
3683 calls a constant function contain the function's address explicitly.
3685 This option results in less efficient code, but some strange hacks
3686 that alter the assembler output may be confused by the optimizations
3687 performed when this option is not used.
3689 The default is @option{-ffunction-cse}
3691 @item -fno-zero-initialized-in-bss
3692 @opindex fno-zero-initialized-in-bss
3693 If the target supports a BSS section, GCC by default puts variables that
3694 are initialized to zero into BSS@.  This can save space in the resulting
3695 code.
3697 This option turns off this behavior because some programs explicitly
3698 rely on variables going to the data section.  E.g., so that the
3699 resulting executable can find the beginning of that section and/or make
3700 assumptions based on that.
3702 The default is @option{-fzero-initialized-in-bss}.
3704 @item -fstrength-reduce
3705 @opindex fstrength-reduce
3706 Perform the optimizations of loop strength reduction and
3707 elimination of iteration variables.
3709 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3711 @item -fthread-jumps
3712 @opindex fthread-jumps
3713 Perform optimizations where we check to see if a jump branches to a
3714 location where another comparison subsumed by the first is found.  If
3715 so, the first branch is redirected to either the destination of the
3716 second branch or a point immediately following it, depending on whether
3717 the condition is known to be true or false.
3719 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3721 @item -fcse-follow-jumps
3722 @opindex fcse-follow-jumps
3723 In common subexpression elimination, scan through jump instructions
3724 when the target of the jump is not reached by any other path.  For
3725 example, when CSE encounters an @code{if} statement with an
3726 @code{else} clause, CSE will follow the jump when the condition
3727 tested is false.
3729 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3731 @item -fcse-skip-blocks
3732 @opindex fcse-skip-blocks
3733 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3734 follow jumps which conditionally skip over blocks.  When CSE
3735 encounters a simple @code{if} statement with no else clause,
3736 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3737 body of the @code{if}.
3739 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3741 @item -frerun-cse-after-loop
3742 @opindex frerun-cse-after-loop
3743 Re-run common subexpression elimination after loop optimizations has been
3744 performed.
3746 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3748 @item -frerun-loop-opt
3749 @opindex frerun-loop-opt
3750 Run the loop optimizer twice.
3752 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3754 @item -fgcse
3755 @opindex fgcse
3756 Perform a global common subexpression elimination pass.
3757 This pass also performs global constant and copy propagation.
3759 @emph{Note:} When compiling a program using computed gotos, a GCC
3760 extension, you may get better runtime performance if you disable
3761 the global common subexpression elimination pass by adding
3762 @option{-fno-gcse} to the command line.
3764 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3766 @item -fgcse-lm
3767 @opindex fgcse-lm
3768 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3769 attempt to move loads which are only killed by stores into themselves.  This
3770 allows a loop containing a load/store sequence to be changed to a load outside
3771 the loop, and a copy/store within the loop.
3773 Enabled by default when gcse is enabled.
3775 @item -fgcse-sm
3776 @opindex fgcse-sm
3777 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3778 subexpression elimination.  This pass will attempt to move stores out of loops.
3779 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3780 can be changed to a load before the loop and a store after the loop.
3782 Enabled by default when gcse is enabled.
3784 @item -floop-optimize
3785 @opindex floop-optimize
3786 Perform loop optimizations: move constant expressions out of loops, simplify
3787 exit test conditions and optionally do strength-reduction and loop unrolling as
3788 well.
3790 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3792 @item -fcrossjumping
3793 @opindex crossjumping
3794 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3795 resulting code may or may not perform better than without cross-jumping.
3797 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3799 @item -fif-conversion
3800 @opindex if-conversion
3801 Attempt to transform conditional jumps into branch-less equivalents.  This
3802 include use of conditional moves, min, max, set flags and abs instructions, and
3803 some tricks doable by standard arithmetics.  The use of conditional execution
3804 on chips where it is available is controlled by @code{if-conversion2}.
3806 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3808 @item -fif-conversion2
3809 @opindex if-conversion2
3810 Use conditional execution (where available) to transform conditional jumps into
3811 branch-less equivalents.
3813 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3815 @item -fdelete-null-pointer-checks
3816 @opindex fdelete-null-pointer-checks
3817 Use global dataflow analysis to identify and eliminate useless checks
3818 for null pointers.  The compiler assumes that dereferencing a null
3819 pointer would have halted the program.  If a pointer is checked after
3820 it has already been dereferenced, it cannot be null.
3822 In some environments, this assumption is not true, and programs can
3823 safely dereference null pointers.  Use
3824 @option{-fno-delete-null-pointer-checks} to disable this optimization
3825 for programs which depend on that behavior.
3827 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3829 @item -fexpensive-optimizations
3830 @opindex fexpensive-optimizations
3831 Perform a number of minor optimizations that are relatively expensive.
3833 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3835 @item -foptimize-register-move
3836 @itemx -fregmove
3837 @opindex foptimize-register-move
3838 @opindex fregmove
3839 Attempt to reassign register numbers in move instructions and as
3840 operands of other simple instructions in order to maximize the amount of
3841 register tying.  This is especially helpful on machines with two-operand
3842 instructions.
3844 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3845 optimization.
3847 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3849 @item -fdelayed-branch
3850 @opindex fdelayed-branch
3851 If supported for the target machine, attempt to reorder instructions
3852 to exploit instruction slots available after delayed branch
3853 instructions.
3855 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3857 @item -fschedule-insns
3858 @opindex fschedule-insns
3859 If supported for the target machine, attempt to reorder instructions to
3860 eliminate execution stalls due to required data being unavailable.  This
3861 helps machines that have slow floating point or memory load instructions
3862 by allowing other instructions to be issued until the result of the load
3863 or floating point instruction is required.
3865 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3867 @item -fschedule-insns2
3868 @opindex fschedule-insns2
3869 Similar to @option{-fschedule-insns}, but requests an additional pass of
3870 instruction scheduling after register allocation has been done.  This is
3871 especially useful on machines with a relatively small number of
3872 registers and where memory load instructions take more than one cycle.
3874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3876 @item -fno-sched-interblock
3877 @opindex fno-sched-interblock
3878 Don't schedule instructions across basic blocks.  This is normally
3879 enabled by default when scheduling before register allocation, i.e.@:
3880 with @option{-fschedule-insns} or at @option{-O2} or higher.
3882 @item -fno-sched-spec
3883 @opindex fno-sched-spec
3884 Don't allow speculative motion of non-load instructions.  This is normally
3885 enabled by default when scheduling before register allocation, i.e.@:
3886 with @option{-fschedule-insns} or at @option{-O2} or higher.
3888 @item -fsched-spec-load
3889 @opindex fsched-spec-load
3890 Allow speculative motion of some load instructions.  This only makes
3891 sense when scheduling before register allocation, i.e.@: with
3892 @option{-fschedule-insns} or at @option{-O2} or higher.
3894 @item -fsched-spec-load-dangerous
3895 @opindex fsched-spec-load-dangerous
3896 Allow speculative motion of more load instructions.  This only makes
3897 sense when scheduling before register allocation, i.e.@: with
3898 @option{-fschedule-insns} or at @option{-O2} or higher.
3900 @item -fsched2-use-superblocks
3901 @opindex fsched2-use-superblocks
3902 When schedulilng after register allocation, do use superblock scheduling
3903 algorithm.  Superblock scheduling allows motion acress basic block boundaries
3904 resulting on faster schedules.  This option is experimental, as not all machine
3905 descriptions used by GCC model the CPU closely enought to avoid unreliable
3906 results from the algorithm. 
3908 This only makes sense when scheduling after register allocation, i.e.@: with
3909 @option{-fschedule-insns2} or at @option{-O2} or higher.
3911 @item -fsched2-use-traces
3912 @opindex fsched2-use-traces
3913 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3914 allocation and additionally perform code duplication in order to increase the
3915 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3916 trace formation.
3918 This mode should produce faster but singificantly longer programs.  Also
3919 without @code{-fbranch-probabilities} the traces constructed may not match the
3920 reality and hurt the performance.  This only makes
3921 sense when scheduling after register allocation, i.e.@: with
3922 @option{-fschedule-insns2} or at @option{-O2} or higher.
3924 @item -fcaller-saves
3925 @opindex fcaller-saves
3926 Enable values to be allocated in registers that will be clobbered by
3927 function calls, by emitting extra instructions to save and restore the
3928 registers around such calls.  Such allocation is done only when it
3929 seems to result in better code than would otherwise be produced.
3931 This option is always enabled by default on certain machines, usually
3932 those which have no call-preserved registers to use instead.
3934 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3936 @item -fmove-all-movables
3937 @opindex fmove-all-movables
3938 Forces all invariant computations in loops to be moved
3939 outside the loop.
3941 @item -freduce-all-givs
3942 @opindex freduce-all-givs
3943 Forces all general-induction variables in loops to be
3944 strength-reduced.
3946 @emph{Note:} When compiling programs written in Fortran,
3947 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3948 by default when you use the optimizer.
3950 These options may generate better or worse code; results are highly
3951 dependent on the structure of loops within the source code.
3953 These two options are intended to be removed someday, once
3954 they have helped determine the efficacy of various
3955 approaches to improving loop optimizations.
3957 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3958 know how use of these options affects
3959 the performance of your production code.
3960 We're very interested in code that runs @emph{slower}
3961 when these options are @emph{enabled}.
3963 @item -fno-peephole
3964 @itemx -fno-peephole2
3965 @opindex fno-peephole
3966 @opindex fno-peephole2
3967 Disable any machine-specific peephole optimizations.  The difference
3968 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3969 are implemented in the compiler; some targets use one, some use the
3970 other, a few use both.
3972 @option{-fpeephole} is enabled by default.
3973 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3975 @item -fno-guess-branch-probability
3976 @opindex fno-guess-branch-probability
3977 Do not guess branch probabilities using a randomized model.
3979 Sometimes gcc will opt to use a randomized model to guess branch
3980 probabilities, when none are available from either profiling feedback
3981 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3982 different runs of the compiler on the same program may produce different
3983 object code.
3985 In a hard real-time system, people don't want different runs of the
3986 compiler to produce code that has different behavior; minimizing
3987 non-determinism is of paramount import.  This switch allows users to
3988 reduce non-determinism, possibly at the expense of inferior
3989 optimization.
3991 The default is @option{-fguess-branch-probability} at levels
3992 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3994 @item -freorder-blocks
3995 @opindex freorder-blocks
3996 Reorder basic blocks in the compiled function in order to reduce number of
3997 taken branches and improve code locality.
3999 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4001 @item -freorder-functions
4002 @opindex freorder-functions
4003 Reorder basic blocks in the compiled function in order to reduce number of
4004 taken branches and improve code locality. This is implemented by using special
4005 subsections @code{text.hot} for most frequently executed functions and
4006 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4007 the linker so object file format must support named sections and linker must
4008 place them in a reasonable way.
4010 Also profile feedback must be available in to make this option effective.  See
4011 @option{-fprofile-arcs} for details.
4013 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015 @item -fstrict-aliasing
4016 @opindex fstrict-aliasing
4017 Allows the compiler to assume the strictest aliasing rules applicable to
4018 the language being compiled.  For C (and C++), this activates
4019 optimizations based on the type of expressions.  In particular, an
4020 object of one type is assumed never to reside at the same address as an
4021 object of a different type, unless the types are almost the same.  For
4022 example, an @code{unsigned int} can alias an @code{int}, but not a
4023 @code{void*} or a @code{double}.  A character type may alias any other
4024 type.
4026 Pay special attention to code like this:
4027 @example
4028 union a_union @{
4029   int i;
4030   double d;
4033 int f() @{
4034   a_union t;
4035   t.d = 3.0;
4036   return t.i;
4038 @end example
4039 The practice of reading from a different union member than the one most
4040 recently written to (called ``type-punning'') is common.  Even with
4041 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4042 is accessed through the union type.  So, the code above will work as
4043 expected.  However, this code might not:
4044 @example
4045 int f() @{
4046   a_union t;
4047   int* ip;
4048   t.d = 3.0;
4049   ip = &t.i;
4050   return *ip;
4052 @end example
4054 Every language that wishes to perform language-specific alias analysis
4055 should define a function that computes, given an @code{tree}
4056 node, an alias set for the node.  Nodes in different alias sets are not
4057 allowed to alias.  For an example, see the C front-end function
4058 @code{c_get_alias_set}.
4060 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4062 @item -falign-functions
4063 @itemx -falign-functions=@var{n}
4064 @opindex falign-functions
4065 Align the start of functions to the next power-of-two greater than
4066 @var{n}, skipping up to @var{n} bytes.  For instance,
4067 @option{-falign-functions=32} aligns functions to the next 32-byte
4068 boundary, but @option{-falign-functions=24} would align to the next
4069 32-byte boundary only if this can be done by skipping 23 bytes or less.
4071 @option{-fno-align-functions} and @option{-falign-functions=1} are
4072 equivalent and mean that functions will not be aligned.
4074 Some assemblers only support this flag when @var{n} is a power of two;
4075 in that case, it is rounded up.
4077 If @var{n} is not specified, use a machine-dependent default.
4079 Enabled at levels @option{-O2}, @option{-O3}.
4081 @item -falign-labels
4082 @itemx -falign-labels=@var{n}
4083 @opindex falign-labels
4084 Align all branch targets to a power-of-two boundary, skipping up to
4085 @var{n} bytes like @option{-falign-functions}.  This option can easily
4086 make code slower, because it must insert dummy operations for when the
4087 branch target is reached in the usual flow of the code.
4089 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4090 are greater than this value, then their values are used instead.
4092 If @var{n} is not specified, use a machine-dependent default which is
4093 very likely to be @samp{1}, meaning no alignment.
4095 Enabled at levels @option{-O2}, @option{-O3}.
4097 @item -falign-loops
4098 @itemx -falign-loops=@var{n}
4099 @opindex falign-loops
4100 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4101 like @option{-falign-functions}.  The hope is that the loop will be
4102 executed many times, which will make up for any execution of the dummy
4103 operations.
4105 If @var{n} is not specified, use a machine-dependent default.
4107 Enabled at levels @option{-O2}, @option{-O3}.
4109 @item -falign-jumps
4110 @itemx -falign-jumps=@var{n}
4111 @opindex falign-jumps
4112 Align branch targets to a power-of-two boundary, for branch targets
4113 where the targets can only be reached by jumping, skipping up to @var{n}
4114 bytes like @option{-falign-functions}.  In this case, no dummy operations
4115 need be executed.
4117 If @var{n} is not specified, use a machine-dependent default.
4119 Enabled at levels @option{-O2}, @option{-O3}.
4121 @item -frename-registers
4122 @opindex frename-registers
4123 Attempt to avoid false dependencies in scheduled code by making use
4124 of registers left over after register allocation.  This optimization
4125 will most benefit processors with lots of registers.  It can, however,
4126 make debugging impossible, since variables will no longer stay in
4127 a ``home register''.
4129 Enabled at levels @option{-O3}.
4131 @item -fno-cprop-registers
4132 @opindex fno-cprop-registers
4133 After register allocation and post-register allocation instruction splitting,
4134 we perform a copy-propagation pass to try to reduce scheduling dependencies
4135 and occasionally eliminate the copy.
4137 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4139 @end table
4141 The following options control compiler behavior regarding floating
4142 point arithmetic.  These options trade off between speed and
4143 correctness.  All must be specifically enabled.
4145 @table @gcctabopt
4146 @item -ffloat-store
4147 @opindex ffloat-store
4148 Do not store floating point variables in registers, and inhibit other
4149 options that might change whether a floating point value is taken from a
4150 register or memory.
4152 @cindex floating point precision
4153 This option prevents undesirable excess precision on machines such as
4154 the 68000 where the floating registers (of the 68881) keep more
4155 precision than a @code{double} is supposed to have.  Similarly for the
4156 x86 architecture.  For most programs, the excess precision does only
4157 good, but a few programs rely on the precise definition of IEEE floating
4158 point.  Use @option{-ffloat-store} for such programs, after modifying
4159 them to store all pertinent intermediate computations into variables.
4161 @item -ffast-math
4162 @opindex ffast-math
4163 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4164 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4165 @option{-fno-signaling-nans}.
4167 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4169 This option should never be turned on by any @option{-O} option since
4170 it can result in incorrect output for programs which depend on
4171 an exact implementation of IEEE or ISO rules/specifications for
4172 math functions.
4174 @item -fno-math-errno
4175 @opindex fno-math-errno
4176 Do not set ERRNO after calling math functions that are executed
4177 with a single instruction, e.g., sqrt.  A program that relies on
4178 IEEE exceptions for math error handling may want to use this flag
4179 for speed while maintaining IEEE arithmetic compatibility.
4181 This option should never be turned on by any @option{-O} option since
4182 it can result in incorrect output for programs which depend on
4183 an exact implementation of IEEE or ISO rules/specifications for
4184 math functions.
4186 The default is @option{-fmath-errno}.
4188 @item -funsafe-math-optimizations
4189 @opindex funsafe-math-optimizations
4190 Allow optimizations for floating-point arithmetic that (a) assume
4191 that arguments and results are valid and (b) may violate IEEE or
4192 ANSI standards.  When used at link-time, it may include libraries
4193 or startup files that change the default FPU control word or other
4194 similar optimizations.
4196 This option should never be turned on by any @option{-O} option since
4197 it can result in incorrect output for programs which depend on
4198 an exact implementation of IEEE or ISO rules/specifications for
4199 math functions.
4201 The default is @option{-fno-unsafe-math-optimizations}.
4203 @item -ffinite-math-only
4204 @opindex ffinite-math-only
4205 Allow optimizations for floating-point arithmetic that assume
4206 that arguments and results are not NaNs or +-Infs.
4208 This option should never be turned on by any @option{-O} option since
4209 it can result in incorrect output for programs which depend on
4210 an exact implementation of IEEE or ISO rules/specifications.
4212 The default is @option{-fno-finite-math-only}.
4214 @item -fno-trapping-math
4215 @opindex fno-trapping-math
4216 Compile code assuming that floating-point operations cannot generate
4217 user-visible traps.  These traps include division by zero, overflow,
4218 underflow, inexact result and invalid operation.  This option implies
4219 @option{-fno-signaling-nans}.  Setting this option may allow faster
4220 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4222 This option should never be turned on by any @option{-O} option since
4223 it can result in incorrect output for programs which depend on
4224 an exact implementation of IEEE or ISO rules/specifications for
4225 math functions.
4227 The default is @option{-ftrapping-math}.
4229 @item -fsignaling-nans
4230 @opindex fsignaling-nans
4231 Compile code assuming that IEEE signaling NaNs may generate user-visible
4232 traps during floating-point operations.  Setting this option disables
4233 optimizations that may change the number of exceptions visible with
4234 signaling NaNs.  This option implies @option{-ftrapping-math}.
4236 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4237 be defined.
4239 The default is @option{-fno-signaling-nans}.
4241 This option is experimental and does not currently guarantee to
4242 disable all GCC optimizations that affect signaling NaN behavior.
4244 @item -fsingle-precision-constant
4245 @opindex fsingle-precision-constant
4246 Treat floating point constant as single precision constant instead of
4247 implicitly converting it to double precision constant.
4250 @end table
4252 The following options control optimizations that may improve
4253 performance, but are not enabled by any @option{-O} options.  This
4254 section includes experimental options that may produce broken code.
4256 @table @gcctabopt
4257 @item -fbranch-probabilities
4258 @opindex fbranch-probabilities
4259 After running a program compiled with @option{-fprofile-arcs}
4260 (@pxref{Debugging Options,, Options for Debugging Your Program or
4261 @command{gcc}}), you can compile it a second time using
4262 @option{-fbranch-probabilities}, to improve optimizations based on
4263 the number of times each branch was taken.  When the program
4264 compiled with @option{-fprofile-arcs} exits it saves arc execution
4265 counts to a file called @file{@var{sourcename}.da} for each source
4266 file  The information in this data file is very dependent on the
4267 structure of the generated code, so you must use the same source code
4268 and the same optimization options for both compilations.
4270 With @option{-fbranch-probabilities}, GCC puts a 
4271 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4272 These can be used to improve optimization.  Currently, they are only
4273 used in one place: in @file{reorg.c}, instead of guessing which path a
4274 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4275 exactly determine which path is taken more often.
4277 @item -fnew-ra
4278 @opindex fnew-ra
4279 Use a graph coloring register allocator.  Currently this option is meant
4280 for testing, so we are interested to hear about miscompilations with
4281 @option{-fnew-ra}.
4283 @item -ftracer
4284 @opindex ftracer
4285 Perform tail duplication to enlarge superblock size. This transformation
4286 simplifies the control flow of the function allowing other optimizations to do
4287 better job.
4289 @item -funit-at-a-time
4290 @opindex funit-at-a-time
4291 Parse the whole compilation unit before starting to produce code.  This allows some
4292 extra optimizations to take place but consumes more memory.
4294 @item -funroll-loops
4295 @opindex funroll-loops
4296 Unroll loops whose number of iterations can be determined at compile time or
4297 upon entry to the loop.  @option{-funroll-loops} implies
4298 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4299 (i.e. complete removal of loops with small constant number of iterations).
4300 This option makes code larger, and may or may not make it run faster.
4302 @item -funroll-all-loops
4303 @opindex funroll-all-loops
4304 Unroll all loops, even if their number of iterations is uncertain when
4305 the loop is entered.  This usually makes programs run more slowly.
4306 @option{-funroll-all-loops} implies the same options as
4307 @option{-funroll-loops}.
4309 @item -fpeel-loops
4310 @opindex fpeel-loops
4311 Peels the loops for that there is enough information that they do not
4312 roll much (from profile feedback).  It also turns on complete loop peeling
4313 (i.e. complete removal of loops with small constant number of iterations).
4315 @item -funswitch-loops
4316 @opindex funswitch-loops
4317 Move branches with loop invariant conditions out of the loop, with duplicates
4318 of the loop on both branches (modified according to result of the condition).
4320 @item -fold-unroll-loops
4321 @opindex fold-unroll-loops
4322 Unroll loops whose number of iterations can be determined at compile
4323 time or upon entry to the loop, using the old loop unroller whose loop
4324 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4325 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4326 option makes code larger, and may or may not make it run faster.
4328 @item -fold-unroll-all-loops
4329 @opindex fold-unroll-all-loops
4330 Unroll all loops, even if their number of iterations is uncertain when
4331 the loop is entered. This is done using the old loop unroller whose loop
4332 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4333 @option{-fold-unroll-all-loops} implies the same options as
4334 @option{-fold-unroll-loops}.
4336 @item -funswitch-loops
4337 @opindex funswitch-loops
4338 Move branches with loop invariant conditions out of the loop, with duplicates
4339 of the loop on both branches (modified according to result of the condition).
4341 @item -funswitch-loops
4342 @opindex funswitch-loops
4343 Move branches with loop invariant conditions out of the loop, with duplicates
4344 of the loop on both branches (modified according to result of the condition).
4346 @item -fprefetch-loop-arrays
4347 @opindex fprefetch-loop-arrays
4348 If supported by the target machine, generate instructions to prefetch
4349 memory to improve the performance of loops that access large arrays.
4351 Disabled at level @option{-Os}.
4353 @item -ffunction-sections
4354 @itemx -fdata-sections
4355 @opindex ffunction-sections
4356 @opindex fdata-sections
4357 Place each function or data item into its own section in the output
4358 file if the target supports arbitrary sections.  The name of the
4359 function or the name of the data item determines the section's name
4360 in the output file.
4362 Use these options on systems where the linker can perform optimizations
4363 to improve locality of reference in the instruction space.  HPPA
4364 processors running HP-UX and SPARC processors running Solaris 2 have
4365 linkers with such optimizations.  Other systems using the ELF object format
4366 as well as AIX may have these optimizations in the future.
4368 Only use these options when there are significant benefits from doing
4369 so.  When you specify these options, the assembler and linker will
4370 create larger object and executable files and will also be slower.
4371 You will not be able to use @code{gprof} on all systems if you
4372 specify this option and you may have problems with debugging if
4373 you specify both this option and @option{-g}.
4375 @item -fssa
4376 @opindex fssa
4377 Perform optimizations in static single assignment form.  Each function's
4378 flow graph is translated into SSA form, optimizations are performed, and
4379 the flow graph is translated back from SSA form.  Users should not
4380 specify this option, since it is not yet ready for production use.
4382 @item -fssa-ccp
4383 @opindex fssa-ccp
4384 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4385 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4387 @item -fssa-dce
4388 @opindex fssa-dce
4389 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4390 Like @option{-fssa}, this is an experimental feature.
4395 @item --param @var{name}=@var{value}
4396 @opindex param
4397 In some places, GCC uses various constants to control the amount of
4398 optimization that is done.  For example, GCC will not inline functions
4399 that contain more that a certain number of instructions.  You can
4400 control some of these constants on the command-line using the
4401 @option{--param} option.
4403 In each case, the @var{value} is an integer.  The allowable choices for
4404 @var{name} are given in the following table:
4406 @table @gcctabopt
4407 @item max-crossjump-edges
4408 The maximum number of incoming edges to consider for crossjumping.
4409 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4410 the number of edges incoming to each block.  Increasing values mean
4411 more aggressive optimization, making the compile time increase with
4412 probably small improvement in executable size.
4414 @item max-delay-slot-insn-search
4415 The maximum number of instructions to consider when looking for an
4416 instruction to fill a delay slot.  If more than this arbitrary number of
4417 instructions is searched, the time savings from filling the delay slot
4418 will be minimal so stop searching.  Increasing values mean more
4419 aggressive optimization, making the compile time increase with probably
4420 small improvement in executable run time.
4422 @item max-delay-slot-live-search
4423 When trying to fill delay slots, the maximum number of instructions to
4424 consider when searching for a block with valid live register
4425 information.  Increasing this arbitrarily chosen value means more
4426 aggressive optimization, increasing the compile time.  This parameter
4427 should be removed when the delay slot code is rewritten to maintain the
4428 control-flow graph.
4430 @item max-gcse-memory
4431 The approximate maximum amount of memory that will be allocated in
4432 order to perform the global common subexpression elimination
4433 optimization.  If more memory than specified is required, the
4434 optimization will not be done.
4436 @item max-gcse-passes
4437 The maximum number of passes of GCSE to run.
4439 @item max-pending-list-length
4440 The maximum number of pending dependencies scheduling will allow
4441 before flushing the current state and starting over.  Large functions
4442 with few branches or calls can create excessively large lists which
4443 needlessly consume memory and resources.
4445 @item max-inline-insns
4446 If an function contains more than this many instructions, it
4447 will not be inlined.  This option is precisely equivalent to
4448 @option{-finline-limit}.
4450 @item max-unrolled-insns
4451 The maximum number of instructions that a loop should have if that loop
4452 is unrolled, and if the loop is unrolled, it determines how many times
4453 the loop code is unrolled.
4455 @item max-average-unrolled-insns
4456 The maximum number of instructions biased by probabilities of their execution
4457 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4458 it determines how many times the loop code is unrolled.
4460 @item max-unroll-times
4461 The maximum number of unrollings of a single loop.
4463 @item max-peeled-insns
4464 The maximum number of instructions that a loop should have if that loop
4465 is peeled, and if the loop is peeled, it determines how many times
4466 the loop code is peeled.
4468 @item max-peel-times
4469 The maximum number of peelings of a single loop.
4471 @item max-completely-peeled-insns
4472 The maximum number of insns of a completely peeled loop.
4474 @item max-completely-peel-times
4475 The maximum number of iterations of a loop to be suitable for complete peeling.
4477 @item max-unswitch-insns
4478 The maximum number of insns of an unswitched loop.
4480 @item max-unswitch-level
4481 The maximum number of branches unswitched in a single loop.
4483 @item hot-bb-count-fraction
4484 Select fraction of the maximal count of repetitions of basic block in program
4485 given basic block needs to have to be considered hot.
4487 @item hot-bb-frequency-fraction
4488 Select fraction of the maximal frequency of executions of basic block in
4489 function given basic block needs to have to be considered hot
4491 @item tracer-dynamic-coverage
4492 @itemx tracer-dynamic-coverage-feedback
4494 This value is used to limit superblock formation once the given percentage of
4495 executed instructions is covered.  This limits unnecessary code size
4496 expansion.
4498 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4499 feedback is available.  The real profiles (as opposed to statically estimated
4500 ones) are much less balanced allowing the threshold to be larger value.
4502 @item tracer-max-code-growth
4503 Stop tail duplication once code growth has reached given percentage.  This is
4504 rather hokey argument, as most of the duplicates will be eliminated later in
4505 cross jumping, so it may be set to much higher values than is the desired code
4506 growth.
4508 @item tracer-min-branch-ratio
4510 Stop reverse growth when the reverse probability of best edge is less than this
4511 threshold (in percent).
4513 @item tracer-min-branch-ratio
4514 @itemx tracer-min-branch-ratio-feedback
4516 Stop forward growth if the best edge do have probability lower than this
4517 threshold.
4519 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4520 compilation for profile feedback and one for compilation without.  The value
4521 for compilation with profile feedback needs to be more conservative (higher) in
4522 order to make tracer effective.
4524 @item ggc-min-expand
4526 GCC uses a garbage collector to manage its own memory allocation.  This
4527 parameter specifies the minimum percentage by which the garbage
4528 collector's heap should be allowed to expand between collections.
4529 Tuning this may improve compilation speed; it has no effect on code
4530 generation.
4532 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4533 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4534 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4535 GCC is not able to calculate RAM on a particular platform, the lower
4536 bound of 30% is used.  Setting this parameter and
4537 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4538 every opportunity.  This is extremely slow, but can be useful for
4539 debugging.
4541 @item ggc-min-heapsize
4543 Minimum size of the garbage collector's heap before it begins bothering
4544 to collect garbage.  The first collection occurs after the heap expands
4545 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4546 tuning this may improve compilation speed, and has no effect on code
4547 generation.
4549 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4550 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4551 available, the notion of "RAM" is the smallest of actual RAM,
4552 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4553 RAM on a particular platform, the lower bound is used.  Setting this
4554 parameter very large effectively disables garbage collection.  Setting
4555 this parameter and @option{ggc-min-expand} to zero causes a full
4556 collection to occur at every opportunity.
4558 @end table
4559 @end table
4561 @node Preprocessor Options
4562 @section Options Controlling the Preprocessor
4563 @cindex preprocessor options
4564 @cindex options, preprocessor
4566 These options control the C preprocessor, which is run on each C source
4567 file before actual compilation.
4569 If you use the @option{-E} option, nothing is done except preprocessing.
4570 Some of these options make sense only together with @option{-E} because
4571 they cause the preprocessor output to be unsuitable for actual
4572 compilation.
4574 @table @gcctabopt
4575 @opindex Wp
4576 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4577 and pass @var{option} directly through to the preprocessor.  If
4578 @var{option} contains commas, it is split into multiple options at the
4579 commas.  However, many options are modified, translated or interpreted
4580 by the compiler driver before being passed to the preprocessor, and
4581 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4582 interface is undocumented and subject to change, so whenever possible
4583 you should avoid using @option{-Wp} and let the driver handle the
4584 options instead.
4586 @item -Xpreprocessor @var{option}
4587 @opindex preprocessor
4588 Pass @var{option} as an option to the preprocessor.  You can use this to
4589 supply system-specific preprocessor options which GCC does not know how to
4590 recognize.
4592 If you want to pass an option that takes an argument, you must use
4593 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4594 @end table
4596 @include cppopts.texi
4598 @node Assembler Options
4599 @section Passing Options to the Assembler
4601 @c prevent bad page break with this line
4602 You can pass options to the assembler.
4604 @table @gcctabopt
4605 @item -Wa,@var{option}
4606 @opindex Wa
4607 Pass @var{option} as an option to the assembler.  If @var{option}
4608 contains commas, it is split into multiple options at the commas.
4610 @item -Xassembler @var{option}
4611 @opindex Xassembler
4612 Pass @var{option} as an option to the assembler.  You can use this to
4613 supply system-specific assembler options which GCC does not know how to
4614 recognize.
4616 If you want to pass an option that takes an argument, you must use
4617 @option{-Xassembler} twice, once for the option and once for the argument.
4619 @end table
4621 @node Link Options
4622 @section Options for Linking
4623 @cindex link options
4624 @cindex options, linking
4626 These options come into play when the compiler links object files into
4627 an executable output file.  They are meaningless if the compiler is
4628 not doing a link step.
4630 @table @gcctabopt
4631 @cindex file names
4632 @item @var{object-file-name}
4633 A file name that does not end in a special recognized suffix is
4634 considered to name an object file or library.  (Object files are
4635 distinguished from libraries by the linker according to the file
4636 contents.)  If linking is done, these object files are used as input
4637 to the linker.
4639 @item -c
4640 @itemx -S
4641 @itemx -E
4642 @opindex c
4643 @opindex S
4644 @opindex E
4645 If any of these options is used, then the linker is not run, and
4646 object file names should not be used as arguments.  @xref{Overall
4647 Options}.
4649 @cindex Libraries
4650 @item -l@var{library}
4651 @itemx -l @var{library}
4652 @opindex l
4653 Search the library named @var{library} when linking.  (The second
4654 alternative with the library as a separate argument is only for
4655 POSIX compliance and is not recommended.)
4657 It makes a difference where in the command you write this option; the
4658 linker searches and processes libraries and object files in the order they
4659 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4660 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4661 to functions in @samp{z}, those functions may not be loaded.
4663 The linker searches a standard list of directories for the library,
4664 which is actually a file named @file{lib@var{library}.a}.  The linker
4665 then uses this file as if it had been specified precisely by name.
4667 The directories searched include several standard system directories
4668 plus any that you specify with @option{-L}.
4670 Normally the files found this way are library files---archive files
4671 whose members are object files.  The linker handles an archive file by
4672 scanning through it for members which define symbols that have so far
4673 been referenced but not defined.  But if the file that is found is an
4674 ordinary object file, it is linked in the usual fashion.  The only
4675 difference between using an @option{-l} option and specifying a file name
4676 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4677 and searches several directories.
4679 @item -lobjc
4680 @opindex lobjc
4681 You need this special case of the @option{-l} option in order to
4682 link an Objective-C program.
4684 @item -nostartfiles
4685 @opindex nostartfiles
4686 Do not use the standard system startup files when linking.
4687 The standard system libraries are used normally, unless @option{-nostdlib}
4688 or @option{-nodefaultlibs} is used.
4690 @item -nodefaultlibs
4691 @opindex nodefaultlibs
4692 Do not use the standard system libraries when linking.
4693 Only the libraries you specify will be passed to the linker.
4694 The standard startup files are used normally, unless @option{-nostartfiles}
4695 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4696 for System V (and ISO C) environments or to bcopy and bzero for
4697 BSD environments.  These entries are usually resolved by entries in
4698 libc.  These entry points should be supplied through some other
4699 mechanism when this option is specified.
4701 @item -nostdlib
4702 @opindex nostdlib
4703 Do not use the standard system startup files or libraries when linking.
4704 No startup files and only the libraries you specify will be passed to
4705 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4706 for System V (and ISO C) environments or to bcopy and bzero for
4707 BSD environments.  These entries are usually resolved by entries in
4708 libc.  These entry points should be supplied through some other
4709 mechanism when this option is specified.
4711 @cindex @option{-lgcc}, use with @option{-nostdlib}
4712 @cindex @option{-nostdlib} and unresolved references
4713 @cindex unresolved references and @option{-nostdlib}
4714 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4715 @cindex @option{-nodefaultlibs} and unresolved references
4716 @cindex unresolved references and @option{-nodefaultlibs}
4717 One of the standard libraries bypassed by @option{-nostdlib} and
4718 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4719 that GCC uses to overcome shortcomings of particular machines, or special
4720 needs for some languages.
4721 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4722 Collection (GCC) Internals},
4723 for more discussion of @file{libgcc.a}.)
4724 In most cases, you need @file{libgcc.a} even when you want to avoid
4725 other standard libraries.  In other words, when you specify @option{-nostdlib}
4726 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4727 This ensures that you have no unresolved references to internal GCC
4728 library subroutines.  (For example, @samp{__main}, used to ensure C++
4729 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4730 GNU Compiler Collection (GCC) Internals}.)
4732 @item -s
4733 @opindex s
4734 Remove all symbol table and relocation information from the executable.
4736 @item -static
4737 @opindex static
4738 On systems that support dynamic linking, this prevents linking with the shared
4739 libraries.  On other systems, this option has no effect.
4741 @item -shared
4742 @opindex shared
4743 Produce a shared object which can then be linked with other objects to
4744 form an executable.  Not all systems support this option.  For predictable
4745 results, you must also specify the same set of options that were used to
4746 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4747 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4748 needs to build supplementary stub code for constructors to work.  On
4749 multi-libbed systems, @samp{gcc -shared} must select the correct support
4750 libraries to link against.  Failing to supply the correct flags may lead
4751 to subtle defects.  Supplying them in cases where they are not necessary
4752 is innocuous.}
4754 @item -shared-libgcc
4755 @itemx -static-libgcc
4756 @opindex shared-libgcc
4757 @opindex static-libgcc
4758 On systems that provide @file{libgcc} as a shared library, these options
4759 force the use of either the shared or static version respectively.
4760 If no shared version of @file{libgcc} was built when the compiler was
4761 configured, these options have no effect.
4763 There are several situations in which an application should use the
4764 shared @file{libgcc} instead of the static version.  The most common
4765 of these is when the application wishes to throw and catch exceptions
4766 across different shared libraries.  In that case, each of the libraries
4767 as well as the application itself should use the shared @file{libgcc}.
4769 Therefore, the G++ and GCJ drivers automatically add
4770 @option{-shared-libgcc} whenever you build a shared library or a main
4771 executable, because C++ and Java programs typically use exceptions, so
4772 this is the right thing to do.
4774 If, instead, you use the GCC driver to create shared libraries, you may
4775 find that they will not always be linked with the shared @file{libgcc}.
4776 If GCC finds, at its configuration time, that you have a GNU linker that
4777 does not support option @option{--eh-frame-hdr}, it will link the shared
4778 version of @file{libgcc} into shared libraries by default.  Otherwise,
4779 it will take advantage of the linker and optimize away the linking with
4780 the shared version of @file{libgcc}, linking with the static version of
4781 libgcc by default.  This allows exceptions to propagate through such
4782 shared libraries, without incurring relocation costs at library load
4783 time.
4785 However, if a library or main executable is supposed to throw or catch
4786 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4787 for the languages used in the program, or using the option
4788 @option{-shared-libgcc}, such that it is linked with the shared
4789 @file{libgcc}.
4791 @item -symbolic
4792 @opindex symbolic
4793 Bind references to global symbols when building a shared object.  Warn
4794 about any unresolved references (unless overridden by the link editor
4795 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4796 this option.
4798 @item -Xlinker @var{option}
4799 @opindex Xlinker
4800 Pass @var{option} as an option to the linker.  You can use this to
4801 supply system-specific linker options which GCC does not know how to
4802 recognize.
4804 If you want to pass an option that takes an argument, you must use
4805 @option{-Xlinker} twice, once for the option and once for the argument.
4806 For example, to pass @option{-assert definitions}, you must write
4807 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4808 @option{-Xlinker "-assert definitions"}, because this passes the entire
4809 string as a single argument, which is not what the linker expects.
4811 @item -Wl,@var{option}
4812 @opindex Wl
4813 Pass @var{option} as an option to the linker.  If @var{option} contains
4814 commas, it is split into multiple options at the commas.
4816 @item -u @var{symbol}
4817 @opindex u
4818 Pretend the symbol @var{symbol} is undefined, to force linking of
4819 library modules to define it.  You can use @option{-u} multiple times with
4820 different symbols to force loading of additional library modules.
4821 @end table
4823 @node Directory Options
4824 @section Options for Directory Search
4825 @cindex directory options
4826 @cindex options, directory search
4827 @cindex search path
4829 These options specify directories to search for header files, for
4830 libraries and for parts of the compiler:
4832 @table @gcctabopt
4833 @item -I@var{dir}
4834 @opindex I
4835 Add the directory @var{dir} to the head of the list of directories to be
4836 searched for header files.  This can be used to override a system header
4837 file, substituting your own version, since these directories are
4838 searched before the system header file directories.  However, you should
4839 not use this option to add directories that contain vendor-supplied
4840 system header files (use @option{-isystem} for that).  If you use more than
4841 one @option{-I} option, the directories are scanned in left-to-right
4842 order; the standard system directories come after.
4844 If a standard system include directory, or a directory specified with
4845 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4846 option will be ignored.  The directory will still be searched but as a
4847 system directory at its normal position in the system include chain.
4848 This is to ensure that GCC's procedure to fix buggy system headers and
4849 the ordering for the include_next directive are not inadvertently changed.
4850 If you really need to change the search order for system directories,
4851 use the @option{-nostdinc} and/or @option{-isystem} options.
4853 @item -I-
4854 @opindex I-
4855 Any directories you specify with @option{-I} options before the @option{-I-}
4856 option are searched only for the case of @samp{#include "@var{file}"};
4857 they are not searched for @samp{#include <@var{file}>}.
4859 If additional directories are specified with @option{-I} options after
4860 the @option{-I-}, these directories are searched for all @samp{#include}
4861 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4862 this way.)
4864 In addition, the @option{-I-} option inhibits the use of the current
4865 directory (where the current input file came from) as the first search
4866 directory for @samp{#include "@var{file}"}.  There is no way to
4867 override this effect of @option{-I-}.  With @option{-I.} you can specify
4868 searching the directory which was current when the compiler was
4869 invoked.  That is not exactly the same as what the preprocessor does
4870 by default, but it is often satisfactory.
4872 @option{-I-} does not inhibit the use of the standard system directories
4873 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4874 independent.
4876 @item -L@var{dir}
4877 @opindex L
4878 Add directory @var{dir} to the list of directories to be searched
4879 for @option{-l}.
4881 @item -B@var{prefix}
4882 @opindex B
4883 This option specifies where to find the executables, libraries,
4884 include files, and data files of the compiler itself.
4886 The compiler driver program runs one or more of the subprograms
4887 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4888 @var{prefix} as a prefix for each program it tries to run, both with and
4889 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4891 For each subprogram to be run, the compiler driver first tries the
4892 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4893 was not specified, the driver tries two standard prefixes, which are
4894 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4895 those results in a file name that is found, the unmodified program
4896 name is searched for using the directories specified in your
4897 @env{PATH} environment variable.
4899 The compiler will check to see if the path provided by the @option{-B}
4900 refers to a directory, and if necessary it will add a directory
4901 separator character at the end of the path.
4903 @option{-B} prefixes that effectively specify directory names also apply
4904 to libraries in the linker, because the compiler translates these
4905 options into @option{-L} options for the linker.  They also apply to
4906 includes files in the preprocessor, because the compiler translates these
4907 options into @option{-isystem} options for the preprocessor.  In this case,
4908 the compiler appends @samp{include} to the prefix.
4910 The run-time support file @file{libgcc.a} can also be searched for using
4911 the @option{-B} prefix, if needed.  If it is not found there, the two
4912 standard prefixes above are tried, and that is all.  The file is left
4913 out of the link if it is not found by those means.
4915 Another way to specify a prefix much like the @option{-B} prefix is to use
4916 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4917 Variables}.
4919 As a special kludge, if the path provided by @option{-B} is
4920 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4921 9, then it will be replaced by @file{[dir/]include}.  This is to help
4922 with boot-strapping the compiler.
4924 @item -specs=@var{file}
4925 @opindex specs
4926 Process @var{file} after the compiler reads in the standard @file{specs}
4927 file, in order to override the defaults that the @file{gcc} driver
4928 program uses when determining what switches to pass to @file{cc1},
4929 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4930 @option{-specs=@var{file}} can be specified on the command line, and they
4931 are processed in order, from left to right.
4932 @end table
4934 @c man end
4936 @node Spec Files
4937 @section Specifying subprocesses and the switches to pass to them
4938 @cindex Spec Files
4939 @command{gcc} is a driver program.  It performs its job by invoking a
4940 sequence of other programs to do the work of compiling, assembling and
4941 linking.  GCC interprets its command-line parameters and uses these to
4942 deduce which programs it should invoke, and which command-line options
4943 it ought to place on their command lines.  This behavior is controlled
4944 by @dfn{spec strings}.  In most cases there is one spec string for each
4945 program that GCC can invoke, but a few programs have multiple spec
4946 strings to control their behavior.  The spec strings built into GCC can
4947 be overridden by using the @option{-specs=} command-line switch to specify
4948 a spec file.
4950 @dfn{Spec files} are plaintext files that are used to construct spec
4951 strings.  They consist of a sequence of directives separated by blank
4952 lines.  The type of directive is determined by the first non-whitespace
4953 character on the line and it can be one of the following:
4955 @table @code
4956 @item %@var{command}
4957 Issues a @var{command} to the spec file processor.  The commands that can
4958 appear here are:
4960 @table @code
4961 @item %include <@var{file}>
4962 @cindex %include
4963 Search for @var{file} and insert its text at the current point in the
4964 specs file.
4966 @item %include_noerr <@var{file}>
4967 @cindex %include_noerr
4968 Just like @samp{%include}, but do not generate an error message if the include
4969 file cannot be found.
4971 @item %rename @var{old_name} @var{new_name}
4972 @cindex %rename
4973 Rename the spec string @var{old_name} to @var{new_name}.
4975 @end table
4977 @item *[@var{spec_name}]:
4978 This tells the compiler to create, override or delete the named spec
4979 string.  All lines after this directive up to the next directive or
4980 blank line are considered to be the text for the spec string.  If this
4981 results in an empty string then the spec will be deleted.  (Or, if the
4982 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4983 does not currently exist a new spec will be created.  If the spec does
4984 exist then its contents will be overridden by the text of this
4985 directive, unless the first character of that text is the @samp{+}
4986 character, in which case the text will be appended to the spec.
4988 @item [@var{suffix}]:
4989 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4990 and up to the next directive or blank line are considered to make up the
4991 spec string for the indicated suffix.  When the compiler encounters an
4992 input file with the named suffix, it will processes the spec string in
4993 order to work out how to compile that file.  For example:
4995 @smallexample
4996 .ZZ:
4997 z-compile -input %i
4998 @end smallexample
5000 This says that any input file whose name ends in @samp{.ZZ} should be
5001 passed to the program @samp{z-compile}, which should be invoked with the
5002 command-line switch @option{-input} and with the result of performing the
5003 @samp{%i} substitution.  (See below.)
5005 As an alternative to providing a spec string, the text that follows a
5006 suffix directive can be one of the following:
5008 @table @code
5009 @item @@@var{language}
5010 This says that the suffix is an alias for a known @var{language}.  This is
5011 similar to using the @option{-x} command-line switch to GCC to specify a
5012 language explicitly.  For example:
5014 @smallexample
5015 .ZZ:
5016 @@c++
5017 @end smallexample
5019 Says that .ZZ files are, in fact, C++ source files.
5021 @item #@var{name}
5022 This causes an error messages saying:
5024 @smallexample
5025 @var{name} compiler not installed on this system.
5026 @end smallexample
5027 @end table
5029 GCC already has an extensive list of suffixes built into it.
5030 This directive will add an entry to the end of the list of suffixes, but
5031 since the list is searched from the end backwards, it is effectively
5032 possible to override earlier entries using this technique.
5034 @end table
5036 GCC has the following spec strings built into it.  Spec files can
5037 override these strings or create their own.  Note that individual
5038 targets can also add their own spec strings to this list.
5040 @smallexample
5041 asm          Options to pass to the assembler
5042 asm_final    Options to pass to the assembler post-processor
5043 cpp          Options to pass to the C preprocessor
5044 cc1          Options to pass to the C compiler
5045 cc1plus      Options to pass to the C++ compiler
5046 endfile      Object files to include at the end of the link
5047 link         Options to pass to the linker
5048 lib          Libraries to include on the command line to the linker
5049 libgcc       Decides which GCC support library to pass to the linker
5050 linker       Sets the name of the linker
5051 predefines   Defines to be passed to the C preprocessor
5052 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5053              by default
5054 startfile    Object files to include at the start of the link
5055 @end smallexample
5057 Here is a small example of a spec file:
5059 @smallexample
5060 %rename lib                 old_lib
5062 *lib:
5063 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5064 @end smallexample
5066 This example renames the spec called @samp{lib} to @samp{old_lib} and
5067 then overrides the previous definition of @samp{lib} with a new one.
5068 The new definition adds in some extra command-line options before
5069 including the text of the old definition.
5071 @dfn{Spec strings} are a list of command-line options to be passed to their
5072 corresponding program.  In addition, the spec strings can contain
5073 @samp{%}-prefixed sequences to substitute variable text or to
5074 conditionally insert text into the command line.  Using these constructs
5075 it is possible to generate quite complex command lines.
5077 Here is a table of all defined @samp{%}-sequences for spec
5078 strings.  Note that spaces are not generated automatically around the
5079 results of expanding these sequences.  Therefore you can concatenate them
5080 together or combine them with constant text in a single argument.
5082 @table @code
5083 @item %%
5084 Substitute one @samp{%} into the program name or argument.
5086 @item %i
5087 Substitute the name of the input file being processed.
5089 @item %b
5090 Substitute the basename of the input file being processed.
5091 This is the substring up to (and not including) the last period
5092 and not including the directory.
5094 @item %B
5095 This is the same as @samp{%b}, but include the file suffix (text after
5096 the last period).
5098 @item %d
5099 Marks the argument containing or following the @samp{%d} as a
5100 temporary file name, so that that file will be deleted if GCC exits
5101 successfully.  Unlike @samp{%g}, this contributes no text to the
5102 argument.
5104 @item %g@var{suffix}
5105 Substitute a file name that has suffix @var{suffix} and is chosen
5106 once per compilation, and mark the argument in the same way as
5107 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5108 name is now chosen in a way that is hard to predict even when previously
5109 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5110 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5111 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5112 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5113 was simply substituted with a file name chosen once per compilation,
5114 without regard to any appended suffix (which was therefore treated
5115 just like ordinary text), making such attacks more likely to succeed.
5117 @item %u@var{suffix}
5118 Like @samp{%g}, but generates a new temporary file name even if
5119 @samp{%u@var{suffix}} was already seen.
5121 @item %U@var{suffix}
5122 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5123 new one if there is no such last file name.  In the absence of any
5124 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5125 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5126 would involve the generation of two distinct file names, one
5127 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5128 simply substituted with a file name chosen for the previous @samp{%u},
5129 without regard to any appended suffix.
5131 @item %j@var{suffix}
5132 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5133 writable, and if save-temps is off; otherwise, substitute the name
5134 of a temporary file, just like @samp{%u}.  This temporary file is not
5135 meant for communication between processes, but rather as a junk
5136 disposal mechanism.
5138 @item %|@var{suffix}
5139 @itemx %m@var{suffix}
5140 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5141 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5142 all.  These are the two most common ways to instruct a program that it
5143 should read from standard input or write to standard output.  If you
5144 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5145 construct: see for example @file{f/lang-specs.h}.
5147 @item %.@var{SUFFIX}
5148 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5149 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5150 terminated by the next space or %.
5152 @item %w
5153 Marks the argument containing or following the @samp{%w} as the
5154 designated output file of this compilation.  This puts the argument
5155 into the sequence of arguments that @samp{%o} will substitute later.
5157 @item %o
5158 Substitutes the names of all the output files, with spaces
5159 automatically placed around them.  You should write spaces
5160 around the @samp{%o} as well or the results are undefined.
5161 @samp{%o} is for use in the specs for running the linker.
5162 Input files whose names have no recognized suffix are not compiled
5163 at all, but they are included among the output files, so they will
5164 be linked.
5166 @item %O
5167 Substitutes the suffix for object files.  Note that this is
5168 handled specially when it immediately follows @samp{%g, %u, or %U},
5169 because of the need for those to form complete file names.  The
5170 handling is such that @samp{%O} is treated exactly as if it had already
5171 been substituted, except that @samp{%g, %u, and %U} do not currently
5172 support additional @var{suffix} characters following @samp{%O} as they would
5173 following, for example, @samp{.o}.
5175 @item %p
5176 Substitutes the standard macro predefinitions for the
5177 current target machine.  Use this when running @code{cpp}.
5179 @item %P
5180 Like @samp{%p}, but puts @samp{__} before and after the name of each
5181 predefined macro, except for macros that start with @samp{__} or with
5182 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5185 @item %I
5186 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5187 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5188 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5189 as necessary.
5191 @item %s
5192 Current argument is the name of a library or startup file of some sort.
5193 Search for that file in a standard list of directories and substitute
5194 the full name found.
5196 @item %e@var{str}
5197 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5198 Use this when inconsistent options are detected.
5200 @item %(@var{name})
5201 Substitute the contents of spec string @var{name} at this point.
5203 @item %[@var{name}]
5204 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5206 @item %x@{@var{option}@}
5207 Accumulate an option for @samp{%X}.
5209 @item %X
5210 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5211 spec string.
5213 @item %Y
5214 Output the accumulated assembler options specified by @option{-Wa}.
5216 @item %Z
5217 Output the accumulated preprocessor options specified by @option{-Wp}.
5219 @item %v1
5220 Substitute the major version number of GCC@.
5221 (For version 2.9.5, this is 2.)
5223 @item %v2
5224 Substitute the minor version number of GCC@.
5225 (For version 2.9.5, this is 9.)
5227 @item %v3
5228 Substitute the patch level number of GCC@.
5229 (For version 2.9.5, this is 5.)
5231 @item %a
5232 Process the @code{asm} spec.  This is used to compute the
5233 switches to be passed to the assembler.
5235 @item %A
5236 Process the @code{asm_final} spec.  This is a spec string for
5237 passing switches to an assembler post-processor, if such a program is
5238 needed.
5240 @item %l
5241 Process the @code{link} spec.  This is the spec for computing the
5242 command line passed to the linker.  Typically it will make use of the
5243 @samp{%L %G %S %D and %E} sequences.
5245 @item %D
5246 Dump out a @option{-L} option for each directory that GCC believes might
5247 contain startup files.  If the target supports multilibs then the
5248 current multilib directory will be prepended to each of these paths.
5250 @item %M
5251 Output the multilib directory with directory separators replaced with
5252 @samp{_}.  If multilib directories are not set, or the multilib directory is
5253 @file{.} then this option emits nothing.
5255 @item %L
5256 Process the @code{lib} spec.  This is a spec string for deciding which
5257 libraries should be included on the command line to the linker.
5259 @item %G
5260 Process the @code{libgcc} spec.  This is a spec string for deciding
5261 which GCC support library should be included on the command line to the linker.
5263 @item %S
5264 Process the @code{startfile} spec.  This is a spec for deciding which
5265 object files should be the first ones passed to the linker.  Typically
5266 this might be a file named @file{crt0.o}.
5268 @item %E
5269 Process the @code{endfile} spec.  This is a spec string that specifies
5270 the last object files that will be passed to the linker.
5272 @item %C
5273 Process the @code{cpp} spec.  This is used to construct the arguments
5274 to be passed to the C preprocessor.
5276 @item %c
5277 Process the @code{signed_char} spec.  This is intended to be used
5278 to tell cpp whether a char is signed.  It typically has the definition:
5279 @smallexample
5280 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5281 @end smallexample
5283 @item %1
5284 Process the @code{cc1} spec.  This is used to construct the options to be
5285 passed to the actual C compiler (@samp{cc1}).
5287 @item %2
5288 Process the @code{cc1plus} spec.  This is used to construct the options to be
5289 passed to the actual C++ compiler (@samp{cc1plus}).
5291 @item %*
5292 Substitute the variable part of a matched option.  See below.
5293 Note that each comma in the substituted string is replaced by
5294 a single space.
5296 @item %<@code{S}
5297 Remove all occurrences of @code{-S} from the command line.  Note---this
5298 command is position dependent.  @samp{%} commands in the spec string
5299 before this one will see @code{-S}, @samp{%} commands in the spec string
5300 after this one will not.
5302 @item %:@var{function}(@var{args})
5303 Call the named function @var{function}, passing it @var{args}.
5304 @var{args} is first processed as a nested spec string, then split
5305 into an argument vector in the usual fashion.  The function returns
5306 a string which is processed as if it had appeared literally as part
5307 of the current spec.
5309 The following built-in spec functions are provided:
5311 @table @code
5312 @item @code{if-exists}
5313 The @code{if-exists} spec function takes one argument, an absolute
5314 pathname to a file.  If the file exists, @code{if-exists} returns the
5315 pathname.  Here is a small example of its usage:
5317 @smallexample
5318 *startfile:
5319 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5320 @end smallexample
5322 @item @code{if-exists-else}
5323 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5324 spec function, except that it takes two arguments.  The first argument is
5325 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5326 returns the pathname.  If it does not exist, it returns the second argument.
5327 This way, @code{if-exists-else} can be used to select one file or another,
5328 based on the existence of the first.  Here is a small example of its usage:
5330 @smallexample 
5331 *startfile:
5332 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5333 @end smallexample
5334 @end table 
5336 @item %@{@code{S}@}
5337 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5338 If that switch was not specified, this substitutes nothing.  Note that
5339 the leading dash is omitted when specifying this option, and it is
5340 automatically inserted if the substitution is performed.  Thus the spec
5341 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5342 and would output the command line option @option{-foo}.
5344 @item %W@{@code{S}@}
5345 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5346 deleted on failure.
5348 @item %@{@code{S}*@}
5349 Substitutes all the switches specified to GCC whose names start
5350 with @code{-S}, but which also take an argument.  This is used for
5351 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5352 GCC considers @option{-o foo} as being
5353 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5354 text, including the space.  Thus two arguments would be generated.
5356 @item %@{@code{S}*&@code{T}*@}
5357 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5358 (the order of @code{S} and @code{T} in the spec is not significant).
5359 There can be any number of ampersand-separated variables; for each the
5360 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5362 @item %@{@code{S}:@code{X}@}
5363 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5365 @item %@{!@code{S}:@code{X}@}
5366 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5368 @item %@{@code{S}*:@code{X}@}
5369 Substitutes @code{X} if one or more switches whose names start with
5370 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5371 once, no matter how many such switches appeared.  However, if @code{%*}
5372 appears somewhere in @code{X}, then @code{X} will be substituted once
5373 for each matching switch, with the @code{%*} replaced by the part of
5374 that switch that matched the @code{*}.
5376 @item %@{.@code{S}:@code{X}@}
5377 Substitutes @code{X}, if processing a file with suffix @code{S}.
5379 @item %@{!.@code{S}:@code{X}@}
5380 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5382 @item %@{@code{S}|@code{P}:@code{X}@}
5383 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5384 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5385 although they have a stronger binding than the @samp{|}.  If @code{%*}
5386 appears in @code{X}, all of the alternatives must be starred, and only
5387 the first matching alternative is substituted.
5389 For example, a spec string like this:
5391 @smallexample
5392 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5393 @end smallexample
5395 will output the following command-line options from the following input
5396 command-line options:
5398 @smallexample
5399 fred.c        -foo -baz
5400 jim.d         -bar -boggle
5401 -d fred.c     -foo -baz -boggle
5402 -d jim.d      -bar -baz -boggle
5403 @end smallexample
5405 @item %@{S:X; T:Y; :D@}
5407 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5408 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5409 be as many clauses as you need.  This may be combined with @code{.}, 
5410 @code{!}, @code{|}, and @code{*} as needed.
5413 @end table
5415 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5416 construct may contain other nested @samp{%} constructs or spaces, or
5417 even newlines.  They are processed as usual, as described above.
5418 Trailing white space in @code{X} is ignored.  White space may also
5419 appear anywhere on the left side of the colon in these constructs,
5420 except between @code{.} or @code{*} and the corresponding word.
5422 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5423 handled specifically in these constructs.  If another value of
5424 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5425 @option{-W} switch is found later in the command line, the earlier
5426 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5427 just one letter, which passes all matching options.
5429 The character @samp{|} at the beginning of the predicate text is used to
5430 indicate that a command should be piped to the following command, but
5431 only if @option{-pipe} is specified.
5433 It is built into GCC which switches take arguments and which do not.
5434 (You might think it would be useful to generalize this to allow each
5435 compiler's spec to say which switches take arguments.  But this cannot
5436 be done in a consistent fashion.  GCC cannot even decide which input
5437 files have been specified without knowing which switches take arguments,
5438 and it must know which input files to compile in order to tell which
5439 compilers to run).
5441 GCC also knows implicitly that arguments starting in @option{-l} are to be
5442 treated as compiler output files, and passed to the linker in their
5443 proper position among the other output files.
5445 @c man begin OPTIONS
5447 @node Target Options
5448 @section Specifying Target Machine and Compiler Version
5449 @cindex target options
5450 @cindex cross compiling
5451 @cindex specifying machine version
5452 @cindex specifying compiler version and target machine
5453 @cindex compiler version, specifying
5454 @cindex target machine, specifying
5456 The usual way to run GCC is to run the executable called @file{gcc}, or
5457 @file{<machine>-gcc} when cross-compiling, or
5458 @file{<machine>-gcc-<version>} to run a version other than the one that
5459 was installed last.  Sometimes this is inconvenient, so GCC provides
5460 options that will switch to another cross-compiler or version.
5462 @table @gcctabopt
5463 @item -b @var{machine}
5464 @opindex b
5465 The argument @var{machine} specifies the target machine for compilation.
5467 The value to use for @var{machine} is the same as was specified as the
5468 machine type when configuring GCC as a cross-compiler.  For
5469 example, if a cross-compiler was configured with @samp{configure
5470 i386v}, meaning to compile for an 80386 running System V, then you
5471 would specify @option{-b i386v} to run that cross compiler.
5473 @item -V @var{version}
5474 @opindex V
5475 The argument @var{version} specifies which version of GCC to run.
5476 This is useful when multiple versions are installed.  For example,
5477 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5478 @end table
5480 The @option{-V} and @option{-b} options work by running the
5481 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5482 use them if you can just run that directly.
5484 @node Submodel Options
5485 @section Hardware Models and Configurations
5486 @cindex submodel options
5487 @cindex specifying hardware config
5488 @cindex hardware models and configurations, specifying
5489 @cindex machine dependent options
5491 Earlier we discussed the standard option @option{-b} which chooses among
5492 different installed compilers for completely different target
5493 machines, such as VAX vs.@: 68000 vs.@: 80386.
5495 In addition, each of these target machine types can have its own
5496 special options, starting with @samp{-m}, to choose among various
5497 hardware models or configurations---for example, 68010 vs 68020,
5498 floating coprocessor or none.  A single installed version of the
5499 compiler can compile for any model or configuration, according to the
5500 options specified.
5502 Some configurations of the compiler also support additional special
5503 options, usually for compatibility with other compilers on the same
5504 platform.
5506 These options are defined by the macro @code{TARGET_SWITCHES} in the
5507 machine description.  The default for the options is also defined by
5508 that macro, which enables you to change the defaults.
5510 @menu
5511 * M680x0 Options::
5512 * M68hc1x Options::
5513 * VAX Options::
5514 * SPARC Options::
5515 * ARM Options::
5516 * MN10200 Options::
5517 * MN10300 Options::
5518 * M32R/D Options::
5519 * M88K Options::
5520 * RS/6000 and PowerPC Options::
5521 * Darwin Options::
5522 * RT Options::
5523 * MIPS Options::
5524 * i386 and x86-64 Options::
5525 * HPPA Options::
5526 * Intel 960 Options::
5527 * DEC Alpha Options::
5528 * DEC Alpha/VMS Options::
5529 * H8/300 Options::
5530 * SH Options::
5531 * System V Options::
5532 * TMS320C3x/C4x Options::
5533 * V850 Options::
5534 * ARC Options::
5535 * NS32K Options::
5536 * AVR Options::
5537 * MCore Options::
5538 * IA-64 Options::
5539 * D30V Options::
5540 * S/390 and zSeries Options::
5541 * CRIS Options::
5542 * MMIX Options::
5543 * PDP-11 Options::
5544 * Xstormy16 Options::
5545 * Xtensa Options::
5546 * FRV Options::
5547 @end menu
5549 @node M680x0 Options
5550 @subsection M680x0 Options
5551 @cindex M680x0 options
5553 These are the @samp{-m} options defined for the 68000 series.  The default
5554 values for these options depends on which style of 68000 was selected when
5555 the compiler was configured; the defaults for the most common choices are
5556 given below.
5558 @table @gcctabopt
5559 @item -m68000
5560 @itemx -mc68000
5561 @opindex m68000
5562 @opindex mc68000
5563 Generate output for a 68000.  This is the default
5564 when the compiler is configured for 68000-based systems.
5566 Use this option for microcontrollers with a 68000 or EC000 core,
5567 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5569 @item -m68020
5570 @itemx -mc68020
5571 @opindex m68020
5572 @opindex mc68020
5573 Generate output for a 68020.  This is the default
5574 when the compiler is configured for 68020-based systems.
5576 @item -m68881
5577 @opindex m68881
5578 Generate output containing 68881 instructions for floating point.
5579 This is the default for most 68020 systems unless @option{--nfp} was
5580 specified when the compiler was configured.
5582 @item -m68030
5583 @opindex m68030
5584 Generate output for a 68030.  This is the default when the compiler is
5585 configured for 68030-based systems.
5587 @item -m68040
5588 @opindex m68040
5589 Generate output for a 68040.  This is the default when the compiler is
5590 configured for 68040-based systems.
5592 This option inhibits the use of 68881/68882 instructions that have to be
5593 emulated by software on the 68040.  Use this option if your 68040 does not
5594 have code to emulate those instructions.
5596 @item -m68060
5597 @opindex m68060
5598 Generate output for a 68060.  This is the default when the compiler is
5599 configured for 68060-based systems.
5601 This option inhibits the use of 68020 and 68881/68882 instructions that
5602 have to be emulated by software on the 68060.  Use this option if your 68060
5603 does not have code to emulate those instructions.
5605 @item -mcpu32
5606 @opindex mcpu32
5607 Generate output for a CPU32.  This is the default
5608 when the compiler is configured for CPU32-based systems.
5610 Use this option for microcontrollers with a
5611 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5612 68336, 68340, 68341, 68349 and 68360.
5614 @item -m5200
5615 @opindex m5200
5616 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5617 when the compiler is configured for 520X-based systems.
5619 Use this option for microcontroller with a 5200 core, including
5620 the MCF5202, MCF5203, MCF5204 and MCF5202.
5623 @item -m68020-40
5624 @opindex m68020-40
5625 Generate output for a 68040, without using any of the new instructions.
5626 This results in code which can run relatively efficiently on either a
5627 68020/68881 or a 68030 or a 68040.  The generated code does use the
5628 68881 instructions that are emulated on the 68040.
5630 @item -m68020-60
5631 @opindex m68020-60
5632 Generate output for a 68060, without using any of the new instructions.
5633 This results in code which can run relatively efficiently on either a
5634 68020/68881 or a 68030 or a 68040.  The generated code does use the
5635 68881 instructions that are emulated on the 68060.
5637 @item -mfpa
5638 @opindex mfpa
5639 Generate output containing Sun FPA instructions for floating point.
5641 @item -msoft-float
5642 @opindex msoft-float
5643 Generate output containing library calls for floating point.
5644 @strong{Warning:} the requisite libraries are not available for all m68k
5645 targets.  Normally the facilities of the machine's usual C compiler are
5646 used, but this can't be done directly in cross-compilation.  You must
5647 make your own arrangements to provide suitable library functions for
5648 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5649 @samp{m68k-*-coff} do provide software floating point support.
5651 @item -mshort
5652 @opindex mshort
5653 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5655 @item -mnobitfield
5656 @opindex mnobitfield
5657 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5658 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5660 @item -mbitfield
5661 @opindex mbitfield
5662 Do use the bit-field instructions.  The @option{-m68020} option implies
5663 @option{-mbitfield}.  This is the default if you use a configuration
5664 designed for a 68020.
5666 @item -mrtd
5667 @opindex mrtd
5668 Use a different function-calling convention, in which functions
5669 that take a fixed number of arguments return with the @code{rtd}
5670 instruction, which pops their arguments while returning.  This
5671 saves one instruction in the caller since there is no need to pop
5672 the arguments there.
5674 This calling convention is incompatible with the one normally
5675 used on Unix, so you cannot use it if you need to call libraries
5676 compiled with the Unix compiler.
5678 Also, you must provide function prototypes for all functions that
5679 take variable numbers of arguments (including @code{printf});
5680 otherwise incorrect code will be generated for calls to those
5681 functions.
5683 In addition, seriously incorrect code will result if you call a
5684 function with too many arguments.  (Normally, extra arguments are
5685 harmlessly ignored.)
5687 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5688 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5690 @item -malign-int
5691 @itemx -mno-align-int
5692 @opindex malign-int
5693 @opindex mno-align-int
5694 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5695 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5696 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5697 Aligning variables on 32-bit boundaries produces code that runs somewhat
5698 faster on processors with 32-bit busses at the expense of more memory.
5700 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5701 align structures containing the above types  differently than
5702 most published application binary interface specifications for the m68k.
5704 @item -mpcrel
5705 @opindex mpcrel
5706 Use the pc-relative addressing mode of the 68000 directly, instead of
5707 using a global offset table.  At present, this option implies @option{-fpic},
5708 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5709 not presently supported with @option{-mpcrel}, though this could be supported for
5710 68020 and higher processors.
5712 @item -mno-strict-align
5713 @itemx -mstrict-align
5714 @opindex mno-strict-align
5715 @opindex mstrict-align
5716 Do not (do) assume that unaligned memory references will be handled by
5717 the system.
5719 @end table
5721 @node M68hc1x Options
5722 @subsection M68hc1x Options
5723 @cindex M68hc1x options
5725 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5726 microcontrollers.  The default values for these options depends on
5727 which style of microcontroller was selected when the compiler was configured;
5728 the defaults for the most common choices are given below.
5730 @table @gcctabopt
5731 @item -m6811
5732 @itemx -m68hc11
5733 @opindex m6811
5734 @opindex m68hc11
5735 Generate output for a 68HC11.  This is the default
5736 when the compiler is configured for 68HC11-based systems.
5738 @item -m6812
5739 @itemx -m68hc12
5740 @opindex m6812
5741 @opindex m68hc12
5742 Generate output for a 68HC12.  This is the default
5743 when the compiler is configured for 68HC12-based systems.
5745 @item -m68S12
5746 @itemx -m68hcs12
5747 @opindex m68S12
5748 @opindex m68hcs12
5749 Generate output for a 68HCS12.  
5751 @item -mauto-incdec
5752 @opindex mauto-incdec
5753 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5754 addressing modes.
5756 @item -minmax
5757 @itemx -nominmax
5758 @opindex minmax
5759 @opindex mnominmax
5760 Enable the use of 68HC12 min and max instructions.
5762 @item -mlong-calls
5763 @itemx -mno-long-calls
5764 @opindex mlong-calls
5765 @opindex mno-long-calls
5766 Treat all calls as being far away (near).  If calls are assumed to be
5767 far away, the compiler will use the @code{call} instruction to
5768 call a function and the @code{rtc} instruction for returning.
5770 @item -mshort
5771 @opindex mshort
5772 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5774 @item -msoft-reg-count=@var{count}
5775 @opindex msoft-reg-count
5776 Specify the number of pseudo-soft registers which are used for the
5777 code generation.  The maximum number is 32.  Using more pseudo-soft
5778 register may or may not result in better code depending on the program.
5779 The default is 4 for 68HC11 and 2 for 68HC12.
5781 @end table
5783 @node VAX Options
5784 @subsection VAX Options
5785 @cindex VAX options
5787 These @samp{-m} options are defined for the VAX:
5789 @table @gcctabopt
5790 @item -munix
5791 @opindex munix
5792 Do not output certain jump instructions (@code{aobleq} and so on)
5793 that the Unix assembler for the VAX cannot handle across long
5794 ranges.
5796 @item -mgnu
5797 @opindex mgnu
5798 Do output those jump instructions, on the assumption that you
5799 will assemble with the GNU assembler.
5801 @item -mg
5802 @opindex mg
5803 Output code for g-format floating point numbers instead of d-format.
5804 @end table
5806 @node SPARC Options
5807 @subsection SPARC Options
5808 @cindex SPARC options
5810 These @samp{-m} switches are supported on the SPARC:
5812 @table @gcctabopt
5813 @item -mno-app-regs
5814 @itemx -mapp-regs
5815 @opindex mno-app-regs
5816 @opindex mapp-regs
5817 Specify @option{-mapp-regs} to generate output using the global registers
5818 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5819 is the default.
5821 To be fully SVR4 ABI compliant at the cost of some performance loss,
5822 specify @option{-mno-app-regs}.  You should compile libraries and system
5823 software with this option.
5825 @item -mfpu
5826 @itemx -mhard-float
5827 @opindex mfpu
5828 @opindex mhard-float
5829 Generate output containing floating point instructions.  This is the
5830 default.
5832 @item -mno-fpu
5833 @itemx -msoft-float
5834 @opindex mno-fpu
5835 @opindex msoft-float
5836 Generate output containing library calls for floating point.
5837 @strong{Warning:} the requisite libraries are not available for all SPARC
5838 targets.  Normally the facilities of the machine's usual C compiler are
5839 used, but this cannot be done directly in cross-compilation.  You must make
5840 your own arrangements to provide suitable library functions for
5841 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5842 @samp{sparclite-*-*} do provide software floating point support.
5844 @option{-msoft-float} changes the calling convention in the output file;
5845 therefore, it is only useful if you compile @emph{all} of a program with
5846 this option.  In particular, you need to compile @file{libgcc.a}, the
5847 library that comes with GCC, with @option{-msoft-float} in order for
5848 this to work.
5850 @item -mhard-quad-float
5851 @opindex mhard-quad-float
5852 Generate output containing quad-word (long double) floating point
5853 instructions.
5855 @item -msoft-quad-float
5856 @opindex msoft-quad-float
5857 Generate output containing library calls for quad-word (long double)
5858 floating point instructions.  The functions called are those specified
5859 in the SPARC ABI@.  This is the default.
5861 As of this writing, there are no sparc implementations that have hardware
5862 support for the quad-word floating point instructions.  They all invoke
5863 a trap handler for one of these instructions, and then the trap handler
5864 emulates the effect of the instruction.  Because of the trap handler overhead,
5865 this is much slower than calling the ABI library routines.  Thus the
5866 @option{-msoft-quad-float} option is the default.
5868 @item -mno-flat
5869 @itemx -mflat
5870 @opindex mno-flat
5871 @opindex mflat
5872 With @option{-mflat}, the compiler does not generate save/restore instructions
5873 and will use a ``flat'' or single register window calling convention.
5874 This model uses %i7 as the frame pointer and is compatible with the normal
5875 register window model.  Code from either may be intermixed.
5876 The local registers and the input registers (0--5) are still treated as
5877 ``call saved'' registers and will be saved on the stack as necessary.
5879 With @option{-mno-flat} (the default), the compiler emits save/restore
5880 instructions (except for leaf functions) and is the normal mode of operation.
5882 @item -mno-unaligned-doubles
5883 @itemx -munaligned-doubles
5884 @opindex mno-unaligned-doubles
5885 @opindex munaligned-doubles
5886 Assume that doubles have 8 byte alignment.  This is the default.
5888 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5889 alignment only if they are contained in another type, or if they have an
5890 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5891 Specifying this option avoids some rare compatibility problems with code
5892 generated by other compilers.  It is not the default because it results
5893 in a performance loss, especially for floating point code.
5895 @item -mno-faster-structs
5896 @itemx -mfaster-structs
5897 @opindex mno-faster-structs
5898 @opindex mfaster-structs
5899 With @option{-mfaster-structs}, the compiler assumes that structures
5900 should have 8 byte alignment.  This enables the use of pairs of
5901 @code{ldd} and @code{std} instructions for copies in structure
5902 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5903 However, the use of this changed alignment directly violates the SPARC
5904 ABI@.  Thus, it's intended only for use on targets where the developer
5905 acknowledges that their resulting code will not be directly in line with
5906 the rules of the ABI@.
5908 @item -mv8
5909 @itemx -msparclite
5910 @opindex mv8
5911 @opindex msparclite
5912 These two options select variations on the SPARC architecture.
5914 By default (unless specifically configured for the Fujitsu SPARClite),
5915 GCC generates code for the v7 variant of the SPARC architecture.
5917 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5918 code is that the compiler emits the integer multiply and integer
5919 divide instructions which exist in SPARC v8 but not in SPARC v7.
5921 @option{-msparclite} will give you SPARClite code.  This adds the integer
5922 multiply, integer divide step and scan (@code{ffs}) instructions which
5923 exist in SPARClite but not in SPARC v7.
5925 These options are deprecated and will be deleted in a future GCC release.
5926 They have been replaced with @option{-mcpu=xxx}.
5928 @item -mcypress
5929 @itemx -msupersparc
5930 @opindex mcypress
5931 @opindex msupersparc
5932 These two options select the processor for which the code is optimized.
5934 With @option{-mcypress} (the default), the compiler optimizes code for the
5935 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5936 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5938 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5939 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5940 of the full SPARC v8 instruction set.
5942 These options are deprecated and will be deleted in a future GCC release.
5943 They have been replaced with @option{-mcpu=xxx}.
5945 @item -mcpu=@var{cpu_type}
5946 @opindex mcpu
5947 Set the instruction set, register set, and instruction scheduling parameters
5948 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5949 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5950 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5951 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5952 @samp{ultrasparc3}.
5954 Default instruction scheduling parameters are used for values that select
5955 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5956 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5958 Here is a list of each supported architecture and their supported
5959 implementations.
5961 @smallexample
5962     v7:             cypress
5963     v8:             supersparc, hypersparc
5964     sparclite:      f930, f934, sparclite86x
5965     sparclet:       tsc701
5966     v9:             ultrasparc, ultrasparc3
5967 @end smallexample
5969 @item -mtune=@var{cpu_type}
5970 @opindex mtune
5971 Set the instruction scheduling parameters for machine type
5972 @var{cpu_type}, but do not set the instruction set or register set that the
5973 option @option{-mcpu=@var{cpu_type}} would.
5975 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5976 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5977 that select a particular cpu implementation.  Those are @samp{cypress},
5978 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5979 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5980 @samp{ultrasparc3}.
5982 @end table
5984 These @samp{-m} switches are supported in addition to the above
5985 on the SPARCLET processor.
5987 @table @gcctabopt
5988 @item -mlittle-endian
5989 @opindex mlittle-endian
5990 Generate code for a processor running in little-endian mode.
5992 @item -mlive-g0
5993 @opindex mlive-g0
5994 Treat register @code{%g0} as a normal register.
5995 GCC will continue to clobber it as necessary but will not assume
5996 it always reads as 0.
5998 @item -mbroken-saverestore
5999 @opindex mbroken-saverestore
6000 Generate code that does not use non-trivial forms of the @code{save} and
6001 @code{restore} instructions.  Early versions of the SPARCLET processor do
6002 not correctly handle @code{save} and @code{restore} instructions used with
6003 arguments.  They correctly handle them used without arguments.  A @code{save}
6004 instruction used without arguments increments the current window pointer
6005 but does not allocate a new stack frame.  It is assumed that the window
6006 overflow trap handler will properly handle this case as will interrupt
6007 handlers.
6008 @end table
6010 These @samp{-m} switches are supported in addition to the above
6011 on SPARC V9 processors in 64-bit environments.
6013 @table @gcctabopt
6014 @item -mlittle-endian
6015 @opindex mlittle-endian
6016 Generate code for a processor running in little-endian mode.
6018 @item -m32
6019 @itemx -m64
6020 @opindex m32
6021 @opindex m64
6022 Generate code for a 32-bit or 64-bit environment.
6023 The 32-bit environment sets int, long and pointer to 32 bits.
6024 The 64-bit environment sets int to 32 bits and long and pointer
6025 to 64 bits.
6027 @item -mcmodel=medlow
6028 @opindex mcmodel=medlow
6029 Generate code for the Medium/Low code model: the program must be linked
6030 in the low 32 bits of the address space.  Pointers are 64 bits.
6031 Programs can be statically or dynamically linked.
6033 @item -mcmodel=medmid
6034 @opindex mcmodel=medmid
6035 Generate code for the Medium/Middle code model: the program must be linked
6036 in the low 44 bits of the address space, the text segment must be less than
6037 2G bytes, and data segment must be within 2G of the text segment.
6038 Pointers are 64 bits.
6040 @item -mcmodel=medany
6041 @opindex mcmodel=medany
6042 Generate code for the Medium/Anywhere code model: the program may be linked
6043 anywhere in the address space, the text segment must be less than
6044 2G bytes, and data segment must be within 2G of the text segment.
6045 Pointers are 64 bits.
6047 @item -mcmodel=embmedany
6048 @opindex mcmodel=embmedany
6049 Generate code for the Medium/Anywhere code model for embedded systems:
6050 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6051 (determined at link time).  Register %g4 points to the base of the
6052 data segment.  Pointers are still 64 bits.
6053 Programs are statically linked, PIC is not supported.
6055 @item -mstack-bias
6056 @itemx -mno-stack-bias
6057 @opindex mstack-bias
6058 @opindex mno-stack-bias
6059 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6060 frame pointer if present, are offset by @minus{}2047 which must be added back
6061 when making stack frame references.
6062 Otherwise, assume no such offset is present.
6063 @end table
6065 @node ARM Options
6066 @subsection ARM Options
6067 @cindex ARM options
6069 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6070 architectures:
6072 @table @gcctabopt
6073 @item -mapcs-frame
6074 @opindex mapcs-frame
6075 Generate a stack frame that is compliant with the ARM Procedure Call
6076 Standard for all functions, even if this is not strictly necessary for
6077 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6078 with this option will cause the stack frames not to be generated for
6079 leaf functions.  The default is @option{-mno-apcs-frame}.
6081 @item -mapcs
6082 @opindex mapcs
6083 This is a synonym for @option{-mapcs-frame}.
6085 @item -mapcs-26
6086 @opindex mapcs-26
6087 Generate code for a processor running with a 26-bit program counter,
6088 and conforming to the function calling standards for the APCS 26-bit
6089 option.  This option replaces the @option{-m2} and @option{-m3} options
6090 of previous releases of the compiler.
6092 @item -mapcs-32
6093 @opindex mapcs-32
6094 Generate code for a processor running with a 32-bit program counter,
6095 and conforming to the function calling standards for the APCS 32-bit
6096 option.  This option replaces the @option{-m6} option of previous releases
6097 of the compiler.
6099 @ignore
6100 @c not currently implemented
6101 @item -mapcs-stack-check
6102 @opindex mapcs-stack-check
6103 Generate code to check the amount of stack space available upon entry to
6104 every function (that actually uses some stack space).  If there is
6105 insufficient space available then either the function
6106 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6107 called, depending upon the amount of stack space required.  The run time
6108 system is required to provide these functions.  The default is
6109 @option{-mno-apcs-stack-check}, since this produces smaller code.
6111 @c not currently implemented
6112 @item -mapcs-float
6113 @opindex mapcs-float
6114 Pass floating point arguments using the float point registers.  This is
6115 one of the variants of the APCS@.  This option is recommended if the
6116 target hardware has a floating point unit or if a lot of floating point
6117 arithmetic is going to be performed by the code.  The default is
6118 @option{-mno-apcs-float}, since integer only code is slightly increased in
6119 size if @option{-mapcs-float} is used.
6121 @c not currently implemented
6122 @item -mapcs-reentrant
6123 @opindex mapcs-reentrant
6124 Generate reentrant, position independent code.  The default is
6125 @option{-mno-apcs-reentrant}.
6126 @end ignore
6128 @item -mthumb-interwork
6129 @opindex mthumb-interwork
6130 Generate code which supports calling between the ARM and Thumb
6131 instruction sets.  Without this option the two instruction sets cannot
6132 be reliably used inside one program.  The default is
6133 @option{-mno-thumb-interwork}, since slightly larger code is generated
6134 when @option{-mthumb-interwork} is specified.
6136 @item -mno-sched-prolog
6137 @opindex mno-sched-prolog
6138 Prevent the reordering of instructions in the function prolog, or the
6139 merging of those instruction with the instructions in the function's
6140 body.  This means that all functions will start with a recognizable set
6141 of instructions (or in fact one of a choice from a small set of
6142 different function prologues), and this information can be used to
6143 locate the start if functions inside an executable piece of code.  The
6144 default is @option{-msched-prolog}.
6146 @item -mhard-float
6147 @opindex mhard-float
6148 Generate output containing floating point instructions.  This is the
6149 default.
6151 @item -msoft-float
6152 @opindex msoft-float
6153 Generate output containing library calls for floating point.
6154 @strong{Warning:} the requisite libraries are not available for all ARM
6155 targets.  Normally the facilities of the machine's usual C compiler are
6156 used, but this cannot be done directly in cross-compilation.  You must make
6157 your own arrangements to provide suitable library functions for
6158 cross-compilation.
6160 @option{-msoft-float} changes the calling convention in the output file;
6161 therefore, it is only useful if you compile @emph{all} of a program with
6162 this option.  In particular, you need to compile @file{libgcc.a}, the
6163 library that comes with GCC, with @option{-msoft-float} in order for
6164 this to work.
6166 @item -mlittle-endian
6167 @opindex mlittle-endian
6168 Generate code for a processor running in little-endian mode.  This is
6169 the default for all standard configurations.
6171 @item -mbig-endian
6172 @opindex mbig-endian
6173 Generate code for a processor running in big-endian mode; the default is
6174 to compile code for a little-endian processor.
6176 @item -mwords-little-endian
6177 @opindex mwords-little-endian
6178 This option only applies when generating code for big-endian processors.
6179 Generate code for a little-endian word order but a big-endian byte
6180 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6181 option should only be used if you require compatibility with code for
6182 big-endian ARM processors generated by versions of the compiler prior to
6183 2.8.
6185 @item -malignment-traps
6186 @opindex malignment-traps
6187 Generate code that will not trap if the MMU has alignment traps enabled.
6188 On ARM architectures prior to ARMv4, there were no instructions to
6189 access half-word objects stored in memory.  However, when reading from
6190 memory a feature of the ARM architecture allows a word load to be used,
6191 even if the address is unaligned, and the processor core will rotate the
6192 data as it is being loaded.  This option tells the compiler that such
6193 misaligned accesses will cause a MMU trap and that it should instead
6194 synthesize the access as a series of byte accesses.  The compiler can
6195 still use word accesses to load half-word data if it knows that the
6196 address is aligned to a word boundary.
6198 This option is ignored when compiling for ARM architecture 4 or later,
6199 since these processors have instructions to directly access half-word
6200 objects in memory.
6202 @item -mno-alignment-traps
6203 @opindex mno-alignment-traps
6204 Generate code that assumes that the MMU will not trap unaligned
6205 accesses.  This produces better code when the target instruction set
6206 does not have half-word memory operations (i.e.@: implementations prior to
6207 ARMv4).
6209 Note that you cannot use this option to access unaligned word objects,
6210 since the processor will only fetch one 32-bit aligned object from
6211 memory.
6213 The default setting for most targets is @option{-mno-alignment-traps}, since
6214 this produces better code when there are no half-word memory
6215 instructions available.
6217 @item -mshort-load-bytes
6218 @itemx -mno-short-load-words
6219 @opindex mshort-load-bytes
6220 @opindex mno-short-load-words
6221 These are deprecated aliases for @option{-malignment-traps}.
6223 @item -mno-short-load-bytes
6224 @itemx -mshort-load-words
6225 @opindex mno-short-load-bytes
6226 @opindex mshort-load-words
6227 This are deprecated aliases for @option{-mno-alignment-traps}.
6229 @item -mcpu=@var{name}
6230 @opindex mcpu
6231 This specifies the name of the target ARM processor.  GCC uses this name
6232 to determine what kind of instructions it can emit when generating
6233 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6234 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6235 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6236 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6237 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6238 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6239 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6240 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6241 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6242 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6244 @itemx -mtune=@var{name}
6245 @opindex mtune
6246 This option is very similar to the @option{-mcpu=} option, except that
6247 instead of specifying the actual target processor type, and hence
6248 restricting which instructions can be used, it specifies that GCC should
6249 tune the performance of the code as if the target were of the type
6250 specified in this option, but still choosing the instructions that it
6251 will generate based on the cpu specified by a @option{-mcpu=} option.
6252 For some ARM implementations better performance can be obtained by using
6253 this option.
6255 @item -march=@var{name}
6256 @opindex march
6257 This specifies the name of the target ARM architecture.  GCC uses this
6258 name to determine what kind of instructions it can emit when generating
6259 assembly code.  This option can be used in conjunction with or instead
6260 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6261 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6262 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6264 @item -mfpe=@var{number}
6265 @itemx -mfp=@var{number}
6266 @opindex mfpe
6267 @opindex mfp
6268 This specifies the version of the floating point emulation available on
6269 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6270 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6272 @item -mstructure-size-boundary=@var{n}
6273 @opindex mstructure-size-boundary
6274 The size of all structures and unions will be rounded up to a multiple
6275 of the number of bits set by this option.  Permissible values are 8 and
6276 32.  The default value varies for different toolchains.  For the COFF
6277 targeted toolchain the default value is 8.  Specifying the larger number
6278 can produce faster, more efficient code, but can also increase the size
6279 of the program.  The two values are potentially incompatible.  Code
6280 compiled with one value cannot necessarily expect to work with code or
6281 libraries compiled with the other value, if they exchange information
6282 using structures or unions.
6284 @item -mabort-on-noreturn
6285 @opindex mabort-on-noreturn
6286 Generate a call to the function @code{abort} at the end of a
6287 @code{noreturn} function.  It will be executed if the function tries to
6288 return.
6290 @item -mlong-calls
6291 @itemx -mno-long-calls
6292 @opindex mlong-calls
6293 @opindex mno-long-calls
6294 Tells the compiler to perform function calls by first loading the
6295 address of the function into a register and then performing a subroutine
6296 call on this register.  This switch is needed if the target function
6297 will lie outside of the 64 megabyte addressing range of the offset based
6298 version of subroutine call instruction.
6300 Even if this switch is enabled, not all function calls will be turned
6301 into long calls.  The heuristic is that static functions, functions
6302 which have the @samp{short-call} attribute, functions that are inside
6303 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6304 definitions have already been compiled within the current compilation
6305 unit, will not be turned into long calls.  The exception to this rule is
6306 that weak function definitions, functions with the @samp{long-call}
6307 attribute or the @samp{section} attribute, and functions that are within
6308 the scope of a @samp{#pragma long_calls} directive, will always be
6309 turned into long calls.
6311 This feature is not enabled by default.  Specifying
6312 @option{-mno-long-calls} will restore the default behavior, as will
6313 placing the function calls within the scope of a @samp{#pragma
6314 long_calls_off} directive.  Note these switches have no effect on how
6315 the compiler generates code to handle function calls via function
6316 pointers.
6318 @item -mnop-fun-dllimport
6319 @opindex mnop-fun-dllimport
6320 Disable support for the @code{dllimport} attribute.
6322 @item -msingle-pic-base
6323 @opindex msingle-pic-base
6324 Treat the register used for PIC addressing as read-only, rather than
6325 loading it in the prologue for each function.  The run-time system is
6326 responsible for initializing this register with an appropriate value
6327 before execution begins.
6329 @item -mpic-register=@var{reg}
6330 @opindex mpic-register
6331 Specify the register to be used for PIC addressing.  The default is R10
6332 unless stack-checking is enabled, when R9 is used.
6334 @item -mcirrus-fix-invalid-insns
6335 @opindex -mcirrus-fix-invalid-insns
6336 @opindex -mno-cirrus-fix-invalid-insns
6337 Insert NOPs into the instruction stream to in order to work around
6338 problems with invalid Maverick instruction combinations.  This option
6339 is only valid if the @option{-mcpu=ep9312} option has been used to
6340 enable generation of instructions for the Cirrus Maverick floating
6341 point co-processor.  This option is not enabled by default, since the
6342 problem is only present in older Maverick implemenations.  The default
6343 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6344 switch.
6346 @item -mpoke-function-name
6347 @opindex mpoke-function-name
6348 Write the name of each function into the text section, directly
6349 preceding the function prologue.  The generated code is similar to this:
6351 @smallexample
6352      t0
6353          .ascii "arm_poke_function_name", 0
6354          .align
6355      t1
6356          .word 0xff000000 + (t1 - t0)
6357      arm_poke_function_name
6358          mov     ip, sp
6359          stmfd   sp!, @{fp, ip, lr, pc@}
6360          sub     fp, ip, #4
6361 @end smallexample
6363 When performing a stack backtrace, code can inspect the value of
6364 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6365 location @code{pc - 12} and the top 8 bits are set, then we know that
6366 there is a function name embedded immediately preceding this location
6367 and has length @code{((pc[-3]) & 0xff000000)}.
6369 @item -mthumb
6370 @opindex mthumb
6371 Generate code for the 16-bit Thumb instruction set.  The default is to
6372 use the 32-bit ARM instruction set.
6374 @item -mtpcs-frame
6375 @opindex mtpcs-frame
6376 Generate a stack frame that is compliant with the Thumb Procedure Call
6377 Standard for all non-leaf functions.  (A leaf function is one that does
6378 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6380 @item -mtpcs-leaf-frame
6381 @opindex mtpcs-leaf-frame
6382 Generate a stack frame that is compliant with the Thumb Procedure Call
6383 Standard for all leaf functions.  (A leaf function is one that does
6384 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6386 @item -mcallee-super-interworking
6387 @opindex mcallee-super-interworking
6388 Gives all externally visible functions in the file being compiled an ARM
6389 instruction set header which switches to Thumb mode before executing the
6390 rest of the function.  This allows these functions to be called from
6391 non-interworking code.
6393 @item -mcaller-super-interworking
6394 @opindex mcaller-super-interworking
6395 Allows calls via function pointers (including virtual functions) to
6396 execute correctly regardless of whether the target code has been
6397 compiled for interworking or not.  There is a small overhead in the cost
6398 of executing a function pointer if this option is enabled.
6400 @end table
6402 @node MN10200 Options
6403 @subsection MN10200 Options
6404 @cindex MN10200 options
6405 These @option{-m} options are defined for Matsushita MN10200 architectures:
6406 @table @gcctabopt
6408 @item -mrelax
6409 @opindex mrelax
6410 Indicate to the linker that it should perform a relaxation optimization pass
6411 to shorten branches, calls and absolute memory addresses.  This option only
6412 has an effect when used on the command line for the final link step.
6414 This option makes symbolic debugging impossible.
6415 @end table
6417 @node MN10300 Options
6418 @subsection MN10300 Options
6419 @cindex MN10300 options
6420 These @option{-m} options are defined for Matsushita MN10300 architectures:
6422 @table @gcctabopt
6423 @item -mmult-bug
6424 @opindex mmult-bug
6425 Generate code to avoid bugs in the multiply instructions for the MN10300
6426 processors.  This is the default.
6428 @item -mno-mult-bug
6429 @opindex mno-mult-bug
6430 Do not generate code to avoid bugs in the multiply instructions for the
6431 MN10300 processors.
6433 @item -mam33
6434 @opindex mam33
6435 Generate code which uses features specific to the AM33 processor.
6437 @item -mno-am33
6438 @opindex mno-am33
6439 Do not generate code which uses features specific to the AM33 processor.  This
6440 is the default.
6442 @item -mno-crt0
6443 @opindex mno-crt0
6444 Do not link in the C run-time initialization object file.
6446 @item -mrelax
6447 @opindex mrelax
6448 Indicate to the linker that it should perform a relaxation optimization pass
6449 to shorten branches, calls and absolute memory addresses.  This option only
6450 has an effect when used on the command line for the final link step.
6452 This option makes symbolic debugging impossible.
6453 @end table
6456 @node M32R/D Options
6457 @subsection M32R/D Options
6458 @cindex M32R/D options
6460 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6462 @table @gcctabopt
6463 @item -m32rx
6464 @opindex m32rx
6465 Generate code for the M32R/X@.
6467 @item -m32r
6468 @opindex m32r
6469 Generate code for the M32R@.  This is the default.
6471 @item -mcode-model=small
6472 @opindex mcode-model=small
6473 Assume all objects live in the lower 16MB of memory (so that their addresses
6474 can be loaded with the @code{ld24} instruction), and assume all subroutines
6475 are reachable with the @code{bl} instruction.
6476 This is the default.
6478 The addressability of a particular object can be set with the
6479 @code{model} attribute.
6481 @item -mcode-model=medium
6482 @opindex mcode-model=medium
6483 Assume objects may be anywhere in the 32-bit address space (the compiler
6484 will generate @code{seth/add3} instructions to load their addresses), and
6485 assume all subroutines are reachable with the @code{bl} instruction.
6487 @item -mcode-model=large
6488 @opindex mcode-model=large
6489 Assume objects may be anywhere in the 32-bit address space (the compiler
6490 will generate @code{seth/add3} instructions to load their addresses), and
6491 assume subroutines may not be reachable with the @code{bl} instruction
6492 (the compiler will generate the much slower @code{seth/add3/jl}
6493 instruction sequence).
6495 @item -msdata=none
6496 @opindex msdata=none
6497 Disable use of the small data area.  Variables will be put into
6498 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6499 @code{section} attribute has been specified).
6500 This is the default.
6502 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6503 Objects may be explicitly put in the small data area with the
6504 @code{section} attribute using one of these sections.
6506 @item -msdata=sdata
6507 @opindex msdata=sdata
6508 Put small global and static data in the small data area, but do not
6509 generate special code to reference them.
6511 @item -msdata=use
6512 @opindex msdata=use
6513 Put small global and static data in the small data area, and generate
6514 special instructions to reference them.
6516 @item -G @var{num}
6517 @opindex G
6518 @cindex smaller data references
6519 Put global and static objects less than or equal to @var{num} bytes
6520 into the small data or bss sections instead of the normal data or bss
6521 sections.  The default value of @var{num} is 8.
6522 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6523 for this option to have any effect.
6525 All modules should be compiled with the same @option{-G @var{num}} value.
6526 Compiling with different values of @var{num} may or may not work; if it
6527 doesn't the linker will give an error message---incorrect code will not be
6528 generated.
6530 @end table
6532 @node M88K Options
6533 @subsection M88K Options
6534 @cindex M88k options
6536 These @samp{-m} options are defined for Motorola 88k architectures:
6538 @table @gcctabopt
6539 @item -m88000
6540 @opindex m88000
6541 Generate code that works well on both the m88100 and the
6542 m88110.
6544 @item -m88100
6545 @opindex m88100
6546 Generate code that works best for the m88100, but that also
6547 runs on the m88110.
6549 @item -m88110
6550 @opindex m88110
6551 Generate code that works best for the m88110, and may not run
6552 on the m88100.
6554 @item -mbig-pic
6555 @opindex mbig-pic
6556 Obsolete option to be removed from the next revision.
6557 Use @option{-fPIC}.
6559 @item -midentify-revision
6560 @opindex midentify-revision
6561 @cindex identifying source, compiler (88k)
6562 Include an @code{ident} directive in the assembler output recording the
6563 source file name, compiler name and version, timestamp, and compilation
6564 flags used.
6566 @item -mno-underscores
6567 @opindex mno-underscores
6568 @cindex underscores, avoiding (88k)
6569 In assembler output, emit symbol names without adding an underscore
6570 character at the beginning of each name.  The default is to use an
6571 underscore as prefix on each name.
6573 @item -mocs-debug-info
6574 @itemx -mno-ocs-debug-info
6575 @opindex mocs-debug-info
6576 @opindex mno-ocs-debug-info
6577 @cindex OCS (88k)
6578 @cindex debugging, 88k OCS
6579 Include (or omit) additional debugging information (about registers used
6580 in each stack frame) as specified in the 88open Object Compatibility
6581 Standard, ``OCS''@.  This extra information allows debugging of code that
6582 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6583 SVr3.2 is to include this information; other 88k configurations omit this
6584 information by default.
6586 @item -mocs-frame-position
6587 @opindex mocs-frame-position
6588 @cindex register positions in frame (88k)
6589 When emitting COFF debugging information for automatic variables and
6590 parameters stored on the stack, use the offset from the canonical frame
6591 address, which is the stack pointer (register 31) on entry to the
6592 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6593 @option{-mocs-frame-position}; other 88k configurations have the default
6594 @option{-mno-ocs-frame-position}.
6596 @item -mno-ocs-frame-position
6597 @opindex mno-ocs-frame-position
6598 @cindex register positions in frame (88k)
6599 When emitting COFF debugging information for automatic variables and
6600 parameters stored on the stack, use the offset from the frame pointer
6601 register (register 30).  When this option is in effect, the frame
6602 pointer is not eliminated when debugging information is selected by the
6603 -g switch.
6605 @item -moptimize-arg-area
6606 @opindex moptimize-arg-area
6607 @cindex arguments in frame (88k)
6608 Save space by reorganizing the stack frame.  This option generates code
6609 that does not agree with the 88open specifications, but uses less
6610 memory.
6612 @itemx -mno-optimize-arg-area
6613 @opindex mno-optimize-arg-area
6614 Do not reorganize the stack frame to save space.  This is the default.
6615 The generated conforms to the specification, but uses more memory.
6617 @item -mshort-data-@var{num}
6618 @opindex mshort-data
6619 @cindex smaller data references (88k)
6620 @cindex r0-relative references (88k)
6621 Generate smaller data references by making them relative to @code{r0},
6622 which allows loading a value using a single instruction (rather than the
6623 usual two).  You control which data references are affected by
6624 specifying @var{num} with this option.  For example, if you specify
6625 @option{-mshort-data-512}, then the data references affected are those
6626 involving displacements of less than 512 bytes.
6627 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6628 than 64k.
6630 @item -mserialize-volatile
6631 @opindex mserialize-volatile
6632 @itemx -mno-serialize-volatile
6633 @opindex mno-serialize-volatile
6634 @cindex sequential consistency on 88k
6635 Do, or don't, generate code to guarantee sequential consistency
6636 of volatile memory references.  By default, consistency is
6637 guaranteed.
6639 The order of memory references made by the MC88110 processor does
6640 not always match the order of the instructions requesting those
6641 references.  In particular, a load instruction may execute before
6642 a preceding store instruction.  Such reordering violates
6643 sequential consistency of volatile memory references, when there
6644 are multiple processors.   When consistency must be guaranteed,
6645 GCC generates special instructions, as needed, to force
6646 execution in the proper order.
6648 The MC88100 processor does not reorder memory references and so
6649 always provides sequential consistency.  However, by default, GCC
6650 generates the special instructions to guarantee consistency
6651 even when you use @option{-m88100}, so that the code may be run on an
6652 MC88110 processor.  If you intend to run your code only on the
6653 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6655 The extra code generated to guarantee consistency may affect the
6656 performance of your application.  If you know that you can safely
6657 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6659 @item -msvr4
6660 @itemx -msvr3
6661 @opindex msvr4
6662 @opindex msvr3
6663 @cindex assembler syntax, 88k
6664 @cindex SVr4
6665 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6666 related to System V release 4 (SVr4).  This controls the following:
6668 @enumerate
6669 @item
6670 Which variant of the assembler syntax to emit.
6671 @item
6672 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6673 that is used on System V release 4.
6674 @item
6675 @option{-msvr4} makes GCC issue additional declaration directives used in
6676 SVr4.
6677 @end enumerate
6679 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6680 @option{-msvr3} is the default for all other m88k configurations.
6682 @item -mversion-03.00
6683 @opindex mversion-03.00
6684 This option is obsolete, and is ignored.
6685 @c ??? which asm syntax better for GAS?  option there too?
6687 @item -mno-check-zero-division
6688 @itemx -mcheck-zero-division
6689 @opindex mno-check-zero-division
6690 @opindex mcheck-zero-division
6691 @cindex zero division on 88k
6692 Do, or don't, generate code to guarantee that integer division by
6693 zero will be detected.  By default, detection is guaranteed.
6695 Some models of the MC88100 processor fail to trap upon integer
6696 division by zero under certain conditions.  By default, when
6697 compiling code that might be run on such a processor, GCC
6698 generates code that explicitly checks for zero-valued divisors
6699 and traps with exception number 503 when one is detected.  Use of
6700 @option{-mno-check-zero-division} suppresses such checking for code
6701 generated to run on an MC88100 processor.
6703 GCC assumes that the MC88110 processor correctly detects all instances
6704 of integer division by zero.  When @option{-m88110} is specified, no
6705 explicit checks for zero-valued divisors are generated, and both
6706 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6707 ignored.
6709 @item -muse-div-instruction
6710 @opindex muse-div-instruction
6711 @cindex divide instruction, 88k
6712 Use the div instruction for signed integer division on the
6713 MC88100 processor.  By default, the div instruction is not used.
6715 On the MC88100 processor the signed integer division instruction
6716 div) traps to the operating system on a negative operand.  The
6717 operating system transparently completes the operation, but at a
6718 large cost in execution time.  By default, when compiling code
6719 that might be run on an MC88100 processor, GCC emulates signed
6720 integer division using the unsigned integer division instruction
6721 divu), thereby avoiding the large penalty of a trap to the
6722 operating system.  Such emulation has its own, smaller, execution
6723 cost in both time and space.  To the extent that your code's
6724 important signed integer division operations are performed on two
6725 nonnegative operands, it may be desirable to use the div
6726 instruction directly.
6728 On the MC88110 processor the div instruction (also known as the
6729 divs instruction) processes negative operands without trapping to
6730 the operating system.  When @option{-m88110} is specified,
6731 @option{-muse-div-instruction} is ignored, and the div instruction is used
6732 for signed integer division.
6734 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6735 particular, the behavior of such a division with and without
6736 @option{-muse-div-instruction} may differ.
6738 @item -mtrap-large-shift
6739 @itemx -mhandle-large-shift
6740 @opindex mtrap-large-shift
6741 @opindex mhandle-large-shift
6742 @cindex bit shift overflow (88k)
6743 @cindex large bit shifts (88k)
6744 Include code to detect bit-shifts of more than 31 bits; respectively,
6745 trap such shifts or emit code to handle them properly.  By default GCC
6746 makes no special provision for large bit shifts.
6748 @item -mwarn-passed-structs
6749 @opindex mwarn-passed-structs
6750 @cindex structure passing (88k)
6751 Warn when a function passes a struct as an argument or result.
6752 Structure-passing conventions have changed during the evolution of the C
6753 language, and are often the source of portability problems.  By default,
6754 GCC issues no such warning.
6755 @end table
6757 @c break page here to avoid unsightly interparagraph stretch.
6758 @c -zw, 2001-8-17
6759 @page
6761 @node RS/6000 and PowerPC Options
6762 @subsection IBM RS/6000 and PowerPC Options
6763 @cindex RS/6000 and PowerPC Options
6764 @cindex IBM RS/6000 and PowerPC Options
6766 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6767 @table @gcctabopt
6768 @item -mpower
6769 @itemx -mno-power
6770 @itemx -mpower2
6771 @itemx -mno-power2
6772 @itemx -mpowerpc
6773 @itemx -mno-powerpc
6774 @itemx -mpowerpc-gpopt
6775 @itemx -mno-powerpc-gpopt
6776 @itemx -mpowerpc-gfxopt
6777 @itemx -mno-powerpc-gfxopt
6778 @itemx -mpowerpc64
6779 @itemx -mno-powerpc64
6780 @opindex mpower
6781 @opindex mno-power
6782 @opindex mpower2
6783 @opindex mno-power2
6784 @opindex mpowerpc
6785 @opindex mno-powerpc
6786 @opindex mpowerpc-gpopt
6787 @opindex mno-powerpc-gpopt
6788 @opindex mpowerpc-gfxopt
6789 @opindex mno-powerpc-gfxopt
6790 @opindex mpowerpc64
6791 @opindex mno-powerpc64
6792 GCC supports two related instruction set architectures for the
6793 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6794 instructions supported by the @samp{rios} chip set used in the original
6795 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6796 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6797 the IBM 4xx microprocessors.
6799 Neither architecture is a subset of the other.  However there is a
6800 large common subset of instructions supported by both.  An MQ
6801 register is included in processors supporting the POWER architecture.
6803 You use these options to specify which instructions are available on the
6804 processor you are using.  The default value of these options is
6805 determined when configuring GCC@.  Specifying the
6806 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6807 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6808 rather than the options listed above.
6810 The @option{-mpower} option allows GCC to generate instructions that
6811 are found only in the POWER architecture and to use the MQ register.
6812 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6813 to generate instructions that are present in the POWER2 architecture but
6814 not the original POWER architecture.
6816 The @option{-mpowerpc} option allows GCC to generate instructions that
6817 are found only in the 32-bit subset of the PowerPC architecture.
6818 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6819 GCC to use the optional PowerPC architecture instructions in the
6820 General Purpose group, including floating-point square root.  Specifying
6821 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6822 use the optional PowerPC architecture instructions in the Graphics
6823 group, including floating-point select.
6825 The @option{-mpowerpc64} option allows GCC to generate the additional
6826 64-bit instructions that are found in the full PowerPC64 architecture
6827 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6828 @option{-mno-powerpc64}.
6830 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6831 will use only the instructions in the common subset of both
6832 architectures plus some special AIX common-mode calls, and will not use
6833 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6834 permits GCC to use any instruction from either architecture and to
6835 allow use of the MQ register; specify this for the Motorola MPC601.
6837 @item -mnew-mnemonics
6838 @itemx -mold-mnemonics
6839 @opindex mnew-mnemonics
6840 @opindex mold-mnemonics
6841 Select which mnemonics to use in the generated assembler code.  With
6842 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6843 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6844 assembler mnemonics defined for the POWER architecture.  Instructions
6845 defined in only one architecture have only one mnemonic; GCC uses that
6846 mnemonic irrespective of which of these options is specified.
6848 GCC defaults to the mnemonics appropriate for the architecture in
6849 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6850 value of these option.  Unless you are building a cross-compiler, you
6851 should normally not specify either @option{-mnew-mnemonics} or
6852 @option{-mold-mnemonics}, but should instead accept the default.
6854 @item -mcpu=@var{cpu_type}
6855 @opindex mcpu
6856 Set architecture type, register usage, choice of mnemonics, and
6857 instruction scheduling parameters for machine type @var{cpu_type}.
6858 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6859 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6860 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6861 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6862 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6863 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6865 @option{-mcpu=common} selects a completely generic processor.  Code
6866 generated under this option will run on any POWER or PowerPC processor.
6867 GCC will use only the instructions in the common subset of both
6868 architectures, and will not use the MQ register.  GCC assumes a generic
6869 processor model for scheduling purposes.
6871 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6872 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6873 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6874 types, with an appropriate, generic processor model assumed for
6875 scheduling purposes.
6877 The other options specify a specific processor.  Code generated under
6878 those options will run best on that processor, and may not run at all on
6879 others.
6881 The @option{-mcpu} options automatically enable or disable other
6882 @option{-m} options as follows:
6884 @table @samp
6885 @item common
6886 @option{-mno-power}, @option{-mno-powerpc}
6888 @item power
6889 @itemx power2
6890 @itemx rios1
6891 @itemx rios2
6892 @itemx rsc
6893 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6895 @item powerpc
6896 @itemx rs64a
6897 @itemx 602
6898 @itemx 603
6899 @itemx 603e
6900 @itemx 604
6901 @itemx 620
6902 @itemx 630
6903 @itemx 740
6904 @itemx 7400
6905 @itemx 7450
6906 @itemx 750
6907 @itemx 505
6908 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6910 @item 601
6911 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6913 @item 403
6914 @itemx 821
6915 @itemx 860
6916 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6917 @end table
6919 @item -mtune=@var{cpu_type}
6920 @opindex mtune
6921 Set the instruction scheduling parameters for machine type
6922 @var{cpu_type}, but do not set the architecture type, register usage, or
6923 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6924 values for @var{cpu_type} are used for @option{-mtune} as for
6925 @option{-mcpu}.  If both are specified, the code generated will use the
6926 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6927 scheduling parameters set by @option{-mtune}.
6929 @item -maltivec
6930 @itemx -mno-altivec
6931 @opindex maltivec
6932 @opindex mno-altivec
6933 These switches enable or disable the use of built-in functions that
6934 allow access to the AltiVec instruction set.  You may also need to set
6935 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6936 enhancements.
6938 @item -mabi=spe
6939 @opindex mabi=spe
6940 Extend the current ABI with SPE ABI extensions.  This does not change
6941 the default ABI, instead it adds the SPE ABI extensions to the current
6942 ABI@.
6944 @item -mabi=no-spe
6945 @opindex mabi=no-spe
6946 Disable Booke SPE ABI extensions for the current ABI.
6948 @item -misel=@var{yes/no}
6949 @itemx -misel
6950 @opindex misel
6951 This switch enables or disables the generation of ISEL instructions.
6953 @item -mfull-toc
6954 @itemx -mno-fp-in-toc
6955 @itemx -mno-sum-in-toc
6956 @itemx -mminimal-toc
6957 @opindex mfull-toc
6958 @opindex mno-fp-in-toc
6959 @opindex mno-sum-in-toc
6960 @opindex mminimal-toc
6961 Modify generation of the TOC (Table Of Contents), which is created for
6962 every executable file.  The @option{-mfull-toc} option is selected by
6963 default.  In that case, GCC will allocate at least one TOC entry for
6964 each unique non-automatic variable reference in your program.  GCC
6965 will also place floating-point constants in the TOC@.  However, only
6966 16,384 entries are available in the TOC@.
6968 If you receive a linker error message that saying you have overflowed
6969 the available TOC space, you can reduce the amount of TOC space used
6970 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6971 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6972 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6973 generate code to calculate the sum of an address and a constant at
6974 run-time instead of putting that sum into the TOC@.  You may specify one
6975 or both of these options.  Each causes GCC to produce very slightly
6976 slower and larger code at the expense of conserving TOC space.
6978 If you still run out of space in the TOC even when you specify both of
6979 these options, specify @option{-mminimal-toc} instead.  This option causes
6980 GCC to make only one TOC entry for every file.  When you specify this
6981 option, GCC will produce code that is slower and larger but which
6982 uses extremely little TOC space.  You may wish to use this option
6983 only on files that contain less frequently executed code.
6985 @item -maix64
6986 @itemx -maix32
6987 @opindex maix64
6988 @opindex maix32
6989 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6990 @code{long} type, and the infrastructure needed to support them.
6991 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6992 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6993 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6995 @item -mxl-call
6996 @itemx -mno-xl-call
6997 @opindex mxl-call
6998 @opindex mno-xl-call
6999 On AIX, pass floating-point arguments to prototyped functions beyond the
7000 register save area (RSA) on the stack in addition to argument FPRs.  The
7001 AIX calling convention was extended but not initially documented to
7002 handle an obscure K&R C case of calling a function that takes the
7003 address of its arguments with fewer arguments than declared.  AIX XL
7004 compilers access floating point arguments which do not fit in the
7005 RSA from the stack when a subroutine is compiled without
7006 optimization.  Because always storing floating-point arguments on the
7007 stack is inefficient and rarely needed, this option is not enabled by
7008 default and only is necessary when calling subroutines compiled by AIX
7009 XL compilers without optimization.
7011 @item -mpe
7012 @opindex mpe
7013 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7014 application written to use message passing with special startup code to
7015 enable the application to run.  The system must have PE installed in the
7016 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7017 must be overridden with the @option{-specs=} option to specify the
7018 appropriate directory location.  The Parallel Environment does not
7019 support threads, so the @option{-mpe} option and the @option{-pthread}
7020 option are incompatible.
7022 @item -msoft-float
7023 @itemx -mhard-float
7024 @opindex msoft-float
7025 @opindex mhard-float
7026 Generate code that does not use (uses) the floating-point register set.
7027 Software floating point emulation is provided if you use the
7028 @option{-msoft-float} option, and pass the option to GCC when linking.
7030 @item -mmultiple
7031 @itemx -mno-multiple
7032 @opindex mmultiple
7033 @opindex mno-multiple
7034 Generate code that uses (does not use) the load multiple word
7035 instructions and the store multiple word instructions.  These
7036 instructions are generated by default on POWER systems, and not
7037 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7038 endian PowerPC systems, since those instructions do not work when the
7039 processor is in little endian mode.  The exceptions are PPC740 and
7040 PPC750 which permit the instructions usage in little endian mode.
7042 @item -mstring
7043 @itemx -mno-string
7044 @opindex mstring
7045 @opindex mno-string
7046 Generate code that uses (does not use) the load string instructions
7047 and the store string word instructions to save multiple registers and
7048 do small block moves.  These instructions are generated by default on
7049 POWER systems, and not generated on PowerPC systems.  Do not use
7050 @option{-mstring} on little endian PowerPC systems, since those
7051 instructions do not work when the processor is in little endian mode.
7052 The exceptions are PPC740 and PPC750 which permit the instructions
7053 usage in little endian mode.
7055 @item -mupdate
7056 @itemx -mno-update
7057 @opindex mupdate
7058 @opindex mno-update
7059 Generate code that uses (does not use) the load or store instructions
7060 that update the base register to the address of the calculated memory
7061 location.  These instructions are generated by default.  If you use
7062 @option{-mno-update}, there is a small window between the time that the
7063 stack pointer is updated and the address of the previous frame is
7064 stored, which means code that walks the stack frame across interrupts or
7065 signals may get corrupted data.
7067 @item -mfused-madd
7068 @itemx -mno-fused-madd
7069 @opindex mfused-madd
7070 @opindex mno-fused-madd
7071 Generate code that uses (does not use) the floating point multiply and
7072 accumulate instructions.  These instructions are generated by default if
7073 hardware floating is used.
7075 @item -mno-bit-align
7076 @itemx -mbit-align
7077 @opindex mno-bit-align
7078 @opindex mbit-align
7079 On System V.4 and embedded PowerPC systems do not (do) force structures
7080 and unions that contain bit-fields to be aligned to the base type of the
7081 bit-field.
7083 For example, by default a structure containing nothing but 8
7084 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7085 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7086 the structure would be aligned to a 1 byte boundary and be one byte in
7087 size.
7089 @item -mno-strict-align
7090 @itemx -mstrict-align
7091 @opindex mno-strict-align
7092 @opindex mstrict-align
7093 On System V.4 and embedded PowerPC systems do not (do) assume that
7094 unaligned memory references will be handled by the system.
7096 @item -mrelocatable
7097 @itemx -mno-relocatable
7098 @opindex mrelocatable
7099 @opindex mno-relocatable
7100 On embedded PowerPC systems generate code that allows (does not allow)
7101 the program to be relocated to a different address at runtime.  If you
7102 use @option{-mrelocatable} on any module, all objects linked together must
7103 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7105 @item -mrelocatable-lib
7106 @itemx -mno-relocatable-lib
7107 @opindex mrelocatable-lib
7108 @opindex mno-relocatable-lib
7109 On embedded PowerPC systems generate code that allows (does not allow)
7110 the program to be relocated to a different address at runtime.  Modules
7111 compiled with @option{-mrelocatable-lib} can be linked with either modules
7112 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7113 with modules compiled with the @option{-mrelocatable} options.
7115 @item -mno-toc
7116 @itemx -mtoc
7117 @opindex mno-toc
7118 @opindex mtoc
7119 On System V.4 and embedded PowerPC systems do not (do) assume that
7120 register 2 contains a pointer to a global area pointing to the addresses
7121 used in the program.
7123 @item -mlittle
7124 @itemx -mlittle-endian
7125 @opindex mlittle
7126 @opindex mlittle-endian
7127 On System V.4 and embedded PowerPC systems compile code for the
7128 processor in little endian mode.  The @option{-mlittle-endian} option is
7129 the same as @option{-mlittle}.
7131 @item -mbig
7132 @itemx -mbig-endian
7133 @opindex mbig
7134 @opindex mbig-endian
7135 On System V.4 and embedded PowerPC systems compile code for the
7136 processor in big endian mode.  The @option{-mbig-endian} option is
7137 the same as @option{-mbig}.
7139 @item -mcall-sysv
7140 @opindex mcall-sysv
7141 On System V.4 and embedded PowerPC systems compile code using calling
7142 conventions that adheres to the March 1995 draft of the System V
7143 Application Binary Interface, PowerPC processor supplement.  This is the
7144 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7146 @item -mcall-sysv-eabi
7147 @opindex mcall-sysv-eabi
7148 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7150 @item -mcall-sysv-noeabi
7151 @opindex mcall-sysv-noeabi
7152 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7154 @item -mcall-aix
7155 @opindex mcall-aix
7156 On System V.4 and embedded PowerPC systems compile code using calling
7157 conventions that are similar to those used on AIX@.  This is the
7158 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7160 @item -mcall-solaris
7161 @opindex mcall-solaris
7162 On System V.4 and embedded PowerPC systems compile code for the Solaris
7163 operating system.
7165 @item -mcall-linux
7166 @opindex mcall-linux
7167 On System V.4 and embedded PowerPC systems compile code for the
7168 Linux-based GNU system.
7170 @item -mcall-gnu
7171 @opindex mcall-gnu
7172 On System V.4 and embedded PowerPC systems compile code for the
7173 Hurd-based GNU system.
7175 @item -mcall-netbsd
7176 @opindex mcall-netbsd
7177 On System V.4 and embedded PowerPC systems compile code for the
7178 NetBSD operating system.
7180 @item -maix-struct-return
7181 @opindex maix-struct-return
7182 Return all structures in memory (as specified by the AIX ABI)@.
7184 @item -msvr4-struct-return
7185 @opindex msvr4-struct-return
7186 Return structures smaller than 8 bytes in registers (as specified by the
7187 SVR4 ABI)@.
7189 @item -mabi=altivec
7190 @opindex mabi=altivec
7191 Extend the current ABI with AltiVec ABI extensions.  This does not
7192 change the default ABI, instead it adds the AltiVec ABI extensions to
7193 the current ABI@.
7195 @item -mabi=no-altivec
7196 @opindex mabi=no-altivec
7197 Disable AltiVec ABI extensions for the current ABI.
7199 @item -mprototype
7200 @itemx -mno-prototype
7201 @opindex mprototype
7202 @opindex mno-prototype
7203 On System V.4 and embedded PowerPC systems assume that all calls to
7204 variable argument functions are properly prototyped.  Otherwise, the
7205 compiler must insert an instruction before every non prototyped call to
7206 set or clear bit 6 of the condition code register (@var{CR}) to
7207 indicate whether floating point values were passed in the floating point
7208 registers in case the function takes a variable arguments.  With
7209 @option{-mprototype}, only calls to prototyped variable argument functions
7210 will set or clear the bit.
7212 @item -msim
7213 @opindex msim
7214 On embedded PowerPC systems, assume that the startup module is called
7215 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7216 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7217 configurations.
7219 @item -mmvme
7220 @opindex mmvme
7221 On embedded PowerPC systems, assume that the startup module is called
7222 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7223 @file{libc.a}.
7225 @item -mads
7226 @opindex mads
7227 On embedded PowerPC systems, assume that the startup module is called
7228 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7229 @file{libc.a}.
7231 @item -myellowknife
7232 @opindex myellowknife
7233 On embedded PowerPC systems, assume that the startup module is called
7234 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7235 @file{libc.a}.
7237 @item -mvxworks
7238 @opindex mvxworks
7239 On System V.4 and embedded PowerPC systems, specify that you are
7240 compiling for a VxWorks system.
7242 @item -mwindiss
7243 @opindex mwindiss
7244 Specify that you are compiling for the WindISS simulation environment.
7246 @item -memb
7247 @opindex memb
7248 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7249 header to indicate that @samp{eabi} extended relocations are used.
7251 @item -meabi
7252 @itemx -mno-eabi
7253 @opindex meabi
7254 @opindex mno-eabi
7255 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7256 Embedded Applications Binary Interface (eabi) which is a set of
7257 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7258 means that the stack is aligned to an 8 byte boundary, a function
7259 @code{__eabi} is called to from @code{main} to set up the eabi
7260 environment, and the @option{-msdata} option can use both @code{r2} and
7261 @code{r13} to point to two separate small data areas.  Selecting
7262 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7263 do not call an initialization function from @code{main}, and the
7264 @option{-msdata} option will only use @code{r13} to point to a single
7265 small data area.  The @option{-meabi} option is on by default if you
7266 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7268 @item -msdata=eabi
7269 @opindex msdata=eabi
7270 On System V.4 and embedded PowerPC systems, put small initialized
7271 @code{const} global and static data in the @samp{.sdata2} section, which
7272 is pointed to by register @code{r2}.  Put small initialized
7273 non-@code{const} global and static data in the @samp{.sdata} section,
7274 which is pointed to by register @code{r13}.  Put small uninitialized
7275 global and static data in the @samp{.sbss} section, which is adjacent to
7276 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7277 incompatible with the @option{-mrelocatable} option.  The
7278 @option{-msdata=eabi} option also sets the @option{-memb} option.
7280 @item -msdata=sysv
7281 @opindex msdata=sysv
7282 On System V.4 and embedded PowerPC systems, put small global and static
7283 data in the @samp{.sdata} section, which is pointed to by register
7284 @code{r13}.  Put small uninitialized global and static data in the
7285 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7286 The @option{-msdata=sysv} option is incompatible with the
7287 @option{-mrelocatable} option.
7289 @item -msdata=default
7290 @itemx -msdata
7291 @opindex msdata=default
7292 @opindex msdata
7293 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7294 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7295 same as @option{-msdata=sysv}.
7297 @item -msdata-data
7298 @opindex msdata-data
7299 On System V.4 and embedded PowerPC systems, put small global and static
7300 data in the @samp{.sdata} section.  Put small uninitialized global and
7301 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7302 to address small data however.  This is the default behavior unless
7303 other @option{-msdata} options are used.
7305 @item -msdata=none
7306 @itemx -mno-sdata
7307 @opindex msdata=none
7308 @opindex mno-sdata
7309 On embedded PowerPC systems, put all initialized global and static data
7310 in the @samp{.data} section, and all uninitialized data in the
7311 @samp{.bss} section.
7313 @item -G @var{num}
7314 @opindex G
7315 @cindex smaller data references (PowerPC)
7316 @cindex .sdata/.sdata2 references (PowerPC)
7317 On embedded PowerPC systems, put global and static items less than or
7318 equal to @var{num} bytes into the small data or bss sections instead of
7319 the normal data or bss section.  By default, @var{num} is 8.  The
7320 @option{-G @var{num}} switch is also passed to the linker.
7321 All modules should be compiled with the same @option{-G @var{num}} value.
7323 @item -mregnames
7324 @itemx -mno-regnames
7325 @opindex mregnames
7326 @opindex mno-regnames
7327 On System V.4 and embedded PowerPC systems do (do not) emit register
7328 names in the assembly language output using symbolic forms.
7330 @item -mlongcall
7331 @itemx -mno-longcall
7332 @opindex mlongcall
7333 @opindex mno-longcall
7334 Default to making all function calls via pointers, so that functions
7335 which reside further than 64 megabytes (67,108,864 bytes) from the
7336 current location can be called.  This setting can be overridden by the
7337 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7339 Some linkers are capable of detecting out-of-range calls and generating
7340 glue code on the fly.  On these systems, long calls are unnecessary and
7341 generate slower code.  As of this writing, the AIX linker can do this,
7342 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7343 to the GNU linker for 32-bit PowerPC systems as well.
7345 In the future, we may cause GCC to ignore all longcall specifications
7346 when the linker is known to generate glue.
7348 @item -pthread
7349 @opindex pthread
7350 Adds support for multithreading with the @dfn{pthreads} library.
7351 This option sets flags for both the preprocessor and linker.
7353 @end table
7355 @node Darwin Options
7356 @subsection Darwin Options
7357 @cindex Darwin options
7358 @table @gcctabopt
7359 @item -all_load    
7360 @opindex all_load   
7361 Loads all members of static archive libraries.
7362 See man ld(1) for more information.
7364 @item -arch_errors_fatal
7365 @opindex arch_errors_fatal
7366 Cause the errors having to do with files that have the wrong architecture
7367 to be fatal.
7369 @item -bind_at_load
7370 @opindex bind_at_load
7371 Causes the output file to be marked such that the dynamic linker will
7372 bind all undefined references when the file is loaded or launched.
7374 @item -bundle     
7375 @opindex bundle
7376 Produce a Mach-o bundle format file.
7377 See man ld(1) for more information.
7379 @item -bundle_loader @var{executable}
7380 @opindex bundle_loader
7381 This specifies the @var{executable} that will be loading the build
7382 output file being linked. See man ld(1) for more information.
7384 @item -allowable_client  @var{client_name}
7385 @item -arch_only
7387 @item -client_name       
7388 @item -compatibility_version
7389 @item -current_version    
7390 @item -dependency-file
7391 @item -dylib_file    
7392 @item -dylinker_install_name
7393 @item -dynamic
7394 @item -dynamiclib   
7395 @item -exported_symbols_list  
7396 @item -filelist
7397 @item -flat_namespace   
7398 @item -force_cpusubtype_ALL
7399 @item -force_flat_namespace   
7400 @item -headerpad_max_install_names
7401 @item -image_base  
7402 @item -init
7403 @item -install_name
7404 @item -keep_private_externs
7405 @item -multi_module
7406 @item -multiply_defined      
7407 @item -multiply_defined_unused      
7408 @item -noall_load  
7409 @item -nomultidefs
7410 @item -noprebind     
7411 @item -noseglinkedit
7412 @item -pagezero_size    
7413 @item -prebind
7414 @item -prebind_all_twolevel_modules
7415 @item -private_bundle
7416 @item -read_only_relocs
7417 @item -sectalign  
7418 @item -sectobjectsymbols    
7419 @item -whyload
7420 @item -seg1addr 
7421 @item -sectcreate
7422 @item -sectobjectsymbols
7423 @item -sectorder
7424 @item -seg_addr_table
7425 @item -seg_addr_table_filename
7426 @item -seglinkedit
7427 @item -segprot   
7428 @item -segs_read_only_addr
7429 @item -segs_read_write_addr
7430 @item -single_module   
7431 @item -static
7432 @item -sub_library
7433 @item -sub_umbrella 
7434 @item -twolevel_namespace
7435 @item -umbrella
7436 @item -undefined
7437 @item -unexported_symbols_list
7438 @item -weak_reference_mismatches
7439 @item -whatsloaded  
7441 @opindex allowable_client
7442 @opindex arch_only    
7443 @opindex client_name
7444 @opindex compatibility_version
7445 @opindex current_version
7446 @opindex dependency-file
7447 @opindex dylib_file
7448 @opindex dylinker_install_name
7449 @opindex dynamic
7450 @opindex dynamiclib
7451 @opindex exported_symbols_list
7452 @opindex filelist  
7453 @opindex flat_namespace    
7454 @opindex force_cpusubtype_ALL
7455 @opindex force_flat_namespace
7456 @opindex headerpad_max_install_names
7457 @opindex image_base
7458 @opindex init     
7459 @opindex install_name
7460 @opindex keep_private_externs
7461 @opindex multi_module   
7462 @opindex multiply_defined
7463 @opindex multiply_defined_unused   
7464 @opindex noall_load  
7465 @opindex nomultidefs   
7466 @opindex noprebind
7467 @opindex noseglinkedit      
7468 @opindex pagezero_size
7469 @opindex prebind
7470 @opindex prebind_all_twolevel_modules
7471 @opindex private_bundle 
7472 @opindex read_only_relocs
7473 @opindex sectalign   
7474 @opindex sectobjectsymbols    
7475 @opindex whyload  
7476 @opindex seg1addr
7477 @opindex sectcreate       
7478 @opindex sectobjectsymbols 
7479 @opindex sectorder     
7480 @opindex seg_addr_table
7481 @opindex seg_addr_table_filename
7482 @opindex seglinkedit
7483 @opindex segprot
7484 @opindex segs_read_only_addr
7485 @opindex segs_read_write_addr
7486 @opindex single_module
7487 @opindex static
7488 @opindex sub_library
7489 @opindex sub_umbrella
7490 @opindex twolevel_namespace
7491 @opindex umbrella
7492 @opindex undefined
7493 @opindex unexported_symbols_list
7494 @opindex weak_reference_mismatches
7495 @opindex whatsloaded
7497 This options are available for Darwin linker. Darwin linker man page
7498 describes them in detail.
7499 @end table
7502 @node RT Options
7503 @subsection IBM RT Options
7504 @cindex RT options
7505 @cindex IBM RT options
7507 These @samp{-m} options are defined for the IBM RT PC:
7509 @table @gcctabopt
7510 @item -min-line-mul
7511 @opindex min-line-mul
7512 Use an in-line code sequence for integer multiplies.  This is the
7513 default.
7515 @item -mcall-lib-mul
7516 @opindex mcall-lib-mul
7517 Call @code{lmul$$} for integer multiples.
7519 @item -mfull-fp-blocks
7520 @opindex mfull-fp-blocks
7521 Generate full-size floating point data blocks, including the minimum
7522 amount of scratch space recommended by IBM@.  This is the default.
7524 @item -mminimum-fp-blocks
7525 @opindex mminimum-fp-blocks
7526 Do not include extra scratch space in floating point data blocks.  This
7527 results in smaller code, but slower execution, since scratch space must
7528 be allocated dynamically.
7530 @cindex @file{stdarg.h} and RT PC
7531 @item -mfp-arg-in-fpregs
7532 @opindex mfp-arg-in-fpregs
7533 Use a calling sequence incompatible with the IBM calling convention in
7534 which floating point arguments are passed in floating point registers.
7535 Note that @code{stdarg.h} will not work with floating point operands
7536 if this option is specified.
7538 @item -mfp-arg-in-gregs
7539 @opindex mfp-arg-in-gregs
7540 Use the normal calling convention for floating point arguments.  This is
7541 the default.
7543 @item -mhc-struct-return
7544 @opindex mhc-struct-return
7545 Return structures of more than one word in memory, rather than in a
7546 register.  This provides compatibility with the MetaWare HighC (hc)
7547 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7548 with the Portable C Compiler (pcc).
7550 @item -mnohc-struct-return
7551 @opindex mnohc-struct-return
7552 Return some structures of more than one word in registers, when
7553 convenient.  This is the default.  For compatibility with the
7554 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7555 option @option{-mhc-struct-return}.
7556 @end table
7558 @node MIPS Options
7559 @subsection MIPS Options
7560 @cindex MIPS options
7562 These @samp{-m} options are defined for the MIPS family of computers:
7564 @table @gcctabopt
7566 @item -march=@var{arch}
7567 @opindex march
7568 Generate code that will run on @var{arch}, which can be the name of a
7569 generic MIPS ISA, or the name of a particular processor.
7570 The ISA names are:
7571 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7572 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7573 The processor names are:
7574 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7575 @samp{m4k},
7576 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7577 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7578 @samp{orion},
7579 @samp{sb1},
7580 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7581 The special value @samp{from-abi} selects the
7582 most compatible architecture for the selected ABI (that is,
7583 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7585 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7586 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7587 @samp{vr} may be written @samp{r}.
7589 GCC defines two macros based on the value of this option.  The first
7590 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7591 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7592 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7593 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7594 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7596 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7597 above.  In other words, it will have the full prefix and will not
7598 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7599 the macro names the resolved architecture (either @samp{"mips1"} or
7600 @samp{"mips3"}).  It names the default architecture when no
7601 @option{-march} option is given.
7603 @item -mtune=@var{arch}
7604 @opindex mtune
7605 Optimize for @var{arch}.  Among other things, this option controls
7606 the way instructions are scheduled, and the perceived cost of arithmetic
7607 operations.  The list of @var{arch} values is the same as for
7608 @option{-march}.
7610 When this option is not used, GCC will optimize for the processor
7611 specified by @option{-march}.  By using @option{-march} and
7612 @option{-mtune} together, it is possible to generate code that will
7613 run on a family of processors, but optimize the code for one
7614 particular member of that family.
7616 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7617 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7618 @samp{-march} ones described above.
7620 @item -mips1
7621 @opindex mips1
7622 Equivalent to @samp{-march=mips1}.
7624 @item -mips2
7625 @opindex mips2
7626 Equivalent to @samp{-march=mips2}.
7628 @item -mips3
7629 @opindex mips3
7630 Equivalent to @samp{-march=mips3}.
7632 @item -mips4
7633 @opindex mips4
7634 Equivalent to @samp{-march=mips4}.
7636 @item -mips32
7637 @opindex mips32
7638 Equivalent to @samp{-march=mips32}.
7640 @item -mips32r2
7641 @opindex mips32r2
7642 Equivalent to @samp{-march=mips32r2}.
7644 @item -mips64
7645 @opindex mips64
7646 Equivalent to @samp{-march=mips64}.
7648 @item -mfused-madd
7649 @itemx -mno-fused-madd
7650 @opindex mfused-madd
7651 @opindex mno-fused-madd
7652 Generate code that uses (does not use) the floating point multiply and
7653 accumulate instructions, when they are available.  These instructions
7654 are generated by default if they are available, but this may be
7655 undesirable if the extra precision causes problems or on certain chips
7656 in the mode where denormals are rounded to zero where denormals
7657 generated by multiply and accumulate instructions cause exceptions
7658 anyway.
7660 @item -mfp32
7661 @opindex mfp32
7662 Assume that floating point registers are 32 bits wide.
7664 @item -mfp64
7665 @opindex mfp64
7666 Assume that floating point registers are 64 bits wide.
7668 @item -mgp32
7669 @opindex mgp32
7670 Assume that general purpose registers are 32 bits wide.
7672 @item -mgp64
7673 @opindex mgp64
7674 Assume that general purpose registers are 64 bits wide.
7676 @item -mint64
7677 @opindex mint64
7678 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7679 explanation of the default, and the width of pointers.
7681 @item -mlong64
7682 @opindex mlong64
7683 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7684 explanation of the default, and the width of pointers.
7686 @item -mlong32
7687 @opindex mlong32
7688 Force long, int, and pointer types to be 32 bits wide.
7690 The default size of ints, longs and pointers depends on the ABI@.  All
7691 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7692 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7693 are the same size as longs, or the same size as integer registers,
7694 whichever is smaller.
7696 @item -mabi=32
7697 @itemx -mabi=o64
7698 @itemx -mabi=n32
7699 @itemx -mabi=64
7700 @itemx -mabi=eabi
7701 @itemx -mabi=meabi
7702 @opindex mabi=32
7703 @opindex mabi=o64
7704 @opindex mabi=n32
7705 @opindex mabi=64
7706 @opindex mabi=eabi
7707 @opindex mabi=meabi
7708 Generate code for the given ABI@.
7710 Note that there are two embedded ABIs: @option{-mabi=eabi}
7711 selects the one defined by Cygnus while @option{-meabi=meabi}
7712 selects the one defined by MIPS@.  Both these ABIs have
7713 32-bit and 64-bit variants.  Normally, GCC will generate
7714 64-bit code when you select a 64-bit architecture, but you
7715 can use @option{-mgp32} to get 32-bit code instead.
7717 @item -mabi-fake-default
7718 @opindex mabi-fake-default
7719 You don't want to know what this option does.  No, really.  I mean
7720 it.  Move on to the next option.
7722 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7723 wants the default set of options to get the root of the multilib tree,
7724 and the shared library SONAMEs without any multilib-indicating
7725 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7726 we want to default to the N32 ABI, while still being binary-compatible
7727 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7728 binary-compatible means shared libraries should have the same SONAMEs,
7729 and libraries should live in the same location.  Having O32 libraries
7730 in a sub-directory named say @file{o32} is not acceptable.
7732 So we trick GCC into believing that O32 is the default ABI, except
7733 that we override the default with some internal command-line
7734 processing magic.  Problem is, if we stopped at that, and you then
7735 created a multilib-aware package that used the output of @command{gcc
7736 -print-multi-lib} to decide which multilibs to build, and how, and
7737 you'd find yourself in an awkward situation when you found out that
7738 some of the options listed ended up mapping to the same multilib, and
7739 none of your libraries was actually built for the multilib that
7740 @option{-print-multi-lib} claims to be the default.  So we added this
7741 option that disables the default switcher, falling back to GCC's
7742 original notion of the default library.  Confused yet?
7744 For short: don't ever use this option, unless you find it in the list
7745 of additional options to be used when building for multilibs, in the
7746 output of @option{gcc -print-multi-lib}.
7748 @item -mmips-as
7749 @opindex mmips-as
7750 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7751 add normal debug information.  This is the default for all
7752 platforms except for the OSF/1 reference platform, using the OSF/rose
7753 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7754 switches are used, the @file{mips-tfile} program will encapsulate the
7755 stabs within MIPS ECOFF@.
7757 @item -mgas
7758 @opindex mgas
7759 Generate code for the GNU assembler.  This is the default on the OSF/1
7760 reference platform, using the OSF/rose object format.  Also, this is
7761 the default if the configure option @option{--with-gnu-as} is used.
7763 @item -msplit-addresses
7764 @itemx -mno-split-addresses
7765 @opindex msplit-addresses
7766 @opindex mno-split-addresses
7767 Generate code to load the high and low parts of address constants separately.
7768 This allows GCC to optimize away redundant loads of the high order
7769 bits of addresses.  This optimization requires GNU as and GNU ld.
7770 This optimization is enabled by default for some embedded targets where
7771 GNU as and GNU ld are standard.
7773 @item -mrnames
7774 @itemx -mno-rnames
7775 @opindex mrnames
7776 @opindex mno-rnames
7777 The @option{-mrnames} switch says to output code using the MIPS software
7778 names for the registers, instead of the hardware names (ie, @var{a0}
7779 instead of @var{$4}).  The only known assembler that supports this option
7780 is the Algorithmics assembler.
7782 @item -mgpopt
7783 @itemx -mno-gpopt
7784 @opindex mgpopt
7785 @opindex mno-gpopt
7786 The @option{-mgpopt} switch says to write all of the data declarations
7787 before the instructions in the text section, this allows the MIPS
7788 assembler to generate one word memory references instead of using two
7789 words for short global or static data items.  This is on by default if
7790 optimization is selected.
7792 @item -mstats
7793 @itemx -mno-stats
7794 @opindex mstats
7795 @opindex mno-stats
7796 For each non-inline function processed, the @option{-mstats} switch
7797 causes the compiler to emit one line to the standard error file to
7798 print statistics about the program (number of registers saved, stack
7799 size, etc.).
7801 @item -mmemcpy
7802 @itemx -mno-memcpy
7803 @opindex mmemcpy
7804 @opindex mno-memcpy
7805 The @option{-mmemcpy} switch makes all block moves call the appropriate
7806 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7807 generating inline code.
7809 @item -mmips-tfile
7810 @itemx -mno-mips-tfile
7811 @opindex mmips-tfile
7812 @opindex mno-mips-tfile
7813 The @option{-mno-mips-tfile} switch causes the compiler not
7814 postprocess the object file with the @file{mips-tfile} program,
7815 after the MIPS assembler has generated it to add debug support.  If
7816 @file{mips-tfile} is not run, then no local variables will be
7817 available to the debugger.  In addition, @file{stage2} and
7818 @file{stage3} objects will have the temporary file names passed to the
7819 assembler embedded in the object file, which means the objects will
7820 not compare the same.  The @option{-mno-mips-tfile} switch should only
7821 be used when there are bugs in the @file{mips-tfile} program that
7822 prevents compilation.
7824 @item -msoft-float
7825 @opindex msoft-float
7826 Generate output containing library calls for floating point.
7827 @strong{Warning:} the requisite libraries are not part of GCC@.
7828 Normally the facilities of the machine's usual C compiler are used, but
7829 this can't be done directly in cross-compilation.  You must make your
7830 own arrangements to provide suitable library functions for
7831 cross-compilation.
7833 @item -mhard-float
7834 @opindex mhard-float
7835 Generate output containing floating point instructions.  This is the
7836 default if you use the unmodified sources.
7838 @item -mabicalls
7839 @itemx -mno-abicalls
7840 @opindex mabicalls
7841 @opindex mno-abicalls
7842 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7843 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7844 position independent code.
7846 @item -mlong-calls
7847 @itemx -mno-long-calls
7848 @opindex mlong-calls
7849 @opindex mno-long-calls
7850 Do all calls with the @samp{JALR} instruction, which requires
7851 loading up a function's address into a register before the call.
7852 You need to use this switch, if you call outside of the current
7853 512 megabyte segment to functions that are not through pointers.
7855 @item -mhalf-pic
7856 @itemx -mno-half-pic
7857 @opindex mhalf-pic
7858 @opindex mno-half-pic
7859 Put pointers to extern references into the data section and load them
7860 up, rather than put the references in the text section.
7862 @item -membedded-pic
7863 @itemx -mno-embedded-pic
7864 @opindex membedded-pic
7865 @opindex mno-embedded-pic
7866 Generate PIC code suitable for some embedded systems.  All calls are
7867 made using PC relative address, and all data is addressed using the $gp
7868 register.  No more than 65536 bytes of global data may be used.  This
7869 requires GNU as and GNU ld which do most of the work.  This currently
7870 only works on targets which use ECOFF; it does not work with ELF@.
7872 @item -membedded-data
7873 @itemx -mno-embedded-data
7874 @opindex membedded-data
7875 @opindex mno-embedded-data
7876 Allocate variables to the read-only data section first if possible, then
7877 next in the small data section if possible, otherwise in data.  This gives
7878 slightly slower code than the default, but reduces the amount of RAM required
7879 when executing, and thus may be preferred for some embedded systems.
7881 @item -muninit-const-in-rodata
7882 @itemx -mno-uninit-const-in-rodata
7883 @opindex muninit-const-in-rodata
7884 @opindex mno-uninit-const-in-rodata
7885 When used together with @option{-membedded-data}, it will always store uninitialized
7886 const variables in the read-only data section.
7888 @item -msingle-float
7889 @itemx -mdouble-float
7890 @opindex msingle-float
7891 @opindex mdouble-float
7892 The @option{-msingle-float} switch tells gcc to assume that the floating
7893 point coprocessor only supports single precision operations, as on the
7894 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7895 double precision operations.  This is the default.
7897 @item -mmad
7898 @itemx -mno-mad
7899 @opindex mmad
7900 @opindex mno-mad
7901 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7902 as on the @samp{r4650} chip.
7904 @item -m4650
7905 @opindex m4650
7906 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7907 @option{-mcpu=r4650}.
7909 @item -mips16
7910 @itemx -mno-mips16
7911 @opindex mips16
7912 @opindex mno-mips16
7913 Enable 16-bit instructions.
7915 @item -mentry
7916 @opindex mentry
7917 Use the entry and exit pseudo ops.  This option can only be used with
7918 @option{-mips16}.
7920 @item -EL
7921 @opindex EL
7922 Compile code for the processor in little endian mode.
7923 The requisite libraries are assumed to exist.
7925 @item -EB
7926 @opindex EB
7927 Compile code for the processor in big endian mode.
7928 The requisite libraries are assumed to exist.
7930 @item -G @var{num}
7931 @opindex G
7932 @cindex smaller data references (MIPS)
7933 @cindex gp-relative references (MIPS)
7934 Put global and static items less than or equal to @var{num} bytes into
7935 the small data or bss sections instead of the normal data or bss
7936 section.  This allows the assembler to emit one word memory reference
7937 instructions based on the global pointer (@var{gp} or @var{$28}),
7938 instead of the normal two words used.  By default, @var{num} is 8 when
7939 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7940 @option{-G @var{num}} switch is also passed to the assembler and linker.
7941 All modules should be compiled with the same @option{-G @var{num}}
7942 value.
7944 @item -nocpp
7945 @opindex nocpp
7946 Tell the MIPS assembler to not run its preprocessor over user
7947 assembler files (with a @samp{.s} suffix) when assembling them.
7949 @item -mfix7000
7950 @opindex mfix7000
7951 Pass an option to gas which will cause nops to be inserted if
7952 the read of the destination register of an mfhi or mflo instruction
7953 occurs in the following two instructions.
7955 @item -no-crt0
7956 @opindex no-crt0
7957 Do not include the default crt0.
7959 @item -mflush-func=@var{func}
7960 @itemx -mno-flush-func
7961 @opindex mflush-func
7962 Specifies the function to call to flush the I and D caches, or to not
7963 call any such function.  If called, the function must take the same
7964 arguments as the common @code{_flush_func()}, that is, the address of the
7965 memory range for which the cache is being flushed, the size of the
7966 memory range, and the number 3 (to flush both caches).  The default
7967 depends on the target gcc was configured for, but commonly is either
7968 @samp{_flush_func} or @samp{__cpu_flush}.
7970 @item -mbranch-likely
7971 @itemx -mno-branch-likely
7972 @opindex mbranch-likely
7973 @opindex mno-branch-likely
7974 Enable or disable use of Branch Likely instructions, regardless of the
7975 default for the selected architecture.  By default, Branch Likely
7976 instructions may be generated if they are supported by the selected
7977 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7978 and processors which implement those architectures; for those, Branch
7979 Likely instructions will not be generated by default because the MIPS32
7980 and MIPS64 architectures specifically deprecate their use.
7981 @end table
7983 @node i386 and x86-64 Options
7984 @subsection Intel 386 and AMD x86-64 Options
7985 @cindex i386 Options
7986 @cindex x86-64 Options
7987 @cindex Intel 386 Options
7988 @cindex AMD x86-64 Options
7990 These @samp{-m} options are defined for the i386 and x86-64 family of
7991 computers:
7993 @table @gcctabopt
7994 @item -mtune=@var{cpu-type}
7995 @opindex mtune
7996 Tune to @var{cpu-type} everything applicable about the generated code, except
7997 for the ABI and the set of available instructions.  The choices for
7998 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7999 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8000 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8001 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8002 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8003 and @samp{c3-2}.
8005 While picking a specific @var{cpu-type} will schedule things appropriately
8006 for that particular chip, the compiler will not generate any code that
8007 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8008 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8009 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8010 AMD chips as opposed to the Intel ones.
8012 @item -march=@var{cpu-type}
8013 @opindex march
8014 Generate instructions for the machine type @var{cpu-type}.  The choices
8015 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8016 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8018 @item -mcpu=@var{cpu-type}
8019 @opindex mcpu
8020 A deprecated synonym for @option{-mtune}.
8022 @item -m386
8023 @itemx -m486
8024 @itemx -mpentium
8025 @itemx -mpentiumpro
8026 @opindex m386
8027 @opindex m486
8028 @opindex mpentium
8029 @opindex mpentiumpro
8030 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8031 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8032 These synonyms are deprecated.
8034 @item -mfpmath=@var{unit}
8035 @opindex march
8036 generate floating point arithmetics for selected unit @var{unit}.  the choices
8037 for @var{unit} are:
8039 @table @samp
8040 @item 387
8041 Use the standard 387 floating point coprocessor present majority of chips and
8042 emulated otherwise.  Code compiled with this option will run almost everywhere.
8043 The temporary results are computed in 80bit precision instead of precision
8044 specified by the type resulting in slightly different results compared to most
8045 of other chips. See @option{-ffloat-store} for more detailed description.
8047 This is the default choice for i386 compiler.
8049 @item sse
8050 Use scalar floating point instructions present in the SSE instruction set.
8051 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8052 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8053 instruction set supports only single precision arithmetics, thus the double and
8054 extended precision arithmetics is still done using 387.  Later version, present
8055 only in Pentium4 and the future AMD x86-64 chips supports double precision
8056 arithmetics too.
8058 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8059 @option{-msse2} switches to enable SSE extensions and make this option
8060 effective.  For x86-64 compiler, these extensions are enabled by default.
8062 The resulting code should be considerably faster in majority of cases and avoid
8063 the numerical instability problems of 387 code, but may break some existing
8064 code that expects temporaries to be 80bit.
8066 This is the default choice for x86-64 compiler.
8068 @item sse,387
8069 Attempt to utilize both instruction sets at once.  This effectively double the
8070 amount of available registers and on chips with separate execution units for
8071 387 and SSE the execution resources too.  Use this option with care, as it is
8072 still experimental, because gcc register allocator does not model separate
8073 functional units well resulting in instable performance.
8074 @end table
8076 @item -masm=@var{dialect}
8077 @opindex masm=@var{dialect}
8078 Output asm instructions using selected @var{dialect}. Supported choices are
8079 @samp{intel} or @samp{att} (the default one).
8081 @item -mieee-fp
8082 @itemx -mno-ieee-fp
8083 @opindex mieee-fp
8084 @opindex mno-ieee-fp
8085 Control whether or not the compiler uses IEEE floating point
8086 comparisons.  These handle correctly the case where the result of a
8087 comparison is unordered.
8089 @item -msoft-float
8090 @opindex msoft-float
8091 Generate output containing library calls for floating point.
8092 @strong{Warning:} the requisite libraries are not part of GCC@.
8093 Normally the facilities of the machine's usual C compiler are used, but
8094 this can't be done directly in cross-compilation.  You must make your
8095 own arrangements to provide suitable library functions for
8096 cross-compilation.
8098 On machines where a function returns floating point results in the 80387
8099 register stack, some floating point opcodes may be emitted even if
8100 @option{-msoft-float} is used.
8102 @item -mno-fp-ret-in-387
8103 @opindex mno-fp-ret-in-387
8104 Do not use the FPU registers for return values of functions.
8106 The usual calling convention has functions return values of types
8107 @code{float} and @code{double} in an FPU register, even if there
8108 is no FPU@.  The idea is that the operating system should emulate
8109 an FPU@.
8111 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8112 in ordinary CPU registers instead.
8114 @item -mno-fancy-math-387
8115 @opindex mno-fancy-math-387
8116 Some 387 emulators do not support the @code{sin}, @code{cos} and
8117 @code{sqrt} instructions for the 387.  Specify this option to avoid
8118 generating those instructions.  This option is the default on FreeBSD,
8119 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8120 indicates that the target cpu will always have an FPU and so the
8121 instruction will not need emulation.  As of revision 2.6.1, these
8122 instructions are not generated unless you also use the
8123 @option{-funsafe-math-optimizations} switch.
8125 @item -malign-double
8126 @itemx -mno-align-double
8127 @opindex malign-double
8128 @opindex mno-align-double
8129 Control whether GCC aligns @code{double}, @code{long double}, and
8130 @code{long long} variables on a two word boundary or a one word
8131 boundary.  Aligning @code{double} variables on a two word boundary will
8132 produce code that runs somewhat faster on a @samp{Pentium} at the
8133 expense of more memory.
8135 @strong{Warning:} if you use the @option{-malign-double} switch,
8136 structures containing the above types will be aligned differently than
8137 the published application binary interface specifications for the 386
8138 and will not be binary compatible with structures in code compiled
8139 without that switch.
8141 @item -m128bit-long-double
8142 @opindex m128bit-long-double
8143 Control the size of @code{long double} type. i386 application binary interface
8144 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8145 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8146 impossible to reach with 12 byte long doubles in the array accesses.
8148 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8149 structures and arrays containing @code{long double} will change their size as
8150 well as function calling convention for function taking @code{long double}
8151 will be modified.
8153 @item -m96bit-long-double
8154 @opindex m96bit-long-double
8155 Set the size of @code{long double} to 96 bits as required by the i386
8156 application binary interface.  This is the default.
8158 @item -msvr3-shlib
8159 @itemx -mno-svr3-shlib
8160 @opindex msvr3-shlib
8161 @opindex mno-svr3-shlib
8162 Control whether GCC places uninitialized local variables into the
8163 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8164 into @code{bss}.  These options are meaningful only on System V Release 3.
8166 @item -mrtd
8167 @opindex mrtd
8168 Use a different function-calling convention, in which functions that
8169 take a fixed number of arguments return with the @code{ret} @var{num}
8170 instruction, which pops their arguments while returning.  This saves one
8171 instruction in the caller since there is no need to pop the arguments
8172 there.
8174 You can specify that an individual function is called with this calling
8175 sequence with the function attribute @samp{stdcall}.  You can also
8176 override the @option{-mrtd} option by using the function attribute
8177 @samp{cdecl}.  @xref{Function Attributes}.
8179 @strong{Warning:} this calling convention is incompatible with the one
8180 normally used on Unix, so you cannot use it if you need to call
8181 libraries compiled with the Unix compiler.
8183 Also, you must provide function prototypes for all functions that
8184 take variable numbers of arguments (including @code{printf});
8185 otherwise incorrect code will be generated for calls to those
8186 functions.
8188 In addition, seriously incorrect code will result if you call a
8189 function with too many arguments.  (Normally, extra arguments are
8190 harmlessly ignored.)
8192 @item -mregparm=@var{num}
8193 @opindex mregparm
8194 Control how many registers are used to pass integer arguments.  By
8195 default, no registers are used to pass arguments, and at most 3
8196 registers can be used.  You can control this behavior for a specific
8197 function by using the function attribute @samp{regparm}.
8198 @xref{Function Attributes}.
8200 @strong{Warning:} if you use this switch, and
8201 @var{num} is nonzero, then you must build all modules with the same
8202 value, including any libraries.  This includes the system libraries and
8203 startup modules.
8205 @item -mpreferred-stack-boundary=@var{num}
8206 @opindex mpreferred-stack-boundary
8207 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8208 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8209 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8210 size (@option{-Os}), in which case the default is the minimum correct
8211 alignment (4 bytes for x86, and 8 bytes for x86-64).
8213 On Pentium and PentiumPro, @code{double} and @code{long double} values
8214 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8215 suffer significant run time performance penalties.  On Pentium III, the
8216 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8217 penalties if it is not 16 byte aligned.
8219 To ensure proper alignment of this values on the stack, the stack boundary
8220 must be as aligned as that required by any value stored on the stack.
8221 Further, every function must be generated such that it keeps the stack
8222 aligned.  Thus calling a function compiled with a higher preferred
8223 stack boundary from a function compiled with a lower preferred stack
8224 boundary will most likely misalign the stack.  It is recommended that
8225 libraries that use callbacks always use the default setting.
8227 This extra alignment does consume extra stack space, and generally
8228 increases code size.  Code that is sensitive to stack space usage, such
8229 as embedded systems and operating system kernels, may want to reduce the
8230 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8232 @item -mmmx
8233 @itemx -mno-mmx
8234 @item -msse
8235 @itemx -mno-sse
8236 @item -msse2
8237 @itemx -mno-sse2
8238 @item -m3dnow
8239 @itemx -mno-3dnow
8240 @opindex mmmx
8241 @opindex mno-mmx
8242 @opindex msse
8243 @opindex mno-sse
8244 @opindex m3dnow
8245 @opindex mno-3dnow
8246 These switches enable or disable the use of built-in functions that allow
8247 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8249 @xref{X86 Built-in Functions}, for details of the functions enabled
8250 and disabled by these switches.
8252 To have SSE/SSE2 instructions generated automatically from floating-point
8253 code, see @option{-mfpmath=sse}.
8255 @item -mpush-args
8256 @itemx -mno-push-args
8257 @opindex mpush-args
8258 @opindex mno-push-args
8259 Use PUSH operations to store outgoing parameters.  This method is shorter
8260 and usually equally fast as method using SUB/MOV operations and is enabled
8261 by default.  In some cases disabling it may improve performance because of
8262 improved scheduling and reduced dependencies.
8264 @item -maccumulate-outgoing-args
8265 @opindex maccumulate-outgoing-args
8266 If enabled, the maximum amount of space required for outgoing arguments will be
8267 computed in the function prologue.  This is faster on most modern CPUs
8268 because of reduced dependencies, improved scheduling and reduced stack usage
8269 when preferred stack boundary is not equal to 2.  The drawback is a notable
8270 increase in code size.  This switch implies @option{-mno-push-args}.
8272 @item -mthreads
8273 @opindex mthreads
8274 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8275 on thread-safe exception handling must compile and link all code with the
8276 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8277 @option{-D_MT}; when linking, it links in a special thread helper library
8278 @option{-lmingwthrd} which cleans up per thread exception handling data.
8280 @item -mno-align-stringops
8281 @opindex mno-align-stringops
8282 Do not align destination of inlined string operations.  This switch reduces
8283 code size and improves performance in case the destination is already aligned,
8284 but gcc don't know about it.
8286 @item -minline-all-stringops
8287 @opindex minline-all-stringops
8288 By default GCC inlines string operations only when destination is known to be
8289 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8290 size, but may improve performance of code that depends on fast memcpy, strlen
8291 and memset for short lengths.
8293 @item -momit-leaf-frame-pointer
8294 @opindex momit-leaf-frame-pointer
8295 Don't keep the frame pointer in a register for leaf functions.  This
8296 avoids the instructions to save, set up and restore frame pointers and
8297 makes an extra register available in leaf functions.  The option
8298 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8299 which might make debugging harder.
8300 @end table
8302 These @samp{-m} switches are supported in addition to the above
8303 on AMD x86-64 processors in 64-bit environments.
8305 @table @gcctabopt
8306 @item -m32
8307 @itemx -m64
8308 @opindex m32
8309 @opindex m64
8310 Generate code for a 32-bit or 64-bit environment.
8311 The 32-bit environment sets int, long and pointer to 32 bits and
8312 generates code that runs on any i386 system.
8313 The 64-bit environment sets int to 32 bits and long and pointer
8314 to 64 bits and generates code for AMD's x86-64 architecture.
8316 @item -mno-red-zone
8317 @opindex no-red-zone
8318 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8319 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8320 stack pointer that will not be modified by signal or interrupt handlers
8321 and therefore can be used for temporary data without adjusting the stack
8322 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8324 @item -mcmodel=small
8325 @opindex mcmodel=small
8326 Generate code for the small code model: the program and its symbols must
8327 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8328 Programs can be statically or dynamically linked.  This is the default
8329 code model.
8331 @item -mcmodel=kernel
8332 @opindex mcmodel=kernel
8333 Generate code for the kernel code model.  The kernel runs in the
8334 negative 2 GB of the address space.
8335 This model has to be used for Linux kernel code.
8337 @item -mcmodel=medium
8338 @opindex mcmodel=medium
8339 Generate code for the medium model: The program is linked in the lower 2
8340 GB of the address space but symbols can be located anywhere in the
8341 address space.  Programs can be statically or dynamically linked, but
8342 building of shared libraries are not supported with the medium model.
8344 @item -mcmodel=large
8345 @opindex mcmodel=large
8346 Generate code for the large model: This model makes no assumptions
8347 about addresses and sizes of sections.  Currently GCC does not implement
8348 this model.
8349 @end table
8351 @node HPPA Options
8352 @subsection HPPA Options
8353 @cindex HPPA Options
8355 These @samp{-m} options are defined for the HPPA family of computers:
8357 @table @gcctabopt
8358 @item -march=@var{architecture-type}
8359 @opindex march
8360 Generate code for the specified architecture.  The choices for
8361 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8362 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8363 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8364 architecture option for your machine.  Code compiled for lower numbered
8365 architectures will run on higher numbered architectures, but not the
8366 other way around.
8368 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8369 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8370 support.
8372 @item -mpa-risc-1-0
8373 @itemx -mpa-risc-1-1
8374 @itemx -mpa-risc-2-0
8375 @opindex mpa-risc-1-0
8376 @opindex mpa-risc-1-1
8377 @opindex mpa-risc-2-0
8378 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8380 @item -mbig-switch
8381 @opindex mbig-switch
8382 Generate code suitable for big switch tables.  Use this option only if
8383 the assembler/linker complain about out of range branches within a switch
8384 table.
8386 @item -mjump-in-delay
8387 @opindex mjump-in-delay
8388 Fill delay slots of function calls with unconditional jump instructions
8389 by modifying the return pointer for the function call to be the target
8390 of the conditional jump.
8392 @item -mdisable-fpregs
8393 @opindex mdisable-fpregs
8394 Prevent floating point registers from being used in any manner.  This is
8395 necessary for compiling kernels which perform lazy context switching of
8396 floating point registers.  If you use this option and attempt to perform
8397 floating point operations, the compiler will abort.
8399 @item -mdisable-indexing
8400 @opindex mdisable-indexing
8401 Prevent the compiler from using indexing address modes.  This avoids some
8402 rather obscure problems when compiling MIG generated code under MACH@.
8404 @item -mno-space-regs
8405 @opindex mno-space-regs
8406 Generate code that assumes the target has no space registers.  This allows
8407 GCC to generate faster indirect calls and use unscaled index address modes.
8409 Such code is suitable for level 0 PA systems and kernels.
8411 @item -mfast-indirect-calls
8412 @opindex mfast-indirect-calls
8413 Generate code that assumes calls never cross space boundaries.  This
8414 allows GCC to emit code which performs faster indirect calls.
8416 This option will not work in the presence of shared libraries or nested
8417 functions.
8419 @item -mlong-load-store
8420 @opindex mlong-load-store
8421 Generate 3-instruction load and store sequences as sometimes required by
8422 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8423 the HP compilers.
8425 @item -mportable-runtime
8426 @opindex mportable-runtime
8427 Use the portable calling conventions proposed by HP for ELF systems.
8429 @item -mgas
8430 @opindex mgas
8431 Enable the use of assembler directives only GAS understands.
8433 @item -mschedule=@var{cpu-type}
8434 @opindex mschedule
8435 Schedule code according to the constraints for the machine type
8436 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8437 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8438 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8439 proper scheduling option for your machine.  The default scheduling is
8440 @samp{8000}.
8442 @item -mlinker-opt
8443 @opindex mlinker-opt
8444 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8445 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8446 linkers in which they give bogus error messages when linking some programs.
8448 @item -msoft-float
8449 @opindex msoft-float
8450 Generate output containing library calls for floating point.
8451 @strong{Warning:} the requisite libraries are not available for all HPPA
8452 targets.  Normally the facilities of the machine's usual C compiler are
8453 used, but this cannot be done directly in cross-compilation.  You must make
8454 your own arrangements to provide suitable library functions for
8455 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8456 does provide software floating point support.
8458 @option{-msoft-float} changes the calling convention in the output file;
8459 therefore, it is only useful if you compile @emph{all} of a program with
8460 this option.  In particular, you need to compile @file{libgcc.a}, the
8461 library that comes with GCC, with @option{-msoft-float} in order for
8462 this to work.
8464 @item -msio
8465 @opindex msio
8466 Generate the predefine, @code{_SIO}, for server IO.  The default is
8467 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8468 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8469 options are available under HP-UX and HI-UX.
8471 @item -mgnu-ld
8472 @opindex gnu-ld
8473 Use GNU ld specific options.  This passes @option{-shared} to ld when
8474 building a shared library.  It is the default when GCC is configured,
8475 explicitly or implicitly, with the GNU linker.  This option does not
8476 have any affect on which ld is called, it only changes what parameters
8477 are passed to that ld.  The ld that is called is determined by the
8478 @option{--with-ld} configure option, gcc's program search path, and
8479 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8480 using @samp{which `gcc -print-prog-name=ld`}.
8482 @item -mhp-ld
8483 @opindex hp-ld
8484 Use HP ld specific options.  This passes @option{-b} to ld when building
8485 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8486 links.  It is the default when GCC is configured, explicitly or
8487 implicitly, with the HP linker.  This option does not have any affect on
8488 which ld is called, it only changes what parameters are passed to that
8489 ld.  The ld that is called is determined by the @option{--with-ld}
8490 configure option, gcc's program search path, and finally by the user's
8491 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8492 `gcc -print-prog-name=ld`}.
8494 @item -mlong-calls
8495 @opindex mno-long-calls
8496 Generate code that uses long call sequences.  This ensures that a call
8497 is always able to reach linker generated stubs.  The default is to generate
8498 long calls only when the distance from the call site to the beginning
8499 of the function or translation unit, as the case may be, exceeds a
8500 predefined limit set by the branch type being used.  The limits for
8501 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8502 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8503 240,000 bytes.
8505 Distances are measured from the beginning of functions when using the
8506 @option{-ffunction-sections} option, or when using the @option{-mgas}
8507 and @option{-mno-portable-runtime} options together under HP-UX with
8508 the SOM linker.
8510 It is normally not desirable to use this option as it will degrade
8511 performance.  However, it may be useful in large applications,
8512 particularly when partial linking is used to build the application.
8514 The types of long calls used depends on the capabilities of the
8515 assembler and linker, and the type of code being generated.  The
8516 impact on systems that support long absolute calls, and long pic
8517 symbol-difference or pc-relative calls should be relatively small.
8518 However, an indirect call is used on 32-bit ELF systems in pic code
8519 and it is quite long.
8521 @end table
8523 @node Intel 960 Options
8524 @subsection Intel 960 Options
8526 These @samp{-m} options are defined for the Intel 960 implementations:
8528 @table @gcctabopt
8529 @item -m@var{cpu-type}
8530 @opindex mka
8531 @opindex mkb
8532 @opindex mmc
8533 @opindex mca
8534 @opindex mcf
8535 @opindex msa
8536 @opindex msb
8537 Assume the defaults for the machine type @var{cpu-type} for some of
8538 the other options, including instruction scheduling, floating point
8539 support, and addressing modes.  The choices for @var{cpu-type} are
8540 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8541 @samp{sa}, and @samp{sb}.
8542 The default is
8543 @samp{kb}.
8545 @item -mnumerics
8546 @itemx -msoft-float
8547 @opindex mnumerics
8548 @opindex msoft-float
8549 The @option{-mnumerics} option indicates that the processor does support
8550 floating-point instructions.  The @option{-msoft-float} option indicates
8551 that floating-point support should not be assumed.
8553 @item -mleaf-procedures
8554 @itemx -mno-leaf-procedures
8555 @opindex mleaf-procedures
8556 @opindex mno-leaf-procedures
8557 Do (or do not) attempt to alter leaf procedures to be callable with the
8558 @code{bal} instruction as well as @code{call}.  This will result in more
8559 efficient code for explicit calls when the @code{bal} instruction can be
8560 substituted by the assembler or linker, but less efficient code in other
8561 cases, such as calls via function pointers, or using a linker that doesn't
8562 support this optimization.
8564 @item -mtail-call
8565 @itemx -mno-tail-call
8566 @opindex mtail-call
8567 @opindex mno-tail-call
8568 Do (or do not) make additional attempts (beyond those of the
8569 machine-independent portions of the compiler) to optimize tail-recursive
8570 calls into branches.  You may not want to do this because the detection of
8571 cases where this is not valid is not totally complete.  The default is
8572 @option{-mno-tail-call}.
8574 @item -mcomplex-addr
8575 @itemx -mno-complex-addr
8576 @opindex mcomplex-addr
8577 @opindex mno-complex-addr
8578 Assume (or do not assume) that the use of a complex addressing mode is a
8579 win on this implementation of the i960.  Complex addressing modes may not
8580 be worthwhile on the K-series, but they definitely are on the C-series.
8581 The default is currently @option{-mcomplex-addr} for all processors except
8582 the CB and CC@.
8584 @item -mcode-align
8585 @itemx -mno-code-align
8586 @opindex mcode-align
8587 @opindex mno-code-align
8588 Align code to 8-byte boundaries for faster fetching (or don't bother).
8589 Currently turned on by default for C-series implementations only.
8591 @ignore
8592 @item -mclean-linkage
8593 @itemx -mno-clean-linkage
8594 @opindex mclean-linkage
8595 @opindex mno-clean-linkage
8596 These options are not fully implemented.
8597 @end ignore
8599 @item -mic-compat
8600 @itemx -mic2.0-compat
8601 @itemx -mic3.0-compat
8602 @opindex mic-compat
8603 @opindex mic2.0-compat
8604 @opindex mic3.0-compat
8605 Enable compatibility with iC960 v2.0 or v3.0.
8607 @item -masm-compat
8608 @itemx -mintel-asm
8609 @opindex masm-compat
8610 @opindex mintel-asm
8611 Enable compatibility with the iC960 assembler.
8613 @item -mstrict-align
8614 @itemx -mno-strict-align
8615 @opindex mstrict-align
8616 @opindex mno-strict-align
8617 Do not permit (do permit) unaligned accesses.
8619 @item -mold-align
8620 @opindex mold-align
8621 Enable structure-alignment compatibility with Intel's gcc release version
8622 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8624 @item -mlong-double-64
8625 @opindex mlong-double-64
8626 Implement type @samp{long double} as 64-bit floating point numbers.
8627 Without the option @samp{long double} is implemented by 80-bit
8628 floating point numbers.  The only reason we have it because there is
8629 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8630 is only useful for people using soft-float targets.  Otherwise, we
8631 should recommend against use of it.
8633 @end table
8635 @node DEC Alpha Options
8636 @subsection DEC Alpha Options
8638 These @samp{-m} options are defined for the DEC Alpha implementations:
8640 @table @gcctabopt
8641 @item -mno-soft-float
8642 @itemx -msoft-float
8643 @opindex mno-soft-float
8644 @opindex msoft-float
8645 Use (do not use) the hardware floating-point instructions for
8646 floating-point operations.  When @option{-msoft-float} is specified,
8647 functions in @file{libgcc.a} will be used to perform floating-point
8648 operations.  Unless they are replaced by routines that emulate the
8649 floating-point operations, or compiled in such a way as to call such
8650 emulations routines, these routines will issue floating-point
8651 operations.   If you are compiling for an Alpha without floating-point
8652 operations, you must ensure that the library is built so as not to call
8653 them.
8655 Note that Alpha implementations without floating-point operations are
8656 required to have floating-point registers.
8658 @item -mfp-reg
8659 @itemx -mno-fp-regs
8660 @opindex mfp-reg
8661 @opindex mno-fp-regs
8662 Generate code that uses (does not use) the floating-point register set.
8663 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8664 register set is not used, floating point operands are passed in integer
8665 registers as if they were integers and floating-point results are passed
8666 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8667 so any function with a floating-point argument or return value called by code
8668 compiled with @option{-mno-fp-regs} must also be compiled with that
8669 option.
8671 A typical use of this option is building a kernel that does not use,
8672 and hence need not save and restore, any floating-point registers.
8674 @item -mieee
8675 @opindex mieee
8676 The Alpha architecture implements floating-point hardware optimized for
8677 maximum performance.  It is mostly compliant with the IEEE floating
8678 point standard.  However, for full compliance, software assistance is
8679 required.  This option generates code fully IEEE compliant code
8680 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8681 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8682 defined during compilation.  The resulting code is less efficient but is
8683 able to correctly support denormalized numbers and exceptional IEEE
8684 values such as not-a-number and plus/minus infinity.  Other Alpha
8685 compilers call this option @option{-ieee_with_no_inexact}.
8687 @item -mieee-with-inexact
8688 @opindex mieee-with-inexact
8689 This is like @option{-mieee} except the generated code also maintains
8690 the IEEE @var{inexact-flag}.  Turning on this option causes the
8691 generated code to implement fully-compliant IEEE math.  In addition to
8692 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8693 macro.  On some Alpha implementations the resulting code may execute
8694 significantly slower than the code generated by default.  Since there is
8695 very little code that depends on the @var{inexact-flag}, you should
8696 normally not specify this option.  Other Alpha compilers call this
8697 option @option{-ieee_with_inexact}.
8699 @item -mfp-trap-mode=@var{trap-mode}
8700 @opindex mfp-trap-mode
8701 This option controls what floating-point related traps are enabled.
8702 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8703 The trap mode can be set to one of four values:
8705 @table @samp
8706 @item n
8707 This is the default (normal) setting.  The only traps that are enabled
8708 are the ones that cannot be disabled in software (e.g., division by zero
8709 trap).
8711 @item u
8712 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8713 as well.
8715 @item su
8716 Like @samp{su}, but the instructions are marked to be safe for software
8717 completion (see Alpha architecture manual for details).
8719 @item sui
8720 Like @samp{su}, but inexact traps are enabled as well.
8721 @end table
8723 @item -mfp-rounding-mode=@var{rounding-mode}
8724 @opindex mfp-rounding-mode
8725 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8726 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8729 @table @samp
8730 @item n
8731 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8732 the nearest machine number or towards the even machine number in case
8733 of a tie.
8735 @item m
8736 Round towards minus infinity.
8738 @item c
8739 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8741 @item d
8742 Dynamic rounding mode.  A field in the floating point control register
8743 (@var{fpcr}, see Alpha architecture reference manual) controls the
8744 rounding mode in effect.  The C library initializes this register for
8745 rounding towards plus infinity.  Thus, unless your program modifies the
8746 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8747 @end table
8749 @item -mtrap-precision=@var{trap-precision}
8750 @opindex mtrap-precision
8751 In the Alpha architecture, floating point traps are imprecise.  This
8752 means without software assistance it is impossible to recover from a
8753 floating trap and program execution normally needs to be terminated.
8754 GCC can generate code that can assist operating system trap handlers
8755 in determining the exact location that caused a floating point trap.
8756 Depending on the requirements of an application, different levels of
8757 precisions can be selected:
8759 @table @samp
8760 @item p
8761 Program precision.  This option is the default and means a trap handler
8762 can only identify which program caused a floating point exception.
8764 @item f
8765 Function precision.  The trap handler can determine the function that
8766 caused a floating point exception.
8768 @item i
8769 Instruction precision.  The trap handler can determine the exact
8770 instruction that caused a floating point exception.
8771 @end table
8773 Other Alpha compilers provide the equivalent options called
8774 @option{-scope_safe} and @option{-resumption_safe}.
8776 @item -mieee-conformant
8777 @opindex mieee-conformant
8778 This option marks the generated code as IEEE conformant.  You must not
8779 use this option unless you also specify @option{-mtrap-precision=i} and either
8780 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8781 is to emit the line @samp{.eflag 48} in the function prologue of the
8782 generated assembly file.  Under DEC Unix, this has the effect that
8783 IEEE-conformant math library routines will be linked in.
8785 @item -mbuild-constants
8786 @opindex mbuild-constants
8787 Normally GCC examines a 32- or 64-bit integer constant to
8788 see if it can construct it from smaller constants in two or three
8789 instructions.  If it cannot, it will output the constant as a literal and
8790 generate code to load it from the data segment at runtime.
8792 Use this option to require GCC to construct @emph{all} integer constants
8793 using code, even if it takes more instructions (the maximum is six).
8795 You would typically use this option to build a shared library dynamic
8796 loader.  Itself a shared library, it must relocate itself in memory
8797 before it can find the variables and constants in its own data segment.
8799 @item -malpha-as
8800 @itemx -mgas
8801 @opindex malpha-as
8802 @opindex mgas
8803 Select whether to generate code to be assembled by the vendor-supplied
8804 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8806 @item -mbwx
8807 @itemx -mno-bwx
8808 @itemx -mcix
8809 @itemx -mno-cix
8810 @itemx -mfix
8811 @itemx -mno-fix
8812 @itemx -mmax
8813 @itemx -mno-max
8814 @opindex mbwx
8815 @opindex mno-bwx
8816 @opindex mcix
8817 @opindex mno-cix
8818 @opindex mfix
8819 @opindex mno-fix
8820 @opindex mmax
8821 @opindex mno-max
8822 Indicate whether GCC should generate code to use the optional BWX,
8823 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8824 sets supported by the CPU type specified via @option{-mcpu=} option or that
8825 of the CPU on which GCC was built if none was specified.
8827 @item -mfloat-vax
8828 @itemx -mfloat-ieee
8829 @opindex mfloat-vax
8830 @opindex mfloat-ieee
8831 Generate code that uses (does not use) VAX F and G floating point
8832 arithmetic instead of IEEE single and double precision.
8834 @item -mexplicit-relocs
8835 @itemx -mno-explicit-relocs
8836 @opindex mexplicit-relocs
8837 @opindex mno-explicit-relocs
8838 Older Alpha assemblers provided no way to generate symbol relocations
8839 except via assembler macros.  Use of these macros does not allow
8840 optimal instruction scheduling.  GNU binutils as of version 2.12
8841 supports a new syntax that allows the compiler to explicitly mark
8842 which relocations should apply to which instructions.  This option
8843 is mostly useful for debugging, as GCC detects the capabilities of
8844 the assembler when it is built and sets the default accordingly.
8846 @item -msmall-data
8847 @itemx -mlarge-data
8848 @opindex msmall-data
8849 @opindex mlarge-data
8850 When @option{-mexplicit-relocs} is in effect, static data is
8851 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8852 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8853 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8854 16-bit relocations off of the @code{$gp} register.  This limits the
8855 size of the small data area to 64KB, but allows the variables to be
8856 directly accessed via a single instruction.
8858 The default is @option{-mlarge-data}.  With this option the data area
8859 is limited to just below 2GB.  Programs that require more than 2GB of
8860 data must use @code{malloc} or @code{mmap} to allocate the data in the
8861 heap instead of in the program's data segment.
8863 When generating code for shared libraries, @option{-fpic} implies
8864 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8866 @item -msmall-text
8867 @itemx -mlarge-text
8868 @opindex msmall-text
8869 @opindex mlarge-text
8870 When @option{-msmall-text} is used, the compiler assumes that the
8871 code of the entire program (or shared library) fits in 4MB, and is
8872 thus reachable with a branch instruction.  When @option{-msmall-data}
8873 is used, the compiler can assume that all local symbols share the
8874 same @code{$gp} value, and thus reduce the number of instructions
8875 required for a function call from 4 to 1.
8877 The default is @option{-mlarge-text}.
8879 @item -mcpu=@var{cpu_type}
8880 @opindex mcpu
8881 Set the instruction set and instruction scheduling parameters for
8882 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8883 style name or the corresponding chip number.  GCC supports scheduling
8884 parameters for the EV4, EV5 and EV6 family of processors and will
8885 choose the default values for the instruction set from the processor
8886 you specify.  If you do not specify a processor type, GCC will default
8887 to the processor on which the compiler was built.
8889 Supported values for @var{cpu_type} are
8891 @table @samp
8892 @item ev4
8893 @item ev45
8894 @itemx 21064
8895 Schedules as an EV4 and has no instruction set extensions.
8897 @item ev5
8898 @itemx 21164
8899 Schedules as an EV5 and has no instruction set extensions.
8901 @item ev56
8902 @itemx 21164a
8903 Schedules as an EV5 and supports the BWX extension.
8905 @item pca56
8906 @itemx 21164pc
8907 @itemx 21164PC
8908 Schedules as an EV5 and supports the BWX and MAX extensions.
8910 @item ev6
8911 @itemx 21264
8912 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8914 @item ev67
8915 @item 21264a
8916 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8917 @end table
8919 @item -mtune=@var{cpu_type}
8920 @opindex mtune
8921 Set only the instruction scheduling parameters for machine type
8922 @var{cpu_type}.  The instruction set is not changed.
8924 @item -mmemory-latency=@var{time}
8925 @opindex mmemory-latency
8926 Sets the latency the scheduler should assume for typical memory
8927 references as seen by the application.  This number is highly
8928 dependent on the memory access patterns used by the application
8929 and the size of the external cache on the machine.
8931 Valid options for @var{time} are
8933 @table @samp
8934 @item @var{number}
8935 A decimal number representing clock cycles.
8937 @item L1
8938 @itemx L2
8939 @itemx L3
8940 @itemx main
8941 The compiler contains estimates of the number of clock cycles for
8942 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8943 (also called Dcache, Scache, and Bcache), as well as to main memory.
8944 Note that L3 is only valid for EV5.
8946 @end table
8947 @end table
8949 @node DEC Alpha/VMS Options
8950 @subsection DEC Alpha/VMS Options
8952 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8954 @table @gcctabopt
8955 @item -mvms-return-codes
8956 @opindex mvms-return-codes
8957 Return VMS condition codes from main.  The default is to return POSIX
8958 style condition (e.g.@ error) codes.
8959 @end table
8961 @node H8/300 Options
8962 @subsection H8/300 Options
8964 These @samp{-m} options are defined for the H8/300 implementations:
8966 @table @gcctabopt
8967 @item -mrelax
8968 @opindex mrelax
8969 Shorten some address references at link time, when possible; uses the
8970 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8971 ld.info, Using ld}, for a fuller description.
8973 @item -mh
8974 @opindex mh
8975 Generate code for the H8/300H@.
8977 @item -ms
8978 @opindex ms
8979 Generate code for the H8S@.
8981 @item -mn
8982 @opindex mn
8983 Generate code for the H8S and H8/300H in the normal mode.  This switch
8984 must be used either with -mh or -ms.
8986 @item -ms2600
8987 @opindex ms2600
8988 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8990 @item -mint32
8991 @opindex mint32
8992 Make @code{int} data 32 bits by default.
8994 @item -malign-300
8995 @opindex malign-300
8996 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8997 The default for the H8/300H and H8S is to align longs and floats on 4
8998 byte boundaries.
8999 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9000 This option has no effect on the H8/300.
9001 @end table
9003 @node SH Options
9004 @subsection SH Options
9006 These @samp{-m} options are defined for the SH implementations:
9008 @table @gcctabopt
9009 @item -m1
9010 @opindex m1
9011 Generate code for the SH1.
9013 @item -m2
9014 @opindex m2
9015 Generate code for the SH2.
9017 @item -m2e
9018 Generate code for the SH2e.
9020 @item -m3
9021 @opindex m3
9022 Generate code for the SH3.
9024 @item -m3e
9025 @opindex m3e
9026 Generate code for the SH3e.
9028 @item -m4-nofpu
9029 @opindex m4-nofpu
9030 Generate code for the SH4 without a floating-point unit.
9032 @item -m4-single-only
9033 @opindex m4-single-only
9034 Generate code for the SH4 with a floating-point unit that only
9035 supports single-precision arithmetic.
9037 @item -m4-single
9038 @opindex m4-single
9039 Generate code for the SH4 assuming the floating-point unit is in
9040 single-precision mode by default.
9042 @item -m4
9043 @opindex m4
9044 Generate code for the SH4.
9046 @item -mb
9047 @opindex mb
9048 Compile code for the processor in big endian mode.
9050 @item -ml
9051 @opindex ml
9052 Compile code for the processor in little endian mode.
9054 @item -mdalign
9055 @opindex mdalign
9056 Align doubles at 64-bit boundaries.  Note that this changes the calling
9057 conventions, and thus some functions from the standard C library will
9058 not work unless you recompile it first with @option{-mdalign}.
9060 @item -mrelax
9061 @opindex mrelax
9062 Shorten some address references at link time, when possible; uses the
9063 linker option @option{-relax}.
9065 @item -mbigtable
9066 @opindex mbigtable
9067 Use 32-bit offsets in @code{switch} tables.  The default is to use
9068 16-bit offsets.
9070 @item -mfmovd
9071 @opindex mfmovd
9072 Enable the use of the instruction @code{fmovd}.
9074 @item -mhitachi
9075 @opindex mhitachi
9076 Comply with the calling conventions defined by Hitachi.
9078 @item -mnomacsave
9079 @opindex mnomacsave
9080 Mark the @code{MAC} register as call-clobbered, even if
9081 @option{-mhitachi} is given.
9083 @item -mieee
9084 @opindex mieee
9085 Increase IEEE-compliance of floating-point code.
9087 @item -misize
9088 @opindex misize
9089 Dump instruction size and location in the assembly code.
9091 @item -mpadstruct
9092 @opindex mpadstruct
9093 This option is deprecated.  It pads structures to multiple of 4 bytes,
9094 which is incompatible with the SH ABI@.
9096 @item -mspace
9097 @opindex mspace
9098 Optimize for space instead of speed.  Implied by @option{-Os}.
9100 @item -mprefergot
9101 @opindex mprefergot
9102 When generating position-independent code, emit function calls using
9103 the Global Offset Table instead of the Procedure Linkage Table.
9105 @item -musermode
9106 @opindex musermode
9107 Generate a library function call to invalidate instruction cache
9108 entries, after fixing up a trampoline.  This library function call
9109 doesn't assume it can write to the whole memory address space.  This
9110 is the default when the target is @code{sh-*-linux*}.
9111 @end table
9113 @node System V Options
9114 @subsection Options for System V
9116 These additional options are available on System V Release 4 for
9117 compatibility with other compilers on those systems:
9119 @table @gcctabopt
9120 @item -G
9121 @opindex G
9122 Create a shared object.
9123 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9125 @item -Qy
9126 @opindex Qy
9127 Identify the versions of each tool used by the compiler, in a
9128 @code{.ident} assembler directive in the output.
9130 @item -Qn
9131 @opindex Qn
9132 Refrain from adding @code{.ident} directives to the output file (this is
9133 the default).
9135 @item -YP,@var{dirs}
9136 @opindex YP
9137 Search the directories @var{dirs}, and no others, for libraries
9138 specified with @option{-l}.
9140 @item -Ym,@var{dir}
9141 @opindex Ym
9142 Look in the directory @var{dir} to find the M4 preprocessor.
9143 The assembler uses this option.
9144 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9145 @c the generic assembler that comes with Solaris takes just -Ym.
9146 @end table
9148 @node TMS320C3x/C4x Options
9149 @subsection TMS320C3x/C4x Options
9150 @cindex TMS320C3x/C4x Options
9152 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9154 @table @gcctabopt
9156 @item -mcpu=@var{cpu_type}
9157 @opindex mcpu
9158 Set the instruction set, register set, and instruction scheduling
9159 parameters for machine type @var{cpu_type}.  Supported values for
9160 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9161 @samp{c44}.  The default is @samp{c40} to generate code for the
9162 TMS320C40.
9164 @item -mbig-memory
9165 @item -mbig
9166 @itemx -msmall-memory
9167 @itemx -msmall
9168 @opindex mbig-memory
9169 @opindex mbig
9170 @opindex msmall-memory
9171 @opindex msmall
9172 Generates code for the big or small memory model.  The small memory
9173 model assumed that all data fits into one 64K word page.  At run-time
9174 the data page (DP) register must be set to point to the 64K page
9175 containing the .bss and .data program sections.  The big memory model is
9176 the default and requires reloading of the DP register for every direct
9177 memory access.
9179 @item -mbk
9180 @itemx -mno-bk
9181 @opindex mbk
9182 @opindex mno-bk
9183 Allow (disallow) allocation of general integer operands into the block
9184 count register BK@.
9186 @item -mdb
9187 @itemx -mno-db
9188 @opindex mdb
9189 @opindex mno-db
9190 Enable (disable) generation of code using decrement and branch,
9191 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9192 on the safe side, this is disabled for the C3x, since the maximum
9193 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9194 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9195 that it can utilize the decrement and branch instruction, but will give
9196 up if there is more than one memory reference in the loop.  Thus a loop
9197 where the loop counter is decremented can generate slightly more
9198 efficient code, in cases where the RPTB instruction cannot be utilized.
9200 @item -mdp-isr-reload
9201 @itemx -mparanoid
9202 @opindex mdp-isr-reload
9203 @opindex mparanoid
9204 Force the DP register to be saved on entry to an interrupt service
9205 routine (ISR), reloaded to point to the data section, and restored on
9206 exit from the ISR@.  This should not be required unless someone has
9207 violated the small memory model by modifying the DP register, say within
9208 an object library.
9210 @item -mmpyi
9211 @itemx -mno-mpyi
9212 @opindex mmpyi
9213 @opindex mno-mpyi
9214 For the C3x use the 24-bit MPYI instruction for integer multiplies
9215 instead of a library call to guarantee 32-bit results.  Note that if one
9216 of the operands is a constant, then the multiplication will be performed
9217 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9218 then squaring operations are performed inline instead of a library call.
9220 @item -mfast-fix
9221 @itemx -mno-fast-fix
9222 @opindex mfast-fix
9223 @opindex mno-fast-fix
9224 The C3x/C4x FIX instruction to convert a floating point value to an
9225 integer value chooses the nearest integer less than or equal to the
9226 floating point value rather than to the nearest integer.  Thus if the
9227 floating point number is negative, the result will be incorrectly
9228 truncated an additional code is necessary to detect and correct this
9229 case.  This option can be used to disable generation of the additional
9230 code required to correct the result.
9232 @item -mrptb
9233 @itemx -mno-rptb
9234 @opindex mrptb
9235 @opindex mno-rptb
9236 Enable (disable) generation of repeat block sequences using the RPTB
9237 instruction for zero overhead looping.  The RPTB construct is only used
9238 for innermost loops that do not call functions or jump across the loop
9239 boundaries.  There is no advantage having nested RPTB loops due to the
9240 overhead required to save and restore the RC, RS, and RE registers.
9241 This is enabled by default with @option{-O2}.
9243 @item -mrpts=@var{count}
9244 @itemx -mno-rpts
9245 @opindex mrpts
9246 @opindex mno-rpts
9247 Enable (disable) the use of the single instruction repeat instruction
9248 RPTS@.  If a repeat block contains a single instruction, and the loop
9249 count can be guaranteed to be less than the value @var{count}, GCC will
9250 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9251 then a RPTS will be emitted even if the loop count cannot be determined
9252 at compile time.  Note that the repeated instruction following RPTS does
9253 not have to be reloaded from memory each iteration, thus freeing up the
9254 CPU buses for operands.  However, since interrupts are blocked by this
9255 instruction, it is disabled by default.
9257 @item -mloop-unsigned
9258 @itemx -mno-loop-unsigned
9259 @opindex mloop-unsigned
9260 @opindex mno-loop-unsigned
9261 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9262 is @math{2^{31} + 1} since these instructions test if the iteration count is
9263 negative to terminate the loop.  If the iteration count is unsigned
9264 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9265 exceeded.  This switch allows an unsigned iteration count.
9267 @item -mti
9268 @opindex mti
9269 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9270 with.  This also enforces compatibility with the API employed by the TI
9271 C3x C compiler.  For example, long doubles are passed as structures
9272 rather than in floating point registers.
9274 @item -mregparm
9275 @itemx -mmemparm
9276 @opindex mregparm
9277 @opindex mmemparm
9278 Generate code that uses registers (stack) for passing arguments to functions.
9279 By default, arguments are passed in registers where possible rather
9280 than by pushing arguments on to the stack.
9282 @item -mparallel-insns
9283 @itemx -mno-parallel-insns
9284 @opindex mparallel-insns
9285 @opindex mno-parallel-insns
9286 Allow the generation of parallel instructions.  This is enabled by
9287 default with @option{-O2}.
9289 @item -mparallel-mpy
9290 @itemx -mno-parallel-mpy
9291 @opindex mparallel-mpy
9292 @opindex mno-parallel-mpy
9293 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9294 provided @option{-mparallel-insns} is also specified.  These instructions have
9295 tight register constraints which can pessimize the code generation
9296 of large functions.
9298 @end table
9300 @node V850 Options
9301 @subsection V850 Options
9302 @cindex V850 Options
9304 These @samp{-m} options are defined for V850 implementations:
9306 @table @gcctabopt
9307 @item -mlong-calls
9308 @itemx -mno-long-calls
9309 @opindex mlong-calls
9310 @opindex mno-long-calls
9311 Treat all calls as being far away (near).  If calls are assumed to be
9312 far away, the compiler will always load the functions address up into a
9313 register, and call indirect through the pointer.
9315 @item -mno-ep
9316 @itemx -mep
9317 @opindex mno-ep
9318 @opindex mep
9319 Do not optimize (do optimize) basic blocks that use the same index
9320 pointer 4 or more times to copy pointer into the @code{ep} register, and
9321 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9322 option is on by default if you optimize.
9324 @item -mno-prolog-function
9325 @itemx -mprolog-function
9326 @opindex mno-prolog-function
9327 @opindex mprolog-function
9328 Do not use (do use) external functions to save and restore registers at
9329 the prolog and epilog of a function.  The external functions are slower,
9330 but use less code space if more than one function saves the same number
9331 of registers.  The @option{-mprolog-function} option is on by default if
9332 you optimize.
9334 @item -mspace
9335 @opindex mspace
9336 Try to make the code as small as possible.  At present, this just turns
9337 on the @option{-mep} and @option{-mprolog-function} options.
9339 @item -mtda=@var{n}
9340 @opindex mtda
9341 Put static or global variables whose size is @var{n} bytes or less into
9342 the tiny data area that register @code{ep} points to.  The tiny data
9343 area can hold up to 256 bytes in total (128 bytes for byte references).
9345 @item -msda=@var{n}
9346 @opindex msda
9347 Put static or global variables whose size is @var{n} bytes or less into
9348 the small data area that register @code{gp} points to.  The small data
9349 area can hold up to 64 kilobytes.
9351 @item -mzda=@var{n}
9352 @opindex mzda
9353 Put static or global variables whose size is @var{n} bytes or less into
9354 the first 32 kilobytes of memory.
9356 @item -mv850
9357 @opindex mv850
9358 Specify that the target processor is the V850.
9360 @item -mbig-switch
9361 @opindex mbig-switch
9362 Generate code suitable for big switch tables.  Use this option only if
9363 the assembler/linker complain about out of range branches within a switch
9364 table.
9366 @item -mapp-regs
9367 @opindex -mapp-regs
9368 This option will cause r2 and r5 to be used in the code generated by
9369 the compiler.  This setting is the default.
9371 @item -mno-app-regs
9372 @opindex -mno-app-regs
9373 This option will cause r2 and r5 to be treated as fixed registers.
9374   
9375 @item -mv850e
9376 @opindex -mv850e
9377 Specify that the target processor is the V850E.  The preprocessor
9378 constant @samp{__v850e__} will be defined if this option is used.
9380 If neither @option{-mv850} nor @option{-mv850e} are defined
9381 then a default target processor will be chosen and the relevant
9382 @samp{__v850*__} preprocessor constant will be defined.
9384 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9385 defined, regardless of which processor variant is the target.
9387 @item -mdisable-callt
9388 @opindex -mdisable-callt
9389 This option will suppress generation of the CALLT instruction for the
9390 v850e flavors of the v850 architecture.  The default is
9391 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9393 @end table
9395 @node ARC Options
9396 @subsection ARC Options
9397 @cindex ARC Options
9399 These options are defined for ARC implementations:
9401 @table @gcctabopt
9402 @item -EL
9403 @opindex EL
9404 Compile code for little endian mode.  This is the default.
9406 @item -EB
9407 @opindex EB
9408 Compile code for big endian mode.
9410 @item -mmangle-cpu
9411 @opindex mmangle-cpu
9412 Prepend the name of the cpu to all public symbol names.
9413 In multiple-processor systems, there are many ARC variants with different
9414 instruction and register set characteristics.  This flag prevents code
9415 compiled for one cpu to be linked with code compiled for another.
9416 No facility exists for handling variants that are ``almost identical''.
9417 This is an all or nothing option.
9419 @item -mcpu=@var{cpu}
9420 @opindex mcpu
9421 Compile code for ARC variant @var{cpu}.
9422 Which variants are supported depend on the configuration.
9423 All variants support @option{-mcpu=base}, this is the default.
9425 @item -mtext=@var{text-section}
9426 @itemx -mdata=@var{data-section}
9427 @itemx -mrodata=@var{readonly-data-section}
9428 @opindex mtext
9429 @opindex mdata
9430 @opindex mrodata
9431 Put functions, data, and readonly data in @var{text-section},
9432 @var{data-section}, and @var{readonly-data-section} respectively
9433 by default.  This can be overridden with the @code{section} attribute.
9434 @xref{Variable Attributes}.
9436 @end table
9438 @node NS32K Options
9439 @subsection NS32K Options
9440 @cindex NS32K options
9442 These are the @samp{-m} options defined for the 32000 series.  The default
9443 values for these options depends on which style of 32000 was selected when
9444 the compiler was configured; the defaults for the most common choices are
9445 given below.
9447 @table @gcctabopt
9448 @item -m32032
9449 @itemx -m32032
9450 @opindex m32032
9451 @opindex m32032
9452 Generate output for a 32032.  This is the default
9453 when the compiler is configured for 32032 and 32016 based systems.
9455 @item -m32332
9456 @itemx -m32332
9457 @opindex m32332
9458 @opindex m32332
9459 Generate output for a 32332.  This is the default
9460 when the compiler is configured for 32332-based systems.
9462 @item -m32532
9463 @itemx -m32532
9464 @opindex m32532
9465 @opindex m32532
9466 Generate output for a 32532.  This is the default
9467 when the compiler is configured for 32532-based systems.
9469 @item -m32081
9470 @opindex m32081
9471 Generate output containing 32081 instructions for floating point.
9472 This is the default for all systems.
9474 @item -m32381
9475 @opindex m32381
9476 Generate output containing 32381 instructions for floating point.  This
9477 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9478 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9480 @item -mmulti-add
9481 @opindex mmulti-add
9482 Try and generate multiply-add floating point instructions @code{polyF}
9483 and @code{dotF}.  This option is only available if the @option{-m32381}
9484 option is in effect.  Using these instructions requires changes to
9485 register allocation which generally has a negative impact on
9486 performance.  This option should only be enabled when compiling code
9487 particularly likely to make heavy use of multiply-add instructions.
9489 @item -mnomulti-add
9490 @opindex mnomulti-add
9491 Do not try and generate multiply-add floating point instructions
9492 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9494 @item -msoft-float
9495 @opindex msoft-float
9496 Generate output containing library calls for floating point.
9497 @strong{Warning:} the requisite libraries may not be available.
9499 @item -mieee-compare
9500 @itemx -mno-ieee-compare
9501 @opindex mieee-compare
9502 @opindex mno-ieee-compare
9503 Control whether or not the compiler uses IEEE floating point
9504 comparisons.  These handle correctly the case where the result of a
9505 comparison is unordered.
9506 @strong{Warning:} the requisite kernel support may not be available.
9508 @item -mnobitfield
9509 @opindex mnobitfield
9510 Do not use the bit-field instructions.  On some machines it is faster to
9511 use shifting and masking operations.  This is the default for the pc532.
9513 @item -mbitfield
9514 @opindex mbitfield
9515 Do use the bit-field instructions.  This is the default for all platforms
9516 except the pc532.
9518 @item -mrtd
9519 @opindex mrtd
9520 Use a different function-calling convention, in which functions
9521 that take a fixed number of arguments return pop their
9522 arguments on return with the @code{ret} instruction.
9524 This calling convention is incompatible with the one normally
9525 used on Unix, so you cannot use it if you need to call libraries
9526 compiled with the Unix compiler.
9528 Also, you must provide function prototypes for all functions that
9529 take variable numbers of arguments (including @code{printf});
9530 otherwise incorrect code will be generated for calls to those
9531 functions.
9533 In addition, seriously incorrect code will result if you call a
9534 function with too many arguments.  (Normally, extra arguments are
9535 harmlessly ignored.)
9537 This option takes its name from the 680x0 @code{rtd} instruction.
9540 @item -mregparam
9541 @opindex mregparam
9542 Use a different function-calling convention where the first two arguments
9543 are passed in registers.
9545 This calling convention is incompatible with the one normally
9546 used on Unix, so you cannot use it if you need to call libraries
9547 compiled with the Unix compiler.
9549 @item -mnoregparam
9550 @opindex mnoregparam
9551 Do not pass any arguments in registers.  This is the default for all
9552 targets.
9554 @item -msb
9555 @opindex msb
9556 It is OK to use the sb as an index register which is always loaded with
9557 zero.  This is the default for the pc532-netbsd target.
9559 @item -mnosb
9560 @opindex mnosb
9561 The sb register is not available for use or has not been initialized to
9562 zero by the run time system.  This is the default for all targets except
9563 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9564 @option{-fpic} is set.
9566 @item -mhimem
9567 @opindex mhimem
9568 Many ns32000 series addressing modes use displacements of up to 512MB@.
9569 If an address is above 512MB then displacements from zero can not be used.
9570 This option causes code to be generated which can be loaded above 512MB@.
9571 This may be useful for operating systems or ROM code.
9573 @item -mnohimem
9574 @opindex mnohimem
9575 Assume code will be loaded in the first 512MB of virtual address space.
9576 This is the default for all platforms.
9579 @end table
9581 @node AVR Options
9582 @subsection AVR Options
9583 @cindex AVR Options
9585 These options are defined for AVR implementations:
9587 @table @gcctabopt
9588 @item -mmcu=@var{mcu}
9589 @opindex mmcu
9590 Specify ATMEL AVR instruction set or MCU type.
9592 Instruction set avr1 is for the minimal AVR core, not supported by the C
9593 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9594 attiny11, attiny12, attiny15, attiny28).
9596 Instruction set avr2 (default) is for the classic AVR core with up to
9597 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9598 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9599 at90c8534, at90s8535).
9601 Instruction set avr3 is for the classic AVR core with up to 128K program
9602 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9604 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9605 memory space (MCU types: atmega8, atmega83, atmega85).
9607 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9608 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9609 atmega64, atmega128, at43usb355, at94k).
9611 @item -msize
9612 @opindex msize
9613 Output instruction sizes to the asm file.
9615 @item -minit-stack=@var{N}
9616 @opindex minit-stack
9617 Specify the initial stack address, which may be a symbol or numeric value,
9618 @samp{__stack} is the default.
9620 @item -mno-interrupts
9621 @opindex mno-interrupts
9622 Generated code is not compatible with hardware interrupts.
9623 Code size will be smaller.
9625 @item -mcall-prologues
9626 @opindex mcall-prologues
9627 Functions prologues/epilogues expanded as call to appropriate
9628 subroutines.  Code size will be smaller.
9630 @item -mno-tablejump
9631 @opindex mno-tablejump
9632 Do not generate tablejump insns which sometimes increase code size.
9634 @item -mtiny-stack
9635 @opindex mtiny-stack
9636 Change only the low 8 bits of the stack pointer.
9637 @end table
9639 @node MCore Options
9640 @subsection MCore Options
9641 @cindex MCore options
9643 These are the @samp{-m} options defined for the Motorola M*Core
9644 processors.
9646 @table @gcctabopt
9648 @item -mhardlit
9649 @itemx -mhardlit
9650 @itemx -mno-hardlit
9651 @opindex mhardlit
9652 @opindex mhardlit
9653 @opindex mno-hardlit
9654 Inline constants into the code stream if it can be done in two
9655 instructions or less.
9657 @item -mdiv
9658 @itemx -mdiv
9659 @itemx -mno-div
9660 @opindex mdiv
9661 @opindex mdiv
9662 @opindex mno-div
9663 Use the divide instruction.  (Enabled by default).
9665 @item -mrelax-immediate
9666 @itemx -mrelax-immediate
9667 @itemx -mno-relax-immediate
9668 @opindex mrelax-immediate
9669 @opindex mrelax-immediate
9670 @opindex mno-relax-immediate
9671 Allow arbitrary sized immediates in bit operations.
9673 @item -mwide-bitfields
9674 @itemx -mwide-bitfields
9675 @itemx -mno-wide-bitfields
9676 @opindex mwide-bitfields
9677 @opindex mwide-bitfields
9678 @opindex mno-wide-bitfields
9679 Always treat bit-fields as int-sized.
9681 @item -m4byte-functions
9682 @itemx -m4byte-functions
9683 @itemx -mno-4byte-functions
9684 @opindex m4byte-functions
9685 @opindex m4byte-functions
9686 @opindex mno-4byte-functions
9687 Force all functions to be aligned to a four byte boundary.
9689 @item -mcallgraph-data
9690 @itemx -mcallgraph-data
9691 @itemx -mno-callgraph-data
9692 @opindex mcallgraph-data
9693 @opindex mcallgraph-data
9694 @opindex mno-callgraph-data
9695 Emit callgraph information.
9697 @item -mslow-bytes
9698 @itemx -mslow-bytes
9699 @itemx -mno-slow-bytes
9700 @opindex mslow-bytes
9701 @opindex mslow-bytes
9702 @opindex mno-slow-bytes
9703 Prefer word access when reading byte quantities.
9705 @item -mlittle-endian
9706 @itemx -mlittle-endian
9707 @itemx -mbig-endian
9708 @opindex mlittle-endian
9709 @opindex mlittle-endian
9710 @opindex mbig-endian
9711 Generate code for a little endian target.
9713 @item -m210
9714 @itemx -m210
9715 @itemx -m340
9716 @opindex m210
9717 @opindex m210
9718 @opindex m340
9719 Generate code for the 210 processor.
9720 @end table
9722 @node IA-64 Options
9723 @subsection IA-64 Options
9724 @cindex IA-64 Options
9726 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9728 @table @gcctabopt
9729 @item -mbig-endian
9730 @opindex mbig-endian
9731 Generate code for a big endian target.  This is the default for HP-UX@.
9733 @item -mlittle-endian
9734 @opindex mlittle-endian
9735 Generate code for a little endian target.  This is the default for AIX5
9736 and Linux.
9738 @item -mgnu-as
9739 @itemx -mno-gnu-as
9740 @opindex mgnu-as
9741 @opindex mno-gnu-as
9742 Generate (or don't) code for the GNU assembler.  This is the default.
9743 @c Also, this is the default if the configure option @option{--with-gnu-as}
9744 @c is used.
9746 @item -mgnu-ld
9747 @itemx -mno-gnu-ld
9748 @opindex mgnu-ld
9749 @opindex mno-gnu-ld
9750 Generate (or don't) code for the GNU linker.  This is the default.
9751 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9752 @c is used.
9754 @item -mno-pic
9755 @opindex mno-pic
9756 Generate code that does not use a global pointer register.  The result
9757 is not position independent code, and violates the IA-64 ABI@.
9759 @item -mvolatile-asm-stop
9760 @itemx -mno-volatile-asm-stop
9761 @opindex mvolatile-asm-stop
9762 @opindex mno-volatile-asm-stop
9763 Generate (or don't) a stop bit immediately before and after volatile asm
9764 statements.
9766 @item -mb-step
9767 @opindex mb-step
9768 Generate code that works around Itanium B step errata.
9770 @item -mregister-names
9771 @itemx -mno-register-names
9772 @opindex mregister-names
9773 @opindex mno-register-names
9774 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9775 the stacked registers.  This may make assembler output more readable.
9777 @item -mno-sdata
9778 @itemx -msdata
9779 @opindex mno-sdata
9780 @opindex msdata
9781 Disable (or enable) optimizations that use the small data section.  This may
9782 be useful for working around optimizer bugs.
9784 @item -mconstant-gp
9785 @opindex mconstant-gp
9786 Generate code that uses a single constant global pointer value.  This is
9787 useful when compiling kernel code.
9789 @item -mauto-pic
9790 @opindex mauto-pic
9791 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9792 This is useful when compiling firmware code.
9794 @item -minline-float-divide-min-latency
9795 @opindex minline-float-divide-min-latency
9796 Generate code for inline divides of floating point values
9797 using the minimum latency algorithm.
9799 @item -minline-float-divide-max-throughput
9800 @opindex minline-float-divide-max-throughput
9801 Generate code for inline divides of floating point values
9802 using the maximum throughput algorithm.
9804 @item -minline-int-divide-min-latency
9805 @opindex minline-int-divide-min-latency
9806 Generate code for inline divides of integer values
9807 using the minimum latency algorithm.
9809 @item -minline-int-divide-max-throughput
9810 @opindex minline-int-divide-max-throughput
9811 Generate code for inline divides of integer values
9812 using the maximum throughput algorithm.
9814 @item -mno-dwarf2-asm
9815 @itemx -mdwarf2-asm
9816 @opindex mno-dwarf2-asm
9817 @opindex mdwarf2-asm
9818 Don't (or do) generate assembler code for the DWARF2 line number debugging
9819 info.  This may be useful when not using the GNU assembler.
9821 @item -mfixed-range=@var{register-range}
9822 @opindex mfixed-range
9823 Generate code treating the given register range as fixed registers.
9824 A fixed register is one that the register allocator can not use.  This is
9825 useful when compiling kernel code.  A register range is specified as
9826 two registers separated by a dash.  Multiple register ranges can be
9827 specified separated by a comma.
9829 @item -mearly-stop-bits
9830 @itemx -mno-early-stop-bits
9831 @opindex mearly-stop-bits
9832 @opindex mno-early-stop-bits
9833 Allow stop bits to be placed earlier than immediately preceding the
9834 instruction that triggered the stop bit.  This can improve instruction
9835 scheduling, but does not always do so.
9836 @end table
9838 @node D30V Options
9839 @subsection D30V Options
9840 @cindex D30V Options
9842 These @samp{-m} options are defined for D30V implementations:
9844 @table @gcctabopt
9845 @item -mextmem
9846 @opindex mextmem
9847 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9848 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9849 memory, which starts at location @code{0x80000000}.
9851 @item -mextmemory
9852 @opindex mextmemory
9853 Same as the @option{-mextmem} switch.
9855 @item -monchip
9856 @opindex monchip
9857 Link the @samp{.text} section into onchip text memory, which starts at
9858 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9859 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9860 into onchip data memory, which starts at location @code{0x20000000}.
9862 @item -mno-asm-optimize
9863 @itemx -masm-optimize
9864 @opindex mno-asm-optimize
9865 @opindex masm-optimize
9866 Disable (enable) passing @option{-O} to the assembler when optimizing.
9867 The assembler uses the @option{-O} option to automatically parallelize
9868 adjacent short instructions where possible.
9870 @item -mbranch-cost=@var{n}
9871 @opindex mbranch-cost
9872 Increase the internal costs of branches to @var{n}.  Higher costs means
9873 that the compiler will issue more instructions to avoid doing a branch.
9874 The default is 2.
9876 @item -mcond-exec=@var{n}
9877 @opindex mcond-exec
9878 Specify the maximum number of conditionally executed instructions that
9879 replace a branch.  The default is 4.
9880 @end table
9882 @node S/390 and zSeries Options
9883 @subsection S/390 and zSeries Options
9884 @cindex S/390 and zSeries Options
9886 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9888 @table @gcctabopt
9889 @item -mhard-float
9890 @itemx -msoft-float
9891 @opindex mhard-float
9892 @opindex msoft-float
9893 Use (do not use) the hardware floating-point instructions and registers
9894 for floating-point operations.  When @option{-msoft-float} is specified,
9895 functions in @file{libgcc.a} will be used to perform floating-point
9896 operations.  When @option{-mhard-float} is specified, the compiler
9897 generates IEEE floating-point instructions.  This is the default.
9899 @item -mbackchain
9900 @itemx -mno-backchain
9901 @opindex mbackchain
9902 @opindex mno-backchain
9903 Generate (or do not generate) code which maintains an explicit
9904 backchain within the stack frame that points to the caller's frame.
9905 This is currently needed to allow debugging.  The default is to
9906 generate the backchain.
9908 @item -msmall-exec
9909 @itemx -mno-small-exec
9910 @opindex msmall-exec
9911 @opindex mno-small-exec
9912 Generate (or do not generate) code using the @code{bras} instruction
9913 to do subroutine calls.
9914 This only works reliably if the total executable size does not
9915 exceed 64k.  The default is to use the @code{basr} instruction instead,
9916 which does not have this limitation.
9918 @item -m64
9919 @itemx -m31
9920 @opindex m64
9921 @opindex m31
9922 When @option{-m31} is specified, generate code compliant to the
9923 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9924 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9925 particular to generate 64-bit instructions.  For the @samp{s390}
9926 targets, the default is @option{-m31}, while the @samp{s390x}
9927 targets default to @option{-m64}.
9929 @item -mzarch
9930 @itemx -mesa
9931 @opindex mzarch
9932 @opindex mesa
9933 When @option{-mzarch} is specified, generate code using the 
9934 instructions available on z/Architecture. 
9935 When @option{-mesa} is specified, generate code using the 
9936 instructions available on ESA/390. Note that @option{-mesa} is
9937 not possible with @option{-m64}.
9938 For the @samp{s390} targets, the default is @option{-mesa}, 
9939 while the @samp{s390x} targets default to @option{-mzarch}.
9941 @item -mmvcle
9942 @itemx -mno-mvcle
9943 @opindex mmvcle
9944 @opindex mno-mvcle
9945 Generate (or do not generate) code using the @code{mvcle} instruction
9946 to perform block moves.  When @option{-mno-mvcle} is specified,
9947 use a @code{mvc} loop instead.  This is the default.
9949 @item -mdebug
9950 @itemx -mno-debug
9951 @opindex mdebug
9952 @opindex mno-debug
9953 Print (or do not print) additional debug information when compiling.
9954 The default is to not print debug information.
9956 @item -march=@var{arch}
9957 @opindex march
9958 Generate code that will run on @var{arch}, which is the name of system
9959 representing a certain processor type. Possible values for
9960 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
9962 @item -mtune=@var{arch}
9963 @opindex mtune
9964 Tune to @var{cpu-type} everything applicable about the generated code,
9965  except for the ABI and the set of available instructions. 
9966 The list of @var{arch} values is the same as for @option{-march}.
9968 @end table
9970 @node CRIS Options
9971 @subsection CRIS Options
9972 @cindex CRIS Options
9974 These options are defined specifically for the CRIS ports.
9976 @table @gcctabopt
9977 @item -march=@var{architecture-type}
9978 @itemx -mcpu=@var{architecture-type}
9979 @opindex march
9980 @opindex mcpu
9981 Generate code for the specified architecture.  The choices for
9982 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9983 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9984 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9985 @samp{v10}.
9987 @item -mtune=@var{architecture-type}
9988 @opindex mtune
9989 Tune to @var{architecture-type} everything applicable about the generated
9990 code, except for the ABI and the set of available instructions.  The
9991 choices for @var{architecture-type} are the same as for
9992 @option{-march=@var{architecture-type}}.
9994 @item -mmax-stack-frame=@var{n}
9995 @opindex mmax-stack-frame
9996 Warn when the stack frame of a function exceeds @var{n} bytes.
9998 @item -melinux-stacksize=@var{n}
9999 @opindex melinux-stacksize
10000 Only available with the @samp{cris-axis-aout} target.  Arranges for
10001 indications in the program to the kernel loader that the stack of the
10002 program should be set to @var{n} bytes.
10004 @item -metrax4
10005 @itemx -metrax100
10006 @opindex metrax4
10007 @opindex metrax100
10008 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10009 @option{-march=v3} and @option{-march=v8} respectively.
10011 @item -mpdebug
10012 @opindex mpdebug
10013 Enable CRIS-specific verbose debug-related information in the assembly
10014 code.  This option also has the effect to turn off the @samp{#NO_APP}
10015 formatted-code indicator to the assembler at the beginning of the
10016 assembly file.
10018 @item -mcc-init
10019 @opindex mcc-init
10020 Do not use condition-code results from previous instruction; always emit
10021 compare and test instructions before use of condition codes.
10023 @item -mno-side-effects
10024 @opindex mno-side-effects
10025 Do not emit instructions with side-effects in addressing modes other than
10026 post-increment.
10028 @item -mstack-align
10029 @itemx -mno-stack-align
10030 @itemx -mdata-align
10031 @itemx -mno-data-align
10032 @itemx -mconst-align
10033 @itemx -mno-const-align
10034 @opindex mstack-align
10035 @opindex mno-stack-align
10036 @opindex mdata-align
10037 @opindex mno-data-align
10038 @opindex mconst-align
10039 @opindex mno-const-align
10040 These options (no-options) arranges (eliminate arrangements) for the
10041 stack-frame, individual data and constants to be aligned for the maximum
10042 single data access size for the chosen CPU model.  The default is to
10043 arrange for 32-bit alignment.  ABI details such as structure layout are
10044 not affected by these options.
10046 @item -m32-bit
10047 @itemx -m16-bit
10048 @itemx -m8-bit
10049 @opindex m32-bit
10050 @opindex m16-bit
10051 @opindex m8-bit
10052 Similar to the stack- data- and const-align options above, these options
10053 arrange for stack-frame, writable data and constants to all be 32-bit,
10054 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10056 @item -mno-prologue-epilogue
10057 @itemx -mprologue-epilogue
10058 @opindex mno-prologue-epilogue
10059 @opindex mprologue-epilogue
10060 With @option{-mno-prologue-epilogue}, the normal function prologue and
10061 epilogue that sets up the stack-frame are omitted and no return
10062 instructions or return sequences are generated in the code.  Use this
10063 option only together with visual inspection of the compiled code: no
10064 warnings or errors are generated when call-saved registers must be saved,
10065 or storage for local variable needs to be allocated.
10067 @item -mno-gotplt
10068 @itemx -mgotplt
10069 @opindex mno-gotplt
10070 @opindex mgotplt
10071 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10072 instruction sequences that load addresses for functions from the PLT part
10073 of the GOT rather than (traditional on other architectures) calls to the
10074 PLT.  The default is @option{-mgotplt}.
10076 @item -maout
10077 @opindex maout
10078 Legacy no-op option only recognized with the cris-axis-aout target.
10080 @item -melf
10081 @opindex melf
10082 Legacy no-op option only recognized with the cris-axis-elf and
10083 cris-axis-linux-gnu targets.
10085 @item -melinux
10086 @opindex melinux
10087 Only recognized with the cris-axis-aout target, where it selects a
10088 GNU/linux-like multilib, include files and instruction set for
10089 @option{-march=v8}.
10091 @item -mlinux
10092 @opindex mlinux
10093 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10095 @item -sim
10096 @opindex sim
10097 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10098 to link with input-output functions from a simulator library.  Code,
10099 initialized data and zero-initialized data are allocated consecutively.
10101 @item -sim2
10102 @opindex sim2
10103 Like @option{-sim}, but pass linker options to locate initialized data at
10104 0x40000000 and zero-initialized data at 0x80000000.
10105 @end table
10107 @node MMIX Options
10108 @subsection MMIX Options
10109 @cindex MMIX Options
10111 These options are defined for the MMIX:
10113 @table @gcctabopt
10114 @item -mlibfuncs
10115 @itemx -mno-libfuncs
10116 @opindex mlibfuncs
10117 @opindex mno-libfuncs
10118 Specify that intrinsic library functions are being compiled, passing all
10119 values in registers, no matter the size.
10121 @item -mepsilon
10122 @itemx -mno-epsilon
10123 @opindex mepsilon
10124 @opindex mno-epsilon
10125 Generate floating-point comparison instructions that compare with respect
10126 to the @code{rE} epsilon register.
10128 @item -mabi=mmixware
10129 @itemx -mabi=gnu
10130 @opindex mabi-mmixware
10131 @opindex mabi=gnu
10132 Generate code that passes function parameters and return values that (in
10133 the called function) are seen as registers @code{$0} and up, as opposed to
10134 the GNU ABI which uses global registers @code{$231} and up.
10136 @item -mzero-extend
10137 @itemx -mno-zero-extend
10138 @opindex mzero-extend
10139 @opindex mno-zero-extend
10140 When reading data from memory in sizes shorter than 64 bits, use (do not
10141 use) zero-extending load instructions by default, rather than
10142 sign-extending ones.
10144 @item -mknuthdiv
10145 @itemx -mno-knuthdiv
10146 @opindex mknuthdiv
10147 @opindex mno-knuthdiv
10148 Make the result of a division yielding a remainder have the same sign as
10149 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10150 remainder follows the sign of the dividend.  Both methods are
10151 arithmetically valid, the latter being almost exclusively used.
10153 @item -mtoplevel-symbols
10154 @itemx -mno-toplevel-symbols
10155 @opindex mtoplevel-symbols
10156 @opindex mno-toplevel-symbols
10157 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10158 code can be used with the @code{PREFIX} assembly directive.
10160 @item -melf
10161 @opindex melf
10162 Generate an executable in the ELF format, rather than the default
10163 @samp{mmo} format used by the @command{mmix} simulator.
10165 @item -mbranch-predict
10166 @itemx -mno-branch-predict
10167 @opindex mbranch-predict
10168 @opindex mno-branch-predict
10169 Use (do not use) the probable-branch instructions, when static branch
10170 prediction indicates a probable branch.
10172 @item -mbase-addresses
10173 @itemx -mno-base-addresses
10174 @opindex mbase-addresses
10175 @opindex mno-base-addresses
10176 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10177 base address automatically generates a request (handled by the assembler
10178 and the linker) for a constant to be set up in a global register.  The
10179 register is used for one or more base address requests within the range 0
10180 to 255 from the value held in the register.  The generally leads to short
10181 and fast code, but the number of different data items that can be
10182 addressed is limited.  This means that a program that uses lots of static
10183 data may require @option{-mno-base-addresses}.
10185 @item -msingle-exit
10186 @itemx -mno-single-exit
10187 @opindex msingle-exit
10188 @opindex mno-single-exit
10189 Force (do not force) generated code to have a single exit point in each
10190 function.
10191 @end table
10193 @node PDP-11 Options
10194 @subsection PDP-11 Options
10195 @cindex PDP-11 Options
10197 These options are defined for the PDP-11:
10199 @table @gcctabopt
10200 @item -mfpu
10201 @opindex mfpu
10202 Use hardware FPP floating point.  This is the default.  (FIS floating
10203 point on the PDP-11/40 is not supported.)
10205 @item -msoft-float
10206 @opindex msoft-float
10207 Do not use hardware floating point.
10209 @item -mac0
10210 @opindex mac0
10211 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10213 @item -mno-ac0
10214 @opindex mno-ac0
10215 Return floating-point results in memory.  This is the default.
10217 @item -m40
10218 @opindex m40
10219 Generate code for a PDP-11/40.
10221 @item -m45
10222 @opindex m45
10223 Generate code for a PDP-11/45.  This is the default.
10225 @item -m10
10226 @opindex m10
10227 Generate code for a PDP-11/10.
10229 @item -mbcopy-builtin
10230 @opindex bcopy-builtin
10231 Use inline @code{movstrhi} patterns for copying memory.  This is the
10232 default.
10234 @item -mbcopy
10235 @opindex mbcopy
10236 Do not use inline @code{movstrhi} patterns for copying memory.
10238 @item -mint16
10239 @itemx -mno-int32
10240 @opindex mint16
10241 @opindex mno-int32
10242 Use 16-bit @code{int}.  This is the default.
10244 @item -mint32
10245 @itemx -mno-int16
10246 @opindex mint32
10247 @opindex mno-int16
10248 Use 32-bit @code{int}.
10250 @item -mfloat64
10251 @itemx -mno-float32
10252 @opindex mfloat64
10253 @opindex mno-float32
10254 Use 64-bit @code{float}.  This is the default.
10256 @item -mfloat32
10257 @item -mno-float64
10258 @opindex mfloat32
10259 @opindex mno-float64
10260 Use 32-bit @code{float}.
10262 @item -mabshi
10263 @opindex mabshi
10264 Use @code{abshi2} pattern.  This is the default.
10266 @item -mno-abshi
10267 @opindex mno-abshi
10268 Do not use @code{abshi2} pattern.
10270 @item -mbranch-expensive
10271 @opindex mbranch-expensive
10272 Pretend that branches are expensive.  This is for experimenting with
10273 code generation only.
10275 @item -mbranch-cheap
10276 @opindex mbranch-cheap
10277 Do not pretend that branches are expensive.  This is the default.
10279 @item -msplit
10280 @opindex msplit
10281 Generate code for a system with split I&D.
10283 @item -mno-split
10284 @opindex mno-split
10285 Generate code for a system without split I&D.  This is the default.
10287 @item -munix-asm
10288 @opindex munix-asm
10289 Use Unix assembler syntax.  This is the default when configured for
10290 @samp{pdp11-*-bsd}.
10292 @item -mdec-asm
10293 @opindex mdec-asm
10294 Use DEC assembler syntax.  This is the default when configured for any
10295 PDP-11 target other than @samp{pdp11-*-bsd}.
10296 @end table
10298 @node Xstormy16 Options
10299 @subsection Xstormy16 Options
10300 @cindex Xstormy16 Options
10302 These options are defined for Xstormy16:
10304 @table @gcctabopt
10305 @item -msim
10306 @opindex msim
10307 Choose startup files and linker script suitable for the simulator.
10308 @end table
10310 @node FRV Options
10311 @subsection FRV Options
10312 @cindex FRV Options
10314 @table @gcctabopt
10315 @item -mgpr-32
10316 @opindex mgpr-32
10318 Only use the first 32 general purpose registers.
10320 @item -mgpr-64
10321 @opindex mgpr-64
10323 Use all 64 general purpose registers.
10325 @item -mfpr-32
10326 @opindex mfpr-32
10328 Use only the first 32 floating point registers.
10330 @item -mfpr-64
10331 @opindex mfpr-64
10333 Use all 64 floating point registers
10335 @item -mhard-float
10336 @opindex mhard-float
10338 Use hardware instructions for floating point operations.
10340 @item -msoft-float
10341 @opindex msoft-float
10343 Use library routines for floating point operations.
10345 @item -malloc-cc
10346 @opindex malloc-cc
10348 Dynamically allocate condition code registers.
10350 @item -mfixed-cc
10351 @opindex mfixed-cc
10353 Do not try to dynamically allocate condition code registers, only
10354 use @code{icc0} and @code{fcc0}.
10356 @item -mdword
10357 @opindex mdword
10359 Change ABI to use double word insns.
10361 @item -mno-dword
10362 @opindex mno-dword
10364 Do not use double word instructions.
10366 @item -mdouble
10367 @opindex mdouble
10369 Use floating point double instructions.
10371 @item -mno-double
10372 @opindex mno-double
10374 Do not use floating point double instructions.
10376 @item -mmedia
10377 @opindex mmedia
10379 Use media instructions.
10381 @item -mno-media
10382 @opindex mno-media
10384 Do not use media instructions.
10386 @item -mmuladd
10387 @opindex mmuladd
10389 Use multiply and add/subtract instructions.
10391 @item -mno-muladd
10392 @opindex mno-muladd
10394 Do not use multiply and add/subtract instructions.
10396 @item -mlibrary-pic
10397 @opindex mlibrary-pic
10399 Enable PIC support for building libraries
10401 @item -macc-4
10402 @opindex macc-4
10404 Use only the first four media accumulator registers.
10406 @item -macc-8
10407 @opindex macc-8
10409 Use all eight media accumulator registers.
10411 @item -mpack
10412 @opindex mpack
10414 Pack VLIW instructions.
10416 @item -mno-pack
10417 @opindex mno-pack
10419 Do not pack VLIW instructions.
10421 @item -mno-eflags
10422 @opindex mno-eflags
10424 Do not mark ABI switches in e_flags.
10426 @item -mcond-move
10427 @opindex mcond-move
10429 Enable the use of conditional-move instructions (default).
10431 This switch is mainly for debugging the compiler and will likely be removed
10432 in a future version.
10434 @item -mno-cond-move
10435 @opindex mno-cond-move
10437 Disable the use of conditional-move instructions.
10439 This switch is mainly for debugging the compiler and will likely be removed
10440 in a future version.
10442 @item -mscc
10443 @opindex mscc
10445 Enable the use of conditional set instructions (default).
10447 This switch is mainly for debugging the compiler and will likely be removed
10448 in a future version.
10450 @item -mno-scc
10451 @opindex mno-scc
10453 Disable the use of conditional set instructions.
10455 This switch is mainly for debugging the compiler and will likely be removed
10456 in a future version.
10458 @item -mcond-exec
10459 @opindex mcond-exec
10461 Enable the use of conditional execution (default).
10463 This switch is mainly for debugging the compiler and will likely be removed
10464 in a future version.
10466 @item -mno-cond-exec
10467 @opindex mno-cond-exec
10469 Disable the use of conditional execution.
10471 This switch is mainly for debugging the compiler and will likely be removed
10472 in a future version.
10474 @item -mvliw-branch
10475 @opindex mvliw-branch
10477 Run a pass to pack branches into VLIW instructions (default).
10479 This switch is mainly for debugging the compiler and will likely be removed
10480 in a future version.
10482 @item -mno-vliw-branch
10483 @opindex mno-vliw-branch
10485 Do not run a pass to pack branches into VLIW instructions.
10487 This switch is mainly for debugging the compiler and will likely be removed
10488 in a future version.
10490 @item -mmulti-cond-exec
10491 @opindex mmulti-cond-exec
10493 Enable optimization of @code{&&} and @code{||} in conditional execution
10494 (default).
10496 This switch is mainly for debugging the compiler and will likely be removed
10497 in a future version.
10499 @item -mno-multi-cond-exec
10500 @opindex mno-multi-cond-exec
10502 Disable optimization of @code{&&} and @code{||} in conditional execution.
10504 This switch is mainly for debugging the compiler and will likely be removed
10505 in a future version.
10507 @item -mnested-cond-exec
10508 @opindex mnested-cond-exec
10510 Enable nested conditional execution optimizations (default).
10512 This switch is mainly for debugging the compiler and will likely be removed
10513 in a future version.
10515 @item -mno-nested-cond-exec
10516 @opindex mno-nested-cond-exec
10518 Disable nested conditional execution optimizations.
10520 This switch is mainly for debugging the compiler and will likely be removed
10521 in a future version.
10523 @item -mtomcat-stats
10524 @opindex mtomcat-stats
10526 Cause gas to print out tomcat statistics.
10528 @item -mcpu=@var{cpu}
10529 @opindex mcpu
10531 Select the processor type for which to generate code.  Possible values are
10532 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10533 @samp{frv}.
10535 @end table
10537 @node Xtensa Options
10538 @subsection Xtensa Options
10539 @cindex Xtensa Options
10541 The Xtensa architecture is designed to support many different
10542 configurations.  The compiler's default options can be set to match a
10543 particular Xtensa configuration by copying a configuration file into the
10544 GCC sources when building GCC@.  The options below may be used to
10545 override the default options.
10547 @table @gcctabopt
10548 @item -mbig-endian
10549 @itemx -mlittle-endian
10550 @opindex mbig-endian
10551 @opindex mlittle-endian
10552 Specify big-endian or little-endian byte ordering for the target Xtensa
10553 processor.
10555 @item -mdensity
10556 @itemx -mno-density
10557 @opindex mdensity
10558 @opindex mno-density
10559 Enable or disable use of the optional Xtensa code density instructions.
10561 @item -mmac16
10562 @itemx -mno-mac16
10563 @opindex mmac16
10564 @opindex mno-mac16
10565 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10566 will generate MAC16 instructions from standard C code, with the
10567 limitation that it will use neither the MR register file nor any
10568 instruction that operates on the MR registers.  When this option is
10569 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10570 combination of core instructions and library calls, depending on whether
10571 any other multiplier options are enabled.
10573 @item -mmul16
10574 @itemx -mno-mul16
10575 @opindex mmul16
10576 @opindex mno-mul16
10577 Enable or disable use of the 16-bit integer multiplier option.  When
10578 enabled, the compiler will generate 16-bit multiply instructions for
10579 multiplications of 16 bits or smaller in standard C code.  When this
10580 option is disabled, the compiler will either use 32-bit multiply or
10581 MAC16 instructions if they are available or generate library calls to
10582 perform the multiply operations using shifts and adds.
10584 @item -mmul32
10585 @itemx -mno-mul32
10586 @opindex mmul32
10587 @opindex mno-mul32
10588 Enable or disable use of the 32-bit integer multiplier option.  When
10589 enabled, the compiler will generate 32-bit multiply instructions for
10590 multiplications of 32 bits or smaller in standard C code.  When this
10591 option is disabled, the compiler will generate library calls to perform
10592 the multiply operations using either shifts and adds or 16-bit multiply
10593 instructions if they are available.
10595 @item -mnsa
10596 @itemx -mno-nsa
10597 @opindex mnsa
10598 @opindex mno-nsa
10599 Enable or disable use of the optional normalization shift amount
10600 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10602 @item -mminmax
10603 @itemx -mno-minmax
10604 @opindex mminmax
10605 @opindex mno-minmax
10606 Enable or disable use of the optional minimum and maximum value
10607 instructions.
10609 @item -msext
10610 @itemx -mno-sext
10611 @opindex msext
10612 @opindex mno-sext
10613 Enable or disable use of the optional sign extend (@code{SEXT})
10614 instruction.
10616 @item -mbooleans
10617 @itemx -mno-booleans
10618 @opindex mbooleans
10619 @opindex mno-booleans
10620 Enable or disable support for the boolean register file used by Xtensa
10621 coprocessors.  This is not typically useful by itself but may be
10622 required for other options that make use of the boolean registers (e.g.,
10623 the floating-point option).
10625 @item -mhard-float
10626 @itemx -msoft-float
10627 @opindex mhard-float
10628 @opindex msoft-float
10629 Enable or disable use of the floating-point option.  When enabled, GCC
10630 generates floating-point instructions for 32-bit @code{float}
10631 operations.  When this option is disabled, GCC generates library calls
10632 to emulate 32-bit floating-point operations using integer instructions.
10633 Regardless of this option, 64-bit @code{double} operations are always
10634 emulated with calls to library functions.
10636 @item -mfused-madd
10637 @itemx -mno-fused-madd
10638 @opindex mfused-madd
10639 @opindex mno-fused-madd
10640 Enable or disable use of fused multiply/add and multiply/subtract
10641 instructions in the floating-point option.  This has no effect if the
10642 floating-point option is not also enabled.  Disabling fused multiply/add
10643 and multiply/subtract instructions forces the compiler to use separate
10644 instructions for the multiply and add/subtract operations.  This may be
10645 desirable in some cases where strict IEEE 754-compliant results are
10646 required: the fused multiply add/subtract instructions do not round the
10647 intermediate result, thereby producing results with @emph{more} bits of
10648 precision than specified by the IEEE standard.  Disabling fused multiply
10649 add/subtract instructions also ensures that the program output is not
10650 sensitive to the compiler's ability to combine multiply and add/subtract
10651 operations.
10653 @item -mserialize-volatile
10654 @itemx -mno-serialize-volatile
10655 @opindex mserialize-volatile
10656 @opindex mno-serialize-volatile
10657 When this option is enabled, GCC inserts @code{MEMW} instructions before
10658 @code{volatile} memory references to guarantee sequential consistency.
10659 The default is @option{-mserialize-volatile}.  Use
10660 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10662 @item -mtext-section-literals
10663 @itemx -mno-text-section-literals
10664 @opindex mtext-section-literals
10665 @opindex mno-text-section-literals
10666 Control the treatment of literal pools.  The default is
10667 @option{-mno-text-section-literals}, which places literals in a separate
10668 section in the output file.  This allows the literal pool to be placed
10669 in a data RAM/ROM, and it also allows the linker to combine literal
10670 pools from separate object files to remove redundant literals and
10671 improve code size.  With @option{-mtext-section-literals}, the literals
10672 are interspersed in the text section in order to keep them as close as
10673 possible to their references.  This may be necessary for large assembly
10674 files.
10676 @item -mtarget-align
10677 @itemx -mno-target-align
10678 @opindex mtarget-align
10679 @opindex mno-target-align
10680 When this option is enabled, GCC instructs the assembler to
10681 automatically align instructions to reduce branch penalties at the
10682 expense of some code density.  The assembler attempts to widen density
10683 instructions to align branch targets and the instructions following call
10684 instructions.  If there are not enough preceding safe density
10685 instructions to align a target, no widening will be performed.  The
10686 default is @option{-mtarget-align}.  These options do not affect the
10687 treatment of auto-aligned instructions like @code{LOOP}, which the
10688 assembler will always align, either by widening density instructions or
10689 by inserting no-op instructions.
10691 @item -mlongcalls
10692 @itemx -mno-longcalls
10693 @opindex mlongcalls
10694 @opindex mno-longcalls
10695 When this option is enabled, GCC instructs the assembler to translate
10696 direct calls to indirect calls unless it can determine that the target
10697 of a direct call is in the range allowed by the call instruction.  This
10698 translation typically occurs for calls to functions in other source
10699 files.  Specifically, the assembler translates a direct @code{CALL}
10700 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10701 The default is @option{-mno-longcalls}.  This option should be used in
10702 programs where the call target can potentially be out of range.  This
10703 option is implemented in the assembler, not the compiler, so the
10704 assembly code generated by GCC will still show direct call
10705 instructions---look at the disassembled object code to see the actual
10706 instructions.  Note that the assembler will use an indirect call for
10707 every cross-file call, not just those that really will be out of range.
10708 @end table
10710 @node Code Gen Options
10711 @section Options for Code Generation Conventions
10712 @cindex code generation conventions
10713 @cindex options, code generation
10714 @cindex run-time options
10716 These machine-independent options control the interface conventions
10717 used in code generation.
10719 Most of them have both positive and negative forms; the negative form
10720 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10721 one of the forms is listed---the one which is not the default.  You
10722 can figure out the other form by either removing @samp{no-} or adding
10725 @table @gcctabopt
10726 @item -fbounds-check
10727 @opindex fbounds-check
10728 For front-ends that support it, generate additional code to check that
10729 indices used to access arrays are within the declared range.  This is
10730 currently only supported by the Java and Fortran 77 front-ends, where
10731 this option defaults to true and false respectively.
10733 @item -ftrapv
10734 @opindex ftrapv
10735 This option generates traps for signed overflow on addition, subtraction,
10736 multiplication operations.
10738 @item -fexceptions
10739 @opindex fexceptions
10740 Enable exception handling.  Generates extra code needed to propagate
10741 exceptions.  For some targets, this implies GCC will generate frame
10742 unwind information for all functions, which can produce significant data
10743 size overhead, although it does not affect execution.  If you do not
10744 specify this option, GCC will enable it by default for languages like
10745 C++ which normally require exception handling, and disable it for
10746 languages like C that do not normally require it.  However, you may need
10747 to enable this option when compiling C code that needs to interoperate
10748 properly with exception handlers written in C++.  You may also wish to
10749 disable this option if you are compiling older C++ programs that don't
10750 use exception handling.
10752 @item -fnon-call-exceptions
10753 @opindex fnon-call-exceptions
10754 Generate code that allows trapping instructions to throw exceptions.
10755 Note that this requires platform-specific runtime support that does
10756 not exist everywhere.  Moreover, it only allows @emph{trapping}
10757 instructions to throw exceptions, i.e.@: memory references or floating
10758 point instructions.  It does not allow exceptions to be thrown from
10759 arbitrary signal handlers such as @code{SIGALRM}.
10761 @item -funwind-tables
10762 @opindex funwind-tables
10763 Similar to @option{-fexceptions}, except that it will just generate any needed
10764 static data, but will not affect the generated code in any other way.
10765 You will normally not enable this option; instead, a language processor
10766 that needs this handling would enable it on your behalf.
10768 @item -fasynchronous-unwind-tables
10769 @opindex funwind-tables
10770 Generate unwind table in dwarf2 format, if supported by target machine.  The
10771 table is exact at each instruction boundary, so it can be used for stack
10772 unwinding from asynchronous events (such as debugger or garbage collector).
10774 @item -fpcc-struct-return
10775 @opindex fpcc-struct-return
10776 Return ``short'' @code{struct} and @code{union} values in memory like
10777 longer ones, rather than in registers.  This convention is less
10778 efficient, but it has the advantage of allowing intercallability between
10779 GCC-compiled files and files compiled with other compilers, particularly
10780 the Portable C Compiler (pcc).
10782 The precise convention for returning structures in memory depends
10783 on the target configuration macros.
10785 Short structures and unions are those whose size and alignment match
10786 that of some integer type.
10788 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10789 switch is not binary compatible with code compiled with the
10790 @option{-freg-struct-return} switch.
10791 Use it to conform to a non-default application binary interface.
10793 @item -freg-struct-return
10794 @opindex freg-struct-return
10795 Return @code{struct} and @code{union} values in registers when possible.
10796 This is more efficient for small structures than
10797 @option{-fpcc-struct-return}.
10799 If you specify neither @option{-fpcc-struct-return} nor
10800 @option{-freg-struct-return}, GCC defaults to whichever convention is
10801 standard for the target.  If there is no standard convention, GCC
10802 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10803 the principal compiler.  In those cases, we can choose the standard, and
10804 we chose the more efficient register return alternative.
10806 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10807 switch is not binary compatible with code compiled with the
10808 @option{-fpcc-struct-return} switch.
10809 Use it to conform to a non-default application binary interface.
10811 @item -fshort-enums
10812 @opindex fshort-enums
10813 Allocate to an @code{enum} type only as many bytes as it needs for the
10814 declared range of possible values.  Specifically, the @code{enum} type
10815 will be equivalent to the smallest integer type which has enough room.
10817 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10818 code that is not binary compatible with code generated without that switch.
10819 Use it to conform to a non-default application binary interface.
10821 @item -fshort-double
10822 @opindex fshort-double
10823 Use the same size for @code{double} as for @code{float}.
10825 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10826 code that is not binary compatible with code generated without that switch.
10827 Use it to conform to a non-default application binary interface.
10829 @item -fshort-wchar
10830 @opindex fshort-wchar
10831 Override the underlying type for @samp{wchar_t} to be @samp{short
10832 unsigned int} instead of the default for the target.  This option is
10833 useful for building programs to run under WINE@.
10835 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10836 code that is not binary compatible with code generated without that switch.
10837 Use it to conform to a non-default application binary interface.
10839 @item -fshared-data
10840 @opindex fshared-data
10841 Requests that the data and non-@code{const} variables of this
10842 compilation be shared data rather than private data.  The distinction
10843 makes sense only on certain operating systems, where shared data is
10844 shared between processes running the same program, while private data
10845 exists in one copy per process.
10847 @item -fno-common
10848 @opindex fno-common
10849 In C, allocate even uninitialized global variables in the data section of the
10850 object file, rather than generating them as common blocks.  This has the
10851 effect that if the same variable is declared (without @code{extern}) in
10852 two different compilations, you will get an error when you link them.
10853 The only reason this might be useful is if you wish to verify that the
10854 program will work on other systems which always work this way.
10856 @item -fno-ident
10857 @opindex fno-ident
10858 Ignore the @samp{#ident} directive.
10860 @item -fno-gnu-linker
10861 @opindex fno-gnu-linker
10862 Do not output global initializations (such as C++ constructors and
10863 destructors) in the form used by the GNU linker (on systems where the GNU
10864 linker is the standard method of handling them).  Use this option when
10865 you want to use a non-GNU linker, which also requires using the
10866 @command{collect2} program to make sure the system linker includes
10867 constructors and destructors.  (@command{collect2} is included in the GCC
10868 distribution.)  For systems which @emph{must} use @command{collect2}, the
10869 compiler driver @command{gcc} is configured to do this automatically.
10871 @item -finhibit-size-directive
10872 @opindex finhibit-size-directive
10873 Don't output a @code{.size} assembler directive, or anything else that
10874 would cause trouble if the function is split in the middle, and the
10875 two halves are placed at locations far apart in memory.  This option is
10876 used when compiling @file{crtstuff.c}; you should not need to use it
10877 for anything else.
10879 @item -fverbose-asm
10880 @opindex fverbose-asm
10881 Put extra commentary information in the generated assembly code to
10882 make it more readable.  This option is generally only of use to those
10883 who actually need to read the generated assembly code (perhaps while
10884 debugging the compiler itself).
10886 @option{-fno-verbose-asm}, the default, causes the
10887 extra information to be omitted and is useful when comparing two assembler
10888 files.
10890 @item -fpic
10891 @opindex fpic
10892 @cindex global offset table
10893 @cindex PIC
10894 Generate position-independent code (PIC) suitable for use in a shared
10895 library, if supported for the target machine.  Such code accesses all
10896 constant addresses through a global offset table (GOT)@.  The dynamic
10897 loader resolves the GOT entries when the program starts (the dynamic
10898 loader is not part of GCC; it is part of the operating system).  If
10899 the GOT size for the linked executable exceeds a machine-specific
10900 maximum size, you get an error message from the linker indicating that
10901 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10902 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10903 on the m68k and RS/6000.  The 386 has no such limit.)
10905 Position-independent code requires special support, and therefore works
10906 only on certain machines.  For the 386, GCC supports PIC for System V
10907 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10908 position-independent.
10910 @item -fPIC
10911 @opindex fPIC
10912 If supported for the target machine, emit position-independent code,
10913 suitable for dynamic linking and avoiding any limit on the size of the
10914 global offset table.  This option makes a difference on the m68k, m88k,
10915 and the SPARC.
10917 Position-independent code requires special support, and therefore works
10918 only on certain machines.
10920 @item -ffixed-@var{reg}
10921 @opindex ffixed
10922 Treat the register named @var{reg} as a fixed register; generated code
10923 should never refer to it (except perhaps as a stack pointer, frame
10924 pointer or in some other fixed role).
10926 @var{reg} must be the name of a register.  The register names accepted
10927 are machine-specific and are defined in the @code{REGISTER_NAMES}
10928 macro in the machine description macro file.
10930 This flag does not have a negative form, because it specifies a
10931 three-way choice.
10933 @item -fcall-used-@var{reg}
10934 @opindex fcall-used
10935 Treat the register named @var{reg} as an allocable register that is
10936 clobbered by function calls.  It may be allocated for temporaries or
10937 variables that do not live across a call.  Functions compiled this way
10938 will not save and restore the register @var{reg}.
10940 It is an error to used this flag with the frame pointer or stack pointer.
10941 Use of this flag for other registers that have fixed pervasive roles in
10942 the machine's execution model will produce disastrous results.
10944 This flag does not have a negative form, because it specifies a
10945 three-way choice.
10947 @item -fcall-saved-@var{reg}
10948 @opindex fcall-saved
10949 Treat the register named @var{reg} as an allocable register saved by
10950 functions.  It may be allocated even for temporaries or variables that
10951 live across a call.  Functions compiled this way will save and restore
10952 the register @var{reg} if they use it.
10954 It is an error to used this flag with the frame pointer or stack pointer.
10955 Use of this flag for other registers that have fixed pervasive roles in
10956 the machine's execution model will produce disastrous results.
10958 A different sort of disaster will result from the use of this flag for
10959 a register in which function values may be returned.
10961 This flag does not have a negative form, because it specifies a
10962 three-way choice.
10964 @item -fpack-struct
10965 @opindex fpack-struct
10966 Pack all structure members together without holes.
10968 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10969 code that is not binary compatible with code generated without that switch.
10970 Additionally, it makes the code suboptimal.
10971 Use it to conform to a non-default application binary interface.
10973 @item -finstrument-functions
10974 @opindex finstrument-functions
10975 Generate instrumentation calls for entry and exit to functions.  Just
10976 after function entry and just before function exit, the following
10977 profiling functions will be called with the address of the current
10978 function and its call site.  (On some platforms,
10979 @code{__builtin_return_address} does not work beyond the current
10980 function, so the call site information may not be available to the
10981 profiling functions otherwise.)
10983 @example
10984 void __cyg_profile_func_enter (void *this_fn,
10985                                void *call_site);
10986 void __cyg_profile_func_exit  (void *this_fn,
10987                                void *call_site);
10988 @end example
10990 The first argument is the address of the start of the current function,
10991 which may be looked up exactly in the symbol table.
10993 This instrumentation is also done for functions expanded inline in other
10994 functions.  The profiling calls will indicate where, conceptually, the
10995 inline function is entered and exited.  This means that addressable
10996 versions of such functions must be available.  If all your uses of a
10997 function are expanded inline, this may mean an additional expansion of
10998 code size.  If you use @samp{extern inline} in your C code, an
10999 addressable version of such functions must be provided.  (This is
11000 normally the case anyways, but if you get lucky and the optimizer always
11001 expands the functions inline, you might have gotten away without
11002 providing static copies.)
11004 A function may be given the attribute @code{no_instrument_function}, in
11005 which case this instrumentation will not be done.  This can be used, for
11006 example, for the profiling functions listed above, high-priority
11007 interrupt routines, and any functions from which the profiling functions
11008 cannot safely be called (perhaps signal handlers, if the profiling
11009 routines generate output or allocate memory).
11011 @item -fstack-check
11012 @opindex fstack-check
11013 Generate code to verify that you do not go beyond the boundary of the
11014 stack.  You should specify this flag if you are running in an
11015 environment with multiple threads, but only rarely need to specify it in
11016 a single-threaded environment since stack overflow is automatically
11017 detected on nearly all systems if there is only one stack.
11019 Note that this switch does not actually cause checking to be done; the
11020 operating system must do that.  The switch causes generation of code
11021 to ensure that the operating system sees the stack being extended.
11023 @item -fstack-limit-register=@var{reg}
11024 @itemx -fstack-limit-symbol=@var{sym}
11025 @itemx -fno-stack-limit
11026 @opindex fstack-limit-register
11027 @opindex fstack-limit-symbol
11028 @opindex fno-stack-limit
11029 Generate code to ensure that the stack does not grow beyond a certain value,
11030 either the value of a register or the address of a symbol.  If the stack
11031 would grow beyond the value, a signal is raised.  For most targets,
11032 the signal is raised before the stack overruns the boundary, so
11033 it is possible to catch the signal without taking special precautions.
11035 For instance, if the stack starts at absolute address @samp{0x80000000}
11036 and grows downwards, you can use the flags
11037 @option{-fstack-limit-symbol=__stack_limit} and
11038 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11039 of 128KB@.  Note that this may only work with the GNU linker.
11041 @cindex aliasing of parameters
11042 @cindex parameters, aliased
11043 @item -fargument-alias
11044 @itemx -fargument-noalias
11045 @itemx -fargument-noalias-global
11046 @opindex fargument-alias
11047 @opindex fargument-noalias
11048 @opindex fargument-noalias-global
11049 Specify the possible relationships among parameters and between
11050 parameters and global data.
11052 @option{-fargument-alias} specifies that arguments (parameters) may
11053 alias each other and may alias global storage.@*
11054 @option{-fargument-noalias} specifies that arguments do not alias
11055 each other, but may alias global storage.@*
11056 @option{-fargument-noalias-global} specifies that arguments do not
11057 alias each other and do not alias global storage.
11059 Each language will automatically use whatever option is required by
11060 the language standard.  You should not need to use these options yourself.
11062 @item -fleading-underscore
11063 @opindex fleading-underscore
11064 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11065 change the way C symbols are represented in the object file.  One use
11066 is to help link with legacy assembly code.
11068 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11069 generate code that is not binary compatible with code generated without that
11070 switch.  Use it to conform to a non-default application binary interface.
11071 Not all targets provide complete support for this switch.
11073 @item -ftls-model=@var{model}
11074 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11075 The @var{model} argument should be one of @code{global-dynamic},
11076 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11078 The default without @option{-fpic} is @code{initial-exec}; with
11079 @option{-fpic} the default is @code{global-dynamic}.
11080 @end table
11082 @c man end
11084 @node Environment Variables
11085 @section Environment Variables Affecting GCC
11086 @cindex environment variables
11088 @c man begin ENVIRONMENT
11090 This section describes several environment variables that affect how GCC
11091 operates.  Some of them work by specifying directories or prefixes to use
11092 when searching for various kinds of files.  Some are used to specify other
11093 aspects of the compilation environment.
11095 Note that you can also specify places to search using options such as
11096 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11097 take precedence over places specified using environment variables, which
11098 in turn take precedence over those specified by the configuration of GCC@.
11099 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11100 GNU Compiler Collection (GCC) Internals}.
11102 @table @env
11103 @item LANG
11104 @itemx LC_CTYPE
11105 @c @itemx LC_COLLATE
11106 @itemx LC_MESSAGES
11107 @c @itemx LC_MONETARY
11108 @c @itemx LC_NUMERIC
11109 @c @itemx LC_TIME
11110 @itemx LC_ALL
11111 @findex LANG
11112 @findex LC_CTYPE
11113 @c @findex LC_COLLATE
11114 @findex LC_MESSAGES
11115 @c @findex LC_MONETARY
11116 @c @findex LC_NUMERIC
11117 @c @findex LC_TIME
11118 @findex LC_ALL
11119 @cindex locale
11120 These environment variables control the way that GCC uses
11121 localization information that allow GCC to work with different
11122 national conventions.  GCC inspects the locale categories
11123 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11124 so.  These locale categories can be set to any value supported by your
11125 installation.  A typical value is @samp{en_UK} for English in the United
11126 Kingdom.
11128 The @env{LC_CTYPE} environment variable specifies character
11129 classification.  GCC uses it to determine the character boundaries in
11130 a string; this is needed for some multibyte encodings that contain quote
11131 and escape characters that would otherwise be interpreted as a string
11132 end or escape.
11134 The @env{LC_MESSAGES} environment variable specifies the language to
11135 use in diagnostic messages.
11137 If the @env{LC_ALL} environment variable is set, it overrides the value
11138 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11139 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11140 environment variable.  If none of these variables are set, GCC
11141 defaults to traditional C English behavior.
11143 @item TMPDIR
11144 @findex TMPDIR
11145 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11146 files.  GCC uses temporary files to hold the output of one stage of
11147 compilation which is to be used as input to the next stage: for example,
11148 the output of the preprocessor, which is the input to the compiler
11149 proper.
11151 @item GCC_EXEC_PREFIX
11152 @findex GCC_EXEC_PREFIX
11153 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11154 names of the subprograms executed by the compiler.  No slash is added
11155 when this prefix is combined with the name of a subprogram, but you can
11156 specify a prefix that ends with a slash if you wish.
11158 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11159 an appropriate prefix to use based on the pathname it was invoked with.
11161 If GCC cannot find the subprogram using the specified prefix, it
11162 tries looking in the usual places for the subprogram.
11164 The default value of @env{GCC_EXEC_PREFIX} is
11165 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11166 of @code{prefix} when you ran the @file{configure} script.
11168 Other prefixes specified with @option{-B} take precedence over this prefix.
11170 This prefix is also used for finding files such as @file{crt0.o} that are
11171 used for linking.
11173 In addition, the prefix is used in an unusual way in finding the
11174 directories to search for header files.  For each of the standard
11175 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11176 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11177 replacing that beginning with the specified prefix to produce an
11178 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11179 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11180 These alternate directories are searched first; the standard directories
11181 come next.
11183 @item COMPILER_PATH
11184 @findex COMPILER_PATH
11185 The value of @env{COMPILER_PATH} is a colon-separated list of
11186 directories, much like @env{PATH}.  GCC tries the directories thus
11187 specified when searching for subprograms, if it can't find the
11188 subprograms using @env{GCC_EXEC_PREFIX}.
11190 @item LIBRARY_PATH
11191 @findex LIBRARY_PATH
11192 The value of @env{LIBRARY_PATH} is a colon-separated list of
11193 directories, much like @env{PATH}.  When configured as a native compiler,
11194 GCC tries the directories thus specified when searching for special
11195 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11196 using GCC also uses these directories when searching for ordinary
11197 libraries for the @option{-l} option (but directories specified with
11198 @option{-L} come first).
11200 @item LANG
11201 @findex LANG
11202 @cindex locale definition
11203 This variable is used to pass locale information to the compiler.  One way in
11204 which this information is used is to determine the character set to be used
11205 when character literals, string literals and comments are parsed in C and C++.
11206 When the compiler is configured to allow multibyte characters,
11207 the following values for @env{LANG} are recognized:
11209 @table @samp
11210 @item C-JIS
11211 Recognize JIS characters.
11212 @item C-SJIS
11213 Recognize SJIS characters.
11214 @item C-EUCJP
11215 Recognize EUCJP characters.
11216 @end table
11218 If @env{LANG} is not defined, or if it has some other value, then the
11219 compiler will use mblen and mbtowc as defined by the default locale to
11220 recognize and translate multibyte characters.
11221 @end table
11223 @noindent
11224 Some additional environments variables affect the behavior of the
11225 preprocessor.
11227 @include cppenv.texi
11229 @c man end
11231 @node Precompiled Headers
11232 @section Using Precompiled Headers
11233 @cindex precompiled headers
11234 @cindex speed of compilation
11236 Often large projects have many header files that are included in every
11237 source file.  The time the compiler takes to process these header files
11238 over and over again can account for nearly all of the time required to
11239 build the project.  To make builds faster, GCC allows users to
11240 `precompile' a header file; then, if builds can use the precompiled
11241 header file they will be much faster.
11243 To create a precompiled header file, simply compile it as you would any
11244 other file, if necessary using the @option{-x} option to make the driver
11245 treat it as a C or C++ header file.  You will probably want to use a
11246 tool like @command{make} to keep the precompiled header up-to-date when
11247 the headers it contains change.
11249 A precompiled header file will be searched for when @code{#include} is
11250 seen in the compilation.  As it searches for the included file
11251 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11252 compiler looks for a precompiled header in each directory just before it
11253 looks for the include file in that directory.  The name searched for is
11254 the name specified in the @code{#include} with @samp{.pch} appended.  If
11255 the precompiled header file can't be used, it is ignored.
11257 For instance, if you have @code{#include "all.h"}, and you have
11258 @file{all.h.pch} in the same directory as @file{all.h}, then the
11259 precompiled header file will be used if possible, and the original
11260 header will be used otherwise.
11262 Alternatively, you might decide to put the precompiled header file in a
11263 directory and use @option{-I} to ensure that directory is searched
11264 before (or instead of) the directory containing the original header.
11265 Then, if you want to check that the precompiled header file is always
11266 used, you can put a file of the same name as the original header in this
11267 directory containing an @code{#error} command.
11269 This also works with @option{-include}.  So yet another way to use
11270 precompiled headers, good for projects not designed with precompiled
11271 header files in mind, is to simply take most of the header files used by
11272 a project, include them from another header file, precompile that header
11273 file, and @option{-include} the precompiled header.  If the header files
11274 have guards against multiple inclusion, they will be skipped because
11275 they've already been included (in the precompiled header).
11277 If you need to precompile the same header file for different
11278 languages, targets, or compiler options, you can instead make a
11279 @emph{directory} named like @file{all.h.pch}, and put each precompiled
11280 header in the directory.  (It doesn't matter what you call the files
11281 in the directory, every precompiled header in the directory will be
11282 considered.)  The first precompiled header encountered in the
11283 directory that is valid for this compilation will be used; they're
11284 searched in no particular order.
11286 There are many other possibilities, limited only by your imagination,
11287 good sense, and the constraints of your build system.
11289 A precompiled header file can be used only when these conditions apply:
11291 @itemize
11292 @item
11293 Only one precompiled header can be used in a particular compilation.
11294 @item
11295 A precompiled header can't be used once the first C token is seen.  You
11296 can have preprocessor directives before a precompiled header; you can
11297 even include a precompiled header from inside another header, so long as
11298 there are no C tokens before the @code{#include}.
11299 @item
11300 The precompiled header file must be produced for the same language as
11301 the current compilation.  You can't use a C precompiled header for a C++
11302 compilation.
11303 @item
11304 The precompiled header file must be produced by the same compiler
11305 version and configuration as the current compilation is using.
11306 The easiest way to guarantee this is to use the same compiler binary
11307 for creating and using precompiled headers.
11308 @item
11309 Any macros defined before the precompiled header (including with
11310 @option{-D}) must either be defined in the same way as when the
11311 precompiled header was generated, or must not affect the precompiled
11312 header, which usually means that the they don't appear in the
11313 precompiled header at all.
11314 @item
11315 Certain command-line options must be defined in the same way as when the
11316 precompiled header was generated.  At present, it's not clear which
11317 options are safe to change and which are not; the safest choice is to
11318 use exactly the same options when generating and using the precompiled
11319 header.
11320 @end itemize
11322 For all of these but the last, the compiler will automatically ignore
11323 the precompiled header if the conditions aren't met.  For the last item,
11324 some option changes will cause the precompiled header to be rejected,
11325 but not all incompatible option combinations have yet been found.  If
11326 you find a new incompatible combination, please consider filing a bug
11327 report, see @ref{Bugs}.
11329 @node Running Protoize
11330 @section Running Protoize
11332 The program @code{protoize} is an optional part of GCC@.  You can use
11333 it to add prototypes to a program, thus converting the program to ISO
11334 C in one respect.  The companion program @code{unprotoize} does the
11335 reverse: it removes argument types from any prototypes that are found.
11337 When you run these programs, you must specify a set of source files as
11338 command line arguments.  The conversion programs start out by compiling
11339 these files to see what functions they define.  The information gathered
11340 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11342 After scanning comes actual conversion.  The specified files are all
11343 eligible to be converted; any files they include (whether sources or
11344 just headers) are eligible as well.
11346 But not all the eligible files are converted.  By default,
11347 @code{protoize} and @code{unprotoize} convert only source and header
11348 files in the current directory.  You can specify additional directories
11349 whose files should be converted with the @option{-d @var{directory}}
11350 option.  You can also specify particular files to exclude with the
11351 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11352 directory name matches one of the specified directory names, and its
11353 name within the directory has not been excluded.
11355 Basic conversion with @code{protoize} consists of rewriting most
11356 function definitions and function declarations to specify the types of
11357 the arguments.  The only ones not rewritten are those for varargs
11358 functions.
11360 @code{protoize} optionally inserts prototype declarations at the
11361 beginning of the source file, to make them available for any calls that
11362 precede the function's definition.  Or it can insert prototype
11363 declarations with block scope in the blocks where undeclared functions
11364 are called.
11366 Basic conversion with @code{unprotoize} consists of rewriting most
11367 function declarations to remove any argument types, and rewriting
11368 function definitions to the old-style pre-ISO form.
11370 Both conversion programs print a warning for any function declaration or
11371 definition that they can't convert.  You can suppress these warnings
11372 with @option{-q}.
11374 The output from @code{protoize} or @code{unprotoize} replaces the
11375 original source file.  The original file is renamed to a name ending
11376 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11377 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11378 for DOS) file already exists, then the source file is simply discarded.
11380 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11381 scan the program and collect information about the functions it uses.
11382 So neither of these programs will work until GCC is installed.
11384 Here is a table of the options you can use with @code{protoize} and
11385 @code{unprotoize}.  Each option works with both programs unless
11386 otherwise stated.
11388 @table @code
11389 @item -B @var{directory}
11390 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11391 usual directory (normally @file{/usr/local/lib}).  This file contains
11392 prototype information about standard system functions.  This option
11393 applies only to @code{protoize}.
11395 @item -c @var{compilation-options}
11396 Use @var{compilation-options} as the options when running @command{gcc} to
11397 produce the @samp{.X} files.  The special option @option{-aux-info} is
11398 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11400 Note that the compilation options must be given as a single argument to
11401 @code{protoize} or @code{unprotoize}.  If you want to specify several
11402 @command{gcc} options, you must quote the entire set of compilation options
11403 to make them a single word in the shell.
11405 There are certain @command{gcc} arguments that you cannot use, because they
11406 would produce the wrong kind of output.  These include @option{-g},
11407 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11408 the @var{compilation-options}, they are ignored.
11410 @item -C
11411 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11412 systems) instead of @samp{.c}.  This is convenient if you are converting
11413 a C program to C++.  This option applies only to @code{protoize}.
11415 @item -g
11416 Add explicit global declarations.  This means inserting explicit
11417 declarations at the beginning of each source file for each function
11418 that is called in the file and was not declared.  These declarations
11419 precede the first function definition that contains a call to an
11420 undeclared function.  This option applies only to @code{protoize}.
11422 @item -i @var{string}
11423 Indent old-style parameter declarations with the string @var{string}.
11424 This option applies only to @code{protoize}.
11426 @code{unprotoize} converts prototyped function definitions to old-style
11427 function definitions, where the arguments are declared between the
11428 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11429 uses five spaces as the indentation.  If you want to indent with just
11430 one space instead, use @option{-i " "}.
11432 @item -k
11433 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11434 is finished.
11436 @item -l
11437 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11438 a prototype declaration for each function in each block which calls the
11439 function without any declaration.  This option applies only to
11440 @code{protoize}.
11442 @item -n
11443 Make no real changes.  This mode just prints information about the conversions
11444 that would have been done without @option{-n}.
11446 @item -N
11447 Make no @samp{.save} files.  The original files are simply deleted.
11448 Use this option with caution.
11450 @item -p @var{program}
11451 Use the program @var{program} as the compiler.  Normally, the name
11452 @file{gcc} is used.
11454 @item -q
11455 Work quietly.  Most warnings are suppressed.
11457 @item -v
11458 Print the version number, just like @option{-v} for @command{gcc}.
11459 @end table
11461 If you need special compiler options to compile one of your program's
11462 source files, then you should generate that file's @samp{.X} file
11463 specially, by running @command{gcc} on that source file with the
11464 appropriate options and the option @option{-aux-info}.  Then run
11465 @code{protoize} on the entire set of files.  @code{protoize} will use
11466 the existing @samp{.X} file because it is newer than the source file.
11467 For example:
11469 @example
11470 gcc -Dfoo=bar file1.c -aux-info file1.X
11471 protoize *.c
11472 @end example
11474 @noindent
11475 You need to include the special files along with the rest in the
11476 @code{protoize} command, even though their @samp{.X} files already
11477 exist, because otherwise they won't get converted.
11479 @xref{Protoize Caveats}, for more information on how to use
11480 @code{protoize} successfully.