OSDN Git Service

* doc/invoke.texi: Remove traces of dead ports.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
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, 2004 Free Software Foundation, Inc.
10
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.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
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{}
40
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
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
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.
74
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.
79
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.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
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}}.
97
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.
104
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.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
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
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
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}
160
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}
171
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 @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo  -Wsynth}
192
193 @item Objective-C Language Options
194 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
195 @gccoptlist{
196 -fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime @gol
198 -fno-nil-receivers @gol
199 -fobjc-exceptions @gol
200 -freplace-objc-classes @gol
201 -fzero-link @gol
202 -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
204
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{-fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
213 -w  -Wextra  -Wall  -Waggregate-return @gol
214 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
215 -Wconversion  -Wno-deprecated-declarations @gol
216 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
217 -Werror  -Werror-implicit-function-declaration @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wno-format-extra-args -Wformat-nonliteral @gol
220 -Wformat-security  -Wformat-y2k @gol
221 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
222 -Wimport  -Wno-import  -Winit-self  -Winline @gol
223 -Wno-invalid-offsetof  -Winvalid-pch @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
228 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
229 -Wreturn-type  -Wsequence-point  -Wshadow @gol
230 -Wsign-compare  -Wstrict-aliasing @gol
231 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
232 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings}
236
237 @item C-only Warning Options
238 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
239 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
240 -Wstrict-prototypes  -Wtraditional @gol
241 -Wdeclaration-after-statement}
242
243 @item Debugging Options
244 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
245 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
246 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
249 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
251 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
252 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
253 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report @gol
255 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
265 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
266 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
267 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
268 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
269 -fdelayed-branch  -fdelete-null-pointer-checks @gol
270 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
271 -fforce-addr  -fforce-mem  -ffunction-sections @gol
272 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -floop-optimize @gol
273 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
274 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
275 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
276 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
277 -fno-default-inline  -fno-defer-pop @gol
278 -fno-function-cse  -fno-guess-branch-probability @gol
279 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
280 -funsafe-math-optimizations  -ffinite-math-only @gol
281 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
282 -fomit-frame-pointer  -foptimize-register-move @gol
283 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
284 -fprofile-generate -fprofile-use @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  @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}
300
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}}
315
316 @item Assembler Option
317 @xref{Assembler Options,,Passing Options to the Assembler}.
318 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
319
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}}
327
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}}
331
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}}
336
337 @item Machine Dependent Options
338 @xref{Submodel Options,,Hardware Models and Configurations}.
339
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}
346
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}}
351
352 @emph{VAX Options}
353 @gccoptlist{-mg  -mgnu  -munix}
354
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}
368
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}
392
393 @emph{MN10300 Options}
394 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
395 -mam33  -mno-am33 @gol
396 -mam33-2  -mno-am33-2 @gol
397 -mno-crt0  -mrelax}
398
399 @emph{M32R/D Options}
400 @gccoptlist{-m32r2 -m32rx -m32r @gol
401 -mdebug @gol
402 -malign-loops -mno-align-loops @gol
403 -missue-rate=@var{number} @gol
404 -mbranch-cost=@var{number} @gol
405 -mmodel=@var{code-size-model-type} @gol
406 -msdata=@var{sdata-type} @gol
407 -mno-flush-func -mflush-func=@var{name} @gol
408 -mno-flush-trap -mflush-trap=@var{number} @gol
409 -G @var{num}}
410
411 @emph{RS/6000 and PowerPC Options}
412 @gccoptlist{-mcpu=@var{cpu-type} @gol
413 -mtune=@var{cpu-type} @gol
414 -mpower  -mno-power  -mpower2  -mno-power2 @gol
415 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
416 -maltivec  -mno-altivec @gol
417 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
418 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
419 -mnew-mnemonics  -mold-mnemonics @gol
420 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
421 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
422 -malign-power  -malign-natural @gol
423 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
424 -mstring  -mno-string  -mupdate  -mno-update @gol
425 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
426 -mstrict-align  -mno-strict-align  -mrelocatable @gol
427 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
428 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
429 -mdynamic-no-pic @gol
430 -mprioritize-restricted-insns=@var{priority} @gol
431 -msched-costly-dep=@var{dependence_type} @gol
432 -minsert-sched-nops=@var{scheme} @gol
433 -mcall-sysv  -mcall-netbsd @gol
434 -maix-struct-return  -msvr4-struct-return @gol
435 -mabi=altivec  -mabi=no-altivec @gol
436 -mabi=spe  -mabi=no-spe @gol
437 -misel=yes  -misel=no @gol
438 -mspe=yes  -mspe=no @gol
439 -mfloat-gprs=yes  -mfloat-gprs=no @gol
440 -mprototype  -mno-prototype @gol
441 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
442 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
443
444 @emph{Darwin Options}
445 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
446 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
447 -client_name  -compatibility_version  -current_version @gol
448 -dependency-file  -dylib_file  -dylinker_install_name @gol
449 -dynamic  -dynamiclib  -exported_symbols_list @gol
450 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
451 -force_flat_namespace  -headerpad_max_install_names @gol
452 -image_base  -init  -install_name  -keep_private_externs @gol
453 -multi_module  -multiply_defined  -multiply_defined_unused @gol
454 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
455 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
456 -private_bundle  -read_only_relocs  -sectalign @gol
457 -sectobjectsymbols  -whyload  -seg1addr @gol
458 -sectcreate  -sectobjectsymbols  -sectorder @gol
459 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
460 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
461 -single_module  -static  -sub_library  -sub_umbrella @gol
462 -twolevel_namespace  -umbrella  -undefined @gol
463 -unexported_symbols_list  -weak_reference_mismatches @gol
464 -whatsloaded}
465
466 @emph{MIPS Options}
467 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
468 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
469 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
470 -mxgot  -mno-xgot  -membedded-pic  -mno-embedded-pic @gol
471 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
472 -msingle-float  -mdouble-float  -mint64  -mlong64  -mlong32 @gol
473 -G@var{num}  -membedded-data  -mno-embedded-data @gol
474 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
475 -msplit-addresses  -mno-split-addresses  @gol
476 -mexplicit-relocs  -mno-explicit-relocs  @gol
477 -mrnames  -mno-rnames @gol
478 -mcheck-zero-division  -mno-check-zero-division @gol
479 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
480 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
481 -mfix-sb1  -mno-fix-sb1  -mflush-func=@var{func} @gol
482 -mno-flush-func  -mbranch-likely  -mno-branch-likely}
483
484 @emph{i386 and x86-64 Options}
485 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
486 -mfpmath=@var{unit} @gol
487 -masm=@var{dialect}  -mno-fancy-math-387 @gol
488 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
489 -mno-wide-multiply  -mrtd  -malign-double @gol
490 -mpreferred-stack-boundary=@var{num} @gol
491 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
492 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
493 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
494 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
495 -mno-red-zone -mno-tls-direct-seg-refs @gol
496 -mcmodel=@var{code-model} @gol
497 -m32  -m64}
498
499 @emph{HPPA Options}
500 @gccoptlist{-march=@var{architecture-type} @gol
501 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
502 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
503 -mjump-in-delay -mlinker-opt -mlong-calls @gol
504 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
505 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
506 -mno-jump-in-delay  -mno-long-load-store @gol
507 -mno-portable-runtime  -mno-soft-float @gol
508 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
509 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
510 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
511 -nolibdld  -static  -threads}
512
513 @emph{Intel 960 Options}
514 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
515 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
516 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
517 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
518 -mno-complex-addr  -mno-leaf-procedures @gol
519 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
520 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
521 -mtail-call}
522
523 @emph{DEC Alpha Options}
524 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
525 -mieee  -mieee-with-inexact  -mieee-conformant @gol
526 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
527 -mtrap-precision=@var{mode}  -mbuild-constants @gol
528 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
529 -mbwx  -mmax  -mfix  -mcix @gol
530 -mfloat-vax  -mfloat-ieee @gol
531 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
532 -msmall-text  -mlarge-text @gol
533 -mmemory-latency=@var{time}}
534
535 @emph{DEC Alpha/VMS Options}
536 @gccoptlist{-mvms-return-codes}
537
538 @emph{H8/300 Options}
539 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
540
541 @emph{SH Options}
542 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
543 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
544 -m5-64media  -m5-64media-nofpu @gol
545 -m5-32media  -m5-32media-nofpu @gol
546 -m5-compact  -m5-compact-nofpu @gol
547 -mb  -ml  -mdalign  -mrelax @gol
548 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
549 -mieee  -misize  -mpadstruct  -mspace @gol
550 -mprefergot  -musermode}
551
552 @emph{System V Options}
553 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
554
555 @emph{ARC Options}
556 @gccoptlist{-EB  -EL @gol
557 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
558 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
559
560 @emph{TMS320C3x/C4x Options}
561 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
562 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
563 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
564 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
565
566 @emph{V850 Options}
567 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
568 -mprolog-function  -mno-prolog-function  -mspace @gol
569 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
570 -mapp-regs  -mno-app-regs @gol
571 -mdisable-callt  -mno-disable-callt @gol
572 -mv850e1 @gol
573 -mv850e @gol
574 -mv850  -mbig-switch}
575
576 @emph{NS32K Options}
577 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
578 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
579 -mregparam  -mnoregparam  -msb  -mnosb @gol
580 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
581
582 @emph{AVR Options}
583 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
584 -mcall-prologues  -mno-tablejump  -mtiny-stack}
585
586 @emph{MCore Options}
587 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
588 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
589 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
590 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
591 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
592
593 @emph{MMIX Options}
594 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
595 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
596 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
597 -mno-base-addresses  -msingle-exit  -mno-single-exit}
598
599 @emph{IA-64 Options}
600 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
601 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
602 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
603 -minline-float-divide-max-throughput @gol
604 -minline-int-divide-min-latency @gol
605 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
606 -mfixed-range=@var{register-range}}
607
608 @emph{D30V Options}
609 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
610 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
611
612 @emph{S/390 and zSeries Options}
613 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
614 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
615 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
616 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
617
618 @emph{CRIS Options}
619 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
620 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
621 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
622 -mstack-align  -mdata-align  -mconst-align @gol
623 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
624 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
625
626 @emph{PDP-11 Options}
627 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
628 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
629 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
630 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
631 -mbranch-expensive  -mbranch-cheap @gol
632 -msplit  -mno-split  -munix-asm  -mdec-asm}
633
634 @emph{Xstormy16 Options}
635 @gccoptlist{-msim}
636
637 @emph{Xtensa Options}
638 @gccoptlist{-mconst16 -mno-const16 @gol
639 -mfused-madd  -mno-fused-madd @gol
640 -mtext-section-literals  -mno-text-section-literals @gol
641 -mtarget-align  -mno-target-align @gol
642 -mlongcalls  -mno-longcalls}
643
644 @emph{FRV Options}
645 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
646 -mhard-float  -msoft-float @gol
647 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
648 -mdouble  -mno-double @gol
649 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
650 -mlibrary-pic  -macc-4 -macc-8 @gol
651 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
652 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
653 -mvliw-branch  -mno-vliw-branch @gol
654 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
655 -mno-nested-cond-exec  -mtomcat-stats @gol
656 -mcpu=@var{cpu}}
657
658 @item Code Generation Options
659 @xref{Code Gen Options,,Options for Code Generation Conventions}.
660 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
661 -ffixed-@var{reg}  -fexceptions @gol
662 -fnon-call-exceptions  -funwind-tables @gol
663 -fasynchronous-unwind-tables @gol
664 -finhibit-size-directive  -finstrument-functions @gol
665 -fno-common  -fno-ident @gol
666 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
667 -freg-struct-return  -fshared-data  -fshort-enums @gol
668 -fshort-double  -fshort-wchar @gol
669 -fverbose-asm  -fpack-struct  -fstack-check @gol
670 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
671 -fargument-alias  -fargument-noalias @gol
672 -fargument-noalias-global  -fleading-underscore @gol
673 -ftls-model=@var{model} @gol
674 -ftrapv  -fwrapv  -fbounds-check}
675 @end table
676
677 @menu
678 * Overall Options::     Controlling the kind of output:
679                         an executable, object files, assembler files,
680                         or preprocessed source.
681 * C Dialect Options::   Controlling the variant of C language compiled.
682 * C++ Dialect Options:: Variations on C++.
683 * Objective-C Dialect Options:: Variations on Objective-C.
684 * Language Independent Options:: Controlling how diagnostics should be
685                         formatted.
686 * Warning Options::     How picky should the compiler be?
687 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
688 * Optimize Options::    How much optimization?
689 * Preprocessor Options:: Controlling header files and macro definitions.
690                          Also, getting dependency information for Make.
691 * Assembler Options::   Passing options to the assembler.
692 * Link Options::        Specifying libraries and so on.
693 * Directory Options::   Where to find header files and libraries.
694                         Where to find the compiler executable files.
695 * Spec Files::          How to pass switches to sub-processes.
696 * Target Options::      Running a cross-compiler, or an old version of GCC.
697 @end menu
698
699 @node Overall Options
700 @section Options Controlling the Kind of Output
701
702 Compilation can involve up to four stages: preprocessing, compilation
703 proper, assembly and linking, always in that order.  GCC is capable of
704 preprocessing and compiling several files either into several
705 assembler input files, or into one assembler input file; then each
706 assembler input file produces an object file, and linking combines all
707 the object files (those newly compiled, and those specified as input)
708 into an executable file.
709
710 @cindex file name suffix
711 For any given input file, the file name suffix determines what kind of
712 compilation is done:
713
714 @table @gcctabopt
715 @item @var{file}.c
716 C source code which must be preprocessed.
717
718 @item @var{file}.i
719 C source code which should not be preprocessed.
720
721 @item @var{file}.ii
722 C++ source code which should not be preprocessed.
723
724 @item @var{file}.m
725 Objective-C source code.  Note that you must link with the library
726 @file{libobjc.a} to make an Objective-C program work.
727
728 @item @var{file}.mi
729 Objective-C source code which should not be preprocessed.
730
731 @item @var{file}.h
732 C or C++ header file to be turned into a precompiled header.
733
734 @item @var{file}.cc
735 @itemx @var{file}.cp
736 @itemx @var{file}.cxx
737 @itemx @var{file}.cpp
738 @itemx @var{file}.CPP
739 @itemx @var{file}.c++
740 @itemx @var{file}.C
741 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
742 the last two letters must both be literally @samp{x}.  Likewise,
743 @samp{.C} refers to a literal capital C@.
744
745 @item @var{file}.hh
746 @itemx @var{file}.H
747 C++ header file to be turned into a precompiled header.
748
749 @item @var{file}.f
750 @itemx @var{file}.for
751 @itemx @var{file}.FOR
752 Fortran source code which should not be preprocessed.
753
754 @item @var{file}.F
755 @itemx @var{file}.fpp
756 @itemx @var{file}.FPP
757 Fortran source code which must be preprocessed (with the traditional
758 preprocessor).
759
760 @item @var{file}.r
761 Fortran source code which must be preprocessed with a RATFOR
762 preprocessor (not included with GCC)@.
763
764 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
765 Using and Porting GNU Fortran}, for more details of the handling of
766 Fortran input files.
767
768 @c FIXME: Descriptions of Java file types.
769 @c @var{file}.java
770 @c @var{file}.class
771 @c @var{file}.zip
772 @c @var{file}.jar
773
774 @item @var{file}.ads
775 Ada source code file which contains a library unit declaration (a
776 declaration of a package, subprogram, or generic, or a generic
777 instantiation), or a library unit renaming declaration (a package,
778 generic, or subprogram renaming declaration).  Such files are also
779 called @dfn{specs}.
780
781 @itemx @var{file}.adb
782 Ada source code file containing a library unit body (a subprogram or
783 package body).  Such files are also called @dfn{bodies}.
784
785 @c GCC also knows about some suffixes for languages not yet included:
786 @c Pascal:
787 @c @var{file}.p
788 @c @var{file}.pas
789
790 @item @var{file}.s
791 Assembler code.
792
793 @item @var{file}.S
794 Assembler code which must be preprocessed.
795
796 @item @var{other}
797 An object file to be fed straight into linking.
798 Any file name with no recognized suffix is treated this way.
799 @end table
800
801 @opindex x
802 You can specify the input language explicitly with the @option{-x} option:
803
804 @table @gcctabopt
805 @item -x @var{language}
806 Specify explicitly the @var{language} for the following input files
807 (rather than letting the compiler choose a default based on the file
808 name suffix).  This option applies to all following input files until
809 the next @option{-x} option.  Possible values for @var{language} are:
810 @example
811 c  c-header  cpp-output
812 c++  c++-header  c++-cpp-output
813 objective-c  objective-c-header  objc-cpp-output
814 assembler  assembler-with-cpp
815 ada
816 f77  f77-cpp-input  ratfor
817 java
818 treelang
819 @end example
820
821 @item -x none
822 Turn off any specification of a language, so that subsequent files are
823 handled according to their file name suffixes (as they are if @option{-x}
824 has not been used at all).
825
826 @item -pass-exit-codes
827 @opindex pass-exit-codes
828 Normally the @command{gcc} program will exit with the code of 1 if any
829 phase of the compiler returns a non-success return code.  If you specify
830 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
831 numerically highest error produced by any phase that returned an error
832 indication.
833 @end table
834
835 If you only want some of the stages of compilation, you can use
836 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
837 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
838 @command{gcc} is to stop.  Note that some combinations (for example,
839 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
840
841 @table @gcctabopt
842 @item -c
843 @opindex c
844 Compile or assemble the source files, but do not link.  The linking
845 stage simply is not done.  The ultimate output is in the form of an
846 object file for each source file.
847
848 By default, the object file name for a source file is made by replacing
849 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
850
851 Unrecognized input files, not requiring compilation or assembly, are
852 ignored.
853
854 @item -S
855 @opindex S
856 Stop after the stage of compilation proper; do not assemble.  The output
857 is in the form of an assembler code file for each non-assembler input
858 file specified.
859
860 By default, the assembler file name for a source file is made by
861 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
862
863 Input files that don't require compilation are ignored.
864
865 @item -E
866 @opindex E
867 Stop after the preprocessing stage; do not run the compiler proper.  The
868 output is in the form of preprocessed source code, which is sent to the
869 standard output.
870
871 Input files which don't require preprocessing are ignored.
872
873 @cindex output file option
874 @item -o @var{file}
875 @opindex o
876 Place output in file @var{file}.  This applies regardless to whatever
877 sort of output is being produced, whether it be an executable file,
878 an object file, an assembler file or preprocessed C code.
879
880 If you specify @option{-o} when compiling more than one input file, or
881 you are producing an executable file as output, all the source files
882 on the command line will be compiled at once.
883
884 If @option{-o} is not specified, the default is to put an executable file
885 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
886 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
887 all preprocessed C source on standard output.
888
889 @item -v
890 @opindex v
891 Print (on standard error output) the commands executed to run the stages
892 of compilation.  Also print the version number of the compiler driver
893 program and of the preprocessor and the compiler proper.
894
895 @item -###
896 @opindex ###
897 Like @option{-v} except the commands are not executed and all command
898 arguments are quoted.  This is useful for shell scripts to capture the
899 driver-generated command lines.
900
901 @item -pipe
902 @opindex pipe
903 Use pipes rather than temporary files for communication between the
904 various stages of compilation.  This fails to work on some systems where
905 the assembler is unable to read from a pipe; but the GNU assembler has
906 no trouble.
907
908 @item --help
909 @opindex help
910 Print (on the standard output) a description of the command line options
911 understood by @command{gcc}.  If the @option{-v} option is also specified
912 then @option{--help} will also be passed on to the various processes
913 invoked by @command{gcc}, so that they can display the command line options
914 they accept.  If the @option{-Wextra} option is also specified then command
915 line options which have no documentation associated with them will also
916 be displayed.
917
918 @item --target-help
919 @opindex target-help
920 Print (on the standard output) a description of target specific command
921 line options for each tool.
922
923 @item --version
924 @opindex version
925 Display the version number and copyrights of the invoked GCC.
926 @end table
927
928 @node Invoking G++
929 @section Compiling C++ Programs
930
931 @cindex suffixes for C++ source
932 @cindex C++ source file suffixes
933 C++ source files conventionally use one of the suffixes @samp{.C},
934 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
935 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
936 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
937 files with these names and compiles them as C++ programs even if you
938 call the compiler the same way as for compiling C programs (usually
939 with the name @command{gcc}).
940
941 @findex g++
942 @findex c++
943 However, C++ programs often require class libraries as well as a
944 compiler that understands the C++ language---and under some
945 circumstances, you might want to compile programs or header files from
946 standard input, or otherwise without a suffix that flags them as C++
947 programs.  You might also like to precompile a C header file with a
948 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
949 program that calls GCC with the default language set to C++, and
950 automatically specifies linking against the C++ library.  On many
951 systems, @command{g++} is also installed with the name @command{c++}.
952
953 @cindex invoking @command{g++}
954 When you compile C++ programs, you may specify many of the same
955 command-line options that you use for compiling programs in any
956 language; or command-line options meaningful for C and related
957 languages; or options that are meaningful only for C++ programs.
958 @xref{C Dialect Options,,Options Controlling C Dialect}, for
959 explanations of options for languages related to C@.
960 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
961 explanations of options that are meaningful only for C++ programs.
962
963 @node C Dialect Options
964 @section Options Controlling C Dialect
965 @cindex dialect options
966 @cindex language dialect options
967 @cindex options, dialect
968
969 The following options control the dialect of C (or languages derived
970 from C, such as C++ and Objective-C) that the compiler accepts:
971
972 @table @gcctabopt
973 @cindex ANSI support
974 @cindex ISO support
975 @item -ansi
976 @opindex ansi
977 In C mode, support all ISO C90 programs.  In C++ mode,
978 remove GNU extensions that conflict with ISO C++.
979
980 This turns off certain features of GCC that are incompatible with ISO
981 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
982 such as the @code{asm} and @code{typeof} keywords, and
983 predefined macros such as @code{unix} and @code{vax} that identify the
984 type of system you are using.  It also enables the undesirable and
985 rarely used ISO trigraph feature.  For the C compiler,
986 it disables recognition of C++ style @samp{//} comments as well as
987 the @code{inline} keyword.
988
989 The alternate keywords @code{__asm__}, @code{__extension__},
990 @code{__inline__} and @code{__typeof__} continue to work despite
991 @option{-ansi}.  You would not want to use them in an ISO C program, of
992 course, but it is useful to put them in header files that might be included
993 in compilations done with @option{-ansi}.  Alternate predefined macros
994 such as @code{__unix__} and @code{__vax__} are also available, with or
995 without @option{-ansi}.
996
997 The @option{-ansi} option does not cause non-ISO programs to be
998 rejected gratuitously.  For that, @option{-pedantic} is required in
999 addition to @option{-ansi}.  @xref{Warning Options}.
1000
1001 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1002 option is used.  Some header files may notice this macro and refrain
1003 from declaring certain functions or defining certain macros that the
1004 ISO standard doesn't call for; this is to avoid interfering with any
1005 programs that might use these names for other things.
1006
1007 Functions which would normally be built in but do not have semantics
1008 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1009 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1010 built-in functions provided by GCC}, for details of the functions
1011 affected.
1012
1013 @item -std=
1014 @opindex std
1015 Determine the language standard.  This option is currently only
1016 supported when compiling C or C++.  A value for this option must be
1017 provided; possible values are
1018
1019 @table @samp
1020 @item c89
1021 @itemx iso9899:1990
1022 ISO C90 (same as @option{-ansi}).
1023
1024 @item iso9899:199409
1025 ISO C90 as modified in amendment 1.
1026
1027 @item c99
1028 @itemx c9x
1029 @itemx iso9899:1999
1030 @itemx iso9899:199x
1031 ISO C99.  Note that this standard is not yet fully supported; see
1032 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1033 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1034
1035 @item gnu89
1036 Default, ISO C90 plus GNU extensions (including some C99 features).
1037
1038 @item gnu99
1039 @itemx gnu9x
1040 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1041 this will become the default.  The name @samp{gnu9x} is deprecated.
1042
1043 @item c++98
1044 The 1998 ISO C++ standard plus amendments.
1045
1046 @item gnu++98
1047 The same as @option{-std=c++98} plus GNU extensions.  This is the
1048 default for C++ code.
1049 @end table
1050
1051 Even when this option is not specified, you can still use some of the
1052 features of newer standards in so far as they do not conflict with
1053 previous C standards.  For example, you may use @code{__restrict__} even
1054 when @option{-std=c99} is not specified.
1055
1056 The @option{-std} options specifying some version of ISO C have the same
1057 effects as @option{-ansi}, except that features that were not in ISO C90
1058 but are in the specified version (for example, @samp{//} comments and
1059 the @code{inline} keyword in ISO C99) are not disabled.
1060
1061 @xref{Standards,,Language Standards Supported by GCC}, for details of
1062 these standard versions.
1063
1064 @item -aux-info @var{filename}
1065 @opindex aux-info
1066 Output to the given filename prototyped declarations for all functions
1067 declared and/or defined in a translation unit, including those in header
1068 files.  This option is silently ignored in any language other than C@.
1069
1070 Besides declarations, the file indicates, in comments, the origin of
1071 each declaration (source file and line), whether the declaration was
1072 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1073 @samp{O} for old, respectively, in the first character after the line
1074 number and the colon), and whether it came from a declaration or a
1075 definition (@samp{C} or @samp{F}, respectively, in the following
1076 character).  In the case of function definitions, a K&R-style list of
1077 arguments followed by their declarations is also provided, inside
1078 comments, after the declaration.
1079
1080 @item -fno-asm
1081 @opindex fno-asm
1082 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1083 keyword, so that code can use these words as identifiers.  You can use
1084 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1085 instead.  @option{-ansi} implies @option{-fno-asm}.
1086
1087 In C++, this switch only affects the @code{typeof} keyword, since
1088 @code{asm} and @code{inline} are standard keywords.  You may want to
1089 use the @option{-fno-gnu-keywords} flag instead, which has the same
1090 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1091 switch only affects the @code{asm} and @code{typeof} keywords, since
1092 @code{inline} is a standard keyword in ISO C99.
1093
1094 @item -fno-builtin
1095 @itemx -fno-builtin-@var{function}
1096 @opindex fno-builtin
1097 @cindex built-in functions
1098 Don't recognize built-in functions that do not begin with
1099 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1100 functions provided by GCC}, for details of the functions affected,
1101 including those which are not built-in functions when @option{-ansi} or
1102 @option{-std} options for strict ISO C conformance are used because they
1103 do not have an ISO standard meaning.
1104
1105 GCC normally generates special code to handle certain built-in functions
1106 more efficiently; for instance, calls to @code{alloca} may become single
1107 instructions that adjust the stack directly, and calls to @code{memcpy}
1108 may become inline copy loops.  The resulting code is often both smaller
1109 and faster, but since the function calls no longer appear as such, you
1110 cannot set a breakpoint on those calls, nor can you change the behavior
1111 of the functions by linking with a different library.
1112
1113 With the @option{-fno-builtin-@var{function}} option
1114 only the built-in function @var{function} is
1115 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1116 function is named this is not built-in in this version of GCC, this
1117 option is ignored.  There is no corresponding
1118 @option{-fbuiltin-@var{function}} option; if you wish to enable
1119 built-in functions selectively when using @option{-fno-builtin} or
1120 @option{-ffreestanding}, you may define macros such as:
1121
1122 @smallexample
1123 #define abs(n)          __builtin_abs ((n))
1124 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1125 @end smallexample
1126
1127 @item -fhosted
1128 @opindex fhosted
1129 @cindex hosted environment
1130
1131 Assert that compilation takes place in a hosted environment.  This implies
1132 @option{-fbuiltin}.  A hosted environment is one in which the
1133 entire standard library is available, and in which @code{main} has a return
1134 type of @code{int}.  Examples are nearly everything except a kernel.
1135 This is equivalent to @option{-fno-freestanding}.
1136
1137 @item -ffreestanding
1138 @opindex ffreestanding
1139 @cindex hosted environment
1140
1141 Assert that compilation takes place in a freestanding environment.  This
1142 implies @option{-fno-builtin}.  A freestanding environment
1143 is one in which the standard library may not exist, and program startup may
1144 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1145 This is equivalent to @option{-fno-hosted}.
1146
1147 @xref{Standards,,Language Standards Supported by GCC}, for details of
1148 freestanding and hosted environments.
1149
1150 @item -fms-extensions
1151 @opindex fms-extensions
1152 Accept some non-standard constructs used in Microsoft header files.
1153
1154 @item -trigraphs
1155 @opindex trigraphs
1156 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1157 options for strict ISO C conformance) implies @option{-trigraphs}.
1158
1159 @item -no-integrated-cpp
1160 @opindex no-integrated-cpp
1161 Performs a compilation in two passes: preprocessing and compiling.  This
1162 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1163 @option{-B} option. The user supplied compilation step can then add in
1164 an additional preprocessing step after normal preprocessing but before
1165 compiling. The default is to use the integrated cpp (internal cpp)
1166
1167 The semantics of this option will change if "cc1", "cc1plus", and
1168 "cc1obj" are merged.
1169
1170 @cindex traditional C language
1171 @cindex C language, traditional
1172 @item -traditional
1173 @itemx -traditional-cpp
1174 @opindex traditional-cpp
1175 @opindex traditional
1176 Formerly, these options caused GCC to attempt to emulate a pre-standard
1177 C compiler.  They are now only supported with the @option{-E} switch.
1178 The preprocessor continues to support a pre-standard mode.  See the GNU
1179 CPP manual for details.
1180
1181 @item -fcond-mismatch
1182 @opindex fcond-mismatch
1183 Allow conditional expressions with mismatched types in the second and
1184 third arguments.  The value of such an expression is void.  This option
1185 is not supported for C++.
1186
1187 @item -funsigned-char
1188 @opindex funsigned-char
1189 Let the type @code{char} be unsigned, like @code{unsigned char}.
1190
1191 Each kind of machine has a default for what @code{char} should
1192 be.  It is either like @code{unsigned char} by default or like
1193 @code{signed char} by default.
1194
1195 Ideally, a portable program should always use @code{signed char} or
1196 @code{unsigned char} when it depends on the signedness of an object.
1197 But many programs have been written to use plain @code{char} and
1198 expect it to be signed, or expect it to be unsigned, depending on the
1199 machines they were written for.  This option, and its inverse, let you
1200 make such a program work with the opposite default.
1201
1202 The type @code{char} is always a distinct type from each of
1203 @code{signed char} or @code{unsigned char}, even though its behavior
1204 is always just like one of those two.
1205
1206 @item -fsigned-char
1207 @opindex fsigned-char
1208 Let the type @code{char} be signed, like @code{signed char}.
1209
1210 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1211 the negative form of @option{-funsigned-char}.  Likewise, the option
1212 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1213
1214 @item -fsigned-bitfields
1215 @itemx -funsigned-bitfields
1216 @itemx -fno-signed-bitfields
1217 @itemx -fno-unsigned-bitfields
1218 @opindex fsigned-bitfields
1219 @opindex funsigned-bitfields
1220 @opindex fno-signed-bitfields
1221 @opindex fno-unsigned-bitfields
1222 These options control whether a bit-field is signed or unsigned, when the
1223 declaration does not use either @code{signed} or @code{unsigned}.  By
1224 default, such a bit-field is signed, because this is consistent: the
1225 basic integer types such as @code{int} are signed types.
1226
1227 @item -fwritable-strings
1228 @opindex fwritable-strings
1229 Store string constants in the writable data segment and don't uniquize
1230 them.  This is for compatibility with old programs which assume they can
1231 write into string constants.
1232
1233 Writing into string constants is a very bad idea; ``constants'' should
1234 be constant.
1235
1236 This option is deprecated.
1237 @end table
1238
1239 @node C++ Dialect Options
1240 @section Options Controlling C++ Dialect
1241
1242 @cindex compiler options, C++
1243 @cindex C++ options, command line
1244 @cindex options, C++
1245 This section describes the command-line options that are only meaningful
1246 for C++ programs; but you can also use most of the GNU compiler options
1247 regardless of what language your program is in.  For example, you
1248 might compile a file @code{firstClass.C} like this:
1249
1250 @example
1251 g++ -g -frepo -O -c firstClass.C
1252 @end example
1253
1254 @noindent
1255 In this example, only @option{-frepo} is an option meant
1256 only for C++ programs; you can use the other options with any
1257 language supported by GCC@.
1258
1259 Here is a list of options that are @emph{only} for compiling C++ programs:
1260
1261 @table @gcctabopt
1262
1263 @item -fabi-version=@var{n}
1264 @opindex fabi-version
1265 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1266 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1267 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1268 the version that conforms most closely to the C++ ABI specification.
1269 Therefore, the ABI obtained using version 0 will change as ABI bugs
1270 are fixed.
1271
1272 The default is version 1.
1273
1274 @item -fno-access-control
1275 @opindex fno-access-control
1276 Turn off all access checking.  This switch is mainly useful for working
1277 around bugs in the access control code.
1278
1279 @item -fcheck-new
1280 @opindex fcheck-new
1281 Check that the pointer returned by @code{operator new} is non-null
1282 before attempting to modify the storage allocated.  This check is
1283 normally unnecessary because the C++ standard specifies that
1284 @code{operator new} will only return @code{0} if it is declared
1285 @samp{throw()}, in which case the compiler will always check the
1286 return value even without this option.  In all other cases, when
1287 @code{operator new} has a non-empty exception specification, memory
1288 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1289 @samp{new (nothrow)}.
1290
1291 @item -fconserve-space
1292 @opindex fconserve-space
1293 Put uninitialized or runtime-initialized global variables into the
1294 common segment, as C does.  This saves space in the executable at the
1295 cost of not diagnosing duplicate definitions.  If you compile with this
1296 flag and your program mysteriously crashes after @code{main()} has
1297 completed, you may have an object that is being destroyed twice because
1298 two definitions were merged.
1299
1300 This option is no longer useful on most targets, now that support has
1301 been added for putting variables into BSS without making them common.
1302
1303 @item -fno-const-strings
1304 @opindex fno-const-strings
1305 Give string constants type @code{char *} instead of type @code{const
1306 char *}.  By default, G++ uses type @code{const char *} as required by
1307 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1308 actually modify the value of a string constant, unless you also use
1309 @option{-fwritable-strings}.
1310
1311 This option might be removed in a future release of G++.  For maximum
1312 portability, you should structure your code so that it works with
1313 string constants that have type @code{const char *}.
1314
1315 @item -fno-elide-constructors
1316 @opindex fno-elide-constructors
1317 The C++ standard allows an implementation to omit creating a temporary
1318 which is only used to initialize another object of the same type.
1319 Specifying this option disables that optimization, and forces G++ to
1320 call the copy constructor in all cases.
1321
1322 @item -fno-enforce-eh-specs
1323 @opindex fno-enforce-eh-specs
1324 Don't check for violation of exception specifications at runtime.  This
1325 option violates the C++ standard, but may be useful for reducing code
1326 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1327 will still optimize based on the exception specifications.
1328
1329 @item -ffor-scope
1330 @itemx -fno-for-scope
1331 @opindex ffor-scope
1332 @opindex fno-for-scope
1333 If @option{-ffor-scope} is specified, the scope of variables declared in
1334 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1335 as specified by the C++ standard.
1336 If @option{-fno-for-scope} is specified, the scope of variables declared in
1337 a @i{for-init-statement} extends to the end of the enclosing scope,
1338 as was the case in old versions of G++, and other (traditional)
1339 implementations of C++.
1340
1341 The default if neither flag is given to follow the standard,
1342 but to allow and give a warning for old-style code that would
1343 otherwise be invalid, or have different behavior.
1344
1345 @item -fno-gnu-keywords
1346 @opindex fno-gnu-keywords
1347 Do not recognize @code{typeof} as a keyword, so that code can use this
1348 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1349 @option{-ansi} implies @option{-fno-gnu-keywords}.
1350
1351 @item -fno-implicit-templates
1352 @opindex fno-implicit-templates
1353 Never emit code for non-inline templates which are instantiated
1354 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1355 @xref{Template Instantiation}, for more information.
1356
1357 @item -fno-implicit-inline-templates
1358 @opindex fno-implicit-inline-templates
1359 Don't emit code for implicit instantiations of inline templates, either.
1360 The default is to handle inlines differently so that compiles with and
1361 without optimization will need the same set of explicit instantiations.
1362
1363 @item -fno-implement-inlines
1364 @opindex fno-implement-inlines
1365 To save space, do not emit out-of-line copies of inline functions
1366 controlled by @samp{#pragma implementation}.  This will cause linker
1367 errors if these functions are not inlined everywhere they are called.
1368
1369 @item -fms-extensions
1370 @opindex fms-extensions
1371 Disable pedantic warnings about constructs used in MFC, such as implicit
1372 int and getting a pointer to member function via non-standard syntax.
1373
1374 @item -fno-nonansi-builtins
1375 @opindex fno-nonansi-builtins
1376 Disable built-in declarations of functions that are not mandated by
1377 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1378 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1379
1380 @item -fno-operator-names
1381 @opindex fno-operator-names
1382 Do not treat the operator name keywords @code{and}, @code{bitand},
1383 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1384 synonyms as keywords.
1385
1386 @item -fno-optional-diags
1387 @opindex fno-optional-diags
1388 Disable diagnostics that the standard says a compiler does not need to
1389 issue.  Currently, the only such diagnostic issued by G++ is the one for
1390 a name having multiple meanings within a class.
1391
1392 @item -fpermissive
1393 @opindex fpermissive
1394 Downgrade some diagnostics about nonconformant code from errors to
1395 warnings.  Thus, using @option{-fpermissive} will allow some
1396 nonconforming code to compile.
1397
1398 @item -frepo
1399 @opindex frepo
1400 Enable automatic template instantiation at link time.  This option also
1401 implies @option{-fno-implicit-templates}.  @xref{Template
1402 Instantiation}, for more information.
1403
1404 @item -fno-rtti
1405 @opindex fno-rtti
1406 Disable generation of information about every class with virtual
1407 functions for use by the C++ runtime type identification features
1408 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1409 of the language, you can save some space by using this flag.  Note that
1410 exception handling uses the same information, but it will generate it as
1411 needed.
1412
1413 @item -fstats
1414 @opindex fstats
1415 Emit statistics about front-end processing at the end of the compilation.
1416 This information is generally only useful to the G++ development team.
1417
1418 @item -ftemplate-depth-@var{n}
1419 @opindex ftemplate-depth
1420 Set the maximum instantiation depth for template classes to @var{n}.
1421 A limit on the template instantiation depth is needed to detect
1422 endless recursions during template class instantiation.  ANSI/ISO C++
1423 conforming programs must not rely on a maximum depth greater than 17.
1424
1425 @item -fuse-cxa-atexit
1426 @opindex fuse-cxa-atexit
1427 Register destructors for objects with static storage duration with the
1428 @code{__cxa_atexit} function rather than the @code{atexit} function.
1429 This option is required for fully standards-compliant handling of static
1430 destructors, but will only work if your C library supports
1431 @code{__cxa_atexit}.
1432
1433 @item -fno-weak
1434 @opindex fno-weak
1435 Do not use weak symbol support, even if it is provided by the linker.
1436 By default, G++ will use weak symbols if they are available.  This
1437 option exists only for testing, and should not be used by end-users;
1438 it will result in inferior code and has no benefits.  This option may
1439 be removed in a future release of G++.
1440
1441 @item -nostdinc++
1442 @opindex nostdinc++
1443 Do not search for header files in the standard directories specific to
1444 C++, but do still search the other standard directories.  (This option
1445 is used when building the C++ library.)
1446 @end table
1447
1448 In addition, these optimization, warning, and code generation options
1449 have meanings only for C++ programs:
1450
1451 @table @gcctabopt
1452 @item -fno-default-inline
1453 @opindex fno-default-inline
1454 Do not assume @samp{inline} for functions defined inside a class scope.
1455 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1456 functions will have linkage like inline functions; they just won't be
1457 inlined by default.
1458
1459 @item -Wabi @r{(C++ only)}
1460 @opindex Wabi
1461 Warn when G++ generates code that is probably not compatible with the
1462 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1463 all such cases, there are probably some cases that are not warned about, 
1464 even though G++ is generating incompatible code.  There may also be
1465 cases where warnings are emitted even though the code that is generated
1466 will be compatible.
1467
1468 You should rewrite your code to avoid these warnings if you are
1469 concerned about the fact that code generated by G++ may not be binary
1470 compatible with code generated by other compilers.
1471
1472 The known incompatibilities at this point include:
1473
1474 @itemize @bullet
1475
1476 @item
1477 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1478 pack data into the same byte as a base class.  For example:
1479
1480 @smallexample
1481 struct A @{ virtual void f(); int f1 : 1; @};
1482 struct B : public A @{ int f2 : 1; @};
1483 @end smallexample
1484
1485 @noindent
1486 In this case, G++ will place @code{B::f2} into the same byte
1487 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1488 by explicitly padding @code{A} so that its size is a multiple of the
1489 byte size on your platform; that will cause G++ and other compilers to
1490 layout @code{B} identically.
1491
1492 @item
1493 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1494 tail padding when laying out virtual bases.  For example:
1495
1496 @smallexample
1497 struct A @{ virtual void f(); char c1; @};
1498 struct B @{ B(); char c2; @};
1499 struct C : public A, public virtual B @{@};
1500 @end smallexample
1501
1502 @noindent
1503 In this case, G++ will not place @code{B} into the tail-padding for
1504 @code{A}; other compilers will.  You can avoid this problem by
1505 explicitly padding @code{A} so that its size is a multiple of its
1506 alignment (ignoring virtual base classes); that will cause G++ and other
1507 compilers to layout @code{C} identically.
1508
1509 @item
1510 Incorrect handling of bit-fields with declared widths greater than that
1511 of their underlying types, when the bit-fields appear in a union.  For
1512 example:
1513
1514 @smallexample
1515 union U @{ int i : 4096; @};
1516 @end smallexample
1517
1518 @noindent
1519 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1520 union too small by the number of bits in an @code{int}.
1521
1522 @item
1523 Empty classes can be placed at incorrect offsets.  For example:
1524  
1525 @smallexample
1526 struct A @{@};
1527
1528 struct B @{
1529   A a;
1530   virtual void f ();
1531 @};
1532
1533 struct C : public B, public A @{@};
1534 @end smallexample
1535
1536 @noindent
1537 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1538 it should be placed at offset zero.  G++ mistakenly believes that the
1539 @code{A} data member of @code{B} is already at offset zero.
1540
1541 @item
1542 Names of template functions whose types involve @code{typename} or
1543 template template parameters can be mangled incorrectly.
1544
1545 @smallexample
1546 template <typename Q>
1547 void f(typename Q::X) @{@}
1548
1549 template <template <typename> class Q>
1550 void f(typename Q<int>::X) @{@}
1551 @end smallexample
1552
1553 @noindent
1554 Instantiations of these templates may be mangled incorrectly.
1555
1556 @end itemize
1557
1558 @item -Wctor-dtor-privacy @r{(C++ only)}
1559 @opindex Wctor-dtor-privacy
1560 Warn when a class seems unusable because all the constructors or
1561 destructors in that class are private, and it has neither friends nor
1562 public static member functions.
1563
1564 @item -Wnon-virtual-dtor @r{(C++ only)}
1565 @opindex Wnon-virtual-dtor
1566 Warn when a class appears to be polymorphic, thereby requiring a virtual
1567 destructor, yet it declares a non-virtual one.
1568 This warning is enabled by @option{-Wall}.
1569
1570 @item -Wreorder @r{(C++ only)}
1571 @opindex Wreorder
1572 @cindex reordering, warning
1573 @cindex warning for reordering of member initializers
1574 Warn when the order of member initializers given in the code does not
1575 match the order in which they must be executed.  For instance:
1576
1577 @smallexample
1578 struct A @{
1579   int i;
1580   int j;
1581   A(): j (0), i (1) @{ @}
1582 @};
1583 @end smallexample
1584
1585 The compiler will rearrange the member initializers for @samp{i}
1586 and @samp{j} to match the declaration order of the members, emitting
1587 a warning to that effect.  This warning is enabled by @option{-Wall}.
1588 @end table
1589
1590 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1591
1592 @table @gcctabopt
1593 @item -Weffc++ @r{(C++ only)}
1594 @opindex Weffc++
1595 Warn about violations of the following style guidelines from Scott Meyers'
1596 @cite{Effective C++} book:
1597
1598 @itemize @bullet
1599 @item
1600 Item 11:  Define a copy constructor and an assignment operator for classes
1601 with dynamically allocated memory.
1602
1603 @item
1604 Item 12:  Prefer initialization to assignment in constructors.
1605
1606 @item
1607 Item 14:  Make destructors virtual in base classes.
1608
1609 @item
1610 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1611
1612 @item
1613 Item 23:  Don't try to return a reference when you must return an object.
1614
1615 @end itemize
1616
1617 Also warn about violations of the following style guidelines from 
1618 Scott Meyers' @cite{More Effective C++} book:
1619
1620 @itemize @bullet
1621 @item
1622 Item 6:  Distinguish between prefix and postfix forms of increment and
1623 decrement operators.
1624
1625 @item
1626 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1627
1628 @end itemize
1629
1630 When selecting this option, be aware that the standard library
1631 headers do not obey all of these guidelines; use @samp{grep -v}
1632 to filter out those warnings.
1633
1634 @item -Wno-deprecated @r{(C++ only)}
1635 @opindex Wno-deprecated
1636 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1637
1638 @item -Wno-non-template-friend @r{(C++ only)}
1639 @opindex Wno-non-template-friend
1640 Disable warnings when non-templatized friend functions are declared
1641 within a template.  Since the advent of explicit template specification
1642 support in G++, if the name of the friend is an unqualified-id (i.e.,
1643 @samp{friend foo(int)}), the C++ language specification demands that the
1644 friend declare or define an ordinary, nontemplate function.  (Section
1645 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1646 could be interpreted as a particular specialization of a templatized
1647 function.  Because this non-conforming behavior is no longer the default
1648 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1649 check existing code for potential trouble spots and is on by default.
1650 This new compiler behavior can be turned off with
1651 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1652 but disables the helpful warning.
1653
1654 @item -Wold-style-cast @r{(C++ only)}
1655 @opindex Wold-style-cast
1656 Warn if an old-style (C-style) cast to a non-void type is used within
1657 a C++ program.  The new-style casts (@samp{static_cast},
1658 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1659 unintended effects and much easier to search for.
1660
1661 @item -Woverloaded-virtual @r{(C++ only)}
1662 @opindex Woverloaded-virtual
1663 @cindex overloaded virtual fn, warning
1664 @cindex warning for overloaded virtual fn
1665 Warn when a function declaration hides virtual functions from a
1666 base class.  For example, in:
1667
1668 @smallexample
1669 struct A @{
1670   virtual void f();
1671 @};
1672
1673 struct B: public A @{
1674   void f(int);
1675 @};
1676 @end smallexample
1677
1678 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1679 like:
1680
1681 @smallexample
1682 B* b;
1683 b->f();
1684 @end smallexample
1685
1686 will fail to compile.
1687
1688 @item -Wno-pmf-conversions @r{(C++ only)}
1689 @opindex Wno-pmf-conversions
1690 Disable the diagnostic for converting a bound pointer to member function
1691 to a plain pointer.
1692
1693 @item -Wsign-promo @r{(C++ only)}
1694 @opindex Wsign-promo
1695 Warn when overload resolution chooses a promotion from unsigned or
1696 enumeral type to a signed type, over a conversion to an unsigned type of
1697 the same size.  Previous versions of G++ would try to preserve
1698 unsignedness, but the standard mandates the current behavior.
1699
1700 @item -Wsynth @r{(C++ only)}
1701 @opindex Wsynth
1702 @cindex warning for synthesized methods
1703 @cindex synthesized methods, warning
1704 Warn when G++'s synthesis behavior does not match that of cfront.  For
1705 instance:
1706
1707 @smallexample
1708 struct A @{
1709   operator int ();
1710   A& operator = (int);
1711 @};
1712
1713 main ()
1714 @{
1715   A a,b;
1716   a = b;
1717 @}
1718 @end smallexample
1719
1720 In this example, G++ will synthesize a default @samp{A& operator =
1721 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1722 @end table
1723
1724 @node Objective-C Dialect Options
1725 @section Options Controlling Objective-C Dialect
1726
1727 @cindex compiler options, Objective-C
1728 @cindex Objective-C options, command line
1729 @cindex options, Objective-C
1730 (NOTE: This manual does not describe the Objective-C language itself.  See
1731 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1732
1733 This section describes the command-line options that are only meaningful
1734 for Objective-C programs, but you can also use most of the GNU compiler
1735 options regardless of what language your program is in.  For example,
1736 you might compile a file @code{some_class.m} like this:
1737
1738 @example
1739 gcc -g -fgnu-runtime -O -c some_class.m
1740 @end example
1741
1742 @noindent
1743 In this example, @option{-fgnu-runtime} is an option meant only for
1744 Objective-C programs; you can use the other options with any language
1745 supported by GCC@.
1746
1747 Here is a list of options that are @emph{only} for compiling Objective-C
1748 programs:
1749
1750 @table @gcctabopt
1751 @item -fconstant-string-class=@var{class-name}
1752 @opindex fconstant-string-class
1753 Use @var{class-name} as the name of the class to instantiate for each
1754 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1755 class name is @code{NXConstantString} if the GNU runtime is being used, and
1756 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1757 @option{-fconstant-cfstrings} option, if also present, will override the
1758 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1759 to be laid out as constant CoreFoundation strings.
1760
1761 @item -fgnu-runtime
1762 @opindex fgnu-runtime
1763 Generate object code compatible with the standard GNU Objective-C
1764 runtime.  This is the default for most types of systems.
1765
1766 @item -fnext-runtime
1767 @opindex fnext-runtime
1768 Generate output compatible with the NeXT runtime.  This is the default
1769 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1770 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1771 used.
1772
1773 @item -fno-nil-receivers
1774 @opindex -fno-nil-receivers
1775 Assume that all Objective-C message dispatches (e.g., 
1776 @code{[receiver message:arg]}) in this translation unit ensure that the receiver 
1777 is not @code{nil}.  This allows for more efficient entry points in the runtime to be 
1778 used.  Currently, this option is only available in conjunction with 
1779 the NeXT runtime on Mac OS X 10.3 and later.
1780
1781 @item -fobjc-exceptions
1782 @opindex -fobjc-exceptions
1783 Enable syntactic support for structured exception handling in Objective-C, 
1784 similar to what is offered by C++ and Java.  Currently, this option is only 
1785 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. 
1786
1787 @smallexample
1788   @@try @{
1789     @dots{}
1790        @@throw expr;
1791     @dots{}
1792   @}
1793   @@catch (AnObjCClass *exc) @{
1794     @dots{}
1795       @@throw expr;
1796     @dots{}
1797       @@throw;
1798     @dots{}
1799   @}
1800   @@catch (AnotherClass *exc) @{
1801     @dots{}
1802   @}
1803   @@catch (id allOthers) @{
1804     @dots{}
1805   @}
1806   @@finally @{
1807     @dots{}
1808       @@throw expr;
1809     @dots{}
1810   @}
1811 @end smallexample
1812
1813 The @code{@@throw} statement may appear anywhere in an Objective-C or
1814 Objective-C++ program; when used inside of a @code{@@catch} block, the 
1815 @code{@@throw} may appear without an argument (as shown above), in which case 
1816 the object caught by the @code{@@catch} will be rethrown.
1817
1818 Note that only (pointers to) Objective-C objects may be thrown and
1819 caught using this scheme.  When an object is thrown, it will be caught
1820 by the nearest @code{@@catch} clause capable of handling objects of that type,
1821 analogously to how @code{catch} blocks work in C++ and Java.  A 
1822 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch 
1823 any and all Objective-C exceptions not caught by previous @code{@@catch}
1824 clauses (if any).
1825
1826 The @code{@@finally} clause, if present, will be executed upon exit from the
1827 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1828 regardless of whether any exceptions are thrown, caught or rethrown
1829 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1830 of the @code{finally} clause in Java.
1831
1832 There are several caveats to using the new exception mechanism:
1833
1834 @itemize @bullet
1835 @item
1836 Although currently designed to be binary compatible with @code{NS_HANDLER}-style 
1837 idioms provided by the @code{NSException} class, the new
1838 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1839 systems, due to additional functionality needed in the (NeXT) Objective-C
1840 runtime.
1841
1842 @item
1843 As mentioned above, the new exceptions do not support handling
1844 types other than Objective-C objects.   Furthermore, when used from 
1845 Objective-C++, the Objective-C exception model does not interoperate with C++
1846 exceptions at this time.  This means you cannot @code{@@throw} an exception
1847 from Objective-C and @code{catch} it in C++, or vice versa 
1848 (i.e., @code{throw @dots{} @@catch}).
1849 @end itemize
1850  
1851 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1852 blocks for thread-safe execution:
1853
1854 @smallexample
1855   @@synchronized (ObjCClass *guard) @{
1856     @dots{}
1857   @}
1858 @end smallexample
1859
1860 Upon entering the @code{@@synchronized} block, a thread of execution shall
1861 first check whether a lock has been placed on the corresponding @code{guard}
1862 object by another thread.  If it has, the current thread shall wait until
1863 the other thread relinquishes its lock.  Once @code{guard} becomes available, 
1864 the current thread will place its own lock on it, execute the code contained in
1865 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1866 making @code{guard} available to other threads).
1867
1868 Unlike Java, Objective-C does not allow for entire methods to be marked
1869 @code{@@synchronized}.  Note that throwing exceptions out of
1870 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1871 to be unlocked properly.
1872
1873 @item -freplace-objc-classes
1874 @opindex -freplace-objc-classes
1875 Emit a special marker instructing @command{ld(1)} not to statically link in
1876 the resulting object file, and allow @command{dyld(1)} to load it in at
1877 run time instead.  This is used in conjunction with the Fix-and-Continue
1878 debugging mode, where the object file in question may be recompiled and 
1879 dynamically reloaded in the course of program execution, without the need
1880 to restart the program itself.  Currently, Fix-and-Continue functionality
1881 is only available in conjunction with the NeXT runtime on Mac OS X 10.3 
1882 and later.
1883
1884 @item -fzero-link
1885 @opindex -fzero-link
1886 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1887 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1888 compile time) with static class references that get initialized at load time,
1889 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1890 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1891 to be retained.  This is useful in Zero-Link debugging mode, since it allows 
1892 for individual class implementations to be modified during program execution.
1893
1894 @item -gen-decls
1895 @opindex gen-decls
1896 Dump interface declarations for all classes seen in the source file to a
1897 file named @file{@var{sourcename}.decl}.
1898
1899 @item -Wno-protocol
1900 @opindex Wno-protocol
1901 If a class is declared to implement a protocol, a warning is issued for
1902 every method in the protocol that is not implemented by the class.  The
1903 default behavior is to issue a warning for every method not explicitly
1904 implemented in the class, even if a method implementation is inherited
1905 from the superclass.  If you use the @code{-Wno-protocol} option, then
1906 methods inherited from the superclass are considered to be implemented,
1907 and no warning is issued for them.
1908
1909 @item -Wselector
1910 @opindex Wselector
1911 Warn if multiple methods of different types for the same selector are
1912 found during compilation.  The check is performed on the list of methods
1913 in the final stage of compilation.  Additionally, a check is performed
1914 for each selector appearing in a @code{@@selector(@dots{})}
1915 expression, and a corresponding method for that selector has been found
1916 during compilation.  Because these checks scan the method table only at
1917 the end of compilation, these warnings are not produced if the final
1918 stage of compilation is not reached, for example because an error is
1919 found during compilation, or because the @code{-fsyntax-only} option is
1920 being used.
1921
1922 @item -Wundeclared-selector
1923 @opindex Wundeclared-selector
1924 Warn if a @code{@@selector(@dots{})} expression referring to an
1925 undeclared selector is found.  A selector is considered undeclared if no
1926 method with that name has been declared before the 
1927 @code{@@selector(@dots{})} expression, either explicitly in an
1928 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1929 an @code{@@implementation} section.  This option always performs its
1930 checks as soon as a @code{@@selector(@dots{})} expression is found,
1931 while @code{-Wselector} only performs its checks in the final stage of
1932 compilation.  This also enforces the coding style convention
1933 that methods and selectors must be declared before being used.
1934
1935 @item -print-objc-runtime-info
1936 @opindex -print-objc-runtime-info
1937 Generate C header describing the largest structure that is passed by
1938 value, if any.
1939
1940 @end table
1941
1942 @node Language Independent Options
1943 @section Options to Control Diagnostic Messages Formatting
1944 @cindex options to control diagnostics formatting
1945 @cindex diagnostic messages
1946 @cindex message formatting
1947
1948 Traditionally, diagnostic messages have been formatted irrespective of
1949 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1950 below can be used to control the diagnostic messages formatting
1951 algorithm, e.g.@: how many characters per line, how often source location
1952 information should be reported.  Right now, only the C++ front end can
1953 honor these options.  However it is expected, in the near future, that
1954 the remaining front ends would be able to digest them correctly.
1955
1956 @table @gcctabopt
1957 @item -fmessage-length=@var{n}
1958 @opindex fmessage-length
1959 Try to format error messages so that they fit on lines of about @var{n}
1960 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1961 the front ends supported by GCC@.  If @var{n} is zero, then no
1962 line-wrapping will be done; each error message will appear on a single
1963 line.
1964
1965 @opindex fdiagnostics-show-location
1966 @item -fdiagnostics-show-location=once
1967 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1968 reporter to emit @emph{once} source location information; that is, in
1969 case the message is too long to fit on a single physical line and has to
1970 be wrapped, the source location won't be emitted (as prefix) again,
1971 over and over, in subsequent continuation lines.  This is the default
1972 behavior.
1973
1974 @item -fdiagnostics-show-location=every-line
1975 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1976 messages reporter to emit the same source location information (as
1977 prefix) for physical lines that result from the process of breaking
1978 a message which is too long to fit on a single line.
1979
1980 @end table
1981
1982 @node Warning Options
1983 @section Options to Request or Suppress Warnings
1984 @cindex options to control warnings
1985 @cindex warning messages
1986 @cindex messages, warning
1987 @cindex suppressing warnings
1988
1989 Warnings are diagnostic messages that report constructions which
1990 are not inherently erroneous but which are risky or suggest there
1991 may have been an error.
1992
1993 You can request many specific warnings with options beginning @samp{-W},
1994 for example @option{-Wimplicit} to request warnings on implicit
1995 declarations.  Each of these specific warning options also has a
1996 negative form beginning @samp{-Wno-} to turn off warnings;
1997 for example, @option{-Wno-implicit}.  This manual lists only one of the
1998 two forms, whichever is not the default.
1999
2000 The following options control the amount and kinds of warnings produced
2001 by GCC; for further, language-specific options also refer to
2002 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2003
2004 @table @gcctabopt
2005 @cindex syntax checking
2006 @item -fsyntax-only
2007 @opindex fsyntax-only
2008 Check the code for syntax errors, but don't do anything beyond that.
2009
2010 @item -pedantic
2011 @opindex pedantic
2012 Issue all the warnings demanded by strict ISO C and ISO C++;
2013 reject all programs that use forbidden extensions, and some other
2014 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2015 version of the ISO C standard specified by any @option{-std} option used.
2016
2017 Valid ISO C and ISO C++ programs should compile properly with or without
2018 this option (though a rare few will require @option{-ansi} or a
2019 @option{-std} option specifying the required version of ISO C)@.  However,
2020 without this option, certain GNU extensions and traditional C and C++
2021 features are supported as well.  With this option, they are rejected.
2022
2023 @option{-pedantic} does not cause warning messages for use of the
2024 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2025 warnings are also disabled in the expression that follows
2026 @code{__extension__}.  However, only system header files should use
2027 these escape routes; application programs should avoid them.
2028 @xref{Alternate Keywords}.
2029
2030 Some users try to use @option{-pedantic} to check programs for strict ISO
2031 C conformance.  They soon find that it does not do quite what they want:
2032 it finds some non-ISO practices, but not all---only those for which
2033 ISO C @emph{requires} a diagnostic, and some others for which
2034 diagnostics have been added.
2035
2036 A feature to report any failure to conform to ISO C might be useful in
2037 some instances, but would require considerable additional work and would
2038 be quite different from @option{-pedantic}.  We don't have plans to
2039 support such a feature in the near future.
2040
2041 Where the standard specified with @option{-std} represents a GNU
2042 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2043 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2044 extended dialect is based.  Warnings from @option{-pedantic} are given
2045 where they are required by the base standard.  (It would not make sense
2046 for such warnings to be given only for features not in the specified GNU
2047 C dialect, since by definition the GNU dialects of C include all
2048 features the compiler supports with the given option, and there would be
2049 nothing to warn about.)
2050
2051 @item -pedantic-errors
2052 @opindex pedantic-errors
2053 Like @option{-pedantic}, except that errors are produced rather than
2054 warnings.
2055
2056 @item -w
2057 @opindex w
2058 Inhibit all warning messages.
2059
2060 @item -Wno-import
2061 @opindex Wno-import
2062 Inhibit warning messages about the use of @samp{#import}.
2063
2064 @item -Wchar-subscripts
2065 @opindex Wchar-subscripts
2066 Warn if an array subscript has type @code{char}.  This is a common cause
2067 of error, as programmers often forget that this type is signed on some
2068 machines.
2069
2070 @item -Wcomment
2071 @opindex Wcomment
2072 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2073 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2074
2075 @item -Wformat
2076 @opindex Wformat
2077 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2078 the arguments supplied have types appropriate to the format string
2079 specified, and that the conversions specified in the format string make
2080 sense.  This includes standard functions, and others specified by format
2081 attributes (@pxref{Function Attributes}), in the @code{printf},
2082 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2083 not in the C standard) families.
2084
2085 The formats are checked against the format features supported by GNU
2086 libc version 2.2.  These include all ISO C90 and C99 features, as well
2087 as features from the Single Unix Specification and some BSD and GNU
2088 extensions.  Other library implementations may not support all these
2089 features; GCC does not support warning about features that go beyond a
2090 particular library's limitations.  However, if @option{-pedantic} is used
2091 with @option{-Wformat}, warnings will be given about format features not
2092 in the selected standard version (but not for @code{strfmon} formats,
2093 since those are not in any version of the C standard).  @xref{C Dialect
2094 Options,,Options Controlling C Dialect}.
2095
2096 Since @option{-Wformat} also checks for null format arguments for
2097 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2098
2099 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2100 aspects of format checking, the options @option{-Wformat-y2k},
2101 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2102 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2103 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2104
2105 @item -Wformat-y2k
2106 @opindex Wformat-y2k
2107 If @option{-Wformat} is specified, also warn about @code{strftime}
2108 formats which may yield only a two-digit year.
2109
2110 @item -Wno-format-extra-args
2111 @opindex Wno-format-extra-args
2112 If @option{-Wformat} is specified, do not warn about excess arguments to a
2113 @code{printf} or @code{scanf} format function.  The C standard specifies
2114 that such arguments are ignored.
2115
2116 Where the unused arguments lie between used arguments that are
2117 specified with @samp{$} operand number specifications, normally
2118 warnings are still given, since the implementation could not know what
2119 type to pass to @code{va_arg} to skip the unused arguments.  However,
2120 in the case of @code{scanf} formats, this option will suppress the
2121 warning if the unused arguments are all pointers, since the Single
2122 Unix Specification says that such unused arguments are allowed.
2123
2124 @item -Wno-format-zero-length
2125 @opindex Wno-format-zero-length
2126 If @option{-Wformat} is specified, do not warn about zero-length formats.
2127 The C standard specifies that zero-length formats are allowed.
2128
2129 @item -Wformat-nonliteral
2130 @opindex Wformat-nonliteral
2131 If @option{-Wformat} is specified, also warn if the format string is not a
2132 string literal and so cannot be checked, unless the format function
2133 takes its format arguments as a @code{va_list}.
2134
2135 @item -Wformat-security
2136 @opindex Wformat-security
2137 If @option{-Wformat} is specified, also warn about uses of format
2138 functions that represent possible security problems.  At present, this
2139 warns about calls to @code{printf} and @code{scanf} functions where the
2140 format string is not a string literal and there are no format arguments,
2141 as in @code{printf (foo);}.  This may be a security hole if the format
2142 string came from untrusted input and contains @samp{%n}.  (This is
2143 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2144 in future warnings may be added to @option{-Wformat-security} that are not
2145 included in @option{-Wformat-nonliteral}.)
2146
2147 @item -Wformat=2
2148 @opindex Wformat=2
2149 Enable @option{-Wformat} plus format checks not included in
2150 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2151 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2152
2153 @item -Wnonnull
2154 @opindex Wnonnull
2155 Warn about passing a null pointer for arguments marked as
2156 requiring a non-null value by the @code{nonnull} function attribute.
2157
2158 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2159 can be disabled with the @option{-Wno-nonnull} option.
2160
2161 @item -Winit-self @r{(C, C++, and Objective-C only)} 
2162 @opindex Winit-self
2163 Warn about uninitialized variables which are initialized with themselves.
2164 Note this option can only be used with the @option{-Wuninitialized} option,
2165 which in turn only works with @option{-O1} and above.
2166
2167 For example, GCC will warn about @code{i} being uninitialized in the
2168 following snippet only when @option{-Winit-self} has been specified:
2169 @smallexample
2170 @group
2171 int f()
2172 @{
2173   int i = i;
2174   return i;
2175 @}
2176 @end group
2177 @end smallexample
2178
2179 @item -Wimplicit-int
2180 @opindex Wimplicit-int
2181 Warn when a declaration does not specify a type.
2182
2183 @item -Wimplicit-function-declaration
2184 @itemx -Werror-implicit-function-declaration
2185 @opindex Wimplicit-function-declaration
2186 @opindex Werror-implicit-function-declaration
2187 Give a warning (or error) whenever a function is used before being
2188 declared.
2189
2190 @item -Wimplicit
2191 @opindex Wimplicit
2192 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2193
2194 @item -Wmain
2195 @opindex Wmain
2196 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2197 function with external linkage, returning int, taking either zero
2198 arguments, two, or three arguments of appropriate types.
2199
2200 @item -Wmissing-braces
2201 @opindex Wmissing-braces
2202 Warn if an aggregate or union initializer is not fully bracketed.  In
2203 the following example, the initializer for @samp{a} is not fully
2204 bracketed, but that for @samp{b} is fully bracketed.
2205
2206 @smallexample
2207 int a[2][2] = @{ 0, 1, 2, 3 @};
2208 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2209 @end smallexample
2210
2211 @item -Wparentheses
2212 @opindex Wparentheses
2213 Warn if parentheses are omitted in certain contexts, such
2214 as when there is an assignment in a context where a truth value
2215 is expected, or when operators are nested whose precedence people
2216 often get confused about.
2217
2218 Also warn about constructions where there may be confusion to which
2219 @code{if} statement an @code{else} branch belongs.  Here is an example of
2220 such a case:
2221
2222 @smallexample
2223 @group
2224 @{
2225   if (a)
2226     if (b)
2227       foo ();
2228   else
2229     bar ();
2230 @}
2231 @end group
2232 @end smallexample
2233
2234 In C, every @code{else} branch belongs to the innermost possible @code{if}
2235 statement, which in this example is @code{if (b)}.  This is often not
2236 what the programmer expected, as illustrated in the above example by
2237 indentation the programmer chose.  When there is the potential for this
2238 confusion, GCC will issue a warning when this flag is specified.
2239 To eliminate the warning, add explicit braces around the innermost
2240 @code{if} statement so there is no way the @code{else} could belong to
2241 the enclosing @code{if}.  The resulting code would look like this:
2242
2243 @smallexample
2244 @group
2245 @{
2246   if (a)
2247     @{
2248       if (b)
2249         foo ();
2250       else
2251         bar ();
2252     @}
2253 @}
2254 @end group
2255 @end smallexample
2256
2257 @item -Wsequence-point
2258 @opindex Wsequence-point
2259 Warn about code that may have undefined semantics because of violations
2260 of sequence point rules in the C standard.
2261
2262 The C standard defines the order in which expressions in a C program are
2263 evaluated in terms of @dfn{sequence points}, which represent a partial
2264 ordering between the execution of parts of the program: those executed
2265 before the sequence point, and those executed after it.  These occur
2266 after the evaluation of a full expression (one which is not part of a
2267 larger expression), after the evaluation of the first operand of a
2268 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2269 function is called (but after the evaluation of its arguments and the
2270 expression denoting the called function), and in certain other places.
2271 Other than as expressed by the sequence point rules, the order of
2272 evaluation of subexpressions of an expression is not specified.  All
2273 these rules describe only a partial order rather than a total order,
2274 since, for example, if two functions are called within one expression
2275 with no sequence point between them, the order in which the functions
2276 are called is not specified.  However, the standards committee have
2277 ruled that function calls do not overlap.
2278
2279 It is not specified when between sequence points modifications to the
2280 values of objects take effect.  Programs whose behavior depends on this
2281 have undefined behavior; the C standard specifies that ``Between the
2282 previous and next sequence point an object shall have its stored value
2283 modified at most once by the evaluation of an expression.  Furthermore,
2284 the prior value shall be read only to determine the value to be
2285 stored.''.  If a program breaks these rules, the results on any
2286 particular implementation are entirely unpredictable.
2287
2288 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2289 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2290 diagnosed by this option, and it may give an occasional false positive
2291 result, but in general it has been found fairly effective at detecting
2292 this sort of problem in programs.
2293
2294 The present implementation of this option only works for C programs.  A
2295 future implementation may also work for C++ programs.
2296
2297 The C standard is worded confusingly, therefore there is some debate
2298 over the precise meaning of the sequence point rules in subtle cases.
2299 Links to discussions of the problem, including proposed formal
2300 definitions, may be found on our readings page, at
2301 @w{@uref{http://gcc.gnu.org/readings.html}}.
2302
2303 @item -Wreturn-type
2304 @opindex Wreturn-type
2305 Warn whenever a function is defined with a return-type that defaults to
2306 @code{int}.  Also warn about any @code{return} statement with no
2307 return-value in a function whose return-type is not @code{void}.
2308
2309 For C++, a function without return type always produces a diagnostic
2310 message, even when @option{-Wno-return-type} is specified.  The only
2311 exceptions are @samp{main} and functions defined in system headers.
2312
2313 @item -Wswitch
2314 @opindex Wswitch
2315 Warn whenever a @code{switch} statement has an index of enumeral type
2316 and lacks a @code{case} for one or more of the named codes of that
2317 enumeration.  (The presence of a @code{default} label prevents this
2318 warning.)  @code{case} labels outside the enumeration range also
2319 provoke warnings when this option is used.
2320
2321 @item -Wswitch-default
2322 @opindex Wswitch-switch
2323 Warn whenever a @code{switch} statement does not have a @code{default}
2324 case.
2325
2326 @item -Wswitch-enum
2327 @opindex Wswitch-enum
2328 Warn whenever a @code{switch} statement has an index of enumeral type
2329 and lacks a @code{case} for one or more of the named codes of that
2330 enumeration.  @code{case} labels outside the enumeration range also
2331 provoke warnings when this option is used.
2332
2333 @item -Wtrigraphs
2334 @opindex Wtrigraphs
2335 Warn if any trigraphs are encountered that might change the meaning of
2336 the program (trigraphs within comments are not warned about).
2337
2338 @item -Wunused-function
2339 @opindex Wunused-function
2340 Warn whenever a static function is declared but not defined or a
2341 non\-inline static function is unused.
2342
2343 @item -Wunused-label
2344 @opindex Wunused-label
2345 Warn whenever a label is declared but not used.
2346
2347 To suppress this warning use the @samp{unused} attribute
2348 (@pxref{Variable Attributes}).
2349
2350 @item -Wunused-parameter
2351 @opindex Wunused-parameter
2352 Warn whenever a function parameter is unused aside from its declaration.
2353
2354 To suppress this warning use the @samp{unused} attribute
2355 (@pxref{Variable Attributes}).
2356
2357 @item -Wunused-variable
2358 @opindex Wunused-variable
2359 Warn whenever a local variable or non-constant static variable is unused
2360 aside from its declaration
2361
2362 To suppress this warning use the @samp{unused} attribute
2363 (@pxref{Variable Attributes}).
2364
2365 @item -Wunused-value
2366 @opindex Wunused-value
2367 Warn whenever a statement computes a result that is explicitly not used.
2368
2369 To suppress this warning cast the expression to @samp{void}.
2370
2371 @item -Wunused
2372 @opindex Wunused
2373 All the above @option{-Wunused} options combined.
2374
2375 In order to get a warning about an unused function parameter, you must
2376 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2377 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2378
2379 @item -Wuninitialized
2380 @opindex Wuninitialized
2381 Warn if an automatic variable is used without first being initialized or
2382 if a variable may be clobbered by a @code{setjmp} call.
2383
2384 These warnings are possible only in optimizing compilation,
2385 because they require data flow information that is computed only
2386 when optimizing.  If you don't specify @option{-O}, you simply won't
2387 get these warnings.
2388
2389 If you want to warn about code which uses the uninitialized value of the
2390 variable in its own initializer, use the @option{-Winit-self} option.
2391
2392 These warnings occur only for variables that are candidates for
2393 register allocation.  Therefore, they do not occur for a variable that
2394 is declared @code{volatile}, or whose address is taken, or whose size
2395 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2396 structures, unions or arrays, even when they are in registers.
2397
2398 Note that there may be no warning about a variable that is used only
2399 to compute a value that itself is never used, because such
2400 computations may be deleted by data flow analysis before the warnings
2401 are printed.
2402
2403 These warnings are made optional because GCC is not smart
2404 enough to see all the reasons why the code might be correct
2405 despite appearing to have an error.  Here is one example of how
2406 this can happen:
2407
2408 @smallexample
2409 @group
2410 @{
2411   int x;
2412   switch (y)
2413     @{
2414     case 1: x = 1;
2415       break;
2416     case 2: x = 4;
2417       break;
2418     case 3: x = 5;
2419     @}
2420   foo (x);
2421 @}
2422 @end group
2423 @end smallexample
2424
2425 @noindent
2426 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2427 always initialized, but GCC doesn't know this.  Here is
2428 another common case:
2429
2430 @smallexample
2431 @{
2432   int save_y;
2433   if (change_y) save_y = y, y = new_y;
2434   @dots{}
2435   if (change_y) y = save_y;
2436 @}
2437 @end smallexample
2438
2439 @noindent
2440 This has no bug because @code{save_y} is used only if it is set.
2441
2442 @cindex @code{longjmp} warnings
2443 This option also warns when a non-volatile automatic variable might be
2444 changed by a call to @code{longjmp}.  These warnings as well are possible
2445 only in optimizing compilation.
2446
2447 The compiler sees only the calls to @code{setjmp}.  It cannot know
2448 where @code{longjmp} will be called; in fact, a signal handler could
2449 call it at any point in the code.  As a result, you may get a warning
2450 even when there is in fact no problem because @code{longjmp} cannot
2451 in fact be called at the place which would cause a problem.
2452
2453 Some spurious warnings can be avoided if you declare all the functions
2454 you use that never return as @code{noreturn}.  @xref{Function
2455 Attributes}.
2456
2457 @item -Wunknown-pragmas
2458 @opindex Wunknown-pragmas
2459 @cindex warning for unknown pragmas
2460 @cindex unknown pragmas, warning
2461 @cindex pragmas, warning of unknown
2462 Warn when a #pragma directive is encountered which is not understood by
2463 GCC@.  If this command line option is used, warnings will even be issued
2464 for unknown pragmas in system header files.  This is not the case if
2465 the warnings were only enabled by the @option{-Wall} command line option.
2466
2467 @item -Wstrict-aliasing
2468 @opindex Wstrict-aliasing
2469 This option is only active when @option{-fstrict-aliasing} is active.
2470 It warns about code which might break the strict aliasing rules that the
2471 compiler is using for optimization. The warning does not catch all
2472 cases, but does attempt to catch the more common pitfalls. It is
2473 included in @option{-Wall}.
2474
2475 @item -Wall
2476 @opindex Wall
2477 All of the above @samp{-W} options combined.  This enables all the
2478 warnings about constructions that some users consider questionable, and
2479 that are easy to avoid (or modify to prevent the warning), even in
2480 conjunction with macros.  This also enables some language-specific
2481 warnings described in @ref{C++ Dialect Options} and
2482 @ref{Objective-C Dialect Options}.
2483 @end table
2484
2485 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2486 Some of them warn about constructions that users generally do not
2487 consider questionable, but which occasionally you might wish to check
2488 for; others warn about constructions that are necessary or hard to avoid
2489 in some cases, and there is no simple way to modify the code to suppress
2490 the warning.
2491
2492 @table @gcctabopt
2493 @item -Wextra
2494 @opindex W
2495 @opindex Wextra
2496 (This option used to be called @option{-W}.  The older name is still
2497 supported, but the newer name is more descriptive.)  Print extra warning
2498 messages for these events:
2499
2500 @itemize @bullet
2501 @item
2502 A function can return either with or without a value.  (Falling
2503 off the end of the function body is considered returning without
2504 a value.)  For example, this function would evoke such a
2505 warning:
2506
2507 @smallexample
2508 @group
2509 foo (a)
2510 @{
2511   if (a > 0)
2512     return a;
2513 @}
2514 @end group
2515 @end smallexample
2516
2517 @item
2518 An expression-statement or the left-hand side of a comma expression
2519 contains no side effects.
2520 To suppress the warning, cast the unused expression to void.
2521 For example, an expression such as @samp{x[i,j]} will cause a warning,
2522 but @samp{x[(void)i,j]} will not.
2523
2524 @item
2525 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2526
2527 @item
2528 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2529 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2530 that of ordinary mathematical notation.
2531
2532 @item
2533 Storage-class specifiers like @code{static} are not the first things in
2534 a declaration.  According to the C Standard, this usage is obsolescent.
2535
2536 @item
2537 The return type of a function has a type qualifier such as @code{const}.
2538 Such a type qualifier has no effect, since the value returned by a
2539 function is not an lvalue.  (But don't warn about the GNU extension of
2540 @code{volatile void} return types.  That extension will be warned about
2541 if @option{-pedantic} is specified.)
2542
2543 @item
2544 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2545 arguments.
2546
2547 @item
2548 A comparison between signed and unsigned values could produce an
2549 incorrect result when the signed value is converted to unsigned.
2550 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2551
2552 @item
2553 An aggregate has an initializer which does not initialize all members.
2554 For example, the following code would cause such a warning, because
2555 @code{x.h} would be implicitly initialized to zero:
2556
2557 @smallexample
2558 struct s @{ int f, g, h; @};
2559 struct s x = @{ 3, 4 @};
2560 @end smallexample
2561
2562 @item
2563 A function parameter is declared without a type specifier in K&R-style
2564 functions:
2565
2566 @smallexample
2567 void foo(bar) @{ @}
2568 @end smallexample
2569
2570 @item
2571 An empty body occurs in an @samp{if} or @samp{else} statement.
2572
2573 @item
2574 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2575 @samp{>}, or @samp{>=}.
2576
2577 @item
2578 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2579
2580 @item
2581 Any of several floating-point events that often indicate errors, such as
2582 overflow, underflow, loss of precision, etc.
2583
2584 @item @r{(C++ only)}
2585 An enumerator and a non-enumerator both appear in a conditional expression.
2586
2587 @item @r{(C++ only)}
2588 A non-static reference or non-static @samp{const} member appears in a
2589 class without constructors.
2590
2591 @item @r{(C++ only)}
2592 Ambiguous virtual bases.
2593
2594 @item @r{(C++ only)}
2595 Subscripting an array which has been declared @samp{register}.
2596
2597 @item @r{(C++ only)}
2598 Taking the address of a variable which has been declared @samp{register}.
2599
2600 @item @r{(C++ only)}
2601 A base class is not initialized in a derived class' copy constructor.
2602 @end itemize
2603
2604 @item -Wno-div-by-zero
2605 @opindex Wno-div-by-zero
2606 @opindex Wdiv-by-zero
2607 Do not warn about compile-time integer division by zero.  Floating point
2608 division by zero is not warned about, as it can be a legitimate way of
2609 obtaining infinities and NaNs.
2610
2611 @item -Wsystem-headers
2612 @opindex Wsystem-headers
2613 @cindex warnings from system headers
2614 @cindex system headers, warnings from
2615 Print warning messages for constructs found in system header files.
2616 Warnings from system headers are normally suppressed, on the assumption
2617 that they usually do not indicate real problems and would only make the
2618 compiler output harder to read.  Using this command line option tells
2619 GCC to emit warnings from system headers as if they occurred in user
2620 code.  However, note that using @option{-Wall} in conjunction with this
2621 option will @emph{not} warn about unknown pragmas in system
2622 headers---for that, @option{-Wunknown-pragmas} must also be used.
2623
2624 @item -Wfloat-equal
2625 @opindex Wfloat-equal
2626 Warn if floating point values are used in equality comparisons.
2627
2628 The idea behind this is that sometimes it is convenient (for the
2629 programmer) to consider floating-point values as approximations to
2630 infinitely precise real numbers.  If you are doing this, then you need
2631 to compute (by analyzing the code, or in some other way) the maximum or
2632 likely maximum error that the computation introduces, and allow for it
2633 when performing comparisons (and when producing output, but that's a
2634 different problem).  In particular, instead of testing for equality, you
2635 would check to see whether the two values have ranges that overlap; and
2636 this is done with the relational operators, so equality comparisons are
2637 probably mistaken.
2638
2639 @item -Wtraditional @r{(C only)}
2640 @opindex Wtraditional
2641 Warn about certain constructs that behave differently in traditional and
2642 ISO C@.  Also warn about ISO C constructs that have no traditional C
2643 equivalent, and/or problematic constructs which should be avoided.
2644
2645 @itemize @bullet
2646 @item
2647 Macro parameters that appear within string literals in the macro body.
2648 In traditional C macro replacement takes place within string literals,
2649 but does not in ISO C@.
2650
2651 @item
2652 In traditional C, some preprocessor directives did not exist.
2653 Traditional preprocessors would only consider a line to be a directive
2654 if the @samp{#} appeared in column 1 on the line.  Therefore
2655 @option{-Wtraditional} warns about directives that traditional C
2656 understands but would ignore because the @samp{#} does not appear as the
2657 first character on the line.  It also suggests you hide directives like
2658 @samp{#pragma} not understood by traditional C by indenting them.  Some
2659 traditional implementations would not recognize @samp{#elif}, so it
2660 suggests avoiding it altogether.
2661
2662 @item
2663 A function-like macro that appears without arguments.
2664
2665 @item
2666 The unary plus operator.
2667
2668 @item
2669 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2670 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2671 constants.)  Note, these suffixes appear in macros defined in the system
2672 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2673 Use of these macros in user code might normally lead to spurious
2674 warnings, however gcc's integrated preprocessor has enough context to
2675 avoid warning in these cases.
2676
2677 @item
2678 A function declared external in one block and then used after the end of
2679 the block.
2680
2681 @item
2682 A @code{switch} statement has an operand of type @code{long}.
2683
2684 @item
2685 A non-@code{static} function declaration follows a @code{static} one.
2686 This construct is not accepted by some traditional C compilers.
2687
2688 @item
2689 The ISO type of an integer constant has a different width or
2690 signedness from its traditional type.  This warning is only issued if
2691 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2692 typically represent bit patterns, are not warned about.
2693
2694 @item
2695 Usage of ISO string concatenation is detected.
2696
2697 @item
2698 Initialization of automatic aggregates.
2699
2700 @item
2701 Identifier conflicts with labels.  Traditional C lacks a separate
2702 namespace for labels.
2703
2704 @item
2705 Initialization of unions.  If the initializer is zero, the warning is
2706 omitted.  This is done under the assumption that the zero initializer in
2707 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2708 initializer warnings and relies on default initialization to zero in the
2709 traditional C case.
2710
2711 @item
2712 Conversions by prototypes between fixed/floating point values and vice
2713 versa.  The absence of these prototypes when compiling with traditional
2714 C would cause serious problems.  This is a subset of the possible
2715 conversion warnings, for the full set use @option{-Wconversion}.
2716
2717 @item
2718 Use of ISO C style function definitions.  This warning intentionally is
2719 @emph{not} issued for prototype declarations or variadic functions
2720 because these ISO C features will appear in your code when using
2721 libiberty's traditional C compatibility macros, @code{PARAMS} and
2722 @code{VPARAMS}.  This warning is also bypassed for nested functions
2723 because that feature is already a gcc extension and thus not relevant to
2724 traditional C compatibility.
2725 @end itemize
2726
2727 @item -Wdeclaration-after-statement @r{(C only)}
2728 @opindex Wdeclaration-after-statement
2729 Warn when a declaration is found after a statement in a block.  This
2730 construct, known from C++, was introduced with ISO C99 and is by default
2731 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2732 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2733
2734 @item -Wundef
2735 @opindex Wundef
2736 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2737
2738 @item -Wendif-labels
2739 @opindex Wendif-labels
2740 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2741
2742 @item -Wshadow
2743 @opindex Wshadow
2744 Warn whenever a local variable shadows another local variable, parameter or
2745 global variable or whenever a built-in function is shadowed.
2746
2747 @item -Wlarger-than-@var{len}
2748 @opindex Wlarger-than
2749 Warn whenever an object of larger than @var{len} bytes is defined.
2750
2751 @item -Wpointer-arith
2752 @opindex Wpointer-arith
2753 Warn about anything that depends on the ``size of'' a function type or
2754 of @code{void}.  GNU C assigns these types a size of 1, for
2755 convenience in calculations with @code{void *} pointers and pointers
2756 to functions.
2757
2758 @item -Wbad-function-cast @r{(C only)}
2759 @opindex Wbad-function-cast
2760 Warn whenever a function call is cast to a non-matching type.
2761 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2762
2763 @item -Wcast-qual
2764 @opindex Wcast-qual
2765 Warn whenever a pointer is cast so as to remove a type qualifier from
2766 the target type.  For example, warn if a @code{const char *} is cast
2767 to an ordinary @code{char *}.
2768
2769 @item -Wcast-align
2770 @opindex Wcast-align
2771 Warn whenever a pointer is cast such that the required alignment of the
2772 target is increased.  For example, warn if a @code{char *} is cast to
2773 an @code{int *} on machines where integers can only be accessed at
2774 two- or four-byte boundaries.
2775
2776 @item -Wwrite-strings
2777 @opindex Wwrite-strings
2778 When compiling C, give string constants the type @code{const
2779 char[@var{length}]} so that
2780 copying the address of one into a non-@code{const} @code{char *}
2781 pointer will get a warning; when compiling C++, warn about the
2782 deprecated conversion from string constants to @code{char *}.
2783 These warnings will help you find at
2784 compile time code that can try to write into a string constant, but
2785 only if you have been very careful about using @code{const} in
2786 declarations and prototypes.  Otherwise, it will just be a nuisance;
2787 this is why we did not make @option{-Wall} request these warnings.
2788
2789 @item -Wconversion
2790 @opindex Wconversion
2791 Warn if a prototype causes a type conversion that is different from what
2792 would happen to the same argument in the absence of a prototype.  This
2793 includes conversions of fixed point to floating and vice versa, and
2794 conversions changing the width or signedness of a fixed point argument
2795 except when the same as the default promotion.
2796
2797 Also, warn if a negative integer constant expression is implicitly
2798 converted to an unsigned type.  For example, warn about the assignment
2799 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2800 casts like @code{(unsigned) -1}.
2801
2802 @item -Wsign-compare
2803 @opindex Wsign-compare
2804 @cindex warning for comparison of signed and unsigned values
2805 @cindex comparison of signed and unsigned values, warning
2806 @cindex signed and unsigned values, comparison warning
2807 Warn when a comparison between signed and unsigned values could produce
2808 an incorrect result when the signed value is converted to unsigned.
2809 This warning is also enabled by @option{-Wextra}; to get the other warnings
2810 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2811
2812 @item -Waggregate-return
2813 @opindex Waggregate-return
2814 Warn if any functions that return structures or unions are defined or
2815 called.  (In languages where you can return an array, this also elicits
2816 a warning.)
2817
2818 @item -Wstrict-prototypes @r{(C only)}
2819 @opindex Wstrict-prototypes
2820 Warn if a function is declared or defined without specifying the
2821 argument types.  (An old-style function definition is permitted without
2822 a warning if preceded by a declaration which specifies the argument
2823 types.)
2824
2825 @item -Wold-style-definition @r{(C only)}
2826 @opindex Wold-style-definition
2827 Warn if an old-style function definition is used.  A warning is given
2828 even if there is a previous prototype.
2829
2830 @item -Wmissing-prototypes @r{(C only)}
2831 @opindex Wmissing-prototypes
2832 Warn if a global function is defined without a previous prototype
2833 declaration.  This warning is issued even if the definition itself
2834 provides a prototype.  The aim is to detect global functions that fail
2835 to be declared in header files.
2836
2837 @item -Wmissing-declarations @r{(C only)}
2838 @opindex Wmissing-declarations
2839 Warn if a global function is defined without a previous declaration.
2840 Do so even if the definition itself provides a prototype.
2841 Use this option to detect global functions that are not declared in
2842 header files.
2843
2844 @item -Wmissing-noreturn
2845 @opindex Wmissing-noreturn
2846 Warn about functions which might be candidates for attribute @code{noreturn}.
2847 Note these are only possible candidates, not absolute ones.  Care should
2848 be taken to manually verify functions actually do not ever return before
2849 adding the @code{noreturn} attribute, otherwise subtle code generation
2850 bugs could be introduced.  You will not get a warning for @code{main} in
2851 hosted C environments.
2852
2853 @item -Wmissing-format-attribute
2854 @opindex Wmissing-format-attribute
2855 @opindex Wformat
2856 If @option{-Wformat} is enabled, also warn about functions which might be
2857 candidates for @code{format} attributes.  Note these are only possible
2858 candidates, not absolute ones.  GCC will guess that @code{format}
2859 attributes might be appropriate for any function that calls a function
2860 like @code{vprintf} or @code{vscanf}, but this might not always be the
2861 case, and some functions for which @code{format} attributes are
2862 appropriate may not be detected.  This option has no effect unless
2863 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2864
2865 @item -Wno-multichar
2866 @opindex Wno-multichar
2867 @opindex Wmultichar
2868 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2869 Usually they indicate a typo in the user's code, as they have
2870 implementation-defined values, and should not be used in portable code.
2871
2872 @item -Wno-deprecated-declarations
2873 @opindex Wno-deprecated-declarations
2874 Do not warn about uses of functions, variables, and types marked as
2875 deprecated by using the @code{deprecated} attribute.
2876 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2877 @pxref{Type Attributes}.)
2878
2879 @item -Wpacked
2880 @opindex Wpacked
2881 Warn if a structure is given the packed attribute, but the packed
2882 attribute has no effect on the layout or size of the structure.
2883 Such structures may be mis-aligned for little benefit.  For
2884 instance, in this code, the variable @code{f.x} in @code{struct bar}
2885 will be misaligned even though @code{struct bar} does not itself
2886 have the packed attribute:
2887
2888 @smallexample
2889 @group
2890 struct foo @{
2891   int x;
2892   char a, b, c, d;
2893 @} __attribute__((packed));
2894 struct bar @{
2895   char z;
2896   struct foo f;
2897 @};
2898 @end group
2899 @end smallexample
2900
2901 @item -Wpadded
2902 @opindex Wpadded
2903 Warn if padding is included in a structure, either to align an element
2904 of the structure or to align the whole structure.  Sometimes when this
2905 happens it is possible to rearrange the fields of the structure to
2906 reduce the padding and so make the structure smaller.
2907
2908 @item -Wredundant-decls
2909 @opindex Wredundant-decls
2910 Warn if anything is declared more than once in the same scope, even in
2911 cases where multiple declaration is valid and changes nothing.
2912
2913 @item -Wnested-externs @r{(C only)}
2914 @opindex Wnested-externs
2915 Warn if an @code{extern} declaration is encountered within a function.
2916
2917 @item -Wunreachable-code
2918 @opindex Wunreachable-code
2919 Warn if the compiler detects that code will never be executed.
2920
2921 This option is intended to warn when the compiler detects that at
2922 least a whole line of source code will never be executed, because
2923 some condition is never satisfied or because it is after a
2924 procedure that never returns.
2925
2926 It is possible for this option to produce a warning even though there
2927 are circumstances under which part of the affected line can be executed,
2928 so care should be taken when removing apparently-unreachable code.
2929
2930 For instance, when a function is inlined, a warning may mean that the
2931 line is unreachable in only one inlined copy of the function.
2932
2933 This option is not made part of @option{-Wall} because in a debugging
2934 version of a program there is often substantial code which checks
2935 correct functioning of the program and is, hopefully, unreachable
2936 because the program does work.  Another common use of unreachable
2937 code is to provide behavior which is selectable at compile-time.
2938
2939 @item -Winline
2940 @opindex Winline
2941 Warn if a function can not be inlined and it was declared as inline.
2942 Even with this option, the compiler will not warn about failures to
2943 inline functions declared in system headers.  
2944
2945 The compiler uses a variety of heuristics to determine whether or not
2946 to inline a function.  For example, the compiler takes into account
2947 the size of the function being inlined and the the amount of inlining
2948 that has already been done in the current function.  Therefore,
2949 seemingly insignificant changes in the source program can cause the
2950 warnings produced by @option{-Winline} to appear or disappear.
2951
2952 @item -Wno-invalid-offsetof @r{(C++ only)}
2953 @opindex Wno-invalid-offsetof
2954 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2955 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2956 to a non-POD type is undefined.  In existing C++ implementations,
2957 however, @samp{offsetof} typically gives meaningful results even when
2958 applied to certain kinds of non-POD types. (Such as a simple
2959 @samp{struct} that fails to be a POD type only by virtue of having a
2960 constructor.)  This flag is for users who are aware that they are
2961 writing nonportable code and who have deliberately chosen to ignore the
2962 warning about it.
2963
2964 The restrictions on @samp{offsetof} may be relaxed in a future version
2965 of the C++ standard.
2966
2967 @item -Winvalid-pch
2968 @opindex Winvalid-pch
2969 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2970 the search path but can't be used.
2971
2972 @item -Wlong-long
2973 @opindex Wlong-long
2974 @opindex Wno-long-long
2975 Warn if @samp{long long} type is used.  This is default.  To inhibit
2976 the warning messages, use @option{-Wno-long-long}.  Flags
2977 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2978 only when @option{-pedantic} flag is used.
2979
2980 @item -Wdisabled-optimization
2981 @opindex Wdisabled-optimization
2982 Warn if a requested optimization pass is disabled.  This warning does
2983 not generally indicate that there is anything wrong with your code; it
2984 merely indicates that GCC's optimizers were unable to handle the code
2985 effectively.  Often, the problem is that your code is too big or too
2986 complex; GCC will refuse to optimize programs when the optimization
2987 itself is likely to take inordinate amounts of time.
2988
2989 @item -Werror
2990 @opindex Werror
2991 Make all warnings into errors.
2992 @end table
2993
2994 @node Debugging Options
2995 @section Options for Debugging Your Program or GCC
2996 @cindex options, debugging
2997 @cindex debugging information options
2998
2999 GCC has various special options that are used for debugging
3000 either your program or GCC:
3001
3002 @table @gcctabopt
3003 @item -g
3004 @opindex g
3005 Produce debugging information in the operating system's native format
3006 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3007 information.
3008
3009 On most systems that use stabs format, @option{-g} enables use of extra
3010 debugging information that only GDB can use; this extra information
3011 makes debugging work better in GDB but will probably make other debuggers
3012 crash or
3013 refuse to read the program.  If you want to control for certain whether
3014 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3015 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3016
3017 Unlike most other C compilers, GCC allows you to use @option{-g} with
3018 @option{-O}.  The shortcuts taken by optimized code may occasionally
3019 produce surprising results: some variables you declared may not exist
3020 at all; flow of control may briefly move where you did not expect it;
3021 some statements may not be executed because they compute constant
3022 results or their values were already at hand; some statements may
3023 execute in different places because they were moved out of loops.
3024
3025 Nevertheless it proves possible to debug optimized output.  This makes
3026 it reasonable to use the optimizer for programs that might have bugs.
3027
3028 The following options are useful when GCC is generated with the
3029 capability for more than one debugging format.
3030
3031 @item -ggdb
3032 @opindex ggdb
3033 Produce debugging information for use by GDB@.  This means to use the
3034 most expressive format available (DWARF 2, stabs, or the native format
3035 if neither of those are supported), including GDB extensions if at all
3036 possible.
3037
3038 @item -gstabs
3039 @opindex gstabs
3040 Produce debugging information in stabs format (if that is supported),
3041 without GDB extensions.  This is the format used by DBX on most BSD
3042 systems.  On MIPS, Alpha and System V Release 4 systems this option
3043 produces stabs debugging output which is not understood by DBX or SDB@.
3044 On System V Release 4 systems this option requires the GNU assembler.
3045
3046 @item -feliminate-unused-debug-symbols
3047 @opindex feliminate-unused-debug-symbols
3048 Produce debugging information in stabs format (if that is supported),
3049 for only symbols that are actually used.
3050
3051 @item -gstabs+
3052 @opindex gstabs+
3053 Produce debugging information in stabs format (if that is supported),
3054 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3055 use of these extensions is likely to make other debuggers crash or
3056 refuse to read the program.
3057
3058 @item -gcoff
3059 @opindex gcoff
3060 Produce debugging information in COFF format (if that is supported).
3061 This is the format used by SDB on most System V systems prior to
3062 System V Release 4.
3063
3064 @item -gxcoff
3065 @opindex gxcoff
3066 Produce debugging information in XCOFF format (if that is supported).
3067 This is the format used by the DBX debugger on IBM RS/6000 systems.
3068
3069 @item -gxcoff+
3070 @opindex gxcoff+
3071 Produce debugging information in XCOFF format (if that is supported),
3072 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3073 use of these extensions is likely to make other debuggers crash or
3074 refuse to read the program, and may cause assemblers other than the GNU
3075 assembler (GAS) to fail with an error.
3076
3077 @item -gdwarf-2
3078 @opindex gdwarf-2
3079 Produce debugging information in DWARF version 2 format (if that is
3080 supported).  This is the format used by DBX on IRIX 6.
3081
3082 @item -gvms
3083 @opindex gvms
3084 Produce debugging information in VMS debug format (if that is
3085 supported).  This is the format used by DEBUG on VMS systems.
3086
3087 @item -g@var{level}
3088 @itemx -ggdb@var{level}
3089 @itemx -gstabs@var{level}
3090 @itemx -gcoff@var{level}
3091 @itemx -gxcoff@var{level}
3092 @itemx -gvms@var{level}
3093 Request debugging information and also use @var{level} to specify how
3094 much information.  The default level is 2.
3095
3096 Level 1 produces minimal information, enough for making backtraces in
3097 parts of the program that you don't plan to debug.  This includes
3098 descriptions of functions and external variables, but no information
3099 about local variables and no line numbers.
3100
3101 Level 3 includes extra information, such as all the macro definitions
3102 present in the program.  Some debuggers support macro expansion when
3103 you use @option{-g3}.
3104
3105 Note that in order to avoid confusion between DWARF1 debug level 2,
3106 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3107 level.  Instead use an additional @option{-g@var{level}} option to
3108 change the debug level for DWARF2.
3109
3110 @item -feliminate-dwarf2-dups
3111 @opindex feliminate-dwarf2-dups
3112 Compress DWARF2 debugging information by eliminating duplicated
3113 information about each symbol.  This option only makes sense when
3114 generating DWARF2 debugging information with @option{-gdwarf-2}.
3115
3116 @cindex @command{prof}
3117 @item -p
3118 @opindex p
3119 Generate extra code to write profile information suitable for the
3120 analysis program @command{prof}.  You must use this option when compiling
3121 the source files you want data about, and you must also use it when
3122 linking.
3123
3124 @cindex @command{gprof}
3125 @item -pg
3126 @opindex pg
3127 Generate extra code to write profile information suitable for the
3128 analysis program @command{gprof}.  You must use this option when compiling
3129 the source files you want data about, and you must also use it when
3130 linking.
3131
3132 @item -Q
3133 @opindex Q
3134 Makes the compiler print out each function name as it is compiled, and
3135 print some statistics about each pass when it finishes.
3136
3137 @item -ftime-report
3138 @opindex ftime-report
3139 Makes the compiler print some statistics about the time consumed by each
3140 pass when it finishes.
3141
3142 @item -fmem-report
3143 @opindex fmem-report
3144 Makes the compiler print some statistics about permanent memory
3145 allocation when it finishes.
3146
3147 @item -fprofile-arcs
3148 @opindex fprofile-arcs
3149 Add code so that program flow @dfn{arcs} are instrumented.  During
3150 execution the program records how many times each branch and call is
3151 executed and how many times it is taken or returns.  When the compiled
3152 program exits it saves this data to a file called
3153 @file{@var{auxname}.gcda} for each source file. The data may be used for
3154 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3155 test coverage analysis (@option{-ftest-coverage}). Each object file's
3156 @var{auxname} is generated from the name of the output file, if
3157 explicitly specified and it is not the final executable, otherwise it is
3158 the basename of the source file. In both cases any suffix is removed
3159 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3160 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3161
3162 @itemize
3163
3164 @item
3165 Compile the source files with @option{-fprofile-arcs} plus optimization
3166 and code generation options. For test coverage analysis, use the
3167 additional @option{-ftest-coverage} option. You do not need to profile
3168 every source file in a program.
3169
3170 @item
3171 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3172 (the latter implies the former).
3173
3174 @item
3175 Run the program on a representative workload to generate the arc profile
3176 information. This may be repeated any number of times. You can run
3177 concurrent instances of your program, and provided that the file system
3178 supports locking, the data files will be correctly updated. Also
3179 @code{fork} calls are detected and correctly handled (double counting
3180 will not happen).
3181
3182 @item
3183 For profile-directed optimizations, compile the source files again with
3184 the same optimization and code generation options plus
3185 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3186 Control Optimization}).
3187
3188 @item
3189 For test coverage analysis, use @command{gcov} to produce human readable
3190 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3191 @command{gcov} documentation for further information.
3192
3193 @end itemize
3194
3195 With @option{-fprofile-arcs}, for each function of your program GCC
3196 creates a program flow graph, then finds a spanning tree for the graph.
3197 Only arcs that are not on the spanning tree have to be instrumented: the
3198 compiler adds code to count the number of times that these arcs are
3199 executed.  When an arc is the only exit or only entrance to a block, the
3200 instrumentation code can be added to the block; otherwise, a new basic
3201 block must be created to hold the instrumentation code.
3202
3203 @need 2000
3204 @item -ftest-coverage
3205 @opindex ftest-coverage
3206 Produce a notes file that the @command{gcov} code-coverage utility
3207 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3208 show program coverage. Each source file's note file is called
3209 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3210 above for a description of @var{auxname} and instructions on how to
3211 generate test coverage data. Coverage data will match the source files
3212 more closely, if you do not optimize.
3213
3214 @item -d@var{letters}
3215 @opindex d
3216 Says to make debugging dumps during compilation at times specified by
3217 @var{letters}.  This is used for debugging the compiler.  The file names
3218 for most of the dumps are made by appending a pass number and a word to
3219 the @var{dumpname}. @var{dumpname} is generated from the name of the
3220 output file, if explicitly specified and it is not an executable,
3221 otherwise it is the basename of the source file. In both cases any
3222 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3223 Here are the possible letters for use in @var{letters}, and their
3224 meanings:
3225
3226 @table @samp
3227 @item A
3228 @opindex dA
3229 Annotate the assembler output with miscellaneous debugging information.
3230 @item b
3231 @opindex db
3232 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3233 @item B
3234 @opindex dB
3235 Dump after block reordering, to @file{@var{file}.30.bbro}.
3236 @item c
3237 @opindex dc
3238 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3239 @item C
3240 @opindex dC
3241 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3242 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3243 @item d
3244 @opindex dd
3245 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3246 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3247 @item D
3248 @opindex dD
3249 Dump all macro definitions, at the end of preprocessing, in addition to
3250 normal output.
3251 @item E
3252 @opindex dE
3253 Dump after the second if conversion, to @file{@var{file}.31.ce3}.
3254 @item f
3255 @opindex df
3256 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3257 Also dump after life analysis, to @file{@var{file}.19.life}.
3258 @item F
3259 @opindex dF
3260 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3261 @item g
3262 @opindex dg
3263 Dump after global register allocation, to @file{@var{file}.25.greg}.
3264 @item G
3265 @opindex dG
3266 Dump after GCSE, to @file{@var{file}.08.gcse}.
3267 Also dump after jump bypassing and control flow optimizations, to
3268 @file{@var{file}.10.bypass}.
3269 @item h
3270 @opindex dh
3271 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3272 @item i
3273 @opindex di
3274 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3275 @item j
3276 @opindex dj
3277 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3278 @item k
3279 @opindex dk
3280 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3281 @item l
3282 @opindex dl
3283 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3284 @item L
3285 @opindex dL
3286 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3287 @file{@var{file}.16.loop2}.
3288 @item M
3289 @opindex dM
3290 Dump after performing the machine dependent reorganization pass, to
3291 @file{@var{file}.35.mach}.
3292 @item n
3293 @opindex dn
3294 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3295 @item N
3296 @opindex dN
3297 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3298 @item o
3299 @opindex do
3300 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3301 @item r
3302 @opindex dr
3303 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3304 @item R
3305 @opindex dR
3306 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3307 @item s
3308 @opindex ds
3309 Dump after CSE (including the jump optimization that sometimes follows
3310 CSE), to @file{@var{file}.06.cse}.
3311 @item S
3312 @opindex dS
3313 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3314 @item t
3315 @opindex dt
3316 Dump after the second CSE pass (including the jump optimization that
3317 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3318 @item T
3319 @opindex dT
3320 Dump after running tracer, to @file{@var{file}.15.tracer}.
3321 @item u
3322 @opindex du
3323 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3324 @item U
3325 @opindex dU
3326 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3327 @item V
3328 @opindex dV
3329 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3330 @item w
3331 @opindex dw
3332 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3333 @item z
3334 @opindex dz
3335 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3336 @item Z
3337 @opindex dZ
3338 Dump after constructing the web, to @file{@var{file}.17.web}.
3339 @item a
3340 @opindex da
3341 Produce all the dumps listed above.
3342 @item H
3343 @opindex dH
3344 Produce a core dump whenever an error occurs.
3345 @item m
3346 @opindex dm
3347 Print statistics on memory usage, at the end of the run, to
3348 standard error.
3349 @item p
3350 @opindex dp
3351 Annotate the assembler output with a comment indicating which
3352 pattern and alternative was used.  The length of each instruction is
3353 also printed.
3354 @item P
3355 @opindex dP
3356 Dump the RTL in the assembler output as a comment before each instruction.
3357 Also turns on @option{-dp} annotation.
3358 @item v
3359 @opindex dv
3360 For each of the other indicated dump files (except for
3361 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3362 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3363 @item x
3364 @opindex dx
3365 Just generate RTL for a function instead of compiling it.  Usually used
3366 with @samp{r}.
3367 @item y
3368 @opindex dy
3369 Dump debugging information during parsing, to standard error.
3370 @end table
3371
3372 @item -fdump-unnumbered
3373 @opindex fdump-unnumbered
3374 When doing debugging dumps (see @option{-d} option above), suppress instruction
3375 numbers and line number note output.  This makes it more feasible to
3376 use diff on debugging dumps for compiler invocations with different
3377 options, in particular with and without @option{-g}.
3378
3379 @item -fdump-translation-unit @r{(C and C++ only)}
3380 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3381 @opindex fdump-translation-unit
3382 Dump a representation of the tree structure for the entire translation
3383 unit to a file.  The file name is made by appending @file{.tu} to the
3384 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3385 controls the details of the dump as described for the
3386 @option{-fdump-tree} options.
3387
3388 @item -fdump-class-hierarchy @r{(C++ only)}
3389 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3390 @opindex fdump-class-hierarchy
3391 Dump a representation of each class's hierarchy and virtual function
3392 table layout to a file.  The file name is made by appending @file{.class}
3393 to the source file name.  If the @samp{-@var{options}} form is used,
3394 @var{options} controls the details of the dump as described for the
3395 @option{-fdump-tree} options.
3396
3397 @item -fdump-tree-@var{switch} @r{(C++ only)}
3398 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3399 @opindex fdump-tree
3400 Control the dumping at various stages of processing the intermediate
3401 language tree to a file.  The file name is generated by appending a switch
3402 specific suffix to the source file name.  If the @samp{-@var{options}}
3403 form is used, @var{options} is a list of @samp{-} separated options that
3404 control the details of the dump. Not all options are applicable to all
3405 dumps, those which are not meaningful will be ignored. The following
3406 options are available
3407
3408 @table @samp
3409 @item address
3410 Print the address of each node.  Usually this is not meaningful as it
3411 changes according to the environment and source file. Its primary use
3412 is for tying up a dump file with a debug environment.
3413 @item slim
3414 Inhibit dumping of members of a scope or body of a function merely
3415 because that scope has been reached. Only dump such items when they
3416 are directly reachable by some other path.
3417 @item all
3418 Turn on all options.
3419 @end table
3420
3421 The following tree dumps are possible:
3422 @table @samp
3423 @item original
3424 Dump before any tree based optimization, to @file{@var{file}.original}.
3425 @item optimized
3426 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3427 @item inlined
3428 Dump after function inlining, to @file{@var{file}.inlined}.
3429 @end table
3430
3431 @item -frandom-seed=@var{string}
3432 @opindex frandom-string
3433 This option provides a seed that GCC uses when it would otherwise use
3434 random numbers.  It is used to generate certain symbol names
3435 that have to be different in every compiled file. It is also used to
3436 place unique stamps in coverage data files and the object files that
3437 produce them. You can use the @option{-frandom-seed} option to produce
3438 reproducibly identical object files.
3439
3440 The @var{string} should be different for every file you compile.
3441
3442 @item -fsched-verbose=@var{n}
3443 @opindex fsched-verbose
3444 On targets that use instruction scheduling, this option controls the
3445 amount of debugging output the scheduler prints.  This information is
3446 written to standard error, unless @option{-dS} or @option{-dR} is
3447 specified, in which case it is output to the usual dump
3448 listing file, @file{.sched} or @file{.sched2} respectively.  However
3449 for @var{n} greater than nine, the output is always printed to standard
3450 error.
3451
3452 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3453 same information as @option{-dRS}.  For @var{n} greater than one, it
3454 also output basic block probabilities, detailed ready list information
3455 and unit/insn info.  For @var{n} greater than two, it includes RTL
3456 at abort point, control-flow and regions info.  And for @var{n} over
3457 four, @option{-fsched-verbose} also includes dependence info.
3458
3459 @item -save-temps
3460 @opindex save-temps
3461 Store the usual ``temporary'' intermediate files permanently; place them
3462 in the current directory and name them based on the source file.  Thus,
3463 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3464 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3465 preprocessed @file{foo.i} output file even though the compiler now
3466 normally uses an integrated preprocessor.
3467
3468 @item -time
3469 @opindex time
3470 Report the CPU time taken by each subprocess in the compilation
3471 sequence.  For C source files, this is the compiler proper and assembler
3472 (plus the linker if linking is done).  The output looks like this:
3473
3474 @smallexample
3475 # cc1 0.12 0.01
3476 # as 0.00 0.01
3477 @end smallexample
3478
3479 The first number on each line is the ``user time,'' that is time spent
3480 executing the program itself.  The second number is ``system time,''
3481 time spent executing operating system routines on behalf of the program.
3482 Both numbers are in seconds.
3483
3484 @item -print-file-name=@var{library}
3485 @opindex print-file-name
3486 Print the full absolute name of the library file @var{library} that
3487 would be used when linking---and don't do anything else.  With this
3488 option, GCC does not compile or link anything; it just prints the
3489 file name.
3490
3491 @item -print-multi-directory
3492 @opindex print-multi-directory
3493 Print the directory name corresponding to the multilib selected by any
3494 other switches present in the command line.  This directory is supposed
3495 to exist in @env{GCC_EXEC_PREFIX}.
3496
3497 @item -print-multi-lib
3498 @opindex print-multi-lib
3499 Print the mapping from multilib directory names to compiler switches
3500 that enable them.  The directory name is separated from the switches by
3501 @samp{;}, and each switch starts with an @samp{@@} instead of the
3502 @samp{-}, without spaces between multiple switches.  This is supposed to
3503 ease shell-processing.
3504
3505 @item -print-prog-name=@var{program}
3506 @opindex print-prog-name
3507 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3508
3509 @item -print-libgcc-file-name
3510 @opindex print-libgcc-file-name
3511 Same as @option{-print-file-name=libgcc.a}.
3512
3513 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3514 but you do want to link with @file{libgcc.a}.  You can do
3515
3516 @example
3517 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3518 @end example
3519
3520 @item -print-search-dirs
3521 @opindex print-search-dirs
3522 Print the name of the configured installation directory and a list of
3523 program and library directories gcc will search---and don't do anything else.
3524
3525 This is useful when gcc prints the error message
3526 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3527 To resolve this you either need to put @file{cpp0} and the other compiler
3528 components where gcc expects to find them, or you can set the environment
3529 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3530 Don't forget the trailing '/'.
3531 @xref{Environment Variables}.
3532
3533 @item -dumpmachine
3534 @opindex dumpmachine
3535 Print the compiler's target machine (for example,
3536 @samp{i686-pc-linux-gnu})---and don't do anything else.
3537
3538 @item -dumpversion
3539 @opindex dumpversion
3540 Print the compiler version (for example, @samp{3.0})---and don't do
3541 anything else.
3542
3543 @item -dumpspecs
3544 @opindex dumpspecs
3545 Print the compiler's built-in specs---and don't do anything else.  (This
3546 is used when GCC itself is being built.)  @xref{Spec Files}.
3547
3548 @item -feliminate-unused-debug-types
3549 @opindex feliminate-unused-debug-types
3550 Normally, when producing DWARF2 output, GCC will emit debugging
3551 information for all types declared in a compilation
3552 unit, regardless of whether or not they are actually used
3553 in that compilation unit.  Sometimes this is useful, such as
3554 if, in the debugger, you want to cast a value to a type that is
3555 not actually used in your program (but is declared).  More often,
3556 however, this results in a significant amount of wasted space.
3557 With this option, GCC will avoid producing debug symbol output
3558 for types that are nowhere used in the source file being compiled.
3559 @end table
3560
3561 @node Optimize Options
3562 @section Options That Control Optimization
3563 @cindex optimize options
3564 @cindex options, optimization
3565
3566 These options control various sorts of optimizations.
3567
3568 Without any optimization option, the compiler's goal is to reduce the
3569 cost of compilation and to make debugging produce the expected
3570 results.  Statements are independent: if you stop the program with a
3571 breakpoint between statements, you can then assign a new value to any
3572 variable or change the program counter to any other statement in the
3573 function and get exactly the results you would expect from the source
3574 code.
3575
3576 Turning on optimization flags makes the compiler attempt to improve
3577 the performance and/or code size at the expense of compilation time
3578 and possibly the ability to debug the program.
3579
3580 The compiler performs optimisation based on the knowledge it has of
3581 the program.  Using the @option{-funit-at-a-time} flag will allow the
3582 compiler to consider information gained from later functions in the
3583 file when compiling a function.  Compiling multiple files at once to a
3584 single output file (and using @option{-funit-at-a-time}) will allow
3585 the compiler to use information gained from all of the files when
3586 compiling each of them.
3587
3588 Not all optimizations are controlled directly by a flag.  Only
3589 optimizations that have a flag are listed.
3590
3591 @table @gcctabopt
3592 @item -O
3593 @itemx -O1
3594 @opindex O
3595 @opindex O1
3596 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3597 more memory for a large function.
3598
3599 With @option{-O}, the compiler tries to reduce code size and execution
3600 time, without performing any optimizations that take a great deal of
3601 compilation time.
3602
3603 @option{-O} turns on the following optimization flags: 
3604 @gccoptlist{-fdefer-pop @gol
3605 -fmerge-constants @gol
3606 -fthread-jumps @gol
3607 -floop-optimize @gol
3608 -fif-conversion @gol
3609 -fif-conversion2 @gol
3610 -fdelayed-branch @gol
3611 -fguess-branch-probability @gol
3612 -fcprop-registers}
3613
3614 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3615 where doing so does not interfere with debugging.
3616
3617 @item -O2
3618 @opindex O2
3619 Optimize even more.  GCC performs nearly all supported optimizations
3620 that do not involve a space-speed tradeoff.  The compiler does not
3621 perform loop unrolling or function inlining when you specify @option{-O2}.
3622 As compared to @option{-O}, this option increases both compilation time
3623 and the performance of the generated code.
3624
3625 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3626 also turns on the following optimization flags:
3627 @gccoptlist{-fforce-mem @gol
3628 -foptimize-sibling-calls @gol
3629 -fstrength-reduce @gol
3630 -fcse-follow-jumps  -fcse-skip-blocks @gol
3631 -frerun-cse-after-loop  -frerun-loop-opt @gol
3632 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3633 -fdelete-null-pointer-checks @gol
3634 -fexpensive-optimizations @gol
3635 -fregmove @gol
3636 -fschedule-insns  -fschedule-insns2 @gol
3637 -fsched-interblock  -fsched-spec @gol
3638 -fcaller-saves @gol
3639 -fpeephole2 @gol
3640 -freorder-blocks  -freorder-functions @gol
3641 -fstrict-aliasing @gol
3642 -funit-at-a-time @gol
3643 -falign-functions  -falign-jumps @gol
3644 -falign-loops  -falign-labels @gol
3645 -fcrossjumping}
3646
3647 Please note the warning under @option{-fgcse} about
3648 invoking @option{-O2} on programs that use computed gotos.
3649
3650 @item -O3
3651 @opindex O3
3652 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3653 @option{-O2} and also turns on the @option{-finline-functions},
3654 @option{-fweb} and @option{-frename-registers} options.
3655
3656 @item -O0
3657 @opindex O0
3658 Do not optimize.  This is the default.
3659
3660 @item -Os
3661 @opindex Os
3662 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3663 do not typically increase code size.  It also performs further
3664 optimizations designed to reduce code size.
3665
3666 @option{-Os} disables the following optimization flags:
3667 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3668 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3669
3670 If you use multiple @option{-O} options, with or without level numbers,
3671 the last such option is the one that is effective.
3672 @end table
3673
3674 Options of the form @option{-f@var{flag}} specify machine-independent
3675 flags.  Most flags have both positive and negative forms; the negative
3676 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3677 below, only one of the forms is listed---the one you typically will
3678 use.  You can figure out the other form by either removing @samp{no-}
3679 or adding it.
3680
3681 The following options control specific optimizations.  They are either
3682 activated by @option{-O} options or are related to ones that are.  You
3683 can use the following flags in the rare cases when ``fine-tuning'' of
3684 optimizations to be performed is desired.
3685
3686 @table @gcctabopt
3687 @item -fno-default-inline
3688 @opindex fno-default-inline
3689 Do not make member functions inline by default merely because they are
3690 defined inside the class scope (C++ only).  Otherwise, when you specify
3691 @w{@option{-O}}, member functions defined inside class scope are compiled
3692 inline by default; i.e., you don't need to add @samp{inline} in front of
3693 the member function name.
3694
3695 @item -fno-defer-pop
3696 @opindex fno-defer-pop
3697 Always pop the arguments to each function call as soon as that function
3698 returns.  For machines which must pop arguments after a function call,
3699 the compiler normally lets arguments accumulate on the stack for several
3700 function calls and pops them all at once.
3701
3702 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3703
3704 @item -fforce-mem
3705 @opindex fforce-mem
3706 Force memory operands to be copied into registers before doing
3707 arithmetic on them.  This produces better code by making all memory
3708 references potential common subexpressions.  When they are not common
3709 subexpressions, instruction combination should eliminate the separate
3710 register-load.
3711
3712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3713
3714 @item -fforce-addr
3715 @opindex fforce-addr
3716 Force memory address constants to be copied into registers before
3717 doing arithmetic on them.  This may produce better code just as
3718 @option{-fforce-mem} may.
3719
3720 @item -fomit-frame-pointer
3721 @opindex fomit-frame-pointer
3722 Don't keep the frame pointer in a register for functions that
3723 don't need one.  This avoids the instructions to save, set up and
3724 restore frame pointers; it also makes an extra register available
3725 in many functions.  @strong{It also makes debugging impossible on
3726 some machines.}
3727
3728 On some machines, such as the VAX, this flag has no effect, because
3729 the standard calling sequence automatically handles the frame pointer
3730 and nothing is saved by pretending it doesn't exist.  The
3731 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3732 whether a target machine supports this flag.  @xref{Registers,,Register
3733 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3734
3735 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3736
3737 @item -foptimize-sibling-calls
3738 @opindex foptimize-sibling-calls
3739 Optimize sibling and tail recursive calls.
3740
3741 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3742
3743 @item -fno-inline
3744 @opindex fno-inline
3745 Don't pay attention to the @code{inline} keyword.  Normally this option
3746 is used to keep the compiler from expanding any functions inline.
3747 Note that if you are not optimizing, no functions can be expanded inline.
3748
3749 @item -finline-functions
3750 @opindex finline-functions
3751 Integrate all simple functions into their callers.  The compiler
3752 heuristically decides which functions are simple enough to be worth
3753 integrating in this way.
3754
3755 If all calls to a given function are integrated, and the function is
3756 declared @code{static}, then the function is normally not output as
3757 assembler code in its own right.
3758
3759 Enabled at level @option{-O3}.
3760
3761 @item -finline-limit=@var{n}
3762 @opindex finline-limit
3763 By default, gcc limits the size of functions that can be inlined.  This flag
3764 allows the control of this limit for functions that are explicitly marked as
3765 inline (i.e., marked with the inline keyword or defined within the class
3766 definition in c++).  @var{n} is the size of functions that can be inlined in
3767 number of pseudo instructions (not counting parameter handling).  The default
3768 value of @var{n} is 600.
3769 Increasing this value can result in more inlined code at
3770 the cost of compilation time and memory consumption.  Decreasing usually makes
3771 the compilation faster and less code will be inlined (which presumably
3772 means slower programs).  This option is particularly useful for programs that
3773 use inlining heavily such as those based on recursive templates with C++.
3774
3775 Inlining is actually controlled by a number of parameters, which may be
3776 specified individually by using @option{--param @var{name}=@var{value}}.
3777 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3778 as follows:
3779
3780 @table @gcctabopt
3781  @item max-inline-insns-single
3782   is set to @var{n}/2.
3783  @item max-inline-insns-auto
3784   is set to @var{n}/2.
3785  @item min-inline-insns
3786   is set to 130 or @var{n}/4, whichever is smaller.
3787  @item max-inline-insns-rtl
3788   is set to @var{n}.
3789 @end table
3790
3791 See below for a documentation of the individual
3792 parameters controlling inlining.
3793
3794 @emph{Note:} pseudo instruction represents, in this particular context, an
3795 abstract measurement of function's size.  In no way, it represents a count
3796 of assembly instructions and as such its exact meaning might change from one
3797 release to an another.
3798
3799 @item -fkeep-inline-functions
3800 @opindex fkeep-inline-functions
3801 Even if all calls to a given function are integrated, and the function
3802 is declared @code{static}, nevertheless output a separate run-time
3803 callable version of the function.  This switch does not affect
3804 @code{extern inline} functions.
3805
3806 @item -fkeep-static-consts
3807 @opindex fkeep-static-consts
3808 Emit variables declared @code{static const} when optimization isn't turned
3809 on, even if the variables aren't referenced.
3810
3811 GCC enables this option by default.  If you want to force the compiler to
3812 check if the variable was referenced, regardless of whether or not
3813 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3814
3815 @item -fmerge-constants
3816 Attempt to merge identical constants (string constants and floating point
3817 constants) across compilation units.
3818
3819 This option is the default for optimized compilation if the assembler and
3820 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3821 behavior.
3822
3823 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3824
3825 @item -fmerge-all-constants
3826 Attempt to merge identical constants and identical variables.
3827
3828 This option implies @option{-fmerge-constants}.  In addition to
3829 @option{-fmerge-constants} this considers e.g. even constant initialized
3830 arrays or initialized constant variables with integral or floating point
3831 types.  Languages like C or C++ require each non-automatic variable to
3832 have distinct location, so using this option will result in non-conforming
3833 behavior.
3834
3835 @item -fnew-ra
3836 @opindex fnew-ra
3837 Use a graph coloring register allocator.  Currently this option is meant
3838 for testing, so we are interested to hear about miscompilations with
3839 @option{-fnew-ra}.
3840
3841 @item -fno-branch-count-reg
3842 @opindex fno-branch-count-reg
3843 Do not use ``decrement and branch'' instructions on a count register,
3844 but instead generate a sequence of instructions that decrement a
3845 register, compare it against zero, then branch based upon the result.
3846 This option is only meaningful on architectures that support such
3847 instructions, which include x86, PowerPC, IA-64 and S/390.
3848
3849 The default is @option{-fbranch-count-reg}, enabled when
3850 @option{-fstrength-reduce} is enabled.
3851
3852 @item -fno-function-cse
3853 @opindex fno-function-cse
3854 Do not put function addresses in registers; make each instruction that
3855 calls a constant function contain the function's address explicitly.
3856
3857 This option results in less efficient code, but some strange hacks
3858 that alter the assembler output may be confused by the optimizations
3859 performed when this option is not used.
3860
3861 The default is @option{-ffunction-cse}
3862
3863 @item -fno-zero-initialized-in-bss
3864 @opindex fno-zero-initialized-in-bss
3865 If the target supports a BSS section, GCC by default puts variables that
3866 are initialized to zero into BSS@.  This can save space in the resulting
3867 code.
3868
3869 This option turns off this behavior because some programs explicitly
3870 rely on variables going to the data section.  E.g., so that the
3871 resulting executable can find the beginning of that section and/or make
3872 assumptions based on that.
3873
3874 The default is @option{-fzero-initialized-in-bss}.
3875
3876 @item -fstrength-reduce
3877 @opindex fstrength-reduce
3878 Perform the optimizations of loop strength reduction and
3879 elimination of iteration variables.
3880
3881 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3882
3883 @item -fthread-jumps
3884 @opindex fthread-jumps
3885 Perform optimizations where we check to see if a jump branches to a
3886 location where another comparison subsumed by the first is found.  If
3887 so, the first branch is redirected to either the destination of the
3888 second branch or a point immediately following it, depending on whether
3889 the condition is known to be true or false.
3890
3891 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3892
3893 @item -fcse-follow-jumps
3894 @opindex fcse-follow-jumps
3895 In common subexpression elimination, scan through jump instructions
3896 when the target of the jump is not reached by any other path.  For
3897 example, when CSE encounters an @code{if} statement with an
3898 @code{else} clause, CSE will follow the jump when the condition
3899 tested is false.
3900
3901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3902
3903 @item -fcse-skip-blocks
3904 @opindex fcse-skip-blocks
3905 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3906 follow jumps which conditionally skip over blocks.  When CSE
3907 encounters a simple @code{if} statement with no else clause,
3908 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3909 body of the @code{if}.
3910
3911 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3912
3913 @item -frerun-cse-after-loop
3914 @opindex frerun-cse-after-loop
3915 Re-run common subexpression elimination after loop optimizations has been
3916 performed.
3917
3918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3919
3920 @item -frerun-loop-opt
3921 @opindex frerun-loop-opt
3922 Run the loop optimizer twice.
3923
3924 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3925
3926 @item -fgcse
3927 @opindex fgcse
3928 Perform a global common subexpression elimination pass.
3929 This pass also performs global constant and copy propagation.
3930
3931 @emph{Note:} When compiling a program using computed gotos, a GCC
3932 extension, you may get better runtime performance if you disable
3933 the global common subexpression elimination pass by adding
3934 @option{-fno-gcse} to the command line.
3935
3936 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3937
3938 @item -fgcse-lm
3939 @opindex fgcse-lm
3940 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3941 attempt to move loads which are only killed by stores into themselves.  This
3942 allows a loop containing a load/store sequence to be changed to a load outside
3943 the loop, and a copy/store within the loop.
3944
3945 Enabled by default when gcse is enabled.
3946
3947 @item -fgcse-sm
3948 @opindex fgcse-sm
3949 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3950 global common subexpression elimination.  This pass will attempt to move
3951 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3952 loops containing a load/store sequence can be changed to a load before
3953 the loop and a store after the loop.
3954
3955 Enabled by default when gcse is enabled.
3956
3957 @item -fgcse-las
3958 @opindex fgcse-las
3959 When @option{-fgcse-las} is enabled, the global common subexpression
3960 elimination pass eliminates redundant loads that come after stores to the
3961 same memory location (both partial and full redundancies).
3962
3963 Enabled by default when gcse is enabled.
3964
3965 @item -floop-optimize
3966 @opindex floop-optimize
3967 Perform loop optimizations: move constant expressions out of loops, simplify
3968 exit test conditions and optionally do strength-reduction and loop unrolling as
3969 well.
3970
3971 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3972
3973 @item -fcrossjumping
3974 @opindex crossjumping
3975 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3976 resulting code may or may not perform better than without cross-jumping.
3977
3978 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3979
3980 @item -fif-conversion
3981 @opindex if-conversion
3982 Attempt to transform conditional jumps into branch-less equivalents.  This
3983 include use of conditional moves, min, max, set flags and abs instructions, and
3984 some tricks doable by standard arithmetics.  The use of conditional execution
3985 on chips where it is available is controlled by @code{if-conversion2}.
3986
3987 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3988
3989 @item -fif-conversion2
3990 @opindex if-conversion2
3991 Use conditional execution (where available) to transform conditional jumps into
3992 branch-less equivalents.
3993
3994 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3995
3996 @item -fdelete-null-pointer-checks
3997 @opindex fdelete-null-pointer-checks
3998 Use global dataflow analysis to identify and eliminate useless checks
3999 for null pointers.  The compiler assumes that dereferencing a null
4000 pointer would have halted the program.  If a pointer is checked after
4001 it has already been dereferenced, it cannot be null.
4002
4003 In some environments, this assumption is not true, and programs can
4004 safely dereference null pointers.  Use
4005 @option{-fno-delete-null-pointer-checks} to disable this optimization
4006 for programs which depend on that behavior.
4007
4008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4009
4010 @item -fexpensive-optimizations
4011 @opindex fexpensive-optimizations
4012 Perform a number of minor optimizations that are relatively expensive.
4013
4014 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015
4016 @item -foptimize-register-move
4017 @itemx -fregmove
4018 @opindex foptimize-register-move
4019 @opindex fregmove
4020 Attempt to reassign register numbers in move instructions and as
4021 operands of other simple instructions in order to maximize the amount of
4022 register tying.  This is especially helpful on machines with two-operand
4023 instructions.
4024
4025 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4026 optimization.
4027
4028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fdelayed-branch
4031 @opindex fdelayed-branch
4032 If supported for the target machine, attempt to reorder instructions
4033 to exploit instruction slots available after delayed branch
4034 instructions.
4035
4036 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4037
4038 @item -fschedule-insns
4039 @opindex fschedule-insns
4040 If supported for the target machine, attempt to reorder instructions to
4041 eliminate execution stalls due to required data being unavailable.  This
4042 helps machines that have slow floating point or memory load instructions
4043 by allowing other instructions to be issued until the result of the load
4044 or floating point instruction is required.
4045
4046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4047
4048 @item -fschedule-insns2
4049 @opindex fschedule-insns2
4050 Similar to @option{-fschedule-insns}, but requests an additional pass of
4051 instruction scheduling after register allocation has been done.  This is
4052 especially useful on machines with a relatively small number of
4053 registers and where memory load instructions take more than one cycle.
4054
4055 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4056
4057 @item -fno-sched-interblock
4058 @opindex fno-sched-interblock
4059 Don't schedule instructions across basic blocks.  This is normally
4060 enabled by default when scheduling before register allocation, i.e.@:
4061 with @option{-fschedule-insns} or at @option{-O2} or higher.
4062
4063 @item -fno-sched-spec
4064 @opindex fno-sched-spec
4065 Don't allow speculative motion of non-load instructions.  This is normally
4066 enabled by default when scheduling before register allocation, i.e.@:
4067 with @option{-fschedule-insns} or at @option{-O2} or higher.
4068
4069 @item -fsched-spec-load
4070 @opindex fsched-spec-load
4071 Allow speculative motion of some load instructions.  This only makes
4072 sense when scheduling before register allocation, i.e.@: with
4073 @option{-fschedule-insns} or at @option{-O2} or higher.
4074
4075 @item -fsched-spec-load-dangerous
4076 @opindex fsched-spec-load-dangerous
4077 Allow speculative motion of more load instructions.  This only makes
4078 sense when scheduling before register allocation, i.e.@: with
4079 @option{-fschedule-insns} or at @option{-O2} or higher.
4080
4081 @item -fsched-stalled-insns=@var{n}
4082 @opindex fsched-stalled-insns
4083 Define how many insns (if any) can be moved prematurely from the queue
4084 of stalled insns into the ready list, during the second scheduling pass.
4085
4086 @item -fsched-stalled-insns-dep=@var{n}
4087 @opindex fsched-stalled-insns-dep
4088 Define how many insn groups (cycles) will be examined for a dependency 
4089 on a stalled insn that is candidate for premature removal from the queue 
4090 of stalled insns.  Has an effect only during the second scheduling pass, 
4091 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4092
4093 @item -fsched2-use-superblocks
4094 @opindex fsched2-use-superblocks
4095 When scheduling after register allocation, do use superblock scheduling
4096 algorithm.  Superblock scheduling allows motion across basic block boundaries
4097 resulting on faster schedules.  This option is experimental, as not all machine
4098 descriptions used by GCC model the CPU closely enough to avoid unreliable
4099 results from the algorithm. 
4100
4101 This only makes sense when scheduling after register allocation, i.e.@: with
4102 @option{-fschedule-insns2} or at @option{-O2} or higher.
4103
4104 @item -fsched2-use-traces
4105 @opindex fsched2-use-traces
4106 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4107 allocation and additionally perform code duplication in order to increase the
4108 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4109 trace formation.
4110
4111 This mode should produce faster but significantly longer programs.  Also
4112 without @code{-fbranch-probabilities} the traces constructed may not match the
4113 reality and hurt the performance.  This only makes
4114 sense when scheduling after register allocation, i.e.@: with
4115 @option{-fschedule-insns2} or at @option{-O2} or higher.
4116
4117 @item -fcaller-saves
4118 @opindex fcaller-saves
4119 Enable values to be allocated in registers that will be clobbered by
4120 function calls, by emitting extra instructions to save and restore the
4121 registers around such calls.  Such allocation is done only when it
4122 seems to result in better code than would otherwise be produced.
4123
4124 This option is always enabled by default on certain machines, usually
4125 those which have no call-preserved registers to use instead.
4126
4127 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4128
4129 @item -fmove-all-movables
4130 @opindex fmove-all-movables
4131 Forces all invariant computations in loops to be moved
4132 outside the loop.
4133
4134 @item -freduce-all-givs
4135 @opindex freduce-all-givs
4136 Forces all general-induction variables in loops to be
4137 strength-reduced.
4138
4139 @emph{Note:} When compiling programs written in Fortran,
4140 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4141 by default when you use the optimizer.
4142
4143 These options may generate better or worse code; results are highly
4144 dependent on the structure of loops within the source code.
4145
4146 These two options are intended to be removed someday, once
4147 they have helped determine the efficacy of various
4148 approaches to improving loop optimizations.
4149
4150 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4151 know how use of these options affects
4152 the performance of your production code.
4153 We're very interested in code that runs @emph{slower}
4154 when these options are @emph{enabled}.
4155
4156 @item -fno-peephole
4157 @itemx -fno-peephole2
4158 @opindex fno-peephole
4159 @opindex fno-peephole2
4160 Disable any machine-specific peephole optimizations.  The difference
4161 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4162 are implemented in the compiler; some targets use one, some use the
4163 other, a few use both.
4164
4165 @option{-fpeephole} is enabled by default.
4166 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4167
4168 @item -fno-guess-branch-probability
4169 @opindex fno-guess-branch-probability
4170 Do not guess branch probabilities using a randomized model.
4171
4172 Sometimes gcc will opt to use a randomized model to guess branch
4173 probabilities, when none are available from either profiling feedback
4174 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4175 different runs of the compiler on the same program may produce different
4176 object code.
4177
4178 In a hard real-time system, people don't want different runs of the
4179 compiler to produce code that has different behavior; minimizing
4180 non-determinism is of paramount import.  This switch allows users to
4181 reduce non-determinism, possibly at the expense of inferior
4182 optimization.
4183
4184 The default is @option{-fguess-branch-probability} at levels
4185 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186
4187 @item -freorder-blocks
4188 @opindex freorder-blocks
4189 Reorder basic blocks in the compiled function in order to reduce number of
4190 taken branches and improve code locality.
4191
4192 Enabled at levels @option{-O2}, @option{-O3}.
4193
4194 @item -freorder-functions
4195 @opindex freorder-functions
4196 Reorder basic blocks in the compiled function in order to reduce number of
4197 taken branches and improve code locality. This is implemented by using special
4198 subsections @code{text.hot} for most frequently executed functions and
4199 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4200 the linker so object file format must support named sections and linker must
4201 place them in a reasonable way.
4202
4203 Also profile feedback must be available in to make this option effective.  See
4204 @option{-fprofile-arcs} for details.
4205
4206 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4207
4208 @item -fstrict-aliasing
4209 @opindex fstrict-aliasing
4210 Allows the compiler to assume the strictest aliasing rules applicable to
4211 the language being compiled.  For C (and C++), this activates
4212 optimizations based on the type of expressions.  In particular, an
4213 object of one type is assumed never to reside at the same address as an
4214 object of a different type, unless the types are almost the same.  For
4215 example, an @code{unsigned int} can alias an @code{int}, but not a
4216 @code{void*} or a @code{double}.  A character type may alias any other
4217 type.
4218
4219 Pay special attention to code like this:
4220 @example
4221 union a_union @{
4222   int i;
4223   double d;
4224 @};
4225
4226 int f() @{
4227   a_union t;
4228   t.d = 3.0;
4229   return t.i;
4230 @}
4231 @end example
4232 The practice of reading from a different union member than the one most
4233 recently written to (called ``type-punning'') is common.  Even with
4234 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4235 is accessed through the union type.  So, the code above will work as
4236 expected.  However, this code might not:
4237 @example
4238 int f() @{
4239   a_union t;
4240   int* ip;
4241   t.d = 3.0;
4242   ip = &t.i;
4243   return *ip;
4244 @}
4245 @end example
4246
4247 Every language that wishes to perform language-specific alias analysis
4248 should define a function that computes, given an @code{tree}
4249 node, an alias set for the node.  Nodes in different alias sets are not
4250 allowed to alias.  For an example, see the C front-end function
4251 @code{c_get_alias_set}.
4252
4253 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4254
4255 @item -falign-functions
4256 @itemx -falign-functions=@var{n}
4257 @opindex falign-functions
4258 Align the start of functions to the next power-of-two greater than
4259 @var{n}, skipping up to @var{n} bytes.  For instance,
4260 @option{-falign-functions=32} aligns functions to the next 32-byte
4261 boundary, but @option{-falign-functions=24} would align to the next
4262 32-byte boundary only if this can be done by skipping 23 bytes or less.
4263
4264 @option{-fno-align-functions} and @option{-falign-functions=1} are
4265 equivalent and mean that functions will not be aligned.
4266
4267 Some assemblers only support this flag when @var{n} is a power of two;
4268 in that case, it is rounded up.
4269
4270 If @var{n} is not specified or is zero, use a machine-dependent default.
4271
4272 Enabled at levels @option{-O2}, @option{-O3}.
4273
4274 @item -falign-labels
4275 @itemx -falign-labels=@var{n}
4276 @opindex falign-labels
4277 Align all branch targets to a power-of-two boundary, skipping up to
4278 @var{n} bytes like @option{-falign-functions}.  This option can easily
4279 make code slower, because it must insert dummy operations for when the
4280 branch target is reached in the usual flow of the code.
4281
4282 @option{-fno-align-labels} and @option{-falign-labels=1} are
4283 equivalent and mean that labels will not be aligned.
4284
4285 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4286 are greater than this value, then their values are used instead.
4287
4288 If @var{n} is not specified or is zero, use a machine-dependent default
4289 which is very likely to be @samp{1}, meaning no alignment.
4290
4291 Enabled at levels @option{-O2}, @option{-O3}.
4292
4293 @item -falign-loops
4294 @itemx -falign-loops=@var{n}
4295 @opindex falign-loops
4296 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4297 like @option{-falign-functions}.  The hope is that the loop will be
4298 executed many times, which will make up for any execution of the dummy
4299 operations.
4300
4301 @option{-fno-align-loops} and @option{-falign-loops=1} are
4302 equivalent and mean that loops will not be aligned.
4303
4304 If @var{n} is not specified or is zero, use a machine-dependent default.
4305
4306 Enabled at levels @option{-O2}, @option{-O3}.
4307
4308 @item -falign-jumps
4309 @itemx -falign-jumps=@var{n}
4310 @opindex falign-jumps
4311 Align branch targets to a power-of-two boundary, for branch targets
4312 where the targets can only be reached by jumping, skipping up to @var{n}
4313 bytes like @option{-falign-functions}.  In this case, no dummy operations
4314 need be executed.
4315
4316 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4317 equivalent and mean that loops will not be aligned.
4318
4319 If @var{n} is not specified or is zero, use a machine-dependent default.
4320
4321 Enabled at levels @option{-O2}, @option{-O3}.
4322
4323 @item -frename-registers
4324 @opindex frename-registers
4325 Attempt to avoid false dependencies in scheduled code by making use
4326 of registers left over after register allocation.  This optimization
4327 will most benefit processors with lots of registers.  It can, however,
4328 make debugging impossible, since variables will no longer stay in
4329 a ``home register''.
4330
4331 @item -fweb
4332 @opindex fweb
4333 Constructs webs as commonly used for register allocation purposes and assign
4334 each web individual pseudo register.  This allows our register allocation pass
4335 to operate on pseudos directly, but also strengthens several other optimization
4336 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4337 however, make debugging impossible, since variables will no longer stay in a
4338 ``home register''.
4339
4340 Enabled at levels @option{-O3}.
4341
4342 @item -fno-cprop-registers
4343 @opindex fno-cprop-registers
4344 After register allocation and post-register allocation instruction splitting,
4345 we perform a copy-propagation pass to try to reduce scheduling dependencies
4346 and occasionally eliminate the copy.
4347
4348 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4349
4350 @item -fprofile-generate
4351 @opindex fprofile-generate
4352 Enable options usually used for instrumenting application to produce profile usefull
4353 for later recompilation profile feedback based optimization.
4354
4355 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}
4356
4357 @item -fprofile-use
4358 @opindex fprofile-use
4359 Enable profile feedback directed optimizations, and optimizations
4360 generally profitable only with profile feedback available.
4361
4362 The following options are enabled: @code{-fbranch-probabilities},
4363 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4364
4365 @end table
4366
4367 The following options control compiler behavior regarding floating
4368 point arithmetic.  These options trade off between speed and
4369 correctness.  All must be specifically enabled.
4370
4371 @table @gcctabopt
4372 @item -ffloat-store
4373 @opindex ffloat-store
4374 Do not store floating point variables in registers, and inhibit other
4375 options that might change whether a floating point value is taken from a
4376 register or memory.
4377
4378 @cindex floating point precision
4379 This option prevents undesirable excess precision on machines such as
4380 the 68000 where the floating registers (of the 68881) keep more
4381 precision than a @code{double} is supposed to have.  Similarly for the
4382 x86 architecture.  For most programs, the excess precision does only
4383 good, but a few programs rely on the precise definition of IEEE floating
4384 point.  Use @option{-ffloat-store} for such programs, after modifying
4385 them to store all pertinent intermediate computations into variables.
4386
4387 @item -ffast-math
4388 @opindex ffast-math
4389 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4390 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4391 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4392
4393 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4394
4395 This option should never be turned on by any @option{-O} option since
4396 it can result in incorrect output for programs which depend on
4397 an exact implementation of IEEE or ISO rules/specifications for
4398 math functions.
4399
4400 @item -fno-math-errno
4401 @opindex fno-math-errno
4402 Do not set ERRNO after calling math functions that are executed
4403 with a single instruction, e.g., sqrt.  A program that relies on
4404 IEEE exceptions for math error handling may want to use this flag
4405 for speed while maintaining IEEE arithmetic compatibility.
4406
4407 This option should never be turned on by any @option{-O} option since
4408 it can result in incorrect output for programs which depend on
4409 an exact implementation of IEEE or ISO rules/specifications for
4410 math functions.
4411
4412 The default is @option{-fmath-errno}.
4413
4414 @item -funsafe-math-optimizations
4415 @opindex funsafe-math-optimizations
4416 Allow optimizations for floating-point arithmetic that (a) assume
4417 that arguments and results are valid and (b) may violate IEEE or
4418 ANSI standards.  When used at link-time, it may include libraries
4419 or startup files that change the default FPU control word or other
4420 similar optimizations.
4421
4422 This option should never be turned on by any @option{-O} option since
4423 it can result in incorrect output for programs which depend on
4424 an exact implementation of IEEE or ISO rules/specifications for
4425 math functions.
4426
4427 The default is @option{-fno-unsafe-math-optimizations}.
4428
4429 @item -ffinite-math-only
4430 @opindex ffinite-math-only
4431 Allow optimizations for floating-point arithmetic that assume
4432 that arguments and results are not NaNs or +-Infs.
4433
4434 This option should never be turned on by any @option{-O} option since
4435 it can result in incorrect output for programs which depend on
4436 an exact implementation of IEEE or ISO rules/specifications.
4437
4438 The default is @option{-fno-finite-math-only}.
4439
4440 @item -fno-trapping-math
4441 @opindex fno-trapping-math
4442 Compile code assuming that floating-point operations cannot generate
4443 user-visible traps.  These traps include division by zero, overflow,
4444 underflow, inexact result and invalid operation.  This option implies
4445 @option{-fno-signaling-nans}.  Setting this option may allow faster
4446 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4447
4448 This option should never be turned on by any @option{-O} option since
4449 it can result in incorrect output for programs which depend on
4450 an exact implementation of IEEE or ISO rules/specifications for
4451 math functions.
4452
4453 The default is @option{-ftrapping-math}.
4454
4455 @item -frounding-math
4456 @opindex frounding-math
4457 Disable transformations and optimizations that assume default floating
4458 point rounding behavior.  This is round-to-zero for all floating point
4459 to integer conversions, and round-to-nearest for all other arithmetic
4460 truncations.  This option should be specified for programs that change
4461 the FP rounding mode dynamically, or that may be executed with a
4462 non-default rounding mode.  This option disables constant folding of
4463 floating point expressions at compile-time (which may be affected by
4464 rounding mode) and arithmetic transformations that are unsafe in the
4465 presence of sign-dependent rounding modes.
4466
4467 The default is @option{-fno-rounding-math}.
4468
4469 This option is experimental and does not currently guarantee to
4470 disable all GCC optimizations that are affected by rounding mode.
4471 Future versions of gcc may provide finer control of this setting
4472 using C99's @code{FENV_ACCESS} pragma.  This command line option
4473 will be used to specify the default state for @code{FENV_ACCESS}.
4474
4475 @item -fsignaling-nans
4476 @opindex fsignaling-nans
4477 Compile code assuming that IEEE signaling NaNs may generate user-visible
4478 traps during floating-point operations.  Setting this option disables
4479 optimizations that may change the number of exceptions visible with
4480 signaling NaNs.  This option implies @option{-ftrapping-math}.
4481
4482 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4483 be defined.
4484
4485 The default is @option{-fno-signaling-nans}.
4486
4487 This option is experimental and does not currently guarantee to
4488 disable all GCC optimizations that affect signaling NaN behavior.
4489
4490 @item -fsingle-precision-constant
4491 @opindex fsingle-precision-constant
4492 Treat floating point constant as single precision constant instead of
4493 implicitly converting it to double precision constant.
4494
4495
4496 @end table
4497
4498 The following options control optimizations that may improve
4499 performance, but are not enabled by any @option{-O} options.  This
4500 section includes experimental options that may produce broken code.
4501
4502 @table @gcctabopt
4503 @item -fbranch-probabilities
4504 @opindex fbranch-probabilities
4505 After running a program compiled with @option{-fprofile-arcs}
4506 (@pxref{Debugging Options,, Options for Debugging Your Program or
4507 @command{gcc}}), you can compile it a second time using
4508 @option{-fbranch-probabilities}, to improve optimizations based on
4509 the number of times each branch was taken.  When the program
4510 compiled with @option{-fprofile-arcs} exits it saves arc execution
4511 counts to a file called @file{@var{sourcename}.gcda} for each source
4512 file  The information in this data file is very dependent on the
4513 structure of the generated code, so you must use the same source code
4514 and the same optimization options for both compilations.
4515
4516 With @option{-fbranch-probabilities}, GCC puts a 
4517 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4518 These can be used to improve optimization.  Currently, they are only
4519 used in one place: in @file{reorg.c}, instead of guessing which path a
4520 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4521 exactly determine which path is taken more often.
4522
4523 @item -fprofile-values
4524 @opindex fprofile-values
4525 If combined with @option{-fprofile-arcs}, it adds code so that some
4526 data about values of expressions in the program is gathered.
4527
4528 With @option{-fbranch-probabilities}, it reads back the data gathered
4529 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4530 notes to instructions for their later usage in optimizations.
4531
4532 @item -fvpt
4533 @opindex fvpt
4534 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4535 a code to gather information about values of expressions.
4536
4537 With @option{-fbranch-probabilities}, it reads back the data gathered
4538 and actually performs the optimizations based on them.
4539 Currently the optimizations include specialization of division operation
4540 using the knowledge about the value of the denominator.
4541
4542 @item -fnew-ra
4543 @opindex fnew-ra
4544 Use a graph coloring register allocator.  Currently this option is meant
4545 for testing, so we are interested to hear about miscompilations with
4546 @option{-fnew-ra}.
4547
4548 @item -ftracer
4549 @opindex ftracer
4550 Perform tail duplication to enlarge superblock size. This transformation
4551 simplifies the control flow of the function allowing other optimizations to do
4552 better job.
4553
4554 @item -funit-at-a-time
4555 @opindex funit-at-a-time
4556 Parse the whole compilation unit before starting to produce code.
4557 This allows some extra optimizations to take place but consumes more
4558 memory.
4559
4560 @item -funroll-loops
4561 @opindex funroll-loops
4562 Unroll loops whose number of iterations can be determined at compile time or
4563 upon entry to the loop.  @option{-funroll-loops} implies
4564 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4565 (i.e. complete removal of loops with small constant number of iterations).
4566 This option makes code larger, and may or may not make it run faster.
4567
4568 @item -funroll-all-loops
4569 @opindex funroll-all-loops
4570 Unroll all loops, even if their number of iterations is uncertain when
4571 the loop is entered.  This usually makes programs run more slowly.
4572 @option{-funroll-all-loops} implies the same options as
4573 @option{-funroll-loops}.
4574
4575 @item -fpeel-loops
4576 @opindex fpeel-loops
4577 Peels the loops for that there is enough information that they do not
4578 roll much (from profile feedback).  It also turns on complete loop peeling
4579 (i.e. complete removal of loops with small constant number of iterations).
4580
4581 @item -funswitch-loops
4582 @opindex funswitch-loops
4583 Move branches with loop invariant conditions out of the loop, with duplicates
4584 of the loop on both branches (modified according to result of the condition).
4585
4586 @item -fold-unroll-loops
4587 @opindex fold-unroll-loops
4588 Unroll loops whose number of iterations can be determined at compile
4589 time or upon entry to the loop, using the old loop unroller whose loop
4590 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4591 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4592 option makes code larger, and may or may not make it run faster.
4593
4594 @item -fold-unroll-all-loops
4595 @opindex fold-unroll-all-loops
4596 Unroll all loops, even if their number of iterations is uncertain when
4597 the loop is entered. This is done using the old loop unroller whose loop
4598 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4599 @option{-fold-unroll-all-loops} implies the same options as
4600 @option{-fold-unroll-loops}.
4601  
4602 @item -funswitch-loops
4603 @opindex funswitch-loops
4604 Move branches with loop invariant conditions out of the loop, with duplicates
4605 of the loop on both branches (modified according to result of the condition).
4606
4607 @item -funswitch-loops
4608 @opindex funswitch-loops
4609 Move branches with loop invariant conditions out of the loop, with duplicates
4610 of the loop on both branches (modified according to result of the condition).
4611
4612 @item -fprefetch-loop-arrays
4613 @opindex fprefetch-loop-arrays
4614 If supported by the target machine, generate instructions to prefetch
4615 memory to improve the performance of loops that access large arrays.
4616
4617 Disabled at level @option{-Os}.
4618
4619 @item -ffunction-sections
4620 @itemx -fdata-sections
4621 @opindex ffunction-sections
4622 @opindex fdata-sections
4623 Place each function or data item into its own section in the output
4624 file if the target supports arbitrary sections.  The name of the
4625 function or the name of the data item determines the section's name
4626 in the output file.
4627
4628 Use these options on systems where the linker can perform optimizations
4629 to improve locality of reference in the instruction space.  Most systems
4630 using the ELF object format and SPARC processors running Solaris 2 have
4631 linkers with such optimizations.  AIX may have these optimizations in
4632 the future.
4633
4634 Only use these options when there are significant benefits from doing
4635 so.  When you specify these options, the assembler and linker will
4636 create larger object and executable files and will also be slower.
4637 You will not be able to use @code{gprof} on all systems if you
4638 specify this option and you may have problems with debugging if
4639 you specify both this option and @option{-g}.
4640
4641 @item -fbranch-target-load-optimize
4642 @opindex fbranch-target-load-optimize
4643 Perform branch target register load optimization before prologue / epilogue
4644 threading.
4645 The use of target registers can typically be exposed only during reload,
4646 thus hoisting loads out of loops and doing inter-block scheduling needs
4647 a separate optimization pass.
4648
4649 @item -fbranch-target-load-optimize2
4650 @opindex fbranch-target-load-optimize2
4651 Perform branch target register load optimization after prologue / epilogue
4652 threading.
4653
4654 @item --param @var{name}=@var{value}
4655 @opindex param
4656 In some places, GCC uses various constants to control the amount of
4657 optimization that is done.  For example, GCC will not inline functions
4658 that contain more that a certain number of instructions.  You can
4659 control some of these constants on the command-line using the
4660 @option{--param} option.
4661
4662 In each case, the @var{value} is an integer.  The allowable choices for
4663 @var{name} are given in the following table:
4664
4665 @table @gcctabopt
4666 @item max-crossjump-edges
4667 The maximum number of incoming edges to consider for crossjumping.
4668 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4669 the number of edges incoming to each block.  Increasing values mean
4670 more aggressive optimization, making the compile time increase with
4671 probably small improvement in executable size.
4672
4673 @item max-delay-slot-insn-search
4674 The maximum number of instructions to consider when looking for an
4675 instruction to fill a delay slot.  If more than this arbitrary number of
4676 instructions is searched, the time savings from filling the delay slot
4677 will be minimal so stop searching.  Increasing values mean more
4678 aggressive optimization, making the compile time increase with probably
4679 small improvement in executable run time.
4680
4681 @item max-delay-slot-live-search
4682 When trying to fill delay slots, the maximum number of instructions to
4683 consider when searching for a block with valid live register
4684 information.  Increasing this arbitrarily chosen value means more
4685 aggressive optimization, increasing the compile time.  This parameter
4686 should be removed when the delay slot code is rewritten to maintain the
4687 control-flow graph.
4688
4689 @item max-gcse-memory
4690 The approximate maximum amount of memory that will be allocated in
4691 order to perform the global common subexpression elimination
4692 optimization.  If more memory than specified is required, the
4693 optimization will not be done.
4694
4695 @item max-gcse-passes
4696 The maximum number of passes of GCSE to run.
4697
4698 @item max-pending-list-length
4699 The maximum number of pending dependencies scheduling will allow
4700 before flushing the current state and starting over.  Large functions
4701 with few branches or calls can create excessively large lists which
4702 needlessly consume memory and resources.
4703
4704 @item max-inline-insns-single
4705 Several parameters control the tree inliner used in gcc.
4706 This number sets the maximum number of instructions (counted in gcc's
4707 internal representation) in a single function that the tree inliner 
4708 will consider for inlining.  This only affects functions declared
4709 inline and methods implemented in a class declaration (C++).
4710 The default value is 500.
4711
4712 @item max-inline-insns-auto
4713 When you use @option{-finline-functions} (included in @option{-O3}),
4714 a lot of functions that would otherwise not be considered for inlining
4715 by the compiler will be investigated.  To those functions, a different
4716 (more restrictive) limit compared to functions declared inline can
4717 be applied.
4718 The default value is 150.
4719
4720 @item large-function-insns
4721 The limit specifying really large functions.  For functions greater than this
4722 limit inlining is constrained by @option{--param large-function-growth}.
4723 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4724 algorithms used by the backend.
4725 This parameter is ignored when @option{-funit-at-a-time} is not used.
4726 The default value is 30000.
4727
4728 @item large-function-growth
4729 Specifies maximal growth of large functtion caused by inlining in percents.
4730 This parameter is ignored when @option{-funit-at-a-time} is not used.
4731 The default value is 200.
4732
4733 @item inline-unit-growth
4734 Specifies maximal overall growth of the compilation unit caused by inlining.
4735 This parameter is ignored when @option{-funit-at-a-time} is not used.
4736 The default value is 150.
4737
4738 @item max-inline-insns-rtl
4739 For languages that use the RTL inliner (this happens at a later stage
4740 than tree inlining), you can set the maximum allowable size (counted 
4741 in RTL instructions) for the RTL inliner with this parameter.
4742 The default value is 600.
4743
4744 @item max-unrolled-insns
4745 The maximum number of instructions that a loop should have if that loop
4746 is unrolled, and if the loop is unrolled, it determines how many times
4747 the loop code is unrolled.
4748
4749 @item max-average-unrolled-insns
4750 The maximum number of instructions biased by probabilities of their execution
4751 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4752 it determines how many times the loop code is unrolled.
4753
4754 @item max-unroll-times
4755 The maximum number of unrollings of a single loop.
4756
4757 @item max-peeled-insns
4758 The maximum number of instructions that a loop should have if that loop
4759 is peeled, and if the loop is peeled, it determines how many times
4760 the loop code is peeled.
4761
4762 @item max-peel-times
4763 The maximum number of peelings of a single loop.
4764
4765 @item max-completely-peeled-insns
4766 The maximum number of insns of a completely peeled loop.
4767
4768 @item max-completely-peel-times
4769 The maximum number of iterations of a loop to be suitable for complete peeling.
4770
4771 @item max-unswitch-insns
4772 The maximum number of insns of an unswitched loop.
4773
4774 @item max-unswitch-level
4775 The maximum number of branches unswitched in a single loop.
4776
4777 @item hot-bb-count-fraction
4778 Select fraction of the maximal count of repetitions of basic block in program
4779 given basic block needs to have to be considered hot.
4780
4781 @item hot-bb-frequency-fraction
4782 Select fraction of the maximal frequency of executions of basic block in
4783 function given basic block needs to have to be considered hot
4784
4785 @item tracer-dynamic-coverage
4786 @itemx tracer-dynamic-coverage-feedback
4787
4788 This value is used to limit superblock formation once the given percentage of
4789 executed instructions is covered.  This limits unnecessary code size
4790 expansion.
4791
4792 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4793 feedback is available.  The real profiles (as opposed to statically estimated
4794 ones) are much less balanced allowing the threshold to be larger value.
4795
4796 @item tracer-max-code-growth
4797 Stop tail duplication once code growth has reached given percentage.  This is
4798 rather hokey argument, as most of the duplicates will be eliminated later in
4799 cross jumping, so it may be set to much higher values than is the desired code
4800 growth.
4801
4802 @item tracer-min-branch-ratio
4803
4804 Stop reverse growth when the reverse probability of best edge is less than this
4805 threshold (in percent).
4806
4807 @item tracer-min-branch-ratio
4808 @itemx tracer-min-branch-ratio-feedback
4809
4810 Stop forward growth if the best edge do have probability lower than this
4811 threshold.
4812
4813 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4814 compilation for profile feedback and one for compilation without.  The value
4815 for compilation with profile feedback needs to be more conservative (higher) in
4816 order to make tracer effective.
4817
4818 @item max-cse-path-length
4819
4820 Maximum number of basic blocks on path that cse considers.
4821
4822 @item ggc-min-expand
4823
4824 GCC uses a garbage collector to manage its own memory allocation.  This
4825 parameter specifies the minimum percentage by which the garbage
4826 collector's heap should be allowed to expand between collections.
4827 Tuning this may improve compilation speed; it has no effect on code
4828 generation.
4829
4830 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4831 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4832 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4833 GCC is not able to calculate RAM on a particular platform, the lower
4834 bound of 30% is used.  Setting this parameter and
4835 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4836 every opportunity.  This is extremely slow, but can be useful for
4837 debugging.
4838
4839 @item ggc-min-heapsize
4840
4841 Minimum size of the garbage collector's heap before it begins bothering
4842 to collect garbage.  The first collection occurs after the heap expands
4843 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4844 tuning this may improve compilation speed, and has no effect on code
4845 generation.
4846
4847 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4848 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4849 available, the notion of "RAM" is the smallest of actual RAM,
4850 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4851 RAM on a particular platform, the lower bound is used.  Setting this
4852 parameter very large effectively disables garbage collection.  Setting
4853 this parameter and @option{ggc-min-expand} to zero causes a full
4854 collection to occur at every opportunity.
4855
4856 @item reorder-blocks-duplicate
4857 @itemx reorder-blocks-duplicate-feedback
4858
4859 Used by basic block reordering pass to decide whether to use unconditional
4860 branch or duplicate the code on its destination.  Code is duplicated when its
4861 estimated size is smaller than this value multiplied by the estimated size of
4862 unconditional jump in the hot spots of the program.
4863
4864 The @option{reorder-block-duplicate-feedback} is used only when profile
4865 feedback is available and may be set to higher values than
4866 @option{reorder-block-duplicate} since information about the hot spots is more
4867 accurate.
4868 @end table
4869 @end table
4870
4871 @node Preprocessor Options
4872 @section Options Controlling the Preprocessor
4873 @cindex preprocessor options
4874 @cindex options, preprocessor
4875
4876 These options control the C preprocessor, which is run on each C source
4877 file before actual compilation.
4878
4879 If you use the @option{-E} option, nothing is done except preprocessing.
4880 Some of these options make sense only together with @option{-E} because
4881 they cause the preprocessor output to be unsuitable for actual
4882 compilation.
4883
4884 @table @gcctabopt
4885 @opindex Wp
4886 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4887 and pass @var{option} directly through to the preprocessor.  If
4888 @var{option} contains commas, it is split into multiple options at the
4889 commas.  However, many options are modified, translated or interpreted
4890 by the compiler driver before being passed to the preprocessor, and
4891 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4892 interface is undocumented and subject to change, so whenever possible
4893 you should avoid using @option{-Wp} and let the driver handle the
4894 options instead.
4895
4896 @item -Xpreprocessor @var{option}
4897 @opindex preprocessor
4898 Pass @var{option} as an option to the preprocessor.  You can use this to
4899 supply system-specific preprocessor options which GCC does not know how to
4900 recognize.
4901
4902 If you want to pass an option that takes an argument, you must use
4903 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4904 @end table
4905
4906 @include cppopts.texi
4907
4908 @node Assembler Options
4909 @section Passing Options to the Assembler
4910
4911 @c prevent bad page break with this line
4912 You can pass options to the assembler.
4913
4914 @table @gcctabopt
4915 @item -Wa,@var{option}
4916 @opindex Wa
4917 Pass @var{option} as an option to the assembler.  If @var{option}
4918 contains commas, it is split into multiple options at the commas.
4919
4920 @item -Xassembler @var{option}
4921 @opindex Xassembler
4922 Pass @var{option} as an option to the assembler.  You can use this to
4923 supply system-specific assembler options which GCC does not know how to
4924 recognize.
4925
4926 If you want to pass an option that takes an argument, you must use
4927 @option{-Xassembler} twice, once for the option and once for the argument.
4928
4929 @end table
4930
4931 @node Link Options
4932 @section Options for Linking
4933 @cindex link options
4934 @cindex options, linking
4935
4936 These options come into play when the compiler links object files into
4937 an executable output file.  They are meaningless if the compiler is
4938 not doing a link step.
4939
4940 @table @gcctabopt
4941 @cindex file names
4942 @item @var{object-file-name}
4943 A file name that does not end in a special recognized suffix is
4944 considered to name an object file or library.  (Object files are
4945 distinguished from libraries by the linker according to the file
4946 contents.)  If linking is done, these object files are used as input
4947 to the linker.
4948
4949 @item -c
4950 @itemx -S
4951 @itemx -E
4952 @opindex c
4953 @opindex S
4954 @opindex E
4955 If any of these options is used, then the linker is not run, and
4956 object file names should not be used as arguments.  @xref{Overall
4957 Options}.
4958
4959 @cindex Libraries
4960 @item -l@var{library}
4961 @itemx -l @var{library}
4962 @opindex l
4963 Search the library named @var{library} when linking.  (The second
4964 alternative with the library as a separate argument is only for
4965 POSIX compliance and is not recommended.)
4966
4967 It makes a difference where in the command you write this option; the
4968 linker searches and processes libraries and object files in the order they
4969 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4970 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4971 to functions in @samp{z}, those functions may not be loaded.
4972
4973 The linker searches a standard list of directories for the library,
4974 which is actually a file named @file{lib@var{library}.a}.  The linker
4975 then uses this file as if it had been specified precisely by name.
4976
4977 The directories searched include several standard system directories
4978 plus any that you specify with @option{-L}.
4979
4980 Normally the files found this way are library files---archive files
4981 whose members are object files.  The linker handles an archive file by
4982 scanning through it for members which define symbols that have so far
4983 been referenced but not defined.  But if the file that is found is an
4984 ordinary object file, it is linked in the usual fashion.  The only
4985 difference between using an @option{-l} option and specifying a file name
4986 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4987 and searches several directories.
4988
4989 @item -lobjc
4990 @opindex lobjc
4991 You need this special case of the @option{-l} option in order to
4992 link an Objective-C program.
4993
4994 @item -nostartfiles
4995 @opindex nostartfiles
4996 Do not use the standard system startup files when linking.
4997 The standard system libraries are used normally, unless @option{-nostdlib}
4998 or @option{-nodefaultlibs} is used.
4999
5000 @item -nodefaultlibs
5001 @opindex nodefaultlibs
5002 Do not use the standard system libraries when linking.
5003 Only the libraries you specify will be passed to the linker.
5004 The standard startup files are used normally, unless @option{-nostartfiles}
5005 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5006 for System V (and ISO C) environments or to bcopy and bzero for
5007 BSD environments.  These entries are usually resolved by entries in
5008 libc.  These entry points should be supplied through some other
5009 mechanism when this option is specified.
5010
5011 @item -nostdlib
5012 @opindex nostdlib
5013 Do not use the standard system startup files or libraries when linking.
5014 No startup files and only the libraries you specify will be passed to
5015 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5016 for System V (and ISO C) environments or to bcopy and bzero for
5017 BSD environments.  These entries are usually resolved by entries in
5018 libc.  These entry points should be supplied through some other
5019 mechanism when this option is specified.
5020
5021 @cindex @option{-lgcc}, use with @option{-nostdlib}
5022 @cindex @option{-nostdlib} and unresolved references
5023 @cindex unresolved references and @option{-nostdlib}
5024 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5025 @cindex @option{-nodefaultlibs} and unresolved references
5026 @cindex unresolved references and @option{-nodefaultlibs}
5027 One of the standard libraries bypassed by @option{-nostdlib} and
5028 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5029 that GCC uses to overcome shortcomings of particular machines, or special
5030 needs for some languages.
5031 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5032 Collection (GCC) Internals},
5033 for more discussion of @file{libgcc.a}.)
5034 In most cases, you need @file{libgcc.a} even when you want to avoid
5035 other standard libraries.  In other words, when you specify @option{-nostdlib}
5036 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5037 This ensures that you have no unresolved references to internal GCC
5038 library subroutines.  (For example, @samp{__main}, used to ensure C++
5039 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5040 GNU Compiler Collection (GCC) Internals}.)
5041
5042 @item -pie
5043 @opindex pie
5044 Produce a position independent executable on targets which support it.
5045 For predictable results, you must also specify the same set of options
5046 that were used to generate code (@option{-fpie}, @option{-fPIE},
5047 or model suboptions) when you specify this option.
5048
5049 @item -s
5050 @opindex s
5051 Remove all symbol table and relocation information from the executable.
5052
5053 @item -static
5054 @opindex static
5055 On systems that support dynamic linking, this prevents linking with the shared
5056 libraries.  On other systems, this option has no effect.
5057
5058 @item -shared
5059 @opindex shared
5060 Produce a shared object which can then be linked with other objects to
5061 form an executable.  Not all systems support this option.  For predictable
5062 results, you must also specify the same set of options that were used to
5063 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5064 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5065 needs to build supplementary stub code for constructors to work.  On
5066 multi-libbed systems, @samp{gcc -shared} must select the correct support
5067 libraries to link against.  Failing to supply the correct flags may lead
5068 to subtle defects.  Supplying them in cases where they are not necessary
5069 is innocuous.}
5070
5071 @item -shared-libgcc
5072 @itemx -static-libgcc
5073 @opindex shared-libgcc
5074 @opindex static-libgcc
5075 On systems that provide @file{libgcc} as a shared library, these options
5076 force the use of either the shared or static version respectively.
5077 If no shared version of @file{libgcc} was built when the compiler was
5078 configured, these options have no effect.
5079
5080 There are several situations in which an application should use the
5081 shared @file{libgcc} instead of the static version.  The most common
5082 of these is when the application wishes to throw and catch exceptions
5083 across different shared libraries.  In that case, each of the libraries
5084 as well as the application itself should use the shared @file{libgcc}.
5085
5086 Therefore, the G++ and GCJ drivers automatically add
5087 @option{-shared-libgcc} whenever you build a shared library or a main
5088 executable, because C++ and Java programs typically use exceptions, so
5089 this is the right thing to do.
5090
5091 If, instead, you use the GCC driver to create shared libraries, you may
5092 find that they will not always be linked with the shared @file{libgcc}.
5093 If GCC finds, at its configuration time, that you have a GNU linker that
5094 does not support option @option{--eh-frame-hdr}, it will link the shared
5095 version of @file{libgcc} into shared libraries by default.  Otherwise,
5096 it will take advantage of the linker and optimize away the linking with
5097 the shared version of @file{libgcc}, linking with the static version of
5098 libgcc by default.  This allows exceptions to propagate through such
5099 shared libraries, without incurring relocation costs at library load
5100 time.
5101
5102 However, if a library or main executable is supposed to throw or catch
5103 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5104 for the languages used in the program, or using the option
5105 @option{-shared-libgcc}, such that it is linked with the shared
5106 @file{libgcc}.
5107
5108 @item -symbolic
5109 @opindex symbolic
5110 Bind references to global symbols when building a shared object.  Warn
5111 about any unresolved references (unless overridden by the link editor
5112 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5113 this option.
5114
5115 @item -Xlinker @var{option}
5116 @opindex Xlinker
5117 Pass @var{option} as an option to the linker.  You can use this to
5118 supply system-specific linker options which GCC does not know how to
5119 recognize.
5120
5121 If you want to pass an option that takes an argument, you must use
5122 @option{-Xlinker} twice, once for the option and once for the argument.
5123 For example, to pass @option{-assert definitions}, you must write
5124 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5125 @option{-Xlinker "-assert definitions"}, because this passes the entire
5126 string as a single argument, which is not what the linker expects.
5127
5128 @item -Wl,@var{option}
5129 @opindex Wl
5130 Pass @var{option} as an option to the linker.  If @var{option} contains
5131 commas, it is split into multiple options at the commas.
5132
5133 @item -u @var{symbol}
5134 @opindex u
5135 Pretend the symbol @var{symbol} is undefined, to force linking of
5136 library modules to define it.  You can use @option{-u} multiple times with
5137 different symbols to force loading of additional library modules.
5138 @end table
5139
5140 @node Directory Options
5141 @section Options for Directory Search
5142 @cindex directory options
5143 @cindex options, directory search
5144 @cindex search path
5145
5146 These options specify directories to search for header files, for
5147 libraries and for parts of the compiler:
5148
5149 @table @gcctabopt
5150 @item -I@var{dir}
5151 @opindex I
5152 Add the directory @var{dir} to the head of the list of directories to be
5153 searched for header files.  This can be used to override a system header
5154 file, substituting your own version, since these directories are
5155 searched before the system header file directories.  However, you should
5156 not use this option to add directories that contain vendor-supplied
5157 system header files (use @option{-isystem} for that).  If you use more than
5158 one @option{-I} option, the directories are scanned in left-to-right
5159 order; the standard system directories come after.
5160
5161 If a standard system include directory, or a directory specified with
5162 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5163 option will be ignored.  The directory will still be searched but as a
5164 system directory at its normal position in the system include chain.
5165 This is to ensure that GCC's procedure to fix buggy system headers and
5166 the ordering for the include_next directive are not inadvertently changed.
5167 If you really need to change the search order for system directories,
5168 use the @option{-nostdinc} and/or @option{-isystem} options.
5169
5170 @item -I-
5171 @opindex I-
5172 Any directories you specify with @option{-I} options before the @option{-I-}
5173 option are searched only for the case of @samp{#include "@var{file}"};
5174 they are not searched for @samp{#include <@var{file}>}.
5175
5176 If additional directories are specified with @option{-I} options after
5177 the @option{-I-}, these directories are searched for all @samp{#include}
5178 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5179 this way.)
5180
5181 In addition, the @option{-I-} option inhibits the use of the current
5182 directory (where the current input file came from) as the first search
5183 directory for @samp{#include "@var{file}"}.  There is no way to
5184 override this effect of @option{-I-}.  With @option{-I.} you can specify
5185 searching the directory which was current when the compiler was
5186 invoked.  That is not exactly the same as what the preprocessor does
5187 by default, but it is often satisfactory.
5188
5189 @option{-I-} does not inhibit the use of the standard system directories
5190 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5191 independent.
5192
5193 @item -L@var{dir}
5194 @opindex L
5195 Add directory @var{dir} to the list of directories to be searched
5196 for @option{-l}.
5197
5198 @item -B@var{prefix}
5199 @opindex B
5200 This option specifies where to find the executables, libraries,
5201 include files, and data files of the compiler itself.
5202
5203 The compiler driver program runs one or more of the subprograms
5204 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5205 @var{prefix} as a prefix for each program it tries to run, both with and
5206 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5207
5208 For each subprogram to be run, the compiler driver first tries the
5209 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5210 was not specified, the driver tries two standard prefixes, which are
5211 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5212 those results in a file name that is found, the unmodified program
5213 name is searched for using the directories specified in your
5214 @env{PATH} environment variable.
5215
5216 The compiler will check to see if the path provided by the @option{-B}
5217 refers to a directory, and if necessary it will add a directory
5218 separator character at the end of the path.
5219
5220 @option{-B} prefixes that effectively specify directory names also apply
5221 to libraries in the linker, because the compiler translates these
5222 options into @option{-L} options for the linker.  They also apply to
5223 includes files in the preprocessor, because the compiler translates these
5224 options into @option{-isystem} options for the preprocessor.  In this case,
5225 the compiler appends @samp{include} to the prefix.
5226
5227 The run-time support file @file{libgcc.a} can also be searched for using
5228 the @option{-B} prefix, if needed.  If it is not found there, the two
5229 standard prefixes above are tried, and that is all.  The file is left
5230 out of the link if it is not found by those means.
5231
5232 Another way to specify a prefix much like the @option{-B} prefix is to use
5233 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5234 Variables}.
5235
5236 As a special kludge, if the path provided by @option{-B} is
5237 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5238 9, then it will be replaced by @file{[dir/]include}.  This is to help
5239 with boot-strapping the compiler.
5240
5241 @item -specs=@var{file}
5242 @opindex specs
5243 Process @var{file} after the compiler reads in the standard @file{specs}
5244 file, in order to override the defaults that the @file{gcc} driver
5245 program uses when determining what switches to pass to @file{cc1},
5246 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5247 @option{-specs=@var{file}} can be specified on the command line, and they
5248 are processed in order, from left to right.
5249 @end table
5250
5251 @c man end
5252
5253 @node Spec Files
5254 @section Specifying subprocesses and the switches to pass to them
5255 @cindex Spec Files
5256
5257 @command{gcc} is a driver program.  It performs its job by invoking a
5258 sequence of other programs to do the work of compiling, assembling and
5259 linking.  GCC interprets its command-line parameters and uses these to
5260 deduce which programs it should invoke, and which command-line options
5261 it ought to place on their command lines.  This behavior is controlled
5262 by @dfn{spec strings}.  In most cases there is one spec string for each
5263 program that GCC can invoke, but a few programs have multiple spec
5264 strings to control their behavior.  The spec strings built into GCC can
5265 be overridden by using the @option{-specs=} command-line switch to specify
5266 a spec file.
5267
5268 @dfn{Spec files} are plaintext files that are used to construct spec
5269 strings.  They consist of a sequence of directives separated by blank
5270 lines.  The type of directive is determined by the first non-whitespace
5271 character on the line and it can be one of the following:
5272
5273 @table @code
5274 @item %@var{command}
5275 Issues a @var{command} to the spec file processor.  The commands that can
5276 appear here are:
5277
5278 @table @code
5279 @item %include <@var{file}>
5280 @cindex %include
5281 Search for @var{file} and insert its text at the current point in the
5282 specs file.
5283
5284 @item %include_noerr <@var{file}>
5285 @cindex %include_noerr
5286 Just like @samp{%include}, but do not generate an error message if the include
5287 file cannot be found.
5288
5289 @item %rename @var{old_name} @var{new_name}
5290 @cindex %rename
5291 Rename the spec string @var{old_name} to @var{new_name}.
5292
5293 @end table
5294
5295 @item *[@var{spec_name}]:
5296 This tells the compiler to create, override or delete the named spec
5297 string.  All lines after this directive up to the next directive or
5298 blank line are considered to be the text for the spec string.  If this
5299 results in an empty string then the spec will be deleted.  (Or, if the
5300 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5301 does not currently exist a new spec will be created.  If the spec does
5302 exist then its contents will be overridden by the text of this
5303 directive, unless the first character of that text is the @samp{+}
5304 character, in which case the text will be appended to the spec.
5305
5306 @item [@var{suffix}]:
5307 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5308 and up to the next directive or blank line are considered to make up the
5309 spec string for the indicated suffix.  When the compiler encounters an
5310 input file with the named suffix, it will processes the spec string in
5311 order to work out how to compile that file.  For example:
5312
5313 @smallexample
5314 .ZZ:
5315 z-compile -input %i
5316 @end smallexample
5317
5318 This says that any input file whose name ends in @samp{.ZZ} should be
5319 passed to the program @samp{z-compile}, which should be invoked with the
5320 command-line switch @option{-input} and with the result of performing the
5321 @samp{%i} substitution.  (See below.)
5322
5323 As an alternative to providing a spec string, the text that follows a
5324 suffix directive can be one of the following:
5325
5326 @table @code
5327 @item @@@var{language}
5328 This says that the suffix is an alias for a known @var{language}.  This is
5329 similar to using the @option{-x} command-line switch to GCC to specify a
5330 language explicitly.  For example:
5331
5332 @smallexample
5333 .ZZ:
5334 @@c++
5335 @end smallexample
5336
5337 Says that .ZZ files are, in fact, C++ source files.
5338
5339 @item #@var{name}
5340 This causes an error messages saying:
5341
5342 @smallexample
5343 @var{name} compiler not installed on this system.
5344 @end smallexample
5345 @end table
5346
5347 GCC already has an extensive list of suffixes built into it.
5348 This directive will add an entry to the end of the list of suffixes, but
5349 since the list is searched from the end backwards, it is effectively
5350 possible to override earlier entries using this technique.
5351
5352 @end table
5353
5354 GCC has the following spec strings built into it.  Spec files can
5355 override these strings or create their own.  Note that individual
5356 targets can also add their own spec strings to this list.
5357
5358 @smallexample
5359 asm          Options to pass to the assembler
5360 asm_final    Options to pass to the assembler post-processor
5361 cpp          Options to pass to the C preprocessor
5362 cc1          Options to pass to the C compiler
5363 cc1plus      Options to pass to the C++ compiler
5364 endfile      Object files to include at the end of the link
5365 link         Options to pass to the linker
5366 lib          Libraries to include on the command line to the linker
5367 libgcc       Decides which GCC support library to pass to the linker
5368 linker       Sets the name of the linker
5369 predefines   Defines to be passed to the C preprocessor
5370 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5371              by default
5372 startfile    Object files to include at the start of the link
5373 @end smallexample
5374
5375 Here is a small example of a spec file:
5376
5377 @smallexample
5378 %rename lib                 old_lib
5379
5380 *lib:
5381 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5382 @end smallexample
5383
5384 This example renames the spec called @samp{lib} to @samp{old_lib} and
5385 then overrides the previous definition of @samp{lib} with a new one.
5386 The new definition adds in some extra command-line options before
5387 including the text of the old definition.
5388
5389 @dfn{Spec strings} are a list of command-line options to be passed to their
5390 corresponding program.  In addition, the spec strings can contain
5391 @samp{%}-prefixed sequences to substitute variable text or to
5392 conditionally insert text into the command line.  Using these constructs
5393 it is possible to generate quite complex command lines.
5394
5395 Here is a table of all defined @samp{%}-sequences for spec
5396 strings.  Note that spaces are not generated automatically around the
5397 results of expanding these sequences.  Therefore you can concatenate them
5398 together or combine them with constant text in a single argument.
5399
5400 @table @code
5401 @item %%
5402 Substitute one @samp{%} into the program name or argument.
5403
5404 @item %i
5405 Substitute the name of the input file being processed.
5406
5407 @item %b
5408 Substitute the basename of the input file being processed.
5409 This is the substring up to (and not including) the last period
5410 and not including the directory.
5411
5412 @item %B
5413 This is the same as @samp{%b}, but include the file suffix (text after
5414 the last period).
5415
5416 @item %d
5417 Marks the argument containing or following the @samp{%d} as a
5418 temporary file name, so that that file will be deleted if GCC exits
5419 successfully.  Unlike @samp{%g}, this contributes no text to the
5420 argument.
5421
5422 @item %g@var{suffix}
5423 Substitute a file name that has suffix @var{suffix} and is chosen
5424 once per compilation, and mark the argument in the same way as
5425 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5426 name is now chosen in a way that is hard to predict even when previously
5427 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5428 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5429 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5430 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5431 was simply substituted with a file name chosen once per compilation,
5432 without regard to any appended suffix (which was therefore treated
5433 just like ordinary text), making such attacks more likely to succeed.
5434
5435 @item %u@var{suffix}
5436 Like @samp{%g}, but generates a new temporary file name even if
5437 @samp{%u@var{suffix}} was already seen.
5438
5439 @item %U@var{suffix}
5440 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5441 new one if there is no such last file name.  In the absence of any
5442 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5443 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5444 would involve the generation of two distinct file names, one
5445 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5446 simply substituted with a file name chosen for the previous @samp{%u},
5447 without regard to any appended suffix.
5448
5449 @item %j@var{suffix}
5450 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5451 writable, and if save-temps is off; otherwise, substitute the name
5452 of a temporary file, just like @samp{%u}.  This temporary file is not
5453 meant for communication between processes, but rather as a junk
5454 disposal mechanism.
5455
5456 @item %|@var{suffix}
5457 @itemx %m@var{suffix}
5458 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5459 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5460 all.  These are the two most common ways to instruct a program that it
5461 should read from standard input or write to standard output.  If you
5462 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5463 construct: see for example @file{f/lang-specs.h}.
5464
5465 @item %.@var{SUFFIX}
5466 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5467 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5468 terminated by the next space or %.
5469
5470 @item %w
5471 Marks the argument containing or following the @samp{%w} as the
5472 designated output file of this compilation.  This puts the argument
5473 into the sequence of arguments that @samp{%o} will substitute later.
5474
5475 @item %o
5476 Substitutes the names of all the output files, with spaces
5477 automatically placed around them.  You should write spaces
5478 around the @samp{%o} as well or the results are undefined.
5479 @samp{%o} is for use in the specs for running the linker.
5480 Input files whose names have no recognized suffix are not compiled
5481 at all, but they are included among the output files, so they will
5482 be linked.
5483
5484 @item %O
5485 Substitutes the suffix for object files.  Note that this is
5486 handled specially when it immediately follows @samp{%g, %u, or %U},
5487 because of the need for those to form complete file names.  The
5488 handling is such that @samp{%O} is treated exactly as if it had already
5489 been substituted, except that @samp{%g, %u, and %U} do not currently
5490 support additional @var{suffix} characters following @samp{%O} as they would
5491 following, for example, @samp{.o}.
5492
5493 @item %p
5494 Substitutes the standard macro predefinitions for the
5495 current target machine.  Use this when running @code{cpp}.
5496
5497 @item %P
5498 Like @samp{%p}, but puts @samp{__} before and after the name of each
5499 predefined macro, except for macros that start with @samp{__} or with
5500 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5501 C@.
5502
5503 @item %I
5504 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5505 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5506 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5507 as necessary.
5508
5509 @item %s
5510 Current argument is the name of a library or startup file of some sort.
5511 Search for that file in a standard list of directories and substitute
5512 the full name found.
5513
5514 @item %e@var{str}
5515 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5516 Use this when inconsistent options are detected.
5517
5518 @item %(@var{name})
5519 Substitute the contents of spec string @var{name} at this point.
5520
5521 @item %[@var{name}]
5522 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5523
5524 @item %x@{@var{option}@}
5525 Accumulate an option for @samp{%X}.
5526
5527 @item %X
5528 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5529 spec string.
5530
5531 @item %Y
5532 Output the accumulated assembler options specified by @option{-Wa}.
5533
5534 @item %Z
5535 Output the accumulated preprocessor options specified by @option{-Wp}.
5536
5537 @item %a
5538 Process the @code{asm} spec.  This is used to compute the
5539 switches to be passed to the assembler.
5540
5541 @item %A
5542 Process the @code{asm_final} spec.  This is a spec string for
5543 passing switches to an assembler post-processor, if such a program is
5544 needed.
5545
5546 @item %l
5547 Process the @code{link} spec.  This is the spec for computing the
5548 command line passed to the linker.  Typically it will make use of the
5549 @samp{%L %G %S %D and %E} sequences.
5550
5551 @item %D
5552 Dump out a @option{-L} option for each directory that GCC believes might
5553 contain startup files.  If the target supports multilibs then the
5554 current multilib directory will be prepended to each of these paths.
5555
5556 @item %M
5557 Output the multilib directory with directory separators replaced with
5558 @samp{_}.  If multilib directories are not set, or the multilib directory is
5559 @file{.} then this option emits nothing.
5560
5561 @item %L
5562 Process the @code{lib} spec.  This is a spec string for deciding which
5563 libraries should be included on the command line to the linker.
5564
5565 @item %G
5566 Process the @code{libgcc} spec.  This is a spec string for deciding
5567 which GCC support library should be included on the command line to the linker.
5568
5569 @item %S
5570 Process the @code{startfile} spec.  This is a spec for deciding which
5571 object files should be the first ones passed to the linker.  Typically
5572 this might be a file named @file{crt0.o}.
5573
5574 @item %E
5575 Process the @code{endfile} spec.  This is a spec string that specifies
5576 the last object files that will be passed to the linker.
5577
5578 @item %C
5579 Process the @code{cpp} spec.  This is used to construct the arguments
5580 to be passed to the C preprocessor.
5581
5582 @item %c
5583 Process the @code{signed_char} spec.  This is intended to be used
5584 to tell cpp whether a char is signed.  It typically has the definition:
5585 @smallexample
5586 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5587 @end smallexample
5588
5589 @item %1
5590 Process the @code{cc1} spec.  This is used to construct the options to be
5591 passed to the actual C compiler (@samp{cc1}).
5592
5593 @item %2
5594 Process the @code{cc1plus} spec.  This is used to construct the options to be
5595 passed to the actual C++ compiler (@samp{cc1plus}).
5596
5597 @item %*
5598 Substitute the variable part of a matched option.  See below.
5599 Note that each comma in the substituted string is replaced by
5600 a single space.
5601
5602 @item %<@code{S}
5603 Remove all occurrences of @code{-S} from the command line.  Note---this
5604 command is position dependent.  @samp{%} commands in the spec string
5605 before this one will see @code{-S}, @samp{%} commands in the spec string
5606 after this one will not.
5607
5608 @item %:@var{function}(@var{args})
5609 Call the named function @var{function}, passing it @var{args}.
5610 @var{args} is first processed as a nested spec string, then split
5611 into an argument vector in the usual fashion.  The function returns
5612 a string which is processed as if it had appeared literally as part
5613 of the current spec.
5614
5615 The following built-in spec functions are provided:
5616
5617 @table @code
5618 @item @code{if-exists}
5619 The @code{if-exists} spec function takes one argument, an absolute
5620 pathname to a file.  If the file exists, @code{if-exists} returns the
5621 pathname.  Here is a small example of its usage:
5622
5623 @smallexample
5624 *startfile:
5625 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5626 @end smallexample
5627
5628 @item @code{if-exists-else}
5629 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5630 spec function, except that it takes two arguments.  The first argument is
5631 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5632 returns the pathname.  If it does not exist, it returns the second argument.
5633 This way, @code{if-exists-else} can be used to select one file or another,
5634 based on the existence of the first.  Here is a small example of its usage:
5635
5636 @smallexample 
5637 *startfile:
5638 crt0%O%s %:if-exists(crti%O%s) \
5639 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5640 @end smallexample
5641 @end table 
5642
5643 @item %@{@code{S}@}
5644 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5645 If that switch was not specified, this substitutes nothing.  Note that
5646 the leading dash is omitted when specifying this option, and it is
5647 automatically inserted if the substitution is performed.  Thus the spec
5648 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5649 and would output the command line option @option{-foo}.
5650
5651 @item %W@{@code{S}@}
5652 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5653 deleted on failure.
5654
5655 @item %@{@code{S}*@}
5656 Substitutes all the switches specified to GCC whose names start
5657 with @code{-S}, but which also take an argument.  This is used for
5658 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5659 GCC considers @option{-o foo} as being
5660 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5661 text, including the space.  Thus two arguments would be generated.
5662
5663 @item %@{@code{S}*&@code{T}*@}
5664 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5665 (the order of @code{S} and @code{T} in the spec is not significant).
5666 There can be any number of ampersand-separated variables; for each the
5667 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5668
5669 @item %@{@code{S}:@code{X}@}
5670 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5671
5672 @item %@{!@code{S}:@code{X}@}
5673 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5674
5675 @item %@{@code{S}*:@code{X}@}
5676 Substitutes @code{X} if one or more switches whose names start with
5677 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5678 once, no matter how many such switches appeared.  However, if @code{%*}
5679 appears somewhere in @code{X}, then @code{X} will be substituted once
5680 for each matching switch, with the @code{%*} replaced by the part of
5681 that switch that matched the @code{*}.
5682
5683 @item %@{.@code{S}:@code{X}@}
5684 Substitutes @code{X}, if processing a file with suffix @code{S}.
5685
5686 @item %@{!.@code{S}:@code{X}@}
5687 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5688
5689 @item %@{@code{S}|@code{P}:@code{X}@}
5690 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5691 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5692 although they have a stronger binding than the @samp{|}.  If @code{%*}
5693 appears in @code{X}, all of the alternatives must be starred, and only
5694 the first matching alternative is substituted.
5695
5696 For example, a spec string like this:
5697
5698 @smallexample
5699 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5700 @end smallexample
5701
5702 will output the following command-line options from the following input
5703 command-line options:
5704
5705 @smallexample
5706 fred.c        -foo -baz
5707 jim.d         -bar -boggle
5708 -d fred.c     -foo -baz -boggle
5709 -d jim.d      -bar -baz -boggle
5710 @end smallexample
5711
5712 @item %@{S:X; T:Y; :D@}
5713
5714 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5715 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5716 be as many clauses as you need.  This may be combined with @code{.}, 
5717 @code{!}, @code{|}, and @code{*} as needed.
5718
5719
5720 @end table
5721
5722 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5723 construct may contain other nested @samp{%} constructs or spaces, or
5724 even newlines.  They are processed as usual, as described above.
5725 Trailing white space in @code{X} is ignored.  White space may also
5726 appear anywhere on the left side of the colon in these constructs,
5727 except between @code{.} or @code{*} and the corresponding word.
5728
5729 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5730 handled specifically in these constructs.  If another value of
5731 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5732 @option{-W} switch is found later in the command line, the earlier
5733 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5734 just one letter, which passes all matching options.
5735
5736 The character @samp{|} at the beginning of the predicate text is used to
5737 indicate that a command should be piped to the following command, but
5738 only if @option{-pipe} is specified.
5739
5740 It is built into GCC which switches take arguments and which do not.
5741 (You might think it would be useful to generalize this to allow each
5742 compiler's spec to say which switches take arguments.  But this cannot
5743 be done in a consistent fashion.  GCC cannot even decide which input
5744 files have been specified without knowing which switches take arguments,
5745 and it must know which input files to compile in order to tell which
5746 compilers to run).
5747
5748 GCC also knows implicitly that arguments starting in @option{-l} are to be
5749 treated as compiler output files, and passed to the linker in their
5750 proper position among the other output files.
5751
5752 @c man begin OPTIONS
5753
5754 @node Target Options
5755 @section Specifying Target Machine and Compiler Version
5756 @cindex target options
5757 @cindex cross compiling
5758 @cindex specifying machine version
5759 @cindex specifying compiler version and target machine
5760 @cindex compiler version, specifying
5761 @cindex target machine, specifying
5762
5763 The usual way to run GCC is to run the executable called @file{gcc}, or
5764 @file{<machine>-gcc} when cross-compiling, or
5765 @file{<machine>-gcc-<version>} to run a version other than the one that
5766 was installed last.  Sometimes this is inconvenient, so GCC provides
5767 options that will switch to another cross-compiler or version.
5768
5769 @table @gcctabopt
5770 @item -b @var{machine}
5771 @opindex b
5772 The argument @var{machine} specifies the target machine for compilation.
5773
5774 The value to use for @var{machine} is the same as was specified as the
5775 machine type when configuring GCC as a cross-compiler.  For
5776 example, if a cross-compiler was configured with @samp{configure
5777 i386v}, meaning to compile for an 80386 running System V, then you
5778 would specify @option{-b i386v} to run that cross compiler.
5779
5780 @item -V @var{version}
5781 @opindex V
5782 The argument @var{version} specifies which version of GCC to run.
5783 This is useful when multiple versions are installed.  For example,
5784 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5785 @end table
5786
5787 The @option{-V} and @option{-b} options work by running the
5788 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5789 use them if you can just run that directly.
5790
5791 @node Submodel Options
5792 @section Hardware Models and Configurations
5793 @cindex submodel options
5794 @cindex specifying hardware config
5795 @cindex hardware models and configurations, specifying
5796 @cindex machine dependent options
5797
5798 Earlier we discussed the standard option @option{-b} which chooses among
5799 different installed compilers for completely different target
5800 machines, such as VAX vs.@: 68000 vs.@: 80386.
5801
5802 In addition, each of these target machine types can have its own
5803 special options, starting with @samp{-m}, to choose among various
5804 hardware models or configurations---for example, 68010 vs 68020,
5805 floating coprocessor or none.  A single installed version of the
5806 compiler can compile for any model or configuration, according to the
5807 options specified.
5808
5809 Some configurations of the compiler also support additional special
5810 options, usually for compatibility with other compilers on the same
5811 platform.
5812
5813 These options are defined by the macro @code{TARGET_SWITCHES} in the
5814 machine description.  The default for the options is also defined by
5815 that macro, which enables you to change the defaults.
5816
5817 @menu
5818 * M680x0 Options::
5819 * M68hc1x Options::
5820 * VAX Options::
5821 * SPARC Options::
5822 * ARM Options::
5823 * MN10300 Options::
5824 * M32R/D Options::
5825 * RS/6000 and PowerPC Options::
5826 * Darwin Options::
5827 * MIPS Options::
5828 * i386 and x86-64 Options::
5829 * HPPA Options::
5830 * Intel 960 Options::
5831 * DEC Alpha Options::
5832 * DEC Alpha/VMS Options::
5833 * H8/300 Options::
5834 * SH Options::
5835 * System V Options::
5836 * TMS320C3x/C4x Options::
5837 * V850 Options::
5838 * ARC Options::
5839 * NS32K Options::
5840 * AVR Options::
5841 * MCore Options::
5842 * IA-64 Options::
5843 * D30V Options::
5844 * S/390 and zSeries Options::
5845 * CRIS Options::
5846 * MMIX Options::
5847 * PDP-11 Options::
5848 * Xstormy16 Options::
5849 * Xtensa Options::
5850 * FRV Options::
5851 @end menu
5852
5853 @node M680x0 Options
5854 @subsection M680x0 Options
5855 @cindex M680x0 options
5856
5857 These are the @samp{-m} options defined for the 68000 series.  The default
5858 values for these options depends on which style of 68000 was selected when
5859 the compiler was configured; the defaults for the most common choices are
5860 given below.
5861
5862 @table @gcctabopt
5863 @item -m68000
5864 @itemx -mc68000
5865 @opindex m68000
5866 @opindex mc68000
5867 Generate output for a 68000.  This is the default
5868 when the compiler is configured for 68000-based systems.
5869
5870 Use this option for microcontrollers with a 68000 or EC000 core,
5871 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5872
5873 @item -m68020
5874 @itemx -mc68020
5875 @opindex m68020
5876 @opindex mc68020
5877 Generate output for a 68020.  This is the default
5878 when the compiler is configured for 68020-based systems.
5879
5880 @item -m68881
5881 @opindex m68881
5882 Generate output containing 68881 instructions for floating point.
5883 This is the default for most 68020 systems unless @option{--nfp} was
5884 specified when the compiler was configured.
5885
5886 @item -m68030
5887 @opindex m68030
5888 Generate output for a 68030.  This is the default when the compiler is
5889 configured for 68030-based systems.
5890
5891 @item -m68040
5892 @opindex m68040
5893 Generate output for a 68040.  This is the default when the compiler is
5894 configured for 68040-based systems.
5895
5896 This option inhibits the use of 68881/68882 instructions that have to be
5897 emulated by software on the 68040.  Use this option if your 68040 does not
5898 have code to emulate those instructions.
5899
5900 @item -m68060
5901 @opindex m68060
5902 Generate output for a 68060.  This is the default when the compiler is
5903 configured for 68060-based systems.
5904
5905 This option inhibits the use of 68020 and 68881/68882 instructions that
5906 have to be emulated by software on the 68060.  Use this option if your 68060
5907 does not have code to emulate those instructions.
5908
5909 @item -mcpu32
5910 @opindex mcpu32
5911 Generate output for a CPU32.  This is the default
5912 when the compiler is configured for CPU32-based systems.
5913
5914 Use this option for microcontrollers with a
5915 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5916 68336, 68340, 68341, 68349 and 68360.
5917
5918 @item -m5200
5919 @opindex m5200
5920 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5921 when the compiler is configured for 520X-based systems.
5922
5923 Use this option for microcontroller with a 5200 core, including
5924 the MCF5202, MCF5203, MCF5204 and MCF5202.
5925
5926
5927 @item -m68020-40
5928 @opindex m68020-40
5929 Generate output for a 68040, without using any of the new instructions.
5930 This results in code which can run relatively efficiently on either a
5931 68020/68881 or a 68030 or a 68040.  The generated code does use the
5932 68881 instructions that are emulated on the 68040.
5933
5934 @item -m68020-60
5935 @opindex m68020-60
5936 Generate output for a 68060, without using any of the new instructions.
5937 This results in code which can run relatively efficiently on either a
5938 68020/68881 or a 68030 or a 68040.  The generated code does use the
5939 68881 instructions that are emulated on the 68060.
5940
5941 @item -msoft-float
5942 @opindex msoft-float
5943 Generate output containing library calls for floating point.
5944 @strong{Warning:} the requisite libraries are not available for all m68k
5945 targets.  Normally the facilities of the machine's usual C compiler are
5946 used, but this can't be done directly in cross-compilation.  You must
5947 make your own arrangements to provide suitable library functions for
5948 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5949 @samp{m68k-*-coff} do provide software floating point support.
5950
5951 @item -mshort
5952 @opindex mshort
5953 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5954
5955 @item -mnobitfield
5956 @opindex mnobitfield
5957 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5958 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5959
5960 @item -mbitfield
5961 @opindex mbitfield
5962 Do use the bit-field instructions.  The @option{-m68020} option implies
5963 @option{-mbitfield}.  This is the default if you use a configuration
5964 designed for a 68020.
5965
5966 @item -mrtd
5967 @opindex mrtd
5968 Use a different function-calling convention, in which functions
5969 that take a fixed number of arguments return with the @code{rtd}
5970 instruction, which pops their arguments while returning.  This
5971 saves one instruction in the caller since there is no need to pop
5972 the arguments there.
5973
5974 This calling convention is incompatible with the one normally
5975 used on Unix, so you cannot use it if you need to call libraries
5976 compiled with the Unix compiler.
5977
5978 Also, you must provide function prototypes for all functions that
5979 take variable numbers of arguments (including @code{printf});
5980 otherwise incorrect code will be generated for calls to those
5981 functions.
5982
5983 In addition, seriously incorrect code will result if you call a
5984 function with too many arguments.  (Normally, extra arguments are
5985 harmlessly ignored.)
5986
5987 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5988 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5989
5990 @item -malign-int
5991 @itemx -mno-align-int
5992 @opindex malign-int
5993 @opindex mno-align-int
5994 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5995 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5996 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5997 Aligning variables on 32-bit boundaries produces code that runs somewhat
5998 faster on processors with 32-bit busses at the expense of more memory.
5999
6000 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6001 align structures containing the above types  differently than
6002 most published application binary interface specifications for the m68k.
6003
6004 @item -mpcrel
6005 @opindex mpcrel
6006 Use the pc-relative addressing mode of the 68000 directly, instead of
6007 using a global offset table.  At present, this option implies @option{-fpic},
6008 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6009 not presently supported with @option{-mpcrel}, though this could be supported for
6010 68020 and higher processors.
6011
6012 @item -mno-strict-align
6013 @itemx -mstrict-align
6014 @opindex mno-strict-align
6015 @opindex mstrict-align
6016 Do not (do) assume that unaligned memory references will be handled by
6017 the system.
6018
6019 @item -msep-data
6020 Generate code that allows the data segment to be located in a different
6021 area of memory from the text segment.  This allows for execute in place in
6022 an environment without virtual memory management.  This option implies -fPIC.
6023
6024 @item -mno-sep-data
6025 Generate code that assumes that the data segment follows the text segment.
6026 This is the default.
6027
6028 @item -mid-shared-library
6029 Generate code that supports shared libraries via the library ID method.
6030 This allows for execute in place and shared libraries in an environment
6031 without virtual memory management.  This option implies -fPIC.
6032
6033 @item -mno-id-shared-library
6034 Generate code that doesn't assume ID based shared libraries are being used.
6035 This is the default.
6036
6037 @item -mshared-library-id=n
6038 Specified the identification number of the ID based shared library being
6039 compiled.  Specifying a value of 0 will generate more compact code, specifying
6040 other values will force the allocation of that number to the current
6041 library but is no more space or time efficient than omitting this option.
6042
6043 @end table
6044
6045 @node M68hc1x Options
6046 @subsection M68hc1x Options
6047 @cindex M68hc1x options
6048
6049 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6050 microcontrollers.  The default values for these options depends on
6051 which style of microcontroller was selected when the compiler was configured;
6052 the defaults for the most common choices are given below.
6053
6054 @table @gcctabopt
6055 @item -m6811
6056 @itemx -m68hc11
6057 @opindex m6811
6058 @opindex m68hc11
6059 Generate output for a 68HC11.  This is the default
6060 when the compiler is configured for 68HC11-based systems.
6061
6062 @item -m6812
6063 @itemx -m68hc12
6064 @opindex m6812
6065 @opindex m68hc12
6066 Generate output for a 68HC12.  This is the default
6067 when the compiler is configured for 68HC12-based systems.
6068
6069 @item -m68S12
6070 @itemx -m68hcs12
6071 @opindex m68S12
6072 @opindex m68hcs12
6073 Generate output for a 68HCS12.  
6074
6075 @item -mauto-incdec
6076 @opindex mauto-incdec
6077 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6078 addressing modes.
6079
6080 @item -minmax
6081 @itemx -nominmax
6082 @opindex minmax
6083 @opindex mnominmax
6084 Enable the use of 68HC12 min and max instructions.
6085
6086 @item -mlong-calls
6087 @itemx -mno-long-calls
6088 @opindex mlong-calls
6089 @opindex mno-long-calls
6090 Treat all calls as being far away (near).  If calls are assumed to be
6091 far away, the compiler will use the @code{call} instruction to
6092 call a function and the @code{rtc} instruction for returning.
6093
6094 @item -mshort
6095 @opindex mshort
6096 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6097
6098 @item -msoft-reg-count=@var{count}
6099 @opindex msoft-reg-count
6100 Specify the number of pseudo-soft registers which are used for the
6101 code generation.  The maximum number is 32.  Using more pseudo-soft
6102 register may or may not result in better code depending on the program.
6103 The default is 4 for 68HC11 and 2 for 68HC12.
6104
6105 @end table
6106
6107 @node VAX Options
6108 @subsection VAX Options
6109 @cindex VAX options
6110
6111 These @samp{-m} options are defined for the VAX:
6112
6113 @table @gcctabopt
6114 @item -munix
6115 @opindex munix
6116 Do not output certain jump instructions (@code{aobleq} and so on)
6117 that the Unix assembler for the VAX cannot handle across long
6118 ranges.
6119
6120 @item -mgnu
6121 @opindex mgnu
6122 Do output those jump instructions, on the assumption that you
6123 will assemble with the GNU assembler.
6124
6125 @item -mg
6126 @opindex mg
6127 Output code for g-format floating point numbers instead of d-format.
6128 @end table
6129
6130 @node SPARC Options
6131 @subsection SPARC Options
6132 @cindex SPARC options
6133
6134 These @samp{-m} switches are supported on the SPARC:
6135
6136 @table @gcctabopt
6137 @item -mno-app-regs
6138 @itemx -mapp-regs
6139 @opindex mno-app-regs
6140 @opindex mapp-regs
6141 Specify @option{-mapp-regs} to generate output using the global registers
6142 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6143 is the default.
6144
6145 To be fully SVR4 ABI compliant at the cost of some performance loss,
6146 specify @option{-mno-app-regs}.  You should compile libraries and system
6147 software with this option.
6148
6149 @item -mfpu
6150 @itemx -mhard-float
6151 @opindex mfpu
6152 @opindex mhard-float
6153 Generate output containing floating point instructions.  This is the
6154 default.
6155
6156 @item -mno-fpu
6157 @itemx -msoft-float
6158 @opindex mno-fpu
6159 @opindex msoft-float
6160 Generate output containing library calls for floating point.
6161 @strong{Warning:} the requisite libraries are not available for all SPARC
6162 targets.  Normally the facilities of the machine's usual C compiler are
6163 used, but this cannot be done directly in cross-compilation.  You must make
6164 your own arrangements to provide suitable library functions for
6165 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6166 @samp{sparclite-*-*} do provide software floating point support.
6167
6168 @option{-msoft-float} changes the calling convention in the output file;
6169 therefore, it is only useful if you compile @emph{all} of a program with
6170 this option.  In particular, you need to compile @file{libgcc.a}, the
6171 library that comes with GCC, with @option{-msoft-float} in order for
6172 this to work.
6173
6174 @item -mhard-quad-float
6175 @opindex mhard-quad-float
6176 Generate output containing quad-word (long double) floating point
6177 instructions.
6178
6179 @item -msoft-quad-float
6180 @opindex msoft-quad-float
6181 Generate output containing library calls for quad-word (long double)
6182 floating point instructions.  The functions called are those specified
6183 in the SPARC ABI@.  This is the default.
6184
6185 As of this writing, there are no sparc implementations that have hardware
6186 support for the quad-word floating point instructions.  They all invoke
6187 a trap handler for one of these instructions, and then the trap handler
6188 emulates the effect of the instruction.  Because of the trap handler overhead,
6189 this is much slower than calling the ABI library routines.  Thus the
6190 @option{-msoft-quad-float} option is the default.
6191
6192 @item -mno-flat
6193 @itemx -mflat
6194 @opindex mno-flat
6195 @opindex mflat
6196 With @option{-mflat}, the compiler does not generate save/restore instructions
6197 and will use a ``flat'' or single register window calling convention.
6198 This model uses %i7 as the frame pointer and is compatible with the normal
6199 register window model.  Code from either may be intermixed.
6200 The local registers and the input registers (0--5) are still treated as
6201 ``call saved'' registers and will be saved on the stack as necessary.
6202
6203 With @option{-mno-flat} (the default), the compiler emits save/restore
6204 instructions (except for leaf functions) and is the normal mode of operation.
6205
6206 @item -mno-unaligned-doubles
6207 @itemx -munaligned-doubles
6208 @opindex mno-unaligned-doubles
6209 @opindex munaligned-doubles
6210 Assume that doubles have 8 byte alignment.  This is the default.
6211
6212 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6213 alignment only if they are contained in another type, or if they have an
6214 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6215 Specifying this option avoids some rare compatibility problems with code
6216 generated by other compilers.  It is not the default because it results
6217 in a performance loss, especially for floating point code.
6218
6219 @item -mno-faster-structs
6220 @itemx -mfaster-structs
6221 @opindex mno-faster-structs
6222 @opindex mfaster-structs
6223 With @option{-mfaster-structs}, the compiler assumes that structures
6224 should have 8 byte alignment.  This enables the use of pairs of
6225 @code{ldd} and @code{std} instructions for copies in structure
6226 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6227 However, the use of this changed alignment directly violates the SPARC
6228 ABI@.  Thus, it's intended only for use on targets where the developer
6229 acknowledges that their resulting code will not be directly in line with
6230 the rules of the ABI@.
6231
6232 @item -mimpure-text
6233 @opindex mimpure-text
6234 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6235 the compiler to not pass @option{-z text} to the linker when linking a
6236 shared object.  Using this option, you can link position-dependent
6237 code into a shared object.  
6238
6239 @option{-mimpure-text} suppresses the ``relocations remain against
6240 allocatable but non-writable sections'' linker error message.
6241 However, the necessary relocations will trigger copy-on-write, and the
6242 shared object is not actually shared across processes.  Instead of
6243 using @option{-mimpure-text}, you should compile all source code with
6244 @option{-fpic} or @option{-fPIC}.
6245
6246 This option is only available on SunOS and Solaris.
6247
6248 @item -mv8
6249 @itemx -msparclite
6250 @opindex mv8
6251 @opindex msparclite
6252 These two options select variations on the SPARC architecture.
6253
6254 By default (unless specifically configured for the Fujitsu SPARClite),
6255 GCC generates code for the v7 variant of the SPARC architecture.
6256
6257 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6258 code is that the compiler emits the integer multiply and integer
6259 divide instructions which exist in SPARC v8 but not in SPARC v7.
6260
6261 @option{-msparclite} will give you SPARClite code.  This adds the integer
6262 multiply, integer divide step and scan (@code{ffs}) instructions which
6263 exist in SPARClite but not in SPARC v7.
6264
6265 These options are deprecated and will be deleted in a future GCC release.
6266 They have been replaced with @option{-mcpu=xxx}.
6267
6268 @item -mcypress
6269 @itemx -msupersparc
6270 @opindex mcypress
6271 @opindex msupersparc
6272 These two options select the processor for which the code is optimized.
6273
6274 With @option{-mcypress} (the default), the compiler optimizes code for the
6275 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6276 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6277
6278 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6279 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6280 of the full SPARC v8 instruction set.
6281
6282 These options are deprecated and will be deleted in a future GCC release.
6283 They have been replaced with @option{-mcpu=xxx}.
6284
6285 @item -mcpu=@var{cpu_type}
6286 @opindex mcpu
6287 Set the instruction set, register set, and instruction scheduling parameters
6288 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6289 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6290 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6291 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6292 @samp{ultrasparc3}.
6293
6294 Default instruction scheduling parameters are used for values that select
6295 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6296 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6297
6298 Here is a list of each supported architecture and their supported
6299 implementations.
6300
6301 @smallexample
6302     v7:             cypress
6303     v8:             supersparc, hypersparc
6304     sparclite:      f930, f934, sparclite86x
6305     sparclet:       tsc701
6306     v9:             ultrasparc, ultrasparc3
6307 @end smallexample
6308
6309 @item -mtune=@var{cpu_type}
6310 @opindex mtune
6311 Set the instruction scheduling parameters for machine type
6312 @var{cpu_type}, but do not set the instruction set or register set that the
6313 option @option{-mcpu=@var{cpu_type}} would.
6314
6315 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6316 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6317 that select a particular cpu implementation.  Those are @samp{cypress},
6318 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6319 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6320 @samp{ultrasparc3}.
6321
6322 @end table
6323
6324 These @samp{-m} switches are supported in addition to the above
6325 on the SPARCLET processor.
6326
6327 @table @gcctabopt
6328 @item -mlittle-endian
6329 @opindex mlittle-endian
6330 Generate code for a processor running in little-endian mode.
6331
6332 @item -mlive-g0
6333 @opindex mlive-g0
6334 Treat register @code{%g0} as a normal register.
6335 GCC will continue to clobber it as necessary but will not assume
6336 it always reads as 0.
6337
6338 @item -mbroken-saverestore
6339 @opindex mbroken-saverestore
6340 Generate code that does not use non-trivial forms of the @code{save} and
6341 @code{restore} instructions.  Early versions of the SPARCLET processor do
6342 not correctly handle @code{save} and @code{restore} instructions used with
6343 arguments.  They correctly handle them used without arguments.  A @code{save}
6344 instruction used without arguments increments the current window pointer
6345 but does not allocate a new stack frame.  It is assumed that the window
6346 overflow trap handler will properly handle this case as will interrupt
6347 handlers.
6348 @end table
6349
6350 These @samp{-m} switches are supported in addition to the above
6351 on SPARC V9 processors in 64-bit environments.
6352
6353 @table @gcctabopt
6354 @item -mlittle-endian
6355 @opindex mlittle-endian
6356 Generate code for a processor running in little-endian mode. It is only
6357 available for a few configurations and most notably not on Solaris.
6358
6359 @item -m32
6360 @itemx -m64
6361 @opindex m32
6362 @opindex m64
6363 Generate code for a 32-bit or 64-bit environment.
6364 The 32-bit environment sets int, long and pointer to 32 bits.
6365 The 64-bit environment sets int to 32 bits and long and pointer
6366 to 64 bits.
6367
6368 @item -mcmodel=medlow
6369 @opindex mcmodel=medlow
6370 Generate code for the Medium/Low code model: the program must be linked
6371 in the low 32 bits of the address space.  Pointers are 64 bits.
6372 Programs can be statically or dynamically linked.
6373
6374 @item -mcmodel=medmid
6375 @opindex mcmodel=medmid
6376 Generate code for the Medium/Middle code model: the program must be linked
6377 in the low 44 bits of the address space, the text segment must be less than
6378 2G bytes, and data segment must be within 2G of the text segment.
6379 Pointers are 64 bits.
6380
6381 @item -mcmodel=medany
6382 @opindex mcmodel=medany
6383 Generate code for the Medium/Anywhere code model: the program may be linked
6384 anywhere in the address space, the text segment must be less than
6385 2G bytes, and data segment must be within 2G of the text segment.
6386 Pointers are 64 bits.
6387
6388 @item -mcmodel=embmedany
6389 @opindex mcmodel=embmedany
6390 Generate code for the Medium/Anywhere code model for embedded systems:
6391 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6392 (determined at link time).  Register %g4 points to the base of the
6393 data segment.  Pointers are still 64 bits.
6394 Programs are statically linked, PIC is not supported.
6395
6396 @item -mstack-bias
6397 @itemx -mno-stack-bias
6398 @opindex mstack-bias
6399 @opindex mno-stack-bias
6400 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6401 frame pointer if present, are offset by @minus{}2047 which must be added back
6402 when making stack frame references.
6403 Otherwise, assume no such offset is present.
6404 @end table
6405
6406 @node ARM Options
6407 @subsection ARM Options
6408 @cindex ARM options
6409
6410 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6411 architectures:
6412
6413 @table @gcctabopt
6414 @item -mapcs-frame
6415 @opindex mapcs-frame
6416 Generate a stack frame that is compliant with the ARM Procedure Call
6417 Standard for all functions, even if this is not strictly necessary for
6418 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6419 with this option will cause the stack frames not to be generated for
6420 leaf functions.  The default is @option{-mno-apcs-frame}.
6421
6422 @item -mapcs
6423 @opindex mapcs
6424 This is a synonym for @option{-mapcs-frame}.
6425
6426 @item -mapcs-26
6427 @opindex mapcs-26
6428 Generate code for a processor running with a 26-bit program counter,
6429 and conforming to the function calling standards for the APCS 26-bit
6430 option.  This option replaces the @option{-m2} and @option{-m3} options
6431 of previous releases of the compiler.
6432
6433 @item -mapcs-32
6434 @opindex mapcs-32
6435 Generate code for a processor running with a 32-bit program counter,
6436 and conforming to the function calling standards for the APCS 32-bit
6437 option.  This option replaces the @option{-m6} option of previous releases
6438 of the compiler.
6439
6440 @ignore
6441 @c not currently implemented
6442 @item -mapcs-stack-check
6443 @opindex mapcs-stack-check
6444 Generate code to check the amount of stack space available upon entry to
6445 every function (that actually uses some stack space).  If there is
6446 insufficient space available then either the function
6447 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6448 called, depending upon the amount of stack space required.  The run time
6449 system is required to provide these functions.  The default is
6450 @option{-mno-apcs-stack-check}, since this produces smaller code.
6451
6452 @c not currently implemented
6453 @item -mapcs-float
6454 @opindex mapcs-float
6455 Pass floating point arguments using the float point registers.  This is
6456 one of the variants of the APCS@.  This option is recommended if the
6457 target hardware has a floating point unit or if a lot of floating point
6458 arithmetic is going to be performed by the code.  The default is
6459 @option{-mno-apcs-float}, since integer only code is slightly increased in
6460 size if @option{-mapcs-float} is used.
6461
6462 @c not currently implemented
6463 @item -mapcs-reentrant
6464 @opindex mapcs-reentrant
6465 Generate reentrant, position independent code.  The default is
6466 @option{-mno-apcs-reentrant}.
6467 @end ignore
6468
6469 @item -mthumb-interwork
6470 @opindex mthumb-interwork
6471 Generate code which supports calling between the ARM and Thumb
6472 instruction sets.  Without this option the two instruction sets cannot
6473 be reliably used inside one program.  The default is
6474 @option{-mno-thumb-interwork}, since slightly larger code is generated
6475 when @option{-mthumb-interwork} is specified.
6476
6477 @item -mno-sched-prolog
6478 @opindex mno-sched-prolog
6479 Prevent the reordering of instructions in the function prolog, or the
6480 merging of those instruction with the instructions in the function's
6481 body.  This means that all functions will start with a recognizable set
6482 of instructions (or in fact one of a choice from a small set of
6483 different function prologues), and this information can be used to
6484 locate the start if functions inside an executable piece of code.  The
6485 default is @option{-msched-prolog}.
6486
6487 @item -mhard-float
6488 @opindex mhard-float
6489 Generate output containing floating point instructions.  This is the
6490 default.
6491
6492 @item -msoft-float
6493 @opindex msoft-float
6494 Generate output containing library calls for floating point.
6495 @strong{Warning:} the requisite libraries are not available for all ARM
6496 targets.  Normally the facilities of the machine's usual C compiler are
6497 used, but this cannot be done directly in cross-compilation.  You must make
6498 your own arrangements to provide suitable library functions for
6499 cross-compilation.
6500
6501 @option{-msoft-float} changes the calling convention in the output file;
6502 therefore, it is only useful if you compile @emph{all} of a program with
6503 this option.  In particular, you need to compile @file{libgcc.a}, the
6504 library that comes with GCC, with @option{-msoft-float} in order for
6505 this to work.
6506
6507 @item -mlittle-endian
6508 @opindex mlittle-endian
6509 Generate code for a processor running in little-endian mode.  This is
6510 the default for all standard configurations.
6511
6512 @item -mbig-endian
6513 @opindex mbig-endian
6514 Generate code for a processor running in big-endian mode; the default is
6515 to compile code for a little-endian processor.
6516
6517 @item -mwords-little-endian
6518 @opindex mwords-little-endian
6519 This option only applies when generating code for big-endian processors.
6520 Generate code for a little-endian word order but a big-endian byte
6521 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6522 option should only be used if you require compatibility with code for
6523 big-endian ARM processors generated by versions of the compiler prior to
6524 2.8.
6525
6526 @item -malignment-traps
6527 @opindex malignment-traps
6528 Generate code that will not trap if the MMU has alignment traps enabled.
6529 On ARM architectures prior to ARMv4, there were no instructions to
6530 access half-word objects stored in memory.  However, when reading from
6531 memory a feature of the ARM architecture allows a word load to be used,
6532 even if the address is unaligned, and the processor core will rotate the
6533 data as it is being loaded.  This option tells the compiler that such
6534 misaligned accesses will cause a MMU trap and that it should instead
6535 synthesize the access as a series of byte accesses.  The compiler can
6536 still use word accesses to load half-word data if it knows that the
6537 address is aligned to a word boundary.
6538
6539 This option is ignored when compiling for ARM architecture 4 or later,
6540 since these processors have instructions to directly access half-word
6541 objects in memory.
6542
6543 @item -mno-alignment-traps
6544 @opindex mno-alignment-traps
6545 Generate code that assumes that the MMU will not trap unaligned
6546 accesses.  This produces better code when the target instruction set
6547 does not have half-word memory operations (i.e.@: implementations prior to
6548 ARMv4).
6549
6550 Note that you cannot use this option to access unaligned word objects,
6551 since the processor will only fetch one 32-bit aligned object from
6552 memory.
6553
6554 The default setting for most targets is @option{-mno-alignment-traps}, since
6555 this produces better code when there are no half-word memory
6556 instructions available.
6557
6558 @item -mshort-load-bytes
6559 @itemx -mno-short-load-words
6560 @opindex mshort-load-bytes
6561 @opindex mno-short-load-words
6562 These are deprecated aliases for @option{-malignment-traps}.
6563
6564 @item -mno-short-load-bytes
6565 @itemx -mshort-load-words
6566 @opindex mno-short-load-bytes
6567 @opindex mshort-load-words
6568 This are deprecated aliases for @option{-mno-alignment-traps}.
6569
6570 @item -mcpu=@var{name}
6571 @opindex mcpu
6572 This specifies the name of the target ARM processor.  GCC uses this name
6573 to determine what kind of instructions it can emit when generating
6574 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6575 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6576 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6577 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6578 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6579 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6580 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6581 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6582 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6583 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6584 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6585 @samp{ep9312}.
6586
6587 @itemx -mtune=@var{name}
6588 @opindex mtune
6589 This option is very similar to the @option{-mcpu=} option, except that
6590 instead of specifying the actual target processor type, and hence
6591 restricting which instructions can be used, it specifies that GCC should
6592 tune the performance of the code as if the target were of the type
6593 specified in this option, but still choosing the instructions that it
6594 will generate based on the cpu specified by a @option{-mcpu=} option.
6595 For some ARM implementations better performance can be obtained by using
6596 this option.
6597
6598 @item -march=@var{name}
6599 @opindex march
6600 This specifies the name of the target ARM architecture.  GCC uses this
6601 name to determine what kind of instructions it can emit when generating
6602 assembly code.  This option can be used in conjunction with or instead
6603 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6604 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6605 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6606 @samp{iwmmxt}, @samp{ep9312}.
6607
6608 @item -mfpe=@var{number}
6609 @itemx -mfp=@var{number}
6610 @opindex mfpe
6611 @opindex mfp
6612 This specifies the version of the floating point emulation available on
6613 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6614 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6615
6616 @item -mstructure-size-boundary=@var{n}
6617 @opindex mstructure-size-boundary
6618 The size of all structures and unions will be rounded up to a multiple
6619 of the number of bits set by this option.  Permissible values are 8 and
6620 32.  The default value varies for different toolchains.  For the COFF
6621 targeted toolchain the default value is 8.  Specifying the larger number
6622 can produce faster, more efficient code, but can also increase the size
6623 of the program.  The two values are potentially incompatible.  Code
6624 compiled with one value cannot necessarily expect to work with code or
6625 libraries compiled with the other value, if they exchange information
6626 using structures or unions.
6627
6628 @item -mabort-on-noreturn
6629 @opindex mabort-on-noreturn
6630 Generate a call to the function @code{abort} at the end of a
6631 @code{noreturn} function.  It will be executed if the function tries to
6632 return.
6633
6634 @item -mlong-calls
6635 @itemx -mno-long-calls
6636 @opindex mlong-calls
6637 @opindex mno-long-calls
6638 Tells the compiler to perform function calls by first loading the
6639 address of the function into a register and then performing a subroutine
6640 call on this register.  This switch is needed if the target function
6641 will lie outside of the 64 megabyte addressing range of the offset based
6642 version of subroutine call instruction.
6643
6644 Even if this switch is enabled, not all function calls will be turned
6645 into long calls.  The heuristic is that static functions, functions
6646 which have the @samp{short-call} attribute, functions that are inside
6647 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6648 definitions have already been compiled within the current compilation
6649 unit, will not be turned into long calls.  The exception to this rule is
6650 that weak function definitions, functions with the @samp{long-call}
6651 attribute or the @samp{section} attribute, and functions that are within
6652 the scope of a @samp{#pragma long_calls} directive, will always be
6653 turned into long calls.
6654
6655 This feature is not enabled by default.  Specifying
6656 @option{-mno-long-calls} will restore the default behavior, as will
6657 placing the function calls within the scope of a @samp{#pragma
6658 long_calls_off} directive.  Note these switches have no effect on how
6659 the compiler generates code to handle function calls via function
6660 pointers.
6661
6662 @item -mnop-fun-dllimport
6663 @opindex mnop-fun-dllimport
6664 Disable support for the @code{dllimport} attribute.
6665
6666 @item -msingle-pic-base
6667 @opindex msingle-pic-base
6668 Treat the register used for PIC addressing as read-only, rather than
6669 loading it in the prologue for each function.  The run-time system is
6670 responsible for initializing this register with an appropriate value
6671 before execution begins.
6672
6673 @item -mpic-register=@var{reg}
6674 @opindex mpic-register
6675 Specify the register to be used for PIC addressing.  The default is R10
6676 unless stack-checking is enabled, when R9 is used.
6677
6678 @item -mcirrus-fix-invalid-insns
6679 @opindex mcirrus-fix-invalid-insns
6680 @opindex mno-cirrus-fix-invalid-insns
6681 Insert NOPs into the instruction stream to in order to work around
6682 problems with invalid Maverick instruction combinations.  This option
6683 is only valid if the @option{-mcpu=ep9312} option has been used to
6684 enable generation of instructions for the Cirrus Maverick floating
6685 point co-processor.  This option is not enabled by default, since the
6686 problem is only present in older Maverick implementations.  The default
6687 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6688 switch.
6689
6690 @item -mpoke-function-name
6691 @opindex mpoke-function-name
6692 Write the name of each function into the text section, directly
6693 preceding the function prologue.  The generated code is similar to this:
6694
6695 @smallexample
6696      t0
6697          .ascii "arm_poke_function_name", 0
6698          .align
6699      t1
6700          .word 0xff000000 + (t1 - t0)
6701      arm_poke_function_name
6702          mov     ip, sp
6703          stmfd   sp!, @{fp, ip, lr, pc@}
6704          sub     fp, ip, #4
6705 @end smallexample
6706
6707 When performing a stack backtrace, code can inspect the value of
6708 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6709 location @code{pc - 12} and the top 8 bits are set, then we know that
6710 there is a function name embedded immediately preceding this location
6711 and has length @code{((pc[-3]) & 0xff000000)}.
6712
6713 @item -mthumb
6714 @opindex mthumb
6715 Generate code for the 16-bit Thumb instruction set.  The default is to
6716 use the 32-bit ARM instruction set.
6717
6718 @item -mtpcs-frame
6719 @opindex mtpcs-frame
6720 Generate a stack frame that is compliant with the Thumb Procedure Call
6721 Standard for all non-leaf functions.  (A leaf function is one that does
6722 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6723
6724 @item -mtpcs-leaf-frame
6725 @opindex mtpcs-leaf-frame
6726 Generate a stack frame that is compliant with the Thumb Procedure Call
6727 Standard for all leaf functions.  (A leaf function is one that does
6728 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6729
6730 @item -mcallee-super-interworking
6731 @opindex mcallee-super-interworking
6732 Gives all externally visible functions in the file being compiled an ARM
6733 instruction set header which switches to Thumb mode before executing the
6734 rest of the function.  This allows these functions to be called from
6735 non-interworking code.
6736
6737 @item -mcaller-super-interworking
6738 @opindex mcaller-super-interworking
6739 Allows calls via function pointers (including virtual functions) to
6740 execute correctly regardless of whether the target code has been
6741 compiled for interworking or not.  There is a small overhead in the cost
6742 of executing a function pointer if this option is enabled.
6743
6744 @end table
6745
6746 @node MN10300 Options
6747 @subsection MN10300 Options
6748 @cindex MN10300 options
6749
6750 These @option{-m} options are defined for Matsushita MN10300 architectures:
6751
6752 @table @gcctabopt
6753 @item -mmult-bug
6754 @opindex mmult-bug
6755 Generate code to avoid bugs in the multiply instructions for the MN10300
6756 processors.  This is the default.
6757
6758 @item -mno-mult-bug
6759 @opindex mno-mult-bug
6760 Do not generate code to avoid bugs in the multiply instructions for the
6761 MN10300 processors.
6762
6763 @item -mam33
6764 @opindex mam33
6765 Generate code which uses features specific to the AM33 processor.
6766
6767 @item -mno-am33
6768 @opindex mno-am33
6769 Do not generate code which uses features specific to the AM33 processor.  This
6770 is the default.
6771
6772 @item -mno-crt0
6773 @opindex mno-crt0
6774 Do not link in the C run-time initialization object file.
6775
6776 @item -mrelax
6777 @opindex mrelax
6778 Indicate to the linker that it should perform a relaxation optimization pass
6779 to shorten branches, calls and absolute memory addresses.  This option only
6780 has an effect when used on the command line for the final link step.
6781
6782 This option makes symbolic debugging impossible.
6783 @end table
6784
6785
6786 @node M32R/D Options
6787 @subsection M32R/D Options
6788 @cindex M32R/D options
6789
6790 These @option{-m} options are defined for Renesas M32R/D architectures:
6791
6792 @table @gcctabopt
6793 @item -m32r2
6794 @opindex m32r2
6795 Generate code for the M32R/2@.
6796
6797 @item -m32rx
6798 @opindex m32rx
6799 Generate code for the M32R/X@.
6800
6801 @item -m32r
6802 @opindex m32r
6803 Generate code for the M32R@.  This is the default.
6804
6805 @item -mmodel=small
6806 @opindex mmodel=small
6807 Assume all objects live in the lower 16MB of memory (so that their addresses
6808 can be loaded with the @code{ld24} instruction), and assume all subroutines
6809 are reachable with the @code{bl} instruction.
6810 This is the default.
6811
6812 The addressability of a particular object can be set with the
6813 @code{model} attribute.
6814
6815 @item -mmodel=medium
6816 @opindex mmodel=medium
6817 Assume objects may be anywhere in the 32-bit address space (the compiler
6818 will generate @code{seth/add3} instructions to load their addresses), and
6819 assume all subroutines are reachable with the @code{bl} instruction.
6820
6821 @item -mmodel=large
6822 @opindex mmodel=large
6823 Assume objects may be anywhere in the 32-bit address space (the compiler
6824 will generate @code{seth/add3} instructions to load their addresses), and
6825 assume subroutines may not be reachable with the @code{bl} instruction
6826 (the compiler will generate the much slower @code{seth/add3/jl}
6827 instruction sequence).
6828
6829 @item -msdata=none
6830 @opindex msdata=none
6831 Disable use of the small data area.  Variables will be put into
6832 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6833 @code{section} attribute has been specified).
6834 This is the default.
6835
6836 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6837 Objects may be explicitly put in the small data area with the
6838 @code{section} attribute using one of these sections.
6839
6840 @item -msdata=sdata
6841 @opindex msdata=sdata
6842 Put small global and static data in the small data area, but do not
6843 generate special code to reference them.
6844
6845 @item -msdata=use
6846 @opindex msdata=use
6847 Put small global and static data in the small data area, and generate
6848 special instructions to reference them.
6849
6850 @item -G @var{num}
6851 @opindex G
6852 @cindex smaller data references
6853 Put global and static objects less than or equal to @var{num} bytes
6854 into the small data or bss sections instead of the normal data or bss
6855 sections.  The default value of @var{num} is 8.
6856 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6857 for this option to have any effect.
6858
6859 All modules should be compiled with the same @option{-G @var{num}} value.
6860 Compiling with different values of @var{num} may or may not work; if it
6861 doesn't the linker will give an error message---incorrect code will not be
6862 generated.
6863
6864 @item -mdebug
6865 @opindex -mdebug
6866 Makes the M32R specific code in the compiler display some statistics
6867 that might help in debugging programs.
6868
6869 @item -malign-loops
6870 @opindex malign-loops
6871 Align all loops to a 32-byte boundary.
6872
6873 @item -mno-align-loops
6874 @opindex mno-align-loops
6875 Do not enforce a 32-byte alignment for loops.  This is the default.
6876
6877 @item -missue-rate=@var{number}
6878 @opindex missue-rate=@var{number}
6879 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6880 or 2.
6881
6882 @item -mbranch-cost=@var{number}
6883 @opindex mbranch-cost=@var{number}
6884 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6885 prefered over conditional code, if it is 2, then the opposite will
6886 apply.
6887
6888 @item -mflush-trap=@var{number}
6889 @opindex mflush-trap=@var{number}
6890 Specifies the trap number to use to flush the cache.  The default is
6891 12.  Valid numbers are between 0 and 15 inclusive.
6892
6893 @item -mno-flush-trap
6894 @opindex mno-flush-trap
6895 Specifies that the cache cannot be flushed by using a trap.
6896
6897 @item -mflush-func=@var{name}
6898 @opindex mflush-func=@var{name}
6899 Specifies the name of the operating system function to call to flush
6900 the cache.  The default is @emph{_flush_cache}, but a function call
6901 will only be used if a trap is not available.
6902
6903 @item -mno-flush-func
6904 @opindex mno-flush-func
6905 Indicates that there is no OS function for flushing the cache.
6906
6907 @end table
6908
6909 @c break page here to avoid unsightly interparagraph stretch.
6910 @c -zw, 2001-8-17
6911 @page
6912
6913 @node RS/6000 and PowerPC Options
6914 @subsection IBM RS/6000 and PowerPC Options
6915 @cindex RS/6000 and PowerPC Options
6916 @cindex IBM RS/6000 and PowerPC Options
6917
6918 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6919 @table @gcctabopt
6920 @item -mpower
6921 @itemx -mno-power
6922 @itemx -mpower2
6923 @itemx -mno-power2
6924 @itemx -mpowerpc
6925 @itemx -mno-powerpc
6926 @itemx -mpowerpc-gpopt
6927 @itemx -mno-powerpc-gpopt
6928 @itemx -mpowerpc-gfxopt
6929 @itemx -mno-powerpc-gfxopt
6930 @itemx -mpowerpc64
6931 @itemx -mno-powerpc64
6932 @opindex mpower
6933 @opindex mno-power
6934 @opindex mpower2
6935 @opindex mno-power2
6936 @opindex mpowerpc
6937 @opindex mno-powerpc
6938 @opindex mpowerpc-gpopt
6939 @opindex mno-powerpc-gpopt
6940 @opindex mpowerpc-gfxopt
6941 @opindex mno-powerpc-gfxopt
6942 @opindex mpowerpc64
6943 @opindex mno-powerpc64
6944 GCC supports two related instruction set architectures for the
6945 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6946 instructions supported by the @samp{rios} chip set used in the original
6947 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6948 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6949 the IBM 4xx microprocessors.
6950
6951 Neither architecture is a subset of the other.  However there is a
6952 large common subset of instructions supported by both.  An MQ
6953 register is included in processors supporting the POWER architecture.
6954
6955 You use these options to specify which instructions are available on the
6956 processor you are using.  The default value of these options is
6957 determined when configuring GCC@.  Specifying the
6958 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6959 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6960 rather than the options listed above.
6961
6962 The @option{-mpower} option allows GCC to generate instructions that
6963 are found only in the POWER architecture and to use the MQ register.
6964 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6965 to generate instructions that are present in the POWER2 architecture but
6966 not the original POWER architecture.
6967
6968 The @option{-mpowerpc} option allows GCC to generate instructions that
6969 are found only in the 32-bit subset of the PowerPC architecture.
6970 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6971 GCC to use the optional PowerPC architecture instructions in the
6972 General Purpose group, including floating-point square root.  Specifying
6973 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6974 use the optional PowerPC architecture instructions in the Graphics
6975 group, including floating-point select.
6976
6977 The @option{-mpowerpc64} option allows GCC to generate the additional
6978 64-bit instructions that are found in the full PowerPC64 architecture
6979 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6980 @option{-mno-powerpc64}.
6981
6982 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6983 will use only the instructions in the common subset of both
6984 architectures plus some special AIX common-mode calls, and will not use
6985 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6986 permits GCC to use any instruction from either architecture and to
6987 allow use of the MQ register; specify this for the Motorola MPC601.
6988
6989 @item -mnew-mnemonics
6990 @itemx -mold-mnemonics
6991 @opindex mnew-mnemonics
6992 @opindex mold-mnemonics
6993 Select which mnemonics to use in the generated assembler code.  With
6994 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6995 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6996 assembler mnemonics defined for the POWER architecture.  Instructions
6997 defined in only one architecture have only one mnemonic; GCC uses that
6998 mnemonic irrespective of which of these options is specified.
6999
7000 GCC defaults to the mnemonics appropriate for the architecture in
7001 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7002 value of these option.  Unless you are building a cross-compiler, you
7003 should normally not specify either @option{-mnew-mnemonics} or
7004 @option{-mold-mnemonics}, but should instead accept the default.
7005
7006 @item -mcpu=@var{cpu_type}
7007 @opindex mcpu
7008 Set architecture type, register usage, choice of mnemonics, and
7009 instruction scheduling parameters for machine type @var{cpu_type}.
7010 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7011 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7012 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7013 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7014 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7015 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7016 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7017 @samp{power4}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
7018 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7019
7020 @option{-mcpu=common} selects a completely generic processor.  Code
7021 generated under this option will run on any POWER or PowerPC processor.
7022 GCC will use only the instructions in the common subset of both
7023 architectures, and will not use the MQ register.  GCC assumes a generic
7024 processor model for scheduling purposes.
7025
7026 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7027 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7028 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7029 types, with an appropriate, generic processor model assumed for
7030 scheduling purposes.
7031
7032 The other options specify a specific processor.  Code generated under
7033 those options will run best on that processor, and may not run at all on
7034 others.
7035
7036 The @option{-mcpu} options automatically enable or disable the
7037 following options: @option{-maltivec}, @option{-mhard-float},
7038 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7039 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7040 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7041 @option{-mstring}.  The particular options set for any particular CPU
7042 will vary between compiler versions, depending on what setting seems
7043 to produce optimal code for that CPU; it doesn't necessarily reflect
7044 the actual hardware's capabilities.  If you wish to set an individual
7045 option to a particular value, you may specify it after the
7046 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7047
7048 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7049 not enabled or disabled by the @option{-mcpu} option at present, since
7050 AIX does not have full support for these options.  You may still
7051 enable or disable them individually if you're sure it'll work in your
7052 environment.
7053
7054 @item -mtune=@var{cpu_type}
7055 @opindex mtune
7056 Set the instruction scheduling parameters for machine type
7057 @var{cpu_type}, but do not set the architecture type, register usage, or
7058 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7059 values for @var{cpu_type} are used for @option{-mtune} as for
7060 @option{-mcpu}.  If both are specified, the code generated will use the
7061 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7062 scheduling parameters set by @option{-mtune}.
7063
7064 @item -maltivec
7065 @itemx -mno-altivec
7066 @opindex maltivec
7067 @opindex mno-altivec
7068 These switches enable or disable the use of built-in functions that
7069 allow access to the AltiVec instruction set.  You may also need to set
7070 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7071 enhancements.
7072
7073 @item -mabi=spe
7074 @opindex mabi=spe
7075 Extend the current ABI with SPE ABI extensions.  This does not change
7076 the default ABI, instead it adds the SPE ABI extensions to the current
7077 ABI@.
7078
7079 @item -mabi=no-spe
7080 @opindex mabi=no-spe
7081 Disable Booke SPE ABI extensions for the current ABI.
7082
7083 @item -misel=@var{yes/no}
7084 @itemx -misel
7085 @opindex misel
7086 This switch enables or disables the generation of ISEL instructions.
7087
7088 @item -mspe=@var{yes/no}
7089 @itemx -mspe
7090 @opindex mspe
7091 This switch enables or disables the generation of SPE simd
7092 instructions.
7093
7094 @item -mfloat-gprs=@var{yes/no}
7095 @itemx -mfloat-gprs
7096 @opindex mfloat-gprs
7097 This switch enables or disables the generation of floating point
7098 operations on the general purpose registers for architectures that
7099 support it.  This option is currently only available on the MPC8540.
7100
7101 @item -mfull-toc
7102 @itemx -mno-fp-in-toc
7103 @itemx -mno-sum-in-toc
7104 @itemx -mminimal-toc
7105 @opindex mfull-toc
7106 @opindex mno-fp-in-toc
7107 @opindex mno-sum-in-toc
7108 @opindex mminimal-toc
7109 Modify generation of the TOC (Table Of Contents), which is created for
7110 every executable file.  The @option{-mfull-toc} option is selected by
7111 default.  In that case, GCC will allocate at least one TOC entry for
7112 each unique non-automatic variable reference in your program.  GCC
7113 will also place floating-point constants in the TOC@.  However, only
7114 16,384 entries are available in the TOC@.
7115
7116 If you receive a linker error message that saying you have overflowed
7117 the available TOC space, you can reduce the amount of TOC space used
7118 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7119 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7120 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7121 generate code to calculate the sum of an address and a constant at
7122 run-time instead of putting that sum into the TOC@.  You may specify one
7123 or both of these options.  Each causes GCC to produce very slightly
7124 slower and larger code at the expense of conserving TOC space.
7125
7126 If you still run out of space in the TOC even when you specify both of
7127 these options, specify @option{-mminimal-toc} instead.  This option causes
7128 GCC to make only one TOC entry for every file.  When you specify this
7129 option, GCC will produce code that is slower and larger but which
7130 uses extremely little TOC space.  You may wish to use this option
7131 only on files that contain less frequently executed code.
7132
7133 @item -maix64
7134 @itemx -maix32
7135 @opindex maix64
7136 @opindex maix32
7137 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7138 @code{long} type, and the infrastructure needed to support them.
7139 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7140 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7141 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7142
7143 @item -mxl-call
7144 @itemx -mno-xl-call
7145 @opindex mxl-call
7146 @opindex mno-xl-call
7147 On AIX, pass floating-point arguments to prototyped functions beyond the
7148 register save area (RSA) on the stack in addition to argument FPRs.  The
7149 AIX calling convention was extended but not initially documented to
7150 handle an obscure K&R C case of calling a function that takes the
7151 address of its arguments with fewer arguments than declared.  AIX XL
7152 compilers access floating point arguments which do not fit in the
7153 RSA from the stack when a subroutine is compiled without
7154 optimization.  Because always storing floating-point arguments on the
7155 stack is inefficient and rarely needed, this option is not enabled by
7156 default and only is necessary when calling subroutines compiled by AIX
7157 XL compilers without optimization.
7158
7159 @item -mpe
7160 @opindex mpe
7161 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7162 application written to use message passing with special startup code to
7163 enable the application to run.  The system must have PE installed in the
7164 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7165 must be overridden with the @option{-specs=} option to specify the
7166 appropriate directory location.  The Parallel Environment does not
7167 support threads, so the @option{-mpe} option and the @option{-pthread}
7168 option are incompatible.
7169
7170 @item -malign-natural
7171 @itemx -malign-power
7172 @opindex malign-natural
7173 @opindex malign-power
7174 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7175 @option{-malign-natural} overrides the ABI-defined alignment of larger
7176 types, such as floating-point doubles, on their natural size-based boundary.
7177 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7178 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7179
7180 @item -msoft-float
7181 @itemx -mhard-float
7182 @opindex msoft-float
7183 @opindex mhard-float
7184 Generate code that does not use (uses) the floating-point register set.
7185 Software floating point emulation is provided if you use the
7186 @option{-msoft-float} option, and pass the option to GCC when linking.
7187
7188 @item -mmultiple
7189 @itemx -mno-multiple
7190 @opindex mmultiple
7191 @opindex mno-multiple
7192 Generate code that uses (does not use) the load multiple word
7193 instructions and the store multiple word instructions.  These
7194 instructions are generated by default on POWER systems, and not
7195 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7196 endian PowerPC systems, since those instructions do not work when the
7197 processor is in little endian mode.  The exceptions are PPC740 and
7198 PPC750 which permit the instructions usage in little endian mode.
7199
7200 @item -mstring
7201 @itemx -mno-string
7202 @opindex mstring
7203 @opindex mno-string
7204 Generate code that uses (does not use) the load string instructions
7205 and the store string word instructions to save multiple registers and
7206 do small block moves.  These instructions are generated by default on
7207 POWER systems, and not generated on PowerPC systems.  Do not use
7208 @option{-mstring} on little endian PowerPC systems, since those
7209 instructions do not work when the processor is in little endian mode.
7210 The exceptions are PPC740 and PPC750 which permit the instructions
7211 usage in little endian mode.
7212
7213 @item -mupdate
7214 @itemx -mno-update
7215 @opindex mupdate
7216 @opindex mno-update
7217 Generate code that uses (does not use) the load or store instructions
7218 that update the base register to the address of the calculated memory
7219 location.  These instructions are generated by default.  If you use
7220 @option{-mno-update}, there is a small window between the time that the
7221 stack pointer is updated and the address of the previous frame is
7222 stored, which means code that walks the stack frame across interrupts or
7223 signals may get corrupted data.
7224
7225 @item -mfused-madd
7226 @itemx -mno-fused-madd
7227 @opindex mfused-madd
7228 @opindex mno-fused-madd
7229 Generate code that uses (does not use) the floating point multiply and
7230 accumulate instructions.  These instructions are generated by default if
7231 hardware floating is used.
7232
7233 @item -mno-bit-align
7234 @itemx -mbit-align
7235 @opindex mno-bit-align
7236 @opindex mbit-align
7237 On System V.4 and embedded PowerPC systems do not (do) force structures
7238 and unions that contain bit-fields to be aligned to the base type of the
7239 bit-field.
7240
7241 For example, by default a structure containing nothing but 8
7242 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7243 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7244 the structure would be aligned to a 1 byte boundary and be one byte in
7245 size.
7246
7247 @item -mno-strict-align
7248 @itemx -mstrict-align
7249 @opindex mno-strict-align
7250 @opindex mstrict-align
7251 On System V.4 and embedded PowerPC systems do not (do) assume that
7252 unaligned memory references will be handled by the system.
7253
7254 @item -mrelocatable
7255 @itemx -mno-relocatable
7256 @opindex mrelocatable
7257 @opindex mno-relocatable
7258 On embedded PowerPC systems generate code that allows (does not allow)
7259 the program to be relocated to a different address at runtime.  If you
7260 use @option{-mrelocatable} on any module, all objects linked together must
7261 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7262
7263 @item -mrelocatable-lib
7264 @itemx -mno-relocatable-lib
7265 @opindex mrelocatable-lib
7266 @opindex mno-relocatable-lib
7267 On embedded PowerPC systems generate code that allows (does not allow)
7268 the program to be relocated to a different address at runtime.  Modules
7269 compiled with @option{-mrelocatable-lib} can be linked with either modules
7270 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7271 with modules compiled with the @option{-mrelocatable} options.
7272
7273 @item -mno-toc
7274 @itemx -mtoc
7275 @opindex mno-toc
7276 @opindex mtoc
7277 On System V.4 and embedded PowerPC systems do not (do) assume that
7278 register 2 contains a pointer to a global area pointing to the addresses
7279 used in the program.
7280
7281 @item -mlittle
7282 @itemx -mlittle-endian
7283 @opindex mlittle
7284 @opindex mlittle-endian
7285 On System V.4 and embedded PowerPC systems compile code for the
7286 processor in little endian mode.  The @option{-mlittle-endian} option is
7287 the same as @option{-mlittle}.
7288
7289 @item -mbig
7290 @itemx -mbig-endian
7291 @opindex mbig
7292 @opindex mbig-endian
7293 On System V.4 and embedded PowerPC systems compile code for the
7294 processor in big endian mode.  The @option{-mbig-endian} option is
7295 the same as @option{-mbig}.
7296
7297 @item -mdynamic-no-pic
7298 @opindex mdynamic-no-pic
7299 On Darwin and Mac OS X systems, compile code so that it is not
7300 relocatable, but that its external references are relocatable.  The
7301 resulting code is suitable for applications, but not shared
7302 libraries.
7303
7304 @item -mprioritize-restricted-insns=@var{priority}
7305 @opindex mprioritize-restricted-insns
7306 This option controls the priority that is assigned to 
7307 dispatch-slot restricted instructions during the second scheduling 
7308 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign 
7309 @var{no/highest/second-highest} priority to dispatch slot restricted 
7310 instructions.
7311
7312 @item -msched-costly-dep=@var{dependence_type}
7313 @opindex msched-costly-dep
7314 This option controls which dependences are considered costly
7315 by the target during instruction scheduling.  The argument
7316 @var{dependence_type} takes one of the following values:
7317 @var{no}: no dependence is costly, 
7318 @var{all}: all dependences are costly, 
7319 @var{true_store_to_load}: a true dependence from store to load is costly,
7320 @var{store_to_load}: any dependence from store to load is costly,
7321 @var{number}: any dependence which latency >= @var{number} is costly.
7322  
7323 @item -minsert-sched-nops=@var{scheme}
7324 @opindex minsert-sched-nops
7325 This option controls which nop insertion scheme will be used during
7326 the second scheduling pass. The argument @var{scheme} takes one of the
7327 following values:
7328 @var{no}: Don't insert nops.
7329 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7330 according to the scheduler's grouping.
7331 @var{regroup_exact}: Insert nops to force costly dependent insns into
7332 separate groups.  Insert exactly as many nops as needed to force an insn
7333 to a new group, according to the estimatied processor grouping.
7334 @var{number}: Insert nops to force costly dependent insns into 
7335 separate groups.  Insert @var{number} nops to force an insn to a new group.
7336
7337 @item -mcall-sysv
7338 @opindex mcall-sysv
7339 On System V.4 and embedded PowerPC systems compile code using calling
7340 conventions that adheres to the March 1995 draft of the System V
7341 Application Binary Interface, PowerPC processor supplement.  This is the
7342 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7343
7344 @item -mcall-sysv-eabi
7345 @opindex mcall-sysv-eabi
7346 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7347
7348 @item -mcall-sysv-noeabi
7349 @opindex mcall-sysv-noeabi
7350 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7351
7352 @item -mcall-solaris
7353 @opindex mcall-solaris
7354 On System V.4 and embedded PowerPC systems compile code for the Solaris
7355 operating system.
7356
7357 @item -mcall-linux
7358 @opindex mcall-linux
7359 On System V.4 and embedded PowerPC systems compile code for the
7360 Linux-based GNU system.
7361
7362 @item -mcall-gnu
7363 @opindex mcall-gnu
7364 On System V.4 and embedded PowerPC systems compile code for the
7365 Hurd-based GNU system.
7366
7367 @item -mcall-netbsd
7368 @opindex mcall-netbsd
7369 On System V.4 and embedded PowerPC systems compile code for the
7370 NetBSD operating system.
7371
7372 @item -maix-struct-return
7373 @opindex maix-struct-return
7374 Return all structures in memory (as specified by the AIX ABI)@.
7375
7376 @item -msvr4-struct-return
7377 @opindex msvr4-struct-return
7378 Return structures smaller than 8 bytes in registers (as specified by the
7379 SVR4 ABI)@.
7380
7381 @item -mabi=altivec
7382 @opindex mabi=altivec
7383 Extend the current ABI with AltiVec ABI extensions.  This does not
7384 change the default ABI, instead it adds the AltiVec ABI extensions to
7385 the current ABI@.
7386
7387 @item -mabi=no-altivec
7388 @opindex mabi=no-altivec
7389 Disable AltiVec ABI extensions for the current ABI.
7390
7391 @item -mprototype
7392 @itemx -mno-prototype
7393 @opindex mprototype
7394 @opindex mno-prototype
7395 On System V.4 and embedded PowerPC systems assume that all calls to
7396 variable argument functions are properly prototyped.  Otherwise, the
7397 compiler must insert an instruction before every non prototyped call to
7398 set or clear bit 6 of the condition code register (@var{CR}) to
7399 indicate whether floating point values were passed in the floating point
7400 registers in case the function takes a variable arguments.  With
7401 @option{-mprototype}, only calls to prototyped variable argument functions
7402 will set or clear the bit.
7403
7404 @item -msim
7405 @opindex msim
7406 On embedded PowerPC systems, assume that the startup module is called
7407 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7408 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7409 configurations.
7410
7411 @item -mmvme
7412 @opindex mmvme
7413 On embedded PowerPC systems, assume that the startup module is called
7414 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7415 @file{libc.a}.
7416
7417 @item -mads
7418 @opindex mads
7419 On embedded PowerPC systems, assume that the startup module is called
7420 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7421 @file{libc.a}.
7422
7423 @item -myellowknife
7424 @opindex myellowknife
7425 On embedded PowerPC systems, assume that the startup module is called
7426 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7427 @file{libc.a}.
7428
7429 @item -mvxworks
7430 @opindex mvxworks
7431 On System V.4 and embedded PowerPC systems, specify that you are
7432 compiling for a VxWorks system.
7433
7434 @item -mwindiss
7435 @opindex mwindiss
7436 Specify that you are compiling for the WindISS simulation environment.
7437
7438 @item -memb
7439 @opindex memb
7440 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7441 header to indicate that @samp{eabi} extended relocations are used.
7442
7443 @item -meabi
7444 @itemx -mno-eabi
7445 @opindex meabi
7446 @opindex mno-eabi
7447 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7448 Embedded Applications Binary Interface (eabi) which is a set of
7449 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7450 means that the stack is aligned to an 8 byte boundary, a function
7451 @code{__eabi} is called to from @code{main} to set up the eabi
7452 environment, and the @option{-msdata} option can use both @code{r2} and
7453 @code{r13} to point to two separate small data areas.  Selecting
7454 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7455 do not call an initialization function from @code{main}, and the
7456 @option{-msdata} option will only use @code{r13} to point to a single
7457 small data area.  The @option{-meabi} option is on by default if you
7458 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7459
7460 @item -msdata=eabi
7461 @opindex msdata=eabi
7462 On System V.4 and embedded PowerPC systems, put small initialized
7463 @code{const} global and static data in the @samp{.sdata2} section, which
7464 is pointed to by register @code{r2}.  Put small initialized
7465 non-@code{const} global and static data in the @samp{.sdata} section,
7466 which is pointed to by register @code{r13}.  Put small uninitialized
7467 global and static data in the @samp{.sbss} section, which is adjacent to
7468 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7469 incompatible with the @option{-mrelocatable} option.  The
7470 @option{-msdata=eabi} option also sets the @option{-memb} option.
7471
7472 @item -msdata=sysv
7473 @opindex msdata=sysv
7474 On System V.4 and embedded PowerPC systems, put small global and static
7475 data in the @samp{.sdata} section, which is pointed to by register
7476 @code{r13}.  Put small uninitialized global and static data in the
7477 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7478 The @option{-msdata=sysv} option is incompatible with the
7479 @option{-mrelocatable} option.
7480
7481 @item -msdata=default
7482 @itemx -msdata
7483 @opindex msdata=default
7484 @opindex msdata
7485 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7486 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7487 same as @option{-msdata=sysv}.
7488
7489 @item -msdata-data
7490 @opindex msdata-data
7491 On System V.4 and embedded PowerPC systems, put small global and static
7492 data in the @samp{.sdata} section.  Put small uninitialized global and
7493 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7494 to address small data however.  This is the default behavior unless
7495 other @option{-msdata} options are used.
7496
7497 @item -msdata=none
7498 @itemx -mno-sdata
7499 @opindex msdata=none
7500 @opindex mno-sdata
7501 On embedded PowerPC systems, put all initialized global and static data
7502 in the @samp{.data} section, and all uninitialized data in the
7503 @samp{.bss} section.
7504
7505 @item -G @var{num}
7506 @opindex G
7507 @cindex smaller data references (PowerPC)
7508 @cindex .sdata/.sdata2 references (PowerPC)
7509 On embedded PowerPC systems, put global and static items less than or
7510 equal to @var{num} bytes into the small data or bss sections instead of
7511 the normal data or bss section.  By default, @var{num} is 8.  The
7512 @option{-G @var{num}} switch is also passed to the linker.
7513 All modules should be compiled with the same @option{-G @var{num}} value.
7514
7515 @item -mregnames
7516 @itemx -mno-regnames
7517 @opindex mregnames
7518 @opindex mno-regnames
7519 On System V.4 and embedded PowerPC systems do (do not) emit register
7520 names in the assembly language output using symbolic forms.
7521
7522 @item -mlongcall
7523 @itemx -mno-longcall
7524 @opindex mlongcall
7525 @opindex mno-longcall
7526 Default to making all function calls via pointers, so that functions
7527 which reside further than 64 megabytes (67,108,864 bytes) from the
7528 current location can be called.  This setting can be overridden by the
7529 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7530
7531 Some linkers are capable of detecting out-of-range calls and generating
7532 glue code on the fly.  On these systems, long calls are unnecessary and
7533 generate slower code.  As of this writing, the AIX linker can do this,
7534 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7535 to the GNU linker for 32-bit PowerPC systems as well.
7536
7537 On Mach-O (Darwin) systems, this option directs the compiler emit to
7538 the glue for every direct call, and the Darwin linker decides whether
7539 to use or discard it.
7540
7541 In the future, we may cause GCC to ignore all longcall specifications
7542 when the linker is known to generate glue.
7543
7544 @item -pthread
7545 @opindex pthread
7546 Adds support for multithreading with the @dfn{pthreads} library.
7547 This option sets flags for both the preprocessor and linker.
7548
7549 @end table
7550
7551 @node Darwin Options
7552 @subsection Darwin Options
7553 @cindex Darwin options
7554
7555 These options are defined for all architectures running the Darwin operating
7556 system.  They are useful for compatibility with other Mac OS compilers.
7557
7558 @table @gcctabopt
7559 @item -all_load    
7560 @opindex all_load   
7561 Loads all members of static archive libraries.
7562 See man ld(1) for more information.
7563
7564 @item -arch_errors_fatal
7565 @opindex arch_errors_fatal
7566 Cause the errors having to do with files that have the wrong architecture
7567 to be fatal.
7568
7569 @item -bind_at_load
7570 @opindex bind_at_load
7571 Causes the output file to be marked such that the dynamic linker will
7572 bind all undefined references when the file is loaded or launched.
7573
7574 @item -bundle     
7575 @opindex bundle
7576 Produce a Mach-o bundle format file.
7577 See man ld(1) for more information.
7578
7579 @item -bundle_loader @var{executable}
7580 @opindex bundle_loader
7581 This specifies the @var{executable} that will be loading the build
7582 output file being linked. See man ld(1) for more information.
7583
7584 @item -allowable_client  @var{client_name}
7585 @itemx -arch_only
7586
7587 @itemx -client_name       
7588 @itemx -compatibility_version
7589 @itemx -current_version    
7590 @itemx -dependency-file
7591 @itemx -dylib_file    
7592 @itemx -dylinker_install_name
7593 @itemx -dynamic
7594 @itemx -dynamiclib   
7595 @itemx -exported_symbols_list  
7596 @itemx -filelist
7597 @itemx -flat_namespace   
7598 @itemx -force_cpusubtype_ALL
7599 @itemx -force_flat_namespace   
7600 @itemx -headerpad_max_install_names
7601 @itemx -image_base  
7602 @itemx -init
7603 @itemx -install_name
7604 @itemx -keep_private_externs
7605 @itemx -multi_module
7606 @itemx -multiply_defined      
7607 @itemx -multiply_defined_unused      
7608 @itemx -noall_load  
7609 @itemx -nofixprebinding
7610 @itemx -nomultidefs
7611 @itemx -noprebind     
7612 @itemx -noseglinkedit
7613 @itemx -pagezero_size    
7614 @itemx -prebind
7615 @itemx -prebind_all_twolevel_modules
7616 @itemx -private_bundle
7617 @itemx -read_only_relocs
7618 @itemx -sectalign  
7619 @itemx -sectobjectsymbols    
7620 @itemx -whyload
7621 @itemx -seg1addr 
7622 @itemx -sectcreate
7623 @itemx -sectobjectsymbols
7624 @itemx -sectorder
7625 @itemx -seg_addr_table
7626 @itemx -seg_addr_table_filename
7627 @itemx -seglinkedit
7628 @itemx -segprot   
7629 @itemx -segs_read_only_addr
7630 @itemx -segs_read_write_addr
7631 @itemx -single_module   
7632 @itemx -static
7633 @itemx -sub_library
7634 @itemx -sub_umbrella 
7635 @itemx -twolevel_namespace
7636 @itemx -umbrella
7637 @itemx -undefined
7638 @itemx -unexported_symbols_list
7639 @itemx -weak_reference_mismatches
7640 @itemx -whatsloaded  
7641
7642 @opindex allowable_client
7643 @opindex arch_only    
7644 @opindex client_name
7645 @opindex compatibility_version
7646 @opindex current_version
7647 @opindex dependency-file
7648 @opindex dylib_file
7649 @opindex dylinker_install_name
7650 @opindex dynamic
7651 @opindex dynamiclib
7652 @opindex exported_symbols_list
7653 @opindex filelist  
7654 @opindex flat_namespace    
7655 @opindex force_cpusubtype_ALL
7656 @opindex force_flat_namespace
7657 @opindex headerpad_max_install_names
7658 @opindex image_base
7659 @opindex init     
7660 @opindex install_name
7661 @opindex keep_private_externs
7662 @opindex multi_module   
7663 @opindex multiply_defined
7664 @opindex multiply_defined_unused   
7665 @opindex noall_load  
7666 @opindex nofixprebinding
7667 @opindex nomultidefs   
7668 @opindex noprebind
7669 @opindex noseglinkedit      
7670 @opindex pagezero_size
7671 @opindex prebind
7672 @opindex prebind_all_twolevel_modules
7673 @opindex private_bundle 
7674 @opindex read_only_relocs
7675 @opindex sectalign   
7676 @opindex sectobjectsymbols    
7677 @opindex whyload  
7678 @opindex seg1addr
7679 @opindex sectcreate       
7680 @opindex sectobjectsymbols 
7681 @opindex sectorder     
7682 @opindex seg_addr_table
7683 @opindex seg_addr_table_filename
7684 @opindex seglinkedit
7685 @opindex segprot
7686 @opindex segs_read_only_addr
7687 @opindex segs_read_write_addr
7688 @opindex single_module
7689 @opindex static
7690 @opindex sub_library
7691 @opindex sub_umbrella
7692 @opindex twolevel_namespace
7693 @opindex umbrella
7694 @opindex undefined
7695 @opindex unexported_symbols_list
7696 @opindex weak_reference_mismatches
7697 @opindex whatsloaded
7698
7699 These options are available for Darwin linker. Darwin linker man page
7700 describes them in detail.
7701 @end table
7702
7703
7704 @node MIPS Options
7705 @subsection MIPS Options
7706 @cindex MIPS options
7707
7708 @table @gcctabopt
7709
7710 @item -EB
7711 @opindex EB
7712 Generate big-endian code.
7713
7714 @item -EL
7715 @opindex EL
7716 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
7717 configurations.
7718
7719 @item -march=@var{arch}
7720 @opindex march
7721 Generate code that will run on @var{arch}, which can be the name of a
7722 generic MIPS ISA, or the name of a particular processor.
7723 The ISA names are:
7724 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7725 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7726 The processor names are:
7727 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7728 @samp{m4k},
7729 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7730 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7731 @samp{rm9000},
7732 @samp{orion},
7733 @samp{sb1},
7734 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7735 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7736 The special value @samp{from-abi} selects the
7737 most compatible architecture for the selected ABI (that is,
7738 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7739
7740 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7741 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7742 @samp{vr} may be written @samp{r}.
7743
7744 GCC defines two macros based on the value of this option.  The first
7745 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7746 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7747 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7748 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7749 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7750
7751 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7752 above.  In other words, it will have the full prefix and will not
7753 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7754 the macro names the resolved architecture (either @samp{"mips1"} or
7755 @samp{"mips3"}).  It names the default architecture when no
7756 @option{-march} option is given.
7757
7758 @item -mtune=@var{arch}
7759 @opindex mtune
7760 Optimize for @var{arch}.  Among other things, this option controls
7761 the way instructions are scheduled, and the perceived cost of arithmetic
7762 operations.  The list of @var{arch} values is the same as for
7763 @option{-march}.
7764
7765 When this option is not used, GCC will optimize for the processor
7766 specified by @option{-march}.  By using @option{-march} and
7767 @option{-mtune} together, it is possible to generate code that will
7768 run on a family of processors, but optimize the code for one
7769 particular member of that family.
7770
7771 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7772 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7773 @samp{-march} ones described above.
7774
7775 @item -mips1
7776 @opindex mips1
7777 Equivalent to @samp{-march=mips1}.
7778
7779 @item -mips2
7780 @opindex mips2
7781 Equivalent to @samp{-march=mips2}.
7782
7783 @item -mips3
7784 @opindex mips3
7785 Equivalent to @samp{-march=mips3}.
7786
7787 @item -mips4
7788 @opindex mips4
7789 Equivalent to @samp{-march=mips4}.
7790
7791 @item -mips32
7792 @opindex mips32
7793 Equivalent to @samp{-march=mips32}.
7794
7795 @item -mips32r2
7796 @opindex mips32r2
7797 Equivalent to @samp{-march=mips32r2}.
7798
7799 @item -mips64
7800 @opindex mips64
7801 Equivalent to @samp{-march=mips64}.
7802
7803 @item -mips16
7804 @itemx -mno-mips16
7805 @opindex mips16
7806 @opindex mno-mips16
7807 Use (do not use) the MIPS16 ISA.
7808
7809 @item -mabi=32
7810 @itemx -mabi=o64
7811 @itemx -mabi=n32
7812 @itemx -mabi=64
7813 @itemx -mabi=eabi
7814 @opindex mabi=32
7815 @opindex mabi=o64
7816 @opindex mabi=n32
7817 @opindex mabi=64
7818 @opindex mabi=eabi
7819 Generate code for the given ABI@.
7820
7821 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
7822 generates 64-bit code when you select a 64-bit architecture, but you
7823 can use @option{-mgp32} to get 32-bit code instead.
7824
7825 @item -mabicalls
7826 @itemx -mno-abicalls
7827 @opindex mabicalls
7828 @opindex mno-abicalls
7829 Generate (do not generate) SVR4-style position-independent code.
7830 @option{-mabicalls} is the default for SVR4-based systems.
7831
7832 @item -mxgot
7833 @itemx -mno-xgot
7834 @opindex mxgot
7835 @opindex mno-xgot
7836 Lift (do not lift) the usual restrictions on the size of the global
7837 offset table.
7838
7839 GCC normally uses a single instruction to load values from the GOT.
7840 While this is relatively efficient, it will only work if the GOT
7841 is smaller than about 64k.  Anything larger will cause the linker
7842 to report an error such as:
7843
7844 @cindex relocation truncated to fit (MIPS)
7845 @smallexample
7846 relocation truncated to fit: R_MIPS_GOT16 foobar
7847 @end smallexample
7848
7849 If this happens, you should recompile your code with @option{-mxgot}.
7850 It should then work with very large GOTs, although it will also be
7851 less efficient, since it will take three instructions to fetch the
7852 value of a global symbol.
7853
7854 Note that some linkers can create multiple GOTs.  If you have such a
7855 linker, you should only need to use @option{-mxgot} when a single object
7856 file accesses more than 64k's worth of GOT entries.  Very few do.
7857
7858 These options have no effect unless GCC is generating position
7859 independent code.
7860
7861 @item -membedded-pic
7862 @itemx -mno-embedded-pic
7863 @opindex membedded-pic
7864 @opindex mno-embedded-pic
7865 Generate (do not generate) position-independent code suitable for some
7866 embedded systems.  All calls are made using PC relative addresses, and
7867 all data is addressed using the $gp register.  No more than 65536
7868 bytes of global data may be used.  This requires GNU as and GNU ld,
7869 which do most of the work.
7870
7871 @item -mgp32
7872 @opindex mgp32
7873 Assume that general-purpose registers are 32 bits wide.
7874
7875 @item -mgp64
7876 @opindex mgp64
7877 Assume that general-purpose registers are 64 bits wide.
7878
7879 @item -mfp32
7880 @opindex mfp32
7881 Assume that floating-point registers are 32 bits wide.
7882
7883 @item -mfp64
7884 @opindex mfp64
7885 Assume that floating-point registers are 64 bits wide.
7886
7887 @item -mhard-float
7888 @opindex mhard-float
7889 Use floating-point coprocessor instructions.
7890
7891 @item -msoft-float
7892 @opindex msoft-float
7893 Do not use floating-point coprocessor instructions.  Implement
7894 floating-point calculations using library calls instead.
7895
7896 @item -msingle-float
7897 @opindex msingle-float
7898 Assume that the floating-point coprocessor only supports single-precision
7899 operations.
7900
7901 @itemx -mdouble-float
7902 @opindex mdouble-float
7903 Assume that the floating-point coprocessor supports double-precision
7904 operations.  This is the default.
7905
7906 @item -mint64
7907 @opindex mint64
7908 Force @code{int} and @code{long} types to be 64 bits wide.  See
7909 @option{-mlong32} for an explanation of the default and the way
7910 that the pointer size is determined.
7911
7912 @item -mlong64
7913 @opindex mlong64
7914 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
7915 an explanation of the default and the way that the pointer size is
7916 determined.
7917
7918 @item -mlong32
7919 @opindex mlong32
7920 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7921
7922 The default size of @code{int}s, @code{long}s and pointers depends on
7923 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
7924 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7925 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
7926 or the same size as integer registers, whichever is smaller.
7927
7928 @item -G @var{num}
7929 @opindex G
7930 @cindex smaller data references (MIPS)
7931 @cindex gp-relative references (MIPS)
7932 Put global and static items less than or equal to @var{num} bytes into
7933 the small data or bss section instead of the normal data or bss section.
7934 This allows the data to be accessed using a single instruction.
7935
7936 All modules should be compiled with the same @option{-G @var{num}}
7937 value.
7938
7939 @item -membedded-data
7940 @itemx -mno-embedded-data
7941 @opindex membedded-data
7942 @opindex mno-embedded-data
7943 Allocate variables to the read-only data section first if possible, then
7944 next in the small data section if possible, otherwise in data.  This gives
7945 slightly slower code than the default, but reduces the amount of RAM required
7946 when executing, and thus may be preferred for some embedded systems.
7947
7948 @item -muninit-const-in-rodata
7949 @itemx -mno-uninit-const-in-rodata
7950 @opindex muninit-const-in-rodata
7951 @opindex mno-uninit-const-in-rodata
7952 Put uninitialized @code{const} variables in the read-only data section.
7953 This option is only meaningful in conjunction with @option{-membedded-data}.
7954
7955 @item -msplit-addresses
7956 @itemx -mno-split-addresses
7957 @opindex msplit-addresses
7958 @opindex mno-split-addresses
7959 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
7960 relocation operators.  This option has been superceded by
7961 @option{-mexplicit-relocs} but is retained for backwards compatibility.
7962
7963 @item -mexplicit-relocs
7964 @itemx -mno-explicit-relocs
7965 @opindex mexplicit-relocs
7966 @opindex mno-explicit-relocs
7967 Use (do not use) assembler relocation operators when dealing with symbolic
7968 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
7969 is to use assembler macros instead.
7970
7971 @option{-mexplicit-relocs} is usually the default if GCC was
7972 configured to use an assembler that supports relocation operators.
7973 However, there are two exceptions:
7974
7975 @itemize @bullet
7976 @item
7977 GCC is not yet able to generate explicit relocations for the combination
7978 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
7979 in a future release.
7980
7981 @item
7982 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
7983 implies @option{-mno-explicit-relocs} unless explicitly overridden.
7984 This is because, when generating abicalls, the choice of relocation
7985 depends on whether a symbol is local or global.  In some rare cases,
7986 GCC will not be able to decide this until the whole compilation unit
7987 has been read.
7988 @end itemize
7989
7990 @item -mrnames
7991 @itemx -mno-rnames
7992 @opindex mrnames
7993 @opindex mno-rnames
7994 Generate (do not generate) code that refers to registers using their
7995 software names.  The default is @option{-mno-rnames}, which tells GCC
7996 to use hardware names like @samp{$4} instead of software names like
7997 @samp{a0}.  The only assembler known to support @option{-rnames} is
7998 the Algorithmics assembler.
7999
8000 @item -mcheck-zero-division
8001 @itemx -mno-check-zero-division
8002 @opindex mcheck-zero-division
8003 @opindex mno-check-zero-division
8004 Trap (do not trap) on integer division by zero.  The default is
8005 @option{-mcheck-zero-division}.
8006
8007 @item -mmemcpy
8008 @itemx -mno-memcpy
8009 @opindex mmemcpy
8010 @opindex mno-memcpy
8011 Force (do not force) the use of @code{memcpy()} for non-trivial block
8012 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8013 most constant-sized copies.
8014
8015 @item -mlong-calls
8016 @itemx -mno-long-calls
8017 @opindex mlong-calls
8018 @opindex mno-long-calls
8019 Disable (do not disable) use of the @code{jal} instruction.  Calling
8020 functions using @code{jal} is more efficient but requires the caller
8021 and callee to be in the same 256 megabyte segment.
8022
8023 This option has no effect on abicalls code.  The default is
8024 @option{-mno-long-calls}.
8025
8026 @item -mmad
8027 @itemx -mno-mad
8028 @opindex mmad
8029 @opindex mno-mad
8030 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8031 instructions, as provided by the R4650 ISA.
8032
8033 @item -mfused-madd
8034 @itemx -mno-fused-madd
8035 @opindex mfused-madd
8036 @opindex mno-fused-madd
8037 Enable (disable) use of the floating point multiply-accumulate
8038 instructions, when they are available.  The default is
8039 @option{-mfused-madd}.
8040
8041 When multiply-accumulate instructions are used, the intermediate
8042 product is calculated to infinite precision and is not subject to
8043 the FCSR Flush to Zero bit.  This may be undesirable in some
8044 circumstances.
8045
8046 @item -nocpp
8047 @opindex nocpp
8048 Tell the MIPS assembler to not run its preprocessor over user
8049 assembler files (with a @samp{.s} suffix) when assembling them.
8050
8051 @item -mfix-sb1
8052 @itemx -mno-fix-sb1
8053 @opindex mfix-sb1
8054 Work around certain SB-1 CPU core errata.
8055 (This flag currently works around the SB-1 revision 2
8056 ``F1'' and ``F2'' floating point errata.)
8057
8058 @item -mflush-func=@var{func}
8059 @itemx -mno-flush-func
8060 @opindex mflush-func
8061 Specifies the function to call to flush the I and D caches, or to not
8062 call any such function.  If called, the function must take the same
8063 arguments as the common @code{_flush_func()}, that is, the address of the
8064 memory range for which the cache is being flushed, the size of the
8065 memory range, and the number 3 (to flush both caches).  The default
8066 depends on the target gcc was configured for, but commonly is either
8067 @samp{_flush_func} or @samp{__cpu_flush}.
8068
8069 @item -mbranch-likely
8070 @itemx -mno-branch-likely
8071 @opindex mbranch-likely
8072 @opindex mno-branch-likely
8073 Enable or disable use of Branch Likely instructions, regardless of the
8074 default for the selected architecture.  By default, Branch Likely
8075 instructions may be generated if they are supported by the selected
8076 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8077 and processors which implement those architectures; for those, Branch
8078 Likely instructions will not be generated by default because the MIPS32
8079 and MIPS64 architectures specifically deprecate their use.
8080 @end table
8081
8082 @node i386 and x86-64 Options
8083 @subsection Intel 386 and AMD x86-64 Options
8084 @cindex i386 Options
8085 @cindex x86-64 Options
8086 @cindex Intel 386 Options
8087 @cindex AMD x86-64 Options
8088
8089 These @samp{-m} options are defined for the i386 and x86-64 family of
8090 computers:
8091
8092 @table @gcctabopt
8093 @item -mtune=@var{cpu-type}
8094 @opindex mtune
8095 Tune to @var{cpu-type} everything applicable about the generated code, except
8096 for the ABI and the set of available instructions.  The choices for
8097 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8098 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8099 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8100 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8101 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8102 and @samp{c3-2}.
8103
8104 While picking a specific @var{cpu-type} will schedule things appropriately
8105 for that particular chip, the compiler will not generate any code that
8106 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8107 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8108 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8109 AMD chips as opposed to the Intel ones.
8110
8111 @item -march=@var{cpu-type}
8112 @opindex march
8113 Generate instructions for the machine type @var{cpu-type}.  The choices
8114 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8115 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8116
8117 @item -mcpu=@var{cpu-type}
8118 @opindex mcpu
8119 A deprecated synonym for @option{-mtune}.
8120
8121 @item -m386
8122 @itemx -m486
8123 @itemx -mpentium
8124 @itemx -mpentiumpro
8125 @opindex m386
8126 @opindex m486
8127 @opindex mpentium
8128 @opindex mpentiumpro
8129 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8130 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8131 These synonyms are deprecated.
8132
8133 @item -mfpmath=@var{unit}
8134 @opindex march
8135 generate floating point arithmetics for selected unit @var{unit}.  the choices
8136 for @var{unit} are:
8137
8138 @table @samp
8139 @item 387
8140 Use the standard 387 floating point coprocessor present majority of chips and
8141 emulated otherwise.  Code compiled with this option will run almost everywhere.
8142 The temporary results are computed in 80bit precision instead of precision
8143 specified by the type resulting in slightly different results compared to most
8144 of other chips. See @option{-ffloat-store} for more detailed description.
8145
8146 This is the default choice for i386 compiler.
8147
8148 @item sse
8149 Use scalar floating point instructions present in the SSE instruction set.
8150 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8151 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8152 instruction set supports only single precision arithmetics, thus the double and
8153 extended precision arithmetics is still done using 387.  Later version, present
8154 only in Pentium4 and the future AMD x86-64 chips supports double precision
8155 arithmetics too.
8156
8157 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8158 @option{-msse2} switches to enable SSE extensions and make this option
8159 effective.  For x86-64 compiler, these extensions are enabled by default.
8160
8161 The resulting code should be considerably faster in majority of cases and avoid
8162 the numerical instability problems of 387 code, but may break some existing
8163 code that expects temporaries to be 80bit.
8164
8165 This is the default choice for x86-64 compiler.
8166
8167 @item pni
8168 Use all SSE extensions enabled by @option{-msse2} as well as the new
8169 SSE extensions in Prescott New Instructions. @option{-mpni} also
8170 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8171 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8172 @code{mwait}. 
8173
8174 @item sse,387
8175 Attempt to utilize both instruction sets at once.  This effectively double the
8176 amount of available registers and on chips with separate execution units for
8177 387 and SSE the execution resources too.  Use this option with care, as it is
8178 still experimental, because gcc register allocator does not model separate
8179 functional units well resulting in instable performance.
8180 @end table
8181
8182 @item -masm=@var{dialect}
8183 @opindex masm=@var{dialect}
8184 Output asm instructions using selected @var{dialect}. Supported choices are
8185 @samp{intel} or @samp{att} (the default one).
8186
8187 @item -mieee-fp
8188 @itemx -mno-ieee-fp
8189 @opindex mieee-fp
8190 @opindex mno-ieee-fp
8191 Control whether or not the compiler uses IEEE floating point
8192 comparisons.  These handle correctly the case where the result of a
8193 comparison is unordered.
8194
8195 @item -msoft-float
8196 @opindex msoft-float
8197 Generate output containing library calls for floating point.
8198 @strong{Warning:} the requisite libraries are not part of GCC@.
8199 Normally the facilities of the machine's usual C compiler are used, but
8200 this can't be done directly in cross-compilation.  You must make your
8201 own arrangements to provide suitable library functions for
8202 cross-compilation.
8203
8204 On machines where a function returns floating point results in the 80387
8205 register stack, some floating point opcodes may be emitted even if
8206 @option{-msoft-float} is used.
8207
8208 @item -mno-fp-ret-in-387
8209 @opindex mno-fp-ret-in-387
8210 Do not use the FPU registers for return values of functions.
8211
8212 The usual calling convention has functions return values of types
8213 @code{float} and @code{double} in an FPU register, even if there
8214 is no FPU@.  The idea is that the operating system should emulate
8215 an FPU@.
8216
8217 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8218 in ordinary CPU registers instead.
8219
8220 @item -mno-fancy-math-387
8221 @opindex mno-fancy-math-387
8222 Some 387 emulators do not support the @code{sin}, @code{cos} and
8223 @code{sqrt} instructions for the 387.  Specify this option to avoid
8224 generating those instructions.  This option is the default on FreeBSD,
8225 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8226 indicates that the target cpu will always have an FPU and so the
8227 instruction will not need emulation.  As of revision 2.6.1, these
8228 instructions are not generated unless you also use the
8229 @option{-funsafe-math-optimizations} switch.
8230
8231 @item -malign-double
8232 @itemx -mno-align-double
8233 @opindex malign-double
8234 @opindex mno-align-double
8235 Control whether GCC aligns @code{double}, @code{long double}, and
8236 @code{long long} variables on a two word boundary or a one word
8237 boundary.  Aligning @code{double} variables on a two word boundary will
8238 produce code that runs somewhat faster on a @samp{Pentium} at the
8239 expense of more memory.
8240
8241 @strong{Warning:} if you use the @option{-malign-double} switch,
8242 structures containing the above types will be aligned differently than
8243 the published application binary interface specifications for the 386
8244 and will not be binary compatible with structures in code compiled
8245 without that switch.
8246
8247 @item -m96bit-long-double
8248 @itemx -m128bit-long-double
8249 @opindex m96bit-long-double
8250 @opindex m128bit-long-double
8251 These switches control the size of @code{long double} type. The i386 
8252 application binary interface specifies the size to be 96 bits, 
8253 so @option{-m96bit-long-double} is the default in 32 bit mode.
8254
8255 Modern architectures (Pentium and newer) would prefer @code{long double}
8256 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8257 conforming to the ABI, this would not be possible.  So specifying a 
8258 @option{-m128bit-long-double} will align @code{long double}
8259 to a 16 byte boundary by padding the @code{long double} with an additional
8260 32 bit zero. 
8261
8262 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8263 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8264  
8265 Notice that neither of these options enable any extra precision over the x87
8266 standard of 80 bits for a @code{long double}. 
8267
8268 @strong{Warning:} if you override the default value for your target ABI, the
8269 structures and arrays containing @code{long double} will change their size as
8270 well as function calling convention for function taking @code{long double}
8271 will be modified.  Hence they will not be binary compatible with arrays or
8272 structures in code compiled without that switch.
8273
8274
8275 @item -msvr3-shlib
8276 @itemx -mno-svr3-shlib
8277 @opindex msvr3-shlib
8278 @opindex mno-svr3-shlib
8279 Control whether GCC places uninitialized local variables into the
8280 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8281 into @code{bss}.  These options are meaningful only on System V Release 3.
8282
8283 @item -mrtd
8284 @opindex mrtd
8285 Use a different function-calling convention, in which functions that
8286 take a fixed number of arguments return with the @code{ret} @var{num}
8287 instruction, which pops their arguments while returning.  This saves one
8288 instruction in the caller since there is no need to pop the arguments
8289 there.
8290
8291 You can specify that an individual function is called with this calling
8292 sequence with the function attribute @samp{stdcall}.  You can also
8293 override the @option{-mrtd} option by using the function attribute
8294 @samp{cdecl}.  @xref{Function Attributes}.
8295
8296 @strong{Warning:} this calling convention is incompatible with the one
8297 normally used on Unix, so you cannot use it if you need to call
8298 libraries compiled with the Unix compiler.
8299
8300 Also, you must provide function prototypes for all functions that
8301 take variable numbers of arguments (including @code{printf});
8302 otherwise incorrect code will be generated for calls to those
8303 functions.
8304
8305 In addition, seriously incorrect code will result if you call a
8306 function with too many arguments.  (Normally, extra arguments are
8307 harmlessly ignored.)
8308
8309 @item -mregparm=@var{num}
8310 @opindex mregparm
8311 Control how many registers are used to pass integer arguments.  By
8312 default, no registers are used to pass arguments, and at most 3
8313 registers can be used.  You can control this behavior for a specific
8314 function by using the function attribute @samp{regparm}.
8315 @xref{Function Attributes}.
8316
8317 @strong{Warning:} if you use this switch, and
8318 @var{num} is nonzero, then you must build all modules with the same
8319 value, including any libraries.  This includes the system libraries and
8320 startup modules.
8321
8322 @item -mpreferred-stack-boundary=@var{num}
8323 @opindex mpreferred-stack-boundary
8324 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8325 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8326 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8327 size (@option{-Os}), in which case the default is the minimum correct
8328 alignment (4 bytes for x86, and 8 bytes for x86-64).
8329
8330 On Pentium and PentiumPro, @code{double} and @code{long double} values
8331 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8332 suffer significant run time performance penalties.  On Pentium III, the
8333 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8334 penalties if it is not 16 byte aligned.
8335
8336 To ensure proper alignment of this values on the stack, the stack boundary
8337 must be as aligned as that required by any value stored on the stack.
8338 Further, every function must be generated such that it keeps the stack
8339 aligned.  Thus calling a function compiled with a higher preferred
8340 stack boundary from a function compiled with a lower preferred stack
8341 boundary will most likely misalign the stack.  It is recommended that
8342 libraries that use callbacks always use the default setting.
8343
8344 This extra alignment does consume extra stack space, and generally
8345 increases code size.  Code that is sensitive to stack space usage, such
8346 as embedded systems and operating system kernels, may want to reduce the
8347 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8348
8349 @item -mmmx
8350 @itemx -mno-mmx
8351 @item -msse
8352 @itemx -mno-sse
8353 @item -msse2
8354 @itemx -mno-sse2
8355 @item -mpni
8356 @itemx -mno-pni
8357 @item -m3dnow
8358 @itemx -mno-3dnow
8359 @opindex mmmx
8360 @opindex mno-mmx
8361 @opindex msse
8362 @opindex mno-sse
8363 @opindex m3dnow
8364 @opindex mno-3dnow
8365 These switches enable or disable the use of built-in functions that allow
8366 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8367
8368 @xref{X86 Built-in Functions}, for details of the functions enabled
8369 and disabled by these switches.
8370
8371 To have SSE/SSE2 instructions generated automatically from floating-point
8372 code, see @option{-mfpmath=sse}.
8373
8374 @item -mpush-args
8375 @itemx -mno-push-args
8376 @opindex mpush-args
8377 @opindex mno-push-args
8378 Use PUSH operations to store outgoing parameters.  This method is shorter
8379 and usually equally fast as method using SUB/MOV operations and is enabled
8380 by default.  In some cases disabling it may improve performance because of
8381 improved scheduling and reduced dependencies.
8382
8383 @item -maccumulate-outgoing-args
8384 @opindex maccumulate-outgoing-args
8385 If enabled, the maximum amount of space required for outgoing arguments will be
8386 computed in the function prologue.  This is faster on most modern CPUs
8387 because of reduced dependencies, improved scheduling and reduced stack usage
8388 when preferred stack boundary is not equal to 2.  The drawback is a notable
8389 increase in code size.  This switch implies @option{-mno-push-args}.
8390
8391 @item -mthreads
8392 @opindex mthreads
8393 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8394 on thread-safe exception handling must compile and link all code with the
8395 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8396 @option{-D_MT}; when linking, it links in a special thread helper library
8397 @option{-lmingwthrd} which cleans up per thread exception handling data.
8398
8399 @item -mno-align-stringops
8400 @opindex mno-align-stringops
8401 Do not align destination of inlined string operations.  This switch reduces
8402 code size and improves performance in case the destination is already aligned,
8403 but gcc don't know about it.
8404
8405 @item -minline-all-stringops
8406 @opindex minline-all-stringops
8407 By default GCC inlines string operations only when destination is known to be
8408 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8409 size, but may improve performance of code that depends on fast memcpy, strlen
8410 and memset for short lengths.
8411
8412 @item -momit-leaf-frame-pointer
8413 @opindex momit-leaf-frame-pointer
8414 Don't keep the frame pointer in a register for leaf functions.  This
8415 avoids the instructions to save, set up and restore frame pointers and
8416 makes an extra register available in leaf functions.  The option
8417 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8418 which might make debugging harder.
8419
8420 @item -mtls-direct-seg-refs
8421 @itemx -mno-tls-direct-seg-refs
8422 @opindex mtls-direct-seg-refs
8423 Controls whether TLS variables may be accessed with offsets from the
8424 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8425 or whether the thread base pointer must be added.  Whether or not this
8426 is legal depends on the operating system, and whether it maps the
8427 segment to cover the entire TLS area.
8428
8429 For systems that use GNU libc, the default is on.
8430 @end table
8431
8432 These @samp{-m} switches are supported in addition to the above
8433 on AMD x86-64 processors in 64-bit environments.
8434
8435 @table @gcctabopt
8436 @item -m32
8437 @itemx -m64
8438 @opindex m32
8439 @opindex m64
8440 Generate code for a 32-bit or 64-bit environment.
8441 The 32-bit environment sets int, long and pointer to 32 bits and
8442 generates code that runs on any i386 system.
8443 The 64-bit environment sets int to 32 bits and long and pointer
8444 to 64 bits and generates code for AMD's x86-64 architecture.
8445
8446 @item -mno-red-zone
8447 @opindex no-red-zone
8448 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8449 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8450 stack pointer that will not be modified by signal or interrupt handlers
8451 and therefore can be used for temporary data without adjusting the stack
8452 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8453
8454 @item -mcmodel=small
8455 @opindex mcmodel=small
8456 Generate code for the small code model: the program and its symbols must
8457 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8458 Programs can be statically or dynamically linked.  This is the default
8459 code model.
8460
8461 @item -mcmodel=kernel
8462 @opindex mcmodel=kernel
8463 Generate code for the kernel code model.  The kernel runs in the
8464 negative 2 GB of the address space.
8465 This model has to be used for Linux kernel code.
8466
8467 @item -mcmodel=medium
8468 @opindex mcmodel=medium
8469 Generate code for the medium model: The program is linked in the lower 2
8470 GB of the address space but symbols can be located anywhere in the
8471 address space.  Programs can be statically or dynamically linked, but
8472 building of shared libraries are not supported with the medium model.
8473
8474 @item -mcmodel=large
8475 @opindex mcmodel=large
8476 Generate code for the large model: This model makes no assumptions
8477 about addresses and sizes of sections.  Currently GCC does not implement
8478 this model.
8479 @end table
8480
8481 @node HPPA Options
8482 @subsection HPPA Options
8483 @cindex HPPA Options
8484
8485 These @samp{-m} options are defined for the HPPA family of computers:
8486
8487 @table @gcctabopt
8488 @item -march=@var{architecture-type}
8489 @opindex march
8490 Generate code for the specified architecture.  The choices for
8491 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8492 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8493 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8494 architecture option for your machine.  Code compiled for lower numbered
8495 architectures will run on higher numbered architectures, but not the
8496 other way around.
8497
8498 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8499 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8500 support.
8501
8502 @item -mpa-risc-1-0
8503 @itemx -mpa-risc-1-1
8504 @itemx -mpa-risc-2-0
8505 @opindex mpa-risc-1-0
8506 @opindex mpa-risc-1-1
8507 @opindex mpa-risc-2-0
8508 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8509
8510 @item -mbig-switch
8511 @opindex mbig-switch
8512 Generate code suitable for big switch tables.  Use this option only if
8513 the assembler/linker complain about out of range branches within a switch
8514 table.
8515
8516 @item -mjump-in-delay
8517 @opindex mjump-in-delay
8518 Fill delay slots of function calls with unconditional jump instructions
8519 by modifying the return pointer for the function call to be the target
8520 of the conditional jump.
8521
8522 @item -mdisable-fpregs
8523 @opindex mdisable-fpregs
8524 Prevent floating point registers from being used in any manner.  This is
8525 necessary for compiling kernels which perform lazy context switching of
8526 floating point registers.  If you use this option and attempt to perform
8527 floating point operations, the compiler will abort.
8528
8529 @item -mdisable-indexing
8530 @opindex mdisable-indexing
8531 Prevent the compiler from using indexing address modes.  This avoids some
8532 rather obscure problems when compiling MIG generated code under MACH@.
8533
8534 @item -mno-space-regs
8535 @opindex mno-space-regs
8536 Generate code that assumes the target has no space registers.  This allows
8537 GCC to generate faster indirect calls and use unscaled index address modes.
8538
8539 Such code is suitable for level 0 PA systems and kernels.
8540
8541 @item -mfast-indirect-calls
8542 @opindex mfast-indirect-calls
8543 Generate code that assumes calls never cross space boundaries.  This
8544 allows GCC to emit code which performs faster indirect calls.
8545
8546 This option will not work in the presence of shared libraries or nested
8547 functions.
8548
8549 @item -mlong-load-store
8550 @opindex mlong-load-store
8551 Generate 3-instruction load and store sequences as sometimes required by
8552 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8553 the HP compilers.
8554
8555 @item -mportable-runtime
8556 @opindex mportable-runtime
8557 Use the portable calling conventions proposed by HP for ELF systems.
8558
8559 @item -mgas
8560 @opindex mgas
8561 Enable the use of assembler directives only GAS understands.
8562
8563 @item -mschedule=@var{cpu-type}
8564 @opindex mschedule
8565 Schedule code according to the constraints for the machine type
8566 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8567 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8568 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8569 proper scheduling option for your machine.  The default scheduling is
8570 @samp{8000}.
8571
8572 @item -mlinker-opt
8573 @opindex mlinker-opt
8574 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8575 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8576 linkers in which they give bogus error messages when linking some programs.
8577
8578 @item -msoft-float
8579 @opindex msoft-float
8580 Generate output containing library calls for floating point.
8581 @strong{Warning:} the requisite libraries are not available for all HPPA
8582 targets.  Normally the facilities of the machine's usual C compiler are
8583 used, but this cannot be done directly in cross-compilation.  You must make
8584 your own arrangements to provide suitable library functions for
8585 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8586 does provide software floating point support.
8587
8588 @option{-msoft-float} changes the calling convention in the output file;
8589 therefore, it is only useful if you compile @emph{all} of a program with
8590 this option.  In particular, you need to compile @file{libgcc.a}, the
8591 library that comes with GCC, with @option{-msoft-float} in order for
8592 this to work.
8593
8594 @item -msio
8595 @opindex msio
8596 Generate the predefine, @code{_SIO}, for server IO.  The default is
8597 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8598 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8599 options are available under HP-UX and HI-UX.
8600
8601 @item -mgnu-ld
8602 @opindex gnu-ld
8603 Use GNU ld specific options.  This passes @option{-shared} to ld when
8604 building a shared library.  It is the default when GCC is configured,
8605 explicitly or implicitly, with the GNU linker.  This option does not
8606 have any affect on which ld is called, it only changes what parameters
8607 are passed to that ld.  The ld that is called is determined by the
8608 @option{--with-ld} configure option, gcc's program search path, and
8609 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8610 using @samp{which `gcc -print-prog-name=ld`}.
8611
8612 @item -mhp-ld
8613 @opindex hp-ld
8614 Use HP ld specific options.  This passes @option{-b} to ld when building
8615 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8616 links.  It is the default when GCC is configured, explicitly or
8617 implicitly, with the HP linker.  This option does not have any affect on
8618 which ld is called, it only changes what parameters are passed to that
8619 ld.  The ld that is called is determined by the @option{--with-ld}
8620 configure option, gcc's program search path, and finally by the user's
8621 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8622 `gcc -print-prog-name=ld`}.
8623
8624 @item -mlong-calls
8625 @opindex mno-long-calls
8626 Generate code that uses long call sequences.  This ensures that a call
8627 is always able to reach linker generated stubs.  The default is to generate
8628 long calls only when the distance from the call site to the beginning
8629 of the function or translation unit, as the case may be, exceeds a
8630 predefined limit set by the branch type being used.  The limits for
8631 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8632 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8633 240,000 bytes.
8634
8635 Distances are measured from the beginning of functions when using the
8636 @option{-ffunction-sections} option, or when using the @option{-mgas}
8637 and @option{-mno-portable-runtime} options together under HP-UX with
8638 the SOM linker.
8639
8640 It is normally not desirable to use this option as it will degrade
8641 performance.  However, it may be useful in large applications,
8642 particularly when partial linking is used to build the application.
8643
8644 The types of long calls used depends on the capabilities of the
8645 assembler and linker, and the type of code being generated.  The
8646 impact on systems that support long absolute calls, and long pic
8647 symbol-difference or pc-relative calls should be relatively small.
8648 However, an indirect call is used on 32-bit ELF systems in pic code
8649 and it is quite long.
8650
8651 @item -nolibdld
8652 @opindex nolibdld
8653 Suppress the generation of link options to search libdld.sl when the
8654 @option{-static} option is specified on HP-UX 10 and later.
8655
8656 @item -static
8657 @opindex static
8658 The HP-UX implementation of setlocale in libc has a dependency on
8659 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8660 when the @option{-static} option is specified, special link options
8661 are needed to resolve this dependency.
8662
8663 On HP-UX 10 and later, the GCC driver adds the necessary options to
8664 link with libdld.sl when the @option{-static} option is specified.
8665 This causes the resulting binary to be dynamic.  On the 64-bit port,
8666 the linkers generate dynamic binaries by default in any case.  The
8667 @option{-nolibdld} option can be used to prevent the GCC driver from
8668 adding these link options.
8669
8670 @item -threads
8671 @opindex threads
8672 Add support for multithreading with the @dfn{dce thread} library
8673 under HP-UX.  This option sets flags for both the preprocessor and
8674 linker.
8675 @end table
8676
8677 @node Intel 960 Options
8678 @subsection Intel 960 Options
8679
8680 These @samp{-m} options are defined for the Intel 960 implementations:
8681
8682 @table @gcctabopt
8683 @item -m@var{cpu-type}
8684 @opindex mka
8685 @opindex mkb
8686 @opindex mmc
8687 @opindex mca
8688 @opindex mcf
8689 @opindex msa
8690 @opindex msb
8691 Assume the defaults for the machine type @var{cpu-type} for some of
8692 the other options, including instruction scheduling, floating point
8693 support, and addressing modes.  The choices for @var{cpu-type} are
8694 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8695 @samp{sa}, and @samp{sb}.
8696 The default is
8697 @samp{kb}.
8698
8699 @item -mnumerics
8700 @itemx -msoft-float
8701 @opindex mnumerics
8702 @opindex msoft-float
8703 The @option{-mnumerics} option indicates that the processor does support
8704 floating-point instructions.  The @option{-msoft-float} option indicates
8705 that floating-point support should not be assumed.
8706
8707 @item -mleaf-procedures
8708 @itemx -mno-leaf-procedures
8709 @opindex mleaf-procedures
8710 @opindex mno-leaf-procedures
8711 Do (or do not) attempt to alter leaf procedures to be callable with the
8712 @code{bal} instruction as well as @code{call}.  This will result in more
8713 efficient code for explicit calls when the @code{bal} instruction can be
8714 substituted by the assembler or linker, but less efficient code in other
8715 cases, such as calls via function pointers, or using a linker that doesn't
8716 support this optimization.
8717
8718 @item -mtail-call
8719 @itemx -mno-tail-call
8720 @opindex mtail-call
8721 @opindex mno-tail-call
8722 Do (or do not) make additional attempts (beyond those of the
8723 machine-independent portions of the compiler) to optimize tail-recursive
8724 calls into branches.  You may not want to do this because the detection of
8725 cases where this is not valid is not totally complete.  The default is
8726 @option{-mno-tail-call}.
8727
8728 @item -mcomplex-addr
8729 @itemx -mno-complex-addr
8730 @opindex mcomplex-addr
8731 @opindex mno-complex-addr
8732 Assume (or do not assume) that the use of a complex addressing mode is a
8733 win on this implementation of the i960.  Complex addressing modes may not
8734 be worthwhile on the K-series, but they definitely are on the C-series.
8735 The default is currently @option{-mcomplex-addr} for all processors except
8736 the CB and CC@.
8737
8738 @item -mcode-align
8739 @itemx -mno-code-align
8740 @opindex mcode-align
8741 @opindex mno-code-align
8742 Align code to 8-byte boundaries for faster fetching (or don't bother).
8743 Currently turned on by default for C-series implementations only.
8744
8745 @ignore
8746 @item -mclean-linkage
8747 @itemx -mno-clean-linkage
8748 @opindex mclean-linkage
8749 @opindex mno-clean-linkage
8750 These options are not fully implemented.
8751 @end ignore
8752
8753 @item -mic-compat
8754 @itemx -mic2.0-compat
8755 @itemx -mic3.0-compat
8756 @opindex mic-compat
8757 @opindex mic2.0-compat
8758 @opindex mic3.0-compat
8759 Enable compatibility with iC960 v2.0 or v3.0.
8760
8761 @item -masm-compat
8762 @itemx -mintel-asm
8763 @opindex masm-compat
8764 @opindex mintel-asm
8765 Enable compatibility with the iC960 assembler.
8766
8767 @item -mstrict-align
8768 @itemx -mno-strict-align
8769 @opindex mstrict-align
8770 @opindex mno-strict-align
8771 Do not permit (do permit) unaligned accesses.
8772
8773 @item -mold-align
8774 @opindex mold-align
8775 Enable structure-alignment compatibility with Intel's gcc release version
8776 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8777
8778 @item -mlong-double-64
8779 @opindex mlong-double-64
8780 Implement type @samp{long double} as 64-bit floating point numbers.
8781 Without the option @samp{long double} is implemented by 80-bit
8782 floating point numbers.  The only reason we have it because there is
8783 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8784 is only useful for people using soft-float targets.  Otherwise, we
8785 should recommend against use of it.
8786
8787 @end table
8788
8789 @node DEC Alpha Options
8790 @subsection DEC Alpha Options
8791
8792 These @samp{-m} options are defined for the DEC Alpha implementations:
8793
8794 @table @gcctabopt
8795 @item -mno-soft-float
8796 @itemx -msoft-float
8797 @opindex mno-soft-float
8798 @opindex msoft-float
8799 Use (do not use) the hardware floating-point instructions for
8800 floating-point operations.  When @option{-msoft-float} is specified,
8801 functions in @file{libgcc.a} will be used to perform floating-point
8802 operations.  Unless they are replaced by routines that emulate the
8803 floating-point operations, or compiled in such a way as to call such
8804 emulations routines, these routines will issue floating-point
8805 operations.   If you are compiling for an Alpha without floating-point
8806 operations, you must ensure that the library is built so as not to call
8807 them.
8808
8809 Note that Alpha implementations without floating-point operations are
8810 required to have floating-point registers.
8811
8812 @item -mfp-reg
8813 @itemx -mno-fp-regs
8814 @opindex mfp-reg
8815 @opindex mno-fp-regs
8816 Generate code that uses (does not use) the floating-point register set.
8817 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8818 register set is not used, floating point operands are passed in integer
8819 registers as if they were integers and floating-point results are passed
8820 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8821 so any function with a floating-point argument or return value called by code
8822 compiled with @option{-mno-fp-regs} must also be compiled with that
8823 option.
8824
8825 A typical use of this option is building a kernel that does not use,
8826 and hence need not save and restore, any floating-point registers.
8827
8828 @item -mieee
8829 @opindex mieee
8830 The Alpha architecture implements floating-point hardware optimized for
8831 maximum performance.  It is mostly compliant with the IEEE floating
8832 point standard.  However, for full compliance, software assistance is
8833 required.  This option generates code fully IEEE compliant code
8834 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8835 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8836 defined during compilation.  The resulting code is less efficient but is
8837 able to correctly support denormalized numbers and exceptional IEEE
8838 values such as not-a-number and plus/minus infinity.  Other Alpha
8839 compilers call this option @option{-ieee_with_no_inexact}.
8840
8841 @item -mieee-with-inexact
8842 @opindex mieee-with-inexact
8843 This is like @option{-mieee} except the generated code also maintains
8844 the IEEE @var{inexact-flag}.  Turning on this option causes the
8845 generated code to implement fully-compliant IEEE math.  In addition to
8846 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8847 macro.  On some Alpha implementations the resulting code may execute
8848 significantly slower than the code generated by default.  Since there is
8849 very little code that depends on the @var{inexact-flag}, you should
8850 normally not specify this option.  Other Alpha compilers call this
8851 option @option{-ieee_with_inexact}.
8852
8853 @item -mfp-trap-mode=@var{trap-mode}
8854 @opindex mfp-trap-mode
8855 This option controls what floating-point related traps are enabled.
8856 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8857 The trap mode can be set to one of four values:
8858
8859 @table @samp
8860 @item n
8861 This is the default (normal) setting.  The only traps that are enabled
8862 are the ones that cannot be disabled in software (e.g., division by zero
8863 trap).
8864
8865 @item u
8866 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8867 as well.
8868
8869 @item su
8870 Like @samp{su}, but the instructions are marked to be safe for software
8871 completion (see Alpha architecture manual for details).
8872
8873 @item sui
8874 Like @samp{su}, but inexact traps are enabled as well.
8875 @end table
8876
8877 @item -mfp-rounding-mode=@var{rounding-mode}
8878 @opindex mfp-rounding-mode
8879 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8880 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8881 of:
8882
8883 @table @samp
8884 @item n
8885 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8886 the nearest machine number or towards the even machine number in case
8887 of a tie.
8888
8889 @item m
8890 Round towards minus infinity.
8891
8892 @item c
8893 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8894
8895 @item d
8896 Dynamic rounding mode.  A field in the floating point control register
8897 (@var{fpcr}, see Alpha architecture reference manual) controls the
8898 rounding mode in effect.  The C library initializes this register for
8899 rounding towards plus infinity.  Thus, unless your program modifies the
8900 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8901 @end table
8902
8903 @item -mtrap-precision=@var{trap-precision}
8904 @opindex mtrap-precision
8905 In the Alpha architecture, floating point traps are imprecise.  This
8906 means without software assistance it is impossible to recover from a
8907 floating trap and program execution normally needs to be terminated.
8908 GCC can generate code that can assist operating system trap handlers
8909 in determining the exact location that caused a floating point trap.
8910 Depending on the requirements of an application, different levels of
8911 precisions can be selected:
8912
8913 @table @samp
8914 @item p
8915 Program precision.  This option is the default and means a trap handler
8916 can only identify which program caused a floating point exception.
8917
8918 @item f
8919 Function precision.  The trap handler can determine the function that
8920 caused a floating point exception.
8921
8922 @item i
8923 Instruction precision.  The trap handler can determine the exact
8924 instruction that caused a floating point exception.
8925 @end table
8926
8927 Other Alpha compilers provide the equivalent options called
8928 @option{-scope_safe} and @option{-resumption_safe}.
8929
8930 @item -mieee-conformant
8931 @opindex mieee-conformant
8932 This option marks the generated code as IEEE conformant.  You must not
8933 use this option unless you also specify @option{-mtrap-precision=i} and either
8934 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8935 is to emit the line @samp{.eflag 48} in the function prologue of the
8936 generated assembly file.  Under DEC Unix, this has the effect that
8937 IEEE-conformant math library routines will be linked in.
8938
8939 @item -mbuild-constants
8940 @opindex mbuild-constants
8941 Normally GCC examines a 32- or 64-bit integer constant to
8942 see if it can construct it from smaller constants in two or three
8943 instructions.  If it cannot, it will output the constant as a literal and
8944 generate code to load it from the data segment at runtime.
8945
8946 Use this option to require GCC to construct @emph{all} integer constants
8947 using code, even if it takes more instructions (the maximum is six).
8948
8949 You would typically use this option to build a shared library dynamic
8950 loader.  Itself a shared library, it must relocate itself in memory
8951 before it can find the variables and constants in its own data segment.
8952
8953 @item -malpha-as
8954 @itemx -mgas
8955 @opindex malpha-as
8956 @opindex mgas
8957 Select whether to generate code to be assembled by the vendor-supplied
8958 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8959
8960 @item -mbwx
8961 @itemx -mno-bwx
8962 @itemx -mcix
8963 @itemx -mno-cix
8964 @itemx -mfix
8965 @itemx -mno-fix
8966 @itemx -mmax
8967 @itemx -mno-max
8968 @opindex mbwx
8969 @opindex mno-bwx
8970 @opindex mcix
8971 @opindex mno-cix
8972 @opindex mfix
8973 @opindex mno-fix
8974 @opindex mmax
8975 @opindex mno-max
8976 Indicate whether GCC should generate code to use the optional BWX,
8977 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8978 sets supported by the CPU type specified via @option{-mcpu=} option or that
8979 of the CPU on which GCC was built if none was specified.
8980
8981 @item -mfloat-vax
8982 @itemx -mfloat-ieee
8983 @opindex mfloat-vax
8984 @opindex mfloat-ieee
8985 Generate code that uses (does not use) VAX F and G floating point
8986 arithmetic instead of IEEE single and double precision.
8987
8988 @item -mexplicit-relocs
8989 @itemx -mno-explicit-relocs
8990 @opindex mexplicit-relocs
8991 @opindex mno-explicit-relocs
8992 Older Alpha assemblers provided no way to generate symbol relocations
8993 except via assembler macros.  Use of these macros does not allow
8994 optimal instruction scheduling.  GNU binutils as of version 2.12
8995 supports a new syntax that allows the compiler to explicitly mark
8996 which relocations should apply to which instructions.  This option
8997 is mostly useful for debugging, as GCC detects the capabilities of
8998 the assembler when it is built and sets the default accordingly.
8999
9000 @item -msmall-data
9001 @itemx -mlarge-data
9002 @opindex msmall-data
9003 @opindex mlarge-data
9004 When @option{-mexplicit-relocs} is in effect, static data is
9005 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9006 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9007 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9008 16-bit relocations off of the @code{$gp} register.  This limits the
9009 size of the small data area to 64KB, but allows the variables to be
9010 directly accessed via a single instruction.
9011
9012 The default is @option{-mlarge-data}.  With this option the data area
9013 is limited to just below 2GB.  Programs that require more than 2GB of
9014 data must use @code{malloc} or @code{mmap} to allocate the data in the
9015 heap instead of in the program's data segment.
9016
9017 When generating code for shared libraries, @option{-fpic} implies
9018 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9019
9020 @item -msmall-text
9021 @itemx -mlarge-text
9022 @opindex msmall-text
9023 @opindex mlarge-text
9024 When @option{-msmall-text} is used, the compiler assumes that the
9025 code of the entire program (or shared library) fits in 4MB, and is
9026 thus reachable with a branch instruction.  When @option{-msmall-data}
9027 is used, the compiler can assume that all local symbols share the
9028 same @code{$gp} value, and thus reduce the number of instructions
9029 required for a function call from 4 to 1.
9030
9031 The default is @option{-mlarge-text}.
9032
9033 @item -mcpu=@var{cpu_type}
9034 @opindex mcpu
9035 Set the instruction set and instruction scheduling parameters for
9036 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9037 style name or the corresponding chip number.  GCC supports scheduling
9038 parameters for the EV4, EV5 and EV6 family of processors and will
9039 choose the default values for the instruction set from the processor
9040 you specify.  If you do not specify a processor type, GCC will default
9041 to the processor on which the compiler was built.
9042
9043 Supported values for @var{cpu_type} are
9044
9045 @table @samp
9046 @item ev4
9047 @itemx ev45
9048 @itemx 21064
9049 Schedules as an EV4 and has no instruction set extensions.
9050
9051 @item ev5
9052 @itemx 21164
9053 Schedules as an EV5 and has no instruction set extensions.
9054
9055 @item ev56
9056 @itemx 21164a
9057 Schedules as an EV5 and supports the BWX extension.
9058
9059 @item pca56
9060 @itemx 21164pc
9061 @itemx 21164PC
9062 Schedules as an EV5 and supports the BWX and MAX extensions.
9063
9064 @item ev6
9065 @itemx 21264
9066 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9067
9068 @item ev67
9069 @itemx 21264a
9070 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9071 @end table
9072
9073 @item -mtune=@var{cpu_type}
9074 @opindex mtune
9075 Set only the instruction scheduling parameters for machine type
9076 @var{cpu_type}.  The instruction set is not changed.
9077
9078 @item -mmemory-latency=@var{time}
9079 @opindex mmemory-latency
9080 Sets the latency the scheduler should assume for typical memory
9081 references as seen by the application.  This number is highly
9082 dependent on the memory access patterns used by the application
9083 and the size of the external cache on the machine.
9084
9085 Valid options for @var{time} are
9086
9087 @table @samp
9088 @item @var{number}
9089 A decimal number representing clock cycles.
9090
9091 @item L1
9092 @itemx L2
9093 @itemx L3
9094 @itemx main
9095 The compiler contains estimates of the number of clock cycles for
9096 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9097 (also called Dcache, Scache, and Bcache), as well as to main memory.
9098 Note that L3 is only valid for EV5.
9099
9100 @end table
9101 @end table
9102
9103 @node DEC Alpha/VMS Options
9104 @subsection DEC Alpha/VMS Options
9105
9106 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9107
9108 @table @gcctabopt
9109 @item -mvms-return-codes
9110 @opindex mvms-return-codes
9111 Return VMS condition codes from main.  The default is to return POSIX
9112 style condition (e.g.@ error) codes.
9113 @end table
9114
9115 @node H8/300 Options
9116 @subsection H8/300 Options
9117
9118 These @samp{-m} options are defined for the H8/300 implementations:
9119
9120 @table @gcctabopt
9121 @item -mrelax
9122 @opindex mrelax
9123 Shorten some address references at link time, when possible; uses the
9124 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9125 ld, Using ld}, for a fuller description.
9126
9127 @item -mh
9128 @opindex mh
9129 Generate code for the H8/300H@.
9130
9131 @item -ms
9132 @opindex ms
9133 Generate code for the H8S@.
9134
9135 @item -mn
9136 @opindex mn
9137 Generate code for the H8S and H8/300H in the normal mode.  This switch
9138 must be used either with -mh or -ms.
9139
9140 @item -ms2600
9141 @opindex ms2600
9142 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9143
9144 @item -mint32
9145 @opindex mint32
9146 Make @code{int} data 32 bits by default.
9147
9148 @item -malign-300
9149 @opindex malign-300
9150 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9151 The default for the H8/300H and H8S is to align longs and floats on 4
9152 byte boundaries.
9153 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9154 This option has no effect on the H8/300.
9155 @end table
9156
9157 @node SH Options
9158 @subsection SH Options
9159
9160 These @samp{-m} options are defined for the SH implementations:
9161
9162 @table @gcctabopt
9163 @item -m1
9164 @opindex m1
9165 Generate code for the SH1.
9166
9167 @item -m2
9168 @opindex m2
9169 Generate code for the SH2.
9170
9171 @item -m2e
9172 Generate code for the SH2e.
9173
9174 @item -m3
9175 @opindex m3
9176 Generate code for the SH3.
9177
9178 @item -m3e
9179 @opindex m3e
9180 Generate code for the SH3e.
9181
9182 @item -m4-nofpu
9183 @opindex m4-nofpu
9184 Generate code for the SH4 without a floating-point unit.
9185
9186 @item -m4-single-only
9187 @opindex m4-single-only
9188 Generate code for the SH4 with a floating-point unit that only
9189 supports single-precision arithmetic.
9190
9191 @item -m4-single
9192 @opindex m4-single
9193 Generate code for the SH4 assuming the floating-point unit is in
9194 single-precision mode by default.
9195
9196 @item -m4
9197 @opindex m4
9198 Generate code for the SH4.
9199
9200 @item -mb
9201 @opindex mb
9202 Compile code for the processor in big endian mode.
9203
9204 @item -ml
9205 @opindex ml
9206 Compile code for the processor in little endian mode.
9207
9208 @item -mdalign
9209 @opindex mdalign
9210 Align doubles at 64-bit boundaries.  Note that this changes the calling
9211 conventions, and thus some functions from the standard C library will
9212 not work unless you recompile it first with @option{-mdalign}.
9213
9214 @item -mrelax
9215 @opindex mrelax
9216 Shorten some address references at link time, when possible; uses the
9217 linker option @option{-relax}.
9218
9219 @item -mbigtable
9220 @opindex mbigtable
9221 Use 32-bit offsets in @code{switch} tables.  The default is to use
9222 16-bit offsets.
9223
9224 @item -mfmovd
9225 @opindex mfmovd
9226 Enable the use of the instruction @code{fmovd}.
9227
9228 @item -mhitachi
9229 @opindex mhitachi
9230 Comply with the calling conventions defined by Renesas.
9231
9232 @item -mnomacsave
9233 @opindex mnomacsave
9234 Mark the @code{MAC} register as call-clobbered, even if
9235 @option{-mhitachi} is given.
9236
9237 @item -mieee
9238 @opindex mieee
9239 Increase IEEE-compliance of floating-point code.
9240
9241 @item -misize
9242 @opindex misize
9243 Dump instruction size and location in the assembly code.
9244
9245 @item -mpadstruct
9246 @opindex mpadstruct
9247 This option is deprecated.  It pads structures to multiple of 4 bytes,
9248 which is incompatible with the SH ABI@.
9249
9250 @item -mspace
9251 @opindex mspace
9252 Optimize for space instead of speed.  Implied by @option{-Os}.
9253
9254 @item -mprefergot
9255 @opindex mprefergot
9256 When generating position-independent code, emit function calls using
9257 the Global Offset Table instead of the Procedure Linkage Table.
9258
9259 @item -musermode
9260 @opindex musermode
9261 Generate a library function call to invalidate instruction cache
9262 entries, after fixing up a trampoline.  This library function call
9263 doesn't assume it can write to the whole memory address space.  This
9264 is the default when the target is @code{sh-*-linux*}.
9265 @end table
9266
9267 @node System V Options
9268 @subsection Options for System V
9269
9270 These additional options are available on System V Release 4 for
9271 compatibility with other compilers on those systems:
9272
9273 @table @gcctabopt
9274 @item -G
9275 @opindex G
9276 Create a shared object.
9277 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9278
9279 @item -Qy
9280 @opindex Qy
9281 Identify the versions of each tool used by the compiler, in a
9282 @code{.ident} assembler directive in the output.
9283
9284 @item -Qn
9285 @opindex Qn
9286 Refrain from adding @code{.ident} directives to the output file (this is
9287 the default).
9288
9289 @item -YP,@var{dirs}
9290 @opindex YP
9291 Search the directories @var{dirs}, and no others, for libraries
9292 specified with @option{-l}.
9293
9294 @item -Ym,@var{dir}
9295 @opindex Ym
9296 Look in the directory @var{dir} to find the M4 preprocessor.
9297 The assembler uses this option.
9298 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9299 @c the generic assembler that comes with Solaris takes just -Ym.
9300 @end table
9301
9302 @node TMS320C3x/C4x Options
9303 @subsection TMS320C3x/C4x Options
9304 @cindex TMS320C3x/C4x Options
9305
9306 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9307
9308 @table @gcctabopt
9309
9310 @item -mcpu=@var{cpu_type}
9311 @opindex mcpu
9312 Set the instruction set, register set, and instruction scheduling
9313 parameters for machine type @var{cpu_type}.  Supported values for
9314 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9315 @samp{c44}.  The default is @samp{c40} to generate code for the
9316 TMS320C40.
9317
9318 @item -mbig-memory
9319 @itemx -mbig
9320 @itemx -msmall-memory
9321 @itemx -msmall
9322 @opindex mbig-memory
9323 @opindex mbig
9324 @opindex msmall-memory
9325 @opindex msmall
9326 Generates code for the big or small memory model.  The small memory
9327 model assumed that all data fits into one 64K word page.  At run-time
9328 the data page (DP) register must be set to point to the 64K page
9329 containing the .bss and .data program sections.  The big memory model is
9330 the default and requires reloading of the DP register for every direct
9331 memory access.
9332
9333 @item -mbk
9334 @itemx -mno-bk
9335 @opindex mbk
9336 @opindex mno-bk
9337 Allow (disallow) allocation of general integer operands into the block
9338 count register BK@.
9339
9340 @item -mdb
9341 @itemx -mno-db
9342 @opindex mdb
9343 @opindex mno-db
9344 Enable (disable) generation of code using decrement and branch,
9345 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9346 on the safe side, this is disabled for the C3x, since the maximum
9347 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9348 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9349 that it can utilize the decrement and branch instruction, but will give
9350 up if there is more than one memory reference in the loop.  Thus a loop
9351 where the loop counter is decremented can generate slightly more
9352 efficient code, in cases where the RPTB instruction cannot be utilized.
9353
9354 @item -mdp-isr-reload
9355 @itemx -mparanoid
9356 @opindex mdp-isr-reload
9357 @opindex mparanoid
9358 Force the DP register to be saved on entry to an interrupt service
9359 routine (ISR), reloaded to point to the data section, and restored on
9360 exit from the ISR@.  This should not be required unless someone has
9361 violated the small memory model by modifying the DP register, say within
9362 an object library.
9363
9364 @item -mmpyi
9365 @itemx -mno-mpyi
9366 @opindex mmpyi
9367 @opindex mno-mpyi
9368 For the C3x use the 24-bit MPYI instruction for integer multiplies
9369 instead of a library call to guarantee 32-bit results.  Note that if one
9370 of the operands is a constant, then the multiplication will be performed
9371 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9372 then squaring operations are performed inline instead of a library call.
9373
9374 @item -mfast-fix
9375 @itemx -mno-fast-fix
9376 @opindex mfast-fix
9377 @opindex mno-fast-fix
9378 The C3x/C4x FIX instruction to convert a floating point value to an
9379 integer value chooses the nearest integer less than or equal to the
9380 floating point value rather than to the nearest integer.  Thus if the
9381 floating point number is negative, the result will be incorrectly
9382 truncated an additional code is necessary to detect and correct this
9383 case.  This option can be used to disable generation of the additional
9384 code required to correct the result.
9385
9386 @item -mrptb
9387 @itemx -mno-rptb
9388 @opindex mrptb
9389 @opindex mno-rptb
9390 Enable (disable) generation of repeat block sequences using the RPTB
9391 instruction for zero overhead looping.  The RPTB construct is only used
9392 for innermost loops that do not call functions or jump across the loop
9393 boundaries.  There is no advantage having nested RPTB loops due to the
9394 overhead required to save and restore the RC, RS, and RE registers.
9395 This is enabled by default with @option{-O2}.
9396
9397 @item -mrpts=@var{count}
9398 @itemx -mno-rpts
9399 @opindex mrpts
9400 @opindex mno-rpts
9401 Enable (disable) the use of the single instruction repeat instruction
9402 RPTS@.  If a repeat block contains a single instruction, and the loop
9403 count can be guaranteed to be less than the value @var{count}, GCC will
9404 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9405 then a RPTS will be emitted even if the loop count cannot be determined
9406 at compile time.  Note that the repeated instruction following RPTS does
9407 not have to be reloaded from memory each iteration, thus freeing up the
9408 CPU buses for operands.  However, since interrupts are blocked by this
9409 instruction, it is disabled by default.
9410
9411 @item -mloop-unsigned
9412 @itemx -mno-loop-unsigned
9413 @opindex mloop-unsigned
9414 @opindex mno-loop-unsigned
9415 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9416 is @math{2^{31} + 1} since these instructions test if the iteration count is
9417 negative to terminate the loop.  If the iteration count is unsigned
9418 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9419 exceeded.  This switch allows an unsigned iteration count.
9420
9421 @item -mti
9422 @opindex mti
9423 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9424 with.  This also enforces compatibility with the API employed by the TI
9425 C3x C compiler.  For example, long doubles are passed as structures
9426 rather than in floating point registers.
9427
9428 @item -mregparm
9429 @itemx -mmemparm
9430 @opindex mregparm
9431 @opindex mmemparm
9432 Generate code that uses registers (stack) for passing arguments to functions.
9433 By default, arguments are passed in registers where possible rather
9434 than by pushing arguments on to the stack.
9435
9436 @item -mparallel-insns
9437 @itemx -mno-parallel-insns
9438 @opindex mparallel-insns
9439 @opindex mno-parallel-insns
9440 Allow the generation of parallel instructions.  This is enabled by
9441 default with @option{-O2}.
9442
9443 @item -mparallel-mpy
9444 @itemx -mno-parallel-mpy
9445 @opindex mparallel-mpy
9446 @opindex mno-parallel-mpy
9447 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9448 provided @option{-mparallel-insns} is also specified.  These instructions have
9449 tight register constraints which can pessimize the code generation
9450 of large functions.
9451
9452 @end table
9453
9454 @node V850 Options
9455 @subsection V850 Options
9456 @cindex V850 Options
9457
9458 These @samp{-m} options are defined for V850 implementations:
9459
9460 @table @gcctabopt
9461 @item -mlong-calls
9462 @itemx -mno-long-calls
9463 @opindex mlong-calls
9464 @opindex mno-long-calls
9465 Treat all calls as being far away (near).  If calls are assumed to be
9466 far away, the compiler will always load the functions address up into a
9467 register, and call indirect through the pointer.
9468
9469 @item -mno-ep
9470 @itemx -mep
9471 @opindex mno-ep
9472 @opindex mep
9473 Do not optimize (do optimize) basic blocks that use the same index
9474 pointer 4 or more times to copy pointer into the @code{ep} register, and
9475 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9476 option is on by default if you optimize.
9477
9478 @item -mno-prolog-function
9479 @itemx -mprolog-function
9480 @opindex mno-prolog-function
9481 @opindex mprolog-function
9482 Do not use (do use) external functions to save and restore registers
9483 at the prologue and epilogue of a function.  The external functions
9484 are slower, but use less code space if more than one function saves
9485 the same number of registers.  The @option{-mprolog-function} option
9486 is on by default if you optimize.
9487
9488 @item -mspace
9489 @opindex mspace
9490 Try to make the code as small as possible.  At present, this just turns
9491 on the @option{-mep} and @option{-mprolog-function} options.
9492
9493 @item -mtda=@var{n}
9494 @opindex mtda
9495 Put static or global variables whose size is @var{n} bytes or less into
9496 the tiny data area that register @code{ep} points to.  The tiny data
9497 area can hold up to 256 bytes in total (128 bytes for byte references).
9498
9499 @item -msda=@var{n}
9500 @opindex msda
9501 Put static or global variables whose size is @var{n} bytes or less into
9502 the small data area that register @code{gp} points to.  The small data
9503 area can hold up to 64 kilobytes.
9504
9505 @item -mzda=@var{n}
9506 @opindex mzda
9507 Put static or global variables whose size is @var{n} bytes or less into
9508 the first 32 kilobytes of memory.
9509
9510 @item -mv850
9511 @opindex mv850
9512 Specify that the target processor is the V850.
9513
9514 @item -mbig-switch
9515 @opindex mbig-switch
9516 Generate code suitable for big switch tables.  Use this option only if
9517 the assembler/linker complain about out of range branches within a switch
9518 table.
9519
9520 @item -mapp-regs
9521 @opindex mapp-regs
9522 This option will cause r2 and r5 to be used in the code generated by
9523 the compiler.  This setting is the default.
9524
9525 @item -mno-app-regs
9526 @opindex mno-app-regs
9527 This option will cause r2 and r5 to be treated as fixed registers.
9528   
9529 @item -mv850e1
9530 @opindex mv850e1
9531 Specify that the target processor is the V850E1.  The preprocessor
9532 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9533 this option is used.
9534
9535 @item -mv850e
9536 @opindex mv850e
9537 Specify that the target processor is the V850E.  The preprocessor
9538 constant @samp{__v850e__} will be defined if this option is used.
9539
9540 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9541 are defined then a default target processor will be chosen and the
9542 relevant @samp{__v850*__} preprocessor constant will be defined.
9543
9544 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9545 defined, regardless of which processor variant is the target.
9546
9547 @item -mdisable-callt
9548 @opindex mdisable-callt
9549 This option will suppress generation of the CALLT instruction for the
9550 v850e and v850e1 flavors of the v850 architecture.  The default is
9551 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9552
9553 @end table
9554
9555 @node ARC Options
9556 @subsection ARC Options
9557 @cindex ARC Options
9558
9559 These options are defined for ARC implementations:
9560
9561 @table @gcctabopt
9562 @item -EL
9563 @opindex EL
9564 Compile code for little endian mode.  This is the default.
9565
9566 @item -EB
9567 @opindex EB
9568 Compile code for big endian mode.
9569
9570 @item -mmangle-cpu
9571 @opindex mmangle-cpu
9572 Prepend the name of the cpu to all public symbol names.
9573 In multiple-processor systems, there are many ARC variants with different
9574 instruction and register set characteristics.  This flag prevents code
9575 compiled for one cpu to be linked with code compiled for another.
9576 No facility exists for handling variants that are ``almost identical''.
9577 This is an all or nothing option.
9578
9579 @item -mcpu=@var{cpu}
9580 @opindex mcpu
9581 Compile code for ARC variant @var{cpu}.
9582 Which variants are supported depend on the configuration.
9583 All variants support @option{-mcpu=base}, this is the default.
9584
9585 @item -mtext=@var{text-section}
9586 @itemx -mdata=@var{data-section}
9587 @itemx -mrodata=@var{readonly-data-section}
9588 @opindex mtext
9589 @opindex mdata
9590 @opindex mrodata
9591 Put functions, data, and readonly data in @var{text-section},
9592 @var{data-section}, and @var{readonly-data-section} respectively
9593 by default.  This can be overridden with the @code{section} attribute.
9594 @xref{Variable Attributes}.
9595
9596 @end table
9597
9598 @node NS32K Options
9599 @subsection NS32K Options
9600 @cindex NS32K options
9601
9602 These are the @samp{-m} options defined for the 32000 series.  The default
9603 values for these options depends on which style of 32000 was selected when
9604 the compiler was configured; the defaults for the most common choices are
9605 given below.
9606
9607 @table @gcctabopt
9608 @item -m32032
9609 @itemx -m32032
9610 @opindex m32032
9611 @opindex m32032
9612 Generate output for a 32032.  This is the default
9613 when the compiler is configured for 32032 and 32016 based systems.
9614
9615 @item -m32332
9616 @itemx -m32332
9617 @opindex m32332
9618 @opindex m32332
9619 Generate output for a 32332.  This is the default
9620 when the compiler is configured for 32332-based systems.
9621
9622 @item -m32532
9623 @itemx -m32532
9624 @opindex m32532
9625 @opindex m32532
9626 Generate output for a 32532.  This is the default
9627 when the compiler is configured for 32532-based systems.
9628
9629 @item -m32081
9630 @opindex m32081
9631 Generate output containing 32081 instructions for floating point.
9632 This is the default for all systems.
9633
9634 @item -m32381
9635 @opindex m32381
9636 Generate output containing 32381 instructions for floating point.  This
9637 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9638 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9639
9640 @item -mmulti-add
9641 @opindex mmulti-add
9642 Try and generate multiply-add floating point instructions @code{polyF}
9643 and @code{dotF}.  This option is only available if the @option{-m32381}
9644 option is in effect.  Using these instructions requires changes to
9645 register allocation which generally has a negative impact on
9646 performance.  This option should only be enabled when compiling code
9647 particularly likely to make heavy use of multiply-add instructions.
9648
9649 @item -mnomulti-add
9650 @opindex mnomulti-add
9651 Do not try and generate multiply-add floating point instructions
9652 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9653
9654 @item -msoft-float
9655 @opindex msoft-float
9656 Generate output containing library calls for floating point.
9657 @strong{Warning:} the requisite libraries may not be available.
9658
9659 @item -mieee-compare
9660 @itemx -mno-ieee-compare
9661 @opindex mieee-compare
9662 @opindex mno-ieee-compare
9663 Control whether or not the compiler uses IEEE floating point
9664 comparisons.  These handle correctly the case where the result of a
9665 comparison is unordered.
9666 @strong{Warning:} the requisite kernel support may not be available.
9667
9668 @item -mnobitfield
9669 @opindex mnobitfield
9670 Do not use the bit-field instructions.  On some machines it is faster to
9671 use shifting and masking operations.  This is the default for the pc532.
9672
9673 @item -mbitfield
9674 @opindex mbitfield
9675 Do use the bit-field instructions.  This is the default for all platforms
9676 except the pc532.
9677
9678 @item -mrtd
9679 @opindex mrtd
9680 Use a different function-calling convention, in which functions
9681 that take a fixed number of arguments return pop their
9682 arguments on return with the @code{ret} instruction.
9683
9684 This calling convention is incompatible with the one normally
9685 used on Unix, so you cannot use it if you need to call libraries
9686 compiled with the Unix compiler.
9687
9688 Also, you must provide function prototypes for all functions that
9689 take variable numbers of arguments (including @code{printf});
9690 otherwise incorrect code will be generated for calls to those
9691 functions.
9692
9693 In addition, seriously incorrect code will result if you call a
9694 function with too many arguments.  (Normally, extra arguments are
9695 harmlessly ignored.)
9696
9697 This option takes its name from the 680x0 @code{rtd} instruction.
9698
9699
9700 @item -mregparam
9701 @opindex mregparam
9702 Use a different function-calling convention where the first two arguments
9703 are passed in registers.
9704
9705 This calling convention is incompatible with the one normally
9706 used on Unix, so you cannot use it if you need to call libraries
9707 compiled with the Unix compiler.
9708
9709 @item -mnoregparam
9710 @opindex mnoregparam
9711 Do not pass any arguments in registers.  This is the default for all
9712 targets.
9713
9714 @item -msb
9715 @opindex msb
9716 It is OK to use the sb as an index register which is always loaded with
9717 zero.  This is the default for the pc532-netbsd target.
9718
9719 @item -mnosb
9720 @opindex mnosb
9721 The sb register is not available for use or has not been initialized to
9722 zero by the run time system.  This is the default for all targets except
9723 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9724 @option{-fpic} is set.
9725
9726 @item -mhimem
9727 @opindex mhimem
9728 Many ns32000 series addressing modes use displacements of up to 512MB@.
9729 If an address is above 512MB then displacements from zero can not be used.
9730 This option causes code to be generated which can be loaded above 512MB@.
9731 This may be useful for operating systems or ROM code.
9732
9733 @item -mnohimem
9734 @opindex mnohimem
9735 Assume code will be loaded in the first 512MB of virtual address space.
9736 This is the default for all platforms.
9737
9738
9739 @end table
9740
9741 @node AVR Options
9742 @subsection AVR Options
9743 @cindex AVR Options
9744
9745 These options are defined for AVR implementations:
9746
9747 @table @gcctabopt
9748 @item -mmcu=@var{mcu}
9749 @opindex mmcu
9750 Specify ATMEL AVR instruction set or MCU type.
9751
9752 Instruction set avr1 is for the minimal AVR core, not supported by the C
9753 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9754 attiny11, attiny12, attiny15, attiny28).
9755
9756 Instruction set avr2 (default) is for the classic AVR core with up to
9757 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9758 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9759 at90c8534, at90s8535).
9760
9761 Instruction set avr3 is for the classic AVR core with up to 128K program
9762 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9763
9764 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9765 memory space (MCU types: atmega8, atmega83, atmega85).
9766
9767 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9768 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9769 atmega64, atmega128, at43usb355, at94k).
9770
9771 @item -msize
9772 @opindex msize
9773 Output instruction sizes to the asm file.
9774
9775 @item -minit-stack=@var{N}
9776 @opindex minit-stack
9777 Specify the initial stack address, which may be a symbol or numeric value,
9778 @samp{__stack} is the default.
9779
9780 @item -mno-interrupts
9781 @opindex mno-interrupts
9782 Generated code is not compatible with hardware interrupts.
9783 Code size will be smaller.
9784
9785 @item -mcall-prologues
9786 @opindex mcall-prologues
9787 Functions prologues/epilogues expanded as call to appropriate
9788 subroutines.  Code size will be smaller.
9789
9790 @item -mno-tablejump
9791 @opindex mno-tablejump
9792 Do not generate tablejump insns which sometimes increase code size.
9793
9794 @item -mtiny-stack
9795 @opindex mtiny-stack
9796 Change only the low 8 bits of the stack pointer.
9797 @end table
9798
9799 @node MCore Options
9800 @subsection MCore Options
9801 @cindex MCore options
9802
9803 These are the @samp{-m} options defined for the Motorola M*Core
9804 processors.
9805
9806 @table @gcctabopt
9807
9808 @item -mhardlit
9809 @itemx -mno-hardlit
9810 @opindex mhardlit
9811 @opindex mno-hardlit
9812 Inline constants into the code stream if it can be done in two
9813 instructions or less.
9814
9815 @item -mdiv
9816 @itemx -mno-div
9817 @opindex mdiv
9818 @opindex mno-div
9819 Use the divide instruction.  (Enabled by default).
9820
9821 @item -mrelax-immediate
9822 @itemx -mno-relax-immediate
9823 @opindex mrelax-immediate
9824 @opindex mno-relax-immediate
9825 Allow arbitrary sized immediates in bit operations.
9826
9827 @item -mwide-bitfields
9828 @itemx -mno-wide-bitfields
9829 @opindex mwide-bitfields
9830 @opindex mno-wide-bitfields
9831 Always treat bit-fields as int-sized.
9832
9833 @item -m4byte-functions
9834 @itemx -mno-4byte-functions
9835 @opindex m4byte-functions
9836 @opindex mno-4byte-functions
9837 Force all functions to be aligned to a four byte boundary.
9838
9839 @item -mcallgraph-data
9840 @itemx -mno-callgraph-data
9841 @opindex mcallgraph-data
9842 @opindex mno-callgraph-data
9843 Emit callgraph information.
9844
9845 @item -mslow-bytes
9846 @itemx -mno-slow-bytes
9847 @opindex mslow-bytes
9848 @opindex mno-slow-bytes
9849 Prefer word access when reading byte quantities.
9850
9851 @item -mlittle-endian
9852 @itemx -mbig-endian
9853 @opindex mlittle-endian
9854 @opindex mbig-endian
9855 Generate code for a little endian target.
9856
9857 @item -m210
9858 @itemx -m340
9859 @opindex m210
9860 @opindex m340
9861 Generate code for the 210 processor.
9862 @end table
9863
9864 @node IA-64 Options
9865 @subsection IA-64 Options
9866 @cindex IA-64 Options
9867
9868 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9869
9870 @table @gcctabopt
9871 @item -mbig-endian
9872 @opindex mbig-endian
9873 Generate code for a big endian target.  This is the default for HP-UX@.
9874
9875 @item -mlittle-endian
9876 @opindex mlittle-endian
9877 Generate code for a little endian target.  This is the default for AIX5
9878 and Linux.
9879
9880 @item -mgnu-as
9881 @itemx -mno-gnu-as
9882 @opindex mgnu-as
9883 @opindex mno-gnu-as
9884 Generate (or don't) code for the GNU assembler.  This is the default.
9885 @c Also, this is the default if the configure option @option{--with-gnu-as}
9886 @c is used.
9887
9888 @item -mgnu-ld
9889 @itemx -mno-gnu-ld
9890 @opindex mgnu-ld
9891 @opindex mno-gnu-ld
9892 Generate (or don't) code for the GNU linker.  This is the default.
9893 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9894 @c is used.
9895
9896 @item -mno-pic
9897 @opindex mno-pic
9898 Generate code that does not use a global pointer register.  The result
9899 is not position independent code, and violates the IA-64 ABI@.
9900
9901 @item -mvolatile-asm-stop
9902 @itemx -mno-volatile-asm-stop
9903 @opindex mvolatile-asm-stop
9904 @opindex mno-volatile-asm-stop
9905 Generate (or don't) a stop bit immediately before and after volatile asm
9906 statements.
9907
9908 @item -mb-step
9909 @opindex mb-step
9910 Generate code that works around Itanium B step errata.
9911
9912 @item -mregister-names
9913 @itemx -mno-register-names
9914 @opindex mregister-names
9915 @opindex mno-register-names
9916 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9917 the stacked registers.  This may make assembler output more readable.
9918
9919 @item -mno-sdata
9920 @itemx -msdata
9921 @opindex mno-sdata
9922 @opindex msdata
9923 Disable (or enable) optimizations that use the small data section.  This may
9924 be useful for working around optimizer bugs.
9925
9926 @item -mconstant-gp
9927 @opindex mconstant-gp
9928 Generate code that uses a single constant global pointer value.  This is
9929 useful when compiling kernel code.
9930
9931 @item -mauto-pic
9932 @opindex mauto-pic
9933 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9934 This is useful when compiling firmware code.
9935
9936 @item -minline-float-divide-min-latency
9937 @opindex minline-float-divide-min-latency
9938 Generate code for inline divides of floating point values
9939 using the minimum latency algorithm.
9940
9941 @item -minline-float-divide-max-throughput
9942 @opindex minline-float-divide-max-throughput
9943 Generate code for inline divides of floating point values
9944 using the maximum throughput algorithm.
9945
9946 @item -minline-int-divide-min-latency
9947 @opindex minline-int-divide-min-latency
9948 Generate code for inline divides of integer values
9949 using the minimum latency algorithm.
9950
9951 @item -minline-int-divide-max-throughput
9952 @opindex minline-int-divide-max-throughput
9953 Generate code for inline divides of integer values
9954 using the maximum throughput algorithm.
9955
9956 @item -mno-dwarf2-asm
9957 @itemx -mdwarf2-asm
9958 @opindex mno-dwarf2-asm
9959 @opindex mdwarf2-asm
9960 Don't (or do) generate assembler code for the DWARF2 line number debugging
9961 info.  This may be useful when not using the GNU assembler.
9962
9963 @item -mfixed-range=@var{register-range}
9964 @opindex mfixed-range
9965 Generate code treating the given register range as fixed registers.
9966 A fixed register is one that the register allocator can not use.  This is
9967 useful when compiling kernel code.  A register range is specified as
9968 two registers separated by a dash.  Multiple register ranges can be
9969 specified separated by a comma.
9970
9971 @item -mearly-stop-bits
9972 @itemx -mno-early-stop-bits
9973 @opindex mearly-stop-bits
9974 @opindex mno-early-stop-bits
9975 Allow stop bits to be placed earlier than immediately preceding the
9976 instruction that triggered the stop bit.  This can improve instruction
9977 scheduling, but does not always do so.
9978 @end table
9979
9980 @node D30V Options
9981 @subsection D30V Options
9982 @cindex D30V Options
9983
9984 These @samp{-m} options are defined for D30V implementations:
9985
9986 @table @gcctabopt
9987 @item -mextmem
9988 @opindex mextmem
9989 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9990 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9991 memory, which starts at location @code{0x80000000}.
9992
9993 @item -mextmemory
9994 @opindex mextmemory
9995 Same as the @option{-mextmem} switch.
9996
9997 @item -monchip
9998 @opindex monchip
9999 Link the @samp{.text} section into onchip text memory, which starts at
10000 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10001 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10002 into onchip data memory, which starts at location @code{0x20000000}.
10003
10004 @item -mno-asm-optimize
10005 @itemx -masm-optimize
10006 @opindex mno-asm-optimize
10007 @opindex masm-optimize
10008 Disable (enable) passing @option{-O} to the assembler when optimizing.
10009 The assembler uses the @option{-O} option to automatically parallelize
10010 adjacent short instructions where possible.
10011
10012 @item -mbranch-cost=@var{n}
10013 @opindex mbranch-cost
10014 Increase the internal costs of branches to @var{n}.  Higher costs means
10015 that the compiler will issue more instructions to avoid doing a branch.
10016 The default is 2.
10017
10018 @item -mcond-exec=@var{n}
10019 @opindex mcond-exec
10020 Specify the maximum number of conditionally executed instructions that
10021 replace a branch.  The default is 4.
10022 @end table
10023
10024 @node S/390 and zSeries Options
10025 @subsection S/390 and zSeries Options
10026 @cindex S/390 and zSeries Options
10027
10028 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10029
10030 @table @gcctabopt
10031 @item -mhard-float
10032 @itemx -msoft-float
10033 @opindex mhard-float
10034 @opindex msoft-float
10035 Use (do not use) the hardware floating-point instructions and registers
10036 for floating-point operations.  When @option{-msoft-float} is specified,
10037 functions in @file{libgcc.a} will be used to perform floating-point
10038 operations.  When @option{-mhard-float} is specified, the compiler
10039 generates IEEE floating-point instructions.  This is the default.
10040
10041 @item -mbackchain
10042 @itemx -mno-backchain
10043 @opindex mbackchain
10044 @opindex mno-backchain
10045 Generate (or do not generate) code which maintains an explicit
10046 backchain within the stack frame that points to the caller's frame.
10047 This is currently needed to allow debugging.  The default is to
10048 generate the backchain.
10049
10050 @item -msmall-exec
10051 @itemx -mno-small-exec
10052 @opindex msmall-exec
10053 @opindex mno-small-exec
10054 Generate (or do not generate) code using the @code{bras} instruction
10055 to do subroutine calls.
10056 This only works reliably if the total executable size does not
10057 exceed 64k.  The default is to use the @code{basr} instruction instead,
10058 which does not have this limitation.
10059
10060 @item -m64
10061 @itemx -m31
10062 @opindex m64
10063 @opindex m31
10064 When @option{-m31} is specified, generate code compliant to the
10065 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10066 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10067 particular to generate 64-bit instructions.  For the @samp{s390}
10068 targets, the default is @option{-m31}, while the @samp{s390x}
10069 targets default to @option{-m64}.
10070
10071 @item -mzarch
10072 @itemx -mesa
10073 @opindex mzarch
10074 @opindex mesa
10075 When @option{-mzarch} is specified, generate code using the 
10076 instructions available on z/Architecture. 
10077 When @option{-mesa} is specified, generate code using the 
10078 instructions available on ESA/390. Note that @option{-mesa} is
10079 not possible with @option{-m64}.
10080 When generating code compliant to the Linux for S/390 ABI,
10081 the default is @option{-mesa}.  When generating code compliant
10082 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10083
10084 @item -mmvcle
10085 @itemx -mno-mvcle
10086 @opindex mmvcle
10087 @opindex mno-mvcle
10088 Generate (or do not generate) code using the @code{mvcle} instruction
10089 to perform block moves.  When @option{-mno-mvcle} is specified,
10090 use a @code{mvc} loop instead.  This is the default.
10091
10092 @item -mdebug
10093 @itemx -mno-debug
10094 @opindex mdebug
10095 @opindex mno-debug
10096 Print (or do not print) additional debug information when compiling.
10097 The default is to not print debug information.
10098
10099 @item -march=@var{cpu-type}
10100 @opindex march
10101 Generate code that will run on @var{cpu-type}, which is the name of a system
10102 representing a certain processor type. Possible values for
10103 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10104 When generating code using the instructions available on z/Architecture,
10105 the default is @option{-march=z900}.  Otherwise, the default is
10106 @option{-march=g5}.
10107
10108 @item -mtune=@var{cpu-type}
10109 @opindex mtune
10110 Tune to @var{cpu-type} everything applicable about the generated code,
10111 except for the ABI and the set of available instructions.
10112 The list of @var{cpu-type} values is the same as for @option{-march}.
10113 The default is the value used for @option{-march}.
10114
10115 @item -mfused-madd
10116 @itemx -mno-fused-madd
10117 @opindex mfused-madd
10118 @opindex mno-fused-madd
10119 Generate code that uses (does not use) the floating point multiply and
10120 accumulate instructions.  These instructions are generated by default if
10121 hardware floating point is used.
10122 @end table
10123
10124 @node CRIS Options
10125 @subsection CRIS Options
10126 @cindex CRIS Options
10127
10128 These options are defined specifically for the CRIS ports.
10129
10130 @table @gcctabopt
10131 @item -march=@var{architecture-type}
10132 @itemx -mcpu=@var{architecture-type}
10133 @opindex march
10134 @opindex mcpu
10135 Generate code for the specified architecture.  The choices for
10136 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10137 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10138 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10139 @samp{v10}.
10140
10141 @item -mtune=@var{architecture-type}
10142 @opindex mtune
10143 Tune to @var{architecture-type} everything applicable about the generated
10144 code, except for the ABI and the set of available instructions.  The
10145 choices for @var{architecture-type} are the same as for
10146 @option{-march=@var{architecture-type}}.
10147
10148 @item -mmax-stack-frame=@var{n}
10149 @opindex mmax-stack-frame
10150 Warn when the stack frame of a function exceeds @var{n} bytes.
10151
10152 @item -melinux-stacksize=@var{n}
10153 @opindex melinux-stacksize
10154 Only available with the @samp{cris-axis-aout} target.  Arranges for
10155 indications in the program to the kernel loader that the stack of the
10156 program should be set to @var{n} bytes.
10157
10158 @item -metrax4
10159 @itemx -metrax100
10160 @opindex metrax4
10161 @opindex metrax100
10162 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10163 @option{-march=v3} and @option{-march=v8} respectively.
10164
10165 @item -mpdebug
10166 @opindex mpdebug
10167 Enable CRIS-specific verbose debug-related information in the assembly
10168 code.  This option also has the effect to turn off the @samp{#NO_APP}
10169 formatted-code indicator to the assembler at the beginning of the
10170 assembly file.
10171
10172 @item -mcc-init
10173 @opindex mcc-init
10174 Do not use condition-code results from previous instruction; always emit
10175 compare and test instructions before use of condition codes.
10176
10177 @item -mno-side-effects
10178 @opindex mno-side-effects
10179 Do not emit instructions with side-effects in addressing modes other than
10180 post-increment.
10181
10182 @item -mstack-align
10183 @itemx -mno-stack-align
10184 @itemx -mdata-align
10185 @itemx -mno-data-align
10186 @itemx -mconst-align
10187 @itemx -mno-const-align
10188 @opindex mstack-align
10189 @opindex mno-stack-align
10190 @opindex mdata-align
10191 @opindex mno-data-align
10192 @opindex mconst-align
10193 @opindex mno-const-align
10194 These options (no-options) arranges (eliminate arrangements) for the
10195 stack-frame, individual data and constants to be aligned for the maximum
10196 single data access size for the chosen CPU model.  The default is to
10197 arrange for 32-bit alignment.  ABI details such as structure layout are
10198 not affected by these options.
10199
10200 @item -m32-bit
10201 @itemx -m16-bit
10202 @itemx -m8-bit
10203 @opindex m32-bit
10204 @opindex m16-bit
10205 @opindex m8-bit
10206 Similar to the stack- data- and const-align options above, these options
10207 arrange for stack-frame, writable data and constants to all be 32-bit,
10208 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10209
10210 @item -mno-prologue-epilogue
10211 @itemx -mprologue-epilogue
10212 @opindex mno-prologue-epilogue
10213 @opindex mprologue-epilogue
10214 With @option{-mno-prologue-epilogue}, the normal function prologue and
10215 epilogue that sets up the stack-frame are omitted and no return
10216 instructions or return sequences are generated in the code.  Use this
10217 option only together with visual inspection of the compiled code: no
10218 warnings or errors are generated when call-saved registers must be saved,
10219 or storage for local variable needs to be allocated.
10220
10221 @item -mno-gotplt
10222 @itemx -mgotplt
10223 @opindex mno-gotplt
10224 @opindex mgotplt
10225 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10226 instruction sequences that load addresses for functions from the PLT part
10227 of the GOT rather than (traditional on other architectures) calls to the
10228 PLT.  The default is @option{-mgotplt}.
10229
10230 @item -maout
10231 @opindex maout
10232 Legacy no-op option only recognized with the cris-axis-aout target.
10233
10234 @item -melf
10235 @opindex melf
10236 Legacy no-op option only recognized with the cris-axis-elf and
10237 cris-axis-linux-gnu targets.
10238
10239 @item -melinux
10240 @opindex melinux
10241 Only recognized with the cris-axis-aout target, where it selects a
10242 GNU/linux-like multilib, include files and instruction set for
10243 @option{-march=v8}.
10244
10245 @item -mlinux
10246 @opindex mlinux
10247 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10248
10249 @item -sim
10250 @opindex sim
10251 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10252 to link with input-output functions from a simulator library.  Code,
10253 initialized data and zero-initialized data are allocated consecutively.
10254
10255 @item -sim2
10256 @opindex sim2
10257 Like @option{-sim}, but pass linker options to locate initialized data at
10258 0x40000000 and zero-initialized data at 0x80000000.
10259 @end table
10260
10261 @node MMIX Options
10262 @subsection MMIX Options
10263 @cindex MMIX Options
10264
10265 These options are defined for the MMIX:
10266
10267 @table @gcctabopt
10268 @item -mlibfuncs
10269 @itemx -mno-libfuncs
10270 @opindex mlibfuncs
10271 @opindex mno-libfuncs
10272 Specify that intrinsic library functions are being compiled, passing all
10273 values in registers, no matter the size.
10274
10275 @item -mepsilon
10276 @itemx -mno-epsilon
10277 @opindex mepsilon
10278 @opindex mno-epsilon
10279 Generate floating-point comparison instructions that compare with respect
10280 to the @code{rE} epsilon register.
10281
10282 @item -mabi=mmixware
10283 @itemx -mabi=gnu
10284 @opindex mabi-mmixware
10285 @opindex mabi=gnu
10286 Generate code that passes function parameters and return values that (in
10287 the called function) are seen as registers @code{$0} and up, as opposed to
10288 the GNU ABI which uses global registers @code{$231} and up.
10289
10290 @item -mzero-extend
10291 @itemx -mno-zero-extend
10292 @opindex mzero-extend
10293 @opindex mno-zero-extend
10294 When reading data from memory in sizes shorter than 64 bits, use (do not
10295 use) zero-extending load instructions by default, rather than
10296 sign-extending ones.
10297
10298 @item -mknuthdiv
10299 @itemx -mno-knuthdiv
10300 @opindex mknuthdiv
10301 @opindex mno-knuthdiv
10302 Make the result of a division yielding a remainder have the same sign as
10303 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10304 remainder follows the sign of the dividend.  Both methods are
10305 arithmetically valid, the latter being almost exclusively used.
10306
10307 @item -mtoplevel-symbols
10308 @itemx -mno-toplevel-symbols
10309 @opindex mtoplevel-symbols
10310 @opindex mno-toplevel-symbols
10311 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10312 code can be used with the @code{PREFIX} assembly directive.
10313
10314 @item -melf
10315 @opindex melf
10316 Generate an executable in the ELF format, rather than the default
10317 @samp{mmo} format used by the @command{mmix} simulator.
10318
10319 @item -mbranch-predict
10320 @itemx -mno-branch-predict
10321 @opindex mbranch-predict
10322 @opindex mno-branch-predict
10323 Use (do not use) the probable-branch instructions, when static branch
10324 prediction indicates a probable branch.
10325
10326 @item -mbase-addresses
10327 @itemx -mno-base-addresses
10328 @opindex mbase-addresses
10329 @opindex mno-base-addresses
10330 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10331 base address automatically generates a request (handled by the assembler
10332 and the linker) for a constant to be set up in a global register.  The
10333 register is used for one or more base address requests within the range 0
10334 to 255 from the value held in the register.  The generally leads to short
10335 and fast code, but the number of different data items that can be
10336 addressed is limited.  This means that a program that uses lots of static
10337 data may require @option{-mno-base-addresses}.
10338
10339 @item -msingle-exit
10340 @itemx -mno-single-exit
10341 @opindex msingle-exit
10342 @opindex mno-single-exit
10343 Force (do not force) generated code to have a single exit point in each
10344 function.
10345 @end table
10346
10347 @node PDP-11 Options
10348 @subsection PDP-11 Options
10349 @cindex PDP-11 Options
10350
10351 These options are defined for the PDP-11:
10352
10353 @table @gcctabopt
10354 @item -mfpu
10355 @opindex mfpu
10356 Use hardware FPP floating point.  This is the default.  (FIS floating
10357 point on the PDP-11/40 is not supported.)
10358
10359 @item -msoft-float
10360 @opindex msoft-float
10361 Do not use hardware floating point.
10362
10363 @item -mac0
10364 @opindex mac0
10365 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10366
10367 @item -mno-ac0
10368 @opindex mno-ac0
10369 Return floating-point results in memory.  This is the default.
10370
10371 @item -m40
10372 @opindex m40
10373 Generate code for a PDP-11/40.
10374
10375 @item -m45
10376 @opindex m45
10377 Generate code for a PDP-11/45.  This is the default.
10378
10379 @item -m10
10380 @opindex m10
10381 Generate code for a PDP-11/10.
10382
10383 @item -mbcopy-builtin
10384 @opindex bcopy-builtin
10385 Use inline @code{movstrhi} patterns for copying memory.  This is the
10386 default.
10387
10388 @item -mbcopy
10389 @opindex mbcopy
10390 Do not use inline @code{movstrhi} patterns for copying memory.
10391
10392 @item -mint16
10393 @itemx -mno-int32
10394 @opindex mint16
10395 @opindex mno-int32
10396 Use 16-bit @code{int}.  This is the default.
10397
10398 @item -mint32
10399 @itemx -mno-int16
10400 @opindex mint32
10401 @opindex mno-int16
10402 Use 32-bit @code{int}.
10403
10404 @item -mfloat64
10405 @itemx -mno-float32
10406 @opindex mfloat64
10407 @opindex mno-float32
10408 Use 64-bit @code{float}.  This is the default.
10409
10410 @item -mfloat32
10411 @itemx -mno-float64
10412 @opindex mfloat32
10413 @opindex mno-float64
10414 Use 32-bit @code{float}.
10415
10416 @item -mabshi
10417 @opindex mabshi
10418 Use @code{abshi2} pattern.  This is the default.
10419
10420 @item -mno-abshi
10421 @opindex mno-abshi
10422 Do not use @code{abshi2} pattern.
10423
10424 @item -mbranch-expensive
10425 @opindex mbranch-expensive
10426 Pretend that branches are expensive.  This is for experimenting with
10427 code generation only.
10428
10429 @item -mbranch-cheap
10430 @opindex mbranch-cheap
10431 Do not pretend that branches are expensive.  This is the default.
10432
10433 @item -msplit
10434 @opindex msplit
10435 Generate code for a system with split I&D.
10436
10437 @item -mno-split
10438 @opindex mno-split
10439 Generate code for a system without split I&D.  This is the default.
10440
10441 @item -munix-asm
10442 @opindex munix-asm
10443 Use Unix assembler syntax.  This is the default when configured for
10444 @samp{pdp11-*-bsd}.
10445
10446 @item -mdec-asm
10447 @opindex mdec-asm
10448 Use DEC assembler syntax.  This is the default when configured for any
10449 PDP-11 target other than @samp{pdp11-*-bsd}.
10450 @end table
10451
10452 @node Xstormy16 Options
10453 @subsection Xstormy16 Options
10454 @cindex Xstormy16 Options
10455
10456 These options are defined for Xstormy16:
10457
10458 @table @gcctabopt
10459 @item -msim
10460 @opindex msim
10461 Choose startup files and linker script suitable for the simulator.
10462 @end table
10463
10464 @node FRV Options
10465 @subsection FRV Options
10466 @cindex FRV Options
10467
10468 @table @gcctabopt
10469 @item -mgpr-32
10470 @opindex mgpr-32
10471
10472 Only use the first 32 general purpose registers.
10473
10474 @item -mgpr-64
10475 @opindex mgpr-64
10476
10477 Use all 64 general purpose registers.
10478
10479 @item -mfpr-32
10480 @opindex mfpr-32
10481
10482 Use only the first 32 floating point registers.
10483
10484 @item -mfpr-64
10485 @opindex mfpr-64
10486
10487 Use all 64 floating point registers
10488
10489 @item -mhard-float
10490 @opindex mhard-float
10491
10492 Use hardware instructions for floating point operations.
10493
10494 @item -msoft-float
10495 @opindex msoft-float
10496
10497 Use library routines for floating point operations.
10498
10499 @item -malloc-cc
10500 @opindex malloc-cc
10501
10502 Dynamically allocate condition code registers.
10503
10504 @item -mfixed-cc
10505 @opindex mfixed-cc
10506
10507 Do not try to dynamically allocate condition code registers, only
10508 use @code{icc0} and @code{fcc0}.
10509
10510 @item -mdword
10511 @opindex mdword
10512
10513 Change ABI to use double word insns.
10514
10515 @item -mno-dword
10516 @opindex mno-dword
10517
10518 Do not use double word instructions.
10519
10520 @item -mdouble
10521 @opindex mdouble
10522
10523 Use floating point double instructions.
10524
10525 @item -mno-double
10526 @opindex mno-double
10527
10528 Do not use floating point double instructions.
10529
10530 @item -mmedia
10531 @opindex mmedia
10532
10533 Use media instructions.
10534
10535 @item -mno-media
10536 @opindex mno-media
10537
10538 Do not use media instructions.
10539
10540 @item -mmuladd
10541 @opindex mmuladd
10542
10543 Use multiply and add/subtract instructions.
10544
10545 @item -mno-muladd
10546 @opindex mno-muladd
10547
10548 Do not use multiply and add/subtract instructions.
10549
10550 @item -mlibrary-pic
10551 @opindex mlibrary-pic
10552
10553 Enable PIC support for building libraries
10554
10555 @item -macc-4
10556 @opindex macc-4
10557
10558 Use only the first four media accumulator registers.
10559
10560 @item -macc-8
10561 @opindex macc-8
10562
10563 Use all eight media accumulator registers.
10564
10565 @item -mpack
10566 @opindex mpack
10567
10568 Pack VLIW instructions.
10569
10570 @item -mno-pack
10571 @opindex mno-pack
10572
10573 Do not pack VLIW instructions.
10574
10575 @item -mno-eflags
10576 @opindex mno-eflags
10577
10578 Do not mark ABI switches in e_flags.
10579
10580 @item -mcond-move
10581 @opindex mcond-move
10582
10583 Enable the use of conditional-move instructions (default).
10584
10585 This switch is mainly for debugging the compiler and will likely be removed
10586 in a future version.
10587
10588 @item -mno-cond-move
10589 @opindex mno-cond-move
10590
10591 Disable the use of conditional-move instructions.
10592
10593 This switch is mainly for debugging the compiler and will likely be removed
10594 in a future version.
10595
10596 @item -mscc
10597 @opindex mscc
10598
10599 Enable the use of conditional set instructions (default).
10600
10601 This switch is mainly for debugging the compiler and will likely be removed
10602 in a future version.
10603
10604 @item -mno-scc
10605 @opindex mno-scc
10606
10607 Disable the use of conditional set instructions.
10608
10609 This switch is mainly for debugging the compiler and will likely be removed
10610 in a future version.
10611
10612 @item -mcond-exec
10613 @opindex mcond-exec
10614
10615 Enable the use of conditional execution (default).
10616
10617 This switch is mainly for debugging the compiler and will likely be removed
10618 in a future version.
10619
10620 @item -mno-cond-exec
10621 @opindex mno-cond-exec
10622
10623 Disable the use of conditional execution.
10624
10625 This switch is mainly for debugging the compiler and will likely be removed
10626 in a future version.
10627
10628 @item -mvliw-branch
10629 @opindex mvliw-branch
10630
10631 Run a pass to pack branches into VLIW instructions (default).
10632
10633 This switch is mainly for debugging the compiler and will likely be removed
10634 in a future version.
10635
10636 @item -mno-vliw-branch
10637 @opindex mno-vliw-branch
10638
10639 Do not run a pass to pack branches into VLIW instructions.
10640
10641 This switch is mainly for debugging the compiler and will likely be removed
10642 in a future version.
10643
10644 @item -mmulti-cond-exec
10645 @opindex mmulti-cond-exec
10646
10647 Enable optimization of @code{&&} and @code{||} in conditional execution
10648 (default).
10649
10650 This switch is mainly for debugging the compiler and will likely be removed
10651 in a future version.
10652
10653 @item -mno-multi-cond-exec
10654 @opindex mno-multi-cond-exec
10655
10656 Disable optimization of @code{&&} and @code{||} in conditional execution.
10657
10658 This switch is mainly for debugging the compiler and will likely be removed
10659 in a future version.
10660
10661 @item -mnested-cond-exec
10662 @opindex mnested-cond-exec
10663
10664 Enable nested conditional execution optimizations (default).
10665
10666 This switch is mainly for debugging the compiler and will likely be removed
10667 in a future version.
10668
10669 @item -mno-nested-cond-exec
10670 @opindex mno-nested-cond-exec
10671
10672 Disable nested conditional execution optimizations.
10673
10674 This switch is mainly for debugging the compiler and will likely be removed
10675 in a future version.
10676
10677 @item -mtomcat-stats
10678 @opindex mtomcat-stats
10679
10680 Cause gas to print out tomcat statistics.
10681
10682 @item -mcpu=@var{cpu}
10683 @opindex mcpu
10684
10685 Select the processor type for which to generate code.  Possible values are
10686 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10687 @samp{frv}.
10688
10689 @end table
10690
10691 @node Xtensa Options
10692 @subsection Xtensa Options
10693 @cindex Xtensa Options
10694
10695 These options are supported for Xtensa targets:
10696
10697 @table @gcctabopt
10698 @item -mconst16
10699 @itemx -mno-const16
10700 @opindex mconst16
10701 @opindex mno-const16
10702 Enable or disable use of @code{CONST16} instructions for loading
10703 constant values.  The @code{CONST16} instruction is currently not a
10704 standard option from Tensilica.  When enabled, @code{CONST16}
10705 instructions are always used in place of the standard @code{L32R}
10706 instructions.  The use of @code{CONST16} is enabled by default only if
10707 the @code{L32R} instruction is not available.
10708
10709 @item -mfused-madd
10710 @itemx -mno-fused-madd
10711 @opindex mfused-madd
10712 @opindex mno-fused-madd
10713 Enable or disable use of fused multiply/add and multiply/subtract
10714 instructions in the floating-point option.  This has no effect if the
10715 floating-point option is not also enabled.  Disabling fused multiply/add
10716 and multiply/subtract instructions forces the compiler to use separate
10717 instructions for the multiply and add/subtract operations.  This may be
10718 desirable in some cases where strict IEEE 754-compliant results are
10719 required: the fused multiply add/subtract instructions do not round the
10720 intermediate result, thereby producing results with @emph{more} bits of
10721 precision than specified by the IEEE standard.  Disabling fused multiply
10722 add/subtract instructions also ensures that the program output is not
10723 sensitive to the compiler's ability to combine multiply and add/subtract
10724 operations.
10725
10726 @item -mtext-section-literals
10727 @itemx -mno-text-section-literals
10728 @opindex mtext-section-literals
10729 @opindex mno-text-section-literals
10730 Control the treatment of literal pools.  The default is
10731 @option{-mno-text-section-literals}, which places literals in a separate
10732 section in the output file.  This allows the literal pool to be placed
10733 in a data RAM/ROM, and it also allows the linker to combine literal
10734 pools from separate object files to remove redundant literals and
10735 improve code size.  With @option{-mtext-section-literals}, the literals
10736 are interspersed in the text section in order to keep them as close as
10737 possible to their references.  This may be necessary for large assembly
10738 files.
10739
10740 @item -mtarget-align
10741 @itemx -mno-target-align
10742 @opindex mtarget-align
10743 @opindex mno-target-align
10744 When this option is enabled, GCC instructs the assembler to
10745 automatically align instructions to reduce branch penalties at the
10746 expense of some code density.  The assembler attempts to widen density
10747 instructions to align branch targets and the instructions following call
10748 instructions.  If there are not enough preceding safe density
10749 instructions to align a target, no widening will be performed.  The
10750 default is @option{-mtarget-align}.  These options do not affect the
10751 treatment of auto-aligned instructions like @code{LOOP}, which the
10752 assembler will always align, either by widening density instructions or
10753 by inserting no-op instructions.
10754
10755 @item -mlongcalls
10756 @itemx -mno-longcalls
10757 @opindex mlongcalls
10758 @opindex mno-longcalls
10759 When this option is enabled, GCC instructs the assembler to translate
10760 direct calls to indirect calls unless it can determine that the target
10761 of a direct call is in the range allowed by the call instruction.  This
10762 translation typically occurs for calls to functions in other source
10763 files.  Specifically, the assembler translates a direct @code{CALL}
10764 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10765 The default is @option{-mno-longcalls}.  This option should be used in
10766 programs where the call target can potentially be out of range.  This
10767 option is implemented in the assembler, not the compiler, so the
10768 assembly code generated by GCC will still show direct call
10769 instructions---look at the disassembled object code to see the actual
10770 instructions.  Note that the assembler will use an indirect call for
10771 every cross-file call, not just those that really will be out of range.
10772 @end table
10773
10774 @node Code Gen Options
10775 @section Options for Code Generation Conventions
10776 @cindex code generation conventions
10777 @cindex options, code generation
10778 @cindex run-time options
10779
10780 These machine-independent options control the interface conventions
10781 used in code generation.
10782
10783 Most of them have both positive and negative forms; the negative form
10784 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10785 one of the forms is listed---the one which is not the default.  You
10786 can figure out the other form by either removing @samp{no-} or adding
10787 it.
10788
10789 @table @gcctabopt
10790 @item -fbounds-check
10791 @opindex fbounds-check
10792 For front-ends that support it, generate additional code to check that
10793 indices used to access arrays are within the declared range.  This is
10794 currently only supported by the Java and Fortran 77 front-ends, where
10795 this option defaults to true and false respectively.
10796
10797 @item -ftrapv
10798 @opindex ftrapv
10799 This option generates traps for signed overflow on addition, subtraction,
10800 multiplication operations.
10801
10802 @item -fwrapv
10803 @opindex fwrapv
10804 This option instructs the compiler to assume that signed arithmetic
10805 overflow of addition, subtraction and multiplication wraps around
10806 using twos-complement representation.  This flag enables some optimizations
10807 and disables other.  This option is enabled by default for the Java
10808 front-end, as required by the Java language specification.
10809
10810 @item -fexceptions
10811 @opindex fexceptions
10812 Enable exception handling.  Generates extra code needed to propagate
10813 exceptions.  For some targets, this implies GCC will generate frame
10814 unwind information for all functions, which can produce significant data
10815 size overhead, although it does not affect execution.  If you do not
10816 specify this option, GCC will enable it by default for languages like
10817 C++ which normally require exception handling, and disable it for
10818 languages like C that do not normally require it.  However, you may need
10819 to enable this option when compiling C code that needs to interoperate
10820 properly with exception handlers written in C++.  You may also wish to
10821 disable this option if you are compiling older C++ programs that don't
10822 use exception handling.
10823
10824 @item -fnon-call-exceptions
10825 @opindex fnon-call-exceptions
10826 Generate code that allows trapping instructions to throw exceptions.
10827 Note that this requires platform-specific runtime support that does
10828 not exist everywhere.  Moreover, it only allows @emph{trapping}
10829 instructions to throw exceptions, i.e.@: memory references or floating
10830 point instructions.  It does not allow exceptions to be thrown from
10831 arbitrary signal handlers such as @code{SIGALRM}.
10832
10833 @item -funwind-tables
10834 @opindex funwind-tables
10835 Similar to @option{-fexceptions}, except that it will just generate any needed
10836 static data, but will not affect the generated code in any other way.
10837 You will normally not enable this option; instead, a language processor
10838 that needs this handling would enable it on your behalf.
10839
10840 @item -fasynchronous-unwind-tables
10841 @opindex funwind-tables
10842 Generate unwind table in dwarf2 format, if supported by target machine.  The
10843 table is exact at each instruction boundary, so it can be used for stack
10844 unwinding from asynchronous events (such as debugger or garbage collector).
10845
10846 @item -fpcc-struct-return
10847 @opindex fpcc-struct-return
10848 Return ``short'' @code{struct} and @code{union} values in memory like
10849 longer ones, rather than in registers.  This convention is less
10850 efficient, but it has the advantage of allowing intercallability between
10851 GCC-compiled files and files compiled with other compilers, particularly
10852 the Portable C Compiler (pcc).
10853
10854 The precise convention for returning structures in memory depends
10855 on the target configuration macros.
10856
10857 Short structures and unions are those whose size and alignment match
10858 that of some integer type.
10859
10860 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10861 switch is not binary compatible with code compiled with the
10862 @option{-freg-struct-return} switch.
10863 Use it to conform to a non-default application binary interface.
10864
10865 @item -freg-struct-return
10866 @opindex freg-struct-return
10867 Return @code{struct} and @code{union} values in registers when possible.
10868 This is more efficient for small structures than
10869 @option{-fpcc-struct-return}.
10870
10871 If you specify neither @option{-fpcc-struct-return} nor
10872 @option{-freg-struct-return}, GCC defaults to whichever convention is
10873 standard for the target.  If there is no standard convention, GCC
10874 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10875 the principal compiler.  In those cases, we can choose the standard, and
10876 we chose the more efficient register return alternative.
10877
10878 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10879 switch is not binary compatible with code compiled with the
10880 @option{-fpcc-struct-return} switch.
10881 Use it to conform to a non-default application binary interface.
10882
10883 @item -fshort-enums
10884 @opindex fshort-enums
10885 Allocate to an @code{enum} type only as many bytes as it needs for the
10886 declared range of possible values.  Specifically, the @code{enum} type
10887 will be equivalent to the smallest integer type which has enough room.
10888
10889 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10890 code that is not binary compatible with code generated without that switch.
10891 Use it to conform to a non-default application binary interface.
10892
10893 @item -fshort-double
10894 @opindex fshort-double
10895 Use the same size for @code{double} as for @code{float}.
10896
10897 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10898 code that is not binary compatible with code generated without that switch.
10899 Use it to conform to a non-default application binary interface.
10900
10901 @item -fshort-wchar
10902 @opindex fshort-wchar
10903 Override the underlying type for @samp{wchar_t} to be @samp{short
10904 unsigned int} instead of the default for the target.  This option is
10905 useful for building programs to run under WINE@.
10906
10907 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10908 code that is not binary compatible with code generated without that switch.
10909 Use it to conform to a non-default application binary interface.
10910
10911 @item -fshared-data
10912 @opindex fshared-data
10913 Requests that the data and non-@code{const} variables of this
10914 compilation be shared data rather than private data.  The distinction
10915 makes sense only on certain operating systems, where shared data is
10916 shared between processes running the same program, while private data
10917 exists in one copy per process.
10918
10919 @item -fno-common
10920 @opindex fno-common
10921 In C, allocate even uninitialized global variables in the data section of the
10922 object file, rather than generating them as common blocks.  This has the
10923 effect that if the same variable is declared (without @code{extern}) in
10924 two different compilations, you will get an error when you link them.
10925 The only reason this might be useful is if you wish to verify that the
10926 program will work on other systems which always work this way.
10927
10928 @item -fno-ident
10929 @opindex fno-ident
10930 Ignore the @samp{#ident} directive.
10931
10932 @item -finhibit-size-directive
10933 @opindex finhibit-size-directive
10934 Don't output a @code{.size} assembler directive, or anything else that
10935 would cause trouble if the function is split in the middle, and the
10936 two halves are placed at locations far apart in memory.  This option is
10937 used when compiling @file{crtstuff.c}; you should not need to use it
10938 for anything else.
10939
10940 @item -fverbose-asm
10941 @opindex fverbose-asm
10942 Put extra commentary information in the generated assembly code to
10943 make it more readable.  This option is generally only of use to those
10944 who actually need to read the generated assembly code (perhaps while
10945 debugging the compiler itself).
10946
10947 @option{-fno-verbose-asm}, the default, causes the
10948 extra information to be omitted and is useful when comparing two assembler
10949 files.
10950
10951 @item -fpic
10952 @opindex fpic
10953 @cindex global offset table
10954 @cindex PIC
10955 Generate position-independent code (PIC) suitable for use in a shared
10956 library, if supported for the target machine.  Such code accesses all
10957 constant addresses through a global offset table (GOT)@.  The dynamic
10958 loader resolves the GOT entries when the program starts (the dynamic
10959 loader is not part of GCC; it is part of the operating system).  If
10960 the GOT size for the linked executable exceeds a machine-specific
10961 maximum size, you get an error message from the linker indicating that
10962 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10963 instead.  (These maximums are 8k on the SPARC and 32k
10964 on the m68k and RS/6000.  The 386 has no such limit.)
10965
10966 Position-independent code requires special support, and therefore works
10967 only on certain machines.  For the 386, GCC supports PIC for System V
10968 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10969 position-independent.
10970
10971 @item -fPIC
10972 @opindex fPIC
10973 If supported for the target machine, emit position-independent code,
10974 suitable for dynamic linking and avoiding any limit on the size of the
10975 global offset table.  This option makes a difference on the m68k
10976 and the SPARC.
10977
10978 Position-independent code requires special support, and therefore works
10979 only on certain machines.
10980
10981 @item -fpie
10982 @itemx -fPIE
10983 @opindex fpie
10984 @opindex fPIE
10985 These options are similar to @option{-fpic} and @option{-fPIC}, but
10986 generated position independent code can be only linked into executables.
10987 Usually these options are used when @option{-pie} GCC option will be
10988 used during linking.
10989
10990 @item -ffixed-@var{reg}
10991 @opindex ffixed
10992 Treat the register named @var{reg} as a fixed register; generated code
10993 should never refer to it (except perhaps as a stack pointer, frame
10994 pointer or in some other fixed role).
10995
10996 @var{reg} must be the name of a register.  The register names accepted
10997 are machine-specific and are defined in the @code{REGISTER_NAMES}
10998 macro in the machine description macro file.
10999
11000 This flag does not have a negative form, because it specifies a
11001 three-way choice.
11002
11003 @item -fcall-used-@var{reg}
11004 @opindex fcall-used
11005 Treat the register named @var{reg} as an allocable register that is
11006 clobbered by function calls.  It may be allocated for temporaries or
11007 variables that do not live across a call.  Functions compiled this way
11008 will not save and restore the register @var{reg}.
11009
11010 It is an error to used this flag with the frame pointer or stack pointer.
11011 Use of this flag for other registers that have fixed pervasive roles in
11012 the machine's execution model will produce disastrous results.
11013
11014 This flag does not have a negative form, because it specifies a
11015 three-way choice.
11016
11017 @item -fcall-saved-@var{reg}
11018 @opindex fcall-saved
11019 Treat the register named @var{reg} as an allocable register saved by
11020 functions.  It may be allocated even for temporaries or variables that
11021 live across a call.  Functions compiled this way will save and restore
11022 the register @var{reg} if they use it.
11023
11024 It is an error to used this flag with the frame pointer or stack pointer.
11025 Use of this flag for other registers that have fixed pervasive roles in
11026 the machine's execution model will produce disastrous results.
11027
11028 A different sort of disaster will result from the use of this flag for
11029 a register in which function values may be returned.
11030
11031 This flag does not have a negative form, because it specifies a
11032 three-way choice.
11033
11034 @item -fpack-struct
11035 @opindex fpack-struct
11036 Pack all structure members together without holes.
11037
11038 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11039 code that is not binary compatible with code generated without that switch.
11040 Additionally, it makes the code suboptimal.
11041 Use it to conform to a non-default application binary interface.
11042
11043 @item -finstrument-functions
11044 @opindex finstrument-functions
11045 Generate instrumentation calls for entry and exit to functions.  Just
11046 after function entry and just before function exit, the following
11047 profiling functions will be called with the address of the current
11048 function and its call site.  (On some platforms,
11049 @code{__builtin_return_address} does not work beyond the current
11050 function, so the call site information may not be available to the
11051 profiling functions otherwise.)
11052
11053 @example
11054 void __cyg_profile_func_enter (void *this_fn,
11055                                void *call_site);
11056 void __cyg_profile_func_exit  (void *this_fn,
11057                                void *call_site);
11058 @end example
11059
11060 The first argument is the address of the start of the current function,
11061 which may be looked up exactly in the symbol table.
11062
11063 This instrumentation is also done for functions expanded inline in other
11064 functions.  The profiling calls will indicate where, conceptually, the
11065 inline function is entered and exited.  This means that addressable
11066 versions of such functions must be available.  If all your uses of a
11067 function are expanded inline, this may mean an additional expansion of
11068 code size.  If you use @samp{extern inline} in your C code, an
11069 addressable version of such functions must be provided.  (This is
11070 normally the case anyways, but if you get lucky and the optimizer always
11071 expands the functions inline, you might have gotten away without
11072 providing static copies.)
11073
11074 A function may be given the attribute @code{no_instrument_function}, in
11075 which case this instrumentation will not be done.  This can be used, for
11076 example, for the profiling functions listed above, high-priority
11077 interrupt routines, and any functions from which the profiling functions
11078 cannot safely be called (perhaps signal handlers, if the profiling
11079 routines generate output or allocate memory).
11080
11081 @item -fstack-check
11082 @opindex fstack-check
11083 Generate code to verify that you do not go beyond the boundary of the
11084 stack.  You should specify this flag if you are running in an
11085 environment with multiple threads, but only rarely need to specify it in
11086 a single-threaded environment since stack overflow is automatically
11087 detected on nearly all systems if there is only one stack.
11088
11089 Note that this switch does not actually cause checking to be done; the
11090 operating system must do that.  The switch causes generation of code
11091 to ensure that the operating system sees the stack being extended.
11092
11093 @item -fstack-limit-register=@var{reg}
11094 @itemx -fstack-limit-symbol=@var{sym}
11095 @itemx -fno-stack-limit
11096 @opindex fstack-limit-register
11097 @opindex fstack-limit-symbol
11098 @opindex fno-stack-limit
11099 Generate code to ensure that the stack does not grow beyond a certain value,
11100 either the value of a register or the address of a symbol.  If the stack
11101 would grow beyond the value, a signal is raised.  For most targets,
11102 the signal is raised before the stack overruns the boundary, so
11103 it is possible to catch the signal without taking special precautions.
11104
11105 For instance, if the stack starts at absolute address @samp{0x80000000}
11106 and grows downwards, you can use the flags
11107 @option{-fstack-limit-symbol=__stack_limit} and
11108 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11109 of 128KB@.  Note that this may only work with the GNU linker.
11110
11111 @cindex aliasing of parameters
11112 @cindex parameters, aliased
11113 @item -fargument-alias
11114 @itemx -fargument-noalias
11115 @itemx -fargument-noalias-global
11116 @opindex fargument-alias
11117 @opindex fargument-noalias
11118 @opindex fargument-noalias-global
11119 Specify the possible relationships among parameters and between
11120 parameters and global data.
11121
11122 @option{-fargument-alias} specifies that arguments (parameters) may
11123 alias each other and may alias global storage.@*
11124 @option{-fargument-noalias} specifies that arguments do not alias
11125 each other, but may alias global storage.@*
11126 @option{-fargument-noalias-global} specifies that arguments do not
11127 alias each other and do not alias global storage.
11128
11129 Each language will automatically use whatever option is required by
11130 the language standard.  You should not need to use these options yourself.
11131
11132 @item -fleading-underscore
11133 @opindex fleading-underscore
11134 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11135 change the way C symbols are represented in the object file.  One use
11136 is to help link with legacy assembly code.
11137
11138 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11139 generate code that is not binary compatible with code generated without that
11140 switch.  Use it to conform to a non-default application binary interface.
11141 Not all targets provide complete support for this switch.
11142
11143 @item -ftls-model=@var{model}
11144 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11145 The @var{model} argument should be one of @code{global-dynamic},
11146 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11147
11148 The default without @option{-fpic} is @code{initial-exec}; with
11149 @option{-fpic} the default is @code{global-dynamic}.
11150 @end table
11151
11152 @c man end
11153
11154 @node Environment Variables
11155 @section Environment Variables Affecting GCC
11156 @cindex environment variables
11157
11158 @c man begin ENVIRONMENT
11159 This section describes several environment variables that affect how GCC
11160 operates.  Some of them work by specifying directories or prefixes to use
11161 when searching for various kinds of files.  Some are used to specify other
11162 aspects of the compilation environment.
11163
11164 Note that you can also specify places to search using options such as
11165 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11166 take precedence over places specified using environment variables, which
11167 in turn take precedence over those specified by the configuration of GCC@.
11168 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11169 GNU Compiler Collection (GCC) Internals}.
11170
11171 @table @env
11172 @item LANG
11173 @itemx LC_CTYPE
11174 @c @itemx LC_COLLATE
11175 @itemx LC_MESSAGES
11176 @c @itemx LC_MONETARY
11177 @c @itemx LC_NUMERIC
11178 @c @itemx LC_TIME
11179 @itemx LC_ALL
11180 @findex LANG
11181 @findex LC_CTYPE
11182 @c @findex LC_COLLATE
11183 @findex LC_MESSAGES
11184 @c @findex LC_MONETARY
11185 @c @findex LC_NUMERIC
11186 @c @findex LC_TIME
11187 @findex LC_ALL
11188 @cindex locale
11189 These environment variables control the way that GCC uses
11190 localization information that allow GCC to work with different
11191 national conventions.  GCC inspects the locale categories
11192 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11193 so.  These locale categories can be set to any value supported by your
11194 installation.  A typical value is @samp{en_UK} for English in the United
11195 Kingdom.
11196
11197 The @env{LC_CTYPE} environment variable specifies character
11198 classification.  GCC uses it to determine the character boundaries in
11199 a string; this is needed for some multibyte encodings that contain quote
11200 and escape characters that would otherwise be interpreted as a string
11201 end or escape.
11202
11203 The @env{LC_MESSAGES} environment variable specifies the language to
11204 use in diagnostic messages.
11205
11206 If the @env{LC_ALL} environment variable is set, it overrides the value
11207 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11208 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11209 environment variable.  If none of these variables are set, GCC
11210 defaults to traditional C English behavior.
11211
11212 @item TMPDIR
11213 @findex TMPDIR
11214 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11215 files.  GCC uses temporary files to hold the output of one stage of
11216 compilation which is to be used as input to the next stage: for example,
11217 the output of the preprocessor, which is the input to the compiler
11218 proper.
11219
11220 @item GCC_EXEC_PREFIX
11221 @findex GCC_EXEC_PREFIX
11222 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11223 names of the subprograms executed by the compiler.  No slash is added
11224 when this prefix is combined with the name of a subprogram, but you can
11225 specify a prefix that ends with a slash if you wish.
11226
11227 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11228 an appropriate prefix to use based on the pathname it was invoked with.
11229
11230 If GCC cannot find the subprogram using the specified prefix, it
11231 tries looking in the usual places for the subprogram.
11232
11233 The default value of @env{GCC_EXEC_PREFIX} is
11234 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11235 of @code{prefix} when you ran the @file{configure} script.
11236
11237 Other prefixes specified with @option{-B} take precedence over this prefix.
11238
11239 This prefix is also used for finding files such as @file{crt0.o} that are
11240 used for linking.
11241
11242 In addition, the prefix is used in an unusual way in finding the
11243 directories to search for header files.  For each of the standard
11244 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11245 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11246 replacing that beginning with the specified prefix to produce an
11247 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11248 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11249 These alternate directories are searched first; the standard directories
11250 come next.
11251
11252 @item COMPILER_PATH
11253 @findex COMPILER_PATH
11254 The value of @env{COMPILER_PATH} is a colon-separated list of
11255 directories, much like @env{PATH}.  GCC tries the directories thus
11256 specified when searching for subprograms, if it can't find the
11257 subprograms using @env{GCC_EXEC_PREFIX}.
11258
11259 @item LIBRARY_PATH
11260 @findex LIBRARY_PATH
11261 The value of @env{LIBRARY_PATH} is a colon-separated list of
11262 directories, much like @env{PATH}.  When configured as a native compiler,
11263 GCC tries the directories thus specified when searching for special
11264 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11265 using GCC also uses these directories when searching for ordinary
11266 libraries for the @option{-l} option (but directories specified with
11267 @option{-L} come first).
11268
11269 @item LANG
11270 @findex LANG
11271 @cindex locale definition
11272 This variable is used to pass locale information to the compiler.  One way in
11273 which this information is used is to determine the character set to be used
11274 when character literals, string literals and comments are parsed in C and C++.
11275 When the compiler is configured to allow multibyte characters,
11276 the following values for @env{LANG} are recognized:
11277
11278 @table @samp
11279 @item C-JIS
11280 Recognize JIS characters.
11281 @item C-SJIS
11282 Recognize SJIS characters.
11283 @item C-EUCJP
11284 Recognize EUCJP characters.
11285 @end table
11286
11287 If @env{LANG} is not defined, or if it has some other value, then the
11288 compiler will use mblen and mbtowc as defined by the default locale to
11289 recognize and translate multibyte characters.
11290 @end table
11291
11292 @noindent
11293 Some additional environments variables affect the behavior of the
11294 preprocessor.
11295
11296 @include cppenv.texi
11297
11298 @c man end
11299
11300 @node Precompiled Headers
11301 @section Using Precompiled Headers
11302 @cindex precompiled headers
11303 @cindex speed of compilation
11304
11305 Often large projects have many header files that are included in every
11306 source file.  The time the compiler takes to process these header files
11307 over and over again can account for nearly all of the time required to
11308 build the project.  To make builds faster, GCC allows users to
11309 `precompile' a header file; then, if builds can use the precompiled
11310 header file they will be much faster.
11311
11312 To create a precompiled header file, simply compile it as you would any
11313 other file, if necessary using the @option{-x} option to make the driver
11314 treat it as a C or C++ header file.  You will probably want to use a
11315 tool like @command{make} to keep the precompiled header up-to-date when
11316 the headers it contains change.
11317
11318 A precompiled header file will be searched for when @code{#include} is
11319 seen in the compilation.  As it searches for the included file
11320 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11321 compiler looks for a precompiled header in each directory just before it
11322 looks for the include file in that directory.  The name searched for is
11323 the name specified in the @code{#include} with @samp{.gch} appended.  If
11324 the precompiled header file can't be used, it is ignored.
11325
11326 For instance, if you have @code{#include "all.h"}, and you have
11327 @file{all.h.gch} in the same directory as @file{all.h}, then the
11328 precompiled header file will be used if possible, and the original
11329 header will be used otherwise.
11330
11331 Alternatively, you might decide to put the precompiled header file in a
11332 directory and use @option{-I} to ensure that directory is searched
11333 before (or instead of) the directory containing the original header.
11334 Then, if you want to check that the precompiled header file is always
11335 used, you can put a file of the same name as the original header in this
11336 directory containing an @code{#error} command.
11337
11338 This also works with @option{-include}.  So yet another way to use
11339 precompiled headers, good for projects not designed with precompiled
11340 header files in mind, is to simply take most of the header files used by
11341 a project, include them from another header file, precompile that header
11342 file, and @option{-include} the precompiled header.  If the header files
11343 have guards against multiple inclusion, they will be skipped because
11344 they've already been included (in the precompiled header).
11345
11346 If you need to precompile the same header file for different
11347 languages, targets, or compiler options, you can instead make a
11348 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11349 header in the directory.  (It doesn't matter what you call the files
11350 in the directory, every precompiled header in the directory will be
11351 considered.)  The first precompiled header encountered in the
11352 directory that is valid for this compilation will be used; they're
11353 searched in no particular order.
11354
11355 There are many other possibilities, limited only by your imagination,
11356 good sense, and the constraints of your build system.
11357
11358 A precompiled header file can be used only when these conditions apply:
11359
11360 @itemize
11361 @item
11362 Only one precompiled header can be used in a particular compilation.
11363 @item
11364 A precompiled header can't be used once the first C token is seen.  You
11365 can have preprocessor directives before a precompiled header; you can
11366 even include a precompiled header from inside another header, so long as
11367 there are no C tokens before the @code{#include}.
11368 @item
11369 The precompiled header file must be produced for the same language as
11370 the current compilation.  You can't use a C precompiled header for a C++
11371 compilation.
11372 @item
11373 The precompiled header file must be produced by the same compiler
11374 version and configuration as the current compilation is using.
11375 The easiest way to guarantee this is to use the same compiler binary
11376 for creating and using precompiled headers.
11377 @item
11378 Any macros defined before the precompiled header (including with
11379 @option{-D}) must either be defined in the same way as when the
11380 precompiled header was generated, or must not affect the precompiled
11381 header, which usually means that the they don't appear in the
11382 precompiled header at all.
11383 @item
11384 Certain command-line options must be defined in the same way as when the
11385 precompiled header was generated.  At present, it's not clear which
11386 options are safe to change and which are not; the safest choice is to
11387 use exactly the same options when generating and using the precompiled
11388 header.
11389 @end itemize
11390
11391 For all of these but the last, the compiler will automatically ignore
11392 the precompiled header if the conditions aren't met.  For the last item,
11393 some option changes will cause the precompiled header to be rejected,
11394 but not all incompatible option combinations have yet been found.  If
11395 you find a new incompatible combination, please consider filing a bug
11396 report, see @ref{Bugs}.
11397
11398 @node Running Protoize
11399 @section Running Protoize
11400
11401 The program @code{protoize} is an optional part of GCC@.  You can use
11402 it to add prototypes to a program, thus converting the program to ISO
11403 C in one respect.  The companion program @code{unprotoize} does the
11404 reverse: it removes argument types from any prototypes that are found.
11405
11406 When you run these programs, you must specify a set of source files as
11407 command line arguments.  The conversion programs start out by compiling
11408 these files to see what functions they define.  The information gathered
11409 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11410
11411 After scanning comes actual conversion.  The specified files are all
11412 eligible to be converted; any files they include (whether sources or
11413 just headers) are eligible as well.
11414
11415 But not all the eligible files are converted.  By default,
11416 @code{protoize} and @code{unprotoize} convert only source and header
11417 files in the current directory.  You can specify additional directories
11418 whose files should be converted with the @option{-d @var{directory}}
11419 option.  You can also specify particular files to exclude with the
11420 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11421 directory name matches one of the specified directory names, and its
11422 name within the directory has not been excluded.
11423
11424 Basic conversion with @code{protoize} consists of rewriting most
11425 function definitions and function declarations to specify the types of
11426 the arguments.  The only ones not rewritten are those for varargs
11427 functions.
11428
11429 @code{protoize} optionally inserts prototype declarations at the
11430 beginning of the source file, to make them available for any calls that
11431 precede the function's definition.  Or it can insert prototype
11432 declarations with block scope in the blocks where undeclared functions
11433 are called.
11434
11435 Basic conversion with @code{unprotoize} consists of rewriting most
11436 function declarations to remove any argument types, and rewriting
11437 function definitions to the old-style pre-ISO form.
11438
11439 Both conversion programs print a warning for any function declaration or
11440 definition that they can't convert.  You can suppress these warnings
11441 with @option{-q}.
11442
11443 The output from @code{protoize} or @code{unprotoize} replaces the
11444 original source file.  The original file is renamed to a name ending
11445 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11446 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11447 for DOS) file already exists, then the source file is simply discarded.
11448
11449 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11450 scan the program and collect information about the functions it uses.
11451 So neither of these programs will work until GCC is installed.
11452
11453 Here is a table of the options you can use with @code{protoize} and
11454 @code{unprotoize}.  Each option works with both programs unless
11455 otherwise stated.
11456
11457 @table @code
11458 @item -B @var{directory}
11459 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11460 usual directory (normally @file{/usr/local/lib}).  This file contains
11461 prototype information about standard system functions.  This option
11462 applies only to @code{protoize}.
11463
11464 @item -c @var{compilation-options}
11465 Use @var{compilation-options} as the options when running @command{gcc} to
11466 produce the @samp{.X} files.  The special option @option{-aux-info} is
11467 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11468
11469 Note that the compilation options must be given as a single argument to
11470 @code{protoize} or @code{unprotoize}.  If you want to specify several
11471 @command{gcc} options, you must quote the entire set of compilation options
11472 to make them a single word in the shell.
11473
11474 There are certain @command{gcc} arguments that you cannot use, because they
11475 would produce the wrong kind of output.  These include @option{-g},
11476 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11477 the @var{compilation-options}, they are ignored.
11478
11479 @item -C
11480 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11481 systems) instead of @samp{.c}.  This is convenient if you are converting
11482 a C program to C++.  This option applies only to @code{protoize}.
11483
11484 @item -g
11485 Add explicit global declarations.  This means inserting explicit
11486 declarations at the beginning of each source file for each function
11487 that is called in the file and was not declared.  These declarations
11488 precede the first function definition that contains a call to an
11489 undeclared function.  This option applies only to @code{protoize}.
11490
11491 @item -i @var{string}
11492 Indent old-style parameter declarations with the string @var{string}.
11493 This option applies only to @code{protoize}.
11494
11495 @code{unprotoize} converts prototyped function definitions to old-style
11496 function definitions, where the arguments are declared between the
11497 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11498 uses five spaces as the indentation.  If you want to indent with just
11499 one space instead, use @option{-i " "}.
11500
11501 @item -k
11502 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11503 is finished.
11504
11505 @item -l
11506 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11507 a prototype declaration for each function in each block which calls the
11508 function without any declaration.  This option applies only to
11509 @code{protoize}.
11510
11511 @item -n
11512 Make no real changes.  This mode just prints information about the conversions
11513 that would have been done without @option{-n}.
11514
11515 @item -N
11516 Make no @samp{.save} files.  The original files are simply deleted.
11517 Use this option with caution.
11518
11519 @item -p @var{program}
11520 Use the program @var{program} as the compiler.  Normally, the name
11521 @file{gcc} is used.
11522
11523 @item -q
11524 Work quietly.  Most warnings are suppressed.
11525
11526 @item -v
11527 Print the version number, just like @option{-v} for @command{gcc}.
11528 @end table
11529
11530 If you need special compiler options to compile one of your program's
11531 source files, then you should generate that file's @samp{.X} file
11532 specially, by running @command{gcc} on that source file with the
11533 appropriate options and the option @option{-aux-info}.  Then run
11534 @code{protoize} on the entire set of files.  @code{protoize} will use
11535 the existing @samp{.X} file because it is newer than the source file.
11536 For example:
11537
11538 @example
11539 gcc -Dfoo=bar file1.c -aux-info file1.X
11540 protoize *.c
11541 @end example
11542
11543 @noindent
11544 You need to include the special files along with the rest in the
11545 @code{protoize} command, even though their @samp{.X} files already
11546 exist, because otherwise they won't get converted.
11547
11548 @xref{Protoize Caveats}, for more information on how to use
11549 @code{protoize} successfully.