Fix links in online manuals.
[official-gcc.git] / gcc / doc / invoke.texi
blobca71dde15c4e77c7aec9fa4f8eff4a8116b2c148
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
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs  -fexternal-templates @gol
178 -falt-external-templates @gol
179 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
180 -fno-implicit-templates @gol
181 -fno-implicit-inline-templates @gol
182 -fno-implement-inlines  -fms-extensions @gol
183 -fno-nonansi-builtins  -fno-operator-names @gol
184 -fno-optional-diags  -fpermissive @gol
185 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
186 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-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{-fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -Wextra  -Wall  -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
218 -Werror  -Werror-implicit-function-declaration @gol
219 -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security  -Wformat-y2k @gol
222 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
223 -Wimport  -Wno-import  -Winit-self  -Winline @gol
224 -Wno-invalid-offsetof  -Winvalid-pch @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces @gol
227 -Wmissing-format-attribute  -Wmissing-noreturn @gol
228 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
229 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
230 -Wreturn-type  -Wsequence-point  -Wshadow @gol
231 -Wsign-compare  -Wstrict-aliasing @gol
232 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
233 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
234 -Wunknown-pragmas  -Wunreachable-code @gol
235 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
236 -Wunused-value  -Wunused-variable  -Wwrite-strings}
238 @item C-only Warning Options
239 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
240 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
241 -Wstrict-prototypes  -Wtraditional @gol
242 -Wdeclaration-after-statement}
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
247 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
248 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
250 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
252 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
253 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
254 -frandom-seed=@var{string} -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{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
266 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
267 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
268 -fbranch-target-load-optimize2 -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  -fgcse-las  -floop-optimize @gol
274 -fcrossjumping  -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 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  @gol
291 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
292 -fsched2-use-superblocks @gol
293 -fsched2-use-traces  -fsignaling-nans @gol
294 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
295 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
296 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
297 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
298 --param @var{name}=@var{value}
299 -O  -O0  -O1  -O2  -O3  -Os}
301 @item Preprocessor Options
302 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
303 @gccoptlist{-A@var{question}=@var{answer} @gol
304 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
305 -C  -dD  -dI  -dM  -dN @gol
306 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
307 -idirafter @var{dir} @gol
308 -include @var{file}  -imacros @var{file} @gol
309 -iprefix @var{file}  -iwithprefix @var{dir} @gol
310 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
311 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
312 -P  -fworking-directory  -remap @gol
313 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
314 -Xpreprocessor @var{option}}
316 @item Assembler Option
317 @xref{Assembler Options,,Passing Options to the Assembler}.
318 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
320 @item Linker Options
321 @xref{Link Options,,Options for Linking}.
322 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
323 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
324 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
325 -Wl,@var{option}  -Xlinker @var{option} @gol
326 -u @var{symbol}}
328 @item Directory Options
329 @xref{Directory Options,,Options for Directory Search}.
330 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
332 @item Target Options
333 @c I wrote this xref this way to avoid overfull hbox. -- rms
334 @xref{Target Options}.
335 @gccoptlist{-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{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
342 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
343 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
344 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
345 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
347 @emph{M68hc1x Options}
348 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
349 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
350 -msoft-reg-count=@var{count}}
352 @emph{VAX Options}
353 @gccoptlist{-mg  -mgnu  -munix}
355 @emph{SPARC Options}
356 @gccoptlist{-mcpu=@var{cpu-type} @gol
357 -mtune=@var{cpu-type} @gol
358 -mcmodel=@var{code-model} @gol
359 -m32  -m64 @gol
360 -mapp-regs  -mbroken-saverestore  -mcypress @gol
361 -mfaster-structs  -mflat @gol
362 -mfpu  -mhard-float  -mhard-quad-float @gol
363 -mimpure-text  -mlittle-endian  -mlive-g0  -mno-app-regs @gol
364 -mno-faster-structs  -mno-flat  -mno-fpu @gol
365 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
366 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
367 -msupersparc  -munaligned-doubles  -mv8}
369 @emph{ARM Options}
370 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
371 -mapcs-26  -mapcs-32 @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -malignment-traps  -mno-alignment-traps @gol
378 -msoft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mabort-on-noreturn @gol
383 -mlong-calls  -mno-long-calls @gol
384 -msingle-pic-base  -mno-single-pic-base @gol
385 -mpic-register=@var{reg} @gol
386 -mnop-fun-dllimport @gol
387 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
388 -mpoke-function-name @gol
389 -mthumb  -marm @gol
390 -mtpcs-frame  -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking  -mcallee-super-interworking}
393 @emph{MN10200 Options}
394 @gccoptlist{-mrelax}
396 @emph{MN10300 Options}
397 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
398 -mam33  -mno-am33 @gol
399 -mam33-2  -mno-am33-2 @gol
400 -mno-crt0  -mrelax}
402 @emph{M32R/D Options}
403 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
404 -msdata=@var{sdata-type}  -G @var{num}}
406 @emph{M88K Options}
407 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
408 -mcheck-zero-division  -mhandle-large-shift @gol
409 -midentify-revision  -mno-check-zero-division @gol
410 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
411 -mno-optimize-arg-area  -mno-serialize-volatile @gol
412 -mno-underscores  -mocs-debug-info @gol
413 -mocs-frame-position  -moptimize-arg-area @gol
414 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
415 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
416 -mversion-03.00  -mwarn-passed-structs}
418 @emph{RS/6000 and PowerPC Options}
419 @gccoptlist{-mcpu=@var{cpu-type} @gol
420 -mtune=@var{cpu-type} @gol
421 -mpower  -mno-power  -mpower2  -mno-power2 @gol
422 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
423 -maltivec  -mno-altivec @gol
424 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
425 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
426 -mnew-mnemonics  -mold-mnemonics @gol
427 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
428 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
429 -malign-power  -malign-natural @gol
430 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
431 -mstring  -mno-string  -mupdate  -mno-update @gol
432 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
433 -mstrict-align  -mno-strict-align  -mrelocatable @gol
434 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
435 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
436 -mdynamic-no-pic @gol
437 -mprioritize-restricted-insns=@var{priority} @gol
438 -msched-costly-dep=@var{dependence_type} @gol
439 -minsert-sched-nops=@var{scheme} @gol
440 -mcall-sysv  -mcall-netbsd @gol
441 -maix-struct-return  -msvr4-struct-return @gol
442 -mabi=altivec  -mabi=no-altivec @gol
443 -mabi=spe  -mabi=no-spe @gol
444 -misel=yes  -misel=no @gol
445 -mspe=yes  -mspe=no @gol
446 -mfloat-gprs=yes  -mfloat-gprs=no @gol
447 -mprototype  -mno-prototype @gol
448 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
449 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
451 @emph{Darwin Options}
452 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
453 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
454 -client_name  -compatibility_version  -current_version @gol
455 -dependency-file  -dylib_file  -dylinker_install_name @gol
456 -dynamic  -dynamiclib  -exported_symbols_list @gol
457 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
458 -force_flat_namespace  -headerpad_max_install_names @gol
459 -image_base  -init  -install_name  -keep_private_externs @gol
460 -multi_module  -multiply_defined  -multiply_defined_unused @gol
461 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
462 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
463 -private_bundle  -read_only_relocs  -sectalign @gol
464 -sectobjectsymbols  -whyload  -seg1addr @gol
465 -sectcreate  -sectobjectsymbols  -sectorder @gol
466 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
467 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
468 -single_module  -static  -sub_library  -sub_umbrella @gol
469 -twolevel_namespace  -umbrella  -undefined @gol
470 -unexported_symbols_list  -weak_reference_mismatches @gol
471 -whatsloaded}
473 @emph{RT Options}
474 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
475 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
476 -mminimum-fp-blocks  -mnohc-struct-return}
478 @emph{MIPS Options}
479 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
480 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
481 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
482 -mgas  -mgp32  -mgp64  -mhard-float  -mint64  -mips1 @gol
483 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
484 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
485 -mmips-as  -mmips-tfile  -mno-abicalls  -mxgot @gol
486 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
487 -mno-embedded-pic  -mno-long-calls @gol
488 -mno-memcpy  -mno-mips-tfile  -mno-rnames @gol
489 -mrnames  -msoft-float @gol
490 -m4650  -msingle-float  -mmad @gol
491 -EL  -EB  -G @var{num}  -nocpp @gol
492 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
493 -mfix7000  -mfix-sb1  -mno-fix-sb1 @gol
494 -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
495 -mbranch-likely -mno-branch-likely}
497 @emph{i386 and x86-64 Options}
498 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
499 -mfpmath=@var{unit} @gol
500 -masm=@var{dialect}  -mno-fancy-math-387 @gol
501 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
502 -mno-wide-multiply  -mrtd  -malign-double @gol
503 -mpreferred-stack-boundary=@var{num} @gol
504 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
505 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
506 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
507 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
508 -mno-red-zone -mno-tls-direct-seg-refs @gol
509 -mcmodel=@var{code-model} @gol
510 -m32  -m64}
512 @emph{HPPA Options}
513 @gccoptlist{-march=@var{architecture-type} @gol
514 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
515 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
516 -mjump-in-delay -mlinker-opt -mlong-calls @gol
517 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
518 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
519 -mno-jump-in-delay  -mno-long-load-store @gol
520 -mno-portable-runtime  -mno-soft-float @gol
521 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
522 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
523 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
524 -nolibdld  -static  -threads}
526 @emph{Intel 960 Options}
527 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
528 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
529 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
530 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
531 -mno-complex-addr  -mno-leaf-procedures @gol
532 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
533 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
534 -mtail-call}
536 @emph{DEC Alpha Options}
537 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
538 -mieee  -mieee-with-inexact  -mieee-conformant @gol
539 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
540 -mtrap-precision=@var{mode}  -mbuild-constants @gol
541 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
542 -mbwx  -mmax  -mfix  -mcix @gol
543 -mfloat-vax  -mfloat-ieee @gol
544 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
545 -msmall-text  -mlarge-text @gol
546 -mmemory-latency=@var{time}}
548 @emph{DEC Alpha/VMS Options}
549 @gccoptlist{-mvms-return-codes}
551 @emph{H8/300 Options}
552 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
554 @emph{SH Options}
555 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
556 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
557 -m5-64media  -m5-64media-nofpu @gol
558 -m5-32media  -m5-32media-nofpu @gol
559 -m5-compact  -m5-compact-nofpu @gol
560 -mb  -ml  -mdalign  -mrelax @gol
561 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
562 -mieee  -misize  -mpadstruct  -mspace @gol
563 -mprefergot  -musermode}
565 @emph{System V Options}
566 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
568 @emph{ARC Options}
569 @gccoptlist{-EB  -EL @gol
570 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
571 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
573 @emph{TMS320C3x/C4x Options}
574 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
575 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
576 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
577 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
579 @emph{V850 Options}
580 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
581 -mprolog-function  -mno-prolog-function  -mspace @gol
582 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
583 -mapp-regs  -mno-app-regs @gol
584 -mdisable-callt  -mno-disable-callt @gol
585 -mv850e1 @gol
586 -mv850e @gol
587 -mv850  -mbig-switch}
589 @emph{NS32K Options}
590 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
591 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
592 -mregparam  -mnoregparam  -msb  -mnosb @gol
593 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
595 @emph{AVR Options}
596 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
597 -mcall-prologues  -mno-tablejump  -mtiny-stack}
599 @emph{MCore Options}
600 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
601 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
602 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
603 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
604 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
606 @emph{MMIX Options}
607 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
608 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
609 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
610 -mno-base-addresses  -msingle-exit  -mno-single-exit}
612 @emph{IA-64 Options}
613 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
614 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
615 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
616 -minline-float-divide-max-throughput @gol
617 -minline-int-divide-min-latency @gol
618 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
619 -mfixed-range=@var{register-range}}
621 @emph{D30V Options}
622 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
623 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
625 @emph{S/390 and zSeries Options}
626 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
627 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
628 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
629 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
631 @emph{CRIS Options}
632 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
633 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
634 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
635 -mstack-align  -mdata-align  -mconst-align @gol
636 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
637 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
639 @emph{PDP-11 Options}
640 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
641 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
642 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
643 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
644 -mbranch-expensive  -mbranch-cheap @gol
645 -msplit  -mno-split  -munix-asm  -mdec-asm}
647 @emph{Xstormy16 Options}
648 @gccoptlist{-msim}
650 @emph{Xtensa Options}
651 @gccoptlist{-mconst16 -mno-const16 @gol
652 -mfused-madd  -mno-fused-madd @gol
653 -mtext-section-literals  -mno-text-section-literals @gol
654 -mtarget-align  -mno-target-align @gol
655 -mlongcalls  -mno-longcalls}
657 @emph{FRV Options}
658 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
659 -mhard-float  -msoft-float @gol
660 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
661 -mdouble  -mno-double @gol
662 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
663 -mlibrary-pic  -macc-4 -macc-8 @gol
664 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
665 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
666 -mvliw-branch  -mno-vliw-branch @gol
667 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
668 -mno-nested-cond-exec  -mtomcat-stats @gol
669 -mcpu=@var{cpu}}
671 @item Code Generation Options
672 @xref{Code Gen Options,,Options for Code Generation Conventions}.
673 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
674 -ffixed-@var{reg}  -fexceptions @gol
675 -fnon-call-exceptions  -funwind-tables @gol
676 -fasynchronous-unwind-tables @gol
677 -finhibit-size-directive  -finstrument-functions @gol
678 -fno-common  -fno-ident  -fno-gnu-linker @gol
679 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
680 -freg-struct-return  -fshared-data  -fshort-enums @gol
681 -fshort-double  -fshort-wchar @gol
682 -fverbose-asm  -fpack-struct  -fstack-check @gol
683 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
684 -fargument-alias  -fargument-noalias @gol
685 -fargument-noalias-global  -fleading-underscore @gol
686 -ftls-model=@var{model} @gol
687 -ftrapv  -fwrapv  -fbounds-check}
688 @end table
690 @menu
691 * Overall Options::     Controlling the kind of output:
692                         an executable, object files, assembler files,
693                         or preprocessed source.
694 * C Dialect Options::   Controlling the variant of C language compiled.
695 * C++ Dialect Options:: Variations on C++.
696 * Objective-C Dialect Options:: Variations on Objective-C.
697 * Language Independent Options:: Controlling how diagnostics should be
698                         formatted.
699 * Warning Options::     How picky should the compiler be?
700 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
701 * Optimize Options::    How much optimization?
702 * Preprocessor Options:: Controlling header files and macro definitions.
703                          Also, getting dependency information for Make.
704 * Assembler Options::   Passing options to the assembler.
705 * Link Options::        Specifying libraries and so on.
706 * Directory Options::   Where to find header files and libraries.
707                         Where to find the compiler executable files.
708 * Spec Files::          How to pass switches to sub-processes.
709 * Target Options::      Running a cross-compiler, or an old version of GCC.
710 @end menu
712 @node Overall Options
713 @section Options Controlling the Kind of Output
715 Compilation can involve up to four stages: preprocessing, compilation
716 proper, assembly and linking, always in that order.  GCC is capable of
717 preprocessing and compiling several files either into several
718 assembler input files, or into one assembler input file; then each
719 assembler input file produces an object file, and linking combines all
720 the object files (those newly compiled, and those specified as input)
721 into an executable file.
723 @cindex file name suffix
724 For any given input file, the file name suffix determines what kind of
725 compilation is done:
727 @table @gcctabopt
728 @item @var{file}.c
729 C source code which must be preprocessed.
731 @item @var{file}.i
732 C source code which should not be preprocessed.
734 @item @var{file}.ii
735 C++ source code which should not be preprocessed.
737 @item @var{file}.m
738 Objective-C source code.  Note that you must link with the library
739 @file{libobjc.a} to make an Objective-C program work.
741 @item @var{file}.mi
742 Objective-C source code which should not be preprocessed.
744 @item @var{file}.h
745 C or C++ header file to be turned into a precompiled header.
747 @item @var{file}.cc
748 @itemx @var{file}.cp
749 @itemx @var{file}.cxx
750 @itemx @var{file}.cpp
751 @itemx @var{file}.CPP
752 @itemx @var{file}.c++
753 @itemx @var{file}.C
754 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
755 the last two letters must both be literally @samp{x}.  Likewise,
756 @samp{.C} refers to a literal capital C@.
758 @item @var{file}.hh
759 @itemx @var{file}.H
760 C++ header file to be turned into a precompiled header.
762 @item @var{file}.f
763 @itemx @var{file}.for
764 @itemx @var{file}.FOR
765 Fortran source code which should not be preprocessed.
767 @item @var{file}.F
768 @itemx @var{file}.fpp
769 @itemx @var{file}.FPP
770 Fortran source code which must be preprocessed (with the traditional
771 preprocessor).
773 @item @var{file}.r
774 Fortran source code which must be preprocessed with a RATFOR
775 preprocessor (not included with GCC)@.
777 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
778 Using and Porting GNU Fortran}, for more details of the handling of
779 Fortran input files.
781 @c FIXME: Descriptions of Java file types.
782 @c @var{file}.java
783 @c @var{file}.class
784 @c @var{file}.zip
785 @c @var{file}.jar
787 @item @var{file}.ads
788 Ada source code file which contains a library unit declaration (a
789 declaration of a package, subprogram, or generic, or a generic
790 instantiation), or a library unit renaming declaration (a package,
791 generic, or subprogram renaming declaration).  Such files are also
792 called @dfn{specs}.
794 @itemx @var{file}.adb
795 Ada source code file containing a library unit body (a subprogram or
796 package body).  Such files are also called @dfn{bodies}.
798 @c GCC also knows about some suffixes for languages not yet included:
799 @c Pascal:
800 @c @var{file}.p
801 @c @var{file}.pas
803 @item @var{file}.s
804 Assembler code.
806 @item @var{file}.S
807 Assembler code which must be preprocessed.
809 @item @var{other}
810 An object file to be fed straight into linking.
811 Any file name with no recognized suffix is treated this way.
812 @end table
814 @opindex x
815 You can specify the input language explicitly with the @option{-x} option:
817 @table @gcctabopt
818 @item -x @var{language}
819 Specify explicitly the @var{language} for the following input files
820 (rather than letting the compiler choose a default based on the file
821 name suffix).  This option applies to all following input files until
822 the next @option{-x} option.  Possible values for @var{language} are:
823 @example
824 c  c-header  cpp-output
825 c++  c++-header  c++-cpp-output
826 objective-c  objective-c-header  objc-cpp-output
827 assembler  assembler-with-cpp
829 f77  f77-cpp-input  ratfor
830 java
831 treelang
832 @end example
834 @item -x none
835 Turn off any specification of a language, so that subsequent files are
836 handled according to their file name suffixes (as they are if @option{-x}
837 has not been used at all).
839 @item -pass-exit-codes
840 @opindex pass-exit-codes
841 Normally the @command{gcc} program will exit with the code of 1 if any
842 phase of the compiler returns a non-success return code.  If you specify
843 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
844 numerically highest error produced by any phase that returned an error
845 indication.
846 @end table
848 If you only want some of the stages of compilation, you can use
849 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
850 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
851 @command{gcc} is to stop.  Note that some combinations (for example,
852 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
854 @table @gcctabopt
855 @item -c
856 @opindex c
857 Compile or assemble the source files, but do not link.  The linking
858 stage simply is not done.  The ultimate output is in the form of an
859 object file for each source file.
861 By default, the object file name for a source file is made by replacing
862 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
864 Unrecognized input files, not requiring compilation or assembly, are
865 ignored.
867 @item -S
868 @opindex S
869 Stop after the stage of compilation proper; do not assemble.  The output
870 is in the form of an assembler code file for each non-assembler input
871 file specified.
873 By default, the assembler file name for a source file is made by
874 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
876 Input files that don't require compilation are ignored.
878 @item -E
879 @opindex E
880 Stop after the preprocessing stage; do not run the compiler proper.  The
881 output is in the form of preprocessed source code, which is sent to the
882 standard output.
884 Input files which don't require preprocessing are ignored.
886 @cindex output file option
887 @item -o @var{file}
888 @opindex o
889 Place output in file @var{file}.  This applies regardless to whatever
890 sort of output is being produced, whether it be an executable file,
891 an object file, an assembler file or preprocessed C code.
893 If you specify @option{-o} when compiling more than one input file, or
894 you are producing an executable file as output, all the source files
895 on the command line will be compiled at once.
897 If @option{-o} is not specified, the default is to put an executable file
898 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
899 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
900 all preprocessed C source on standard output.
902 @item -v
903 @opindex v
904 Print (on standard error output) the commands executed to run the stages
905 of compilation.  Also print the version number of the compiler driver
906 program and of the preprocessor and the compiler proper.
908 @item -###
909 @opindex ###
910 Like @option{-v} except the commands are not executed and all command
911 arguments are quoted.  This is useful for shell scripts to capture the
912 driver-generated command lines.
914 @item -pipe
915 @opindex pipe
916 Use pipes rather than temporary files for communication between the
917 various stages of compilation.  This fails to work on some systems where
918 the assembler is unable to read from a pipe; but the GNU assembler has
919 no trouble.
921 @item --help
922 @opindex help
923 Print (on the standard output) a description of the command line options
924 understood by @command{gcc}.  If the @option{-v} option is also specified
925 then @option{--help} will also be passed on to the various processes
926 invoked by @command{gcc}, so that they can display the command line options
927 they accept.  If the @option{-Wextra} option is also specified then command
928 line options which have no documentation associated with them will also
929 be displayed.
931 @item --target-help
932 @opindex target-help
933 Print (on the standard output) a description of target specific command
934 line options for each tool.
936 @item --version
937 @opindex version
938 Display the version number and copyrights of the invoked GCC.
939 @end table
941 @node Invoking G++
942 @section Compiling C++ Programs
944 @cindex suffixes for C++ source
945 @cindex C++ source file suffixes
946 C++ source files conventionally use one of the suffixes @samp{.C},
947 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
948 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
949 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
950 files with these names and compiles them as C++ programs even if you
951 call the compiler the same way as for compiling C programs (usually
952 with the name @command{gcc}).
954 @findex g++
955 @findex c++
956 However, C++ programs often require class libraries as well as a
957 compiler that understands the C++ language---and under some
958 circumstances, you might want to compile programs or header files from
959 standard input, or otherwise without a suffix that flags them as C++
960 programs.  You might also like to precompile a C header file with a
961 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
962 program that calls GCC with the default language set to C++, and
963 automatically specifies linking against the C++ library.  On many
964 systems, @command{g++} is also installed with the name @command{c++}.
966 @cindex invoking @command{g++}
967 When you compile C++ programs, you may specify many of the same
968 command-line options that you use for compiling programs in any
969 language; or command-line options meaningful for C and related
970 languages; or options that are meaningful only for C++ programs.
971 @xref{C Dialect Options,,Options Controlling C Dialect}, for
972 explanations of options for languages related to C@.
973 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
974 explanations of options that are meaningful only for C++ programs.
976 @node C Dialect Options
977 @section Options Controlling C Dialect
978 @cindex dialect options
979 @cindex language dialect options
980 @cindex options, dialect
982 The following options control the dialect of C (or languages derived
983 from C, such as C++ and Objective-C) that the compiler accepts:
985 @table @gcctabopt
986 @cindex ANSI support
987 @cindex ISO support
988 @item -ansi
989 @opindex ansi
990 In C mode, support all ISO C90 programs.  In C++ mode,
991 remove GNU extensions that conflict with ISO C++.
993 This turns off certain features of GCC that are incompatible with ISO
994 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
995 such as the @code{asm} and @code{typeof} keywords, and
996 predefined macros such as @code{unix} and @code{vax} that identify the
997 type of system you are using.  It also enables the undesirable and
998 rarely used ISO trigraph feature.  For the C compiler,
999 it disables recognition of C++ style @samp{//} comments as well as
1000 the @code{inline} keyword.
1002 The alternate keywords @code{__asm__}, @code{__extension__},
1003 @code{__inline__} and @code{__typeof__} continue to work despite
1004 @option{-ansi}.  You would not want to use them in an ISO C program, of
1005 course, but it is useful to put them in header files that might be included
1006 in compilations done with @option{-ansi}.  Alternate predefined macros
1007 such as @code{__unix__} and @code{__vax__} are also available, with or
1008 without @option{-ansi}.
1010 The @option{-ansi} option does not cause non-ISO programs to be
1011 rejected gratuitously.  For that, @option{-pedantic} is required in
1012 addition to @option{-ansi}.  @xref{Warning Options}.
1014 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1015 option is used.  Some header files may notice this macro and refrain
1016 from declaring certain functions or defining certain macros that the
1017 ISO standard doesn't call for; this is to avoid interfering with any
1018 programs that might use these names for other things.
1020 Functions which would normally be built in but do not have semantics
1021 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1022 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1023 built-in functions provided by GCC}, for details of the functions
1024 affected.
1026 @item -std=
1027 @opindex std
1028 Determine the language standard.  This option is currently only
1029 supported when compiling C or C++.  A value for this option must be
1030 provided; possible values are
1032 @table @samp
1033 @item c89
1034 @itemx iso9899:1990
1035 ISO C90 (same as @option{-ansi}).
1037 @item iso9899:199409
1038 ISO C90 as modified in amendment 1.
1040 @item c99
1041 @itemx c9x
1042 @itemx iso9899:1999
1043 @itemx iso9899:199x
1044 ISO C99.  Note that this standard is not yet fully supported; see
1045 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1046 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1048 @item gnu89
1049 Default, ISO C90 plus GNU extensions (including some C99 features).
1051 @item gnu99
1052 @item gnu9x
1053 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1054 this will become the default.  The name @samp{gnu9x} is deprecated.
1056 @item c++98
1057 The 1998 ISO C++ standard plus amendments.
1059 @item gnu++98
1060 The same as @option{-std=c++98} plus GNU extensions.  This is the
1061 default for C++ code.
1062 @end table
1064 Even when this option is not specified, you can still use some of the
1065 features of newer standards in so far as they do not conflict with
1066 previous C standards.  For example, you may use @code{__restrict__} even
1067 when @option{-std=c99} is not specified.
1069 The @option{-std} options specifying some version of ISO C have the same
1070 effects as @option{-ansi}, except that features that were not in ISO C90
1071 but are in the specified version (for example, @samp{//} comments and
1072 the @code{inline} keyword in ISO C99) are not disabled.
1074 @xref{Standards,,Language Standards Supported by GCC}, for details of
1075 these standard versions.
1077 @item -aux-info @var{filename}
1078 @opindex aux-info
1079 Output to the given filename prototyped declarations for all functions
1080 declared and/or defined in a translation unit, including those in header
1081 files.  This option is silently ignored in any language other than C@.
1083 Besides declarations, the file indicates, in comments, the origin of
1084 each declaration (source file and line), whether the declaration was
1085 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1086 @samp{O} for old, respectively, in the first character after the line
1087 number and the colon), and whether it came from a declaration or a
1088 definition (@samp{C} or @samp{F}, respectively, in the following
1089 character).  In the case of function definitions, a K&R-style list of
1090 arguments followed by their declarations is also provided, inside
1091 comments, after the declaration.
1093 @item -fno-asm
1094 @opindex fno-asm
1095 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1096 keyword, so that code can use these words as identifiers.  You can use
1097 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1098 instead.  @option{-ansi} implies @option{-fno-asm}.
1100 In C++, this switch only affects the @code{typeof} keyword, since
1101 @code{asm} and @code{inline} are standard keywords.  You may want to
1102 use the @option{-fno-gnu-keywords} flag instead, which has the same
1103 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1104 switch only affects the @code{asm} and @code{typeof} keywords, since
1105 @code{inline} is a standard keyword in ISO C99.
1107 @item -fno-builtin
1108 @itemx -fno-builtin-@var{function}
1109 @opindex fno-builtin
1110 @cindex built-in functions
1111 Don't recognize built-in functions that do not begin with
1112 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1113 functions provided by GCC}, for details of the functions affected,
1114 including those which are not built-in functions when @option{-ansi} or
1115 @option{-std} options for strict ISO C conformance are used because they
1116 do not have an ISO standard meaning.
1118 GCC normally generates special code to handle certain built-in functions
1119 more efficiently; for instance, calls to @code{alloca} may become single
1120 instructions that adjust the stack directly, and calls to @code{memcpy}
1121 may become inline copy loops.  The resulting code is often both smaller
1122 and faster, but since the function calls no longer appear as such, you
1123 cannot set a breakpoint on those calls, nor can you change the behavior
1124 of the functions by linking with a different library.
1126 With the @option{-fno-builtin-@var{function}} option
1127 only the built-in function @var{function} is
1128 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1129 function is named this is not built-in in this version of GCC, this
1130 option is ignored.  There is no corresponding
1131 @option{-fbuiltin-@var{function}} option; if you wish to enable
1132 built-in functions selectively when using @option{-fno-builtin} or
1133 @option{-ffreestanding}, you may define macros such as:
1135 @smallexample
1136 #define abs(n)          __builtin_abs ((n))
1137 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1138 @end smallexample
1140 @item -fhosted
1141 @opindex fhosted
1142 @cindex hosted environment
1144 Assert that compilation takes place in a hosted environment.  This implies
1145 @option{-fbuiltin}.  A hosted environment is one in which the
1146 entire standard library is available, and in which @code{main} has a return
1147 type of @code{int}.  Examples are nearly everything except a kernel.
1148 This is equivalent to @option{-fno-freestanding}.
1150 @item -ffreestanding
1151 @opindex ffreestanding
1152 @cindex hosted environment
1154 Assert that compilation takes place in a freestanding environment.  This
1155 implies @option{-fno-builtin}.  A freestanding environment
1156 is one in which the standard library may not exist, and program startup may
1157 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1158 This is equivalent to @option{-fno-hosted}.
1160 @xref{Standards,,Language Standards Supported by GCC}, for details of
1161 freestanding and hosted environments.
1163 @item -fms-extensions
1164 @opindex fms-extensions
1165 Accept some non-standard constructs used in Microsoft header files.
1167 @item -trigraphs
1168 @opindex trigraphs
1169 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1170 options for strict ISO C conformance) implies @option{-trigraphs}.
1172 @item -no-integrated-cpp
1173 @opindex no-integrated-cpp
1174 Performs a compilation in two passes: preprocessing and compiling.  This
1175 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1176 @option{-B} option. The user supplied compilation step can then add in
1177 an additional preprocessing step after normal preprocessing but before
1178 compiling. The default is to use the integrated cpp (internal cpp)
1180 The semantics of this option will change if "cc1", "cc1plus", and
1181 "cc1obj" are merged.
1183 @cindex traditional C language
1184 @cindex C language, traditional
1185 @item -traditional
1186 @itemx -traditional-cpp
1187 @opindex traditional-cpp
1188 @opindex traditional
1189 Formerly, these options caused GCC to attempt to emulate a pre-standard
1190 C compiler.  They are now only supported with the @option{-E} switch.
1191 The preprocessor continues to support a pre-standard mode.  See the GNU
1192 CPP manual for details.
1194 @item -fcond-mismatch
1195 @opindex fcond-mismatch
1196 Allow conditional expressions with mismatched types in the second and
1197 third arguments.  The value of such an expression is void.  This option
1198 is not supported for C++.
1200 @item -funsigned-char
1201 @opindex funsigned-char
1202 Let the type @code{char} be unsigned, like @code{unsigned char}.
1204 Each kind of machine has a default for what @code{char} should
1205 be.  It is either like @code{unsigned char} by default or like
1206 @code{signed char} by default.
1208 Ideally, a portable program should always use @code{signed char} or
1209 @code{unsigned char} when it depends on the signedness of an object.
1210 But many programs have been written to use plain @code{char} and
1211 expect it to be signed, or expect it to be unsigned, depending on the
1212 machines they were written for.  This option, and its inverse, let you
1213 make such a program work with the opposite default.
1215 The type @code{char} is always a distinct type from each of
1216 @code{signed char} or @code{unsigned char}, even though its behavior
1217 is always just like one of those two.
1219 @item -fsigned-char
1220 @opindex fsigned-char
1221 Let the type @code{char} be signed, like @code{signed char}.
1223 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1224 the negative form of @option{-funsigned-char}.  Likewise, the option
1225 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1227 @item -fsigned-bitfields
1228 @itemx -funsigned-bitfields
1229 @itemx -fno-signed-bitfields
1230 @itemx -fno-unsigned-bitfields
1231 @opindex fsigned-bitfields
1232 @opindex funsigned-bitfields
1233 @opindex fno-signed-bitfields
1234 @opindex fno-unsigned-bitfields
1235 These options control whether a bit-field is signed or unsigned, when the
1236 declaration does not use either @code{signed} or @code{unsigned}.  By
1237 default, such a bit-field is signed, because this is consistent: the
1238 basic integer types such as @code{int} are signed types.
1240 @item -fwritable-strings
1241 @opindex fwritable-strings
1242 Store string constants in the writable data segment and don't uniquize
1243 them.  This is for compatibility with old programs which assume they can
1244 write into string constants.
1246 Writing into string constants is a very bad idea; ``constants'' should
1247 be constant.
1248 @end table
1250 @node C++ Dialect Options
1251 @section Options Controlling C++ Dialect
1253 @cindex compiler options, C++
1254 @cindex C++ options, command line
1255 @cindex options, C++
1256 This section describes the command-line options that are only meaningful
1257 for C++ programs; but you can also use most of the GNU compiler options
1258 regardless of what language your program is in.  For example, you
1259 might compile a file @code{firstClass.C} like this:
1261 @example
1262 g++ -g -frepo -O -c firstClass.C
1263 @end example
1265 @noindent
1266 In this example, only @option{-frepo} is an option meant
1267 only for C++ programs; you can use the other options with any
1268 language supported by GCC@.
1270 Here is a list of options that are @emph{only} for compiling C++ programs:
1272 @table @gcctabopt
1274 @item -fabi-version=@var{n}
1275 @opindex fabi-version
1276 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1277 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1278 version that conforms most closely to the C++ ABI specification.
1279 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1280 fixed.
1282 The default is version 1.
1284 @item -fno-access-control
1285 @opindex fno-access-control
1286 Turn off all access checking.  This switch is mainly useful for working
1287 around bugs in the access control code.
1289 @item -fcheck-new
1290 @opindex fcheck-new
1291 Check that the pointer returned by @code{operator new} is non-null
1292 before attempting to modify the storage allocated.  This check is
1293 normally unnecessary because the C++ standard specifies that
1294 @code{operator new} will only return @code{0} if it is declared
1295 @samp{throw()}, in which case the compiler will always check the
1296 return value even without this option.  In all other cases, when
1297 @code{operator new} has a non-empty exception specification, memory
1298 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1299 @samp{new (nothrow)}.
1301 @item -fconserve-space
1302 @opindex fconserve-space
1303 Put uninitialized or runtime-initialized global variables into the
1304 common segment, as C does.  This saves space in the executable at the
1305 cost of not diagnosing duplicate definitions.  If you compile with this
1306 flag and your program mysteriously crashes after @code{main()} has
1307 completed, you may have an object that is being destroyed twice because
1308 two definitions were merged.
1310 This option is no longer useful on most targets, now that support has
1311 been added for putting variables into BSS without making them common.
1313 @item -fno-const-strings
1314 @opindex fno-const-strings
1315 Give string constants type @code{char *} instead of type @code{const
1316 char *}.  By default, G++ uses type @code{const char *} as required by
1317 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1318 actually modify the value of a string constant, unless you also use
1319 @option{-fwritable-strings}.
1321 This option might be removed in a future release of G++.  For maximum
1322 portability, you should structure your code so that it works with
1323 string constants that have type @code{const char *}.
1325 @item -fno-elide-constructors
1326 @opindex fno-elide-constructors
1327 The C++ standard allows an implementation to omit creating a temporary
1328 which is only used to initialize another object of the same type.
1329 Specifying this option disables that optimization, and forces G++ to
1330 call the copy constructor in all cases.
1332 @item -fno-enforce-eh-specs
1333 @opindex fno-enforce-eh-specs
1334 Don't check for violation of exception specifications at runtime.  This
1335 option violates the C++ standard, but may be useful for reducing code
1336 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1337 will still optimize based on the exception specifications.
1339 @item -fexternal-templates
1340 @opindex fexternal-templates
1342 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1343 template instantiation; template instances are emitted or not according
1344 to the location of the template definition.  @xref{Template
1345 Instantiation}, for more information.
1347 This option is deprecated.
1349 @item -falt-external-templates
1350 @opindex falt-external-templates
1351 Similar to @option{-fexternal-templates}, but template instances are
1352 emitted or not according to the place where they are first instantiated.
1353 @xref{Template Instantiation}, for more information.
1355 This option is deprecated.
1357 @item -ffor-scope
1358 @itemx -fno-for-scope
1359 @opindex ffor-scope
1360 @opindex fno-for-scope
1361 If @option{-ffor-scope} is specified, the scope of variables declared in
1362 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1363 as specified by the C++ standard.
1364 If @option{-fno-for-scope} is specified, the scope of variables declared in
1365 a @i{for-init-statement} extends to the end of the enclosing scope,
1366 as was the case in old versions of G++, and other (traditional)
1367 implementations of C++.
1369 The default if neither flag is given to follow the standard,
1370 but to allow and give a warning for old-style code that would
1371 otherwise be invalid, or have different behavior.
1373 @item -fno-gnu-keywords
1374 @opindex fno-gnu-keywords
1375 Do not recognize @code{typeof} as a keyword, so that code can use this
1376 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1377 @option{-ansi} implies @option{-fno-gnu-keywords}.
1379 @item -fno-implicit-templates
1380 @opindex fno-implicit-templates
1381 Never emit code for non-inline templates which are instantiated
1382 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1383 @xref{Template Instantiation}, for more information.
1385 @item -fno-implicit-inline-templates
1386 @opindex fno-implicit-inline-templates
1387 Don't emit code for implicit instantiations of inline templates, either.
1388 The default is to handle inlines differently so that compiles with and
1389 without optimization will need the same set of explicit instantiations.
1391 @item -fno-implement-inlines
1392 @opindex fno-implement-inlines
1393 To save space, do not emit out-of-line copies of inline functions
1394 controlled by @samp{#pragma implementation}.  This will cause linker
1395 errors if these functions are not inlined everywhere they are called.
1397 @item -fms-extensions
1398 @opindex fms-extensions
1399 Disable pedantic warnings about constructs used in MFC, such as implicit
1400 int and getting a pointer to member function via non-standard syntax.
1402 @item -fno-nonansi-builtins
1403 @opindex fno-nonansi-builtins
1404 Disable built-in declarations of functions that are not mandated by
1405 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1406 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1408 @item -fno-operator-names
1409 @opindex fno-operator-names
1410 Do not treat the operator name keywords @code{and}, @code{bitand},
1411 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1412 synonyms as keywords.
1414 @item -fno-optional-diags
1415 @opindex fno-optional-diags
1416 Disable diagnostics that the standard says a compiler does not need to
1417 issue.  Currently, the only such diagnostic issued by G++ is the one for
1418 a name having multiple meanings within a class.
1420 @item -fpermissive
1421 @opindex fpermissive
1422 Downgrade some diagnostics about nonconformant code from errors to
1423 warnings.  Thus, using @option{-fpermissive} will allow some
1424 nonconforming code to compile.
1426 @item -frepo
1427 @opindex frepo
1428 Enable automatic template instantiation at link time.  This option also
1429 implies @option{-fno-implicit-templates}.  @xref{Template
1430 Instantiation}, for more information.
1432 @item -fno-rtti
1433 @opindex fno-rtti
1434 Disable generation of information about every class with virtual
1435 functions for use by the C++ runtime type identification features
1436 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1437 of the language, you can save some space by using this flag.  Note that
1438 exception handling uses the same information, but it will generate it as
1439 needed.
1441 @item -fstats
1442 @opindex fstats
1443 Emit statistics about front-end processing at the end of the compilation.
1444 This information is generally only useful to the G++ development team.
1446 @item -ftemplate-depth-@var{n}
1447 @opindex ftemplate-depth
1448 Set the maximum instantiation depth for template classes to @var{n}.
1449 A limit on the template instantiation depth is needed to detect
1450 endless recursions during template class instantiation.  ANSI/ISO C++
1451 conforming programs must not rely on a maximum depth greater than 17.
1453 @item -fuse-cxa-atexit
1454 @opindex fuse-cxa-atexit
1455 Register destructors for objects with static storage duration with the
1456 @code{__cxa_atexit} function rather than the @code{atexit} function.
1457 This option is required for fully standards-compliant handling of static
1458 destructors, but will only work if your C library supports
1459 @code{__cxa_atexit}.
1461 @item -fno-weak
1462 @opindex fno-weak
1463 Do not use weak symbol support, even if it is provided by the linker.
1464 By default, G++ will use weak symbols if they are available.  This
1465 option exists only for testing, and should not be used by end-users;
1466 it will result in inferior code and has no benefits.  This option may
1467 be removed in a future release of G++.
1469 @item -nostdinc++
1470 @opindex nostdinc++
1471 Do not search for header files in the standard directories specific to
1472 C++, but do still search the other standard directories.  (This option
1473 is used when building the C++ library.)
1474 @end table
1476 In addition, these optimization, warning, and code generation options
1477 have meanings only for C++ programs:
1479 @table @gcctabopt
1480 @item -fno-default-inline
1481 @opindex fno-default-inline
1482 Do not assume @samp{inline} for functions defined inside a class scope.
1483 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1484 functions will have linkage like inline functions; they just won't be
1485 inlined by default.
1487 @item -Wabi @r{(C++ only)}
1488 @opindex Wabi
1489 Warn when G++ generates code that is probably not compatible with the
1490 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1491 all such cases, there are probably some cases that are not warned about, 
1492 even though G++ is generating incompatible code.  There may also be
1493 cases where warnings are emitted even though the code that is generated
1494 will be compatible.
1496 You should rewrite your code to avoid these warnings if you are
1497 concerned about the fact that code generated by G++ may not be binary
1498 compatible with code generated by other compilers.
1500 The known incompatibilities at this point include:
1502 @itemize @bullet
1504 @item
1505 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1506 pack data into the same byte as a base class.  For example:
1508 @smallexample
1509 struct A @{ virtual void f(); int f1 : 1; @};
1510 struct B : public A @{ int f2 : 1; @};
1511 @end smallexample
1513 @noindent
1514 In this case, G++ will place @code{B::f2} into the same byte
1515 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1516 by explicitly padding @code{A} so that its size is a multiple of the
1517 byte size on your platform; that will cause G++ and other compilers to
1518 layout @code{B} identically.
1520 @item
1521 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1522 tail padding when laying out virtual bases.  For example:
1524 @smallexample
1525 struct A @{ virtual void f(); char c1; @};
1526 struct B @{ B(); char c2; @};
1527 struct C : public A, public virtual B @{@};
1528 @end smallexample
1530 @noindent
1531 In this case, G++ will not place @code{B} into the tail-padding for
1532 @code{A}; other compilers will.  You can avoid this problem by
1533 explicitly padding @code{A} so that its size is a multiple of its
1534 alignment (ignoring virtual base classes); that will cause G++ and other
1535 compilers to layout @code{C} identically.
1537 @item
1538 Incorrect handling of bit-fields with declared widths greater than that
1539 of their underlying types, when the bit-fields appear in a union.  For
1540 example:
1542 @smallexample
1543 union U @{ int i : 4096; @};
1544 @end smallexample
1546 @noindent
1547 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1548 union too small by the number of bits in an @code{int}.
1550 @item
1551 Empty classes can be placed at incorrect offsets.  For example:
1553 @smallexample
1554 struct A @{@};
1556 struct B @{
1557   A a;
1558   virtual void f ();
1561 struct C : public B, public A @{@};
1562 @end smallexample
1564 @noindent
1565 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1566 it should be placed at offset zero.  G++ mistakenly believes that the
1567 @code{A} data member of @code{B} is already at offset zero.
1569 @item
1570 Names of template functions whose types involve @code{typename} or
1571 template template parameters can be mangled incorrectly.
1573 @smallexample
1574 template <typename Q>
1575 void f(typename Q::X) @{@}
1577 template <template <typename> class Q>
1578 void f(typename Q<int>::X) @{@}
1579 @end smallexample
1581 @noindent
1582 Instantiations of these templates may be mangled incorrectly.
1584 @end itemize
1586 @item -Wctor-dtor-privacy @r{(C++ only)}
1587 @opindex Wctor-dtor-privacy
1588 Warn when a class seems unusable because all the constructors or
1589 destructors in that class are private, and it has neither friends nor
1590 public static member functions.
1592 @item -Wnon-virtual-dtor @r{(C++ only)}
1593 @opindex Wnon-virtual-dtor
1594 Warn when a class appears to be polymorphic, thereby requiring a virtual
1595 destructor, yet it declares a non-virtual one.
1596 This warning is enabled by @option{-Wall}.
1598 @item -Wreorder @r{(C++ only)}
1599 @opindex Wreorder
1600 @cindex reordering, warning
1601 @cindex warning for reordering of member initializers
1602 Warn when the order of member initializers given in the code does not
1603 match the order in which they must be executed.  For instance:
1605 @smallexample
1606 struct A @{
1607   int i;
1608   int j;
1609   A(): j (0), i (1) @{ @}
1611 @end smallexample
1613 The compiler will rearrange the member initializers for @samp{i}
1614 and @samp{j} to match the declaration order of the members, emitting
1615 a warning to that effect.  This warning is enabled by @option{-Wall}.
1616 @end table
1618 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1620 @table @gcctabopt
1621 @item -Weffc++ @r{(C++ only)}
1622 @opindex Weffc++
1623 Warn about violations of the following style guidelines from Scott Meyers'
1624 @cite{Effective C++} book:
1626 @itemize @bullet
1627 @item
1628 Item 11:  Define a copy constructor and an assignment operator for classes
1629 with dynamically allocated memory.
1631 @item
1632 Item 12:  Prefer initialization to assignment in constructors.
1634 @item
1635 Item 14:  Make destructors virtual in base classes.
1637 @item
1638 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1640 @item
1641 Item 23:  Don't try to return a reference when you must return an object.
1643 @end itemize
1645 Also warn about violations of the following style guidelines from 
1646 Scott Meyers' @cite{More Effective C++} book:
1648 @itemize @bullet
1649 @item
1650 Item 6:  Distinguish between prefix and postfix forms of increment and
1651 decrement operators.
1653 @item
1654 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1656 @end itemize
1658 When selecting this option, be aware that the standard library
1659 headers do not obey all of these guidelines; use @samp{grep -v}
1660 to filter out those warnings.
1662 @item -Wno-deprecated @r{(C++ only)}
1663 @opindex Wno-deprecated
1664 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1666 @item -Wno-non-template-friend @r{(C++ only)}
1667 @opindex Wno-non-template-friend
1668 Disable warnings when non-templatized friend functions are declared
1669 within a template.  Since the advent of explicit template specification
1670 support in G++, if the name of the friend is an unqualified-id (i.e.,
1671 @samp{friend foo(int)}), the C++ language specification demands that the
1672 friend declare or define an ordinary, nontemplate function.  (Section
1673 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1674 could be interpreted as a particular specialization of a templatized
1675 function.  Because this non-conforming behavior is no longer the default
1676 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1677 check existing code for potential trouble spots and is on by default.
1678 This new compiler behavior can be turned off with
1679 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1680 but disables the helpful warning.
1682 @item -Wold-style-cast @r{(C++ only)}
1683 @opindex Wold-style-cast
1684 Warn if an old-style (C-style) cast to a non-void type is used within
1685 a C++ program.  The new-style casts (@samp{static_cast},
1686 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1687 unintended effects and much easier to search for.
1689 @item -Woverloaded-virtual @r{(C++ only)}
1690 @opindex Woverloaded-virtual
1691 @cindex overloaded virtual fn, warning
1692 @cindex warning for overloaded virtual fn
1693 Warn when a function declaration hides virtual functions from a
1694 base class.  For example, in:
1696 @smallexample
1697 struct A @{
1698   virtual void f();
1701 struct B: public A @{
1702   void f(int);
1704 @end smallexample
1706 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1707 like:
1709 @smallexample
1710 B* b;
1711 b->f();
1712 @end smallexample
1714 will fail to compile.
1716 @item -Wno-pmf-conversions @r{(C++ only)}
1717 @opindex Wno-pmf-conversions
1718 Disable the diagnostic for converting a bound pointer to member function
1719 to a plain pointer.
1721 @item -Wsign-promo @r{(C++ only)}
1722 @opindex Wsign-promo
1723 Warn when overload resolution chooses a promotion from unsigned or
1724 enumeral type to a signed type, over a conversion to an unsigned type of
1725 the same size.  Previous versions of G++ would try to preserve
1726 unsignedness, but the standard mandates the current behavior.
1728 @item -Wsynth @r{(C++ only)}
1729 @opindex Wsynth
1730 @cindex warning for synthesized methods
1731 @cindex synthesized methods, warning
1732 Warn when G++'s synthesis behavior does not match that of cfront.  For
1733 instance:
1735 @smallexample
1736 struct A @{
1737   operator int ();
1738   A& operator = (int);
1741 main ()
1743   A a,b;
1744   a = b;
1746 @end smallexample
1748 In this example, G++ will synthesize a default @samp{A& operator =
1749 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1750 @end table
1752 @node Objective-C Dialect Options
1753 @section Options Controlling Objective-C Dialect
1755 @cindex compiler options, Objective-C
1756 @cindex Objective-C options, command line
1757 @cindex options, Objective-C
1758 (NOTE: This manual does not describe the Objective-C language itself.  See
1759 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1761 This section describes the command-line options that are only meaningful
1762 for Objective-C programs, but you can also use most of the GNU compiler
1763 options regardless of what language your program is in.  For example,
1764 you might compile a file @code{some_class.m} like this:
1766 @example
1767 gcc -g -fgnu-runtime -O -c some_class.m
1768 @end example
1770 @noindent
1771 In this example, @option{-fgnu-runtime} is an option meant only for
1772 Objective-C programs; you can use the other options with any language
1773 supported by GCC@.
1775 Here is a list of options that are @emph{only} for compiling Objective-C
1776 programs:
1778 @table @gcctabopt
1779 @item -fconstant-string-class=@var{class-name}
1780 @opindex fconstant-string-class
1781 Use @var{class-name} as the name of the class to instantiate for each
1782 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1783 class name is @code{NXConstantString} if the GNU runtime is being used, and
1784 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1785 @option{-fconstant-cfstrings} option, if also present, will override the
1786 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1787 to be laid out as constant CoreFoundation strings.
1789 @item -fgnu-runtime
1790 @opindex fgnu-runtime
1791 Generate object code compatible with the standard GNU Objective-C
1792 runtime.  This is the default for most types of systems.
1794 @item -fnext-runtime
1795 @opindex fnext-runtime
1796 Generate output compatible with the NeXT runtime.  This is the default
1797 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1798 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1799 used.
1801 @item -fno-nil-receivers
1802 @opindex -fno-nil-receivers
1803 Assume that all Objective-C message dispatches (e.g., 
1804 @code{[receiver message:arg]}) in this translation unit ensure that the receiver 
1805 is not @code{nil}.  This allows for more efficient entry points in the runtime to be 
1806 used.  Currently, this option is only available in conjunction with 
1807 the NeXT runtime on Mac OS X 10.3 and later.
1809 @item -fobjc-exceptions
1810 @opindex -fobjc-exceptions
1811 Enable syntactic support for structured exception handling in Objective-C, 
1812 similar to what is offered by C++ and Java.  Currently, this option is only 
1813 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. 
1815 @smallexample
1816   @@try @{
1817     @dots{}
1818        @@throw expr;
1819     @dots{}
1820   @}
1821   @@catch (AnObjCClass *exc) @{
1822     @dots{}
1823       @@throw expr;
1824     @dots{}
1825       @@throw;
1826     @dots{}
1827   @}
1828   @@catch (AnotherClass *exc) @{
1829     @dots{}
1830   @}
1831   @@catch (id allOthers) @{
1832     @dots{}
1833   @}
1834   @@finally @{
1835     @dots{}
1836       @@throw expr;
1837     @dots{}
1838   @}
1839 @end smallexample
1841 The @code{@@throw} statement may appear anywhere in an Objective-C or
1842 Objective-C++ program; when used inside of a @code{@@catch} block, the 
1843 @code{@@throw} may appear without an argument (as shown above), in which case 
1844 the object caught by the @code{@@catch} will be rethrown.
1846 Note that only (pointers to) Objective-C objects may be thrown and
1847 caught using this scheme.  When an object is thrown, it will be caught
1848 by the nearest @code{@@catch} clause capable of handling objects of that type,
1849 analogously to how @code{catch} blocks work in C++ and Java.  A 
1850 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch 
1851 any and all Objective-C exceptions not caught by previous @code{@@catch}
1852 clauses (if any).
1854 The @code{@@finally} clause, if present, will be executed upon exit from the
1855 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1856 regardless of whether any exceptions are thrown, caught or rethrown
1857 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1858 of the @code{finally} clause in Java.
1860 There are several caveats to using the new exception mechanism:
1862 @itemize @bullet
1863 @item
1864 Although currently designed to be binary compatible with @code{NS_HANDLER}-style 
1865 idioms provided by the @code{NSException} class, the new
1866 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1867 systems, due to additional functionality needed in the (NeXT) Objective-C
1868 runtime.
1870 @item
1871 As mentioned above, the new exceptions do not support handling
1872 types other than Objective-C objects.   Furthermore, when used from 
1873 Objective-C++, the Objective-C exception model does not interoperate with C++
1874 exceptions at this time.  This means you cannot @code{@@throw} an exception
1875 from Objective-C and @code{catch} it in C++, or vice versa 
1876 (i.e., @code{throw @dots{} @@catch}).
1877 @end itemize
1879 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1880 blocks for thread-safe execution:
1882 @smallexample
1883   @@synchronized (ObjCClass *guard) @{
1884     @dots{}
1885   @}
1886 @end smallexample
1888 Upon entering the @code{@@synchronized} block, a thread of execution shall
1889 first check whether a lock has been placed on the corresponding @code{guard}
1890 object by another thread.  If it has, the current thread shall wait until
1891 the other thread relinquishes its lock.  Once @code{guard} becomes available, 
1892 the current thread will place its own lock on it, execute the code contained in
1893 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1894 making @code{guard} available to other threads).
1896 Unlike Java, Objective-C does not allow for entire methods to be marked
1897 @code{@@synchronized}.  Note that throwing exceptions out of
1898 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1899 to be unlocked properly.
1901 @item -freplace-objc-classes
1902 @opindex -freplace-objc-classes
1903 Emit a special marker instructing @command{ld(1)} not to statically link in
1904 the resulting object file, and allow @command{dyld(1)} to load it in at
1905 run time instead.  This is used in conjunction with the Fix-and-Continue
1906 debugging mode, where the object file in question may be recompiled and 
1907 dynamically reloaded in the course of program execution, without the need
1908 to restart the program itself.  Currently, Fix-and-Continue functionality
1909 is only available in conjunction with the NeXT runtime on Mac OS X 10.3 
1910 and later.
1912 @item -fzero-link
1913 @opindex -fzero-link
1914 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1915 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1916 compile time) with static class references that get initialized at load time,
1917 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1918 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1919 to be retained.  This is useful in Zero-Link debugging mode, since it allows 
1920 for individual class implementations to be modified during program execution.
1922 @item -gen-decls
1923 @opindex gen-decls
1924 Dump interface declarations for all classes seen in the source file to a
1925 file named @file{@var{sourcename}.decl}.
1927 @item -Wno-protocol
1928 @opindex Wno-protocol
1929 If a class is declared to implement a protocol, a warning is issued for
1930 every method in the protocol that is not implemented by the class.  The
1931 default behavior is to issue a warning for every method not explicitly
1932 implemented in the class, even if a method implementation is inherited
1933 from the superclass.  If you use the @code{-Wno-protocol} option, then
1934 methods inherited from the superclass are considered to be implemented,
1935 and no warning is issued for them.
1937 @item -Wselector
1938 @opindex Wselector
1939 Warn if multiple methods of different types for the same selector are
1940 found during compilation.  The check is performed on the list of methods
1941 in the final stage of compilation.  Additionally, a check is performed
1942 for each selector appearing in a @code{@@selector(@dots{})}
1943 expression, and a corresponding method for that selector has been found
1944 during compilation.  Because these checks scan the method table only at
1945 the end of compilation, these warnings are not produced if the final
1946 stage of compilation is not reached, for example because an error is
1947 found during compilation, or because the @code{-fsyntax-only} option is
1948 being used.
1950 @item -Wundeclared-selector
1951 @opindex Wundeclared-selector
1952 Warn if a @code{@@selector(@dots{})} expression referring to an
1953 undeclared selector is found.  A selector is considered undeclared if no
1954 method with that name has been declared before the 
1955 @code{@@selector(@dots{})} expression, either explicitly in an
1956 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1957 an @code{@@implementation} section.  This option always performs its
1958 checks as soon as a @code{@@selector(@dots{})} expression is found,
1959 while @code{-Wselector} only performs its checks in the final stage of
1960 compilation.  This also enforces the coding style convention
1961 that methods and selectors must be declared before being used.
1963 @item -print-objc-runtime-info
1964 @opindex -print-objc-runtime-info
1965 Generate C header describing the largest structure that is passed by
1966 value, if any.
1968 @end table
1970 @node Language Independent Options
1971 @section Options to Control Diagnostic Messages Formatting
1972 @cindex options to control diagnostics formatting
1973 @cindex diagnostic messages
1974 @cindex message formatting
1976 Traditionally, diagnostic messages have been formatted irrespective of
1977 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1978 below can be used to control the diagnostic messages formatting
1979 algorithm, e.g.@: how many characters per line, how often source location
1980 information should be reported.  Right now, only the C++ front end can
1981 honor these options.  However it is expected, in the near future, that
1982 the remaining front ends would be able to digest them correctly.
1984 @table @gcctabopt
1985 @item -fmessage-length=@var{n}
1986 @opindex fmessage-length
1987 Try to format error messages so that they fit on lines of about @var{n}
1988 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1989 the front ends supported by GCC@.  If @var{n} is zero, then no
1990 line-wrapping will be done; each error message will appear on a single
1991 line.
1993 @opindex fdiagnostics-show-location
1994 @item -fdiagnostics-show-location=once
1995 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1996 reporter to emit @emph{once} source location information; that is, in
1997 case the message is too long to fit on a single physical line and has to
1998 be wrapped, the source location won't be emitted (as prefix) again,
1999 over and over, in subsequent continuation lines.  This is the default
2000 behavior.
2002 @item -fdiagnostics-show-location=every-line
2003 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2004 messages reporter to emit the same source location information (as
2005 prefix) for physical lines that result from the process of breaking
2006 a message which is too long to fit on a single line.
2008 @end table
2010 @node Warning Options
2011 @section Options to Request or Suppress Warnings
2012 @cindex options to control warnings
2013 @cindex warning messages
2014 @cindex messages, warning
2015 @cindex suppressing warnings
2017 Warnings are diagnostic messages that report constructions which
2018 are not inherently erroneous but which are risky or suggest there
2019 may have been an error.
2021 You can request many specific warnings with options beginning @samp{-W},
2022 for example @option{-Wimplicit} to request warnings on implicit
2023 declarations.  Each of these specific warning options also has a
2024 negative form beginning @samp{-Wno-} to turn off warnings;
2025 for example, @option{-Wno-implicit}.  This manual lists only one of the
2026 two forms, whichever is not the default.
2028 The following options control the amount and kinds of warnings produced
2029 by GCC; for further, language-specific options also refer to
2030 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2032 @table @gcctabopt
2033 @cindex syntax checking
2034 @item -fsyntax-only
2035 @opindex fsyntax-only
2036 Check the code for syntax errors, but don't do anything beyond that.
2038 @item -pedantic
2039 @opindex pedantic
2040 Issue all the warnings demanded by strict ISO C and ISO C++;
2041 reject all programs that use forbidden extensions, and some other
2042 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2043 version of the ISO C standard specified by any @option{-std} option used.
2045 Valid ISO C and ISO C++ programs should compile properly with or without
2046 this option (though a rare few will require @option{-ansi} or a
2047 @option{-std} option specifying the required version of ISO C)@.  However,
2048 without this option, certain GNU extensions and traditional C and C++
2049 features are supported as well.  With this option, they are rejected.
2051 @option{-pedantic} does not cause warning messages for use of the
2052 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2053 warnings are also disabled in the expression that follows
2054 @code{__extension__}.  However, only system header files should use
2055 these escape routes; application programs should avoid them.
2056 @xref{Alternate Keywords}.
2058 Some users try to use @option{-pedantic} to check programs for strict ISO
2059 C conformance.  They soon find that it does not do quite what they want:
2060 it finds some non-ISO practices, but not all---only those for which
2061 ISO C @emph{requires} a diagnostic, and some others for which
2062 diagnostics have been added.
2064 A feature to report any failure to conform to ISO C might be useful in
2065 some instances, but would require considerable additional work and would
2066 be quite different from @option{-pedantic}.  We don't have plans to
2067 support such a feature in the near future.
2069 Where the standard specified with @option{-std} represents a GNU
2070 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2071 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2072 extended dialect is based.  Warnings from @option{-pedantic} are given
2073 where they are required by the base standard.  (It would not make sense
2074 for such warnings to be given only for features not in the specified GNU
2075 C dialect, since by definition the GNU dialects of C include all
2076 features the compiler supports with the given option, and there would be
2077 nothing to warn about.)
2079 @item -pedantic-errors
2080 @opindex pedantic-errors
2081 Like @option{-pedantic}, except that errors are produced rather than
2082 warnings.
2084 @item -w
2085 @opindex w
2086 Inhibit all warning messages.
2088 @item -Wno-import
2089 @opindex Wno-import
2090 Inhibit warning messages about the use of @samp{#import}.
2092 @item -Wchar-subscripts
2093 @opindex Wchar-subscripts
2094 Warn if an array subscript has type @code{char}.  This is a common cause
2095 of error, as programmers often forget that this type is signed on some
2096 machines.
2098 @item -Wcomment
2099 @opindex Wcomment
2100 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2101 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2103 @item -Wformat
2104 @opindex Wformat
2105 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2106 the arguments supplied have types appropriate to the format string
2107 specified, and that the conversions specified in the format string make
2108 sense.  This includes standard functions, and others specified by format
2109 attributes (@pxref{Function Attributes}), in the @code{printf},
2110 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2111 not in the C standard) families.
2113 The formats are checked against the format features supported by GNU
2114 libc version 2.2.  These include all ISO C90 and C99 features, as well
2115 as features from the Single Unix Specification and some BSD and GNU
2116 extensions.  Other library implementations may not support all these
2117 features; GCC does not support warning about features that go beyond a
2118 particular library's limitations.  However, if @option{-pedantic} is used
2119 with @option{-Wformat}, warnings will be given about format features not
2120 in the selected standard version (but not for @code{strfmon} formats,
2121 since those are not in any version of the C standard).  @xref{C Dialect
2122 Options,,Options Controlling C Dialect}.
2124 Since @option{-Wformat} also checks for null format arguments for
2125 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2127 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2128 aspects of format checking, the options @option{-Wformat-y2k},
2129 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2130 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2131 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2133 @item -Wformat-y2k
2134 @opindex Wformat-y2k
2135 If @option{-Wformat} is specified, also warn about @code{strftime}
2136 formats which may yield only a two-digit year.
2138 @item -Wno-format-extra-args
2139 @opindex Wno-format-extra-args
2140 If @option{-Wformat} is specified, do not warn about excess arguments to a
2141 @code{printf} or @code{scanf} format function.  The C standard specifies
2142 that such arguments are ignored.
2144 Where the unused arguments lie between used arguments that are
2145 specified with @samp{$} operand number specifications, normally
2146 warnings are still given, since the implementation could not know what
2147 type to pass to @code{va_arg} to skip the unused arguments.  However,
2148 in the case of @code{scanf} formats, this option will suppress the
2149 warning if the unused arguments are all pointers, since the Single
2150 Unix Specification says that such unused arguments are allowed.
2152 @item -Wno-format-zero-length
2153 @opindex Wno-format-zero-length
2154 If @option{-Wformat} is specified, do not warn about zero-length formats.
2155 The C standard specifies that zero-length formats are allowed.
2157 @item -Wformat-nonliteral
2158 @opindex Wformat-nonliteral
2159 If @option{-Wformat} is specified, also warn if the format string is not a
2160 string literal and so cannot be checked, unless the format function
2161 takes its format arguments as a @code{va_list}.
2163 @item -Wformat-security
2164 @opindex Wformat-security
2165 If @option{-Wformat} is specified, also warn about uses of format
2166 functions that represent possible security problems.  At present, this
2167 warns about calls to @code{printf} and @code{scanf} functions where the
2168 format string is not a string literal and there are no format arguments,
2169 as in @code{printf (foo);}.  This may be a security hole if the format
2170 string came from untrusted input and contains @samp{%n}.  (This is
2171 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2172 in future warnings may be added to @option{-Wformat-security} that are not
2173 included in @option{-Wformat-nonliteral}.)
2175 @item -Wformat=2
2176 @opindex Wformat=2
2177 Enable @option{-Wformat} plus format checks not included in
2178 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2179 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2181 @item -Wnonnull
2182 @opindex Wnonnull
2183 Warn about passing a null pointer for arguments marked as
2184 requiring a non-null value by the @code{nonnull} function attribute.
2186 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2187 can be disabled with the @option{-Wno-nonnull} option.
2189 @item -Winit-self @r{(C, C++, and Objective-C only)} 
2190 @opindex Winit-self
2191 Warn about uninitialized variables which are initialized with themselves.
2192 Note this option can only be used with the @option{-Wuninitialized} option,
2193 which in turn only works with @option{-O1} and above.
2195 For example, GCC will warn about @code{i} being uninitialized in the
2196 following snippet only when @option{-Winit-self} has been specified:
2197 @smallexample
2198 @group
2199 int f()
2201   int i = i;
2202   return i;
2204 @end group
2205 @end smallexample
2207 @item -Wimplicit-int
2208 @opindex Wimplicit-int
2209 Warn when a declaration does not specify a type.
2211 @item -Wimplicit-function-declaration
2212 @itemx -Werror-implicit-function-declaration
2213 @opindex Wimplicit-function-declaration
2214 @opindex Werror-implicit-function-declaration
2215 Give a warning (or error) whenever a function is used before being
2216 declared.
2218 @item -Wimplicit
2219 @opindex Wimplicit
2220 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2222 @item -Wmain
2223 @opindex Wmain
2224 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2225 function with external linkage, returning int, taking either zero
2226 arguments, two, or three arguments of appropriate types.
2228 @item -Wmissing-braces
2229 @opindex Wmissing-braces
2230 Warn if an aggregate or union initializer is not fully bracketed.  In
2231 the following example, the initializer for @samp{a} is not fully
2232 bracketed, but that for @samp{b} is fully bracketed.
2234 @smallexample
2235 int a[2][2] = @{ 0, 1, 2, 3 @};
2236 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2237 @end smallexample
2239 @item -Wparentheses
2240 @opindex Wparentheses
2241 Warn if parentheses are omitted in certain contexts, such
2242 as when there is an assignment in a context where a truth value
2243 is expected, or when operators are nested whose precedence people
2244 often get confused about.
2246 Also warn about constructions where there may be confusion to which
2247 @code{if} statement an @code{else} branch belongs.  Here is an example of
2248 such a case:
2250 @smallexample
2251 @group
2253   if (a)
2254     if (b)
2255       foo ();
2256   else
2257     bar ();
2259 @end group
2260 @end smallexample
2262 In C, every @code{else} branch belongs to the innermost possible @code{if}
2263 statement, which in this example is @code{if (b)}.  This is often not
2264 what the programmer expected, as illustrated in the above example by
2265 indentation the programmer chose.  When there is the potential for this
2266 confusion, GCC will issue a warning when this flag is specified.
2267 To eliminate the warning, add explicit braces around the innermost
2268 @code{if} statement so there is no way the @code{else} could belong to
2269 the enclosing @code{if}.  The resulting code would look like this:
2271 @smallexample
2272 @group
2274   if (a)
2275     @{
2276       if (b)
2277         foo ();
2278       else
2279         bar ();
2280     @}
2282 @end group
2283 @end smallexample
2285 @item -Wsequence-point
2286 @opindex Wsequence-point
2287 Warn about code that may have undefined semantics because of violations
2288 of sequence point rules in the C standard.
2290 The C standard defines the order in which expressions in a C program are
2291 evaluated in terms of @dfn{sequence points}, which represent a partial
2292 ordering between the execution of parts of the program: those executed
2293 before the sequence point, and those executed after it.  These occur
2294 after the evaluation of a full expression (one which is not part of a
2295 larger expression), after the evaluation of the first operand of a
2296 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2297 function is called (but after the evaluation of its arguments and the
2298 expression denoting the called function), and in certain other places.
2299 Other than as expressed by the sequence point rules, the order of
2300 evaluation of subexpressions of an expression is not specified.  All
2301 these rules describe only a partial order rather than a total order,
2302 since, for example, if two functions are called within one expression
2303 with no sequence point between them, the order in which the functions
2304 are called is not specified.  However, the standards committee have
2305 ruled that function calls do not overlap.
2307 It is not specified when between sequence points modifications to the
2308 values of objects take effect.  Programs whose behavior depends on this
2309 have undefined behavior; the C standard specifies that ``Between the
2310 previous and next sequence point an object shall have its stored value
2311 modified at most once by the evaluation of an expression.  Furthermore,
2312 the prior value shall be read only to determine the value to be
2313 stored.''.  If a program breaks these rules, the results on any
2314 particular implementation are entirely unpredictable.
2316 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2317 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2318 diagnosed by this option, and it may give an occasional false positive
2319 result, but in general it has been found fairly effective at detecting
2320 this sort of problem in programs.
2322 The present implementation of this option only works for C programs.  A
2323 future implementation may also work for C++ programs.
2325 The C standard is worded confusingly, therefore there is some debate
2326 over the precise meaning of the sequence point rules in subtle cases.
2327 Links to discussions of the problem, including proposed formal
2328 definitions, may be found on our readings page, at
2329 @w{@uref{http://gcc.gnu.org/readings.html}}.
2331 @item -Wreturn-type
2332 @opindex Wreturn-type
2333 Warn whenever a function is defined with a return-type that defaults to
2334 @code{int}.  Also warn about any @code{return} statement with no
2335 return-value in a function whose return-type is not @code{void}.
2337 For C++, a function without return type always produces a diagnostic
2338 message, even when @option{-Wno-return-type} is specified.  The only
2339 exceptions are @samp{main} and functions defined in system headers.
2341 @item -Wswitch
2342 @opindex Wswitch
2343 Warn whenever a @code{switch} statement has an index of enumeral type
2344 and lacks a @code{case} for one or more of the named codes of that
2345 enumeration.  (The presence of a @code{default} label prevents this
2346 warning.)  @code{case} labels outside the enumeration range also
2347 provoke warnings when this option is used.
2349 @item -Wswitch-default
2350 @opindex Wswitch-switch
2351 Warn whenever a @code{switch} statement does not have a @code{default}
2352 case.
2354 @item -Wswitch-enum
2355 @opindex Wswitch-enum
2356 Warn whenever a @code{switch} statement has an index of enumeral type
2357 and lacks a @code{case} for one or more of the named codes of that
2358 enumeration.  @code{case} labels outside the enumeration range also
2359 provoke warnings when this option is used.
2361 @item -Wtrigraphs
2362 @opindex Wtrigraphs
2363 Warn if any trigraphs are encountered that might change the meaning of
2364 the program (trigraphs within comments are not warned about).
2366 @item -Wunused-function
2367 @opindex Wunused-function
2368 Warn whenever a static function is declared but not defined or a
2369 non\-inline static function is unused.
2371 @item -Wunused-label
2372 @opindex Wunused-label
2373 Warn whenever a label is declared but not used.
2375 To suppress this warning use the @samp{unused} attribute
2376 (@pxref{Variable Attributes}).
2378 @item -Wunused-parameter
2379 @opindex Wunused-parameter
2380 Warn whenever a function parameter is unused aside from its declaration.
2382 To suppress this warning use the @samp{unused} attribute
2383 (@pxref{Variable Attributes}).
2385 @item -Wunused-variable
2386 @opindex Wunused-variable
2387 Warn whenever a local variable or non-constant static variable is unused
2388 aside from its declaration
2390 To suppress this warning use the @samp{unused} attribute
2391 (@pxref{Variable Attributes}).
2393 @item -Wunused-value
2394 @opindex Wunused-value
2395 Warn whenever a statement computes a result that is explicitly not used.
2397 To suppress this warning cast the expression to @samp{void}.
2399 @item -Wunused
2400 @opindex Wunused
2401 All the above @option{-Wunused} options combined.
2403 In order to get a warning about an unused function parameter, you must
2404 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2405 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2407 @item -Wuninitialized
2408 @opindex Wuninitialized
2409 Warn if an automatic variable is used without first being initialized or
2410 if a variable may be clobbered by a @code{setjmp} call.
2412 These warnings are possible only in optimizing compilation,
2413 because they require data flow information that is computed only
2414 when optimizing.  If you don't specify @option{-O}, you simply won't
2415 get these warnings.
2417 If you want to warn about code which uses the uninitialized value of the
2418 variable in its own initializer, use the @option{-Winit-self} option.
2420 These warnings occur only for variables that are candidates for
2421 register allocation.  Therefore, they do not occur for a variable that
2422 is declared @code{volatile}, or whose address is taken, or whose size
2423 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2424 structures, unions or arrays, even when they are in registers.
2426 Note that there may be no warning about a variable that is used only
2427 to compute a value that itself is never used, because such
2428 computations may be deleted by data flow analysis before the warnings
2429 are printed.
2431 These warnings are made optional because GCC is not smart
2432 enough to see all the reasons why the code might be correct
2433 despite appearing to have an error.  Here is one example of how
2434 this can happen:
2436 @smallexample
2437 @group
2439   int x;
2440   switch (y)
2441     @{
2442     case 1: x = 1;
2443       break;
2444     case 2: x = 4;
2445       break;
2446     case 3: x = 5;
2447     @}
2448   foo (x);
2450 @end group
2451 @end smallexample
2453 @noindent
2454 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2455 always initialized, but GCC doesn't know this.  Here is
2456 another common case:
2458 @smallexample
2460   int save_y;
2461   if (change_y) save_y = y, y = new_y;
2462   @dots{}
2463   if (change_y) y = save_y;
2465 @end smallexample
2467 @noindent
2468 This has no bug because @code{save_y} is used only if it is set.
2470 @cindex @code{longjmp} warnings
2471 This option also warns when a non-volatile automatic variable might be
2472 changed by a call to @code{longjmp}.  These warnings as well are possible
2473 only in optimizing compilation.
2475 The compiler sees only the calls to @code{setjmp}.  It cannot know
2476 where @code{longjmp} will be called; in fact, a signal handler could
2477 call it at any point in the code.  As a result, you may get a warning
2478 even when there is in fact no problem because @code{longjmp} cannot
2479 in fact be called at the place which would cause a problem.
2481 Some spurious warnings can be avoided if you declare all the functions
2482 you use that never return as @code{noreturn}.  @xref{Function
2483 Attributes}.
2485 @item -Wunknown-pragmas
2486 @opindex Wunknown-pragmas
2487 @cindex warning for unknown pragmas
2488 @cindex unknown pragmas, warning
2489 @cindex pragmas, warning of unknown
2490 Warn when a #pragma directive is encountered which is not understood by
2491 GCC@.  If this command line option is used, warnings will even be issued
2492 for unknown pragmas in system header files.  This is not the case if
2493 the warnings were only enabled by the @option{-Wall} command line option.
2495 @item -Wstrict-aliasing
2496 @opindex Wstrict-aliasing
2497 This option is only active when @option{-fstrict-aliasing} is active.
2498 It warns about code which might break the strict aliasing rules that the
2499 compiler is using for optimization. The warning does not catch all
2500 cases, but does attempt to catch the more common pitfalls. It is
2501 included in @option{-Wall}.
2503 @item -Wall
2504 @opindex Wall
2505 All of the above @samp{-W} options combined.  This enables all the
2506 warnings about constructions that some users consider questionable, and
2507 that are easy to avoid (or modify to prevent the warning), even in
2508 conjunction with macros.  This also enables some language-specific
2509 warnings described in @ref{C++ Dialect Options} and
2510 @ref{Objective-C Dialect Options}.
2511 @end table
2513 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2514 Some of them warn about constructions that users generally do not
2515 consider questionable, but which occasionally you might wish to check
2516 for; others warn about constructions that are necessary or hard to avoid
2517 in some cases, and there is no simple way to modify the code to suppress
2518 the warning.
2520 @table @gcctabopt
2521 @item -Wextra
2522 @opindex W
2523 @opindex Wextra
2524 (This option used to be called @option{-W}.  The older name is still
2525 supported, but the newer name is more descriptive.)  Print extra warning
2526 messages for these events:
2528 @itemize @bullet
2529 @item
2530 A function can return either with or without a value.  (Falling
2531 off the end of the function body is considered returning without
2532 a value.)  For example, this function would evoke such a
2533 warning:
2535 @smallexample
2536 @group
2537 foo (a)
2539   if (a > 0)
2540     return a;
2542 @end group
2543 @end smallexample
2545 @item
2546 An expression-statement or the left-hand side of a comma expression
2547 contains no side effects.
2548 To suppress the warning, cast the unused expression to void.
2549 For example, an expression such as @samp{x[i,j]} will cause a warning,
2550 but @samp{x[(void)i,j]} will not.
2552 @item
2553 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2555 @item
2556 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2557 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2558 that of ordinary mathematical notation.
2560 @item
2561 Storage-class specifiers like @code{static} are not the first things in
2562 a declaration.  According to the C Standard, this usage is obsolescent.
2564 @item
2565 The return type of a function has a type qualifier such as @code{const}.
2566 Such a type qualifier has no effect, since the value returned by a
2567 function is not an lvalue.  (But don't warn about the GNU extension of
2568 @code{volatile void} return types.  That extension will be warned about
2569 if @option{-pedantic} is specified.)
2571 @item
2572 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2573 arguments.
2575 @item
2576 A comparison between signed and unsigned values could produce an
2577 incorrect result when the signed value is converted to unsigned.
2578 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2580 @item
2581 An aggregate has an initializer which does not initialize all members.
2582 For example, the following code would cause such a warning, because
2583 @code{x.h} would be implicitly initialized to zero:
2585 @smallexample
2586 struct s @{ int f, g, h; @};
2587 struct s x = @{ 3, 4 @};
2588 @end smallexample
2590 @item
2591 A function parameter is declared without a type specifier in K&R-style
2592 functions:
2594 @smallexample
2595 void foo(bar) @{ @}
2596 @end smallexample
2598 @item
2599 An empty body occurs in an @samp{if} or @samp{else} statement.
2601 @item
2602 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2603 @samp{>}, or @samp{>=}.
2605 @item
2606 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2608 @item
2609 Any of several floating-point events that often indicate errors, such as
2610 overflow, underflow, loss of precision, etc.
2612 @item @r{(C++ only)}
2613 An enumerator and a non-enumerator both appear in a conditional expression.
2615 @item @r{(C++ only)}
2616 A non-static reference or non-static @samp{const} member appears in a
2617 class without constructors.
2619 @item @r{(C++ only)}
2620 Ambiguous virtual bases.
2622 @item @r{(C++ only)}
2623 Subscripting an array which has been declared @samp{register}.
2625 @item @r{(C++ only)}
2626 Taking the address of a variable which has been declared @samp{register}.
2628 @item @r{(C++ only)}
2629 A base class is not initialized in a derived class' copy constructor.
2630 @end itemize
2632 @item -Wno-div-by-zero
2633 @opindex Wno-div-by-zero
2634 @opindex Wdiv-by-zero
2635 Do not warn about compile-time integer division by zero.  Floating point
2636 division by zero is not warned about, as it can be a legitimate way of
2637 obtaining infinities and NaNs.
2639 @item -Wsystem-headers
2640 @opindex Wsystem-headers
2641 @cindex warnings from system headers
2642 @cindex system headers, warnings from
2643 Print warning messages for constructs found in system header files.
2644 Warnings from system headers are normally suppressed, on the assumption
2645 that they usually do not indicate real problems and would only make the
2646 compiler output harder to read.  Using this command line option tells
2647 GCC to emit warnings from system headers as if they occurred in user
2648 code.  However, note that using @option{-Wall} in conjunction with this
2649 option will @emph{not} warn about unknown pragmas in system
2650 headers---for that, @option{-Wunknown-pragmas} must also be used.
2652 @item -Wfloat-equal
2653 @opindex Wfloat-equal
2654 Warn if floating point values are used in equality comparisons.
2656 The idea behind this is that sometimes it is convenient (for the
2657 programmer) to consider floating-point values as approximations to
2658 infinitely precise real numbers.  If you are doing this, then you need
2659 to compute (by analyzing the code, or in some other way) the maximum or
2660 likely maximum error that the computation introduces, and allow for it
2661 when performing comparisons (and when producing output, but that's a
2662 different problem).  In particular, instead of testing for equality, you
2663 would check to see whether the two values have ranges that overlap; and
2664 this is done with the relational operators, so equality comparisons are
2665 probably mistaken.
2667 @item -Wtraditional @r{(C only)}
2668 @opindex Wtraditional
2669 Warn about certain constructs that behave differently in traditional and
2670 ISO C@.  Also warn about ISO C constructs that have no traditional C
2671 equivalent, and/or problematic constructs which should be avoided.
2673 @itemize @bullet
2674 @item
2675 Macro parameters that appear within string literals in the macro body.
2676 In traditional C macro replacement takes place within string literals,
2677 but does not in ISO C@.
2679 @item
2680 In traditional C, some preprocessor directives did not exist.
2681 Traditional preprocessors would only consider a line to be a directive
2682 if the @samp{#} appeared in column 1 on the line.  Therefore
2683 @option{-Wtraditional} warns about directives that traditional C
2684 understands but would ignore because the @samp{#} does not appear as the
2685 first character on the line.  It also suggests you hide directives like
2686 @samp{#pragma} not understood by traditional C by indenting them.  Some
2687 traditional implementations would not recognize @samp{#elif}, so it
2688 suggests avoiding it altogether.
2690 @item
2691 A function-like macro that appears without arguments.
2693 @item
2694 The unary plus operator.
2696 @item
2697 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2698 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2699 constants.)  Note, these suffixes appear in macros defined in the system
2700 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2701 Use of these macros in user code might normally lead to spurious
2702 warnings, however gcc's integrated preprocessor has enough context to
2703 avoid warning in these cases.
2705 @item
2706 A function declared external in one block and then used after the end of
2707 the block.
2709 @item
2710 A @code{switch} statement has an operand of type @code{long}.
2712 @item
2713 A non-@code{static} function declaration follows a @code{static} one.
2714 This construct is not accepted by some traditional C compilers.
2716 @item
2717 The ISO type of an integer constant has a different width or
2718 signedness from its traditional type.  This warning is only issued if
2719 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2720 typically represent bit patterns, are not warned about.
2722 @item
2723 Usage of ISO string concatenation is detected.
2725 @item
2726 Initialization of automatic aggregates.
2728 @item
2729 Identifier conflicts with labels.  Traditional C lacks a separate
2730 namespace for labels.
2732 @item
2733 Initialization of unions.  If the initializer is zero, the warning is
2734 omitted.  This is done under the assumption that the zero initializer in
2735 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2736 initializer warnings and relies on default initialization to zero in the
2737 traditional C case.
2739 @item
2740 Conversions by prototypes between fixed/floating point values and vice
2741 versa.  The absence of these prototypes when compiling with traditional
2742 C would cause serious problems.  This is a subset of the possible
2743 conversion warnings, for the full set use @option{-Wconversion}.
2745 @item
2746 Use of ISO C style function definitions.  This warning intentionally is
2747 @emph{not} issued for prototype declarations or variadic functions
2748 because these ISO C features will appear in your code when using
2749 libiberty's traditional C compatibility macros, @code{PARAMS} and
2750 @code{VPARAMS}.  This warning is also bypassed for nested functions
2751 because that feature is already a gcc extension and thus not relevant to
2752 traditional C compatibility.
2753 @end itemize
2755 @item -Wdeclaration-after-statement @r{(C only)}
2756 @opindex Wdeclaration-after-statement
2757 Warn when a declaration is found after a statement in a block.  This
2758 construct, known from C++, was introduced with ISO C99 and is by default
2759 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2760 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2762 @item -Wundef
2763 @opindex Wundef
2764 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2766 @item -Wendif-labels
2767 @opindex Wendif-labels
2768 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2770 @item -Wshadow
2771 @opindex Wshadow
2772 Warn whenever a local variable shadows another local variable, parameter or
2773 global variable or whenever a built-in function is shadowed.
2775 @item -Wlarger-than-@var{len}
2776 @opindex Wlarger-than
2777 Warn whenever an object of larger than @var{len} bytes is defined.
2779 @item -Wpointer-arith
2780 @opindex Wpointer-arith
2781 Warn about anything that depends on the ``size of'' a function type or
2782 of @code{void}.  GNU C assigns these types a size of 1, for
2783 convenience in calculations with @code{void *} pointers and pointers
2784 to functions.
2786 @item -Wbad-function-cast @r{(C only)}
2787 @opindex Wbad-function-cast
2788 Warn whenever a function call is cast to a non-matching type.
2789 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2791 @item -Wcast-qual
2792 @opindex Wcast-qual
2793 Warn whenever a pointer is cast so as to remove a type qualifier from
2794 the target type.  For example, warn if a @code{const char *} is cast
2795 to an ordinary @code{char *}.
2797 @item -Wcast-align
2798 @opindex Wcast-align
2799 Warn whenever a pointer is cast such that the required alignment of the
2800 target is increased.  For example, warn if a @code{char *} is cast to
2801 an @code{int *} on machines where integers can only be accessed at
2802 two- or four-byte boundaries.
2804 @item -Wwrite-strings
2805 @opindex Wwrite-strings
2806 When compiling C, give string constants the type @code{const
2807 char[@var{length}]} so that
2808 copying the address of one into a non-@code{const} @code{char *}
2809 pointer will get a warning; when compiling C++, warn about the
2810 deprecated conversion from string constants to @code{char *}.
2811 These warnings will help you find at
2812 compile time code that can try to write into a string constant, but
2813 only if you have been very careful about using @code{const} in
2814 declarations and prototypes.  Otherwise, it will just be a nuisance;
2815 this is why we did not make @option{-Wall} request these warnings.
2817 @item -Wconversion
2818 @opindex Wconversion
2819 Warn if a prototype causes a type conversion that is different from what
2820 would happen to the same argument in the absence of a prototype.  This
2821 includes conversions of fixed point to floating and vice versa, and
2822 conversions changing the width or signedness of a fixed point argument
2823 except when the same as the default promotion.
2825 Also, warn if a negative integer constant expression is implicitly
2826 converted to an unsigned type.  For example, warn about the assignment
2827 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2828 casts like @code{(unsigned) -1}.
2830 @item -Wsign-compare
2831 @opindex Wsign-compare
2832 @cindex warning for comparison of signed and unsigned values
2833 @cindex comparison of signed and unsigned values, warning
2834 @cindex signed and unsigned values, comparison warning
2835 Warn when a comparison between signed and unsigned values could produce
2836 an incorrect result when the signed value is converted to unsigned.
2837 This warning is also enabled by @option{-Wextra}; to get the other warnings
2838 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2840 @item -Waggregate-return
2841 @opindex Waggregate-return
2842 Warn if any functions that return structures or unions are defined or
2843 called.  (In languages where you can return an array, this also elicits
2844 a warning.)
2846 @item -Wstrict-prototypes @r{(C only)}
2847 @opindex Wstrict-prototypes
2848 Warn if a function is declared or defined without specifying the
2849 argument types.  (An old-style function definition is permitted without
2850 a warning if preceded by a declaration which specifies the argument
2851 types.)
2853 @item -Wold-style-definition @r{(C only)}
2854 @opindex Wold-style-definition
2855 Warn if an old-style function definition is used.  A warning is given
2856 even if there is a previous prototype.
2858 @item -Wmissing-prototypes @r{(C only)}
2859 @opindex Wmissing-prototypes
2860 Warn if a global function is defined without a previous prototype
2861 declaration.  This warning is issued even if the definition itself
2862 provides a prototype.  The aim is to detect global functions that fail
2863 to be declared in header files.
2865 @item -Wmissing-declarations @r{(C only)}
2866 @opindex Wmissing-declarations
2867 Warn if a global function is defined without a previous declaration.
2868 Do so even if the definition itself provides a prototype.
2869 Use this option to detect global functions that are not declared in
2870 header files.
2872 @item -Wmissing-noreturn
2873 @opindex Wmissing-noreturn
2874 Warn about functions which might be candidates for attribute @code{noreturn}.
2875 Note these are only possible candidates, not absolute ones.  Care should
2876 be taken to manually verify functions actually do not ever return before
2877 adding the @code{noreturn} attribute, otherwise subtle code generation
2878 bugs could be introduced.  You will not get a warning for @code{main} in
2879 hosted C environments.
2881 @item -Wmissing-format-attribute
2882 @opindex Wmissing-format-attribute
2883 @opindex Wformat
2884 If @option{-Wformat} is enabled, also warn about functions which might be
2885 candidates for @code{format} attributes.  Note these are only possible
2886 candidates, not absolute ones.  GCC will guess that @code{format}
2887 attributes might be appropriate for any function that calls a function
2888 like @code{vprintf} or @code{vscanf}, but this might not always be the
2889 case, and some functions for which @code{format} attributes are
2890 appropriate may not be detected.  This option has no effect unless
2891 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2893 @item -Wno-multichar
2894 @opindex Wno-multichar
2895 @opindex Wmultichar
2896 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2897 Usually they indicate a typo in the user's code, as they have
2898 implementation-defined values, and should not be used in portable code.
2900 @item -Wno-deprecated-declarations
2901 @opindex Wno-deprecated-declarations
2902 Do not warn about uses of functions, variables, and types marked as
2903 deprecated by using the @code{deprecated} attribute.
2904 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2905 @pxref{Type Attributes}.)
2907 @item -Wpacked
2908 @opindex Wpacked
2909 Warn if a structure is given the packed attribute, but the packed
2910 attribute has no effect on the layout or size of the structure.
2911 Such structures may be mis-aligned for little benefit.  For
2912 instance, in this code, the variable @code{f.x} in @code{struct bar}
2913 will be misaligned even though @code{struct bar} does not itself
2914 have the packed attribute:
2916 @smallexample
2917 @group
2918 struct foo @{
2919   int x;
2920   char a, b, c, d;
2921 @} __attribute__((packed));
2922 struct bar @{
2923   char z;
2924   struct foo f;
2926 @end group
2927 @end smallexample
2929 @item -Wpadded
2930 @opindex Wpadded
2931 Warn if padding is included in a structure, either to align an element
2932 of the structure or to align the whole structure.  Sometimes when this
2933 happens it is possible to rearrange the fields of the structure to
2934 reduce the padding and so make the structure smaller.
2936 @item -Wredundant-decls
2937 @opindex Wredundant-decls
2938 Warn if anything is declared more than once in the same scope, even in
2939 cases where multiple declaration is valid and changes nothing.
2941 @item -Wnested-externs @r{(C only)}
2942 @opindex Wnested-externs
2943 Warn if an @code{extern} declaration is encountered within a function.
2945 @item -Wunreachable-code
2946 @opindex Wunreachable-code
2947 Warn if the compiler detects that code will never be executed.
2949 This option is intended to warn when the compiler detects that at
2950 least a whole line of source code will never be executed, because
2951 some condition is never satisfied or because it is after a
2952 procedure that never returns.
2954 It is possible for this option to produce a warning even though there
2955 are circumstances under which part of the affected line can be executed,
2956 so care should be taken when removing apparently-unreachable code.
2958 For instance, when a function is inlined, a warning may mean that the
2959 line is unreachable in only one inlined copy of the function.
2961 This option is not made part of @option{-Wall} because in a debugging
2962 version of a program there is often substantial code which checks
2963 correct functioning of the program and is, hopefully, unreachable
2964 because the program does work.  Another common use of unreachable
2965 code is to provide behavior which is selectable at compile-time.
2967 @item -Winline
2968 @opindex Winline
2969 Warn if a function can not be inlined and it was declared as inline.
2970 Even with this option, the compiler will not warn about failures to
2971 inline functions declared in system headers.  
2973 The compiler uses a variety of heuristics to determine whether or not
2974 to inline a function.  For example, the compiler takes into account
2975 the size of the function being inlined and the the amount of inlining
2976 that has already been done in the current function.  Therefore,
2977 seemingly insignificant changes in the source program can cause the
2978 warnings produced by @option{-Winline} to appear or disappear.
2980 @item -Wno-invalid-offsetof @r{(C++ only)}
2981 @opindex Wno-invalid-offsetof
2982 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2983 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2984 to a non-POD type is undefined.  In existing C++ implementations,
2985 however, @samp{offsetof} typically gives meaningful results even when
2986 applied to certain kinds of non-POD types. (Such as a simple
2987 @samp{struct} that fails to be a POD type only by virtue of having a
2988 constructor.)  This flag is for users who are aware that they are
2989 writing nonportable code and who have deliberately chosen to ignore the
2990 warning about it.
2992 The restrictions on @samp{offsetof} may be relaxed in a future version
2993 of the C++ standard.
2995 @item -Winvalid-pch
2996 @opindex Winvalid-pch
2997 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2998 the search path but can't be used.
3000 @item -Wlong-long
3001 @opindex Wlong-long
3002 @opindex Wno-long-long
3003 Warn if @samp{long long} type is used.  This is default.  To inhibit
3004 the warning messages, use @option{-Wno-long-long}.  Flags
3005 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3006 only when @option{-pedantic} flag is used.
3008 @item -Wdisabled-optimization
3009 @opindex Wdisabled-optimization
3010 Warn if a requested optimization pass is disabled.  This warning does
3011 not generally indicate that there is anything wrong with your code; it
3012 merely indicates that GCC's optimizers were unable to handle the code
3013 effectively.  Often, the problem is that your code is too big or too
3014 complex; GCC will refuse to optimize programs when the optimization
3015 itself is likely to take inordinate amounts of time.
3017 @item -Werror
3018 @opindex Werror
3019 Make all warnings into errors.
3020 @end table
3022 @node Debugging Options
3023 @section Options for Debugging Your Program or GCC
3024 @cindex options, debugging
3025 @cindex debugging information options
3027 GCC has various special options that are used for debugging
3028 either your program or GCC:
3030 @table @gcctabopt
3031 @item -g
3032 @opindex g
3033 Produce debugging information in the operating system's native format
3034 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3035 information.
3037 On most systems that use stabs format, @option{-g} enables use of extra
3038 debugging information that only GDB can use; this extra information
3039 makes debugging work better in GDB but will probably make other debuggers
3040 crash or
3041 refuse to read the program.  If you want to control for certain whether
3042 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3043 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
3044 or @option{-gvms} (see below).
3046 Unlike most other C compilers, GCC allows you to use @option{-g} with
3047 @option{-O}.  The shortcuts taken by optimized code may occasionally
3048 produce surprising results: some variables you declared may not exist
3049 at all; flow of control may briefly move where you did not expect it;
3050 some statements may not be executed because they compute constant
3051 results or their values were already at hand; some statements may
3052 execute in different places because they were moved out of loops.
3054 Nevertheless it proves possible to debug optimized output.  This makes
3055 it reasonable to use the optimizer for programs that might have bugs.
3057 The following options are useful when GCC is generated with the
3058 capability for more than one debugging format.
3060 @item -ggdb
3061 @opindex ggdb
3062 Produce debugging information for use by GDB@.  This means to use the
3063 most expressive format available (DWARF 2, stabs, or the native format
3064 if neither of those are supported), including GDB extensions if at all
3065 possible.
3067 @item -gstabs
3068 @opindex gstabs
3069 Produce debugging information in stabs format (if that is supported),
3070 without GDB extensions.  This is the format used by DBX on most BSD
3071 systems.  On MIPS, Alpha and System V Release 4 systems this option
3072 produces stabs debugging output which is not understood by DBX or SDB@.
3073 On System V Release 4 systems this option requires the GNU assembler.
3075 @item -feliminate-unused-debug-symbols
3076 @opindex feliminate-unused-debug-symbols
3077 Produce debugging information in stabs format (if that is supported),
3078 for only symbols that are actually used.
3080 @item -gstabs+
3081 @opindex gstabs+
3082 Produce debugging information in stabs format (if that is supported),
3083 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3084 use of these extensions is likely to make other debuggers crash or
3085 refuse to read the program.
3087 @item -gcoff
3088 @opindex gcoff
3089 Produce debugging information in COFF format (if that is supported).
3090 This is the format used by SDB on most System V systems prior to
3091 System V Release 4.
3093 @item -gxcoff
3094 @opindex gxcoff
3095 Produce debugging information in XCOFF format (if that is supported).
3096 This is the format used by the DBX debugger on IBM RS/6000 systems.
3098 @item -gxcoff+
3099 @opindex gxcoff+
3100 Produce debugging information in XCOFF format (if that is supported),
3101 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3102 use of these extensions is likely to make other debuggers crash or
3103 refuse to read the program, and may cause assemblers other than the GNU
3104 assembler (GAS) to fail with an error.
3106 @item -gdwarf
3107 @opindex gdwarf
3108 Produce debugging information in DWARF version 1 format (if that is
3109 supported).  This is the format used by SDB on most System V Release 4
3110 systems.
3112 This option is deprecated.
3114 @item -gdwarf+
3115 @opindex gdwarf+
3116 Produce debugging information in DWARF version 1 format (if that is
3117 supported), using GNU extensions understood only by the GNU debugger
3118 (GDB)@.  The use of these extensions is likely to make other debuggers
3119 crash or refuse to read the program.
3121 This option is deprecated.
3123 @item -gdwarf-2
3124 @opindex gdwarf-2
3125 Produce debugging information in DWARF version 2 format (if that is
3126 supported).  This is the format used by DBX on IRIX 6.
3128 @item -gvms
3129 @opindex gvms
3130 Produce debugging information in VMS debug format (if that is
3131 supported).  This is the format used by DEBUG on VMS systems.
3133 @item -g@var{level}
3134 @itemx -ggdb@var{level}
3135 @itemx -gstabs@var{level}
3136 @itemx -gcoff@var{level}
3137 @itemx -gxcoff@var{level}
3138 @itemx -gvms@var{level}
3139 Request debugging information and also use @var{level} to specify how
3140 much information.  The default level is 2.
3142 Level 1 produces minimal information, enough for making backtraces in
3143 parts of the program that you don't plan to debug.  This includes
3144 descriptions of functions and external variables, but no information
3145 about local variables and no line numbers.
3147 Level 3 includes extra information, such as all the macro definitions
3148 present in the program.  Some debuggers support macro expansion when
3149 you use @option{-g3}.
3151 Note that in order to avoid confusion between DWARF1 debug level 2,
3152 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
3153 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
3154 option to change the debug level for DWARF1 or DWARF2.
3156 @item -feliminate-dwarf2-dups
3157 @opindex feliminate-dwarf2-dups
3158 Compress DWARF2 debugging information by eliminating duplicated
3159 information about each symbol.  This option only makes sense when
3160 generating DWARF2 debugging information with @option{-gdwarf-2}.
3162 @cindex @command{prof}
3163 @item -p
3164 @opindex p
3165 Generate extra code to write profile information suitable for the
3166 analysis program @command{prof}.  You must use this option when compiling
3167 the source files you want data about, and you must also use it when
3168 linking.
3170 @cindex @command{gprof}
3171 @item -pg
3172 @opindex pg
3173 Generate extra code to write profile information suitable for the
3174 analysis program @command{gprof}.  You must use this option when compiling
3175 the source files you want data about, and you must also use it when
3176 linking.
3178 @item -Q
3179 @opindex Q
3180 Makes the compiler print out each function name as it is compiled, and
3181 print some statistics about each pass when it finishes.
3183 @item -ftime-report
3184 @opindex ftime-report
3185 Makes the compiler print some statistics about the time consumed by each
3186 pass when it finishes.
3188 @item -fmem-report
3189 @opindex fmem-report
3190 Makes the compiler print some statistics about permanent memory
3191 allocation when it finishes.
3193 @item -fprofile-arcs
3194 @opindex fprofile-arcs
3195 Add code so that program flow @dfn{arcs} are instrumented.  During
3196 execution the program records how many times each branch and call is
3197 executed and how many times it is taken or returns.  When the compiled
3198 program exits it saves this data to a file called
3199 @file{@var{auxname}.gcda} for each source file. The data may be used for
3200 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3201 test coverage analysis (@option{-ftest-coverage}). Each object file's
3202 @var{auxname} is generated from the name of the output file, if
3203 explicitly specified and it is not the final executable, otherwise it is
3204 the basename of the source file. In both cases any suffix is removed
3205 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3206 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3208 @itemize
3210 @item
3211 Compile the source files with @option{-fprofile-arcs} plus optimization
3212 and code generation options. For test coverage analysis, use the
3213 additional @option{-ftest-coverage} option. You do not need to profile
3214 every source file in a program.
3216 @item
3217 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3218 (the latter implies the former).
3220 @item
3221 Run the program on a representative workload to generate the arc profile
3222 information. This may be repeated any number of times. You can run
3223 concurrent instances of your program, and provided that the file system
3224 supports locking, the data files will be correctly updated. Also
3225 @code{fork} calls are detected and correctly handled (double counting
3226 will not happen).
3228 @item
3229 For profile-directed optimizations, compile the source files again with
3230 the same optimization and code generation options plus
3231 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3232 Control Optimization}).
3234 @item
3235 For test coverage analysis, use @command{gcov} to produce human readable
3236 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3237 @command{gcov} documentation for further information.
3239 @end itemize
3241 With @option{-fprofile-arcs}, for each function of your program GCC
3242 creates a program flow graph, then finds a spanning tree for the graph.
3243 Only arcs that are not on the spanning tree have to be instrumented: the
3244 compiler adds code to count the number of times that these arcs are
3245 executed.  When an arc is the only exit or only entrance to a block, the
3246 instrumentation code can be added to the block; otherwise, a new basic
3247 block must be created to hold the instrumentation code.
3249 @need 2000
3250 @item -ftest-coverage
3251 @opindex ftest-coverage
3252 Produce a notes file that the @command{gcov} code-coverage utility
3253 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3254 show program coverage. Each source file's note file is called
3255 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3256 above for a description of @var{auxname} and instructions on how to
3257 generate test coverage data. Coverage data will match the source files
3258 more closely, if you do not optimize.
3260 @item -d@var{letters}
3261 @opindex d
3262 Says to make debugging dumps during compilation at times specified by
3263 @var{letters}.  This is used for debugging the compiler.  The file names
3264 for most of the dumps are made by appending a pass number and a word to
3265 the @var{dumpname}. @var{dumpname} is generated from the name of the
3266 output file, if explicitly specified and it is not an executable,
3267 otherwise it is the basename of the source file. In both cases any
3268 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3269 Here are the possible letters for use in @var{letters}, and their
3270 meanings:
3272 @table @samp
3273 @item A
3274 @opindex dA
3275 Annotate the assembler output with miscellaneous debugging information.
3276 @item b
3277 @opindex db
3278 Dump after computing branch probabilities, to @file{@var{file}.16.bp}.
3279 @item B
3280 @opindex dB
3281 Dump after block reordering, to @file{@var{file}.32.bbro}.
3282 @item c
3283 @opindex dc
3284 Dump after instruction combination, to the file @file{@var{file}.22.combine}.
3285 @item C
3286 @opindex dC
3287 Dump after the first if conversion, to the file @file{@var{file}.17.ce1}.
3288 Also dump after the second if conversion, to the file @file{@var{file}.23.ce2}.
3289 @item d
3290 @opindex dd
3291 Dump after branch target load optimization, to to @file{@var{file}.34.btl}.
3292 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3293 @item D
3294 @opindex dD
3295 Dump all macro definitions, at the end of preprocessing, in addition to
3296 normal output.
3297 @item e
3298 @opindex de
3299 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
3300 @file{@var{file}.010.ussa}.
3301 @item E
3302 @opindex dE
3303 Dump after the second if conversion, to @file{@var{file}.33.ce3}.
3304 @item f
3305 @opindex df
3306 Dump after control and data flow analysis, to @file{@var{file}.15.cfg}.
3307 Also dump after life analysis, to @file{@var{file}.21.life}.
3308 @item F
3309 @opindex dF
3310 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.11.addressof}.
3311 @item g
3312 @opindex dg
3313 Dump after global register allocation, to @file{@var{file}.27.greg}.
3314 @item G
3315 @opindex dG
3316 Dump after GCSE, to @file{@var{file}.12.gcse}.
3317 Also dump after jump bypassing and control flow optimizations, to
3318 @file{@var{file}.14.bypass}.
3319 @item h
3320 @opindex dh
3321 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3322 @item i
3323 @opindex di
3324 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3325 @item j
3326 @opindex dj
3327 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3328 @item k
3329 @opindex dk
3330 Dump after conversion from registers to stack, to @file{@var{file}.36.stack}.
3331 @item l
3332 @opindex dl
3333 Dump after local register allocation, to @file{@var{file}.26.lreg}.
3334 @item L
3335 @opindex dL
3336 Dump after loop optimization passes, to @file{@var{file}.13.loop} and
3337 @file{@var{file}.19.loop2}.
3338 @item M
3339 @opindex dM
3340 Dump after performing the machine dependent reorganization pass, to
3341 @file{@var{file}.37.mach}.
3342 @item n
3343 @opindex dn
3344 Dump after register renumbering, to @file{@var{file}.31.rnreg}.
3345 @item N
3346 @opindex dN
3347 Dump after the register move pass, to @file{@var{file}.24.regmove}.
3348 @item o
3349 @opindex do
3350 Dump after post-reload optimizations, to @file{@var{file}.28.postreload}.
3351 @item r
3352 @opindex dr
3353 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3354 @item R
3355 @opindex dR
3356 Dump after the second scheduling pass, to @file{@var{file}.35.sched2}.
3357 @item s
3358 @opindex ds
3359 Dump after CSE (including the jump optimization that sometimes follows
3360 CSE), to @file{@var{file}.019.cse}.
3361 @item S
3362 @opindex dS
3363 Dump after the first scheduling pass, to @file{@var{file}.25.sched}.
3364 @item t
3365 @opindex dt
3366 Dump after the second CSE pass (including the jump optimization that
3367 sometimes follows CSE), to @file{@var{file}.20.cse2}.
3368 @item T
3369 @opindex dT
3370 Dump after running tracer, to @file{@var{file}.18.tracer}.
3371 @item u
3372 @opindex du
3373 Dump after null pointer elimination pass to @file{@var{file}.018.null}.
3374 @item U
3375 @opindex dU
3376 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3377 @item w
3378 @opindex dw
3379 Dump after the second flow pass, to @file{@var{file}.29.flow2}.
3380 @item W
3381 @opindex dW
3382 Dump after SSA conditional constant propagation, to
3383 @file{@var{file}.06.ssaccp}.
3384 @item X
3385 @opindex dX
3386 Dump after SSA dead code elimination, to @file{@var{file}.07.ssadce}.
3387 @item z
3388 @opindex dz
3389 Dump after the peephole pass, to @file{@var{file}.30.peephole2}.
3390 @item a
3391 @opindex da
3392 Produce all the dumps listed above.
3393 @item H
3394 @opindex dH
3395 Produce a core dump whenever an error occurs.
3396 @item m
3397 @opindex dm
3398 Print statistics on memory usage, at the end of the run, to
3399 standard error.
3400 @item p
3401 @opindex dp
3402 Annotate the assembler output with a comment indicating which
3403 pattern and alternative was used.  The length of each instruction is
3404 also printed.
3405 @item P
3406 @opindex dP
3407 Dump the RTL in the assembler output as a comment before each instruction.
3408 Also turns on @option{-dp} annotation.
3409 @item v
3410 @opindex dv
3411 For each of the other indicated dump files (except for
3412 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3413 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3414 @item x
3415 @opindex dx
3416 Just generate RTL for a function instead of compiling it.  Usually used
3417 with @samp{r}.
3418 @item y
3419 @opindex dy
3420 Dump debugging information during parsing, to standard error.
3421 @end table
3423 @item -fdump-unnumbered
3424 @opindex fdump-unnumbered
3425 When doing debugging dumps (see @option{-d} option above), suppress instruction
3426 numbers and line number note output.  This makes it more feasible to
3427 use diff on debugging dumps for compiler invocations with different
3428 options, in particular with and without @option{-g}.
3430 @item -fdump-translation-unit @r{(C and C++ only)}
3431 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3432 @opindex fdump-translation-unit
3433 Dump a representation of the tree structure for the entire translation
3434 unit to a file.  The file name is made by appending @file{.tu} to the
3435 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3436 controls the details of the dump as described for the
3437 @option{-fdump-tree} options.
3439 @item -fdump-class-hierarchy @r{(C++ only)}
3440 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3441 @opindex fdump-class-hierarchy
3442 Dump a representation of each class's hierarchy and virtual function
3443 table layout to a file.  The file name is made by appending @file{.class}
3444 to the source file name.  If the @samp{-@var{options}} form is used,
3445 @var{options} controls the details of the dump as described for the
3446 @option{-fdump-tree} options.
3448 @item -fdump-tree-@var{switch} @r{(C++ only)}
3449 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3450 @opindex fdump-tree
3451 Control the dumping at various stages of processing the intermediate
3452 language tree to a file.  The file name is generated by appending a switch
3453 specific suffix to the source file name.  If the @samp{-@var{options}}
3454 form is used, @var{options} is a list of @samp{-} separated options that
3455 control the details of the dump. Not all options are applicable to all
3456 dumps, those which are not meaningful will be ignored. The following
3457 options are available
3459 @table @samp
3460 @item address
3461 Print the address of each node.  Usually this is not meaningful as it
3462 changes according to the environment and source file. Its primary use
3463 is for tying up a dump file with a debug environment.
3464 @item slim
3465 Inhibit dumping of members of a scope or body of a function merely
3466 because that scope has been reached. Only dump such items when they
3467 are directly reachable by some other path.
3468 @item all
3469 Turn on all options.
3470 @end table
3472 The following tree dumps are possible:
3473 @table @samp
3474 @item original
3475 Dump before any tree based optimization, to @file{@var{file}.original}.
3476 @item optimized
3477 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3478 @item inlined
3479 Dump after function inlining, to @file{@var{file}.inlined}.
3480 @end table
3482 @item -frandom-seed=@var{string}
3483 @opindex frandom-string
3484 This option provides a seed that GCC uses when it would otherwise use
3485 random numbers.  It is used to generate certain symbol names
3486 that have to be different in every compiled file. It is also used to
3487 place unique stamps in coverage data files and the object files that
3488 produce them. You can use the @option{-frandom-seed} option to produce
3489 reproducibly identical object files.
3491 The @var{string} should be different for every file you compile.
3493 @item -fsched-verbose=@var{n}
3494 @opindex fsched-verbose
3495 On targets that use instruction scheduling, this option controls the
3496 amount of debugging output the scheduler prints.  This information is
3497 written to standard error, unless @option{-dS} or @option{-dR} is
3498 specified, in which case it is output to the usual dump
3499 listing file, @file{.sched} or @file{.sched2} respectively.  However
3500 for @var{n} greater than nine, the output is always printed to standard
3501 error.
3503 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3504 same information as @option{-dRS}.  For @var{n} greater than one, it
3505 also output basic block probabilities, detailed ready list information
3506 and unit/insn info.  For @var{n} greater than two, it includes RTL
3507 at abort point, control-flow and regions info.  And for @var{n} over
3508 four, @option{-fsched-verbose} also includes dependence info.
3510 @item -save-temps
3511 @opindex save-temps
3512 Store the usual ``temporary'' intermediate files permanently; place them
3513 in the current directory and name them based on the source file.  Thus,
3514 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3515 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3516 preprocessed @file{foo.i} output file even though the compiler now
3517 normally uses an integrated preprocessor.
3519 @item -time
3520 @opindex time
3521 Report the CPU time taken by each subprocess in the compilation
3522 sequence.  For C source files, this is the compiler proper and assembler
3523 (plus the linker if linking is done).  The output looks like this:
3525 @smallexample
3526 # cc1 0.12 0.01
3527 # as 0.00 0.01
3528 @end smallexample
3530 The first number on each line is the ``user time,'' that is time spent
3531 executing the program itself.  The second number is ``system time,''
3532 time spent executing operating system routines on behalf of the program.
3533 Both numbers are in seconds.
3535 @item -print-file-name=@var{library}
3536 @opindex print-file-name
3537 Print the full absolute name of the library file @var{library} that
3538 would be used when linking---and don't do anything else.  With this
3539 option, GCC does not compile or link anything; it just prints the
3540 file name.
3542 @item -print-multi-directory
3543 @opindex print-multi-directory
3544 Print the directory name corresponding to the multilib selected by any
3545 other switches present in the command line.  This directory is supposed
3546 to exist in @env{GCC_EXEC_PREFIX}.
3548 @item -print-multi-lib
3549 @opindex print-multi-lib
3550 Print the mapping from multilib directory names to compiler switches
3551 that enable them.  The directory name is separated from the switches by
3552 @samp{;}, and each switch starts with an @samp{@@} instead of the
3553 @samp{-}, without spaces between multiple switches.  This is supposed to
3554 ease shell-processing.
3556 @item -print-prog-name=@var{program}
3557 @opindex print-prog-name
3558 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3560 @item -print-libgcc-file-name
3561 @opindex print-libgcc-file-name
3562 Same as @option{-print-file-name=libgcc.a}.
3564 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3565 but you do want to link with @file{libgcc.a}.  You can do
3567 @example
3568 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3569 @end example
3571 @item -print-search-dirs
3572 @opindex print-search-dirs
3573 Print the name of the configured installation directory and a list of
3574 program and library directories gcc will search---and don't do anything else.
3576 This is useful when gcc prints the error message
3577 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3578 To resolve this you either need to put @file{cpp0} and the other compiler
3579 components where gcc expects to find them, or you can set the environment
3580 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3581 Don't forget the trailing '/'.
3582 @xref{Environment Variables}.
3584 @item -dumpmachine
3585 @opindex dumpmachine
3586 Print the compiler's target machine (for example,
3587 @samp{i686-pc-linux-gnu})---and don't do anything else.
3589 @item -dumpversion
3590 @opindex dumpversion
3591 Print the compiler version (for example, @samp{3.0})---and don't do
3592 anything else.
3594 @item -dumpspecs
3595 @opindex dumpspecs
3596 Print the compiler's built-in specs---and don't do anything else.  (This
3597 is used when GCC itself is being built.)  @xref{Spec Files}.
3599 @item -feliminate-unused-debug-types
3600 @opindex feliminate-unused-debug-types
3601 Normally, when producing DWARF2 output, GCC will emit debugging
3602 information for all types declared in a compilation
3603 unit, regardless of whether or not they are actually used
3604 in that compilation unit.  Sometimes this is useful, such as
3605 if, in the debugger, you want to cast a value to a type that is
3606 not actually used in your program (but is declared).  More often,
3607 however, this results in a significant amount of wasted space.
3608 With this option, GCC will avoid producing debug symbol output
3609 for types that are nowhere used in the source file being compiled.
3610 @end table
3612 @node Optimize Options
3613 @section Options That Control Optimization
3614 @cindex optimize options
3615 @cindex options, optimization
3617 These options control various sorts of optimizations.
3619 Without any optimization option, the compiler's goal is to reduce the
3620 cost of compilation and to make debugging produce the expected
3621 results.  Statements are independent: if you stop the program with a
3622 breakpoint between statements, you can then assign a new value to any
3623 variable or change the program counter to any other statement in the
3624 function and get exactly the results you would expect from the source
3625 code.
3627 Turning on optimization flags makes the compiler attempt to improve
3628 the performance and/or code size at the expense of compilation time
3629 and possibly the ability to debug the program.
3631 The compiler performs optimisation based on the knowledge it has of
3632 the program.  Using the @option{-funit-at-a-time} flag will allow the
3633 compiler to consider information gained from later functions in the
3634 file when compiling a function.  Compiling multiple files at once to a
3635 single output file (and using @option{-funit-at-a-time}) will allow
3636 the compiler to use information gained from all of the files when
3637 compiling each of them.
3639 Not all optimizations are controlled directly by a flag.  Only
3640 optimizations that have a flag are listed.
3642 @table @gcctabopt
3643 @item -O
3644 @itemx -O1
3645 @opindex O
3646 @opindex O1
3647 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3648 more memory for a large function.
3650 With @option{-O}, the compiler tries to reduce code size and execution
3651 time, without performing any optimizations that take a great deal of
3652 compilation time.
3654 @option{-O} turns on the following optimization flags: 
3655 @gccoptlist{-fdefer-pop @gol
3656 -fmerge-constants @gol
3657 -fthread-jumps @gol
3658 -floop-optimize @gol
3659 -fcrossjumping @gol
3660 -fif-conversion @gol
3661 -fif-conversion2 @gol
3662 -fdelayed-branch @gol
3663 -fguess-branch-probability @gol
3664 -fcprop-registers}
3666 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3667 where doing so does not interfere with debugging.
3669 @item -O2
3670 @opindex O2
3671 Optimize even more.  GCC performs nearly all supported optimizations
3672 that do not involve a space-speed tradeoff.  The compiler does not
3673 perform loop unrolling or function inlining when you specify @option{-O2}.
3674 As compared to @option{-O}, this option increases both compilation time
3675 and the performance of the generated code.
3677 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3678 also turns on the following optimization flags:
3679 @gccoptlist{-fforce-mem @gol
3680 -foptimize-sibling-calls @gol
3681 -fstrength-reduce @gol
3682 -fcse-follow-jumps  -fcse-skip-blocks @gol
3683 -frerun-cse-after-loop  -frerun-loop-opt @gol
3684 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3685 -fdelete-null-pointer-checks @gol
3686 -fexpensive-optimizations @gol
3687 -fregmove @gol
3688 -fschedule-insns  -fschedule-insns2 @gol
3689 -fsched-interblock  -fsched-spec @gol
3690 -fcaller-saves @gol
3691 -fpeephole2 @gol
3692 -freorder-blocks  -freorder-functions @gol
3693 -fstrict-aliasing @gol
3694 -funit-at-a-time -fweb @gol
3695 -falign-functions  -falign-jumps @gol
3696 -falign-loops  -falign-labels}
3698 Please note the warning under @option{-fgcse} about
3699 invoking @option{-O2} on programs that use computed gotos.
3701 @item -O3
3702 @opindex O3
3703 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3704 @option{-O2} and also turns on the @option{-finline-functions},
3705 @option{-fweb} and @option{-frename-registers} options.
3707 @item -O0
3708 @opindex O0
3709 Do not optimize.  This is the default.
3711 @item -Os
3712 @opindex Os
3713 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3714 do not typically increase code size.  It also performs further
3715 optimizations designed to reduce code size.
3717 @option{-Os} disables the following optimization flags:
3718 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3719 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3721 If you use multiple @option{-O} options, with or without level numbers,
3722 the last such option is the one that is effective.
3723 @end table
3725 Options of the form @option{-f@var{flag}} specify machine-independent
3726 flags.  Most flags have both positive and negative forms; the negative
3727 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3728 below, only one of the forms is listed---the one you typically will
3729 use.  You can figure out the other form by either removing @samp{no-}
3730 or adding it.
3732 The following options control specific optimizations.  They are either
3733 activated by @option{-O} options or are related to ones that are.  You
3734 can use the following flags in the rare cases when ``fine-tuning'' of
3735 optimizations to be performed is desired.
3737 @table @gcctabopt
3738 @item -fno-default-inline
3739 @opindex fno-default-inline
3740 Do not make member functions inline by default merely because they are
3741 defined inside the class scope (C++ only).  Otherwise, when you specify
3742 @w{@option{-O}}, member functions defined inside class scope are compiled
3743 inline by default; i.e., you don't need to add @samp{inline} in front of
3744 the member function name.
3746 @item -fno-defer-pop
3747 @opindex fno-defer-pop
3748 Always pop the arguments to each function call as soon as that function
3749 returns.  For machines which must pop arguments after a function call,
3750 the compiler normally lets arguments accumulate on the stack for several
3751 function calls and pops them all at once.
3753 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3755 @item -fforce-mem
3756 @opindex fforce-mem
3757 Force memory operands to be copied into registers before doing
3758 arithmetic on them.  This produces better code by making all memory
3759 references potential common subexpressions.  When they are not common
3760 subexpressions, instruction combination should eliminate the separate
3761 register-load.
3763 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3765 @item -fforce-addr
3766 @opindex fforce-addr
3767 Force memory address constants to be copied into registers before
3768 doing arithmetic on them.  This may produce better code just as
3769 @option{-fforce-mem} may.
3771 @item -fomit-frame-pointer
3772 @opindex fomit-frame-pointer
3773 Don't keep the frame pointer in a register for functions that
3774 don't need one.  This avoids the instructions to save, set up and
3775 restore frame pointers; it also makes an extra register available
3776 in many functions.  @strong{It also makes debugging impossible on
3777 some machines.}
3779 On some machines, such as the VAX, this flag has no effect, because
3780 the standard calling sequence automatically handles the frame pointer
3781 and nothing is saved by pretending it doesn't exist.  The
3782 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3783 whether a target machine supports this flag.  @xref{Registers,,Register
3784 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3786 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3788 @item -foptimize-sibling-calls
3789 @opindex foptimize-sibling-calls
3790 Optimize sibling and tail recursive calls.
3792 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3794 @item -fno-inline
3795 @opindex fno-inline
3796 Don't pay attention to the @code{inline} keyword.  Normally this option
3797 is used to keep the compiler from expanding any functions inline.
3798 Note that if you are not optimizing, no functions can be expanded inline.
3800 @item -finline-functions
3801 @opindex finline-functions
3802 Integrate all simple functions into their callers.  The compiler
3803 heuristically decides which functions are simple enough to be worth
3804 integrating in this way.
3806 If all calls to a given function are integrated, and the function is
3807 declared @code{static}, then the function is normally not output as
3808 assembler code in its own right.
3810 Enabled at level @option{-O3}.
3812 @item -finline-limit=@var{n}
3813 @opindex finline-limit
3814 By default, gcc limits the size of functions that can be inlined.  This flag
3815 allows the control of this limit for functions that are explicitly marked as
3816 inline (i.e., marked with the inline keyword or defined within the class
3817 definition in c++).  @var{n} is the size of functions that can be inlined in
3818 number of pseudo instructions (not counting parameter handling).  The default
3819 value of @var{n} is 600.
3820 Increasing this value can result in more inlined code at
3821 the cost of compilation time and memory consumption.  Decreasing usually makes
3822 the compilation faster and less code will be inlined (which presumably
3823 means slower programs).  This option is particularly useful for programs that
3824 use inlining heavily such as those based on recursive templates with C++.
3826 Inlining is actually controlled by a number of parameters, which may be
3827 specified individually by using @option{--param @var{name}=@var{value}}.
3828 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3829 as follows:
3831 @table @gcctabopt
3832  @item max-inline-insns-single
3833   is set to @var{n}/2.
3834  @item max-inline-insns-auto
3835   is set to @var{n}/2.
3836  @item min-inline-insns
3837   is set to 130 or @var{n}/4, whichever is smaller.
3838  @item max-inline-insns-rtl
3839   is set to @var{n}.
3840 @end table
3842 See below for a documentation of the individual
3843 parameters controlling inlining.
3845 @emph{Note:} pseudo instruction represents, in this particular context, an
3846 abstract measurement of function's size.  In no way, it represents a count
3847 of assembly instructions and as such its exact meaning might change from one
3848 release to an another.
3850 @item -fkeep-inline-functions
3851 @opindex fkeep-inline-functions
3852 Even if all calls to a given function are integrated, and the function
3853 is declared @code{static}, nevertheless output a separate run-time
3854 callable version of the function.  This switch does not affect
3855 @code{extern inline} functions.
3857 @item -fkeep-static-consts
3858 @opindex fkeep-static-consts
3859 Emit variables declared @code{static const} when optimization isn't turned
3860 on, even if the variables aren't referenced.
3862 GCC enables this option by default.  If you want to force the compiler to
3863 check if the variable was referenced, regardless of whether or not
3864 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3866 @item -fmerge-constants
3867 Attempt to merge identical constants (string constants and floating point
3868 constants) across compilation units.
3870 This option is the default for optimized compilation if the assembler and
3871 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3872 behavior.
3874 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3876 @item -fmerge-all-constants
3877 Attempt to merge identical constants and identical variables.
3879 This option implies @option{-fmerge-constants}.  In addition to
3880 @option{-fmerge-constants} this considers e.g. even constant initialized
3881 arrays or initialized constant variables with integral or floating point
3882 types.  Languages like C or C++ require each non-automatic variable to
3883 have distinct location, so using this option will result in non-conforming
3884 behavior.
3886 @item -fnew-ra
3887 @opindex fnew-ra
3888 Use a graph coloring register allocator.  Currently this option is meant
3889 for testing, so we are interested to hear about miscompilations with
3890 @option{-fnew-ra}.
3892 @item -fno-branch-count-reg
3893 @opindex fno-branch-count-reg
3894 Do not use ``decrement and branch'' instructions on a count register,
3895 but instead generate a sequence of instructions that decrement a
3896 register, compare it against zero, then branch based upon the result.
3897 This option is only meaningful on architectures that support such
3898 instructions, which include x86, PowerPC, IA-64 and S/390.
3900 The default is @option{-fbranch-count-reg}, enabled when
3901 @option{-fstrength-reduce} is enabled.
3903 @item -fno-function-cse
3904 @opindex fno-function-cse
3905 Do not put function addresses in registers; make each instruction that
3906 calls a constant function contain the function's address explicitly.
3908 This option results in less efficient code, but some strange hacks
3909 that alter the assembler output may be confused by the optimizations
3910 performed when this option is not used.
3912 The default is @option{-ffunction-cse}
3914 @item -fno-zero-initialized-in-bss
3915 @opindex fno-zero-initialized-in-bss
3916 If the target supports a BSS section, GCC by default puts variables that
3917 are initialized to zero into BSS@.  This can save space in the resulting
3918 code.
3920 This option turns off this behavior because some programs explicitly
3921 rely on variables going to the data section.  E.g., so that the
3922 resulting executable can find the beginning of that section and/or make
3923 assumptions based on that.
3925 The default is @option{-fzero-initialized-in-bss}.
3927 @item -fstrength-reduce
3928 @opindex fstrength-reduce
3929 Perform the optimizations of loop strength reduction and
3930 elimination of iteration variables.
3932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3934 @item -fthread-jumps
3935 @opindex fthread-jumps
3936 Perform optimizations where we check to see if a jump branches to a
3937 location where another comparison subsumed by the first is found.  If
3938 so, the first branch is redirected to either the destination of the
3939 second branch or a point immediately following it, depending on whether
3940 the condition is known to be true or false.
3942 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3944 @item -fcse-follow-jumps
3945 @opindex fcse-follow-jumps
3946 In common subexpression elimination, scan through jump instructions
3947 when the target of the jump is not reached by any other path.  For
3948 example, when CSE encounters an @code{if} statement with an
3949 @code{else} clause, CSE will follow the jump when the condition
3950 tested is false.
3952 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3954 @item -fcse-skip-blocks
3955 @opindex fcse-skip-blocks
3956 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3957 follow jumps which conditionally skip over blocks.  When CSE
3958 encounters a simple @code{if} statement with no else clause,
3959 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3960 body of the @code{if}.
3962 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3964 @item -frerun-cse-after-loop
3965 @opindex frerun-cse-after-loop
3966 Re-run common subexpression elimination after loop optimizations has been
3967 performed.
3969 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3971 @item -frerun-loop-opt
3972 @opindex frerun-loop-opt
3973 Run the loop optimizer twice.
3975 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3977 @item -fgcse
3978 @opindex fgcse
3979 Perform a global common subexpression elimination pass.
3980 This pass also performs global constant and copy propagation.
3982 @emph{Note:} When compiling a program using computed gotos, a GCC
3983 extension, you may get better runtime performance if you disable
3984 the global common subexpression elimination pass by adding
3985 @option{-fno-gcse} to the command line.
3987 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3989 @item -fgcse-lm
3990 @opindex fgcse-lm
3991 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3992 attempt to move loads which are only killed by stores into themselves.  This
3993 allows a loop containing a load/store sequence to be changed to a load outside
3994 the loop, and a copy/store within the loop.
3996 Enabled by default when gcse is enabled.
3998 @item -fgcse-sm
3999 @opindex fgcse-sm
4000 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4001 global common subexpression elimination.  This pass will attempt to move
4002 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4003 loops containing a load/store sequence can be changed to a load before
4004 the loop and a store after the loop.
4006 Enabled by default when gcse is enabled.
4008 @item -fgcse-las
4009 @opindex fgcse-las
4010 When @option{-fgcse-las} is enabled, the global common subexpression
4011 elimination pass eliminates redundant loads that come after stores to the
4012 same memory location (both partial and full redundancies).
4014 Enabled by default when gcse is enabled.
4016 @item -floop-optimize
4017 @opindex floop-optimize
4018 Perform loop optimizations: move constant expressions out of loops, simplify
4019 exit test conditions and optionally do strength-reduction and loop unrolling as
4020 well.
4022 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4024 @item -fcrossjumping
4025 @opindex crossjumping
4026 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4027 resulting code may or may not perform better than without cross-jumping.
4029 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4031 @item -fif-conversion
4032 @opindex if-conversion
4033 Attempt to transform conditional jumps into branch-less equivalents.  This
4034 include use of conditional moves, min, max, set flags and abs instructions, and
4035 some tricks doable by standard arithmetics.  The use of conditional execution
4036 on chips where it is available is controlled by @code{if-conversion2}.
4038 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4040 @item -fif-conversion2
4041 @opindex if-conversion2
4042 Use conditional execution (where available) to transform conditional jumps into
4043 branch-less equivalents.
4045 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4047 @item -fdelete-null-pointer-checks
4048 @opindex fdelete-null-pointer-checks
4049 Use global dataflow analysis to identify and eliminate useless checks
4050 for null pointers.  The compiler assumes that dereferencing a null
4051 pointer would have halted the program.  If a pointer is checked after
4052 it has already been dereferenced, it cannot be null.
4054 In some environments, this assumption is not true, and programs can
4055 safely dereference null pointers.  Use
4056 @option{-fno-delete-null-pointer-checks} to disable this optimization
4057 for programs which depend on that behavior.
4059 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4061 @item -fexpensive-optimizations
4062 @opindex fexpensive-optimizations
4063 Perform a number of minor optimizations that are relatively expensive.
4065 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4067 @item -foptimize-register-move
4068 @itemx -fregmove
4069 @opindex foptimize-register-move
4070 @opindex fregmove
4071 Attempt to reassign register numbers in move instructions and as
4072 operands of other simple instructions in order to maximize the amount of
4073 register tying.  This is especially helpful on machines with two-operand
4074 instructions.
4076 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4077 optimization.
4079 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4081 @item -fdelayed-branch
4082 @opindex fdelayed-branch
4083 If supported for the target machine, attempt to reorder instructions
4084 to exploit instruction slots available after delayed branch
4085 instructions.
4087 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4089 @item -fschedule-insns
4090 @opindex fschedule-insns
4091 If supported for the target machine, attempt to reorder instructions to
4092 eliminate execution stalls due to required data being unavailable.  This
4093 helps machines that have slow floating point or memory load instructions
4094 by allowing other instructions to be issued until the result of the load
4095 or floating point instruction is required.
4097 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4099 @item -fschedule-insns2
4100 @opindex fschedule-insns2
4101 Similar to @option{-fschedule-insns}, but requests an additional pass of
4102 instruction scheduling after register allocation has been done.  This is
4103 especially useful on machines with a relatively small number of
4104 registers and where memory load instructions take more than one cycle.
4106 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4108 @item -fno-sched-interblock
4109 @opindex fno-sched-interblock
4110 Don't schedule instructions across basic blocks.  This is normally
4111 enabled by default when scheduling before register allocation, i.e.@:
4112 with @option{-fschedule-insns} or at @option{-O2} or higher.
4114 @item -fno-sched-spec
4115 @opindex fno-sched-spec
4116 Don't allow speculative motion of non-load instructions.  This is normally
4117 enabled by default when scheduling before register allocation, i.e.@:
4118 with @option{-fschedule-insns} or at @option{-O2} or higher.
4120 @item -fsched-spec-load
4121 @opindex fsched-spec-load
4122 Allow speculative motion of some load instructions.  This only makes
4123 sense when scheduling before register allocation, i.e.@: with
4124 @option{-fschedule-insns} or at @option{-O2} or higher.
4126 @item -fsched-spec-load-dangerous
4127 @opindex fsched-spec-load-dangerous
4128 Allow speculative motion of more load instructions.  This only makes
4129 sense when scheduling before register allocation, i.e.@: with
4130 @option{-fschedule-insns} or at @option{-O2} or higher.
4132 @item -fsched-stalled-insns=@var{n}
4133 @opindex fsched-stalled-insns
4134 Define how many insns (if any) can be moved prematurely from the queue
4135 of stalled insns into the ready list, during the second scheduling pass.
4137 @item -fsched-stalled-insns-dep=@var{n}
4138 @opindex fsched-stalled-insns-dep
4139 Define how many insn groups (cycles) will be examined for a dependency 
4140 on a stalled insn that is candidate for premature removal from the queue 
4141 of stalled insns.  Has an effect only during the second scheduling pass, 
4142 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4144 @item -fsched2-use-superblocks
4145 @opindex fsched2-use-superblocks
4146 When scheduling after register allocation, do use superblock scheduling
4147 algorithm.  Superblock scheduling allows motion across basic block boundaries
4148 resulting on faster schedules.  This option is experimental, as not all machine
4149 descriptions used by GCC model the CPU closely enough to avoid unreliable
4150 results from the algorithm. 
4152 This only makes sense when scheduling after register allocation, i.e.@: with
4153 @option{-fschedule-insns2} or at @option{-O2} or higher.
4155 @item -fsched2-use-traces
4156 @opindex fsched2-use-traces
4157 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4158 allocation and additionally perform code duplication in order to increase the
4159 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4160 trace formation.
4162 This mode should produce faster but significantly longer programs.  Also
4163 without @code{-fbranch-probabilities} the traces constructed may not match the
4164 reality and hurt the performance.  This only makes
4165 sense when scheduling after register allocation, i.e.@: with
4166 @option{-fschedule-insns2} or at @option{-O2} or higher.
4168 @item -fcaller-saves
4169 @opindex fcaller-saves
4170 Enable values to be allocated in registers that will be clobbered by
4171 function calls, by emitting extra instructions to save and restore the
4172 registers around such calls.  Such allocation is done only when it
4173 seems to result in better code than would otherwise be produced.
4175 This option is always enabled by default on certain machines, usually
4176 those which have no call-preserved registers to use instead.
4178 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4180 @item -fmove-all-movables
4181 @opindex fmove-all-movables
4182 Forces all invariant computations in loops to be moved
4183 outside the loop.
4185 @item -freduce-all-givs
4186 @opindex freduce-all-givs
4187 Forces all general-induction variables in loops to be
4188 strength-reduced.
4190 @emph{Note:} When compiling programs written in Fortran,
4191 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4192 by default when you use the optimizer.
4194 These options may generate better or worse code; results are highly
4195 dependent on the structure of loops within the source code.
4197 These two options are intended to be removed someday, once
4198 they have helped determine the efficacy of various
4199 approaches to improving loop optimizations.
4201 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4202 know how use of these options affects
4203 the performance of your production code.
4204 We're very interested in code that runs @emph{slower}
4205 when these options are @emph{enabled}.
4207 @item -fno-peephole
4208 @itemx -fno-peephole2
4209 @opindex fno-peephole
4210 @opindex fno-peephole2
4211 Disable any machine-specific peephole optimizations.  The difference
4212 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4213 are implemented in the compiler; some targets use one, some use the
4214 other, a few use both.
4216 @option{-fpeephole} is enabled by default.
4217 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4219 @item -fno-guess-branch-probability
4220 @opindex fno-guess-branch-probability
4221 Do not guess branch probabilities using a randomized model.
4223 Sometimes gcc will opt to use a randomized model to guess branch
4224 probabilities, when none are available from either profiling feedback
4225 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4226 different runs of the compiler on the same program may produce different
4227 object code.
4229 In a hard real-time system, people don't want different runs of the
4230 compiler to produce code that has different behavior; minimizing
4231 non-determinism is of paramount import.  This switch allows users to
4232 reduce non-determinism, possibly at the expense of inferior
4233 optimization.
4235 The default is @option{-fguess-branch-probability} at levels
4236 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4238 @item -freorder-blocks
4239 @opindex freorder-blocks
4240 Reorder basic blocks in the compiled function in order to reduce number of
4241 taken branches and improve code locality.
4243 Enabled at levels @option{-O2}, @option{-O3}.
4245 @item -freorder-functions
4246 @opindex freorder-functions
4247 Reorder basic blocks in the compiled function in order to reduce number of
4248 taken branches and improve code locality. This is implemented by using special
4249 subsections @code{text.hot} for most frequently executed functions and
4250 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4251 the linker so object file format must support named sections and linker must
4252 place them in a reasonable way.
4254 Also profile feedback must be available in to make this option effective.  See
4255 @option{-fprofile-arcs} for details.
4257 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4259 @item -fstrict-aliasing
4260 @opindex fstrict-aliasing
4261 Allows the compiler to assume the strictest aliasing rules applicable to
4262 the language being compiled.  For C (and C++), this activates
4263 optimizations based on the type of expressions.  In particular, an
4264 object of one type is assumed never to reside at the same address as an
4265 object of a different type, unless the types are almost the same.  For
4266 example, an @code{unsigned int} can alias an @code{int}, but not a
4267 @code{void*} or a @code{double}.  A character type may alias any other
4268 type.
4270 Pay special attention to code like this:
4271 @example
4272 union a_union @{
4273   int i;
4274   double d;
4277 int f() @{
4278   a_union t;
4279   t.d = 3.0;
4280   return t.i;
4282 @end example
4283 The practice of reading from a different union member than the one most
4284 recently written to (called ``type-punning'') is common.  Even with
4285 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4286 is accessed through the union type.  So, the code above will work as
4287 expected.  However, this code might not:
4288 @example
4289 int f() @{
4290   a_union t;
4291   int* ip;
4292   t.d = 3.0;
4293   ip = &t.i;
4294   return *ip;
4296 @end example
4298 Every language that wishes to perform language-specific alias analysis
4299 should define a function that computes, given an @code{tree}
4300 node, an alias set for the node.  Nodes in different alias sets are not
4301 allowed to alias.  For an example, see the C front-end function
4302 @code{c_get_alias_set}.
4304 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4306 @item -falign-functions
4307 @itemx -falign-functions=@var{n}
4308 @opindex falign-functions
4309 Align the start of functions to the next power-of-two greater than
4310 @var{n}, skipping up to @var{n} bytes.  For instance,
4311 @option{-falign-functions=32} aligns functions to the next 32-byte
4312 boundary, but @option{-falign-functions=24} would align to the next
4313 32-byte boundary only if this can be done by skipping 23 bytes or less.
4315 @option{-fno-align-functions} and @option{-falign-functions=1} are
4316 equivalent and mean that functions will not be aligned.
4318 Some assemblers only support this flag when @var{n} is a power of two;
4319 in that case, it is rounded up.
4321 If @var{n} is not specified or is zero, use a machine-dependent default.
4323 Enabled at levels @option{-O2}, @option{-O3}.
4325 @item -falign-labels
4326 @itemx -falign-labels=@var{n}
4327 @opindex falign-labels
4328 Align all branch targets to a power-of-two boundary, skipping up to
4329 @var{n} bytes like @option{-falign-functions}.  This option can easily
4330 make code slower, because it must insert dummy operations for when the
4331 branch target is reached in the usual flow of the code.
4333 @option{-fno-align-labels} and @option{-falign-labels=1} are
4334 equivalent and mean that labels will not be aligned.
4336 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4337 are greater than this value, then their values are used instead.
4339 If @var{n} is not specified or is zero, use a machine-dependent default
4340 which is very likely to be @samp{1}, meaning no alignment.
4342 Enabled at levels @option{-O2}, @option{-O3}.
4344 @item -falign-loops
4345 @itemx -falign-loops=@var{n}
4346 @opindex falign-loops
4347 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4348 like @option{-falign-functions}.  The hope is that the loop will be
4349 executed many times, which will make up for any execution of the dummy
4350 operations.
4352 @option{-fno-align-loops} and @option{-falign-loops=1} are
4353 equivalent and mean that loops will not be aligned.
4355 If @var{n} is not specified or is zero, use a machine-dependent default.
4357 Enabled at levels @option{-O2}, @option{-O3}.
4359 @item -falign-jumps
4360 @itemx -falign-jumps=@var{n}
4361 @opindex falign-jumps
4362 Align branch targets to a power-of-two boundary, for branch targets
4363 where the targets can only be reached by jumping, skipping up to @var{n}
4364 bytes like @option{-falign-functions}.  In this case, no dummy operations
4365 need be executed.
4367 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4368 equivalent and mean that loops will not be aligned.
4370 If @var{n} is not specified or is zero, use a machine-dependent default.
4372 Enabled at levels @option{-O2}, @option{-O3}.
4374 @item -frename-registers
4375 @opindex frename-registers
4376 Attempt to avoid false dependencies in scheduled code by making use
4377 of registers left over after register allocation.  This optimization
4378 will most benefit processors with lots of registers.  It can, however,
4379 make debugging impossible, since variables will no longer stay in
4380 a ``home register''.
4382 @item -fweb
4383 @opindex fweb
4384 Constructs webs as commonly used for register allocation purposes and assign
4385 each web individual pseudo register.  This allows our register allocation pass
4386 to operate on pseudos directly, but also strengthens several other optimization
4387 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4388 however, make debugging impossible, since variables will no longer stay in a
4389 ``home register''.
4391 Enabled at levels @option{-O3}.
4393 @item -fno-cprop-registers
4394 @opindex fno-cprop-registers
4395 After register allocation and post-register allocation instruction splitting,
4396 we perform a copy-propagation pass to try to reduce scheduling dependencies
4397 and occasionally eliminate the copy.
4399 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4401 @end table
4403 The following options control compiler behavior regarding floating
4404 point arithmetic.  These options trade off between speed and
4405 correctness.  All must be specifically enabled.
4407 @table @gcctabopt
4408 @item -ffloat-store
4409 @opindex ffloat-store
4410 Do not store floating point variables in registers, and inhibit other
4411 options that might change whether a floating point value is taken from a
4412 register or memory.
4414 @cindex floating point precision
4415 This option prevents undesirable excess precision on machines such as
4416 the 68000 where the floating registers (of the 68881) keep more
4417 precision than a @code{double} is supposed to have.  Similarly for the
4418 x86 architecture.  For most programs, the excess precision does only
4419 good, but a few programs rely on the precise definition of IEEE floating
4420 point.  Use @option{-ffloat-store} for such programs, after modifying
4421 them to store all pertinent intermediate computations into variables.
4423 @item -ffast-math
4424 @opindex ffast-math
4425 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4426 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4427 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4429 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4431 This option should never be turned on by any @option{-O} option since
4432 it can result in incorrect output for programs which depend on
4433 an exact implementation of IEEE or ISO rules/specifications for
4434 math functions.
4436 @item -fno-math-errno
4437 @opindex fno-math-errno
4438 Do not set ERRNO after calling math functions that are executed
4439 with a single instruction, e.g., sqrt.  A program that relies on
4440 IEEE exceptions for math error handling may want to use this flag
4441 for speed while maintaining IEEE arithmetic compatibility.
4443 This option should never be turned on by any @option{-O} option since
4444 it can result in incorrect output for programs which depend on
4445 an exact implementation of IEEE or ISO rules/specifications for
4446 math functions.
4448 The default is @option{-fmath-errno}.
4450 @item -funsafe-math-optimizations
4451 @opindex funsafe-math-optimizations
4452 Allow optimizations for floating-point arithmetic that (a) assume
4453 that arguments and results are valid and (b) may violate IEEE or
4454 ANSI standards.  When used at link-time, it may include libraries
4455 or startup files that change the default FPU control word or other
4456 similar optimizations.
4458 This option should never be turned on by any @option{-O} option since
4459 it can result in incorrect output for programs which depend on
4460 an exact implementation of IEEE or ISO rules/specifications for
4461 math functions.
4463 The default is @option{-fno-unsafe-math-optimizations}.
4465 @item -ffinite-math-only
4466 @opindex ffinite-math-only
4467 Allow optimizations for floating-point arithmetic that assume
4468 that arguments and results are not NaNs or +-Infs.
4470 This option should never be turned on by any @option{-O} option since
4471 it can result in incorrect output for programs which depend on
4472 an exact implementation of IEEE or ISO rules/specifications.
4474 The default is @option{-fno-finite-math-only}.
4476 @item -fno-trapping-math
4477 @opindex fno-trapping-math
4478 Compile code assuming that floating-point operations cannot generate
4479 user-visible traps.  These traps include division by zero, overflow,
4480 underflow, inexact result and invalid operation.  This option implies
4481 @option{-fno-signaling-nans}.  Setting this option may allow faster
4482 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4484 This option should never be turned on by any @option{-O} option since
4485 it can result in incorrect output for programs which depend on
4486 an exact implementation of IEEE or ISO rules/specifications for
4487 math functions.
4489 The default is @option{-ftrapping-math}.
4491 @item -frounding-math
4492 @opindex frounding-math
4493 Disable transformations and optimizations that assume default floating
4494 point rounding behavior.  This is round-to-zero for all floating point
4495 to integer conversions, and round-to-nearest for all other arithmetic
4496 truncations.  This option should be specified for programs that change
4497 the FP rounding mode dynamically, or that may be executed with a
4498 non-default rounding mode.  This option disables constant folding of
4499 floating point expressions at compile-time (which may be affected by
4500 rounding mode) and arithmetic transformations that are unsafe in the
4501 presence of sign-dependent rounding modes.
4503 The default is @option{-fno-rounding-math}.
4505 This option is experimental and does not currently guarantee to
4506 disable all GCC optimizations that are affected by rounding mode.
4507 Future versions of gcc may provide finer control of this setting
4508 using C99's @code{FENV_ACCESS} pragma.  This command line option
4509 will be used to specify the default state for @code{FENV_ACCESS}.
4511 @item -fsignaling-nans
4512 @opindex fsignaling-nans
4513 Compile code assuming that IEEE signaling NaNs may generate user-visible
4514 traps during floating-point operations.  Setting this option disables
4515 optimizations that may change the number of exceptions visible with
4516 signaling NaNs.  This option implies @option{-ftrapping-math}.
4518 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4519 be defined.
4521 The default is @option{-fno-signaling-nans}.
4523 This option is experimental and does not currently guarantee to
4524 disable all GCC optimizations that affect signaling NaN behavior.
4526 @item -fsingle-precision-constant
4527 @opindex fsingle-precision-constant
4528 Treat floating point constant as single precision constant instead of
4529 implicitly converting it to double precision constant.
4532 @end table
4534 The following options control optimizations that may improve
4535 performance, but are not enabled by any @option{-O} options.  This
4536 section includes experimental options that may produce broken code.
4538 @table @gcctabopt
4539 @item -fbranch-probabilities
4540 @opindex fbranch-probabilities
4541 After running a program compiled with @option{-fprofile-arcs}
4542 (@pxref{Debugging Options,, Options for Debugging Your Program or
4543 @command{gcc}}), you can compile it a second time using
4544 @option{-fbranch-probabilities}, to improve optimizations based on
4545 the number of times each branch was taken.  When the program
4546 compiled with @option{-fprofile-arcs} exits it saves arc execution
4547 counts to a file called @file{@var{sourcename}.gcda} for each source
4548 file  The information in this data file is very dependent on the
4549 structure of the generated code, so you must use the same source code
4550 and the same optimization options for both compilations.
4552 With @option{-fbranch-probabilities}, GCC puts a 
4553 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4554 These can be used to improve optimization.  Currently, they are only
4555 used in one place: in @file{reorg.c}, instead of guessing which path a
4556 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4557 exactly determine which path is taken more often.
4559 @item -fprofile-values
4560 @opindex fprofile-values
4561 If combined with @option{-fprofile-arcs}, it adds code so that some
4562 data about values of expressions in the program is gathered.
4564 With @option{-fbranch-probabilities}, it reads back the data gathered
4565 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4566 notes to instructions for their later usage in optimizations.
4568 @item -fvpt
4569 @opindex fvpt
4570 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4571 a code to gather information about values of expressions.
4573 With @option{-fbranch-probabilities}, it reads back the data gathered
4574 and actually performs the optimizations based on them.
4575 Currently the optimizations include specialization of division operation
4576 using the knowledge about the value of the denominator.
4578 @item -fnew-ra
4579 @opindex fnew-ra
4580 Use a graph coloring register allocator.  Currently this option is meant
4581 for testing, so we are interested to hear about miscompilations with
4582 @option{-fnew-ra}.
4584 @item -ftracer
4585 @opindex ftracer
4586 Perform tail duplication to enlarge superblock size. This transformation
4587 simplifies the control flow of the function allowing other optimizations to do
4588 better job.
4590 @item -funit-at-a-time
4591 @opindex funit-at-a-time
4592 Parse the whole compilation unit before starting to produce code.
4593 This allows some extra optimizations to take place but consumes more
4594 memory.
4596 @item -funroll-loops
4597 @opindex funroll-loops
4598 Unroll loops whose number of iterations can be determined at compile time or
4599 upon entry to the loop.  @option{-funroll-loops} implies
4600 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4601 (i.e. complete removal of loops with small constant number of iterations).
4602 This option makes code larger, and may or may not make it run faster.
4604 @item -funroll-all-loops
4605 @opindex funroll-all-loops
4606 Unroll all loops, even if their number of iterations is uncertain when
4607 the loop is entered.  This usually makes programs run more slowly.
4608 @option{-funroll-all-loops} implies the same options as
4609 @option{-funroll-loops}.
4611 @item -fpeel-loops
4612 @opindex fpeel-loops
4613 Peels the loops for that there is enough information that they do not
4614 roll much (from profile feedback).  It also turns on complete loop peeling
4615 (i.e. complete removal of loops with small constant number of iterations).
4617 @item -funswitch-loops
4618 @opindex funswitch-loops
4619 Move branches with loop invariant conditions out of the loop, with duplicates
4620 of the loop on both branches (modified according to result of the condition).
4622 @item -fold-unroll-loops
4623 @opindex fold-unroll-loops
4624 Unroll loops whose number of iterations can be determined at compile
4625 time or upon entry to the loop, using the old loop unroller whose loop
4626 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4627 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4628 option makes code larger, and may or may not make it run faster.
4630 @item -fold-unroll-all-loops
4631 @opindex fold-unroll-all-loops
4632 Unroll all loops, even if their number of iterations is uncertain when
4633 the loop is entered. This is done using the old loop unroller whose loop
4634 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4635 @option{-fold-unroll-all-loops} implies the same options as
4636 @option{-fold-unroll-loops}.
4638 @item -funswitch-loops
4639 @opindex funswitch-loops
4640 Move branches with loop invariant conditions out of the loop, with duplicates
4641 of the loop on both branches (modified according to result of the condition).
4643 @item -funswitch-loops
4644 @opindex funswitch-loops
4645 Move branches with loop invariant conditions out of the loop, with duplicates
4646 of the loop on both branches (modified according to result of the condition).
4648 @item -fprefetch-loop-arrays
4649 @opindex fprefetch-loop-arrays
4650 If supported by the target machine, generate instructions to prefetch
4651 memory to improve the performance of loops that access large arrays.
4653 Disabled at level @option{-Os}.
4655 @item -ffunction-sections
4656 @itemx -fdata-sections
4657 @opindex ffunction-sections
4658 @opindex fdata-sections
4659 Place each function or data item into its own section in the output
4660 file if the target supports arbitrary sections.  The name of the
4661 function or the name of the data item determines the section's name
4662 in the output file.
4664 Use these options on systems where the linker can perform optimizations
4665 to improve locality of reference in the instruction space.  Most systems
4666 using the ELF object format and SPARC processors running Solaris 2 have
4667 linkers with such optimizations.  AIX may have these optimizations in
4668 the future.
4670 Only use these options when there are significant benefits from doing
4671 so.  When you specify these options, the assembler and linker will
4672 create larger object and executable files and will also be slower.
4673 You will not be able to use @code{gprof} on all systems if you
4674 specify this option and you may have problems with debugging if
4675 you specify both this option and @option{-g}.
4677 @item -fssa
4678 @opindex fssa
4679 Perform optimizations in static single assignment form.  Each function's
4680 flow graph is translated into SSA form, optimizations are performed, and
4681 the flow graph is translated back from SSA form.  Users should not
4682 specify this option, since it is not yet ready for production use.
4684 @item -fssa-ccp
4685 @opindex fssa-ccp
4686 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4687 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4689 @item -fssa-dce
4690 @opindex fssa-dce
4691 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4692 Like @option{-fssa}, this is an experimental feature.
4694 @item -fbranch-target-load-optimize
4695 @opindex fbranch-target-load-optimize
4696 Perform branch target register load optimization before prologue / epilogue
4697 threading.
4698 The use of target registers can typically be exposed only during reload,
4699 thus hoisting loads out of loops and doing inter-block scheduling needs
4700 a separate optimization pass.
4702 @item -fbranch-target-load-optimize2
4703 @opindex fbranch-target-load-optimize2
4704 Perform branch target register load optimization after prologue / epilogue
4705 threading.
4710 @item --param @var{name}=@var{value}
4711 @opindex param
4712 In some places, GCC uses various constants to control the amount of
4713 optimization that is done.  For example, GCC will not inline functions
4714 that contain more that a certain number of instructions.  You can
4715 control some of these constants on the command-line using the
4716 @option{--param} option.
4718 In each case, the @var{value} is an integer.  The allowable choices for
4719 @var{name} are given in the following table:
4721 @table @gcctabopt
4722 @item max-crossjump-edges
4723 The maximum number of incoming edges to consider for crossjumping.
4724 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4725 the number of edges incoming to each block.  Increasing values mean
4726 more aggressive optimization, making the compile time increase with
4727 probably small improvement in executable size.
4729 @item max-delay-slot-insn-search
4730 The maximum number of instructions to consider when looking for an
4731 instruction to fill a delay slot.  If more than this arbitrary number of
4732 instructions is searched, the time savings from filling the delay slot
4733 will be minimal so stop searching.  Increasing values mean more
4734 aggressive optimization, making the compile time increase with probably
4735 small improvement in executable run time.
4737 @item max-delay-slot-live-search
4738 When trying to fill delay slots, the maximum number of instructions to
4739 consider when searching for a block with valid live register
4740 information.  Increasing this arbitrarily chosen value means more
4741 aggressive optimization, increasing the compile time.  This parameter
4742 should be removed when the delay slot code is rewritten to maintain the
4743 control-flow graph.
4745 @item max-gcse-memory
4746 The approximate maximum amount of memory that will be allocated in
4747 order to perform the global common subexpression elimination
4748 optimization.  If more memory than specified is required, the
4749 optimization will not be done.
4751 @item max-gcse-passes
4752 The maximum number of passes of GCSE to run.
4754 @item max-pending-list-length
4755 The maximum number of pending dependencies scheduling will allow
4756 before flushing the current state and starting over.  Large functions
4757 with few branches or calls can create excessively large lists which
4758 needlessly consume memory and resources.
4760 @item max-inline-insns-single
4761 Several parameters control the tree inliner used in gcc.
4762 This number sets the maximum number of instructions (counted in gcc's
4763 internal representation) in a single function that the tree inliner 
4764 will consider for inlining.  This only affects functions declared
4765 inline and methods implemented in a class declaration (C++).
4766 The default value is 500.
4768 @item max-inline-insns-auto
4769 When you use @option{-finline-functions} (included in @option{-O3}),
4770 a lot of functions that would otherwise not be considered for inlining
4771 by the compiler will be investigated.  To those functions, a different
4772 (more restrictive) limit compared to functions declared inline can
4773 be applied.
4774 The default value is 150.
4776 @item large-function-insns
4777 The limit specifying really large functions.  For functions greater than this
4778 limit inlining is constrained by @option{--param large-function-growth}.
4779 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4780 algorithms used by the backend.
4781 This parameter is ignored when @option{-funit-at-a-time} is not used.
4782 The default value is 30000.
4784 @item large-function-growth
4785 Specifies maximal growth of large functtion caused by inlining in percents.
4786 This parameter is ignored when @option{-funit-at-a-time} is not used.
4787 The default value is 200.
4789 @item inline-unit-growth
4790 Specifies maximal overall growth of the compilation unit caused by inlining.
4791 This parameter is ignored when @option{-funit-at-a-time} is not used.
4792 The default value is 150.
4794 @item max-inline-insns-rtl
4795 For languages that use the RTL inliner (this happens at a later stage
4796 than tree inlining), you can set the maximum allowable size (counted 
4797 in RTL instructions) for the RTL inliner with this parameter.
4798 The default value is 600.
4800 @item max-unrolled-insns
4801 The maximum number of instructions that a loop should have if that loop
4802 is unrolled, and if the loop is unrolled, it determines how many times
4803 the loop code is unrolled.
4805 @item max-average-unrolled-insns
4806 The maximum number of instructions biased by probabilities of their execution
4807 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4808 it determines how many times the loop code is unrolled.
4810 @item max-unroll-times
4811 The maximum number of unrollings of a single loop.
4813 @item max-peeled-insns
4814 The maximum number of instructions that a loop should have if that loop
4815 is peeled, and if the loop is peeled, it determines how many times
4816 the loop code is peeled.
4818 @item max-peel-times
4819 The maximum number of peelings of a single loop.
4821 @item max-completely-peeled-insns
4822 The maximum number of insns of a completely peeled loop.
4824 @item max-completely-peel-times
4825 The maximum number of iterations of a loop to be suitable for complete peeling.
4827 @item max-unswitch-insns
4828 The maximum number of insns of an unswitched loop.
4830 @item max-unswitch-level
4831 The maximum number of branches unswitched in a single loop.
4833 @item hot-bb-count-fraction
4834 Select fraction of the maximal count of repetitions of basic block in program
4835 given basic block needs to have to be considered hot.
4837 @item hot-bb-frequency-fraction
4838 Select fraction of the maximal frequency of executions of basic block in
4839 function given basic block needs to have to be considered hot
4841 @item tracer-dynamic-coverage
4842 @itemx tracer-dynamic-coverage-feedback
4844 This value is used to limit superblock formation once the given percentage of
4845 executed instructions is covered.  This limits unnecessary code size
4846 expansion.
4848 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4849 feedback is available.  The real profiles (as opposed to statically estimated
4850 ones) are much less balanced allowing the threshold to be larger value.
4852 @item tracer-max-code-growth
4853 Stop tail duplication once code growth has reached given percentage.  This is
4854 rather hokey argument, as most of the duplicates will be eliminated later in
4855 cross jumping, so it may be set to much higher values than is the desired code
4856 growth.
4858 @item tracer-min-branch-ratio
4860 Stop reverse growth when the reverse probability of best edge is less than this
4861 threshold (in percent).
4863 @item tracer-min-branch-ratio
4864 @itemx tracer-min-branch-ratio-feedback
4866 Stop forward growth if the best edge do have probability lower than this
4867 threshold.
4869 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4870 compilation for profile feedback and one for compilation without.  The value
4871 for compilation with profile feedback needs to be more conservative (higher) in
4872 order to make tracer effective.
4874 @item max-cse-path-length
4876 Maximum number of basic blocks on path that cse considers.
4878 @item ggc-min-expand
4880 GCC uses a garbage collector to manage its own memory allocation.  This
4881 parameter specifies the minimum percentage by which the garbage
4882 collector's heap should be allowed to expand between collections.
4883 Tuning this may improve compilation speed; it has no effect on code
4884 generation.
4886 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4887 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4888 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4889 GCC is not able to calculate RAM on a particular platform, the lower
4890 bound of 30% is used.  Setting this parameter and
4891 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4892 every opportunity.  This is extremely slow, but can be useful for
4893 debugging.
4895 @item ggc-min-heapsize
4897 Minimum size of the garbage collector's heap before it begins bothering
4898 to collect garbage.  The first collection occurs after the heap expands
4899 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4900 tuning this may improve compilation speed, and has no effect on code
4901 generation.
4903 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4904 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4905 available, the notion of "RAM" is the smallest of actual RAM,
4906 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4907 RAM on a particular platform, the lower bound is used.  Setting this
4908 parameter very large effectively disables garbage collection.  Setting
4909 this parameter and @option{ggc-min-expand} to zero causes a full
4910 collection to occur at every opportunity.
4912 @item reorder-blocks-duplicate
4913 @itemx reorder-blocks-duplicate-feedback
4915 Used by basic block reordering pass to decide whether to use unconditional
4916 branch or duplicate the code on its destination.  Code is duplicated when its
4917 estimated size is smaller than this value multiplied by the estimated size of
4918 unconditional jump in the hot spots of the program.
4920 The @option{reorder-block-duplicate-feedback} is used only when profile
4921 feedback is available and may be set to higher values than
4922 @option{reorder-block-duplicate} since information about the hot spots is more
4923 accurate.
4924 @end table
4925 @end table
4927 @node Preprocessor Options
4928 @section Options Controlling the Preprocessor
4929 @cindex preprocessor options
4930 @cindex options, preprocessor
4932 These options control the C preprocessor, which is run on each C source
4933 file before actual compilation.
4935 If you use the @option{-E} option, nothing is done except preprocessing.
4936 Some of these options make sense only together with @option{-E} because
4937 they cause the preprocessor output to be unsuitable for actual
4938 compilation.
4940 @table @gcctabopt
4941 @opindex Wp
4942 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4943 and pass @var{option} directly through to the preprocessor.  If
4944 @var{option} contains commas, it is split into multiple options at the
4945 commas.  However, many options are modified, translated or interpreted
4946 by the compiler driver before being passed to the preprocessor, and
4947 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4948 interface is undocumented and subject to change, so whenever possible
4949 you should avoid using @option{-Wp} and let the driver handle the
4950 options instead.
4952 @item -Xpreprocessor @var{option}
4953 @opindex preprocessor
4954 Pass @var{option} as an option to the preprocessor.  You can use this to
4955 supply system-specific preprocessor options which GCC does not know how to
4956 recognize.
4958 If you want to pass an option that takes an argument, you must use
4959 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4960 @end table
4962 @include cppopts.texi
4964 @node Assembler Options
4965 @section Passing Options to the Assembler
4967 @c prevent bad page break with this line
4968 You can pass options to the assembler.
4970 @table @gcctabopt
4971 @item -Wa,@var{option}
4972 @opindex Wa
4973 Pass @var{option} as an option to the assembler.  If @var{option}
4974 contains commas, it is split into multiple options at the commas.
4976 @item -Xassembler @var{option}
4977 @opindex Xassembler
4978 Pass @var{option} as an option to the assembler.  You can use this to
4979 supply system-specific assembler options which GCC does not know how to
4980 recognize.
4982 If you want to pass an option that takes an argument, you must use
4983 @option{-Xassembler} twice, once for the option and once for the argument.
4985 @end table
4987 @node Link Options
4988 @section Options for Linking
4989 @cindex link options
4990 @cindex options, linking
4992 These options come into play when the compiler links object files into
4993 an executable output file.  They are meaningless if the compiler is
4994 not doing a link step.
4996 @table @gcctabopt
4997 @cindex file names
4998 @item @var{object-file-name}
4999 A file name that does not end in a special recognized suffix is
5000 considered to name an object file or library.  (Object files are
5001 distinguished from libraries by the linker according to the file
5002 contents.)  If linking is done, these object files are used as input
5003 to the linker.
5005 @item -c
5006 @itemx -S
5007 @itemx -E
5008 @opindex c
5009 @opindex S
5010 @opindex E
5011 If any of these options is used, then the linker is not run, and
5012 object file names should not be used as arguments.  @xref{Overall
5013 Options}.
5015 @cindex Libraries
5016 @item -l@var{library}
5017 @itemx -l @var{library}
5018 @opindex l
5019 Search the library named @var{library} when linking.  (The second
5020 alternative with the library as a separate argument is only for
5021 POSIX compliance and is not recommended.)
5023 It makes a difference where in the command you write this option; the
5024 linker searches and processes libraries and object files in the order they
5025 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5026 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5027 to functions in @samp{z}, those functions may not be loaded.
5029 The linker searches a standard list of directories for the library,
5030 which is actually a file named @file{lib@var{library}.a}.  The linker
5031 then uses this file as if it had been specified precisely by name.
5033 The directories searched include several standard system directories
5034 plus any that you specify with @option{-L}.
5036 Normally the files found this way are library files---archive files
5037 whose members are object files.  The linker handles an archive file by
5038 scanning through it for members which define symbols that have so far
5039 been referenced but not defined.  But if the file that is found is an
5040 ordinary object file, it is linked in the usual fashion.  The only
5041 difference between using an @option{-l} option and specifying a file name
5042 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5043 and searches several directories.
5045 @item -lobjc
5046 @opindex lobjc
5047 You need this special case of the @option{-l} option in order to
5048 link an Objective-C program.
5050 @item -nostartfiles
5051 @opindex nostartfiles
5052 Do not use the standard system startup files when linking.
5053 The standard system libraries are used normally, unless @option{-nostdlib}
5054 or @option{-nodefaultlibs} is used.
5056 @item -nodefaultlibs
5057 @opindex nodefaultlibs
5058 Do not use the standard system libraries when linking.
5059 Only the libraries you specify will be passed to the linker.
5060 The standard startup files are used normally, unless @option{-nostartfiles}
5061 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5062 for System V (and ISO C) environments or to bcopy and bzero for
5063 BSD environments.  These entries are usually resolved by entries in
5064 libc.  These entry points should be supplied through some other
5065 mechanism when this option is specified.
5067 @item -nostdlib
5068 @opindex nostdlib
5069 Do not use the standard system startup files or libraries when linking.
5070 No startup files and only the libraries you specify will be passed to
5071 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5072 for System V (and ISO C) environments or to bcopy and bzero for
5073 BSD environments.  These entries are usually resolved by entries in
5074 libc.  These entry points should be supplied through some other
5075 mechanism when this option is specified.
5077 @cindex @option{-lgcc}, use with @option{-nostdlib}
5078 @cindex @option{-nostdlib} and unresolved references
5079 @cindex unresolved references and @option{-nostdlib}
5080 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5081 @cindex @option{-nodefaultlibs} and unresolved references
5082 @cindex unresolved references and @option{-nodefaultlibs}
5083 One of the standard libraries bypassed by @option{-nostdlib} and
5084 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5085 that GCC uses to overcome shortcomings of particular machines, or special
5086 needs for some languages.
5087 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5088 Collection (GCC) Internals},
5089 for more discussion of @file{libgcc.a}.)
5090 In most cases, you need @file{libgcc.a} even when you want to avoid
5091 other standard libraries.  In other words, when you specify @option{-nostdlib}
5092 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5093 This ensures that you have no unresolved references to internal GCC
5094 library subroutines.  (For example, @samp{__main}, used to ensure C++
5095 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5096 GNU Compiler Collection (GCC) Internals}.)
5098 @item -pie
5099 @opindex pie
5100 Produce a position independent executable on targets which support it.
5101 For predictable results, you must also specify the same set of options
5102 that were used to generate code (@option{-fpie}, @option{-fPIE},
5103 or model suboptions) when you specify this option.
5105 @item -s
5106 @opindex s
5107 Remove all symbol table and relocation information from the executable.
5109 @item -static
5110 @opindex static
5111 On systems that support dynamic linking, this prevents linking with the shared
5112 libraries.  On other systems, this option has no effect.
5114 @item -shared
5115 @opindex shared
5116 Produce a shared object which can then be linked with other objects to
5117 form an executable.  Not all systems support this option.  For predictable
5118 results, you must also specify the same set of options that were used to
5119 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5120 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5121 needs to build supplementary stub code for constructors to work.  On
5122 multi-libbed systems, @samp{gcc -shared} must select the correct support
5123 libraries to link against.  Failing to supply the correct flags may lead
5124 to subtle defects.  Supplying them in cases where they are not necessary
5125 is innocuous.}
5127 @item -shared-libgcc
5128 @itemx -static-libgcc
5129 @opindex shared-libgcc
5130 @opindex static-libgcc
5131 On systems that provide @file{libgcc} as a shared library, these options
5132 force the use of either the shared or static version respectively.
5133 If no shared version of @file{libgcc} was built when the compiler was
5134 configured, these options have no effect.
5136 There are several situations in which an application should use the
5137 shared @file{libgcc} instead of the static version.  The most common
5138 of these is when the application wishes to throw and catch exceptions
5139 across different shared libraries.  In that case, each of the libraries
5140 as well as the application itself should use the shared @file{libgcc}.
5142 Therefore, the G++ and GCJ drivers automatically add
5143 @option{-shared-libgcc} whenever you build a shared library or a main
5144 executable, because C++ and Java programs typically use exceptions, so
5145 this is the right thing to do.
5147 If, instead, you use the GCC driver to create shared libraries, you may
5148 find that they will not always be linked with the shared @file{libgcc}.
5149 If GCC finds, at its configuration time, that you have a GNU linker that
5150 does not support option @option{--eh-frame-hdr}, it will link the shared
5151 version of @file{libgcc} into shared libraries by default.  Otherwise,
5152 it will take advantage of the linker and optimize away the linking with
5153 the shared version of @file{libgcc}, linking with the static version of
5154 libgcc by default.  This allows exceptions to propagate through such
5155 shared libraries, without incurring relocation costs at library load
5156 time.
5158 However, if a library or main executable is supposed to throw or catch
5159 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5160 for the languages used in the program, or using the option
5161 @option{-shared-libgcc}, such that it is linked with the shared
5162 @file{libgcc}.
5164 @item -symbolic
5165 @opindex symbolic
5166 Bind references to global symbols when building a shared object.  Warn
5167 about any unresolved references (unless overridden by the link editor
5168 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5169 this option.
5171 @item -Xlinker @var{option}
5172 @opindex Xlinker
5173 Pass @var{option} as an option to the linker.  You can use this to
5174 supply system-specific linker options which GCC does not know how to
5175 recognize.
5177 If you want to pass an option that takes an argument, you must use
5178 @option{-Xlinker} twice, once for the option and once for the argument.
5179 For example, to pass @option{-assert definitions}, you must write
5180 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5181 @option{-Xlinker "-assert definitions"}, because this passes the entire
5182 string as a single argument, which is not what the linker expects.
5184 @item -Wl,@var{option}
5185 @opindex Wl
5186 Pass @var{option} as an option to the linker.  If @var{option} contains
5187 commas, it is split into multiple options at the commas.
5189 @item -u @var{symbol}
5190 @opindex u
5191 Pretend the symbol @var{symbol} is undefined, to force linking of
5192 library modules to define it.  You can use @option{-u} multiple times with
5193 different symbols to force loading of additional library modules.
5194 @end table
5196 @node Directory Options
5197 @section Options for Directory Search
5198 @cindex directory options
5199 @cindex options, directory search
5200 @cindex search path
5202 These options specify directories to search for header files, for
5203 libraries and for parts of the compiler:
5205 @table @gcctabopt
5206 @item -I@var{dir}
5207 @opindex I
5208 Add the directory @var{dir} to the head of the list of directories to be
5209 searched for header files.  This can be used to override a system header
5210 file, substituting your own version, since these directories are
5211 searched before the system header file directories.  However, you should
5212 not use this option to add directories that contain vendor-supplied
5213 system header files (use @option{-isystem} for that).  If you use more than
5214 one @option{-I} option, the directories are scanned in left-to-right
5215 order; the standard system directories come after.
5217 If a standard system include directory, or a directory specified with
5218 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5219 option will be ignored.  The directory will still be searched but as a
5220 system directory at its normal position in the system include chain.
5221 This is to ensure that GCC's procedure to fix buggy system headers and
5222 the ordering for the include_next directive are not inadvertently changed.
5223 If you really need to change the search order for system directories,
5224 use the @option{-nostdinc} and/or @option{-isystem} options.
5226 @item -I-
5227 @opindex I-
5228 Any directories you specify with @option{-I} options before the @option{-I-}
5229 option are searched only for the case of @samp{#include "@var{file}"};
5230 they are not searched for @samp{#include <@var{file}>}.
5232 If additional directories are specified with @option{-I} options after
5233 the @option{-I-}, these directories are searched for all @samp{#include}
5234 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5235 this way.)
5237 In addition, the @option{-I-} option inhibits the use of the current
5238 directory (where the current input file came from) as the first search
5239 directory for @samp{#include "@var{file}"}.  There is no way to
5240 override this effect of @option{-I-}.  With @option{-I.} you can specify
5241 searching the directory which was current when the compiler was
5242 invoked.  That is not exactly the same as what the preprocessor does
5243 by default, but it is often satisfactory.
5245 @option{-I-} does not inhibit the use of the standard system directories
5246 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5247 independent.
5249 @item -L@var{dir}
5250 @opindex L
5251 Add directory @var{dir} to the list of directories to be searched
5252 for @option{-l}.
5254 @item -B@var{prefix}
5255 @opindex B
5256 This option specifies where to find the executables, libraries,
5257 include files, and data files of the compiler itself.
5259 The compiler driver program runs one or more of the subprograms
5260 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5261 @var{prefix} as a prefix for each program it tries to run, both with and
5262 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5264 For each subprogram to be run, the compiler driver first tries the
5265 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5266 was not specified, the driver tries two standard prefixes, which are
5267 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5268 those results in a file name that is found, the unmodified program
5269 name is searched for using the directories specified in your
5270 @env{PATH} environment variable.
5272 The compiler will check to see if the path provided by the @option{-B}
5273 refers to a directory, and if necessary it will add a directory
5274 separator character at the end of the path.
5276 @option{-B} prefixes that effectively specify directory names also apply
5277 to libraries in the linker, because the compiler translates these
5278 options into @option{-L} options for the linker.  They also apply to
5279 includes files in the preprocessor, because the compiler translates these
5280 options into @option{-isystem} options for the preprocessor.  In this case,
5281 the compiler appends @samp{include} to the prefix.
5283 The run-time support file @file{libgcc.a} can also be searched for using
5284 the @option{-B} prefix, if needed.  If it is not found there, the two
5285 standard prefixes above are tried, and that is all.  The file is left
5286 out of the link if it is not found by those means.
5288 Another way to specify a prefix much like the @option{-B} prefix is to use
5289 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5290 Variables}.
5292 As a special kludge, if the path provided by @option{-B} is
5293 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5294 9, then it will be replaced by @file{[dir/]include}.  This is to help
5295 with boot-strapping the compiler.
5297 @item -specs=@var{file}
5298 @opindex specs
5299 Process @var{file} after the compiler reads in the standard @file{specs}
5300 file, in order to override the defaults that the @file{gcc} driver
5301 program uses when determining what switches to pass to @file{cc1},
5302 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5303 @option{-specs=@var{file}} can be specified on the command line, and they
5304 are processed in order, from left to right.
5305 @end table
5307 @c man end
5309 @node Spec Files
5310 @section Specifying subprocesses and the switches to pass to them
5311 @cindex Spec Files
5313 @command{gcc} is a driver program.  It performs its job by invoking a
5314 sequence of other programs to do the work of compiling, assembling and
5315 linking.  GCC interprets its command-line parameters and uses these to
5316 deduce which programs it should invoke, and which command-line options
5317 it ought to place on their command lines.  This behavior is controlled
5318 by @dfn{spec strings}.  In most cases there is one spec string for each
5319 program that GCC can invoke, but a few programs have multiple spec
5320 strings to control their behavior.  The spec strings built into GCC can
5321 be overridden by using the @option{-specs=} command-line switch to specify
5322 a spec file.
5324 @dfn{Spec files} are plaintext files that are used to construct spec
5325 strings.  They consist of a sequence of directives separated by blank
5326 lines.  The type of directive is determined by the first non-whitespace
5327 character on the line and it can be one of the following:
5329 @table @code
5330 @item %@var{command}
5331 Issues a @var{command} to the spec file processor.  The commands that can
5332 appear here are:
5334 @table @code
5335 @item %include <@var{file}>
5336 @cindex %include
5337 Search for @var{file} and insert its text at the current point in the
5338 specs file.
5340 @item %include_noerr <@var{file}>
5341 @cindex %include_noerr
5342 Just like @samp{%include}, but do not generate an error message if the include
5343 file cannot be found.
5345 @item %rename @var{old_name} @var{new_name}
5346 @cindex %rename
5347 Rename the spec string @var{old_name} to @var{new_name}.
5349 @end table
5351 @item *[@var{spec_name}]:
5352 This tells the compiler to create, override or delete the named spec
5353 string.  All lines after this directive up to the next directive or
5354 blank line are considered to be the text for the spec string.  If this
5355 results in an empty string then the spec will be deleted.  (Or, if the
5356 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5357 does not currently exist a new spec will be created.  If the spec does
5358 exist then its contents will be overridden by the text of this
5359 directive, unless the first character of that text is the @samp{+}
5360 character, in which case the text will be appended to the spec.
5362 @item [@var{suffix}]:
5363 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5364 and up to the next directive or blank line are considered to make up the
5365 spec string for the indicated suffix.  When the compiler encounters an
5366 input file with the named suffix, it will processes the spec string in
5367 order to work out how to compile that file.  For example:
5369 @smallexample
5370 .ZZ:
5371 z-compile -input %i
5372 @end smallexample
5374 This says that any input file whose name ends in @samp{.ZZ} should be
5375 passed to the program @samp{z-compile}, which should be invoked with the
5376 command-line switch @option{-input} and with the result of performing the
5377 @samp{%i} substitution.  (See below.)
5379 As an alternative to providing a spec string, the text that follows a
5380 suffix directive can be one of the following:
5382 @table @code
5383 @item @@@var{language}
5384 This says that the suffix is an alias for a known @var{language}.  This is
5385 similar to using the @option{-x} command-line switch to GCC to specify a
5386 language explicitly.  For example:
5388 @smallexample
5389 .ZZ:
5390 @@c++
5391 @end smallexample
5393 Says that .ZZ files are, in fact, C++ source files.
5395 @item #@var{name}
5396 This causes an error messages saying:
5398 @smallexample
5399 @var{name} compiler not installed on this system.
5400 @end smallexample
5401 @end table
5403 GCC already has an extensive list of suffixes built into it.
5404 This directive will add an entry to the end of the list of suffixes, but
5405 since the list is searched from the end backwards, it is effectively
5406 possible to override earlier entries using this technique.
5408 @end table
5410 GCC has the following spec strings built into it.  Spec files can
5411 override these strings or create their own.  Note that individual
5412 targets can also add their own spec strings to this list.
5414 @smallexample
5415 asm          Options to pass to the assembler
5416 asm_final    Options to pass to the assembler post-processor
5417 cpp          Options to pass to the C preprocessor
5418 cc1          Options to pass to the C compiler
5419 cc1plus      Options to pass to the C++ compiler
5420 endfile      Object files to include at the end of the link
5421 link         Options to pass to the linker
5422 lib          Libraries to include on the command line to the linker
5423 libgcc       Decides which GCC support library to pass to the linker
5424 linker       Sets the name of the linker
5425 predefines   Defines to be passed to the C preprocessor
5426 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5427              by default
5428 startfile    Object files to include at the start of the link
5429 @end smallexample
5431 Here is a small example of a spec file:
5433 @smallexample
5434 %rename lib                 old_lib
5436 *lib:
5437 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5438 @end smallexample
5440 This example renames the spec called @samp{lib} to @samp{old_lib} and
5441 then overrides the previous definition of @samp{lib} with a new one.
5442 The new definition adds in some extra command-line options before
5443 including the text of the old definition.
5445 @dfn{Spec strings} are a list of command-line options to be passed to their
5446 corresponding program.  In addition, the spec strings can contain
5447 @samp{%}-prefixed sequences to substitute variable text or to
5448 conditionally insert text into the command line.  Using these constructs
5449 it is possible to generate quite complex command lines.
5451 Here is a table of all defined @samp{%}-sequences for spec
5452 strings.  Note that spaces are not generated automatically around the
5453 results of expanding these sequences.  Therefore you can concatenate them
5454 together or combine them with constant text in a single argument.
5456 @table @code
5457 @item %%
5458 Substitute one @samp{%} into the program name or argument.
5460 @item %i
5461 Substitute the name of the input file being processed.
5463 @item %b
5464 Substitute the basename of the input file being processed.
5465 This is the substring up to (and not including) the last period
5466 and not including the directory.
5468 @item %B
5469 This is the same as @samp{%b}, but include the file suffix (text after
5470 the last period).
5472 @item %d
5473 Marks the argument containing or following the @samp{%d} as a
5474 temporary file name, so that that file will be deleted if GCC exits
5475 successfully.  Unlike @samp{%g}, this contributes no text to the
5476 argument.
5478 @item %g@var{suffix}
5479 Substitute a file name that has suffix @var{suffix} and is chosen
5480 once per compilation, and mark the argument in the same way as
5481 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5482 name is now chosen in a way that is hard to predict even when previously
5483 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5484 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5485 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5486 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5487 was simply substituted with a file name chosen once per compilation,
5488 without regard to any appended suffix (which was therefore treated
5489 just like ordinary text), making such attacks more likely to succeed.
5491 @item %u@var{suffix}
5492 Like @samp{%g}, but generates a new temporary file name even if
5493 @samp{%u@var{suffix}} was already seen.
5495 @item %U@var{suffix}
5496 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5497 new one if there is no such last file name.  In the absence of any
5498 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5499 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5500 would involve the generation of two distinct file names, one
5501 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5502 simply substituted with a file name chosen for the previous @samp{%u},
5503 without regard to any appended suffix.
5505 @item %j@var{suffix}
5506 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5507 writable, and if save-temps is off; otherwise, substitute the name
5508 of a temporary file, just like @samp{%u}.  This temporary file is not
5509 meant for communication between processes, but rather as a junk
5510 disposal mechanism.
5512 @item %|@var{suffix}
5513 @itemx %m@var{suffix}
5514 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5515 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5516 all.  These are the two most common ways to instruct a program that it
5517 should read from standard input or write to standard output.  If you
5518 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5519 construct: see for example @file{f/lang-specs.h}.
5521 @item %.@var{SUFFIX}
5522 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5523 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5524 terminated by the next space or %.
5526 @item %w
5527 Marks the argument containing or following the @samp{%w} as the
5528 designated output file of this compilation.  This puts the argument
5529 into the sequence of arguments that @samp{%o} will substitute later.
5531 @item %o
5532 Substitutes the names of all the output files, with spaces
5533 automatically placed around them.  You should write spaces
5534 around the @samp{%o} as well or the results are undefined.
5535 @samp{%o} is for use in the specs for running the linker.
5536 Input files whose names have no recognized suffix are not compiled
5537 at all, but they are included among the output files, so they will
5538 be linked.
5540 @item %O
5541 Substitutes the suffix for object files.  Note that this is
5542 handled specially when it immediately follows @samp{%g, %u, or %U},
5543 because of the need for those to form complete file names.  The
5544 handling is such that @samp{%O} is treated exactly as if it had already
5545 been substituted, except that @samp{%g, %u, and %U} do not currently
5546 support additional @var{suffix} characters following @samp{%O} as they would
5547 following, for example, @samp{.o}.
5549 @item %p
5550 Substitutes the standard macro predefinitions for the
5551 current target machine.  Use this when running @code{cpp}.
5553 @item %P
5554 Like @samp{%p}, but puts @samp{__} before and after the name of each
5555 predefined macro, except for macros that start with @samp{__} or with
5556 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5559 @item %I
5560 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5561 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5562 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5563 as necessary.
5565 @item %s
5566 Current argument is the name of a library or startup file of some sort.
5567 Search for that file in a standard list of directories and substitute
5568 the full name found.
5570 @item %e@var{str}
5571 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5572 Use this when inconsistent options are detected.
5574 @item %(@var{name})
5575 Substitute the contents of spec string @var{name} at this point.
5577 @item %[@var{name}]
5578 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5580 @item %x@{@var{option}@}
5581 Accumulate an option for @samp{%X}.
5583 @item %X
5584 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5585 spec string.
5587 @item %Y
5588 Output the accumulated assembler options specified by @option{-Wa}.
5590 @item %Z
5591 Output the accumulated preprocessor options specified by @option{-Wp}.
5593 @item %a
5594 Process the @code{asm} spec.  This is used to compute the
5595 switches to be passed to the assembler.
5597 @item %A
5598 Process the @code{asm_final} spec.  This is a spec string for
5599 passing switches to an assembler post-processor, if such a program is
5600 needed.
5602 @item %l
5603 Process the @code{link} spec.  This is the spec for computing the
5604 command line passed to the linker.  Typically it will make use of the
5605 @samp{%L %G %S %D and %E} sequences.
5607 @item %D
5608 Dump out a @option{-L} option for each directory that GCC believes might
5609 contain startup files.  If the target supports multilibs then the
5610 current multilib directory will be prepended to each of these paths.
5612 @item %M
5613 Output the multilib directory with directory separators replaced with
5614 @samp{_}.  If multilib directories are not set, or the multilib directory is
5615 @file{.} then this option emits nothing.
5617 @item %L
5618 Process the @code{lib} spec.  This is a spec string for deciding which
5619 libraries should be included on the command line to the linker.
5621 @item %G
5622 Process the @code{libgcc} spec.  This is a spec string for deciding
5623 which GCC support library should be included on the command line to the linker.
5625 @item %S
5626 Process the @code{startfile} spec.  This is a spec for deciding which
5627 object files should be the first ones passed to the linker.  Typically
5628 this might be a file named @file{crt0.o}.
5630 @item %E
5631 Process the @code{endfile} spec.  This is a spec string that specifies
5632 the last object files that will be passed to the linker.
5634 @item %C
5635 Process the @code{cpp} spec.  This is used to construct the arguments
5636 to be passed to the C preprocessor.
5638 @item %c
5639 Process the @code{signed_char} spec.  This is intended to be used
5640 to tell cpp whether a char is signed.  It typically has the definition:
5641 @smallexample
5642 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5643 @end smallexample
5645 @item %1
5646 Process the @code{cc1} spec.  This is used to construct the options to be
5647 passed to the actual C compiler (@samp{cc1}).
5649 @item %2
5650 Process the @code{cc1plus} spec.  This is used to construct the options to be
5651 passed to the actual C++ compiler (@samp{cc1plus}).
5653 @item %*
5654 Substitute the variable part of a matched option.  See below.
5655 Note that each comma in the substituted string is replaced by
5656 a single space.
5658 @item %<@code{S}
5659 Remove all occurrences of @code{-S} from the command line.  Note---this
5660 command is position dependent.  @samp{%} commands in the spec string
5661 before this one will see @code{-S}, @samp{%} commands in the spec string
5662 after this one will not.
5664 @item %:@var{function}(@var{args})
5665 Call the named function @var{function}, passing it @var{args}.
5666 @var{args} is first processed as a nested spec string, then split
5667 into an argument vector in the usual fashion.  The function returns
5668 a string which is processed as if it had appeared literally as part
5669 of the current spec.
5671 The following built-in spec functions are provided:
5673 @table @code
5674 @item @code{if-exists}
5675 The @code{if-exists} spec function takes one argument, an absolute
5676 pathname to a file.  If the file exists, @code{if-exists} returns the
5677 pathname.  Here is a small example of its usage:
5679 @smallexample
5680 *startfile:
5681 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5682 @end smallexample
5684 @item @code{if-exists-else}
5685 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5686 spec function, except that it takes two arguments.  The first argument is
5687 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5688 returns the pathname.  If it does not exist, it returns the second argument.
5689 This way, @code{if-exists-else} can be used to select one file or another,
5690 based on the existence of the first.  Here is a small example of its usage:
5692 @smallexample 
5693 *startfile:
5694 crt0%O%s %:if-exists(crti%O%s) \
5695 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5696 @end smallexample
5697 @end table 
5699 @item %@{@code{S}@}
5700 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5701 If that switch was not specified, this substitutes nothing.  Note that
5702 the leading dash is omitted when specifying this option, and it is
5703 automatically inserted if the substitution is performed.  Thus the spec
5704 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5705 and would output the command line option @option{-foo}.
5707 @item %W@{@code{S}@}
5708 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5709 deleted on failure.
5711 @item %@{@code{S}*@}
5712 Substitutes all the switches specified to GCC whose names start
5713 with @code{-S}, but which also take an argument.  This is used for
5714 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5715 GCC considers @option{-o foo} as being
5716 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5717 text, including the space.  Thus two arguments would be generated.
5719 @item %@{@code{S}*&@code{T}*@}
5720 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5721 (the order of @code{S} and @code{T} in the spec is not significant).
5722 There can be any number of ampersand-separated variables; for each the
5723 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5725 @item %@{@code{S}:@code{X}@}
5726 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5728 @item %@{!@code{S}:@code{X}@}
5729 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5731 @item %@{@code{S}*:@code{X}@}
5732 Substitutes @code{X} if one or more switches whose names start with
5733 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5734 once, no matter how many such switches appeared.  However, if @code{%*}
5735 appears somewhere in @code{X}, then @code{X} will be substituted once
5736 for each matching switch, with the @code{%*} replaced by the part of
5737 that switch that matched the @code{*}.
5739 @item %@{.@code{S}:@code{X}@}
5740 Substitutes @code{X}, if processing a file with suffix @code{S}.
5742 @item %@{!.@code{S}:@code{X}@}
5743 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5745 @item %@{@code{S}|@code{P}:@code{X}@}
5746 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5747 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5748 although they have a stronger binding than the @samp{|}.  If @code{%*}
5749 appears in @code{X}, all of the alternatives must be starred, and only
5750 the first matching alternative is substituted.
5752 For example, a spec string like this:
5754 @smallexample
5755 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5756 @end smallexample
5758 will output the following command-line options from the following input
5759 command-line options:
5761 @smallexample
5762 fred.c        -foo -baz
5763 jim.d         -bar -boggle
5764 -d fred.c     -foo -baz -boggle
5765 -d jim.d      -bar -baz -boggle
5766 @end smallexample
5768 @item %@{S:X; T:Y; :D@}
5770 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5771 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5772 be as many clauses as you need.  This may be combined with @code{.}, 
5773 @code{!}, @code{|}, and @code{*} as needed.
5776 @end table
5778 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5779 construct may contain other nested @samp{%} constructs or spaces, or
5780 even newlines.  They are processed as usual, as described above.
5781 Trailing white space in @code{X} is ignored.  White space may also
5782 appear anywhere on the left side of the colon in these constructs,
5783 except between @code{.} or @code{*} and the corresponding word.
5785 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5786 handled specifically in these constructs.  If another value of
5787 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5788 @option{-W} switch is found later in the command line, the earlier
5789 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5790 just one letter, which passes all matching options.
5792 The character @samp{|} at the beginning of the predicate text is used to
5793 indicate that a command should be piped to the following command, but
5794 only if @option{-pipe} is specified.
5796 It is built into GCC which switches take arguments and which do not.
5797 (You might think it would be useful to generalize this to allow each
5798 compiler's spec to say which switches take arguments.  But this cannot
5799 be done in a consistent fashion.  GCC cannot even decide which input
5800 files have been specified without knowing which switches take arguments,
5801 and it must know which input files to compile in order to tell which
5802 compilers to run).
5804 GCC also knows implicitly that arguments starting in @option{-l} are to be
5805 treated as compiler output files, and passed to the linker in their
5806 proper position among the other output files.
5808 @c man begin OPTIONS
5810 @node Target Options
5811 @section Specifying Target Machine and Compiler Version
5812 @cindex target options
5813 @cindex cross compiling
5814 @cindex specifying machine version
5815 @cindex specifying compiler version and target machine
5816 @cindex compiler version, specifying
5817 @cindex target machine, specifying
5819 The usual way to run GCC is to run the executable called @file{gcc}, or
5820 @file{<machine>-gcc} when cross-compiling, or
5821 @file{<machine>-gcc-<version>} to run a version other than the one that
5822 was installed last.  Sometimes this is inconvenient, so GCC provides
5823 options that will switch to another cross-compiler or version.
5825 @table @gcctabopt
5826 @item -b @var{machine}
5827 @opindex b
5828 The argument @var{machine} specifies the target machine for compilation.
5830 The value to use for @var{machine} is the same as was specified as the
5831 machine type when configuring GCC as a cross-compiler.  For
5832 example, if a cross-compiler was configured with @samp{configure
5833 i386v}, meaning to compile for an 80386 running System V, then you
5834 would specify @option{-b i386v} to run that cross compiler.
5836 @item -V @var{version}
5837 @opindex V
5838 The argument @var{version} specifies which version of GCC to run.
5839 This is useful when multiple versions are installed.  For example,
5840 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5841 @end table
5843 The @option{-V} and @option{-b} options work by running the
5844 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5845 use them if you can just run that directly.
5847 @node Submodel Options
5848 @section Hardware Models and Configurations
5849 @cindex submodel options
5850 @cindex specifying hardware config
5851 @cindex hardware models and configurations, specifying
5852 @cindex machine dependent options
5854 Earlier we discussed the standard option @option{-b} which chooses among
5855 different installed compilers for completely different target
5856 machines, such as VAX vs.@: 68000 vs.@: 80386.
5858 In addition, each of these target machine types can have its own
5859 special options, starting with @samp{-m}, to choose among various
5860 hardware models or configurations---for example, 68010 vs 68020,
5861 floating coprocessor or none.  A single installed version of the
5862 compiler can compile for any model or configuration, according to the
5863 options specified.
5865 Some configurations of the compiler also support additional special
5866 options, usually for compatibility with other compilers on the same
5867 platform.
5869 These options are defined by the macro @code{TARGET_SWITCHES} in the
5870 machine description.  The default for the options is also defined by
5871 that macro, which enables you to change the defaults.
5873 @menu
5874 * M680x0 Options::
5875 * M68hc1x Options::
5876 * VAX Options::
5877 * SPARC Options::
5878 * ARM Options::
5879 * MN10200 Options::
5880 * MN10300 Options::
5881 * M32R/D Options::
5882 * M88K Options::
5883 * RS/6000 and PowerPC Options::
5884 * Darwin Options::
5885 * RT Options::
5886 * MIPS Options::
5887 * i386 and x86-64 Options::
5888 * HPPA Options::
5889 * Intel 960 Options::
5890 * DEC Alpha Options::
5891 * DEC Alpha/VMS Options::
5892 * H8/300 Options::
5893 * SH Options::
5894 * System V Options::
5895 * TMS320C3x/C4x Options::
5896 * V850 Options::
5897 * ARC Options::
5898 * NS32K Options::
5899 * AVR Options::
5900 * MCore Options::
5901 * IA-64 Options::
5902 * D30V Options::
5903 * S/390 and zSeries Options::
5904 * CRIS Options::
5905 * MMIX Options::
5906 * PDP-11 Options::
5907 * Xstormy16 Options::
5908 * Xtensa Options::
5909 * FRV Options::
5910 @end menu
5912 @node M680x0 Options
5913 @subsection M680x0 Options
5914 @cindex M680x0 options
5916 These are the @samp{-m} options defined for the 68000 series.  The default
5917 values for these options depends on which style of 68000 was selected when
5918 the compiler was configured; the defaults for the most common choices are
5919 given below.
5921 @table @gcctabopt
5922 @item -m68000
5923 @itemx -mc68000
5924 @opindex m68000
5925 @opindex mc68000
5926 Generate output for a 68000.  This is the default
5927 when the compiler is configured for 68000-based systems.
5929 Use this option for microcontrollers with a 68000 or EC000 core,
5930 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5932 @item -m68020
5933 @itemx -mc68020
5934 @opindex m68020
5935 @opindex mc68020
5936 Generate output for a 68020.  This is the default
5937 when the compiler is configured for 68020-based systems.
5939 @item -m68881
5940 @opindex m68881
5941 Generate output containing 68881 instructions for floating point.
5942 This is the default for most 68020 systems unless @option{--nfp} was
5943 specified when the compiler was configured.
5945 @item -m68030
5946 @opindex m68030
5947 Generate output for a 68030.  This is the default when the compiler is
5948 configured for 68030-based systems.
5950 @item -m68040
5951 @opindex m68040
5952 Generate output for a 68040.  This is the default when the compiler is
5953 configured for 68040-based systems.
5955 This option inhibits the use of 68881/68882 instructions that have to be
5956 emulated by software on the 68040.  Use this option if your 68040 does not
5957 have code to emulate those instructions.
5959 @item -m68060
5960 @opindex m68060
5961 Generate output for a 68060.  This is the default when the compiler is
5962 configured for 68060-based systems.
5964 This option inhibits the use of 68020 and 68881/68882 instructions that
5965 have to be emulated by software on the 68060.  Use this option if your 68060
5966 does not have code to emulate those instructions.
5968 @item -mcpu32
5969 @opindex mcpu32
5970 Generate output for a CPU32.  This is the default
5971 when the compiler is configured for CPU32-based systems.
5973 Use this option for microcontrollers with a
5974 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5975 68336, 68340, 68341, 68349 and 68360.
5977 @item -m5200
5978 @opindex m5200
5979 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5980 when the compiler is configured for 520X-based systems.
5982 Use this option for microcontroller with a 5200 core, including
5983 the MCF5202, MCF5203, MCF5204 and MCF5202.
5986 @item -m68020-40
5987 @opindex m68020-40
5988 Generate output for a 68040, without using any of the new instructions.
5989 This results in code which can run relatively efficiently on either a
5990 68020/68881 or a 68030 or a 68040.  The generated code does use the
5991 68881 instructions that are emulated on the 68040.
5993 @item -m68020-60
5994 @opindex m68020-60
5995 Generate output for a 68060, without using any of the new instructions.
5996 This results in code which can run relatively efficiently on either a
5997 68020/68881 or a 68030 or a 68040.  The generated code does use the
5998 68881 instructions that are emulated on the 68060.
6000 @item -msoft-float
6001 @opindex msoft-float
6002 Generate output containing library calls for floating point.
6003 @strong{Warning:} the requisite libraries are not available for all m68k
6004 targets.  Normally the facilities of the machine's usual C compiler are
6005 used, but this can't be done directly in cross-compilation.  You must
6006 make your own arrangements to provide suitable library functions for
6007 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
6008 @samp{m68k-*-coff} do provide software floating point support.
6010 @item -mshort
6011 @opindex mshort
6012 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6014 @item -mnobitfield
6015 @opindex mnobitfield
6016 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
6017 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
6019 @item -mbitfield
6020 @opindex mbitfield
6021 Do use the bit-field instructions.  The @option{-m68020} option implies
6022 @option{-mbitfield}.  This is the default if you use a configuration
6023 designed for a 68020.
6025 @item -mrtd
6026 @opindex mrtd
6027 Use a different function-calling convention, in which functions
6028 that take a fixed number of arguments return with the @code{rtd}
6029 instruction, which pops their arguments while returning.  This
6030 saves one instruction in the caller since there is no need to pop
6031 the arguments there.
6033 This calling convention is incompatible with the one normally
6034 used on Unix, so you cannot use it if you need to call libraries
6035 compiled with the Unix compiler.
6037 Also, you must provide function prototypes for all functions that
6038 take variable numbers of arguments (including @code{printf});
6039 otherwise incorrect code will be generated for calls to those
6040 functions.
6042 In addition, seriously incorrect code will result if you call a
6043 function with too many arguments.  (Normally, extra arguments are
6044 harmlessly ignored.)
6046 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6047 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6049 @item -malign-int
6050 @itemx -mno-align-int
6051 @opindex malign-int
6052 @opindex mno-align-int
6053 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6054 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6055 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6056 Aligning variables on 32-bit boundaries produces code that runs somewhat
6057 faster on processors with 32-bit busses at the expense of more memory.
6059 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6060 align structures containing the above types  differently than
6061 most published application binary interface specifications for the m68k.
6063 @item -mpcrel
6064 @opindex mpcrel
6065 Use the pc-relative addressing mode of the 68000 directly, instead of
6066 using a global offset table.  At present, this option implies @option{-fpic},
6067 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6068 not presently supported with @option{-mpcrel}, though this could be supported for
6069 68020 and higher processors.
6071 @item -mno-strict-align
6072 @itemx -mstrict-align
6073 @opindex mno-strict-align
6074 @opindex mstrict-align
6075 Do not (do) assume that unaligned memory references will be handled by
6076 the system.
6078 @item -msep-data
6079 Generate code that allows the data segment to be located in a different
6080 area of memory from the text segment.  This allows for execute in place in
6081 an environment without virtual memory management.  This option implies -fPIC.
6083 @item -mno-sep-data
6084 Generate code that assumes that the data segment follows the text segment.
6085 This is the default.
6087 @item -mid-shared-library
6088 Generate code that supports shared libraries via the library ID method.
6089 This allows for execute in place and shared libraries in an environment
6090 without virtual memory management.  This option implies -fPIC.
6092 @item -mno-id-shared-library
6093 Generate code that doesn't assume ID based shared libraries are being used.
6094 This is the default.
6096 @item -mshared-library-id=n
6097 Specified the identification number of the ID based shared library being
6098 compiled.  Specifying a value of 0 will generate more compact code, specifying
6099 other values will force the allocation of that number to the current
6100 library but is no more space or time efficient than omitting this option.
6102 @end table
6104 @node M68hc1x Options
6105 @subsection M68hc1x Options
6106 @cindex M68hc1x options
6108 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6109 microcontrollers.  The default values for these options depends on
6110 which style of microcontroller was selected when the compiler was configured;
6111 the defaults for the most common choices are given below.
6113 @table @gcctabopt
6114 @item -m6811
6115 @itemx -m68hc11
6116 @opindex m6811
6117 @opindex m68hc11
6118 Generate output for a 68HC11.  This is the default
6119 when the compiler is configured for 68HC11-based systems.
6121 @item -m6812
6122 @itemx -m68hc12
6123 @opindex m6812
6124 @opindex m68hc12
6125 Generate output for a 68HC12.  This is the default
6126 when the compiler is configured for 68HC12-based systems.
6128 @item -m68S12
6129 @itemx -m68hcs12
6130 @opindex m68S12
6131 @opindex m68hcs12
6132 Generate output for a 68HCS12.  
6134 @item -mauto-incdec
6135 @opindex mauto-incdec
6136 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6137 addressing modes.
6139 @item -minmax
6140 @itemx -nominmax
6141 @opindex minmax
6142 @opindex mnominmax
6143 Enable the use of 68HC12 min and max instructions.
6145 @item -mlong-calls
6146 @itemx -mno-long-calls
6147 @opindex mlong-calls
6148 @opindex mno-long-calls
6149 Treat all calls as being far away (near).  If calls are assumed to be
6150 far away, the compiler will use the @code{call} instruction to
6151 call a function and the @code{rtc} instruction for returning.
6153 @item -mshort
6154 @opindex mshort
6155 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6157 @item -msoft-reg-count=@var{count}
6158 @opindex msoft-reg-count
6159 Specify the number of pseudo-soft registers which are used for the
6160 code generation.  The maximum number is 32.  Using more pseudo-soft
6161 register may or may not result in better code depending on the program.
6162 The default is 4 for 68HC11 and 2 for 68HC12.
6164 @end table
6166 @node VAX Options
6167 @subsection VAX Options
6168 @cindex VAX options
6170 These @samp{-m} options are defined for the VAX:
6172 @table @gcctabopt
6173 @item -munix
6174 @opindex munix
6175 Do not output certain jump instructions (@code{aobleq} and so on)
6176 that the Unix assembler for the VAX cannot handle across long
6177 ranges.
6179 @item -mgnu
6180 @opindex mgnu
6181 Do output those jump instructions, on the assumption that you
6182 will assemble with the GNU assembler.
6184 @item -mg
6185 @opindex mg
6186 Output code for g-format floating point numbers instead of d-format.
6187 @end table
6189 @node SPARC Options
6190 @subsection SPARC Options
6191 @cindex SPARC options
6193 These @samp{-m} switches are supported on the SPARC:
6195 @table @gcctabopt
6196 @item -mno-app-regs
6197 @itemx -mapp-regs
6198 @opindex mno-app-regs
6199 @opindex mapp-regs
6200 Specify @option{-mapp-regs} to generate output using the global registers
6201 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6202 is the default.
6204 To be fully SVR4 ABI compliant at the cost of some performance loss,
6205 specify @option{-mno-app-regs}.  You should compile libraries and system
6206 software with this option.
6208 @item -mfpu
6209 @itemx -mhard-float
6210 @opindex mfpu
6211 @opindex mhard-float
6212 Generate output containing floating point instructions.  This is the
6213 default.
6215 @item -mno-fpu
6216 @itemx -msoft-float
6217 @opindex mno-fpu
6218 @opindex msoft-float
6219 Generate output containing library calls for floating point.
6220 @strong{Warning:} the requisite libraries are not available for all SPARC
6221 targets.  Normally the facilities of the machine's usual C compiler are
6222 used, but this cannot be done directly in cross-compilation.  You must make
6223 your own arrangements to provide suitable library functions for
6224 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6225 @samp{sparclite-*-*} do provide software floating point support.
6227 @option{-msoft-float} changes the calling convention in the output file;
6228 therefore, it is only useful if you compile @emph{all} of a program with
6229 this option.  In particular, you need to compile @file{libgcc.a}, the
6230 library that comes with GCC, with @option{-msoft-float} in order for
6231 this to work.
6233 @item -mhard-quad-float
6234 @opindex mhard-quad-float
6235 Generate output containing quad-word (long double) floating point
6236 instructions.
6238 @item -msoft-quad-float
6239 @opindex msoft-quad-float
6240 Generate output containing library calls for quad-word (long double)
6241 floating point instructions.  The functions called are those specified
6242 in the SPARC ABI@.  This is the default.
6244 As of this writing, there are no sparc implementations that have hardware
6245 support for the quad-word floating point instructions.  They all invoke
6246 a trap handler for one of these instructions, and then the trap handler
6247 emulates the effect of the instruction.  Because of the trap handler overhead,
6248 this is much slower than calling the ABI library routines.  Thus the
6249 @option{-msoft-quad-float} option is the default.
6251 @item -mno-flat
6252 @itemx -mflat
6253 @opindex mno-flat
6254 @opindex mflat
6255 With @option{-mflat}, the compiler does not generate save/restore instructions
6256 and will use a ``flat'' or single register window calling convention.
6257 This model uses %i7 as the frame pointer and is compatible with the normal
6258 register window model.  Code from either may be intermixed.
6259 The local registers and the input registers (0--5) are still treated as
6260 ``call saved'' registers and will be saved on the stack as necessary.
6262 With @option{-mno-flat} (the default), the compiler emits save/restore
6263 instructions (except for leaf functions) and is the normal mode of operation.
6265 @item -mno-unaligned-doubles
6266 @itemx -munaligned-doubles
6267 @opindex mno-unaligned-doubles
6268 @opindex munaligned-doubles
6269 Assume that doubles have 8 byte alignment.  This is the default.
6271 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6272 alignment only if they are contained in another type, or if they have an
6273 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6274 Specifying this option avoids some rare compatibility problems with code
6275 generated by other compilers.  It is not the default because it results
6276 in a performance loss, especially for floating point code.
6278 @item -mno-faster-structs
6279 @itemx -mfaster-structs
6280 @opindex mno-faster-structs
6281 @opindex mfaster-structs
6282 With @option{-mfaster-structs}, the compiler assumes that structures
6283 should have 8 byte alignment.  This enables the use of pairs of
6284 @code{ldd} and @code{std} instructions for copies in structure
6285 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6286 However, the use of this changed alignment directly violates the SPARC
6287 ABI@.  Thus, it's intended only for use on targets where the developer
6288 acknowledges that their resulting code will not be directly in line with
6289 the rules of the ABI@.
6291 @item -mimpure-text
6292 @opindex mimpure-text
6293 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6294 the compiler to not pass @option{-z text} to the linker when linking a
6295 shared object.  Using this option, you can link position-dependent
6296 code into a shared object.  
6298 @option{-mimpure-text} suppresses the ``relocations remain against
6299 allocatable but non-writable sections'' linker error message.
6300 However, the necessary relocations will trigger copy-on-write, and the
6301 shared object is not actually shared across processes.  Instead of
6302 using @option{-mimpure-text}, you should compile all source code with
6303 @option{-fpic} or @option{-fPIC}.
6305 This option is only available on SunOS and Solaris.
6307 @item -mv8
6308 @itemx -msparclite
6309 @opindex mv8
6310 @opindex msparclite
6311 These two options select variations on the SPARC architecture.
6313 By default (unless specifically configured for the Fujitsu SPARClite),
6314 GCC generates code for the v7 variant of the SPARC architecture.
6316 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6317 code is that the compiler emits the integer multiply and integer
6318 divide instructions which exist in SPARC v8 but not in SPARC v7.
6320 @option{-msparclite} will give you SPARClite code.  This adds the integer
6321 multiply, integer divide step and scan (@code{ffs}) instructions which
6322 exist in SPARClite but not in SPARC v7.
6324 These options are deprecated and will be deleted in a future GCC release.
6325 They have been replaced with @option{-mcpu=xxx}.
6327 @item -mcypress
6328 @itemx -msupersparc
6329 @opindex mcypress
6330 @opindex msupersparc
6331 These two options select the processor for which the code is optimized.
6333 With @option{-mcypress} (the default), the compiler optimizes code for the
6334 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6335 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6337 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6338 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6339 of the full SPARC v8 instruction set.
6341 These options are deprecated and will be deleted in a future GCC release.
6342 They have been replaced with @option{-mcpu=xxx}.
6344 @item -mcpu=@var{cpu_type}
6345 @opindex mcpu
6346 Set the instruction set, register set, and instruction scheduling parameters
6347 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6348 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6349 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6350 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6351 @samp{ultrasparc3}.
6353 Default instruction scheduling parameters are used for values that select
6354 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6355 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6357 Here is a list of each supported architecture and their supported
6358 implementations.
6360 @smallexample
6361     v7:             cypress
6362     v8:             supersparc, hypersparc
6363     sparclite:      f930, f934, sparclite86x
6364     sparclet:       tsc701
6365     v9:             ultrasparc, ultrasparc3
6366 @end smallexample
6368 @item -mtune=@var{cpu_type}
6369 @opindex mtune
6370 Set the instruction scheduling parameters for machine type
6371 @var{cpu_type}, but do not set the instruction set or register set that the
6372 option @option{-mcpu=@var{cpu_type}} would.
6374 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6375 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6376 that select a particular cpu implementation.  Those are @samp{cypress},
6377 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6378 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6379 @samp{ultrasparc3}.
6381 @end table
6383 These @samp{-m} switches are supported in addition to the above
6384 on the SPARCLET processor.
6386 @table @gcctabopt
6387 @item -mlittle-endian
6388 @opindex mlittle-endian
6389 Generate code for a processor running in little-endian mode.
6391 @item -mlive-g0
6392 @opindex mlive-g0
6393 Treat register @code{%g0} as a normal register.
6394 GCC will continue to clobber it as necessary but will not assume
6395 it always reads as 0.
6397 @item -mbroken-saverestore
6398 @opindex mbroken-saverestore
6399 Generate code that does not use non-trivial forms of the @code{save} and
6400 @code{restore} instructions.  Early versions of the SPARCLET processor do
6401 not correctly handle @code{save} and @code{restore} instructions used with
6402 arguments.  They correctly handle them used without arguments.  A @code{save}
6403 instruction used without arguments increments the current window pointer
6404 but does not allocate a new stack frame.  It is assumed that the window
6405 overflow trap handler will properly handle this case as will interrupt
6406 handlers.
6407 @end table
6409 These @samp{-m} switches are supported in addition to the above
6410 on SPARC V9 processors in 64-bit environments.
6412 @table @gcctabopt
6413 @item -mlittle-endian
6414 @opindex mlittle-endian
6415 Generate code for a processor running in little-endian mode. It is only
6416 available for a few configurations and most notably not on Solaris.
6418 @item -m32
6419 @itemx -m64
6420 @opindex m32
6421 @opindex m64
6422 Generate code for a 32-bit or 64-bit environment.
6423 The 32-bit environment sets int, long and pointer to 32 bits.
6424 The 64-bit environment sets int to 32 bits and long and pointer
6425 to 64 bits.
6427 @item -mcmodel=medlow
6428 @opindex mcmodel=medlow
6429 Generate code for the Medium/Low code model: the program must be linked
6430 in the low 32 bits of the address space.  Pointers are 64 bits.
6431 Programs can be statically or dynamically linked.
6433 @item -mcmodel=medmid
6434 @opindex mcmodel=medmid
6435 Generate code for the Medium/Middle code model: the program must be linked
6436 in the low 44 bits of the address space, the text segment must be less than
6437 2G bytes, and data segment must be within 2G of the text segment.
6438 Pointers are 64 bits.
6440 @item -mcmodel=medany
6441 @opindex mcmodel=medany
6442 Generate code for the Medium/Anywhere code model: the program may be linked
6443 anywhere in the address space, the text segment must be less than
6444 2G bytes, and data segment must be within 2G of the text segment.
6445 Pointers are 64 bits.
6447 @item -mcmodel=embmedany
6448 @opindex mcmodel=embmedany
6449 Generate code for the Medium/Anywhere code model for embedded systems:
6450 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6451 (determined at link time).  Register %g4 points to the base of the
6452 data segment.  Pointers are still 64 bits.
6453 Programs are statically linked, PIC is not supported.
6455 @item -mstack-bias
6456 @itemx -mno-stack-bias
6457 @opindex mstack-bias
6458 @opindex mno-stack-bias
6459 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6460 frame pointer if present, are offset by @minus{}2047 which must be added back
6461 when making stack frame references.
6462 Otherwise, assume no such offset is present.
6463 @end table
6465 @node ARM Options
6466 @subsection ARM Options
6467 @cindex ARM options
6469 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6470 architectures:
6472 @table @gcctabopt
6473 @item -mapcs-frame
6474 @opindex mapcs-frame
6475 Generate a stack frame that is compliant with the ARM Procedure Call
6476 Standard for all functions, even if this is not strictly necessary for
6477 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6478 with this option will cause the stack frames not to be generated for
6479 leaf functions.  The default is @option{-mno-apcs-frame}.
6481 @item -mapcs
6482 @opindex mapcs
6483 This is a synonym for @option{-mapcs-frame}.
6485 @item -mapcs-26
6486 @opindex mapcs-26
6487 Generate code for a processor running with a 26-bit program counter,
6488 and conforming to the function calling standards for the APCS 26-bit
6489 option.  This option replaces the @option{-m2} and @option{-m3} options
6490 of previous releases of the compiler.
6492 @item -mapcs-32
6493 @opindex mapcs-32
6494 Generate code for a processor running with a 32-bit program counter,
6495 and conforming to the function calling standards for the APCS 32-bit
6496 option.  This option replaces the @option{-m6} option of previous releases
6497 of the compiler.
6499 @ignore
6500 @c not currently implemented
6501 @item -mapcs-stack-check
6502 @opindex mapcs-stack-check
6503 Generate code to check the amount of stack space available upon entry to
6504 every function (that actually uses some stack space).  If there is
6505 insufficient space available then either the function
6506 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6507 called, depending upon the amount of stack space required.  The run time
6508 system is required to provide these functions.  The default is
6509 @option{-mno-apcs-stack-check}, since this produces smaller code.
6511 @c not currently implemented
6512 @item -mapcs-float
6513 @opindex mapcs-float
6514 Pass floating point arguments using the float point registers.  This is
6515 one of the variants of the APCS@.  This option is recommended if the
6516 target hardware has a floating point unit or if a lot of floating point
6517 arithmetic is going to be performed by the code.  The default is
6518 @option{-mno-apcs-float}, since integer only code is slightly increased in
6519 size if @option{-mapcs-float} is used.
6521 @c not currently implemented
6522 @item -mapcs-reentrant
6523 @opindex mapcs-reentrant
6524 Generate reentrant, position independent code.  The default is
6525 @option{-mno-apcs-reentrant}.
6526 @end ignore
6528 @item -mthumb-interwork
6529 @opindex mthumb-interwork
6530 Generate code which supports calling between the ARM and Thumb
6531 instruction sets.  Without this option the two instruction sets cannot
6532 be reliably used inside one program.  The default is
6533 @option{-mno-thumb-interwork}, since slightly larger code is generated
6534 when @option{-mthumb-interwork} is specified.
6536 @item -mno-sched-prolog
6537 @opindex mno-sched-prolog
6538 Prevent the reordering of instructions in the function prolog, or the
6539 merging of those instruction with the instructions in the function's
6540 body.  This means that all functions will start with a recognizable set
6541 of instructions (or in fact one of a choice from a small set of
6542 different function prologues), and this information can be used to
6543 locate the start if functions inside an executable piece of code.  The
6544 default is @option{-msched-prolog}.
6546 @item -mhard-float
6547 @opindex mhard-float
6548 Generate output containing floating point instructions.  This is the
6549 default.
6551 @item -msoft-float
6552 @opindex msoft-float
6553 Generate output containing library calls for floating point.
6554 @strong{Warning:} the requisite libraries are not available for all ARM
6555 targets.  Normally the facilities of the machine's usual C compiler are
6556 used, but this cannot be done directly in cross-compilation.  You must make
6557 your own arrangements to provide suitable library functions for
6558 cross-compilation.
6560 @option{-msoft-float} changes the calling convention in the output file;
6561 therefore, it is only useful if you compile @emph{all} of a program with
6562 this option.  In particular, you need to compile @file{libgcc.a}, the
6563 library that comes with GCC, with @option{-msoft-float} in order for
6564 this to work.
6566 @item -mlittle-endian
6567 @opindex mlittle-endian
6568 Generate code for a processor running in little-endian mode.  This is
6569 the default for all standard configurations.
6571 @item -mbig-endian
6572 @opindex mbig-endian
6573 Generate code for a processor running in big-endian mode; the default is
6574 to compile code for a little-endian processor.
6576 @item -mwords-little-endian
6577 @opindex mwords-little-endian
6578 This option only applies when generating code for big-endian processors.
6579 Generate code for a little-endian word order but a big-endian byte
6580 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6581 option should only be used if you require compatibility with code for
6582 big-endian ARM processors generated by versions of the compiler prior to
6583 2.8.
6585 @item -malignment-traps
6586 @opindex malignment-traps
6587 Generate code that will not trap if the MMU has alignment traps enabled.
6588 On ARM architectures prior to ARMv4, there were no instructions to
6589 access half-word objects stored in memory.  However, when reading from
6590 memory a feature of the ARM architecture allows a word load to be used,
6591 even if the address is unaligned, and the processor core will rotate the
6592 data as it is being loaded.  This option tells the compiler that such
6593 misaligned accesses will cause a MMU trap and that it should instead
6594 synthesize the access as a series of byte accesses.  The compiler can
6595 still use word accesses to load half-word data if it knows that the
6596 address is aligned to a word boundary.
6598 This option is ignored when compiling for ARM architecture 4 or later,
6599 since these processors have instructions to directly access half-word
6600 objects in memory.
6602 @item -mno-alignment-traps
6603 @opindex mno-alignment-traps
6604 Generate code that assumes that the MMU will not trap unaligned
6605 accesses.  This produces better code when the target instruction set
6606 does not have half-word memory operations (i.e.@: implementations prior to
6607 ARMv4).
6609 Note that you cannot use this option to access unaligned word objects,
6610 since the processor will only fetch one 32-bit aligned object from
6611 memory.
6613 The default setting for most targets is @option{-mno-alignment-traps}, since
6614 this produces better code when there are no half-word memory
6615 instructions available.
6617 @item -mshort-load-bytes
6618 @itemx -mno-short-load-words
6619 @opindex mshort-load-bytes
6620 @opindex mno-short-load-words
6621 These are deprecated aliases for @option{-malignment-traps}.
6623 @item -mno-short-load-bytes
6624 @itemx -mshort-load-words
6625 @opindex mno-short-load-bytes
6626 @opindex mshort-load-words
6627 This are deprecated aliases for @option{-mno-alignment-traps}.
6629 @item -mcpu=@var{name}
6630 @opindex mcpu
6631 This specifies the name of the target ARM processor.  GCC uses this name
6632 to determine what kind of instructions it can emit when generating
6633 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6634 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6635 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6636 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6637 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6638 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6639 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6640 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6641 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6642 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6643 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6644 @samp{ep9312}.
6646 @itemx -mtune=@var{name}
6647 @opindex mtune
6648 This option is very similar to the @option{-mcpu=} option, except that
6649 instead of specifying the actual target processor type, and hence
6650 restricting which instructions can be used, it specifies that GCC should
6651 tune the performance of the code as if the target were of the type
6652 specified in this option, but still choosing the instructions that it
6653 will generate based on the cpu specified by a @option{-mcpu=} option.
6654 For some ARM implementations better performance can be obtained by using
6655 this option.
6657 @item -march=@var{name}
6658 @opindex march
6659 This specifies the name of the target ARM architecture.  GCC uses this
6660 name to determine what kind of instructions it can emit when generating
6661 assembly code.  This option can be used in conjunction with or instead
6662 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6663 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6664 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6665 @samp{iwmmxt}, @samp{ep9312}.
6667 @item -mfpe=@var{number}
6668 @itemx -mfp=@var{number}
6669 @opindex mfpe
6670 @opindex mfp
6671 This specifies the version of the floating point emulation available on
6672 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6673 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6675 @item -mstructure-size-boundary=@var{n}
6676 @opindex mstructure-size-boundary
6677 The size of all structures and unions will be rounded up to a multiple
6678 of the number of bits set by this option.  Permissible values are 8 and
6679 32.  The default value varies for different toolchains.  For the COFF
6680 targeted toolchain the default value is 8.  Specifying the larger number
6681 can produce faster, more efficient code, but can also increase the size
6682 of the program.  The two values are potentially incompatible.  Code
6683 compiled with one value cannot necessarily expect to work with code or
6684 libraries compiled with the other value, if they exchange information
6685 using structures or unions.
6687 @item -mabort-on-noreturn
6688 @opindex mabort-on-noreturn
6689 Generate a call to the function @code{abort} at the end of a
6690 @code{noreturn} function.  It will be executed if the function tries to
6691 return.
6693 @item -mlong-calls
6694 @itemx -mno-long-calls
6695 @opindex mlong-calls
6696 @opindex mno-long-calls
6697 Tells the compiler to perform function calls by first loading the
6698 address of the function into a register and then performing a subroutine
6699 call on this register.  This switch is needed if the target function
6700 will lie outside of the 64 megabyte addressing range of the offset based
6701 version of subroutine call instruction.
6703 Even if this switch is enabled, not all function calls will be turned
6704 into long calls.  The heuristic is that static functions, functions
6705 which have the @samp{short-call} attribute, functions that are inside
6706 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6707 definitions have already been compiled within the current compilation
6708 unit, will not be turned into long calls.  The exception to this rule is
6709 that weak function definitions, functions with the @samp{long-call}
6710 attribute or the @samp{section} attribute, and functions that are within
6711 the scope of a @samp{#pragma long_calls} directive, will always be
6712 turned into long calls.
6714 This feature is not enabled by default.  Specifying
6715 @option{-mno-long-calls} will restore the default behavior, as will
6716 placing the function calls within the scope of a @samp{#pragma
6717 long_calls_off} directive.  Note these switches have no effect on how
6718 the compiler generates code to handle function calls via function
6719 pointers.
6721 @item -mnop-fun-dllimport
6722 @opindex mnop-fun-dllimport
6723 Disable support for the @code{dllimport} attribute.
6725 @item -msingle-pic-base
6726 @opindex msingle-pic-base
6727 Treat the register used for PIC addressing as read-only, rather than
6728 loading it in the prologue for each function.  The run-time system is
6729 responsible for initializing this register with an appropriate value
6730 before execution begins.
6732 @item -mpic-register=@var{reg}
6733 @opindex mpic-register
6734 Specify the register to be used for PIC addressing.  The default is R10
6735 unless stack-checking is enabled, when R9 is used.
6737 @item -mcirrus-fix-invalid-insns
6738 @opindex mcirrus-fix-invalid-insns
6739 @opindex mno-cirrus-fix-invalid-insns
6740 Insert NOPs into the instruction stream to in order to work around
6741 problems with invalid Maverick instruction combinations.  This option
6742 is only valid if the @option{-mcpu=ep9312} option has been used to
6743 enable generation of instructions for the Cirrus Maverick floating
6744 point co-processor.  This option is not enabled by default, since the
6745 problem is only present in older Maverick implementations.  The default
6746 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6747 switch.
6749 @item -mpoke-function-name
6750 @opindex mpoke-function-name
6751 Write the name of each function into the text section, directly
6752 preceding the function prologue.  The generated code is similar to this:
6754 @smallexample
6755      t0
6756          .ascii "arm_poke_function_name", 0
6757          .align
6758      t1
6759          .word 0xff000000 + (t1 - t0)
6760      arm_poke_function_name
6761          mov     ip, sp
6762          stmfd   sp!, @{fp, ip, lr, pc@}
6763          sub     fp, ip, #4
6764 @end smallexample
6766 When performing a stack backtrace, code can inspect the value of
6767 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6768 location @code{pc - 12} and the top 8 bits are set, then we know that
6769 there is a function name embedded immediately preceding this location
6770 and has length @code{((pc[-3]) & 0xff000000)}.
6772 @item -mthumb
6773 @opindex mthumb
6774 Generate code for the 16-bit Thumb instruction set.  The default is to
6775 use the 32-bit ARM instruction set.
6777 @item -mtpcs-frame
6778 @opindex mtpcs-frame
6779 Generate a stack frame that is compliant with the Thumb Procedure Call
6780 Standard for all non-leaf functions.  (A leaf function is one that does
6781 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6783 @item -mtpcs-leaf-frame
6784 @opindex mtpcs-leaf-frame
6785 Generate a stack frame that is compliant with the Thumb Procedure Call
6786 Standard for all leaf functions.  (A leaf function is one that does
6787 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6789 @item -mcallee-super-interworking
6790 @opindex mcallee-super-interworking
6791 Gives all externally visible functions in the file being compiled an ARM
6792 instruction set header which switches to Thumb mode before executing the
6793 rest of the function.  This allows these functions to be called from
6794 non-interworking code.
6796 @item -mcaller-super-interworking
6797 @opindex mcaller-super-interworking
6798 Allows calls via function pointers (including virtual functions) to
6799 execute correctly regardless of whether the target code has been
6800 compiled for interworking or not.  There is a small overhead in the cost
6801 of executing a function pointer if this option is enabled.
6803 @end table
6805 @node MN10200 Options
6806 @subsection MN10200 Options
6807 @cindex MN10200 options
6809 These @option{-m} options are defined for Matsushita MN10200 architectures:
6810 @table @gcctabopt
6812 @item -mrelax
6813 @opindex mrelax
6814 Indicate to the linker that it should perform a relaxation optimization pass
6815 to shorten branches, calls and absolute memory addresses.  This option only
6816 has an effect when used on the command line for the final link step.
6818 This option makes symbolic debugging impossible.
6819 @end table
6821 @node MN10300 Options
6822 @subsection MN10300 Options
6823 @cindex MN10300 options
6825 These @option{-m} options are defined for Matsushita MN10300 architectures:
6827 @table @gcctabopt
6828 @item -mmult-bug
6829 @opindex mmult-bug
6830 Generate code to avoid bugs in the multiply instructions for the MN10300
6831 processors.  This is the default.
6833 @item -mno-mult-bug
6834 @opindex mno-mult-bug
6835 Do not generate code to avoid bugs in the multiply instructions for the
6836 MN10300 processors.
6838 @item -mam33
6839 @opindex mam33
6840 Generate code which uses features specific to the AM33 processor.
6842 @item -mno-am33
6843 @opindex mno-am33
6844 Do not generate code which uses features specific to the AM33 processor.  This
6845 is the default.
6847 @item -mno-crt0
6848 @opindex mno-crt0
6849 Do not link in the C run-time initialization object file.
6851 @item -mrelax
6852 @opindex mrelax
6853 Indicate to the linker that it should perform a relaxation optimization pass
6854 to shorten branches, calls and absolute memory addresses.  This option only
6855 has an effect when used on the command line for the final link step.
6857 This option makes symbolic debugging impossible.
6858 @end table
6861 @node M32R/D Options
6862 @subsection M32R/D Options
6863 @cindex M32R/D options
6865 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6867 @table @gcctabopt
6868 @item -m32rx
6869 @opindex m32rx
6870 Generate code for the M32R/X@.
6872 @item -m32r
6873 @opindex m32r
6874 Generate code for the M32R@.  This is the default.
6876 @item -mcode-model=small
6877 @opindex mcode-model=small
6878 Assume all objects live in the lower 16MB of memory (so that their addresses
6879 can be loaded with the @code{ld24} instruction), and assume all subroutines
6880 are reachable with the @code{bl} instruction.
6881 This is the default.
6883 The addressability of a particular object can be set with the
6884 @code{model} attribute.
6886 @item -mcode-model=medium
6887 @opindex mcode-model=medium
6888 Assume objects may be anywhere in the 32-bit address space (the compiler
6889 will generate @code{seth/add3} instructions to load their addresses), and
6890 assume all subroutines are reachable with the @code{bl} instruction.
6892 @item -mcode-model=large
6893 @opindex mcode-model=large
6894 Assume objects may be anywhere in the 32-bit address space (the compiler
6895 will generate @code{seth/add3} instructions to load their addresses), and
6896 assume subroutines may not be reachable with the @code{bl} instruction
6897 (the compiler will generate the much slower @code{seth/add3/jl}
6898 instruction sequence).
6900 @item -msdata=none
6901 @opindex msdata=none
6902 Disable use of the small data area.  Variables will be put into
6903 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6904 @code{section} attribute has been specified).
6905 This is the default.
6907 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6908 Objects may be explicitly put in the small data area with the
6909 @code{section} attribute using one of these sections.
6911 @item -msdata=sdata
6912 @opindex msdata=sdata
6913 Put small global and static data in the small data area, but do not
6914 generate special code to reference them.
6916 @item -msdata=use
6917 @opindex msdata=use
6918 Put small global and static data in the small data area, and generate
6919 special instructions to reference them.
6921 @item -G @var{num}
6922 @opindex G
6923 @cindex smaller data references
6924 Put global and static objects less than or equal to @var{num} bytes
6925 into the small data or bss sections instead of the normal data or bss
6926 sections.  The default value of @var{num} is 8.
6927 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6928 for this option to have any effect.
6930 All modules should be compiled with the same @option{-G @var{num}} value.
6931 Compiling with different values of @var{num} may or may not work; if it
6932 doesn't the linker will give an error message---incorrect code will not be
6933 generated.
6935 @end table
6937 @node M88K Options
6938 @subsection M88K Options
6939 @cindex M88k options
6941 These @samp{-m} options are defined for Motorola 88k architectures:
6943 @table @gcctabopt
6944 @item -m88000
6945 @opindex m88000
6946 Generate code that works well on both the m88100 and the
6947 m88110.
6949 @item -m88100
6950 @opindex m88100
6951 Generate code that works best for the m88100, but that also
6952 runs on the m88110.
6954 @item -m88110
6955 @opindex m88110
6956 Generate code that works best for the m88110, and may not run
6957 on the m88100.
6959 @item -mbig-pic
6960 @opindex mbig-pic
6961 Obsolete option to be removed from the next revision.
6962 Use @option{-fPIC}.
6964 @item -midentify-revision
6965 @opindex midentify-revision
6966 @cindex identifying source, compiler (88k)
6967 Include an @code{ident} directive in the assembler output recording the
6968 source file name, compiler name and version, timestamp, and compilation
6969 flags used.
6971 @item -mno-underscores
6972 @opindex mno-underscores
6973 @cindex underscores, avoiding (88k)
6974 In assembler output, emit symbol names without adding an underscore
6975 character at the beginning of each name.  The default is to use an
6976 underscore as prefix on each name.
6978 @item -mocs-debug-info
6979 @itemx -mno-ocs-debug-info
6980 @opindex mocs-debug-info
6981 @opindex mno-ocs-debug-info
6982 @cindex OCS (88k)
6983 @cindex debugging, 88k OCS
6984 Include (or omit) additional debugging information (about registers used
6985 in each stack frame) as specified in the 88open Object Compatibility
6986 Standard, ``OCS''@.  This extra information allows debugging of code that
6987 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6988 SVr3.2 is to include this information; other 88k configurations omit this
6989 information by default.
6991 @item -mocs-frame-position
6992 @opindex mocs-frame-position
6993 @cindex register positions in frame (88k)
6994 When emitting COFF debugging information for automatic variables and
6995 parameters stored on the stack, use the offset from the canonical frame
6996 address, which is the stack pointer (register 31) on entry to the
6997 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6998 @option{-mocs-frame-position}; other 88k configurations have the default
6999 @option{-mno-ocs-frame-position}.
7001 @item -mno-ocs-frame-position
7002 @opindex mno-ocs-frame-position
7003 @cindex register positions in frame (88k)
7004 When emitting COFF debugging information for automatic variables and
7005 parameters stored on the stack, use the offset from the frame pointer
7006 register (register 30).  When this option is in effect, the frame
7007 pointer is not eliminated when debugging information is selected by the
7008 -g switch.
7010 @item -moptimize-arg-area
7011 @opindex moptimize-arg-area
7012 @cindex arguments in frame (88k)
7013 Save space by reorganizing the stack frame.  This option generates code
7014 that does not agree with the 88open specifications, but uses less
7015 memory.
7017 @itemx -mno-optimize-arg-area
7018 @opindex mno-optimize-arg-area
7019 Do not reorganize the stack frame to save space.  This is the default.
7020 The generated conforms to the specification, but uses more memory.
7022 @item -mshort-data-@var{num}
7023 @opindex mshort-data
7024 @cindex smaller data references (88k)
7025 @cindex r0-relative references (88k)
7026 Generate smaller data references by making them relative to @code{r0},
7027 which allows loading a value using a single instruction (rather than the
7028 usual two).  You control which data references are affected by
7029 specifying @var{num} with this option.  For example, if you specify
7030 @option{-mshort-data-512}, then the data references affected are those
7031 involving displacements of less than 512 bytes.
7032 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
7033 than 64k.
7035 @item -mserialize-volatile
7036 @opindex mserialize-volatile
7037 @itemx -mno-serialize-volatile
7038 @opindex mno-serialize-volatile
7039 @cindex sequential consistency on 88k
7040 Do, or don't, generate code to guarantee sequential consistency
7041 of volatile memory references.  By default, consistency is
7042 guaranteed.
7044 The order of memory references made by the MC88110 processor does
7045 not always match the order of the instructions requesting those
7046 references.  In particular, a load instruction may execute before
7047 a preceding store instruction.  Such reordering violates
7048 sequential consistency of volatile memory references, when there
7049 are multiple processors.   When consistency must be guaranteed,
7050 GCC generates special instructions, as needed, to force
7051 execution in the proper order.
7053 The MC88100 processor does not reorder memory references and so
7054 always provides sequential consistency.  However, by default, GCC
7055 generates the special instructions to guarantee consistency
7056 even when you use @option{-m88100}, so that the code may be run on an
7057 MC88110 processor.  If you intend to run your code only on the
7058 MC88100 processor, you may use @option{-mno-serialize-volatile}.
7060 The extra code generated to guarantee consistency may affect the
7061 performance of your application.  If you know that you can safely
7062 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
7064 @item -msvr4
7065 @itemx -msvr3
7066 @opindex msvr4
7067 @opindex msvr3
7068 @cindex assembler syntax, 88k
7069 @cindex SVr4
7070 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
7071 related to System V release 4 (SVr4).  This controls the following:
7073 @enumerate
7074 @item
7075 Which variant of the assembler syntax to emit.
7076 @item
7077 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
7078 that is used on System V release 4.
7079 @item
7080 @option{-msvr4} makes GCC issue additional declaration directives used in
7081 SVr4.
7082 @end enumerate
7084 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
7085 @option{-msvr3} is the default for all other m88k configurations.
7087 @item -mversion-03.00
7088 @opindex mversion-03.00
7089 This option is obsolete, and is ignored.
7090 @c ??? which asm syntax better for GAS?  option there too?
7092 @item -mno-check-zero-division
7093 @itemx -mcheck-zero-division
7094 @opindex mno-check-zero-division
7095 @opindex mcheck-zero-division
7096 @cindex zero division on 88k
7097 Do, or don't, generate code to guarantee that integer division by
7098 zero will be detected.  By default, detection is guaranteed.
7100 Some models of the MC88100 processor fail to trap upon integer
7101 division by zero under certain conditions.  By default, when
7102 compiling code that might be run on such a processor, GCC
7103 generates code that explicitly checks for zero-valued divisors
7104 and traps with exception number 503 when one is detected.  Use of
7105 @option{-mno-check-zero-division} suppresses such checking for code
7106 generated to run on an MC88100 processor.
7108 GCC assumes that the MC88110 processor correctly detects all instances
7109 of integer division by zero.  When @option{-m88110} is specified, no
7110 explicit checks for zero-valued divisors are generated, and both
7111 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
7112 ignored.
7114 @item -muse-div-instruction
7115 @opindex muse-div-instruction
7116 @cindex divide instruction, 88k
7117 Use the div instruction for signed integer division on the
7118 MC88100 processor.  By default, the div instruction is not used.
7120 On the MC88100 processor the signed integer division instruction
7121 div) traps to the operating system on a negative operand.  The
7122 operating system transparently completes the operation, but at a
7123 large cost in execution time.  By default, when compiling code
7124 that might be run on an MC88100 processor, GCC emulates signed
7125 integer division using the unsigned integer division instruction
7126 divu), thereby avoiding the large penalty of a trap to the
7127 operating system.  Such emulation has its own, smaller, execution
7128 cost in both time and space.  To the extent that your code's
7129 important signed integer division operations are performed on two
7130 nonnegative operands, it may be desirable to use the div
7131 instruction directly.
7133 On the MC88110 processor the div instruction (also known as the
7134 divs instruction) processes negative operands without trapping to
7135 the operating system.  When @option{-m88110} is specified,
7136 @option{-muse-div-instruction} is ignored, and the div instruction is used
7137 for signed integer division.
7139 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
7140 particular, the behavior of such a division with and without
7141 @option{-muse-div-instruction} may differ.
7143 @item -mtrap-large-shift
7144 @itemx -mhandle-large-shift
7145 @opindex mtrap-large-shift
7146 @opindex mhandle-large-shift
7147 @cindex bit shift overflow (88k)
7148 @cindex large bit shifts (88k)
7149 Include code to detect bit-shifts of more than 31 bits; respectively,
7150 trap such shifts or emit code to handle them properly.  By default GCC
7151 makes no special provision for large bit shifts.
7153 @item -mwarn-passed-structs
7154 @opindex mwarn-passed-structs
7155 @cindex structure passing (88k)
7156 Warn when a function passes a struct as an argument or result.
7157 Structure-passing conventions have changed during the evolution of the C
7158 language, and are often the source of portability problems.  By default,
7159 GCC issues no such warning.
7160 @end table
7162 @c break page here to avoid unsightly interparagraph stretch.
7163 @c -zw, 2001-8-17
7164 @page
7166 @node RS/6000 and PowerPC Options
7167 @subsection IBM RS/6000 and PowerPC Options
7168 @cindex RS/6000 and PowerPC Options
7169 @cindex IBM RS/6000 and PowerPC Options
7171 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
7172 @table @gcctabopt
7173 @item -mpower
7174 @itemx -mno-power
7175 @itemx -mpower2
7176 @itemx -mno-power2
7177 @itemx -mpowerpc
7178 @itemx -mno-powerpc
7179 @itemx -mpowerpc-gpopt
7180 @itemx -mno-powerpc-gpopt
7181 @itemx -mpowerpc-gfxopt
7182 @itemx -mno-powerpc-gfxopt
7183 @itemx -mpowerpc64
7184 @itemx -mno-powerpc64
7185 @opindex mpower
7186 @opindex mno-power
7187 @opindex mpower2
7188 @opindex mno-power2
7189 @opindex mpowerpc
7190 @opindex mno-powerpc
7191 @opindex mpowerpc-gpopt
7192 @opindex mno-powerpc-gpopt
7193 @opindex mpowerpc-gfxopt
7194 @opindex mno-powerpc-gfxopt
7195 @opindex mpowerpc64
7196 @opindex mno-powerpc64
7197 GCC supports two related instruction set architectures for the
7198 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
7199 instructions supported by the @samp{rios} chip set used in the original
7200 RS/6000 systems and the @dfn{PowerPC} instruction set is the
7201 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
7202 the IBM 4xx microprocessors.
7204 Neither architecture is a subset of the other.  However there is a
7205 large common subset of instructions supported by both.  An MQ
7206 register is included in processors supporting the POWER architecture.
7208 You use these options to specify which instructions are available on the
7209 processor you are using.  The default value of these options is
7210 determined when configuring GCC@.  Specifying the
7211 @option{-mcpu=@var{cpu_type}} overrides the specification of these
7212 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
7213 rather than the options listed above.
7215 The @option{-mpower} option allows GCC to generate instructions that
7216 are found only in the POWER architecture and to use the MQ register.
7217 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7218 to generate instructions that are present in the POWER2 architecture but
7219 not the original POWER architecture.
7221 The @option{-mpowerpc} option allows GCC to generate instructions that
7222 are found only in the 32-bit subset of the PowerPC architecture.
7223 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7224 GCC to use the optional PowerPC architecture instructions in the
7225 General Purpose group, including floating-point square root.  Specifying
7226 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7227 use the optional PowerPC architecture instructions in the Graphics
7228 group, including floating-point select.
7230 The @option{-mpowerpc64} option allows GCC to generate the additional
7231 64-bit instructions that are found in the full PowerPC64 architecture
7232 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7233 @option{-mno-powerpc64}.
7235 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7236 will use only the instructions in the common subset of both
7237 architectures plus some special AIX common-mode calls, and will not use
7238 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7239 permits GCC to use any instruction from either architecture and to
7240 allow use of the MQ register; specify this for the Motorola MPC601.
7242 @item -mnew-mnemonics
7243 @itemx -mold-mnemonics
7244 @opindex mnew-mnemonics
7245 @opindex mold-mnemonics
7246 Select which mnemonics to use in the generated assembler code.  With
7247 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7248 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7249 assembler mnemonics defined for the POWER architecture.  Instructions
7250 defined in only one architecture have only one mnemonic; GCC uses that
7251 mnemonic irrespective of which of these options is specified.
7253 GCC defaults to the mnemonics appropriate for the architecture in
7254 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7255 value of these option.  Unless you are building a cross-compiler, you
7256 should normally not specify either @option{-mnew-mnemonics} or
7257 @option{-mold-mnemonics}, but should instead accept the default.
7259 @item -mcpu=@var{cpu_type}
7260 @opindex mcpu
7261 Set architecture type, register usage, choice of mnemonics, and
7262 instruction scheduling parameters for machine type @var{cpu_type}.
7263 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
7264 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
7265 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
7266 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{G4}, 
7267 @samp{750}, @samp{G3},  @samp{power}, @samp{power2}, @samp{powerpc}, 
7268 @samp{403}, @samp{505}, @samp{801}, @samp{821}, @samp{823}, @samp{860},
7269 @samp{970}, @samp{G5} and @samp{common}.
7271 @option{-mcpu=common} selects a completely generic processor.  Code
7272 generated under this option will run on any POWER or PowerPC processor.
7273 GCC will use only the instructions in the common subset of both
7274 architectures, and will not use the MQ register.  GCC assumes a generic
7275 processor model for scheduling purposes.
7277 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7278 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7279 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7280 types, with an appropriate, generic processor model assumed for
7281 scheduling purposes.
7283 The other options specify a specific processor.  Code generated under
7284 those options will run best on that processor, and may not run at all on
7285 others.
7287 The @option{-mcpu} options automatically enable or disable other
7288 @option{-m} options as follows:
7290 @table @samp
7291 @item common
7292 @option{-mno-power}, @option{-mno-powerpc}
7294 @item power
7295 @itemx power2
7296 @itemx rios1
7297 @itemx rios2
7298 @itemx rsc
7299 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7301 @item powerpc
7302 @itemx rs64a
7303 @itemx 602
7304 @itemx 603
7305 @itemx 603e
7306 @itemx 604
7307 @itemx 620
7308 @itemx 630
7309 @itemx 740
7310 @itemx 7400
7311 @itemx 7450
7312 @itemx G4
7313 @itemx 750
7314 @itemx G3
7315 @itemx 505
7316 @itemx 970
7317 @itemx G5
7318 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7320 @item 601
7321 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7323 @item 403
7324 @itemx 821
7325 @itemx 860
7326 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7327 @end table
7329 @item -mtune=@var{cpu_type}
7330 @opindex mtune
7331 Set the instruction scheduling parameters for machine type
7332 @var{cpu_type}, but do not set the architecture type, register usage, or
7333 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7334 values for @var{cpu_type} are used for @option{-mtune} as for
7335 @option{-mcpu}.  If both are specified, the code generated will use the
7336 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7337 scheduling parameters set by @option{-mtune}.
7339 @item -maltivec
7340 @itemx -mno-altivec
7341 @opindex maltivec
7342 @opindex mno-altivec
7343 These switches enable or disable the use of built-in functions that
7344 allow access to the AltiVec instruction set.  You may also need to set
7345 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7346 enhancements.
7348 @item -mabi=spe
7349 @opindex mabi=spe
7350 Extend the current ABI with SPE ABI extensions.  This does not change
7351 the default ABI, instead it adds the SPE ABI extensions to the current
7352 ABI@.
7354 @item -mabi=no-spe
7355 @opindex mabi=no-spe
7356 Disable Booke SPE ABI extensions for the current ABI.
7358 @item -misel=@var{yes/no}
7359 @itemx -misel
7360 @opindex misel
7361 This switch enables or disables the generation of ISEL instructions.
7363 @item -mspe=@var{yes/no}
7364 @itemx -mspe
7365 @opindex mspe
7366 This switch enables or disables the generation of SPE simd
7367 instructions.
7369 @item -mfloat-gprs=@var{yes/no}
7370 @itemx -mfloat-gprs
7371 @opindex mfloat-gprs
7372 This switch enables or disables the generation of floating point
7373 operations on the general purpose registers for architectures that
7374 support it.  This option is currently only available on the MPC8540.
7376 @item -mfull-toc
7377 @itemx -mno-fp-in-toc
7378 @itemx -mno-sum-in-toc
7379 @itemx -mminimal-toc
7380 @opindex mfull-toc
7381 @opindex mno-fp-in-toc
7382 @opindex mno-sum-in-toc
7383 @opindex mminimal-toc
7384 Modify generation of the TOC (Table Of Contents), which is created for
7385 every executable file.  The @option{-mfull-toc} option is selected by
7386 default.  In that case, GCC will allocate at least one TOC entry for
7387 each unique non-automatic variable reference in your program.  GCC
7388 will also place floating-point constants in the TOC@.  However, only
7389 16,384 entries are available in the TOC@.
7391 If you receive a linker error message that saying you have overflowed
7392 the available TOC space, you can reduce the amount of TOC space used
7393 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7394 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7395 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7396 generate code to calculate the sum of an address and a constant at
7397 run-time instead of putting that sum into the TOC@.  You may specify one
7398 or both of these options.  Each causes GCC to produce very slightly
7399 slower and larger code at the expense of conserving TOC space.
7401 If you still run out of space in the TOC even when you specify both of
7402 these options, specify @option{-mminimal-toc} instead.  This option causes
7403 GCC to make only one TOC entry for every file.  When you specify this
7404 option, GCC will produce code that is slower and larger but which
7405 uses extremely little TOC space.  You may wish to use this option
7406 only on files that contain less frequently executed code.
7408 @item -maix64
7409 @itemx -maix32
7410 @opindex maix64
7411 @opindex maix32
7412 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7413 @code{long} type, and the infrastructure needed to support them.
7414 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7415 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7416 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7418 @item -mxl-call
7419 @itemx -mno-xl-call
7420 @opindex mxl-call
7421 @opindex mno-xl-call
7422 On AIX, pass floating-point arguments to prototyped functions beyond the
7423 register save area (RSA) on the stack in addition to argument FPRs.  The
7424 AIX calling convention was extended but not initially documented to
7425 handle an obscure K&R C case of calling a function that takes the
7426 address of its arguments with fewer arguments than declared.  AIX XL
7427 compilers access floating point arguments which do not fit in the
7428 RSA from the stack when a subroutine is compiled without
7429 optimization.  Because always storing floating-point arguments on the
7430 stack is inefficient and rarely needed, this option is not enabled by
7431 default and only is necessary when calling subroutines compiled by AIX
7432 XL compilers without optimization.
7434 @item -mpe
7435 @opindex mpe
7436 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7437 application written to use message passing with special startup code to
7438 enable the application to run.  The system must have PE installed in the
7439 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7440 must be overridden with the @option{-specs=} option to specify the
7441 appropriate directory location.  The Parallel Environment does not
7442 support threads, so the @option{-mpe} option and the @option{-pthread}
7443 option are incompatible.
7445 @item -malign-natural
7446 @itemx -malign-power
7447 @opindex malign-natural
7448 @opindex malign-power
7449 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7450 @option{-malign-natural} overrides the ABI-defined alignment of larger
7451 types, such as floating-point doubles, on their natural size-based boundary.
7452 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7453 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7455 @item -msoft-float
7456 @itemx -mhard-float
7457 @opindex msoft-float
7458 @opindex mhard-float
7459 Generate code that does not use (uses) the floating-point register set.
7460 Software floating point emulation is provided if you use the
7461 @option{-msoft-float} option, and pass the option to GCC when linking.
7463 @item -mmultiple
7464 @itemx -mno-multiple
7465 @opindex mmultiple
7466 @opindex mno-multiple
7467 Generate code that uses (does not use) the load multiple word
7468 instructions and the store multiple word instructions.  These
7469 instructions are generated by default on POWER systems, and not
7470 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7471 endian PowerPC systems, since those instructions do not work when the
7472 processor is in little endian mode.  The exceptions are PPC740 and
7473 PPC750 which permit the instructions usage in little endian mode.
7475 @item -mstring
7476 @itemx -mno-string
7477 @opindex mstring
7478 @opindex mno-string
7479 Generate code that uses (does not use) the load string instructions
7480 and the store string word instructions to save multiple registers and
7481 do small block moves.  These instructions are generated by default on
7482 POWER systems, and not generated on PowerPC systems.  Do not use
7483 @option{-mstring} on little endian PowerPC systems, since those
7484 instructions do not work when the processor is in little endian mode.
7485 The exceptions are PPC740 and PPC750 which permit the instructions
7486 usage in little endian mode.
7488 @item -mupdate
7489 @itemx -mno-update
7490 @opindex mupdate
7491 @opindex mno-update
7492 Generate code that uses (does not use) the load or store instructions
7493 that update the base register to the address of the calculated memory
7494 location.  These instructions are generated by default.  If you use
7495 @option{-mno-update}, there is a small window between the time that the
7496 stack pointer is updated and the address of the previous frame is
7497 stored, which means code that walks the stack frame across interrupts or
7498 signals may get corrupted data.
7500 @item -mfused-madd
7501 @itemx -mno-fused-madd
7502 @opindex mfused-madd
7503 @opindex mno-fused-madd
7504 Generate code that uses (does not use) the floating point multiply and
7505 accumulate instructions.  These instructions are generated by default if
7506 hardware floating is used.
7508 @item -mno-bit-align
7509 @itemx -mbit-align
7510 @opindex mno-bit-align
7511 @opindex mbit-align
7512 On System V.4 and embedded PowerPC systems do not (do) force structures
7513 and unions that contain bit-fields to be aligned to the base type of the
7514 bit-field.
7516 For example, by default a structure containing nothing but 8
7517 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7518 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7519 the structure would be aligned to a 1 byte boundary and be one byte in
7520 size.
7522 @item -mno-strict-align
7523 @itemx -mstrict-align
7524 @opindex mno-strict-align
7525 @opindex mstrict-align
7526 On System V.4 and embedded PowerPC systems do not (do) assume that
7527 unaligned memory references will be handled by the system.
7529 @item -mrelocatable
7530 @itemx -mno-relocatable
7531 @opindex mrelocatable
7532 @opindex mno-relocatable
7533 On embedded PowerPC systems generate code that allows (does not allow)
7534 the program to be relocated to a different address at runtime.  If you
7535 use @option{-mrelocatable} on any module, all objects linked together must
7536 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7538 @item -mrelocatable-lib
7539 @itemx -mno-relocatable-lib
7540 @opindex mrelocatable-lib
7541 @opindex mno-relocatable-lib
7542 On embedded PowerPC systems generate code that allows (does not allow)
7543 the program to be relocated to a different address at runtime.  Modules
7544 compiled with @option{-mrelocatable-lib} can be linked with either modules
7545 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7546 with modules compiled with the @option{-mrelocatable} options.
7548 @item -mno-toc
7549 @itemx -mtoc
7550 @opindex mno-toc
7551 @opindex mtoc
7552 On System V.4 and embedded PowerPC systems do not (do) assume that
7553 register 2 contains a pointer to a global area pointing to the addresses
7554 used in the program.
7556 @item -mlittle
7557 @itemx -mlittle-endian
7558 @opindex mlittle
7559 @opindex mlittle-endian
7560 On System V.4 and embedded PowerPC systems compile code for the
7561 processor in little endian mode.  The @option{-mlittle-endian} option is
7562 the same as @option{-mlittle}.
7564 @item -mbig
7565 @itemx -mbig-endian
7566 @opindex mbig
7567 @opindex mbig-endian
7568 On System V.4 and embedded PowerPC systems compile code for the
7569 processor in big endian mode.  The @option{-mbig-endian} option is
7570 the same as @option{-mbig}.
7572 @item -mdynamic-no-pic
7573 @opindex mdynamic-no-pic
7574 On Darwin and Mac OS X systems, compile code so that it is not
7575 relocatable, but that its external references are relocatable.  The
7576 resulting code is suitable for applications, but not shared
7577 libraries.
7579 @item -mprioritize-restricted-insns=@var{priority}
7580 @opindex mprioritize-restricted-insns
7581 This option controls the priority that is assigned to 
7582 dispatch-slot restricted instructions during the second scheduling 
7583 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign 
7584 @var{no/highest/second-highest} priority to dispatch slot restricted 
7585 instructions.
7587 @item -msched-costly-dep=@var{dependence_type}
7588 @opindex msched-costly-dep
7589 This option controls which dependences are considered costly
7590 by the target during instruction scheduling.  The argument
7591 @var{dependence_type} takes one of the following values:
7592 @var{no}: no dependence is costly, 
7593 @var{all}: all dependences are costly, 
7594 @var{true_store_to_load}: a true dependence from store to load is costly,
7595 @var{store_to_load}: any dependence from store to load is costly,
7596 @var{number}: any dependence which latency >= @var{number} is costly.
7598 @item -minsert-sched-nops=@var{scheme}
7599 @opindex minsert-sched-nops
7600 This option controls which nop insertion scheme will be used during
7601 the second scheduling pass. The argument @var{scheme} takes one of the
7602 following values:
7603 @var{no}: Don't insert nops.
7604 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7605 according to the scheduler's grouping.
7606 @var{regroup_exact}: Insert nops to force costly dependent insns into
7607 separate groups.  Insert exactly as many nops as needed to force an insn
7608 to a new group, according to the estimatied processor grouping.
7609 @var{number}: Insert nops to force costly dependent insns into 
7610 separate groups.  Insert @var{number} nops to force an insn to a new group.
7612 @item -mcall-sysv
7613 @opindex mcall-sysv
7614 On System V.4 and embedded PowerPC systems compile code using calling
7615 conventions that adheres to the March 1995 draft of the System V
7616 Application Binary Interface, PowerPC processor supplement.  This is the
7617 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7619 @item -mcall-sysv-eabi
7620 @opindex mcall-sysv-eabi
7621 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7623 @item -mcall-sysv-noeabi
7624 @opindex mcall-sysv-noeabi
7625 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7627 @item -mcall-solaris
7628 @opindex mcall-solaris
7629 On System V.4 and embedded PowerPC systems compile code for the Solaris
7630 operating system.
7632 @item -mcall-linux
7633 @opindex mcall-linux
7634 On System V.4 and embedded PowerPC systems compile code for the
7635 Linux-based GNU system.
7637 @item -mcall-gnu
7638 @opindex mcall-gnu
7639 On System V.4 and embedded PowerPC systems compile code for the
7640 Hurd-based GNU system.
7642 @item -mcall-netbsd
7643 @opindex mcall-netbsd
7644 On System V.4 and embedded PowerPC systems compile code for the
7645 NetBSD operating system.
7647 @item -maix-struct-return
7648 @opindex maix-struct-return
7649 Return all structures in memory (as specified by the AIX ABI)@.
7651 @item -msvr4-struct-return
7652 @opindex msvr4-struct-return
7653 Return structures smaller than 8 bytes in registers (as specified by the
7654 SVR4 ABI)@.
7656 @item -mabi=altivec
7657 @opindex mabi=altivec
7658 Extend the current ABI with AltiVec ABI extensions.  This does not
7659 change the default ABI, instead it adds the AltiVec ABI extensions to
7660 the current ABI@.
7662 @item -mabi=no-altivec
7663 @opindex mabi=no-altivec
7664 Disable AltiVec ABI extensions for the current ABI.
7666 @item -mprototype
7667 @itemx -mno-prototype
7668 @opindex mprototype
7669 @opindex mno-prototype
7670 On System V.4 and embedded PowerPC systems assume that all calls to
7671 variable argument functions are properly prototyped.  Otherwise, the
7672 compiler must insert an instruction before every non prototyped call to
7673 set or clear bit 6 of the condition code register (@var{CR}) to
7674 indicate whether floating point values were passed in the floating point
7675 registers in case the function takes a variable arguments.  With
7676 @option{-mprototype}, only calls to prototyped variable argument functions
7677 will set or clear the bit.
7679 @item -msim
7680 @opindex msim
7681 On embedded PowerPC systems, assume that the startup module is called
7682 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7683 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7684 configurations.
7686 @item -mmvme
7687 @opindex mmvme
7688 On embedded PowerPC systems, assume that the startup module is called
7689 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7690 @file{libc.a}.
7692 @item -mads
7693 @opindex mads
7694 On embedded PowerPC systems, assume that the startup module is called
7695 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7696 @file{libc.a}.
7698 @item -myellowknife
7699 @opindex myellowknife
7700 On embedded PowerPC systems, assume that the startup module is called
7701 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7702 @file{libc.a}.
7704 @item -mvxworks
7705 @opindex mvxworks
7706 On System V.4 and embedded PowerPC systems, specify that you are
7707 compiling for a VxWorks system.
7709 @item -mwindiss
7710 @opindex mwindiss
7711 Specify that you are compiling for the WindISS simulation environment.
7713 @item -memb
7714 @opindex memb
7715 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7716 header to indicate that @samp{eabi} extended relocations are used.
7718 @item -meabi
7719 @itemx -mno-eabi
7720 @opindex meabi
7721 @opindex mno-eabi
7722 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7723 Embedded Applications Binary Interface (eabi) which is a set of
7724 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7725 means that the stack is aligned to an 8 byte boundary, a function
7726 @code{__eabi} is called to from @code{main} to set up the eabi
7727 environment, and the @option{-msdata} option can use both @code{r2} and
7728 @code{r13} to point to two separate small data areas.  Selecting
7729 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7730 do not call an initialization function from @code{main}, and the
7731 @option{-msdata} option will only use @code{r13} to point to a single
7732 small data area.  The @option{-meabi} option is on by default if you
7733 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7735 @item -msdata=eabi
7736 @opindex msdata=eabi
7737 On System V.4 and embedded PowerPC systems, put small initialized
7738 @code{const} global and static data in the @samp{.sdata2} section, which
7739 is pointed to by register @code{r2}.  Put small initialized
7740 non-@code{const} global and static data in the @samp{.sdata} section,
7741 which is pointed to by register @code{r13}.  Put small uninitialized
7742 global and static data in the @samp{.sbss} section, which is adjacent to
7743 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7744 incompatible with the @option{-mrelocatable} option.  The
7745 @option{-msdata=eabi} option also sets the @option{-memb} option.
7747 @item -msdata=sysv
7748 @opindex msdata=sysv
7749 On System V.4 and embedded PowerPC systems, put small global and static
7750 data in the @samp{.sdata} section, which is pointed to by register
7751 @code{r13}.  Put small uninitialized global and static data in the
7752 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7753 The @option{-msdata=sysv} option is incompatible with the
7754 @option{-mrelocatable} option.
7756 @item -msdata=default
7757 @itemx -msdata
7758 @opindex msdata=default
7759 @opindex msdata
7760 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7761 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7762 same as @option{-msdata=sysv}.
7764 @item -msdata-data
7765 @opindex msdata-data
7766 On System V.4 and embedded PowerPC systems, put small global and static
7767 data in the @samp{.sdata} section.  Put small uninitialized global and
7768 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7769 to address small data however.  This is the default behavior unless
7770 other @option{-msdata} options are used.
7772 @item -msdata=none
7773 @itemx -mno-sdata
7774 @opindex msdata=none
7775 @opindex mno-sdata
7776 On embedded PowerPC systems, put all initialized global and static data
7777 in the @samp{.data} section, and all uninitialized data in the
7778 @samp{.bss} section.
7780 @item -G @var{num}
7781 @opindex G
7782 @cindex smaller data references (PowerPC)
7783 @cindex .sdata/.sdata2 references (PowerPC)
7784 On embedded PowerPC systems, put global and static items less than or
7785 equal to @var{num} bytes into the small data or bss sections instead of
7786 the normal data or bss section.  By default, @var{num} is 8.  The
7787 @option{-G @var{num}} switch is also passed to the linker.
7788 All modules should be compiled with the same @option{-G @var{num}} value.
7790 @item -mregnames
7791 @itemx -mno-regnames
7792 @opindex mregnames
7793 @opindex mno-regnames
7794 On System V.4 and embedded PowerPC systems do (do not) emit register
7795 names in the assembly language output using symbolic forms.
7797 @item -mlongcall
7798 @itemx -mno-longcall
7799 @opindex mlongcall
7800 @opindex mno-longcall
7801 Default to making all function calls via pointers, so that functions
7802 which reside further than 64 megabytes (67,108,864 bytes) from the
7803 current location can be called.  This setting can be overridden by the
7804 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7806 Some linkers are capable of detecting out-of-range calls and generating
7807 glue code on the fly.  On these systems, long calls are unnecessary and
7808 generate slower code.  As of this writing, the AIX linker can do this,
7809 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7810 to the GNU linker for 32-bit PowerPC systems as well.
7812 In the future, we may cause GCC to ignore all longcall specifications
7813 when the linker is known to generate glue.
7815 @item -pthread
7816 @opindex pthread
7817 Adds support for multithreading with the @dfn{pthreads} library.
7818 This option sets flags for both the preprocessor and linker.
7820 @end table
7822 @node Darwin Options
7823 @subsection Darwin Options
7824 @cindex Darwin options
7826 These options are defined for all architectures running the Darwin operating
7827 system.  They are useful for compatibility with other Mac OS compilers.
7829 @table @gcctabopt
7830 @item -all_load    
7831 @opindex all_load   
7832 Loads all members of static archive libraries.
7833 See man ld(1) for more information.
7835 @item -arch_errors_fatal
7836 @opindex arch_errors_fatal
7837 Cause the errors having to do with files that have the wrong architecture
7838 to be fatal.
7840 @item -bind_at_load
7841 @opindex bind_at_load
7842 Causes the output file to be marked such that the dynamic linker will
7843 bind all undefined references when the file is loaded or launched.
7845 @item -bundle     
7846 @opindex bundle
7847 Produce a Mach-o bundle format file.
7848 See man ld(1) for more information.
7850 @item -bundle_loader @var{executable}
7851 @opindex bundle_loader
7852 This specifies the @var{executable} that will be loading the build
7853 output file being linked. See man ld(1) for more information.
7855 @item -allowable_client  @var{client_name}
7856 @item -arch_only
7858 @item -client_name       
7859 @item -compatibility_version
7860 @item -current_version    
7861 @item -dependency-file
7862 @item -dylib_file    
7863 @item -dylinker_install_name
7864 @item -dynamic
7865 @item -dynamiclib   
7866 @item -exported_symbols_list  
7867 @item -filelist
7868 @item -flat_namespace   
7869 @item -force_cpusubtype_ALL
7870 @item -force_flat_namespace   
7871 @item -headerpad_max_install_names
7872 @item -image_base  
7873 @item -init
7874 @item -install_name
7875 @item -keep_private_externs
7876 @item -multi_module
7877 @item -multiply_defined      
7878 @item -multiply_defined_unused      
7879 @item -noall_load  
7880 @item -nofixprebinding
7881 @item -nomultidefs
7882 @item -noprebind     
7883 @item -noseglinkedit
7884 @item -pagezero_size    
7885 @item -prebind
7886 @item -prebind_all_twolevel_modules
7887 @item -private_bundle
7888 @item -read_only_relocs
7889 @item -sectalign  
7890 @item -sectobjectsymbols    
7891 @item -whyload
7892 @item -seg1addr 
7893 @item -sectcreate
7894 @item -sectobjectsymbols
7895 @item -sectorder
7896 @item -seg_addr_table
7897 @item -seg_addr_table_filename
7898 @item -seglinkedit
7899 @item -segprot   
7900 @item -segs_read_only_addr
7901 @item -segs_read_write_addr
7902 @item -single_module   
7903 @item -static
7904 @item -sub_library
7905 @item -sub_umbrella 
7906 @item -twolevel_namespace
7907 @item -umbrella
7908 @item -undefined
7909 @item -unexported_symbols_list
7910 @item -weak_reference_mismatches
7911 @item -whatsloaded  
7913 @opindex allowable_client
7914 @opindex arch_only    
7915 @opindex client_name
7916 @opindex compatibility_version
7917 @opindex current_version
7918 @opindex dependency-file
7919 @opindex dylib_file
7920 @opindex dylinker_install_name
7921 @opindex dynamic
7922 @opindex dynamiclib
7923 @opindex exported_symbols_list
7924 @opindex filelist  
7925 @opindex flat_namespace    
7926 @opindex force_cpusubtype_ALL
7927 @opindex force_flat_namespace
7928 @opindex headerpad_max_install_names
7929 @opindex image_base
7930 @opindex init     
7931 @opindex install_name
7932 @opindex keep_private_externs
7933 @opindex multi_module   
7934 @opindex multiply_defined
7935 @opindex multiply_defined_unused   
7936 @opindex noall_load  
7937 @opindex nofixprebinding
7938 @opindex nomultidefs   
7939 @opindex noprebind
7940 @opindex noseglinkedit      
7941 @opindex pagezero_size
7942 @opindex prebind
7943 @opindex prebind_all_twolevel_modules
7944 @opindex private_bundle 
7945 @opindex read_only_relocs
7946 @opindex sectalign   
7947 @opindex sectobjectsymbols    
7948 @opindex whyload  
7949 @opindex seg1addr
7950 @opindex sectcreate       
7951 @opindex sectobjectsymbols 
7952 @opindex sectorder     
7953 @opindex seg_addr_table
7954 @opindex seg_addr_table_filename
7955 @opindex seglinkedit
7956 @opindex segprot
7957 @opindex segs_read_only_addr
7958 @opindex segs_read_write_addr
7959 @opindex single_module
7960 @opindex static
7961 @opindex sub_library
7962 @opindex sub_umbrella
7963 @opindex twolevel_namespace
7964 @opindex umbrella
7965 @opindex undefined
7966 @opindex unexported_symbols_list
7967 @opindex weak_reference_mismatches
7968 @opindex whatsloaded
7970 This options are available for Darwin linker. Darwin linker man page
7971 describes them in detail.
7972 @end table
7975 @node RT Options
7976 @subsection IBM RT Options
7977 @cindex RT options
7978 @cindex IBM RT options
7980 These @samp{-m} options are defined for the IBM RT PC:
7982 @table @gcctabopt
7983 @item -min-line-mul
7984 @opindex min-line-mul
7985 Use an in-line code sequence for integer multiplies.  This is the
7986 default.
7988 @item -mcall-lib-mul
7989 @opindex mcall-lib-mul
7990 Call @code{lmul$$} for integer multiples.
7992 @item -mfull-fp-blocks
7993 @opindex mfull-fp-blocks
7994 Generate full-size floating point data blocks, including the minimum
7995 amount of scratch space recommended by IBM@.  This is the default.
7997 @item -mminimum-fp-blocks
7998 @opindex mminimum-fp-blocks
7999 Do not include extra scratch space in floating point data blocks.  This
8000 results in smaller code, but slower execution, since scratch space must
8001 be allocated dynamically.
8003 @cindex @file{stdarg.h} and RT PC
8004 @item -mfp-arg-in-fpregs
8005 @opindex mfp-arg-in-fpregs
8006 Use a calling sequence incompatible with the IBM calling convention in
8007 which floating point arguments are passed in floating point registers.
8008 Note that @code{stdarg.h} will not work with floating point operands
8009 if this option is specified.
8011 @item -mfp-arg-in-gregs
8012 @opindex mfp-arg-in-gregs
8013 Use the normal calling convention for floating point arguments.  This is
8014 the default.
8016 @item -mhc-struct-return
8017 @opindex mhc-struct-return
8018 Return structures of more than one word in memory, rather than in a
8019 register.  This provides compatibility with the MetaWare HighC (hc)
8020 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
8021 with the Portable C Compiler (pcc).
8023 @item -mnohc-struct-return
8024 @opindex mnohc-struct-return
8025 Return some structures of more than one word in registers, when
8026 convenient.  This is the default.  For compatibility with the
8027 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
8028 option @option{-mhc-struct-return}.
8029 @end table
8031 @node MIPS Options
8032 @subsection MIPS Options
8033 @cindex MIPS options
8035 These @samp{-m} options are defined for the MIPS family of computers:
8037 @table @gcctabopt
8039 @item -march=@var{arch}
8040 @opindex march
8041 Generate code that will run on @var{arch}, which can be the name of a
8042 generic MIPS ISA, or the name of a particular processor.
8043 The ISA names are:
8044 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
8045 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
8046 The processor names are:
8047 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
8048 @samp{m4k},
8049 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
8050 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
8051 @samp{rm9000},
8052 @samp{orion},
8053 @samp{sb1},
8054 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
8055 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
8056 The special value @samp{from-abi} selects the
8057 most compatible architecture for the selected ABI (that is,
8058 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
8060 In processor names, a final @samp{000} can be abbreviated as @samp{k}
8061 (for example, @samp{-march=r2k}).  Prefixes are optional, and
8062 @samp{vr} may be written @samp{r}.
8064 GCC defines two macros based on the value of this option.  The first
8065 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
8066 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
8067 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
8068 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
8069 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
8071 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
8072 above.  In other words, it will have the full prefix and will not
8073 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
8074 the macro names the resolved architecture (either @samp{"mips1"} or
8075 @samp{"mips3"}).  It names the default architecture when no
8076 @option{-march} option is given.
8078 @item -mtune=@var{arch}
8079 @opindex mtune
8080 Optimize for @var{arch}.  Among other things, this option controls
8081 the way instructions are scheduled, and the perceived cost of arithmetic
8082 operations.  The list of @var{arch} values is the same as for
8083 @option{-march}.
8085 When this option is not used, GCC will optimize for the processor
8086 specified by @option{-march}.  By using @option{-march} and
8087 @option{-mtune} together, it is possible to generate code that will
8088 run on a family of processors, but optimize the code for one
8089 particular member of that family.
8091 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
8092 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
8093 @samp{-march} ones described above.
8095 @item -mips1
8096 @opindex mips1
8097 Equivalent to @samp{-march=mips1}.
8099 @item -mips2
8100 @opindex mips2
8101 Equivalent to @samp{-march=mips2}.
8103 @item -mips3
8104 @opindex mips3
8105 Equivalent to @samp{-march=mips3}.
8107 @item -mips4
8108 @opindex mips4
8109 Equivalent to @samp{-march=mips4}.
8111 @item -mips32
8112 @opindex mips32
8113 Equivalent to @samp{-march=mips32}.
8115 @item -mips32r2
8116 @opindex mips32r2
8117 Equivalent to @samp{-march=mips32r2}.
8119 @item -mips64
8120 @opindex mips64
8121 Equivalent to @samp{-march=mips64}.
8123 @item -mfused-madd
8124 @itemx -mno-fused-madd
8125 @opindex mfused-madd
8126 @opindex mno-fused-madd
8127 Generate code that uses (does not use) the floating point multiply and
8128 accumulate instructions, when they are available.  These instructions
8129 are generated by default if they are available, but this may be
8130 undesirable if the extra precision causes problems or on certain chips
8131 in the mode where denormals are rounded to zero where denormals
8132 generated by multiply and accumulate instructions cause exceptions
8133 anyway.
8135 @item -mfp32
8136 @opindex mfp32
8137 Assume that floating point registers are 32 bits wide.
8139 @item -mfp64
8140 @opindex mfp64
8141 Assume that floating point registers are 64 bits wide.
8143 @item -mgp32
8144 @opindex mgp32
8145 Assume that general purpose registers are 32 bits wide.
8147 @item -mgp64
8148 @opindex mgp64
8149 Assume that general purpose registers are 64 bits wide.
8151 @item -mint64
8152 @opindex mint64
8153 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
8154 explanation of the default, and the width of pointers.
8156 @item -mlong64
8157 @opindex mlong64
8158 Force long types to be 64 bits wide.  See @option{-mlong32} for an
8159 explanation of the default, and the width of pointers.
8161 @item -mlong32
8162 @opindex mlong32
8163 Force long, int, and pointer types to be 32 bits wide.
8165 The default size of ints, longs and pointers depends on the ABI@.  All
8166 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
8167 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
8168 are the same size as longs, or the same size as integer registers,
8169 whichever is smaller.
8171 @item -mabi=32
8172 @itemx -mabi=o64
8173 @itemx -mabi=n32
8174 @itemx -mabi=64
8175 @itemx -mabi=eabi
8176 @itemx -mabi=meabi
8177 @opindex mabi=32
8178 @opindex mabi=o64
8179 @opindex mabi=n32
8180 @opindex mabi=64
8181 @opindex mabi=eabi
8182 @opindex mabi=meabi
8183 Generate code for the given ABI@.
8185 Note that there are two embedded ABIs: @option{-mabi=eabi}
8186 selects the one defined by Cygnus while @option{-meabi=meabi}
8187 selects the one defined by MIPS@.  Both these ABIs have
8188 32-bit and 64-bit variants.  Normally, GCC will generate
8189 64-bit code when you select a 64-bit architecture, but you
8190 can use @option{-mgp32} to get 32-bit code instead.
8192 @item -mabi-fake-default
8193 @opindex mabi-fake-default
8194 You don't want to know what this option does.  No, really.  I mean
8195 it.  Move on to the next option.
8197 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
8198 wants the default set of options to get the root of the multilib tree,
8199 and the shared library SONAMEs without any multilib-indicating
8200 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
8201 we want to default to the N32 ABI, while still being binary-compatible
8202 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
8203 binary-compatible means shared libraries should have the same SONAMEs,
8204 and libraries should live in the same location.  Having O32 libraries
8205 in a sub-directory named say @file{o32} is not acceptable.
8207 So we trick GCC into believing that O32 is the default ABI, except
8208 that we override the default with some internal command-line
8209 processing magic.  Problem is, if we stopped at that, and you then
8210 created a multilib-aware package that used the output of @command{gcc
8211 -print-multi-lib} to decide which multilibs to build, and how, and
8212 you'd find yourself in an awkward situation when you found out that
8213 some of the options listed ended up mapping to the same multilib, and
8214 none of your libraries was actually built for the multilib that
8215 @option{-print-multi-lib} claims to be the default.  So we added this
8216 option that disables the default switcher, falling back to GCC's
8217 original notion of the default library.  Confused yet?
8219 For short: don't ever use this option, unless you find it in the list
8220 of additional options to be used when building for multilibs, in the
8221 output of @option{gcc -print-multi-lib}.
8223 @item -mmips-as
8224 @opindex mmips-as
8225 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
8226 add normal debug information.  This is the default for all
8227 platforms except for the OSF/1 reference platform, using the OSF/rose
8228 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
8229 switches are used, the @file{mips-tfile} program will encapsulate the
8230 stabs within MIPS ECOFF@.
8232 @item -mgas
8233 @opindex mgas
8234 Generate code for the GNU assembler.  This is the default on the OSF/1
8235 reference platform, using the OSF/rose object format.  Also, this is
8236 the default if the configure option @option{--with-gnu-as} is used.
8238 @item -msplit-addresses
8239 @itemx -mno-split-addresses
8240 @opindex msplit-addresses
8241 @opindex mno-split-addresses
8242 Generate code to load the high and low parts of address constants separately.
8243 This allows GCC to optimize away redundant loads of the high order
8244 bits of addresses.  This optimization requires GNU as and GNU ld.
8245 This optimization is enabled by default for some embedded targets where
8246 GNU as and GNU ld are standard.
8248 @item -mrnames
8249 @itemx -mno-rnames
8250 @opindex mrnames
8251 @opindex mno-rnames
8252 The @option{-mrnames} switch says to output code using the MIPS software
8253 names for the registers, instead of the hardware names (ie, @var{a0}
8254 instead of @var{$4}).  The only known assembler that supports this option
8255 is the Algorithmics assembler.
8257 @item -mmemcpy
8258 @itemx -mno-memcpy
8259 @opindex mmemcpy
8260 @opindex mno-memcpy
8261 The @option{-mmemcpy} switch makes all block moves call the appropriate
8262 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
8263 generating inline code.
8265 @item -mmips-tfile
8266 @itemx -mno-mips-tfile
8267 @opindex mmips-tfile
8268 @opindex mno-mips-tfile
8269 The @option{-mno-mips-tfile} switch causes the compiler not
8270 postprocess the object file with the @file{mips-tfile} program,
8271 after the MIPS assembler has generated it to add debug support.  If
8272 @file{mips-tfile} is not run, then no local variables will be
8273 available to the debugger.  In addition, @file{stage2} and
8274 @file{stage3} objects will have the temporary file names passed to the
8275 assembler embedded in the object file, which means the objects will
8276 not compare the same.  The @option{-mno-mips-tfile} switch should only
8277 be used when there are bugs in the @file{mips-tfile} program that
8278 prevents compilation.
8280 @item -msoft-float
8281 @opindex msoft-float
8282 Generate output containing library calls for floating point.
8283 @strong{Warning:} the requisite libraries are not part of GCC@.
8284 Normally the facilities of the machine's usual C compiler are used, but
8285 this can't be done directly in cross-compilation.  You must make your
8286 own arrangements to provide suitable library functions for
8287 cross-compilation.
8289 @item -mhard-float
8290 @opindex mhard-float
8291 Generate output containing floating point instructions.  This is the
8292 default if you use the unmodified sources.
8294 @item -mabicalls
8295 @itemx -mno-abicalls
8296 @opindex mabicalls
8297 @opindex mno-abicalls
8298 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8299 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8300 position independent code.
8302 @item -mxgot
8303 @itemx -mno-xgot
8304 @opindex mxgot
8305 @opindex mno-xgot
8306 Lift (or do not lift) the usual restrictions on the size of the global
8307 offset table.
8309 GCC normally uses a single instruction to load values from the GOT.
8310 While this is relatively efficient, it will only work if the GOT
8311 is smaller than about 64k.  Anything larger will cause the linker
8312 to report an error such as:
8314 @cindex relocation truncated to fit (MIPS)
8315 @smallexample
8316 relocation truncated to fit: R_MIPS_GOT16 foobar
8317 @end smallexample
8319 If this happens, you should recompile your code with @option{-mxgot}.
8320 It should then work with very large GOTs, although it will also be
8321 less efficient, since it will take three instructions to fetch the
8322 value of a global symbol.
8324 Note that some linkers can create multiple GOTs.  If you have such a
8325 linker, you should only need to use @option{-mxgot} when a single object
8326 file accesses more than 64k's worth of GOT entries.  Very few do.
8328 These options have no effect unless GCC is generating position
8329 independent code.
8331 @item -mlong-calls
8332 @itemx -mno-long-calls
8333 @opindex mlong-calls
8334 @opindex mno-long-calls
8335 Do all calls with the @samp{JALR} instruction, which requires
8336 loading up a function's address into a register before the call.
8337 You need to use this switch, if you call outside of the current
8338 512 megabyte segment to functions that are not through pointers.
8340 @item -membedded-pic
8341 @itemx -mno-embedded-pic
8342 @opindex membedded-pic
8343 @opindex mno-embedded-pic
8344 Generate PIC code suitable for some embedded systems.  All calls are
8345 made using PC relative address, and all data is addressed using the $gp
8346 register.  No more than 65536 bytes of global data may be used.  This
8347 requires GNU as and GNU ld which do most of the work.  This currently
8348 only works on targets which use ECOFF; it does not work with ELF@.
8350 @item -membedded-data
8351 @itemx -mno-embedded-data
8352 @opindex membedded-data
8353 @opindex mno-embedded-data
8354 Allocate variables to the read-only data section first if possible, then
8355 next in the small data section if possible, otherwise in data.  This gives
8356 slightly slower code than the default, but reduces the amount of RAM required
8357 when executing, and thus may be preferred for some embedded systems.
8359 @item -muninit-const-in-rodata
8360 @itemx -mno-uninit-const-in-rodata
8361 @opindex muninit-const-in-rodata
8362 @opindex mno-uninit-const-in-rodata
8363 When used together with @option{-membedded-data}, it will always store uninitialized
8364 const variables in the read-only data section.
8366 @item -msingle-float
8367 @itemx -mdouble-float
8368 @opindex msingle-float
8369 @opindex mdouble-float
8370 The @option{-msingle-float} switch tells gcc to assume that the floating
8371 point coprocessor only supports single precision operations, as on the
8372 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8373 double precision operations.  This is the default.
8375 @item -mmad
8376 @itemx -mno-mad
8377 @opindex mmad
8378 @opindex mno-mad
8379 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8380 as on the @samp{r4650} chip.
8382 @item -m4650
8383 @opindex m4650
8384 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8385 @option{-mcpu=r4650}.
8387 @item -mips16
8388 @itemx -mno-mips16
8389 @opindex mips16
8390 @opindex mno-mips16
8391 Enable 16-bit instructions.
8393 @item -EL
8394 @opindex EL
8395 Compile code for the processor in little endian mode.
8396 The requisite libraries are assumed to exist.
8398 @item -EB
8399 @opindex EB
8400 Compile code for the processor in big endian mode.
8401 The requisite libraries are assumed to exist.
8403 @item -G @var{num}
8404 @opindex G
8405 @cindex smaller data references (MIPS)
8406 @cindex gp-relative references (MIPS)
8407 Put global and static items less than or equal to @var{num} bytes into
8408 the small data or bss sections instead of the normal data or bss
8409 section.  This allows the assembler to emit one word memory reference
8410 instructions based on the global pointer (@var{gp} or @var{$28}),
8411 instead of the normal two words used.  By default, @var{num} is 8 when
8412 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8413 @option{-G @var{num}} switch is also passed to the assembler and linker.
8414 All modules should be compiled with the same @option{-G @var{num}}
8415 value.
8417 @item -nocpp
8418 @opindex nocpp
8419 Tell the MIPS assembler to not run its preprocessor over user
8420 assembler files (with a @samp{.s} suffix) when assembling them.
8422 @item -mfix7000
8423 @opindex mfix7000
8424 Pass an option to gas which will cause nops to be inserted if
8425 the read of the destination register of an mfhi or mflo instruction
8426 occurs in the following two instructions.
8428 @item -mfix-sb1
8429 @itemx -mno-fix-sb1
8430 @opindex mfix-sb1
8431 Work around certain SB-1 CPU core errata.
8432 (This flag currently works around the SB-1 revision 2
8433 ``F1'' and ``F2'' floating point errata.)
8435 @item -no-crt0
8436 @opindex no-crt0
8437 Do not include the default crt0.
8439 @item -mflush-func=@var{func}
8440 @itemx -mno-flush-func
8441 @opindex mflush-func
8442 Specifies the function to call to flush the I and D caches, or to not
8443 call any such function.  If called, the function must take the same
8444 arguments as the common @code{_flush_func()}, that is, the address of the
8445 memory range for which the cache is being flushed, the size of the
8446 memory range, and the number 3 (to flush both caches).  The default
8447 depends on the target gcc was configured for, but commonly is either
8448 @samp{_flush_func} or @samp{__cpu_flush}.
8450 @item -mbranch-likely
8451 @itemx -mno-branch-likely
8452 @opindex mbranch-likely
8453 @opindex mno-branch-likely
8454 Enable or disable use of Branch Likely instructions, regardless of the
8455 default for the selected architecture.  By default, Branch Likely
8456 instructions may be generated if they are supported by the selected
8457 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8458 and processors which implement those architectures; for those, Branch
8459 Likely instructions will not be generated by default because the MIPS32
8460 and MIPS64 architectures specifically deprecate their use.
8461 @end table
8463 @node i386 and x86-64 Options
8464 @subsection Intel 386 and AMD x86-64 Options
8465 @cindex i386 Options
8466 @cindex x86-64 Options
8467 @cindex Intel 386 Options
8468 @cindex AMD x86-64 Options
8470 These @samp{-m} options are defined for the i386 and x86-64 family of
8471 computers:
8473 @table @gcctabopt
8474 @item -mtune=@var{cpu-type}
8475 @opindex mtune
8476 Tune to @var{cpu-type} everything applicable about the generated code, except
8477 for the ABI and the set of available instructions.  The choices for
8478 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8479 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8480 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8481 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8482 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8483 and @samp{c3-2}.
8485 While picking a specific @var{cpu-type} will schedule things appropriately
8486 for that particular chip, the compiler will not generate any code that
8487 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8488 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8489 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8490 AMD chips as opposed to the Intel ones.
8492 @item -march=@var{cpu-type}
8493 @opindex march
8494 Generate instructions for the machine type @var{cpu-type}.  The choices
8495 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8496 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8498 @item -mcpu=@var{cpu-type}
8499 @opindex mcpu
8500 A deprecated synonym for @option{-mtune}.
8502 @item -m386
8503 @itemx -m486
8504 @itemx -mpentium
8505 @itemx -mpentiumpro
8506 @opindex m386
8507 @opindex m486
8508 @opindex mpentium
8509 @opindex mpentiumpro
8510 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8511 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8512 These synonyms are deprecated.
8514 @item -mfpmath=@var{unit}
8515 @opindex march
8516 generate floating point arithmetics for selected unit @var{unit}.  the choices
8517 for @var{unit} are:
8519 @table @samp
8520 @item 387
8521 Use the standard 387 floating point coprocessor present majority of chips and
8522 emulated otherwise.  Code compiled with this option will run almost everywhere.
8523 The temporary results are computed in 80bit precision instead of precision
8524 specified by the type resulting in slightly different results compared to most
8525 of other chips. See @option{-ffloat-store} for more detailed description.
8527 This is the default choice for i386 compiler.
8529 @item sse
8530 Use scalar floating point instructions present in the SSE instruction set.
8531 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8532 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8533 instruction set supports only single precision arithmetics, thus the double and
8534 extended precision arithmetics is still done using 387.  Later version, present
8535 only in Pentium4 and the future AMD x86-64 chips supports double precision
8536 arithmetics too.
8538 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8539 @option{-msse2} switches to enable SSE extensions and make this option
8540 effective.  For x86-64 compiler, these extensions are enabled by default.
8542 The resulting code should be considerably faster in majority of cases and avoid
8543 the numerical instability problems of 387 code, but may break some existing
8544 code that expects temporaries to be 80bit.
8546 This is the default choice for x86-64 compiler.
8548 @item pni
8549 Use all SSE extensions enabled by @option{-msse2} as well as the new
8550 SSE extensions in Prescott New Instructions. @option{-mpni} also
8551 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8552 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8553 @code{mwait}. 
8555 @item sse,387
8556 Attempt to utilize both instruction sets at once.  This effectively double the
8557 amount of available registers and on chips with separate execution units for
8558 387 and SSE the execution resources too.  Use this option with care, as it is
8559 still experimental, because gcc register allocator does not model separate
8560 functional units well resulting in instable performance.
8561 @end table
8563 @item -masm=@var{dialect}
8564 @opindex masm=@var{dialect}
8565 Output asm instructions using selected @var{dialect}. Supported choices are
8566 @samp{intel} or @samp{att} (the default one).
8568 @item -mieee-fp
8569 @itemx -mno-ieee-fp
8570 @opindex mieee-fp
8571 @opindex mno-ieee-fp
8572 Control whether or not the compiler uses IEEE floating point
8573 comparisons.  These handle correctly the case where the result of a
8574 comparison is unordered.
8576 @item -msoft-float
8577 @opindex msoft-float
8578 Generate output containing library calls for floating point.
8579 @strong{Warning:} the requisite libraries are not part of GCC@.
8580 Normally the facilities of the machine's usual C compiler are used, but
8581 this can't be done directly in cross-compilation.  You must make your
8582 own arrangements to provide suitable library functions for
8583 cross-compilation.
8585 On machines where a function returns floating point results in the 80387
8586 register stack, some floating point opcodes may be emitted even if
8587 @option{-msoft-float} is used.
8589 @item -mno-fp-ret-in-387
8590 @opindex mno-fp-ret-in-387
8591 Do not use the FPU registers for return values of functions.
8593 The usual calling convention has functions return values of types
8594 @code{float} and @code{double} in an FPU register, even if there
8595 is no FPU@.  The idea is that the operating system should emulate
8596 an FPU@.
8598 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8599 in ordinary CPU registers instead.
8601 @item -mno-fancy-math-387
8602 @opindex mno-fancy-math-387
8603 Some 387 emulators do not support the @code{sin}, @code{cos} and
8604 @code{sqrt} instructions for the 387.  Specify this option to avoid
8605 generating those instructions.  This option is the default on FreeBSD,
8606 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8607 indicates that the target cpu will always have an FPU and so the
8608 instruction will not need emulation.  As of revision 2.6.1, these
8609 instructions are not generated unless you also use the
8610 @option{-funsafe-math-optimizations} switch.
8612 @item -malign-double
8613 @itemx -mno-align-double
8614 @opindex malign-double
8615 @opindex mno-align-double
8616 Control whether GCC aligns @code{double}, @code{long double}, and
8617 @code{long long} variables on a two word boundary or a one word
8618 boundary.  Aligning @code{double} variables on a two word boundary will
8619 produce code that runs somewhat faster on a @samp{Pentium} at the
8620 expense of more memory.
8622 @strong{Warning:} if you use the @option{-malign-double} switch,
8623 structures containing the above types will be aligned differently than
8624 the published application binary interface specifications for the 386
8625 and will not be binary compatible with structures in code compiled
8626 without that switch.
8628 @item -m96bit-long-double
8629 @item -m128bit-long-double
8630 @opindex m96bit-long-double
8631 @opindex m128bit-long-double
8632 These switches control the size of @code{long double} type. The i386 
8633 application binary interface specifies the size to be 96 bits, 
8634 so @option{-m96bit-long-double} is the default in 32 bit mode.
8636 Modern architectures (Pentium and newer) would prefer @code{long double}
8637 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8638 conforming to the ABI, this would not be possible.  So specifying a 
8639 @option{-m128bit-long-double} will align @code{long double}
8640 to a 16 byte boundary by padding the @code{long double} with an additional
8641 32 bit zero. 
8643 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8644 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8646 Notice that neither of these options enable any extra precision over the x87
8647 standard of 80 bits for a @code{long double}. 
8649 @strong{Warning:} if you override the default value for your target ABI, the
8650 structures and arrays containing @code{long double} will change their size as
8651 well as function calling convention for function taking @code{long double}
8652 will be modified.  Hence they will not be binary compatible with arrays or
8653 structures in code compiled without that switch.
8656 @item -msvr3-shlib
8657 @itemx -mno-svr3-shlib
8658 @opindex msvr3-shlib
8659 @opindex mno-svr3-shlib
8660 Control whether GCC places uninitialized local variables into the
8661 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8662 into @code{bss}.  These options are meaningful only on System V Release 3.
8664 @item -mrtd
8665 @opindex mrtd
8666 Use a different function-calling convention, in which functions that
8667 take a fixed number of arguments return with the @code{ret} @var{num}
8668 instruction, which pops their arguments while returning.  This saves one
8669 instruction in the caller since there is no need to pop the arguments
8670 there.
8672 You can specify that an individual function is called with this calling
8673 sequence with the function attribute @samp{stdcall}.  You can also
8674 override the @option{-mrtd} option by using the function attribute
8675 @samp{cdecl}.  @xref{Function Attributes}.
8677 @strong{Warning:} this calling convention is incompatible with the one
8678 normally used on Unix, so you cannot use it if you need to call
8679 libraries compiled with the Unix compiler.
8681 Also, you must provide function prototypes for all functions that
8682 take variable numbers of arguments (including @code{printf});
8683 otherwise incorrect code will be generated for calls to those
8684 functions.
8686 In addition, seriously incorrect code will result if you call a
8687 function with too many arguments.  (Normally, extra arguments are
8688 harmlessly ignored.)
8690 @item -mregparm=@var{num}
8691 @opindex mregparm
8692 Control how many registers are used to pass integer arguments.  By
8693 default, no registers are used to pass arguments, and at most 3
8694 registers can be used.  You can control this behavior for a specific
8695 function by using the function attribute @samp{regparm}.
8696 @xref{Function Attributes}.
8698 @strong{Warning:} if you use this switch, and
8699 @var{num} is nonzero, then you must build all modules with the same
8700 value, including any libraries.  This includes the system libraries and
8701 startup modules.
8703 @item -mpreferred-stack-boundary=@var{num}
8704 @opindex mpreferred-stack-boundary
8705 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8706 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8707 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8708 size (@option{-Os}), in which case the default is the minimum correct
8709 alignment (4 bytes for x86, and 8 bytes for x86-64).
8711 On Pentium and PentiumPro, @code{double} and @code{long double} values
8712 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8713 suffer significant run time performance penalties.  On Pentium III, the
8714 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8715 penalties if it is not 16 byte aligned.
8717 To ensure proper alignment of this values on the stack, the stack boundary
8718 must be as aligned as that required by any value stored on the stack.
8719 Further, every function must be generated such that it keeps the stack
8720 aligned.  Thus calling a function compiled with a higher preferred
8721 stack boundary from a function compiled with a lower preferred stack
8722 boundary will most likely misalign the stack.  It is recommended that
8723 libraries that use callbacks always use the default setting.
8725 This extra alignment does consume extra stack space, and generally
8726 increases code size.  Code that is sensitive to stack space usage, such
8727 as embedded systems and operating system kernels, may want to reduce the
8728 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8730 @item -mmmx
8731 @itemx -mno-mmx
8732 @item -msse
8733 @itemx -mno-sse
8734 @item -msse2
8735 @itemx -mno-sse2
8736 @item -mpni
8737 @itemx -mno-pni
8738 @item -m3dnow
8739 @itemx -mno-3dnow
8740 @opindex mmmx
8741 @opindex mno-mmx
8742 @opindex msse
8743 @opindex mno-sse
8744 @opindex m3dnow
8745 @opindex mno-3dnow
8746 These switches enable or disable the use of built-in functions that allow
8747 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8749 @xref{X86 Built-in Functions}, for details of the functions enabled
8750 and disabled by these switches.
8752 To have SSE/SSE2 instructions generated automatically from floating-point
8753 code, see @option{-mfpmath=sse}.
8755 @item -mpush-args
8756 @itemx -mno-push-args
8757 @opindex mpush-args
8758 @opindex mno-push-args
8759 Use PUSH operations to store outgoing parameters.  This method is shorter
8760 and usually equally fast as method using SUB/MOV operations and is enabled
8761 by default.  In some cases disabling it may improve performance because of
8762 improved scheduling and reduced dependencies.
8764 @item -maccumulate-outgoing-args
8765 @opindex maccumulate-outgoing-args
8766 If enabled, the maximum amount of space required for outgoing arguments will be
8767 computed in the function prologue.  This is faster on most modern CPUs
8768 because of reduced dependencies, improved scheduling and reduced stack usage
8769 when preferred stack boundary is not equal to 2.  The drawback is a notable
8770 increase in code size.  This switch implies @option{-mno-push-args}.
8772 @item -mthreads
8773 @opindex mthreads
8774 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8775 on thread-safe exception handling must compile and link all code with the
8776 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8777 @option{-D_MT}; when linking, it links in a special thread helper library
8778 @option{-lmingwthrd} which cleans up per thread exception handling data.
8780 @item -mno-align-stringops
8781 @opindex mno-align-stringops
8782 Do not align destination of inlined string operations.  This switch reduces
8783 code size and improves performance in case the destination is already aligned,
8784 but gcc don't know about it.
8786 @item -minline-all-stringops
8787 @opindex minline-all-stringops
8788 By default GCC inlines string operations only when destination is known to be
8789 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8790 size, but may improve performance of code that depends on fast memcpy, strlen
8791 and memset for short lengths.
8793 @item -momit-leaf-frame-pointer
8794 @opindex momit-leaf-frame-pointer
8795 Don't keep the frame pointer in a register for leaf functions.  This
8796 avoids the instructions to save, set up and restore frame pointers and
8797 makes an extra register available in leaf functions.  The option
8798 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8799 which might make debugging harder.
8801 @item -mtls-direct-seg-refs
8802 @itemx -mno-tls-direct-seg-refs
8803 @opindex mtls-direct-seg-refs
8804 Controls whether TLS variables may be accessed with offsets from the
8805 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8806 or whether the thread base pointer must be added.  Whether or not this
8807 is legal depends on the operating system, and whether it maps the
8808 segment to cover the entire TLS area.
8810 For systems that use GNU libc, the default is on.
8811 @end table
8813 These @samp{-m} switches are supported in addition to the above
8814 on AMD x86-64 processors in 64-bit environments.
8816 @table @gcctabopt
8817 @item -m32
8818 @itemx -m64
8819 @opindex m32
8820 @opindex m64
8821 Generate code for a 32-bit or 64-bit environment.
8822 The 32-bit environment sets int, long and pointer to 32 bits and
8823 generates code that runs on any i386 system.
8824 The 64-bit environment sets int to 32 bits and long and pointer
8825 to 64 bits and generates code for AMD's x86-64 architecture.
8827 @item -mno-red-zone
8828 @opindex no-red-zone
8829 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8830 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8831 stack pointer that will not be modified by signal or interrupt handlers
8832 and therefore can be used for temporary data without adjusting the stack
8833 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8835 @item -mcmodel=small
8836 @opindex mcmodel=small
8837 Generate code for the small code model: the program and its symbols must
8838 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8839 Programs can be statically or dynamically linked.  This is the default
8840 code model.
8842 @item -mcmodel=kernel
8843 @opindex mcmodel=kernel
8844 Generate code for the kernel code model.  The kernel runs in the
8845 negative 2 GB of the address space.
8846 This model has to be used for Linux kernel code.
8848 @item -mcmodel=medium
8849 @opindex mcmodel=medium
8850 Generate code for the medium model: The program is linked in the lower 2
8851 GB of the address space but symbols can be located anywhere in the
8852 address space.  Programs can be statically or dynamically linked, but
8853 building of shared libraries are not supported with the medium model.
8855 @item -mcmodel=large
8856 @opindex mcmodel=large
8857 Generate code for the large model: This model makes no assumptions
8858 about addresses and sizes of sections.  Currently GCC does not implement
8859 this model.
8860 @end table
8862 @node HPPA Options
8863 @subsection HPPA Options
8864 @cindex HPPA Options
8866 These @samp{-m} options are defined for the HPPA family of computers:
8868 @table @gcctabopt
8869 @item -march=@var{architecture-type}
8870 @opindex march
8871 Generate code for the specified architecture.  The choices for
8872 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8873 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8874 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8875 architecture option for your machine.  Code compiled for lower numbered
8876 architectures will run on higher numbered architectures, but not the
8877 other way around.
8879 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8880 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8881 support.
8883 @item -mpa-risc-1-0
8884 @itemx -mpa-risc-1-1
8885 @itemx -mpa-risc-2-0
8886 @opindex mpa-risc-1-0
8887 @opindex mpa-risc-1-1
8888 @opindex mpa-risc-2-0
8889 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8891 @item -mbig-switch
8892 @opindex mbig-switch
8893 Generate code suitable for big switch tables.  Use this option only if
8894 the assembler/linker complain about out of range branches within a switch
8895 table.
8897 @item -mjump-in-delay
8898 @opindex mjump-in-delay
8899 Fill delay slots of function calls with unconditional jump instructions
8900 by modifying the return pointer for the function call to be the target
8901 of the conditional jump.
8903 @item -mdisable-fpregs
8904 @opindex mdisable-fpregs
8905 Prevent floating point registers from being used in any manner.  This is
8906 necessary for compiling kernels which perform lazy context switching of
8907 floating point registers.  If you use this option and attempt to perform
8908 floating point operations, the compiler will abort.
8910 @item -mdisable-indexing
8911 @opindex mdisable-indexing
8912 Prevent the compiler from using indexing address modes.  This avoids some
8913 rather obscure problems when compiling MIG generated code under MACH@.
8915 @item -mno-space-regs
8916 @opindex mno-space-regs
8917 Generate code that assumes the target has no space registers.  This allows
8918 GCC to generate faster indirect calls and use unscaled index address modes.
8920 Such code is suitable for level 0 PA systems and kernels.
8922 @item -mfast-indirect-calls
8923 @opindex mfast-indirect-calls
8924 Generate code that assumes calls never cross space boundaries.  This
8925 allows GCC to emit code which performs faster indirect calls.
8927 This option will not work in the presence of shared libraries or nested
8928 functions.
8930 @item -mlong-load-store
8931 @opindex mlong-load-store
8932 Generate 3-instruction load and store sequences as sometimes required by
8933 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8934 the HP compilers.
8936 @item -mportable-runtime
8937 @opindex mportable-runtime
8938 Use the portable calling conventions proposed by HP for ELF systems.
8940 @item -mgas
8941 @opindex mgas
8942 Enable the use of assembler directives only GAS understands.
8944 @item -mschedule=@var{cpu-type}
8945 @opindex mschedule
8946 Schedule code according to the constraints for the machine type
8947 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8948 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8949 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8950 proper scheduling option for your machine.  The default scheduling is
8951 @samp{8000}.
8953 @item -mlinker-opt
8954 @opindex mlinker-opt
8955 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8956 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8957 linkers in which they give bogus error messages when linking some programs.
8959 @item -msoft-float
8960 @opindex msoft-float
8961 Generate output containing library calls for floating point.
8962 @strong{Warning:} the requisite libraries are not available for all HPPA
8963 targets.  Normally the facilities of the machine's usual C compiler are
8964 used, but this cannot be done directly in cross-compilation.  You must make
8965 your own arrangements to provide suitable library functions for
8966 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8967 does provide software floating point support.
8969 @option{-msoft-float} changes the calling convention in the output file;
8970 therefore, it is only useful if you compile @emph{all} of a program with
8971 this option.  In particular, you need to compile @file{libgcc.a}, the
8972 library that comes with GCC, with @option{-msoft-float} in order for
8973 this to work.
8975 @item -msio
8976 @opindex msio
8977 Generate the predefine, @code{_SIO}, for server IO.  The default is
8978 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8979 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8980 options are available under HP-UX and HI-UX.
8982 @item -mgnu-ld
8983 @opindex gnu-ld
8984 Use GNU ld specific options.  This passes @option{-shared} to ld when
8985 building a shared library.  It is the default when GCC is configured,
8986 explicitly or implicitly, with the GNU linker.  This option does not
8987 have any affect on which ld is called, it only changes what parameters
8988 are passed to that ld.  The ld that is called is determined by the
8989 @option{--with-ld} configure option, gcc's program search path, and
8990 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8991 using @samp{which `gcc -print-prog-name=ld`}.
8993 @item -mhp-ld
8994 @opindex hp-ld
8995 Use HP ld specific options.  This passes @option{-b} to ld when building
8996 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8997 links.  It is the default when GCC is configured, explicitly or
8998 implicitly, with the HP linker.  This option does not have any affect on
8999 which ld is called, it only changes what parameters are passed to that
9000 ld.  The ld that is called is determined by the @option{--with-ld}
9001 configure option, gcc's program search path, and finally by the user's
9002 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9003 `gcc -print-prog-name=ld`}.
9005 @item -mlong-calls
9006 @opindex mno-long-calls
9007 Generate code that uses long call sequences.  This ensures that a call
9008 is always able to reach linker generated stubs.  The default is to generate
9009 long calls only when the distance from the call site to the beginning
9010 of the function or translation unit, as the case may be, exceeds a
9011 predefined limit set by the branch type being used.  The limits for
9012 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9013 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9014 240,000 bytes.
9016 Distances are measured from the beginning of functions when using the
9017 @option{-ffunction-sections} option, or when using the @option{-mgas}
9018 and @option{-mno-portable-runtime} options together under HP-UX with
9019 the SOM linker.
9021 It is normally not desirable to use this option as it will degrade
9022 performance.  However, it may be useful in large applications,
9023 particularly when partial linking is used to build the application.
9025 The types of long calls used depends on the capabilities of the
9026 assembler and linker, and the type of code being generated.  The
9027 impact on systems that support long absolute calls, and long pic
9028 symbol-difference or pc-relative calls should be relatively small.
9029 However, an indirect call is used on 32-bit ELF systems in pic code
9030 and it is quite long.
9032 @item -nolibdld
9033 @opindex nolibdld
9034 Suppress the generation of link options to search libdld.sl when the
9035 @option{-static} option is specified on HP-UX 10 and later.
9037 @item -static
9038 @opindex static
9039 The HP-UX implementation of setlocale in libc has a dependency on
9040 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9041 when the @option{-static} option is specified, special link options
9042 are needed to resolve this dependency.
9044 On HP-UX 10 and later, the GCC driver adds the necessary options to
9045 link with libdld.sl when the @option{-static} option is specified.
9046 This causes the resulting binary to be dynamic.  On the 64-bit port,
9047 the linkers generate dynamic binaries by default in any case.  The
9048 @option{-nolibdld} option can be used to prevent the GCC driver from
9049 adding these link options.
9051 @item -threads
9052 @opindex threads
9053 Add support for multithreading with the @dfn{dce thread} library
9054 under HP-UX.  This option sets flags for both the preprocessor and
9055 linker.
9056 @end table
9058 @node Intel 960 Options
9059 @subsection Intel 960 Options
9061 These @samp{-m} options are defined for the Intel 960 implementations:
9063 @table @gcctabopt
9064 @item -m@var{cpu-type}
9065 @opindex mka
9066 @opindex mkb
9067 @opindex mmc
9068 @opindex mca
9069 @opindex mcf
9070 @opindex msa
9071 @opindex msb
9072 Assume the defaults for the machine type @var{cpu-type} for some of
9073 the other options, including instruction scheduling, floating point
9074 support, and addressing modes.  The choices for @var{cpu-type} are
9075 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
9076 @samp{sa}, and @samp{sb}.
9077 The default is
9078 @samp{kb}.
9080 @item -mnumerics
9081 @itemx -msoft-float
9082 @opindex mnumerics
9083 @opindex msoft-float
9084 The @option{-mnumerics} option indicates that the processor does support
9085 floating-point instructions.  The @option{-msoft-float} option indicates
9086 that floating-point support should not be assumed.
9088 @item -mleaf-procedures
9089 @itemx -mno-leaf-procedures
9090 @opindex mleaf-procedures
9091 @opindex mno-leaf-procedures
9092 Do (or do not) attempt to alter leaf procedures to be callable with the
9093 @code{bal} instruction as well as @code{call}.  This will result in more
9094 efficient code for explicit calls when the @code{bal} instruction can be
9095 substituted by the assembler or linker, but less efficient code in other
9096 cases, such as calls via function pointers, or using a linker that doesn't
9097 support this optimization.
9099 @item -mtail-call
9100 @itemx -mno-tail-call
9101 @opindex mtail-call
9102 @opindex mno-tail-call
9103 Do (or do not) make additional attempts (beyond those of the
9104 machine-independent portions of the compiler) to optimize tail-recursive
9105 calls into branches.  You may not want to do this because the detection of
9106 cases where this is not valid is not totally complete.  The default is
9107 @option{-mno-tail-call}.
9109 @item -mcomplex-addr
9110 @itemx -mno-complex-addr
9111 @opindex mcomplex-addr
9112 @opindex mno-complex-addr
9113 Assume (or do not assume) that the use of a complex addressing mode is a
9114 win on this implementation of the i960.  Complex addressing modes may not
9115 be worthwhile on the K-series, but they definitely are on the C-series.
9116 The default is currently @option{-mcomplex-addr} for all processors except
9117 the CB and CC@.
9119 @item -mcode-align
9120 @itemx -mno-code-align
9121 @opindex mcode-align
9122 @opindex mno-code-align
9123 Align code to 8-byte boundaries for faster fetching (or don't bother).
9124 Currently turned on by default for C-series implementations only.
9126 @ignore
9127 @item -mclean-linkage
9128 @itemx -mno-clean-linkage
9129 @opindex mclean-linkage
9130 @opindex mno-clean-linkage
9131 These options are not fully implemented.
9132 @end ignore
9134 @item -mic-compat
9135 @itemx -mic2.0-compat
9136 @itemx -mic3.0-compat
9137 @opindex mic-compat
9138 @opindex mic2.0-compat
9139 @opindex mic3.0-compat
9140 Enable compatibility with iC960 v2.0 or v3.0.
9142 @item -masm-compat
9143 @itemx -mintel-asm
9144 @opindex masm-compat
9145 @opindex mintel-asm
9146 Enable compatibility with the iC960 assembler.
9148 @item -mstrict-align
9149 @itemx -mno-strict-align
9150 @opindex mstrict-align
9151 @opindex mno-strict-align
9152 Do not permit (do permit) unaligned accesses.
9154 @item -mold-align
9155 @opindex mold-align
9156 Enable structure-alignment compatibility with Intel's gcc release version
9157 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
9159 @item -mlong-double-64
9160 @opindex mlong-double-64
9161 Implement type @samp{long double} as 64-bit floating point numbers.
9162 Without the option @samp{long double} is implemented by 80-bit
9163 floating point numbers.  The only reason we have it because there is
9164 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
9165 is only useful for people using soft-float targets.  Otherwise, we
9166 should recommend against use of it.
9168 @end table
9170 @node DEC Alpha Options
9171 @subsection DEC Alpha Options
9173 These @samp{-m} options are defined for the DEC Alpha implementations:
9175 @table @gcctabopt
9176 @item -mno-soft-float
9177 @itemx -msoft-float
9178 @opindex mno-soft-float
9179 @opindex msoft-float
9180 Use (do not use) the hardware floating-point instructions for
9181 floating-point operations.  When @option{-msoft-float} is specified,
9182 functions in @file{libgcc.a} will be used to perform floating-point
9183 operations.  Unless they are replaced by routines that emulate the
9184 floating-point operations, or compiled in such a way as to call such
9185 emulations routines, these routines will issue floating-point
9186 operations.   If you are compiling for an Alpha without floating-point
9187 operations, you must ensure that the library is built so as not to call
9188 them.
9190 Note that Alpha implementations without floating-point operations are
9191 required to have floating-point registers.
9193 @item -mfp-reg
9194 @itemx -mno-fp-regs
9195 @opindex mfp-reg
9196 @opindex mno-fp-regs
9197 Generate code that uses (does not use) the floating-point register set.
9198 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9199 register set is not used, floating point operands are passed in integer
9200 registers as if they were integers and floating-point results are passed
9201 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9202 so any function with a floating-point argument or return value called by code
9203 compiled with @option{-mno-fp-regs} must also be compiled with that
9204 option.
9206 A typical use of this option is building a kernel that does not use,
9207 and hence need not save and restore, any floating-point registers.
9209 @item -mieee
9210 @opindex mieee
9211 The Alpha architecture implements floating-point hardware optimized for
9212 maximum performance.  It is mostly compliant with the IEEE floating
9213 point standard.  However, for full compliance, software assistance is
9214 required.  This option generates code fully IEEE compliant code
9215 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9216 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9217 defined during compilation.  The resulting code is less efficient but is
9218 able to correctly support denormalized numbers and exceptional IEEE
9219 values such as not-a-number and plus/minus infinity.  Other Alpha
9220 compilers call this option @option{-ieee_with_no_inexact}.
9222 @item -mieee-with-inexact
9223 @opindex mieee-with-inexact
9224 This is like @option{-mieee} except the generated code also maintains
9225 the IEEE @var{inexact-flag}.  Turning on this option causes the
9226 generated code to implement fully-compliant IEEE math.  In addition to
9227 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9228 macro.  On some Alpha implementations the resulting code may execute
9229 significantly slower than the code generated by default.  Since there is
9230 very little code that depends on the @var{inexact-flag}, you should
9231 normally not specify this option.  Other Alpha compilers call this
9232 option @option{-ieee_with_inexact}.
9234 @item -mfp-trap-mode=@var{trap-mode}
9235 @opindex mfp-trap-mode
9236 This option controls what floating-point related traps are enabled.
9237 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9238 The trap mode can be set to one of four values:
9240 @table @samp
9241 @item n
9242 This is the default (normal) setting.  The only traps that are enabled
9243 are the ones that cannot be disabled in software (e.g., division by zero
9244 trap).
9246 @item u
9247 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9248 as well.
9250 @item su
9251 Like @samp{su}, but the instructions are marked to be safe for software
9252 completion (see Alpha architecture manual for details).
9254 @item sui
9255 Like @samp{su}, but inexact traps are enabled as well.
9256 @end table
9258 @item -mfp-rounding-mode=@var{rounding-mode}
9259 @opindex mfp-rounding-mode
9260 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9261 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9264 @table @samp
9265 @item n
9266 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9267 the nearest machine number or towards the even machine number in case
9268 of a tie.
9270 @item m
9271 Round towards minus infinity.
9273 @item c
9274 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9276 @item d
9277 Dynamic rounding mode.  A field in the floating point control register
9278 (@var{fpcr}, see Alpha architecture reference manual) controls the
9279 rounding mode in effect.  The C library initializes this register for
9280 rounding towards plus infinity.  Thus, unless your program modifies the
9281 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9282 @end table
9284 @item -mtrap-precision=@var{trap-precision}
9285 @opindex mtrap-precision
9286 In the Alpha architecture, floating point traps are imprecise.  This
9287 means without software assistance it is impossible to recover from a
9288 floating trap and program execution normally needs to be terminated.
9289 GCC can generate code that can assist operating system trap handlers
9290 in determining the exact location that caused a floating point trap.
9291 Depending on the requirements of an application, different levels of
9292 precisions can be selected:
9294 @table @samp
9295 @item p
9296 Program precision.  This option is the default and means a trap handler
9297 can only identify which program caused a floating point exception.
9299 @item f
9300 Function precision.  The trap handler can determine the function that
9301 caused a floating point exception.
9303 @item i
9304 Instruction precision.  The trap handler can determine the exact
9305 instruction that caused a floating point exception.
9306 @end table
9308 Other Alpha compilers provide the equivalent options called
9309 @option{-scope_safe} and @option{-resumption_safe}.
9311 @item -mieee-conformant
9312 @opindex mieee-conformant
9313 This option marks the generated code as IEEE conformant.  You must not
9314 use this option unless you also specify @option{-mtrap-precision=i} and either
9315 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9316 is to emit the line @samp{.eflag 48} in the function prologue of the
9317 generated assembly file.  Under DEC Unix, this has the effect that
9318 IEEE-conformant math library routines will be linked in.
9320 @item -mbuild-constants
9321 @opindex mbuild-constants
9322 Normally GCC examines a 32- or 64-bit integer constant to
9323 see if it can construct it from smaller constants in two or three
9324 instructions.  If it cannot, it will output the constant as a literal and
9325 generate code to load it from the data segment at runtime.
9327 Use this option to require GCC to construct @emph{all} integer constants
9328 using code, even if it takes more instructions (the maximum is six).
9330 You would typically use this option to build a shared library dynamic
9331 loader.  Itself a shared library, it must relocate itself in memory
9332 before it can find the variables and constants in its own data segment.
9334 @item -malpha-as
9335 @itemx -mgas
9336 @opindex malpha-as
9337 @opindex mgas
9338 Select whether to generate code to be assembled by the vendor-supplied
9339 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9341 @item -mbwx
9342 @itemx -mno-bwx
9343 @itemx -mcix
9344 @itemx -mno-cix
9345 @itemx -mfix
9346 @itemx -mno-fix
9347 @itemx -mmax
9348 @itemx -mno-max
9349 @opindex mbwx
9350 @opindex mno-bwx
9351 @opindex mcix
9352 @opindex mno-cix
9353 @opindex mfix
9354 @opindex mno-fix
9355 @opindex mmax
9356 @opindex mno-max
9357 Indicate whether GCC should generate code to use the optional BWX,
9358 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9359 sets supported by the CPU type specified via @option{-mcpu=} option or that
9360 of the CPU on which GCC was built if none was specified.
9362 @item -mfloat-vax
9363 @itemx -mfloat-ieee
9364 @opindex mfloat-vax
9365 @opindex mfloat-ieee
9366 Generate code that uses (does not use) VAX F and G floating point
9367 arithmetic instead of IEEE single and double precision.
9369 @item -mexplicit-relocs
9370 @itemx -mno-explicit-relocs
9371 @opindex mexplicit-relocs
9372 @opindex mno-explicit-relocs
9373 Older Alpha assemblers provided no way to generate symbol relocations
9374 except via assembler macros.  Use of these macros does not allow
9375 optimal instruction scheduling.  GNU binutils as of version 2.12
9376 supports a new syntax that allows the compiler to explicitly mark
9377 which relocations should apply to which instructions.  This option
9378 is mostly useful for debugging, as GCC detects the capabilities of
9379 the assembler when it is built and sets the default accordingly.
9381 @item -msmall-data
9382 @itemx -mlarge-data
9383 @opindex msmall-data
9384 @opindex mlarge-data
9385 When @option{-mexplicit-relocs} is in effect, static data is
9386 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9387 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9388 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9389 16-bit relocations off of the @code{$gp} register.  This limits the
9390 size of the small data area to 64KB, but allows the variables to be
9391 directly accessed via a single instruction.
9393 The default is @option{-mlarge-data}.  With this option the data area
9394 is limited to just below 2GB.  Programs that require more than 2GB of
9395 data must use @code{malloc} or @code{mmap} to allocate the data in the
9396 heap instead of in the program's data segment.
9398 When generating code for shared libraries, @option{-fpic} implies
9399 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9401 @item -msmall-text
9402 @itemx -mlarge-text
9403 @opindex msmall-text
9404 @opindex mlarge-text
9405 When @option{-msmall-text} is used, the compiler assumes that the
9406 code of the entire program (or shared library) fits in 4MB, and is
9407 thus reachable with a branch instruction.  When @option{-msmall-data}
9408 is used, the compiler can assume that all local symbols share the
9409 same @code{$gp} value, and thus reduce the number of instructions
9410 required for a function call from 4 to 1.
9412 The default is @option{-mlarge-text}.
9414 @item -mcpu=@var{cpu_type}
9415 @opindex mcpu
9416 Set the instruction set and instruction scheduling parameters for
9417 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9418 style name or the corresponding chip number.  GCC supports scheduling
9419 parameters for the EV4, EV5 and EV6 family of processors and will
9420 choose the default values for the instruction set from the processor
9421 you specify.  If you do not specify a processor type, GCC will default
9422 to the processor on which the compiler was built.
9424 Supported values for @var{cpu_type} are
9426 @table @samp
9427 @item ev4
9428 @item ev45
9429 @itemx 21064
9430 Schedules as an EV4 and has no instruction set extensions.
9432 @item ev5
9433 @itemx 21164
9434 Schedules as an EV5 and has no instruction set extensions.
9436 @item ev56
9437 @itemx 21164a
9438 Schedules as an EV5 and supports the BWX extension.
9440 @item pca56
9441 @itemx 21164pc
9442 @itemx 21164PC
9443 Schedules as an EV5 and supports the BWX and MAX extensions.
9445 @item ev6
9446 @itemx 21264
9447 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9449 @item ev67
9450 @item 21264a
9451 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9452 @end table
9454 @item -mtune=@var{cpu_type}
9455 @opindex mtune
9456 Set only the instruction scheduling parameters for machine type
9457 @var{cpu_type}.  The instruction set is not changed.
9459 @item -mmemory-latency=@var{time}
9460 @opindex mmemory-latency
9461 Sets the latency the scheduler should assume for typical memory
9462 references as seen by the application.  This number is highly
9463 dependent on the memory access patterns used by the application
9464 and the size of the external cache on the machine.
9466 Valid options for @var{time} are
9468 @table @samp
9469 @item @var{number}
9470 A decimal number representing clock cycles.
9472 @item L1
9473 @itemx L2
9474 @itemx L3
9475 @itemx main
9476 The compiler contains estimates of the number of clock cycles for
9477 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9478 (also called Dcache, Scache, and Bcache), as well as to main memory.
9479 Note that L3 is only valid for EV5.
9481 @end table
9482 @end table
9484 @node DEC Alpha/VMS Options
9485 @subsection DEC Alpha/VMS Options
9487 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9489 @table @gcctabopt
9490 @item -mvms-return-codes
9491 @opindex mvms-return-codes
9492 Return VMS condition codes from main.  The default is to return POSIX
9493 style condition (e.g.@ error) codes.
9494 @end table
9496 @node H8/300 Options
9497 @subsection H8/300 Options
9499 These @samp{-m} options are defined for the H8/300 implementations:
9501 @table @gcctabopt
9502 @item -mrelax
9503 @opindex mrelax
9504 Shorten some address references at link time, when possible; uses the
9505 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9506 ld, Using ld}, for a fuller description.
9508 @item -mh
9509 @opindex mh
9510 Generate code for the H8/300H@.
9512 @item -ms
9513 @opindex ms
9514 Generate code for the H8S@.
9516 @item -mn
9517 @opindex mn
9518 Generate code for the H8S and H8/300H in the normal mode.  This switch
9519 must be used either with -mh or -ms.
9521 @item -ms2600
9522 @opindex ms2600
9523 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9525 @item -mint32
9526 @opindex mint32
9527 Make @code{int} data 32 bits by default.
9529 @item -malign-300
9530 @opindex malign-300
9531 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9532 The default for the H8/300H and H8S is to align longs and floats on 4
9533 byte boundaries.
9534 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9535 This option has no effect on the H8/300.
9536 @end table
9538 @node SH Options
9539 @subsection SH Options
9541 These @samp{-m} options are defined for the SH implementations:
9543 @table @gcctabopt
9544 @item -m1
9545 @opindex m1
9546 Generate code for the SH1.
9548 @item -m2
9549 @opindex m2
9550 Generate code for the SH2.
9552 @item -m2e
9553 Generate code for the SH2e.
9555 @item -m3
9556 @opindex m3
9557 Generate code for the SH3.
9559 @item -m3e
9560 @opindex m3e
9561 Generate code for the SH3e.
9563 @item -m4-nofpu
9564 @opindex m4-nofpu
9565 Generate code for the SH4 without a floating-point unit.
9567 @item -m4-single-only
9568 @opindex m4-single-only
9569 Generate code for the SH4 with a floating-point unit that only
9570 supports single-precision arithmetic.
9572 @item -m4-single
9573 @opindex m4-single
9574 Generate code for the SH4 assuming the floating-point unit is in
9575 single-precision mode by default.
9577 @item -m4
9578 @opindex m4
9579 Generate code for the SH4.
9581 @item -mb
9582 @opindex mb
9583 Compile code for the processor in big endian mode.
9585 @item -ml
9586 @opindex ml
9587 Compile code for the processor in little endian mode.
9589 @item -mdalign
9590 @opindex mdalign
9591 Align doubles at 64-bit boundaries.  Note that this changes the calling
9592 conventions, and thus some functions from the standard C library will
9593 not work unless you recompile it first with @option{-mdalign}.
9595 @item -mrelax
9596 @opindex mrelax
9597 Shorten some address references at link time, when possible; uses the
9598 linker option @option{-relax}.
9600 @item -mbigtable
9601 @opindex mbigtable
9602 Use 32-bit offsets in @code{switch} tables.  The default is to use
9603 16-bit offsets.
9605 @item -mfmovd
9606 @opindex mfmovd
9607 Enable the use of the instruction @code{fmovd}.
9609 @item -mhitachi
9610 @opindex mhitachi
9611 Comply with the calling conventions defined by Renesas.
9613 @item -mnomacsave
9614 @opindex mnomacsave
9615 Mark the @code{MAC} register as call-clobbered, even if
9616 @option{-mhitachi} is given.
9618 @item -mieee
9619 @opindex mieee
9620 Increase IEEE-compliance of floating-point code.
9622 @item -misize
9623 @opindex misize
9624 Dump instruction size and location in the assembly code.
9626 @item -mpadstruct
9627 @opindex mpadstruct
9628 This option is deprecated.  It pads structures to multiple of 4 bytes,
9629 which is incompatible with the SH ABI@.
9631 @item -mspace
9632 @opindex mspace
9633 Optimize for space instead of speed.  Implied by @option{-Os}.
9635 @item -mprefergot
9636 @opindex mprefergot
9637 When generating position-independent code, emit function calls using
9638 the Global Offset Table instead of the Procedure Linkage Table.
9640 @item -musermode
9641 @opindex musermode
9642 Generate a library function call to invalidate instruction cache
9643 entries, after fixing up a trampoline.  This library function call
9644 doesn't assume it can write to the whole memory address space.  This
9645 is the default when the target is @code{sh-*-linux*}.
9646 @end table
9648 @node System V Options
9649 @subsection Options for System V
9651 These additional options are available on System V Release 4 for
9652 compatibility with other compilers on those systems:
9654 @table @gcctabopt
9655 @item -G
9656 @opindex G
9657 Create a shared object.
9658 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9660 @item -Qy
9661 @opindex Qy
9662 Identify the versions of each tool used by the compiler, in a
9663 @code{.ident} assembler directive in the output.
9665 @item -Qn
9666 @opindex Qn
9667 Refrain from adding @code{.ident} directives to the output file (this is
9668 the default).
9670 @item -YP,@var{dirs}
9671 @opindex YP
9672 Search the directories @var{dirs}, and no others, for libraries
9673 specified with @option{-l}.
9675 @item -Ym,@var{dir}
9676 @opindex Ym
9677 Look in the directory @var{dir} to find the M4 preprocessor.
9678 The assembler uses this option.
9679 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9680 @c the generic assembler that comes with Solaris takes just -Ym.
9681 @end table
9683 @node TMS320C3x/C4x Options
9684 @subsection TMS320C3x/C4x Options
9685 @cindex TMS320C3x/C4x Options
9687 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9689 @table @gcctabopt
9691 @item -mcpu=@var{cpu_type}
9692 @opindex mcpu
9693 Set the instruction set, register set, and instruction scheduling
9694 parameters for machine type @var{cpu_type}.  Supported values for
9695 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9696 @samp{c44}.  The default is @samp{c40} to generate code for the
9697 TMS320C40.
9699 @item -mbig-memory
9700 @item -mbig
9701 @itemx -msmall-memory
9702 @itemx -msmall
9703 @opindex mbig-memory
9704 @opindex mbig
9705 @opindex msmall-memory
9706 @opindex msmall
9707 Generates code for the big or small memory model.  The small memory
9708 model assumed that all data fits into one 64K word page.  At run-time
9709 the data page (DP) register must be set to point to the 64K page
9710 containing the .bss and .data program sections.  The big memory model is
9711 the default and requires reloading of the DP register for every direct
9712 memory access.
9714 @item -mbk
9715 @itemx -mno-bk
9716 @opindex mbk
9717 @opindex mno-bk
9718 Allow (disallow) allocation of general integer operands into the block
9719 count register BK@.
9721 @item -mdb
9722 @itemx -mno-db
9723 @opindex mdb
9724 @opindex mno-db
9725 Enable (disable) generation of code using decrement and branch,
9726 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9727 on the safe side, this is disabled for the C3x, since the maximum
9728 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9729 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9730 that it can utilize the decrement and branch instruction, but will give
9731 up if there is more than one memory reference in the loop.  Thus a loop
9732 where the loop counter is decremented can generate slightly more
9733 efficient code, in cases where the RPTB instruction cannot be utilized.
9735 @item -mdp-isr-reload
9736 @itemx -mparanoid
9737 @opindex mdp-isr-reload
9738 @opindex mparanoid
9739 Force the DP register to be saved on entry to an interrupt service
9740 routine (ISR), reloaded to point to the data section, and restored on
9741 exit from the ISR@.  This should not be required unless someone has
9742 violated the small memory model by modifying the DP register, say within
9743 an object library.
9745 @item -mmpyi
9746 @itemx -mno-mpyi
9747 @opindex mmpyi
9748 @opindex mno-mpyi
9749 For the C3x use the 24-bit MPYI instruction for integer multiplies
9750 instead of a library call to guarantee 32-bit results.  Note that if one
9751 of the operands is a constant, then the multiplication will be performed
9752 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9753 then squaring operations are performed inline instead of a library call.
9755 @item -mfast-fix
9756 @itemx -mno-fast-fix
9757 @opindex mfast-fix
9758 @opindex mno-fast-fix
9759 The C3x/C4x FIX instruction to convert a floating point value to an
9760 integer value chooses the nearest integer less than or equal to the
9761 floating point value rather than to the nearest integer.  Thus if the
9762 floating point number is negative, the result will be incorrectly
9763 truncated an additional code is necessary to detect and correct this
9764 case.  This option can be used to disable generation of the additional
9765 code required to correct the result.
9767 @item -mrptb
9768 @itemx -mno-rptb
9769 @opindex mrptb
9770 @opindex mno-rptb
9771 Enable (disable) generation of repeat block sequences using the RPTB
9772 instruction for zero overhead looping.  The RPTB construct is only used
9773 for innermost loops that do not call functions or jump across the loop
9774 boundaries.  There is no advantage having nested RPTB loops due to the
9775 overhead required to save and restore the RC, RS, and RE registers.
9776 This is enabled by default with @option{-O2}.
9778 @item -mrpts=@var{count}
9779 @itemx -mno-rpts
9780 @opindex mrpts
9781 @opindex mno-rpts
9782 Enable (disable) the use of the single instruction repeat instruction
9783 RPTS@.  If a repeat block contains a single instruction, and the loop
9784 count can be guaranteed to be less than the value @var{count}, GCC will
9785 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9786 then a RPTS will be emitted even if the loop count cannot be determined
9787 at compile time.  Note that the repeated instruction following RPTS does
9788 not have to be reloaded from memory each iteration, thus freeing up the
9789 CPU buses for operands.  However, since interrupts are blocked by this
9790 instruction, it is disabled by default.
9792 @item -mloop-unsigned
9793 @itemx -mno-loop-unsigned
9794 @opindex mloop-unsigned
9795 @opindex mno-loop-unsigned
9796 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9797 is @math{2^{31} + 1} since these instructions test if the iteration count is
9798 negative to terminate the loop.  If the iteration count is unsigned
9799 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9800 exceeded.  This switch allows an unsigned iteration count.
9802 @item -mti
9803 @opindex mti
9804 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9805 with.  This also enforces compatibility with the API employed by the TI
9806 C3x C compiler.  For example, long doubles are passed as structures
9807 rather than in floating point registers.
9809 @item -mregparm
9810 @itemx -mmemparm
9811 @opindex mregparm
9812 @opindex mmemparm
9813 Generate code that uses registers (stack) for passing arguments to functions.
9814 By default, arguments are passed in registers where possible rather
9815 than by pushing arguments on to the stack.
9817 @item -mparallel-insns
9818 @itemx -mno-parallel-insns
9819 @opindex mparallel-insns
9820 @opindex mno-parallel-insns
9821 Allow the generation of parallel instructions.  This is enabled by
9822 default with @option{-O2}.
9824 @item -mparallel-mpy
9825 @itemx -mno-parallel-mpy
9826 @opindex mparallel-mpy
9827 @opindex mno-parallel-mpy
9828 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9829 provided @option{-mparallel-insns} is also specified.  These instructions have
9830 tight register constraints which can pessimize the code generation
9831 of large functions.
9833 @end table
9835 @node V850 Options
9836 @subsection V850 Options
9837 @cindex V850 Options
9839 These @samp{-m} options are defined for V850 implementations:
9841 @table @gcctabopt
9842 @item -mlong-calls
9843 @itemx -mno-long-calls
9844 @opindex mlong-calls
9845 @opindex mno-long-calls
9846 Treat all calls as being far away (near).  If calls are assumed to be
9847 far away, the compiler will always load the functions address up into a
9848 register, and call indirect through the pointer.
9850 @item -mno-ep
9851 @itemx -mep
9852 @opindex mno-ep
9853 @opindex mep
9854 Do not optimize (do optimize) basic blocks that use the same index
9855 pointer 4 or more times to copy pointer into the @code{ep} register, and
9856 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9857 option is on by default if you optimize.
9859 @item -mno-prolog-function
9860 @itemx -mprolog-function
9861 @opindex mno-prolog-function
9862 @opindex mprolog-function
9863 Do not use (do use) external functions to save and restore registers
9864 at the prologue and epilogue of a function.  The external functions
9865 are slower, but use less code space if more than one function saves
9866 the same number of registers.  The @option{-mprolog-function} option
9867 is on by default if you optimize.
9869 @item -mspace
9870 @opindex mspace
9871 Try to make the code as small as possible.  At present, this just turns
9872 on the @option{-mep} and @option{-mprolog-function} options.
9874 @item -mtda=@var{n}
9875 @opindex mtda
9876 Put static or global variables whose size is @var{n} bytes or less into
9877 the tiny data area that register @code{ep} points to.  The tiny data
9878 area can hold up to 256 bytes in total (128 bytes for byte references).
9880 @item -msda=@var{n}
9881 @opindex msda
9882 Put static or global variables whose size is @var{n} bytes or less into
9883 the small data area that register @code{gp} points to.  The small data
9884 area can hold up to 64 kilobytes.
9886 @item -mzda=@var{n}
9887 @opindex mzda
9888 Put static or global variables whose size is @var{n} bytes or less into
9889 the first 32 kilobytes of memory.
9891 @item -mv850
9892 @opindex mv850
9893 Specify that the target processor is the V850.
9895 @item -mbig-switch
9896 @opindex mbig-switch
9897 Generate code suitable for big switch tables.  Use this option only if
9898 the assembler/linker complain about out of range branches within a switch
9899 table.
9901 @item -mapp-regs
9902 @opindex mapp-regs
9903 This option will cause r2 and r5 to be used in the code generated by
9904 the compiler.  This setting is the default.
9906 @item -mno-app-regs
9907 @opindex mno-app-regs
9908 This option will cause r2 and r5 to be treated as fixed registers.
9909   
9910 @item -mv850e1
9911 @opindex mv850e1
9912 Specify that the target processor is the V850E1.  The preprocessor
9913 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9914 this option is used.
9916 @item -mv850e
9917 @opindex mv850e
9918 Specify that the target processor is the V850E.  The preprocessor
9919 constant @samp{__v850e__} will be defined if this option is used.
9921 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9922 are defined then a default target processor will be chosen and the
9923 relevant @samp{__v850*__} preprocessor constant will be defined.
9925 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9926 defined, regardless of which processor variant is the target.
9928 @item -mdisable-callt
9929 @opindex mdisable-callt
9930 This option will suppress generation of the CALLT instruction for the
9931 v850e and v850e1 flavors of the v850 architecture.  The default is
9932 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9934 @end table
9936 @node ARC Options
9937 @subsection ARC Options
9938 @cindex ARC Options
9940 These options are defined for ARC implementations:
9942 @table @gcctabopt
9943 @item -EL
9944 @opindex EL
9945 Compile code for little endian mode.  This is the default.
9947 @item -EB
9948 @opindex EB
9949 Compile code for big endian mode.
9951 @item -mmangle-cpu
9952 @opindex mmangle-cpu
9953 Prepend the name of the cpu to all public symbol names.
9954 In multiple-processor systems, there are many ARC variants with different
9955 instruction and register set characteristics.  This flag prevents code
9956 compiled for one cpu to be linked with code compiled for another.
9957 No facility exists for handling variants that are ``almost identical''.
9958 This is an all or nothing option.
9960 @item -mcpu=@var{cpu}
9961 @opindex mcpu
9962 Compile code for ARC variant @var{cpu}.
9963 Which variants are supported depend on the configuration.
9964 All variants support @option{-mcpu=base}, this is the default.
9966 @item -mtext=@var{text-section}
9967 @itemx -mdata=@var{data-section}
9968 @itemx -mrodata=@var{readonly-data-section}
9969 @opindex mtext
9970 @opindex mdata
9971 @opindex mrodata
9972 Put functions, data, and readonly data in @var{text-section},
9973 @var{data-section}, and @var{readonly-data-section} respectively
9974 by default.  This can be overridden with the @code{section} attribute.
9975 @xref{Variable Attributes}.
9977 @end table
9979 @node NS32K Options
9980 @subsection NS32K Options
9981 @cindex NS32K options
9983 These are the @samp{-m} options defined for the 32000 series.  The default
9984 values for these options depends on which style of 32000 was selected when
9985 the compiler was configured; the defaults for the most common choices are
9986 given below.
9988 @table @gcctabopt
9989 @item -m32032
9990 @itemx -m32032
9991 @opindex m32032
9992 @opindex m32032
9993 Generate output for a 32032.  This is the default
9994 when the compiler is configured for 32032 and 32016 based systems.
9996 @item -m32332
9997 @itemx -m32332
9998 @opindex m32332
9999 @opindex m32332
10000 Generate output for a 32332.  This is the default
10001 when the compiler is configured for 32332-based systems.
10003 @item -m32532
10004 @itemx -m32532
10005 @opindex m32532
10006 @opindex m32532
10007 Generate output for a 32532.  This is the default
10008 when the compiler is configured for 32532-based systems.
10010 @item -m32081
10011 @opindex m32081
10012 Generate output containing 32081 instructions for floating point.
10013 This is the default for all systems.
10015 @item -m32381
10016 @opindex m32381
10017 Generate output containing 32381 instructions for floating point.  This
10018 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10019 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10021 @item -mmulti-add
10022 @opindex mmulti-add
10023 Try and generate multiply-add floating point instructions @code{polyF}
10024 and @code{dotF}.  This option is only available if the @option{-m32381}
10025 option is in effect.  Using these instructions requires changes to
10026 register allocation which generally has a negative impact on
10027 performance.  This option should only be enabled when compiling code
10028 particularly likely to make heavy use of multiply-add instructions.
10030 @item -mnomulti-add
10031 @opindex mnomulti-add
10032 Do not try and generate multiply-add floating point instructions
10033 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10035 @item -msoft-float
10036 @opindex msoft-float
10037 Generate output containing library calls for floating point.
10038 @strong{Warning:} the requisite libraries may not be available.
10040 @item -mieee-compare
10041 @itemx -mno-ieee-compare
10042 @opindex mieee-compare
10043 @opindex mno-ieee-compare
10044 Control whether or not the compiler uses IEEE floating point
10045 comparisons.  These handle correctly the case where the result of a
10046 comparison is unordered.
10047 @strong{Warning:} the requisite kernel support may not be available.
10049 @item -mnobitfield
10050 @opindex mnobitfield
10051 Do not use the bit-field instructions.  On some machines it is faster to
10052 use shifting and masking operations.  This is the default for the pc532.
10054 @item -mbitfield
10055 @opindex mbitfield
10056 Do use the bit-field instructions.  This is the default for all platforms
10057 except the pc532.
10059 @item -mrtd
10060 @opindex mrtd
10061 Use a different function-calling convention, in which functions
10062 that take a fixed number of arguments return pop their
10063 arguments on return with the @code{ret} instruction.
10065 This calling convention is incompatible with the one normally
10066 used on Unix, so you cannot use it if you need to call libraries
10067 compiled with the Unix compiler.
10069 Also, you must provide function prototypes for all functions that
10070 take variable numbers of arguments (including @code{printf});
10071 otherwise incorrect code will be generated for calls to those
10072 functions.
10074 In addition, seriously incorrect code will result if you call a
10075 function with too many arguments.  (Normally, extra arguments are
10076 harmlessly ignored.)
10078 This option takes its name from the 680x0 @code{rtd} instruction.
10081 @item -mregparam
10082 @opindex mregparam
10083 Use a different function-calling convention where the first two arguments
10084 are passed in registers.
10086 This calling convention is incompatible with the one normally
10087 used on Unix, so you cannot use it if you need to call libraries
10088 compiled with the Unix compiler.
10090 @item -mnoregparam
10091 @opindex mnoregparam
10092 Do not pass any arguments in registers.  This is the default for all
10093 targets.
10095 @item -msb
10096 @opindex msb
10097 It is OK to use the sb as an index register which is always loaded with
10098 zero.  This is the default for the pc532-netbsd target.
10100 @item -mnosb
10101 @opindex mnosb
10102 The sb register is not available for use or has not been initialized to
10103 zero by the run time system.  This is the default for all targets except
10104 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10105 @option{-fpic} is set.
10107 @item -mhimem
10108 @opindex mhimem
10109 Many ns32000 series addressing modes use displacements of up to 512MB@.
10110 If an address is above 512MB then displacements from zero can not be used.
10111 This option causes code to be generated which can be loaded above 512MB@.
10112 This may be useful for operating systems or ROM code.
10114 @item -mnohimem
10115 @opindex mnohimem
10116 Assume code will be loaded in the first 512MB of virtual address space.
10117 This is the default for all platforms.
10120 @end table
10122 @node AVR Options
10123 @subsection AVR Options
10124 @cindex AVR Options
10126 These options are defined for AVR implementations:
10128 @table @gcctabopt
10129 @item -mmcu=@var{mcu}
10130 @opindex mmcu
10131 Specify ATMEL AVR instruction set or MCU type.
10133 Instruction set avr1 is for the minimal AVR core, not supported by the C
10134 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10135 attiny11, attiny12, attiny15, attiny28).
10137 Instruction set avr2 (default) is for the classic AVR core with up to
10138 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10139 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10140 at90c8534, at90s8535).
10142 Instruction set avr3 is for the classic AVR core with up to 128K program
10143 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10145 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10146 memory space (MCU types: atmega8, atmega83, atmega85).
10148 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10149 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10150 atmega64, atmega128, at43usb355, at94k).
10152 @item -msize
10153 @opindex msize
10154 Output instruction sizes to the asm file.
10156 @item -minit-stack=@var{N}
10157 @opindex minit-stack
10158 Specify the initial stack address, which may be a symbol or numeric value,
10159 @samp{__stack} is the default.
10161 @item -mno-interrupts
10162 @opindex mno-interrupts
10163 Generated code is not compatible with hardware interrupts.
10164 Code size will be smaller.
10166 @item -mcall-prologues
10167 @opindex mcall-prologues
10168 Functions prologues/epilogues expanded as call to appropriate
10169 subroutines.  Code size will be smaller.
10171 @item -mno-tablejump
10172 @opindex mno-tablejump
10173 Do not generate tablejump insns which sometimes increase code size.
10175 @item -mtiny-stack
10176 @opindex mtiny-stack
10177 Change only the low 8 bits of the stack pointer.
10178 @end table
10180 @node MCore Options
10181 @subsection MCore Options
10182 @cindex MCore options
10184 These are the @samp{-m} options defined for the Motorola M*Core
10185 processors.
10187 @table @gcctabopt
10189 @item -mhardlit
10190 @itemx -mno-hardlit
10191 @opindex mhardlit
10192 @opindex mno-hardlit
10193 Inline constants into the code stream if it can be done in two
10194 instructions or less.
10196 @item -mdiv
10197 @itemx -mno-div
10198 @opindex mdiv
10199 @opindex mno-div
10200 Use the divide instruction.  (Enabled by default).
10202 @item -mrelax-immediate
10203 @itemx -mno-relax-immediate
10204 @opindex mrelax-immediate
10205 @opindex mno-relax-immediate
10206 Allow arbitrary sized immediates in bit operations.
10208 @item -mwide-bitfields
10209 @itemx -mno-wide-bitfields
10210 @opindex mwide-bitfields
10211 @opindex mno-wide-bitfields
10212 Always treat bit-fields as int-sized.
10214 @item -m4byte-functions
10215 @itemx -mno-4byte-functions
10216 @opindex m4byte-functions
10217 @opindex mno-4byte-functions
10218 Force all functions to be aligned to a four byte boundary.
10220 @item -mcallgraph-data
10221 @itemx -mno-callgraph-data
10222 @opindex mcallgraph-data
10223 @opindex mno-callgraph-data
10224 Emit callgraph information.
10226 @item -mslow-bytes
10227 @itemx -mno-slow-bytes
10228 @opindex mslow-bytes
10229 @opindex mno-slow-bytes
10230 Prefer word access when reading byte quantities.
10232 @item -mlittle-endian
10233 @itemx -mbig-endian
10234 @opindex mlittle-endian
10235 @opindex mbig-endian
10236 Generate code for a little endian target.
10238 @item -m210
10239 @itemx -m340
10240 @opindex m210
10241 @opindex m340
10242 Generate code for the 210 processor.
10243 @end table
10245 @node IA-64 Options
10246 @subsection IA-64 Options
10247 @cindex IA-64 Options
10249 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10251 @table @gcctabopt
10252 @item -mbig-endian
10253 @opindex mbig-endian
10254 Generate code for a big endian target.  This is the default for HP-UX@.
10256 @item -mlittle-endian
10257 @opindex mlittle-endian
10258 Generate code for a little endian target.  This is the default for AIX5
10259 and Linux.
10261 @item -mgnu-as
10262 @itemx -mno-gnu-as
10263 @opindex mgnu-as
10264 @opindex mno-gnu-as
10265 Generate (or don't) code for the GNU assembler.  This is the default.
10266 @c Also, this is the default if the configure option @option{--with-gnu-as}
10267 @c is used.
10269 @item -mgnu-ld
10270 @itemx -mno-gnu-ld
10271 @opindex mgnu-ld
10272 @opindex mno-gnu-ld
10273 Generate (or don't) code for the GNU linker.  This is the default.
10274 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10275 @c is used.
10277 @item -mno-pic
10278 @opindex mno-pic
10279 Generate code that does not use a global pointer register.  The result
10280 is not position independent code, and violates the IA-64 ABI@.
10282 @item -mvolatile-asm-stop
10283 @itemx -mno-volatile-asm-stop
10284 @opindex mvolatile-asm-stop
10285 @opindex mno-volatile-asm-stop
10286 Generate (or don't) a stop bit immediately before and after volatile asm
10287 statements.
10289 @item -mb-step
10290 @opindex mb-step
10291 Generate code that works around Itanium B step errata.
10293 @item -mregister-names
10294 @itemx -mno-register-names
10295 @opindex mregister-names
10296 @opindex mno-register-names
10297 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10298 the stacked registers.  This may make assembler output more readable.
10300 @item -mno-sdata
10301 @itemx -msdata
10302 @opindex mno-sdata
10303 @opindex msdata
10304 Disable (or enable) optimizations that use the small data section.  This may
10305 be useful for working around optimizer bugs.
10307 @item -mconstant-gp
10308 @opindex mconstant-gp
10309 Generate code that uses a single constant global pointer value.  This is
10310 useful when compiling kernel code.
10312 @item -mauto-pic
10313 @opindex mauto-pic
10314 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10315 This is useful when compiling firmware code.
10317 @item -minline-float-divide-min-latency
10318 @opindex minline-float-divide-min-latency
10319 Generate code for inline divides of floating point values
10320 using the minimum latency algorithm.
10322 @item -minline-float-divide-max-throughput
10323 @opindex minline-float-divide-max-throughput
10324 Generate code for inline divides of floating point values
10325 using the maximum throughput algorithm.
10327 @item -minline-int-divide-min-latency
10328 @opindex minline-int-divide-min-latency
10329 Generate code for inline divides of integer values
10330 using the minimum latency algorithm.
10332 @item -minline-int-divide-max-throughput
10333 @opindex minline-int-divide-max-throughput
10334 Generate code for inline divides of integer values
10335 using the maximum throughput algorithm.
10337 @item -mno-dwarf2-asm
10338 @itemx -mdwarf2-asm
10339 @opindex mno-dwarf2-asm
10340 @opindex mdwarf2-asm
10341 Don't (or do) generate assembler code for the DWARF2 line number debugging
10342 info.  This may be useful when not using the GNU assembler.
10344 @item -mfixed-range=@var{register-range}
10345 @opindex mfixed-range
10346 Generate code treating the given register range as fixed registers.
10347 A fixed register is one that the register allocator can not use.  This is
10348 useful when compiling kernel code.  A register range is specified as
10349 two registers separated by a dash.  Multiple register ranges can be
10350 specified separated by a comma.
10352 @item -mearly-stop-bits
10353 @itemx -mno-early-stop-bits
10354 @opindex mearly-stop-bits
10355 @opindex mno-early-stop-bits
10356 Allow stop bits to be placed earlier than immediately preceding the
10357 instruction that triggered the stop bit.  This can improve instruction
10358 scheduling, but does not always do so.
10359 @end table
10361 @node D30V Options
10362 @subsection D30V Options
10363 @cindex D30V Options
10365 These @samp{-m} options are defined for D30V implementations:
10367 @table @gcctabopt
10368 @item -mextmem
10369 @opindex mextmem
10370 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10371 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10372 memory, which starts at location @code{0x80000000}.
10374 @item -mextmemory
10375 @opindex mextmemory
10376 Same as the @option{-mextmem} switch.
10378 @item -monchip
10379 @opindex monchip
10380 Link the @samp{.text} section into onchip text memory, which starts at
10381 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10382 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10383 into onchip data memory, which starts at location @code{0x20000000}.
10385 @item -mno-asm-optimize
10386 @itemx -masm-optimize
10387 @opindex mno-asm-optimize
10388 @opindex masm-optimize
10389 Disable (enable) passing @option{-O} to the assembler when optimizing.
10390 The assembler uses the @option{-O} option to automatically parallelize
10391 adjacent short instructions where possible.
10393 @item -mbranch-cost=@var{n}
10394 @opindex mbranch-cost
10395 Increase the internal costs of branches to @var{n}.  Higher costs means
10396 that the compiler will issue more instructions to avoid doing a branch.
10397 The default is 2.
10399 @item -mcond-exec=@var{n}
10400 @opindex mcond-exec
10401 Specify the maximum number of conditionally executed instructions that
10402 replace a branch.  The default is 4.
10403 @end table
10405 @node S/390 and zSeries Options
10406 @subsection S/390 and zSeries Options
10407 @cindex S/390 and zSeries Options
10409 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10411 @table @gcctabopt
10412 @item -mhard-float
10413 @itemx -msoft-float
10414 @opindex mhard-float
10415 @opindex msoft-float
10416 Use (do not use) the hardware floating-point instructions and registers
10417 for floating-point operations.  When @option{-msoft-float} is specified,
10418 functions in @file{libgcc.a} will be used to perform floating-point
10419 operations.  When @option{-mhard-float} is specified, the compiler
10420 generates IEEE floating-point instructions.  This is the default.
10422 @item -mbackchain
10423 @itemx -mno-backchain
10424 @opindex mbackchain
10425 @opindex mno-backchain
10426 Generate (or do not generate) code which maintains an explicit
10427 backchain within the stack frame that points to the caller's frame.
10428 This is currently needed to allow debugging.  The default is to
10429 generate the backchain.
10431 @item -msmall-exec
10432 @itemx -mno-small-exec
10433 @opindex msmall-exec
10434 @opindex mno-small-exec
10435 Generate (or do not generate) code using the @code{bras} instruction
10436 to do subroutine calls.
10437 This only works reliably if the total executable size does not
10438 exceed 64k.  The default is to use the @code{basr} instruction instead,
10439 which does not have this limitation.
10441 @item -m64
10442 @itemx -m31
10443 @opindex m64
10444 @opindex m31
10445 When @option{-m31} is specified, generate code compliant to the
10446 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10447 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10448 particular to generate 64-bit instructions.  For the @samp{s390}
10449 targets, the default is @option{-m31}, while the @samp{s390x}
10450 targets default to @option{-m64}.
10452 @item -mzarch
10453 @itemx -mesa
10454 @opindex mzarch
10455 @opindex mesa
10456 When @option{-mzarch} is specified, generate code using the 
10457 instructions available on z/Architecture. 
10458 When @option{-mesa} is specified, generate code using the 
10459 instructions available on ESA/390. Note that @option{-mesa} is
10460 not possible with @option{-m64}.
10461 When generating code compliant to the Linux for S/390 ABI,
10462 the default is @option{-mesa}.  When generating code compliant
10463 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10465 @item -mmvcle
10466 @itemx -mno-mvcle
10467 @opindex mmvcle
10468 @opindex mno-mvcle
10469 Generate (or do not generate) code using the @code{mvcle} instruction
10470 to perform block moves.  When @option{-mno-mvcle} is specified,
10471 use a @code{mvc} loop instead.  This is the default.
10473 @item -mdebug
10474 @itemx -mno-debug
10475 @opindex mdebug
10476 @opindex mno-debug
10477 Print (or do not print) additional debug information when compiling.
10478 The default is to not print debug information.
10480 @item -march=@var{cpu-type}
10481 @opindex march
10482 Generate code that will run on @var{cpu-type}, which is the name of a system
10483 representing a certain processor type. Possible values for
10484 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10485 When generating code using the instructions available on z/Architecture,
10486 the default is @option{-march=z900}.  Otherwise, the default is
10487 @option{-march=g5}.
10489 @item -mtune=@var{cpu-type}
10490 @opindex mtune
10491 Tune to @var{cpu-type} everything applicable about the generated code,
10492 except for the ABI and the set of available instructions.
10493 The list of @var{cpu-type} values is the same as for @option{-march}.
10494 The default is the value used for @option{-march}.
10496 @item -mfused-madd
10497 @itemx -mno-fused-madd
10498 @opindex mfused-madd
10499 @opindex mno-fused-madd
10500 Generate code that uses (does not use) the floating point multiply and
10501 accumulate instructions.  These instructions are generated by default if
10502 hardware floating point is used.
10503 @end table
10505 @node CRIS Options
10506 @subsection CRIS Options
10507 @cindex CRIS Options
10509 These options are defined specifically for the CRIS ports.
10511 @table @gcctabopt
10512 @item -march=@var{architecture-type}
10513 @itemx -mcpu=@var{architecture-type}
10514 @opindex march
10515 @opindex mcpu
10516 Generate code for the specified architecture.  The choices for
10517 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10518 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10519 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10520 @samp{v10}.
10522 @item -mtune=@var{architecture-type}
10523 @opindex mtune
10524 Tune to @var{architecture-type} everything applicable about the generated
10525 code, except for the ABI and the set of available instructions.  The
10526 choices for @var{architecture-type} are the same as for
10527 @option{-march=@var{architecture-type}}.
10529 @item -mmax-stack-frame=@var{n}
10530 @opindex mmax-stack-frame
10531 Warn when the stack frame of a function exceeds @var{n} bytes.
10533 @item -melinux-stacksize=@var{n}
10534 @opindex melinux-stacksize
10535 Only available with the @samp{cris-axis-aout} target.  Arranges for
10536 indications in the program to the kernel loader that the stack of the
10537 program should be set to @var{n} bytes.
10539 @item -metrax4
10540 @itemx -metrax100
10541 @opindex metrax4
10542 @opindex metrax100
10543 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10544 @option{-march=v3} and @option{-march=v8} respectively.
10546 @item -mpdebug
10547 @opindex mpdebug
10548 Enable CRIS-specific verbose debug-related information in the assembly
10549 code.  This option also has the effect to turn off the @samp{#NO_APP}
10550 formatted-code indicator to the assembler at the beginning of the
10551 assembly file.
10553 @item -mcc-init
10554 @opindex mcc-init
10555 Do not use condition-code results from previous instruction; always emit
10556 compare and test instructions before use of condition codes.
10558 @item -mno-side-effects
10559 @opindex mno-side-effects
10560 Do not emit instructions with side-effects in addressing modes other than
10561 post-increment.
10563 @item -mstack-align
10564 @itemx -mno-stack-align
10565 @itemx -mdata-align
10566 @itemx -mno-data-align
10567 @itemx -mconst-align
10568 @itemx -mno-const-align
10569 @opindex mstack-align
10570 @opindex mno-stack-align
10571 @opindex mdata-align
10572 @opindex mno-data-align
10573 @opindex mconst-align
10574 @opindex mno-const-align
10575 These options (no-options) arranges (eliminate arrangements) for the
10576 stack-frame, individual data and constants to be aligned for the maximum
10577 single data access size for the chosen CPU model.  The default is to
10578 arrange for 32-bit alignment.  ABI details such as structure layout are
10579 not affected by these options.
10581 @item -m32-bit
10582 @itemx -m16-bit
10583 @itemx -m8-bit
10584 @opindex m32-bit
10585 @opindex m16-bit
10586 @opindex m8-bit
10587 Similar to the stack- data- and const-align options above, these options
10588 arrange for stack-frame, writable data and constants to all be 32-bit,
10589 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10591 @item -mno-prologue-epilogue
10592 @itemx -mprologue-epilogue
10593 @opindex mno-prologue-epilogue
10594 @opindex mprologue-epilogue
10595 With @option{-mno-prologue-epilogue}, the normal function prologue and
10596 epilogue that sets up the stack-frame are omitted and no return
10597 instructions or return sequences are generated in the code.  Use this
10598 option only together with visual inspection of the compiled code: no
10599 warnings or errors are generated when call-saved registers must be saved,
10600 or storage for local variable needs to be allocated.
10602 @item -mno-gotplt
10603 @itemx -mgotplt
10604 @opindex mno-gotplt
10605 @opindex mgotplt
10606 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10607 instruction sequences that load addresses for functions from the PLT part
10608 of the GOT rather than (traditional on other architectures) calls to the
10609 PLT.  The default is @option{-mgotplt}.
10611 @item -maout
10612 @opindex maout
10613 Legacy no-op option only recognized with the cris-axis-aout target.
10615 @item -melf
10616 @opindex melf
10617 Legacy no-op option only recognized with the cris-axis-elf and
10618 cris-axis-linux-gnu targets.
10620 @item -melinux
10621 @opindex melinux
10622 Only recognized with the cris-axis-aout target, where it selects a
10623 GNU/linux-like multilib, include files and instruction set for
10624 @option{-march=v8}.
10626 @item -mlinux
10627 @opindex mlinux
10628 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10630 @item -sim
10631 @opindex sim
10632 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10633 to link with input-output functions from a simulator library.  Code,
10634 initialized data and zero-initialized data are allocated consecutively.
10636 @item -sim2
10637 @opindex sim2
10638 Like @option{-sim}, but pass linker options to locate initialized data at
10639 0x40000000 and zero-initialized data at 0x80000000.
10640 @end table
10642 @node MMIX Options
10643 @subsection MMIX Options
10644 @cindex MMIX Options
10646 These options are defined for the MMIX:
10648 @table @gcctabopt
10649 @item -mlibfuncs
10650 @itemx -mno-libfuncs
10651 @opindex mlibfuncs
10652 @opindex mno-libfuncs
10653 Specify that intrinsic library functions are being compiled, passing all
10654 values in registers, no matter the size.
10656 @item -mepsilon
10657 @itemx -mno-epsilon
10658 @opindex mepsilon
10659 @opindex mno-epsilon
10660 Generate floating-point comparison instructions that compare with respect
10661 to the @code{rE} epsilon register.
10663 @item -mabi=mmixware
10664 @itemx -mabi=gnu
10665 @opindex mabi-mmixware
10666 @opindex mabi=gnu
10667 Generate code that passes function parameters and return values that (in
10668 the called function) are seen as registers @code{$0} and up, as opposed to
10669 the GNU ABI which uses global registers @code{$231} and up.
10671 @item -mzero-extend
10672 @itemx -mno-zero-extend
10673 @opindex mzero-extend
10674 @opindex mno-zero-extend
10675 When reading data from memory in sizes shorter than 64 bits, use (do not
10676 use) zero-extending load instructions by default, rather than
10677 sign-extending ones.
10679 @item -mknuthdiv
10680 @itemx -mno-knuthdiv
10681 @opindex mknuthdiv
10682 @opindex mno-knuthdiv
10683 Make the result of a division yielding a remainder have the same sign as
10684 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10685 remainder follows the sign of the dividend.  Both methods are
10686 arithmetically valid, the latter being almost exclusively used.
10688 @item -mtoplevel-symbols
10689 @itemx -mno-toplevel-symbols
10690 @opindex mtoplevel-symbols
10691 @opindex mno-toplevel-symbols
10692 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10693 code can be used with the @code{PREFIX} assembly directive.
10695 @item -melf
10696 @opindex melf
10697 Generate an executable in the ELF format, rather than the default
10698 @samp{mmo} format used by the @command{mmix} simulator.
10700 @item -mbranch-predict
10701 @itemx -mno-branch-predict
10702 @opindex mbranch-predict
10703 @opindex mno-branch-predict
10704 Use (do not use) the probable-branch instructions, when static branch
10705 prediction indicates a probable branch.
10707 @item -mbase-addresses
10708 @itemx -mno-base-addresses
10709 @opindex mbase-addresses
10710 @opindex mno-base-addresses
10711 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10712 base address automatically generates a request (handled by the assembler
10713 and the linker) for a constant to be set up in a global register.  The
10714 register is used for one or more base address requests within the range 0
10715 to 255 from the value held in the register.  The generally leads to short
10716 and fast code, but the number of different data items that can be
10717 addressed is limited.  This means that a program that uses lots of static
10718 data may require @option{-mno-base-addresses}.
10720 @item -msingle-exit
10721 @itemx -mno-single-exit
10722 @opindex msingle-exit
10723 @opindex mno-single-exit
10724 Force (do not force) generated code to have a single exit point in each
10725 function.
10726 @end table
10728 @node PDP-11 Options
10729 @subsection PDP-11 Options
10730 @cindex PDP-11 Options
10732 These options are defined for the PDP-11:
10734 @table @gcctabopt
10735 @item -mfpu
10736 @opindex mfpu
10737 Use hardware FPP floating point.  This is the default.  (FIS floating
10738 point on the PDP-11/40 is not supported.)
10740 @item -msoft-float
10741 @opindex msoft-float
10742 Do not use hardware floating point.
10744 @item -mac0
10745 @opindex mac0
10746 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10748 @item -mno-ac0
10749 @opindex mno-ac0
10750 Return floating-point results in memory.  This is the default.
10752 @item -m40
10753 @opindex m40
10754 Generate code for a PDP-11/40.
10756 @item -m45
10757 @opindex m45
10758 Generate code for a PDP-11/45.  This is the default.
10760 @item -m10
10761 @opindex m10
10762 Generate code for a PDP-11/10.
10764 @item -mbcopy-builtin
10765 @opindex bcopy-builtin
10766 Use inline @code{movstrhi} patterns for copying memory.  This is the
10767 default.
10769 @item -mbcopy
10770 @opindex mbcopy
10771 Do not use inline @code{movstrhi} patterns for copying memory.
10773 @item -mint16
10774 @itemx -mno-int32
10775 @opindex mint16
10776 @opindex mno-int32
10777 Use 16-bit @code{int}.  This is the default.
10779 @item -mint32
10780 @itemx -mno-int16
10781 @opindex mint32
10782 @opindex mno-int16
10783 Use 32-bit @code{int}.
10785 @item -mfloat64
10786 @itemx -mno-float32
10787 @opindex mfloat64
10788 @opindex mno-float32
10789 Use 64-bit @code{float}.  This is the default.
10791 @item -mfloat32
10792 @item -mno-float64
10793 @opindex mfloat32
10794 @opindex mno-float64
10795 Use 32-bit @code{float}.
10797 @item -mabshi
10798 @opindex mabshi
10799 Use @code{abshi2} pattern.  This is the default.
10801 @item -mno-abshi
10802 @opindex mno-abshi
10803 Do not use @code{abshi2} pattern.
10805 @item -mbranch-expensive
10806 @opindex mbranch-expensive
10807 Pretend that branches are expensive.  This is for experimenting with
10808 code generation only.
10810 @item -mbranch-cheap
10811 @opindex mbranch-cheap
10812 Do not pretend that branches are expensive.  This is the default.
10814 @item -msplit
10815 @opindex msplit
10816 Generate code for a system with split I&D.
10818 @item -mno-split
10819 @opindex mno-split
10820 Generate code for a system without split I&D.  This is the default.
10822 @item -munix-asm
10823 @opindex munix-asm
10824 Use Unix assembler syntax.  This is the default when configured for
10825 @samp{pdp11-*-bsd}.
10827 @item -mdec-asm
10828 @opindex mdec-asm
10829 Use DEC assembler syntax.  This is the default when configured for any
10830 PDP-11 target other than @samp{pdp11-*-bsd}.
10831 @end table
10833 @node Xstormy16 Options
10834 @subsection Xstormy16 Options
10835 @cindex Xstormy16 Options
10837 These options are defined for Xstormy16:
10839 @table @gcctabopt
10840 @item -msim
10841 @opindex msim
10842 Choose startup files and linker script suitable for the simulator.
10843 @end table
10845 @node FRV Options
10846 @subsection FRV Options
10847 @cindex FRV Options
10849 @table @gcctabopt
10850 @item -mgpr-32
10851 @opindex mgpr-32
10853 Only use the first 32 general purpose registers.
10855 @item -mgpr-64
10856 @opindex mgpr-64
10858 Use all 64 general purpose registers.
10860 @item -mfpr-32
10861 @opindex mfpr-32
10863 Use only the first 32 floating point registers.
10865 @item -mfpr-64
10866 @opindex mfpr-64
10868 Use all 64 floating point registers
10870 @item -mhard-float
10871 @opindex mhard-float
10873 Use hardware instructions for floating point operations.
10875 @item -msoft-float
10876 @opindex msoft-float
10878 Use library routines for floating point operations.
10880 @item -malloc-cc
10881 @opindex malloc-cc
10883 Dynamically allocate condition code registers.
10885 @item -mfixed-cc
10886 @opindex mfixed-cc
10888 Do not try to dynamically allocate condition code registers, only
10889 use @code{icc0} and @code{fcc0}.
10891 @item -mdword
10892 @opindex mdword
10894 Change ABI to use double word insns.
10896 @item -mno-dword
10897 @opindex mno-dword
10899 Do not use double word instructions.
10901 @item -mdouble
10902 @opindex mdouble
10904 Use floating point double instructions.
10906 @item -mno-double
10907 @opindex mno-double
10909 Do not use floating point double instructions.
10911 @item -mmedia
10912 @opindex mmedia
10914 Use media instructions.
10916 @item -mno-media
10917 @opindex mno-media
10919 Do not use media instructions.
10921 @item -mmuladd
10922 @opindex mmuladd
10924 Use multiply and add/subtract instructions.
10926 @item -mno-muladd
10927 @opindex mno-muladd
10929 Do not use multiply and add/subtract instructions.
10931 @item -mlibrary-pic
10932 @opindex mlibrary-pic
10934 Enable PIC support for building libraries
10936 @item -macc-4
10937 @opindex macc-4
10939 Use only the first four media accumulator registers.
10941 @item -macc-8
10942 @opindex macc-8
10944 Use all eight media accumulator registers.
10946 @item -mpack
10947 @opindex mpack
10949 Pack VLIW instructions.
10951 @item -mno-pack
10952 @opindex mno-pack
10954 Do not pack VLIW instructions.
10956 @item -mno-eflags
10957 @opindex mno-eflags
10959 Do not mark ABI switches in e_flags.
10961 @item -mcond-move
10962 @opindex mcond-move
10964 Enable the use of conditional-move instructions (default).
10966 This switch is mainly for debugging the compiler and will likely be removed
10967 in a future version.
10969 @item -mno-cond-move
10970 @opindex mno-cond-move
10972 Disable the use of conditional-move instructions.
10974 This switch is mainly for debugging the compiler and will likely be removed
10975 in a future version.
10977 @item -mscc
10978 @opindex mscc
10980 Enable the use of conditional set instructions (default).
10982 This switch is mainly for debugging the compiler and will likely be removed
10983 in a future version.
10985 @item -mno-scc
10986 @opindex mno-scc
10988 Disable the use of conditional set instructions.
10990 This switch is mainly for debugging the compiler and will likely be removed
10991 in a future version.
10993 @item -mcond-exec
10994 @opindex mcond-exec
10996 Enable the use of conditional execution (default).
10998 This switch is mainly for debugging the compiler and will likely be removed
10999 in a future version.
11001 @item -mno-cond-exec
11002 @opindex mno-cond-exec
11004 Disable the use of conditional execution.
11006 This switch is mainly for debugging the compiler and will likely be removed
11007 in a future version.
11009 @item -mvliw-branch
11010 @opindex mvliw-branch
11012 Run a pass to pack branches into VLIW instructions (default).
11014 This switch is mainly for debugging the compiler and will likely be removed
11015 in a future version.
11017 @item -mno-vliw-branch
11018 @opindex mno-vliw-branch
11020 Do not run a pass to pack branches into VLIW instructions.
11022 This switch is mainly for debugging the compiler and will likely be removed
11023 in a future version.
11025 @item -mmulti-cond-exec
11026 @opindex mmulti-cond-exec
11028 Enable optimization of @code{&&} and @code{||} in conditional execution
11029 (default).
11031 This switch is mainly for debugging the compiler and will likely be removed
11032 in a future version.
11034 @item -mno-multi-cond-exec
11035 @opindex mno-multi-cond-exec
11037 Disable optimization of @code{&&} and @code{||} in conditional execution.
11039 This switch is mainly for debugging the compiler and will likely be removed
11040 in a future version.
11042 @item -mnested-cond-exec
11043 @opindex mnested-cond-exec
11045 Enable nested conditional execution optimizations (default).
11047 This switch is mainly for debugging the compiler and will likely be removed
11048 in a future version.
11050 @item -mno-nested-cond-exec
11051 @opindex mno-nested-cond-exec
11053 Disable nested conditional execution optimizations.
11055 This switch is mainly for debugging the compiler and will likely be removed
11056 in a future version.
11058 @item -mtomcat-stats
11059 @opindex mtomcat-stats
11061 Cause gas to print out tomcat statistics.
11063 @item -mcpu=@var{cpu}
11064 @opindex mcpu
11066 Select the processor type for which to generate code.  Possible values are
11067 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
11068 @samp{frv}.
11070 @end table
11072 @node Xtensa Options
11073 @subsection Xtensa Options
11074 @cindex Xtensa Options
11076 These options are supported for Xtensa targets:
11078 @table @gcctabopt
11079 @item -mconst16
11080 @itemx -mno-const16
11081 @opindex mconst16
11082 @opindex mno-const16
11083 Enable or disable use of @code{CONST16} instructions for loading
11084 constant values.  The @code{CONST16} instruction is currently not a
11085 standard option from Tensilica.  When enabled, @code{CONST16}
11086 instructions are always used in place of the standard @code{L32R}
11087 instructions.  The use of @code{CONST16} is enabled by default only if
11088 the @code{L32R} instruction is not available.
11090 @item -mfused-madd
11091 @itemx -mno-fused-madd
11092 @opindex mfused-madd
11093 @opindex mno-fused-madd
11094 Enable or disable use of fused multiply/add and multiply/subtract
11095 instructions in the floating-point option.  This has no effect if the
11096 floating-point option is not also enabled.  Disabling fused multiply/add
11097 and multiply/subtract instructions forces the compiler to use separate
11098 instructions for the multiply and add/subtract operations.  This may be
11099 desirable in some cases where strict IEEE 754-compliant results are
11100 required: the fused multiply add/subtract instructions do not round the
11101 intermediate result, thereby producing results with @emph{more} bits of
11102 precision than specified by the IEEE standard.  Disabling fused multiply
11103 add/subtract instructions also ensures that the program output is not
11104 sensitive to the compiler's ability to combine multiply and add/subtract
11105 operations.
11107 @item -mtext-section-literals
11108 @itemx -mno-text-section-literals
11109 @opindex mtext-section-literals
11110 @opindex mno-text-section-literals
11111 Control the treatment of literal pools.  The default is
11112 @option{-mno-text-section-literals}, which places literals in a separate
11113 section in the output file.  This allows the literal pool to be placed
11114 in a data RAM/ROM, and it also allows the linker to combine literal
11115 pools from separate object files to remove redundant literals and
11116 improve code size.  With @option{-mtext-section-literals}, the literals
11117 are interspersed in the text section in order to keep them as close as
11118 possible to their references.  This may be necessary for large assembly
11119 files.
11121 @item -mtarget-align
11122 @itemx -mno-target-align
11123 @opindex mtarget-align
11124 @opindex mno-target-align
11125 When this option is enabled, GCC instructs the assembler to
11126 automatically align instructions to reduce branch penalties at the
11127 expense of some code density.  The assembler attempts to widen density
11128 instructions to align branch targets and the instructions following call
11129 instructions.  If there are not enough preceding safe density
11130 instructions to align a target, no widening will be performed.  The
11131 default is @option{-mtarget-align}.  These options do not affect the
11132 treatment of auto-aligned instructions like @code{LOOP}, which the
11133 assembler will always align, either by widening density instructions or
11134 by inserting no-op instructions.
11136 @item -mlongcalls
11137 @itemx -mno-longcalls
11138 @opindex mlongcalls
11139 @opindex mno-longcalls
11140 When this option is enabled, GCC instructs the assembler to translate
11141 direct calls to indirect calls unless it can determine that the target
11142 of a direct call is in the range allowed by the call instruction.  This
11143 translation typically occurs for calls to functions in other source
11144 files.  Specifically, the assembler translates a direct @code{CALL}
11145 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11146 The default is @option{-mno-longcalls}.  This option should be used in
11147 programs where the call target can potentially be out of range.  This
11148 option is implemented in the assembler, not the compiler, so the
11149 assembly code generated by GCC will still show direct call
11150 instructions---look at the disassembled object code to see the actual
11151 instructions.  Note that the assembler will use an indirect call for
11152 every cross-file call, not just those that really will be out of range.
11153 @end table
11155 @node Code Gen Options
11156 @section Options for Code Generation Conventions
11157 @cindex code generation conventions
11158 @cindex options, code generation
11159 @cindex run-time options
11161 These machine-independent options control the interface conventions
11162 used in code generation.
11164 Most of them have both positive and negative forms; the negative form
11165 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11166 one of the forms is listed---the one which is not the default.  You
11167 can figure out the other form by either removing @samp{no-} or adding
11170 @table @gcctabopt
11171 @item -fbounds-check
11172 @opindex fbounds-check
11173 For front-ends that support it, generate additional code to check that
11174 indices used to access arrays are within the declared range.  This is
11175 currently only supported by the Java and Fortran 77 front-ends, where
11176 this option defaults to true and false respectively.
11178 @item -ftrapv
11179 @opindex ftrapv
11180 This option generates traps for signed overflow on addition, subtraction,
11181 multiplication operations.
11183 @item -fwrapv
11184 @opindex fwrapv
11185 This option instructs the compiler to assume that signed arithmetic
11186 overflow of addition, subtraction and multiplication wraps around
11187 using twos-complement representation.  This flag enables some optimizations
11188 and disables other.  This option is enabled by default for the Java
11189 front-end, as required by the Java language specification.
11191 @item -fexceptions
11192 @opindex fexceptions
11193 Enable exception handling.  Generates extra code needed to propagate
11194 exceptions.  For some targets, this implies GCC will generate frame
11195 unwind information for all functions, which can produce significant data
11196 size overhead, although it does not affect execution.  If you do not
11197 specify this option, GCC will enable it by default for languages like
11198 C++ which normally require exception handling, and disable it for
11199 languages like C that do not normally require it.  However, you may need
11200 to enable this option when compiling C code that needs to interoperate
11201 properly with exception handlers written in C++.  You may also wish to
11202 disable this option if you are compiling older C++ programs that don't
11203 use exception handling.
11205 @item -fnon-call-exceptions
11206 @opindex fnon-call-exceptions
11207 Generate code that allows trapping instructions to throw exceptions.
11208 Note that this requires platform-specific runtime support that does
11209 not exist everywhere.  Moreover, it only allows @emph{trapping}
11210 instructions to throw exceptions, i.e.@: memory references or floating
11211 point instructions.  It does not allow exceptions to be thrown from
11212 arbitrary signal handlers such as @code{SIGALRM}.
11214 @item -funwind-tables
11215 @opindex funwind-tables
11216 Similar to @option{-fexceptions}, except that it will just generate any needed
11217 static data, but will not affect the generated code in any other way.
11218 You will normally not enable this option; instead, a language processor
11219 that needs this handling would enable it on your behalf.
11221 @item -fasynchronous-unwind-tables
11222 @opindex funwind-tables
11223 Generate unwind table in dwarf2 format, if supported by target machine.  The
11224 table is exact at each instruction boundary, so it can be used for stack
11225 unwinding from asynchronous events (such as debugger or garbage collector).
11227 @item -fpcc-struct-return
11228 @opindex fpcc-struct-return
11229 Return ``short'' @code{struct} and @code{union} values in memory like
11230 longer ones, rather than in registers.  This convention is less
11231 efficient, but it has the advantage of allowing intercallability between
11232 GCC-compiled files and files compiled with other compilers, particularly
11233 the Portable C Compiler (pcc).
11235 The precise convention for returning structures in memory depends
11236 on the target configuration macros.
11238 Short structures and unions are those whose size and alignment match
11239 that of some integer type.
11241 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11242 switch is not binary compatible with code compiled with the
11243 @option{-freg-struct-return} switch.
11244 Use it to conform to a non-default application binary interface.
11246 @item -freg-struct-return
11247 @opindex freg-struct-return
11248 Return @code{struct} and @code{union} values in registers when possible.
11249 This is more efficient for small structures than
11250 @option{-fpcc-struct-return}.
11252 If you specify neither @option{-fpcc-struct-return} nor
11253 @option{-freg-struct-return}, GCC defaults to whichever convention is
11254 standard for the target.  If there is no standard convention, GCC
11255 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11256 the principal compiler.  In those cases, we can choose the standard, and
11257 we chose the more efficient register return alternative.
11259 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11260 switch is not binary compatible with code compiled with the
11261 @option{-fpcc-struct-return} switch.
11262 Use it to conform to a non-default application binary interface.
11264 @item -fshort-enums
11265 @opindex fshort-enums
11266 Allocate to an @code{enum} type only as many bytes as it needs for the
11267 declared range of possible values.  Specifically, the @code{enum} type
11268 will be equivalent to the smallest integer type which has enough room.
11270 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11271 code that is not binary compatible with code generated without that switch.
11272 Use it to conform to a non-default application binary interface.
11274 @item -fshort-double
11275 @opindex fshort-double
11276 Use the same size for @code{double} as for @code{float}.
11278 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11279 code that is not binary compatible with code generated without that switch.
11280 Use it to conform to a non-default application binary interface.
11282 @item -fshort-wchar
11283 @opindex fshort-wchar
11284 Override the underlying type for @samp{wchar_t} to be @samp{short
11285 unsigned int} instead of the default for the target.  This option is
11286 useful for building programs to run under WINE@.
11288 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11289 code that is not binary compatible with code generated without that switch.
11290 Use it to conform to a non-default application binary interface.
11292 @item -fshared-data
11293 @opindex fshared-data
11294 Requests that the data and non-@code{const} variables of this
11295 compilation be shared data rather than private data.  The distinction
11296 makes sense only on certain operating systems, where shared data is
11297 shared between processes running the same program, while private data
11298 exists in one copy per process.
11300 @item -fno-common
11301 @opindex fno-common
11302 In C, allocate even uninitialized global variables in the data section of the
11303 object file, rather than generating them as common blocks.  This has the
11304 effect that if the same variable is declared (without @code{extern}) in
11305 two different compilations, you will get an error when you link them.
11306 The only reason this might be useful is if you wish to verify that the
11307 program will work on other systems which always work this way.
11309 @item -fno-ident
11310 @opindex fno-ident
11311 Ignore the @samp{#ident} directive.
11313 @item -fno-gnu-linker
11314 @opindex fno-gnu-linker
11315 Do not output global initializations (such as C++ constructors and
11316 destructors) in the form used by the GNU linker (on systems where the GNU
11317 linker is the standard method of handling them).  Use this option when
11318 you want to use a non-GNU linker, which also requires using the
11319 @command{collect2} program to make sure the system linker includes
11320 constructors and destructors.  (@command{collect2} is included in the GCC
11321 distribution.)  For systems which @emph{must} use @command{collect2}, the
11322 compiler driver @command{gcc} is configured to do this automatically.
11324 @item -finhibit-size-directive
11325 @opindex finhibit-size-directive
11326 Don't output a @code{.size} assembler directive, or anything else that
11327 would cause trouble if the function is split in the middle, and the
11328 two halves are placed at locations far apart in memory.  This option is
11329 used when compiling @file{crtstuff.c}; you should not need to use it
11330 for anything else.
11332 @item -fverbose-asm
11333 @opindex fverbose-asm
11334 Put extra commentary information in the generated assembly code to
11335 make it more readable.  This option is generally only of use to those
11336 who actually need to read the generated assembly code (perhaps while
11337 debugging the compiler itself).
11339 @option{-fno-verbose-asm}, the default, causes the
11340 extra information to be omitted and is useful when comparing two assembler
11341 files.
11343 @item -fpic
11344 @opindex fpic
11345 @cindex global offset table
11346 @cindex PIC
11347 Generate position-independent code (PIC) suitable for use in a shared
11348 library, if supported for the target machine.  Such code accesses all
11349 constant addresses through a global offset table (GOT)@.  The dynamic
11350 loader resolves the GOT entries when the program starts (the dynamic
11351 loader is not part of GCC; it is part of the operating system).  If
11352 the GOT size for the linked executable exceeds a machine-specific
11353 maximum size, you get an error message from the linker indicating that
11354 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11355 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11356 on the m68k and RS/6000.  The 386 has no such limit.)
11358 Position-independent code requires special support, and therefore works
11359 only on certain machines.  For the 386, GCC supports PIC for System V
11360 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11361 position-independent.
11363 @item -fPIC
11364 @opindex fPIC
11365 If supported for the target machine, emit position-independent code,
11366 suitable for dynamic linking and avoiding any limit on the size of the
11367 global offset table.  This option makes a difference on the m68k, m88k,
11368 and the SPARC.
11370 Position-independent code requires special support, and therefore works
11371 only on certain machines.
11373 @item -fpie
11374 @itemx -fPIE
11375 @opindex fpie
11376 @opindex fPIE
11377 These options are similar to @option{-fpic} and @option{-fPIC}, but
11378 generated position independent code can be only linked into executables.
11379 Usually these options are used when @option{-pie} GCC option will be
11380 used during linking.
11382 @item -ffixed-@var{reg}
11383 @opindex ffixed
11384 Treat the register named @var{reg} as a fixed register; generated code
11385 should never refer to it (except perhaps as a stack pointer, frame
11386 pointer or in some other fixed role).
11388 @var{reg} must be the name of a register.  The register names accepted
11389 are machine-specific and are defined in the @code{REGISTER_NAMES}
11390 macro in the machine description macro file.
11392 This flag does not have a negative form, because it specifies a
11393 three-way choice.
11395 @item -fcall-used-@var{reg}
11396 @opindex fcall-used
11397 Treat the register named @var{reg} as an allocable register that is
11398 clobbered by function calls.  It may be allocated for temporaries or
11399 variables that do not live across a call.  Functions compiled this way
11400 will not save and restore the register @var{reg}.
11402 It is an error to used this flag with the frame pointer or stack pointer.
11403 Use of this flag for other registers that have fixed pervasive roles in
11404 the machine's execution model will produce disastrous results.
11406 This flag does not have a negative form, because it specifies a
11407 three-way choice.
11409 @item -fcall-saved-@var{reg}
11410 @opindex fcall-saved
11411 Treat the register named @var{reg} as an allocable register saved by
11412 functions.  It may be allocated even for temporaries or variables that
11413 live across a call.  Functions compiled this way will save and restore
11414 the register @var{reg} if they use it.
11416 It is an error to used this flag with the frame pointer or stack pointer.
11417 Use of this flag for other registers that have fixed pervasive roles in
11418 the machine's execution model will produce disastrous results.
11420 A different sort of disaster will result from the use of this flag for
11421 a register in which function values may be returned.
11423 This flag does not have a negative form, because it specifies a
11424 three-way choice.
11426 @item -fpack-struct
11427 @opindex fpack-struct
11428 Pack all structure members together without holes.
11430 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11431 code that is not binary compatible with code generated without that switch.
11432 Additionally, it makes the code suboptimal.
11433 Use it to conform to a non-default application binary interface.
11435 @item -finstrument-functions
11436 @opindex finstrument-functions
11437 Generate instrumentation calls for entry and exit to functions.  Just
11438 after function entry and just before function exit, the following
11439 profiling functions will be called with the address of the current
11440 function and its call site.  (On some platforms,
11441 @code{__builtin_return_address} does not work beyond the current
11442 function, so the call site information may not be available to the
11443 profiling functions otherwise.)
11445 @example
11446 void __cyg_profile_func_enter (void *this_fn,
11447                                void *call_site);
11448 void __cyg_profile_func_exit  (void *this_fn,
11449                                void *call_site);
11450 @end example
11452 The first argument is the address of the start of the current function,
11453 which may be looked up exactly in the symbol table.
11455 This instrumentation is also done for functions expanded inline in other
11456 functions.  The profiling calls will indicate where, conceptually, the
11457 inline function is entered and exited.  This means that addressable
11458 versions of such functions must be available.  If all your uses of a
11459 function are expanded inline, this may mean an additional expansion of
11460 code size.  If you use @samp{extern inline} in your C code, an
11461 addressable version of such functions must be provided.  (This is
11462 normally the case anyways, but if you get lucky and the optimizer always
11463 expands the functions inline, you might have gotten away without
11464 providing static copies.)
11466 A function may be given the attribute @code{no_instrument_function}, in
11467 which case this instrumentation will not be done.  This can be used, for
11468 example, for the profiling functions listed above, high-priority
11469 interrupt routines, and any functions from which the profiling functions
11470 cannot safely be called (perhaps signal handlers, if the profiling
11471 routines generate output or allocate memory).
11473 @item -fstack-check
11474 @opindex fstack-check
11475 Generate code to verify that you do not go beyond the boundary of the
11476 stack.  You should specify this flag if you are running in an
11477 environment with multiple threads, but only rarely need to specify it in
11478 a single-threaded environment since stack overflow is automatically
11479 detected on nearly all systems if there is only one stack.
11481 Note that this switch does not actually cause checking to be done; the
11482 operating system must do that.  The switch causes generation of code
11483 to ensure that the operating system sees the stack being extended.
11485 @item -fstack-limit-register=@var{reg}
11486 @itemx -fstack-limit-symbol=@var{sym}
11487 @itemx -fno-stack-limit
11488 @opindex fstack-limit-register
11489 @opindex fstack-limit-symbol
11490 @opindex fno-stack-limit
11491 Generate code to ensure that the stack does not grow beyond a certain value,
11492 either the value of a register or the address of a symbol.  If the stack
11493 would grow beyond the value, a signal is raised.  For most targets,
11494 the signal is raised before the stack overruns the boundary, so
11495 it is possible to catch the signal without taking special precautions.
11497 For instance, if the stack starts at absolute address @samp{0x80000000}
11498 and grows downwards, you can use the flags
11499 @option{-fstack-limit-symbol=__stack_limit} and
11500 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11501 of 128KB@.  Note that this may only work with the GNU linker.
11503 @cindex aliasing of parameters
11504 @cindex parameters, aliased
11505 @item -fargument-alias
11506 @itemx -fargument-noalias
11507 @itemx -fargument-noalias-global
11508 @opindex fargument-alias
11509 @opindex fargument-noalias
11510 @opindex fargument-noalias-global
11511 Specify the possible relationships among parameters and between
11512 parameters and global data.
11514 @option{-fargument-alias} specifies that arguments (parameters) may
11515 alias each other and may alias global storage.@*
11516 @option{-fargument-noalias} specifies that arguments do not alias
11517 each other, but may alias global storage.@*
11518 @option{-fargument-noalias-global} specifies that arguments do not
11519 alias each other and do not alias global storage.
11521 Each language will automatically use whatever option is required by
11522 the language standard.  You should not need to use these options yourself.
11524 @item -fleading-underscore
11525 @opindex fleading-underscore
11526 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11527 change the way C symbols are represented in the object file.  One use
11528 is to help link with legacy assembly code.
11530 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11531 generate code that is not binary compatible with code generated without that
11532 switch.  Use it to conform to a non-default application binary interface.
11533 Not all targets provide complete support for this switch.
11535 @item -ftls-model=@var{model}
11536 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11537 The @var{model} argument should be one of @code{global-dynamic},
11538 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11540 The default without @option{-fpic} is @code{initial-exec}; with
11541 @option{-fpic} the default is @code{global-dynamic}.
11542 @end table
11544 @c man end
11546 @node Environment Variables
11547 @section Environment Variables Affecting GCC
11548 @cindex environment variables
11550 @c man begin ENVIRONMENT
11551 This section describes several environment variables that affect how GCC
11552 operates.  Some of them work by specifying directories or prefixes to use
11553 when searching for various kinds of files.  Some are used to specify other
11554 aspects of the compilation environment.
11556 Note that you can also specify places to search using options such as
11557 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11558 take precedence over places specified using environment variables, which
11559 in turn take precedence over those specified by the configuration of GCC@.
11560 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11561 GNU Compiler Collection (GCC) Internals}.
11563 @table @env
11564 @item LANG
11565 @itemx LC_CTYPE
11566 @c @itemx LC_COLLATE
11567 @itemx LC_MESSAGES
11568 @c @itemx LC_MONETARY
11569 @c @itemx LC_NUMERIC
11570 @c @itemx LC_TIME
11571 @itemx LC_ALL
11572 @findex LANG
11573 @findex LC_CTYPE
11574 @c @findex LC_COLLATE
11575 @findex LC_MESSAGES
11576 @c @findex LC_MONETARY
11577 @c @findex LC_NUMERIC
11578 @c @findex LC_TIME
11579 @findex LC_ALL
11580 @cindex locale
11581 These environment variables control the way that GCC uses
11582 localization information that allow GCC to work with different
11583 national conventions.  GCC inspects the locale categories
11584 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11585 so.  These locale categories can be set to any value supported by your
11586 installation.  A typical value is @samp{en_UK} for English in the United
11587 Kingdom.
11589 The @env{LC_CTYPE} environment variable specifies character
11590 classification.  GCC uses it to determine the character boundaries in
11591 a string; this is needed for some multibyte encodings that contain quote
11592 and escape characters that would otherwise be interpreted as a string
11593 end or escape.
11595 The @env{LC_MESSAGES} environment variable specifies the language to
11596 use in diagnostic messages.
11598 If the @env{LC_ALL} environment variable is set, it overrides the value
11599 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11600 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11601 environment variable.  If none of these variables are set, GCC
11602 defaults to traditional C English behavior.
11604 @item TMPDIR
11605 @findex TMPDIR
11606 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11607 files.  GCC uses temporary files to hold the output of one stage of
11608 compilation which is to be used as input to the next stage: for example,
11609 the output of the preprocessor, which is the input to the compiler
11610 proper.
11612 @item GCC_EXEC_PREFIX
11613 @findex GCC_EXEC_PREFIX
11614 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11615 names of the subprograms executed by the compiler.  No slash is added
11616 when this prefix is combined with the name of a subprogram, but you can
11617 specify a prefix that ends with a slash if you wish.
11619 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11620 an appropriate prefix to use based on the pathname it was invoked with.
11622 If GCC cannot find the subprogram using the specified prefix, it
11623 tries looking in the usual places for the subprogram.
11625 The default value of @env{GCC_EXEC_PREFIX} is
11626 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11627 of @code{prefix} when you ran the @file{configure} script.
11629 Other prefixes specified with @option{-B} take precedence over this prefix.
11631 This prefix is also used for finding files such as @file{crt0.o} that are
11632 used for linking.
11634 In addition, the prefix is used in an unusual way in finding the
11635 directories to search for header files.  For each of the standard
11636 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11637 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11638 replacing that beginning with the specified prefix to produce an
11639 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11640 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11641 These alternate directories are searched first; the standard directories
11642 come next.
11644 @item COMPILER_PATH
11645 @findex COMPILER_PATH
11646 The value of @env{COMPILER_PATH} is a colon-separated list of
11647 directories, much like @env{PATH}.  GCC tries the directories thus
11648 specified when searching for subprograms, if it can't find the
11649 subprograms using @env{GCC_EXEC_PREFIX}.
11651 @item LIBRARY_PATH
11652 @findex LIBRARY_PATH
11653 The value of @env{LIBRARY_PATH} is a colon-separated list of
11654 directories, much like @env{PATH}.  When configured as a native compiler,
11655 GCC tries the directories thus specified when searching for special
11656 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11657 using GCC also uses these directories when searching for ordinary
11658 libraries for the @option{-l} option (but directories specified with
11659 @option{-L} come first).
11661 @item LANG
11662 @findex LANG
11663 @cindex locale definition
11664 This variable is used to pass locale information to the compiler.  One way in
11665 which this information is used is to determine the character set to be used
11666 when character literals, string literals and comments are parsed in C and C++.
11667 When the compiler is configured to allow multibyte characters,
11668 the following values for @env{LANG} are recognized:
11670 @table @samp
11671 @item C-JIS
11672 Recognize JIS characters.
11673 @item C-SJIS
11674 Recognize SJIS characters.
11675 @item C-EUCJP
11676 Recognize EUCJP characters.
11677 @end table
11679 If @env{LANG} is not defined, or if it has some other value, then the
11680 compiler will use mblen and mbtowc as defined by the default locale to
11681 recognize and translate multibyte characters.
11682 @end table
11684 @noindent
11685 Some additional environments variables affect the behavior of the
11686 preprocessor.
11688 @include cppenv.texi
11690 @c man end
11692 @node Precompiled Headers
11693 @section Using Precompiled Headers
11694 @cindex precompiled headers
11695 @cindex speed of compilation
11697 Often large projects have many header files that are included in every
11698 source file.  The time the compiler takes to process these header files
11699 over and over again can account for nearly all of the time required to
11700 build the project.  To make builds faster, GCC allows users to
11701 `precompile' a header file; then, if builds can use the precompiled
11702 header file they will be much faster.
11704 To create a precompiled header file, simply compile it as you would any
11705 other file, if necessary using the @option{-x} option to make the driver
11706 treat it as a C or C++ header file.  You will probably want to use a
11707 tool like @command{make} to keep the precompiled header up-to-date when
11708 the headers it contains change.
11710 A precompiled header file will be searched for when @code{#include} is
11711 seen in the compilation.  As it searches for the included file
11712 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11713 compiler looks for a precompiled header in each directory just before it
11714 looks for the include file in that directory.  The name searched for is
11715 the name specified in the @code{#include} with @samp{.gch} appended.  If
11716 the precompiled header file can't be used, it is ignored.
11718 For instance, if you have @code{#include "all.h"}, and you have
11719 @file{all.h.gch} in the same directory as @file{all.h}, then the
11720 precompiled header file will be used if possible, and the original
11721 header will be used otherwise.
11723 Alternatively, you might decide to put the precompiled header file in a
11724 directory and use @option{-I} to ensure that directory is searched
11725 before (or instead of) the directory containing the original header.
11726 Then, if you want to check that the precompiled header file is always
11727 used, you can put a file of the same name as the original header in this
11728 directory containing an @code{#error} command.
11730 This also works with @option{-include}.  So yet another way to use
11731 precompiled headers, good for projects not designed with precompiled
11732 header files in mind, is to simply take most of the header files used by
11733 a project, include them from another header file, precompile that header
11734 file, and @option{-include} the precompiled header.  If the header files
11735 have guards against multiple inclusion, they will be skipped because
11736 they've already been included (in the precompiled header).
11738 If you need to precompile the same header file for different
11739 languages, targets, or compiler options, you can instead make a
11740 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11741 header in the directory.  (It doesn't matter what you call the files
11742 in the directory, every precompiled header in the directory will be
11743 considered.)  The first precompiled header encountered in the
11744 directory that is valid for this compilation will be used; they're
11745 searched in no particular order.
11747 There are many other possibilities, limited only by your imagination,
11748 good sense, and the constraints of your build system.
11750 A precompiled header file can be used only when these conditions apply:
11752 @itemize
11753 @item
11754 Only one precompiled header can be used in a particular compilation.
11755 @item
11756 A precompiled header can't be used once the first C token is seen.  You
11757 can have preprocessor directives before a precompiled header; you can
11758 even include a precompiled header from inside another header, so long as
11759 there are no C tokens before the @code{#include}.
11760 @item
11761 The precompiled header file must be produced for the same language as
11762 the current compilation.  You can't use a C precompiled header for a C++
11763 compilation.
11764 @item
11765 The precompiled header file must be produced by the same compiler
11766 version and configuration as the current compilation is using.
11767 The easiest way to guarantee this is to use the same compiler binary
11768 for creating and using precompiled headers.
11769 @item
11770 Any macros defined before the precompiled header (including with
11771 @option{-D}) must either be defined in the same way as when the
11772 precompiled header was generated, or must not affect the precompiled
11773 header, which usually means that the they don't appear in the
11774 precompiled header at all.
11775 @item
11776 Certain command-line options must be defined in the same way as when the
11777 precompiled header was generated.  At present, it's not clear which
11778 options are safe to change and which are not; the safest choice is to
11779 use exactly the same options when generating and using the precompiled
11780 header.
11781 @end itemize
11783 For all of these but the last, the compiler will automatically ignore
11784 the precompiled header if the conditions aren't met.  For the last item,
11785 some option changes will cause the precompiled header to be rejected,
11786 but not all incompatible option combinations have yet been found.  If
11787 you find a new incompatible combination, please consider filing a bug
11788 report, see @ref{Bugs}.
11790 @node Running Protoize
11791 @section Running Protoize
11793 The program @code{protoize} is an optional part of GCC@.  You can use
11794 it to add prototypes to a program, thus converting the program to ISO
11795 C in one respect.  The companion program @code{unprotoize} does the
11796 reverse: it removes argument types from any prototypes that are found.
11798 When you run these programs, you must specify a set of source files as
11799 command line arguments.  The conversion programs start out by compiling
11800 these files to see what functions they define.  The information gathered
11801 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11803 After scanning comes actual conversion.  The specified files are all
11804 eligible to be converted; any files they include (whether sources or
11805 just headers) are eligible as well.
11807 But not all the eligible files are converted.  By default,
11808 @code{protoize} and @code{unprotoize} convert only source and header
11809 files in the current directory.  You can specify additional directories
11810 whose files should be converted with the @option{-d @var{directory}}
11811 option.  You can also specify particular files to exclude with the
11812 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11813 directory name matches one of the specified directory names, and its
11814 name within the directory has not been excluded.
11816 Basic conversion with @code{protoize} consists of rewriting most
11817 function definitions and function declarations to specify the types of
11818 the arguments.  The only ones not rewritten are those for varargs
11819 functions.
11821 @code{protoize} optionally inserts prototype declarations at the
11822 beginning of the source file, to make them available for any calls that
11823 precede the function's definition.  Or it can insert prototype
11824 declarations with block scope in the blocks where undeclared functions
11825 are called.
11827 Basic conversion with @code{unprotoize} consists of rewriting most
11828 function declarations to remove any argument types, and rewriting
11829 function definitions to the old-style pre-ISO form.
11831 Both conversion programs print a warning for any function declaration or
11832 definition that they can't convert.  You can suppress these warnings
11833 with @option{-q}.
11835 The output from @code{protoize} or @code{unprotoize} replaces the
11836 original source file.  The original file is renamed to a name ending
11837 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11838 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11839 for DOS) file already exists, then the source file is simply discarded.
11841 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11842 scan the program and collect information about the functions it uses.
11843 So neither of these programs will work until GCC is installed.
11845 Here is a table of the options you can use with @code{protoize} and
11846 @code{unprotoize}.  Each option works with both programs unless
11847 otherwise stated.
11849 @table @code
11850 @item -B @var{directory}
11851 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11852 usual directory (normally @file{/usr/local/lib}).  This file contains
11853 prototype information about standard system functions.  This option
11854 applies only to @code{protoize}.
11856 @item -c @var{compilation-options}
11857 Use @var{compilation-options} as the options when running @command{gcc} to
11858 produce the @samp{.X} files.  The special option @option{-aux-info} is
11859 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11861 Note that the compilation options must be given as a single argument to
11862 @code{protoize} or @code{unprotoize}.  If you want to specify several
11863 @command{gcc} options, you must quote the entire set of compilation options
11864 to make them a single word in the shell.
11866 There are certain @command{gcc} arguments that you cannot use, because they
11867 would produce the wrong kind of output.  These include @option{-g},
11868 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11869 the @var{compilation-options}, they are ignored.
11871 @item -C
11872 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11873 systems) instead of @samp{.c}.  This is convenient if you are converting
11874 a C program to C++.  This option applies only to @code{protoize}.
11876 @item -g
11877 Add explicit global declarations.  This means inserting explicit
11878 declarations at the beginning of each source file for each function
11879 that is called in the file and was not declared.  These declarations
11880 precede the first function definition that contains a call to an
11881 undeclared function.  This option applies only to @code{protoize}.
11883 @item -i @var{string}
11884 Indent old-style parameter declarations with the string @var{string}.
11885 This option applies only to @code{protoize}.
11887 @code{unprotoize} converts prototyped function definitions to old-style
11888 function definitions, where the arguments are declared between the
11889 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11890 uses five spaces as the indentation.  If you want to indent with just
11891 one space instead, use @option{-i " "}.
11893 @item -k
11894 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11895 is finished.
11897 @item -l
11898 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11899 a prototype declaration for each function in each block which calls the
11900 function without any declaration.  This option applies only to
11901 @code{protoize}.
11903 @item -n
11904 Make no real changes.  This mode just prints information about the conversions
11905 that would have been done without @option{-n}.
11907 @item -N
11908 Make no @samp{.save} files.  The original files are simply deleted.
11909 Use this option with caution.
11911 @item -p @var{program}
11912 Use the program @var{program} as the compiler.  Normally, the name
11913 @file{gcc} is used.
11915 @item -q
11916 Work quietly.  Most warnings are suppressed.
11918 @item -v
11919 Print the version number, just like @option{-v} for @command{gcc}.
11920 @end table
11922 If you need special compiler options to compile one of your program's
11923 source files, then you should generate that file's @samp{.X} file
11924 specially, by running @command{gcc} on that source file with the
11925 appropriate options and the option @option{-aux-info}.  Then run
11926 @code{protoize} on the entire set of files.  @code{protoize} will use
11927 the existing @samp{.X} file because it is newer than the source file.
11928 For example:
11930 @example
11931 gcc -Dfoo=bar file1.c -aux-info file1.X
11932 protoize *.c
11933 @end example
11935 @noindent
11936 You need to include the special files along with the rest in the
11937 @code{protoize} command, even though their @samp{.X} files already
11938 exist, because otherwise they won't get converted.
11940 @xref{Protoize Caveats}, for more information on how to use
11941 @code{protoize} successfully.