Bring in a trimmed down gcc-3.4-20040618.
[dragonfly.git] / contrib / gcc-3.4 / 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  -mapp-regs  -mno-app-regs @gol
360 -mfaster-structs  -mno-faster-structs @gol
361 -mflat  -mno-flat  -mfpu  -mno-fpu @gol
362 -mhard-float  -msoft-float @gol
363 -mhard-quad-float  -msoft-quad-float @gol
364 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
365 -mstack-bias  -mno-stack-bias @gol
366 -munaligned-doubles  -mno-unaligned-doubles @gol
367 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
368 -mcypress  -mf930  -mf934 @gol
369 -msparclite  -msupersparc  -mv8}
370
371 @emph{ARM Options}
372 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
373 -mapcs-26  -mapcs-32 @gol
374 -mapcs-stack-check  -mno-apcs-stack-check @gol
375 -mapcs-float  -mno-apcs-float @gol
376 -mapcs-reentrant  -mno-apcs-reentrant @gol
377 -msched-prolog  -mno-sched-prolog @gol
378 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
379 -malignment-traps  -mno-alignment-traps @gol
380 -msoft-float  -mhard-float  -mfpe @gol
381 -mthumb-interwork  -mno-thumb-interwork @gol
382 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
383 -mstructure-size-boundary=@var{n} @gol
384 -mabort-on-noreturn @gol
385 -mlong-calls  -mno-long-calls @gol
386 -msingle-pic-base  -mno-single-pic-base @gol
387 -mpic-register=@var{reg} @gol
388 -mnop-fun-dllimport @gol
389 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
390 -mpoke-function-name @gol
391 -mthumb  -marm @gol
392 -mtpcs-frame  -mtpcs-leaf-frame @gol
393 -mcaller-super-interworking  -mcallee-super-interworking}
394
395 @emph{MN10300 Options}
396 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
397 -mam33  -mno-am33 @gol
398 -mam33-2  -mno-am33-2 @gol
399 -mno-crt0  -mrelax}
400
401 @emph{M32R/D Options}
402 @gccoptlist{-m32r2 -m32rx -m32r @gol
403 -mdebug @gol
404 -malign-loops -mno-align-loops @gol
405 -missue-rate=@var{number} @gol
406 -mbranch-cost=@var{number} @gol
407 -mmodel=@var{code-size-model-type} @gol
408 -msdata=@var{sdata-type} @gol
409 -mno-flush-func -mflush-func=@var{name} @gol
410 -mno-flush-trap -mflush-trap=@var{number} @gol
411 -G @var{num}}
412
413 @emph{RS/6000 and PowerPC Options}
414 @gccoptlist{-mcpu=@var{cpu-type} @gol
415 -mtune=@var{cpu-type} @gol
416 -mpower  -mno-power  -mpower2  -mno-power2 @gol
417 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
418 -maltivec  -mno-altivec @gol
419 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
420 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
421 -mnew-mnemonics  -mold-mnemonics @gol
422 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
423 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
424 -malign-power  -malign-natural @gol
425 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
426 -mstring  -mno-string  -mupdate  -mno-update @gol
427 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
428 -mstrict-align  -mno-strict-align  -mrelocatable @gol
429 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
430 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
431 -mdynamic-no-pic @gol
432 -mprioritize-restricted-insns=@var{priority} @gol
433 -msched-costly-dep=@var{dependence_type} @gol
434 -minsert-sched-nops=@var{scheme} @gol
435 -mcall-sysv  -mcall-netbsd @gol
436 -maix-struct-return  -msvr4-struct-return @gol
437 -mabi=altivec  -mabi=no-altivec @gol
438 -mabi=spe  -mabi=no-spe @gol
439 -misel=yes  -misel=no @gol
440 -mspe=yes  -mspe=no @gol
441 -mfloat-gprs=yes  -mfloat-gprs=no @gol
442 -mprototype  -mno-prototype @gol
443 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
444 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
445
446 @emph{Darwin Options}
447 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
448 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
449 -client_name  -compatibility_version  -current_version @gol
450 -dependency-file  -dylib_file  -dylinker_install_name @gol
451 -dynamic  -dynamiclib  -exported_symbols_list @gol
452 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
453 -force_flat_namespace  -headerpad_max_install_names @gol
454 -image_base  -init  -install_name  -keep_private_externs @gol
455 -multi_module  -multiply_defined  -multiply_defined_unused @gol
456 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
457 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
458 -private_bundle  -read_only_relocs  -sectalign @gol
459 -sectobjectsymbols  -whyload  -seg1addr @gol
460 -sectcreate  -sectobjectsymbols  -sectorder @gol
461 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
462 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
463 -single_module  -static  -sub_library  -sub_umbrella @gol
464 -twolevel_namespace  -umbrella  -undefined @gol
465 -unexported_symbols_list  -weak_reference_mismatches @gol
466 -whatsloaded}
467
468 @emph{MIPS Options}
469 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
470 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
471 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
472 -mxgot  -mno-xgot  -membedded-pic  -mno-embedded-pic @gol
473 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
474 -msingle-float  -mdouble-float  -mint64  -mlong64  -mlong32 @gol
475 -G@var{num}  -membedded-data  -mno-embedded-data @gol
476 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
477 -msplit-addresses  -mno-split-addresses  @gol
478 -mexplicit-relocs  -mno-explicit-relocs  @gol
479 -mrnames  -mno-rnames @gol
480 -mcheck-zero-division  -mno-check-zero-division @gol
481 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
482 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
483 -mfix-sb1  -mno-fix-sb1  -mflush-func=@var{func} @gol
484 -mno-flush-func  -mbranch-likely  -mno-branch-likely}
485
486 @emph{i386 and x86-64 Options}
487 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
488 -mfpmath=@var{unit} @gol
489 -masm=@var{dialect}  -mno-fancy-math-387 @gol
490 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
491 -mno-wide-multiply  -mrtd  -malign-double @gol
492 -mpreferred-stack-boundary=@var{num} @gol
493 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
494 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
495 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
496 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
497 -mno-red-zone -mno-tls-direct-seg-refs @gol
498 -mcmodel=@var{code-model} @gol
499 -m32  -m64}
500
501 @emph{HPPA Options}
502 @gccoptlist{-march=@var{architecture-type} @gol
503 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
504 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
505 -mjump-in-delay -mlinker-opt -mlong-calls @gol
506 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
507 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
508 -mno-jump-in-delay  -mno-long-load-store @gol
509 -mno-portable-runtime  -mno-soft-float @gol
510 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
511 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
512 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
513 -nolibdld  -static  -threads}
514
515 @emph{Intel 960 Options}
516 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
517 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
518 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
519 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
520 -mno-complex-addr  -mno-leaf-procedures @gol
521 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
522 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
523 -mtail-call}
524
525 @emph{DEC Alpha Options}
526 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
527 -mieee  -mieee-with-inexact  -mieee-conformant @gol
528 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
529 -mtrap-precision=@var{mode}  -mbuild-constants @gol
530 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
531 -mbwx  -mmax  -mfix  -mcix @gol
532 -mfloat-vax  -mfloat-ieee @gol
533 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
534 -msmall-text  -mlarge-text @gol
535 -mmemory-latency=@var{time}}
536
537 @emph{DEC Alpha/VMS Options}
538 @gccoptlist{-mvms-return-codes}
539
540 @emph{H8/300 Options}
541 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
542
543 @emph{SH Options}
544 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
545 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
546 -m5-64media  -m5-64media-nofpu @gol
547 -m5-32media  -m5-32media-nofpu @gol
548 -m5-compact  -m5-compact-nofpu @gol
549 -mb  -ml  -mdalign  -mrelax @gol
550 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
551 -mieee  -misize  -mpadstruct  -mspace @gol
552 -mprefergot  -musermode}
553
554 @emph{System V Options}
555 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
556
557 @emph{ARC Options}
558 @gccoptlist{-EB  -EL @gol
559 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
560 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
561
562 @emph{TMS320C3x/C4x Options}
563 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
564 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
565 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
566 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
567
568 @emph{V850 Options}
569 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
570 -mprolog-function  -mno-prolog-function  -mspace @gol
571 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
572 -mapp-regs  -mno-app-regs @gol
573 -mdisable-callt  -mno-disable-callt @gol
574 -mv850e1 @gol
575 -mv850e @gol
576 -mv850  -mbig-switch}
577
578 @emph{NS32K Options}
579 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
580 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
581 -mregparam  -mnoregparam  -msb  -mnosb @gol
582 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
583
584 @emph{AVR Options}
585 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
586 -mcall-prologues  -mno-tablejump  -mtiny-stack}
587
588 @emph{MCore Options}
589 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
590 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
591 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
592 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
593 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
594
595 @emph{MMIX Options}
596 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
597 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
598 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
599 -mno-base-addresses  -msingle-exit  -mno-single-exit}
600
601 @emph{IA-64 Options}
602 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
603 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
604 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
605 -minline-float-divide-max-throughput @gol
606 -minline-int-divide-min-latency @gol
607 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
608 -mfixed-range=@var{register-range}}
609
610 @emph{D30V Options}
611 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
612 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
613
614 @emph{S/390 and zSeries Options}
615 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
616 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
617 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
618 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
619
620 @emph{CRIS Options}
621 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
622 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
623 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
624 -mstack-align  -mdata-align  -mconst-align @gol
625 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
626 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
627 -mmul-bug-workaround  -mno-mul-bug-workaround}
628
629 @emph{PDP-11 Options}
630 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
631 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
632 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
633 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
634 -mbranch-expensive  -mbranch-cheap @gol
635 -msplit  -mno-split  -munix-asm  -mdec-asm}
636
637 @emph{Xstormy16 Options}
638 @gccoptlist{-msim}
639
640 @emph{Xtensa Options}
641 @gccoptlist{-mconst16 -mno-const16 @gol
642 -mfused-madd  -mno-fused-madd @gol
643 -mtext-section-literals  -mno-text-section-literals @gol
644 -mtarget-align  -mno-target-align @gol
645 -mlongcalls  -mno-longcalls}
646
647 @emph{FRV Options}
648 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
649 -mhard-float  -msoft-float @gol
650 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
651 -mdouble  -mno-double @gol
652 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
653 -mlibrary-pic  -macc-4 -macc-8 @gol
654 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
655 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
656 -mvliw-branch  -mno-vliw-branch @gol
657 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
658 -mno-nested-cond-exec  -mtomcat-stats @gol
659 -mcpu=@var{cpu}}
660
661 @item Code Generation Options
662 @xref{Code Gen Options,,Options for Code Generation Conventions}.
663 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
664 -ffixed-@var{reg}  -fexceptions @gol
665 -fnon-call-exceptions  -funwind-tables @gol
666 -fasynchronous-unwind-tables @gol
667 -finhibit-size-directive  -finstrument-functions @gol
668 -fno-common  -fno-ident @gol
669 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
670 -freg-struct-return  -fshared-data  -fshort-enums @gol
671 -fshort-double  -fshort-wchar @gol
672 -fverbose-asm  -fpack-struct  -fstack-check @gol
673 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
674 -fargument-alias  -fargument-noalias @gol
675 -fargument-noalias-global  -fleading-underscore @gol
676 -ftls-model=@var{model} @gol
677 -ftrapv  -fwrapv  -fbounds-check}
678 @end table
679
680 @menu
681 * Overall Options::     Controlling the kind of output:
682                         an executable, object files, assembler files,
683                         or preprocessed source.
684 * C Dialect Options::   Controlling the variant of C language compiled.
685 * C++ Dialect Options:: Variations on C++.
686 * Objective-C Dialect Options:: Variations on Objective-C.
687 * Language Independent Options:: Controlling how diagnostics should be
688                         formatted.
689 * Warning Options::     How picky should the compiler be?
690 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
691 * Optimize Options::    How much optimization?
692 * Preprocessor Options:: Controlling header files and macro definitions.
693                          Also, getting dependency information for Make.
694 * Assembler Options::   Passing options to the assembler.
695 * Link Options::        Specifying libraries and so on.
696 * Directory Options::   Where to find header files and libraries.
697                         Where to find the compiler executable files.
698 * Spec Files::          How to pass switches to sub-processes.
699 * Target Options::      Running a cross-compiler, or an old version of GCC.
700 @end menu
701
702 @node Overall Options
703 @section Options Controlling the Kind of Output
704
705 Compilation can involve up to four stages: preprocessing, compilation
706 proper, assembly and linking, always in that order.  GCC is capable of
707 preprocessing and compiling several files either into several
708 assembler input files, or into one assembler input file; then each
709 assembler input file produces an object file, and linking combines all
710 the object files (those newly compiled, and those specified as input)
711 into an executable file.
712
713 @cindex file name suffix
714 For any given input file, the file name suffix determines what kind of
715 compilation is done:
716
717 @table @gcctabopt
718 @item @var{file}.c
719 C source code which must be preprocessed.
720
721 @item @var{file}.i
722 C source code which should not be preprocessed.
723
724 @item @var{file}.ii
725 C++ source code which should not be preprocessed.
726
727 @item @var{file}.m
728 Objective-C source code.  Note that you must link with the library
729 @file{libobjc.a} to make an Objective-C program work.
730
731 @item @var{file}.mi
732 Objective-C source code which should not be preprocessed.
733
734 @item @var{file}.h
735 C or C++ header file to be turned into a precompiled header.
736
737 @item @var{file}.cc
738 @itemx @var{file}.cp
739 @itemx @var{file}.cxx
740 @itemx @var{file}.cpp
741 @itemx @var{file}.CPP
742 @itemx @var{file}.c++
743 @itemx @var{file}.C
744 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
745 the last two letters must both be literally @samp{x}.  Likewise,
746 @samp{.C} refers to a literal capital C@.
747
748 @item @var{file}.hh
749 @itemx @var{file}.H
750 C++ header file to be turned into a precompiled header.
751
752 @item @var{file}.f
753 @itemx @var{file}.for
754 @itemx @var{file}.FOR
755 Fortran source code which should not be preprocessed.
756
757 @item @var{file}.F
758 @itemx @var{file}.fpp
759 @itemx @var{file}.FPP
760 Fortran source code which must be preprocessed (with the traditional
761 preprocessor).
762
763 @item @var{file}.r
764 Fortran source code which must be preprocessed with a RATFOR
765 preprocessor (not included with GCC)@.
766
767 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
768 Using and Porting GNU Fortran}, for more details of the handling of
769 Fortran input files.
770
771 @c FIXME: Descriptions of Java file types.
772 @c @var{file}.java
773 @c @var{file}.class
774 @c @var{file}.zip
775 @c @var{file}.jar
776
777 @item @var{file}.ads
778 Ada source code file which contains a library unit declaration (a
779 declaration of a package, subprogram, or generic, or a generic
780 instantiation), or a library unit renaming declaration (a package,
781 generic, or subprogram renaming declaration).  Such files are also
782 called @dfn{specs}.
783
784 @itemx @var{file}.adb
785 Ada source code file containing a library unit body (a subprogram or
786 package body).  Such files are also called @dfn{bodies}.
787
788 @c GCC also knows about some suffixes for languages not yet included:
789 @c Pascal:
790 @c @var{file}.p
791 @c @var{file}.pas
792
793 @item @var{file}.s
794 Assembler code.
795
796 @item @var{file}.S
797 Assembler code which must be preprocessed.
798
799 @item @var{other}
800 An object file to be fed straight into linking.
801 Any file name with no recognized suffix is treated this way.
802 @end table
803
804 @opindex x
805 You can specify the input language explicitly with the @option{-x} option:
806
807 @table @gcctabopt
808 @item -x @var{language}
809 Specify explicitly the @var{language} for the following input files
810 (rather than letting the compiler choose a default based on the file
811 name suffix).  This option applies to all following input files until
812 the next @option{-x} option.  Possible values for @var{language} are:
813 @smallexample
814 c  c-header  cpp-output
815 c++  c++-header  c++-cpp-output
816 objective-c  objective-c-header  objc-cpp-output
817 assembler  assembler-with-cpp
818 ada
819 f77  f77-cpp-input  ratfor
820 java
821 treelang
822 @end smallexample
823
824 @item -x none
825 Turn off any specification of a language, so that subsequent files are
826 handled according to their file name suffixes (as they are if @option{-x}
827 has not been used at all).
828
829 @item -pass-exit-codes
830 @opindex pass-exit-codes
831 Normally the @command{gcc} program will exit with the code of 1 if any
832 phase of the compiler returns a non-success return code.  If you specify
833 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
834 numerically highest error produced by any phase that returned an error
835 indication.
836 @end table
837
838 If you only want some of the stages of compilation, you can use
839 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
840 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
841 @command{gcc} is to stop.  Note that some combinations (for example,
842 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
843
844 @table @gcctabopt
845 @item -c
846 @opindex c
847 Compile or assemble the source files, but do not link.  The linking
848 stage simply is not done.  The ultimate output is in the form of an
849 object file for each source file.
850
851 By default, the object file name for a source file is made by replacing
852 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
853
854 Unrecognized input files, not requiring compilation or assembly, are
855 ignored.
856
857 @item -S
858 @opindex S
859 Stop after the stage of compilation proper; do not assemble.  The output
860 is in the form of an assembler code file for each non-assembler input
861 file specified.
862
863 By default, the assembler file name for a source file is made by
864 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
865
866 Input files that don't require compilation are ignored.
867
868 @item -E
869 @opindex E
870 Stop after the preprocessing stage; do not run the compiler proper.  The
871 output is in the form of preprocessed source code, which is sent to the
872 standard output.
873
874 Input files which don't require preprocessing are ignored.
875
876 @cindex output file option
877 @item -o @var{file}
878 @opindex o
879 Place output in file @var{file}.  This applies regardless to whatever
880 sort of output is being produced, whether it be an executable file,
881 an object file, an assembler file or preprocessed C code.
882
883 If you specify @option{-o} when compiling more than one input file, or
884 you are producing an executable file as output, all the source files
885 on the command line will be compiled at once.
886
887 If @option{-o} is not specified, the default is to put an executable file
888 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
889 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
890 all preprocessed C source on standard output.
891
892 @item -v
893 @opindex v
894 Print (on standard error output) the commands executed to run the stages
895 of compilation.  Also print the version number of the compiler driver
896 program and of the preprocessor and the compiler proper.
897
898 @item -###
899 @opindex ###
900 Like @option{-v} except the commands are not executed and all command
901 arguments are quoted.  This is useful for shell scripts to capture the
902 driver-generated command lines.
903
904 @item -pipe
905 @opindex pipe
906 Use pipes rather than temporary files for communication between the
907 various stages of compilation.  This fails to work on some systems where
908 the assembler is unable to read from a pipe; but the GNU assembler has
909 no trouble.
910
911 @item --help
912 @opindex help
913 Print (on the standard output) a description of the command line options
914 understood by @command{gcc}.  If the @option{-v} option is also specified
915 then @option{--help} will also be passed on to the various processes
916 invoked by @command{gcc}, so that they can display the command line options
917 they accept.  If the @option{-Wextra} option is also specified then command
918 line options which have no documentation associated with them will also
919 be displayed.
920
921 @item --target-help
922 @opindex target-help
923 Print (on the standard output) a description of target specific command
924 line options for each tool.
925
926 @item --version
927 @opindex version
928 Display the version number and copyrights of the invoked GCC.
929 @end table
930
931 @node Invoking G++
932 @section Compiling C++ Programs
933
934 @cindex suffixes for C++ source
935 @cindex C++ source file suffixes
936 C++ source files conventionally use one of the suffixes @samp{.C},
937 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
938 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
939 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
940 files with these names and compiles them as C++ programs even if you
941 call the compiler the same way as for compiling C programs (usually
942 with the name @command{gcc}).
943
944 @findex g++
945 @findex c++
946 However, C++ programs often require class libraries as well as a
947 compiler that understands the C++ language---and under some
948 circumstances, you might want to compile programs or header files from
949 standard input, or otherwise without a suffix that flags them as C++
950 programs.  You might also like to precompile a C header file with a
951 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
952 program that calls GCC with the default language set to C++, and
953 automatically specifies linking against the C++ library.  On many
954 systems, @command{g++} is also installed with the name @command{c++}.
955
956 @cindex invoking @command{g++}
957 When you compile C++ programs, you may specify many of the same
958 command-line options that you use for compiling programs in any
959 language; or command-line options meaningful for C and related
960 languages; or options that are meaningful only for C++ programs.
961 @xref{C Dialect Options,,Options Controlling C Dialect}, for
962 explanations of options for languages related to C@.
963 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
964 explanations of options that are meaningful only for C++ programs.
965
966 @node C Dialect Options
967 @section Options Controlling C Dialect
968 @cindex dialect options
969 @cindex language dialect options
970 @cindex options, dialect
971
972 The following options control the dialect of C (or languages derived
973 from C, such as C++ and Objective-C) that the compiler accepts:
974
975 @table @gcctabopt
976 @cindex ANSI support
977 @cindex ISO support
978 @item -ansi
979 @opindex ansi
980 In C mode, support all ISO C90 programs.  In C++ mode,
981 remove GNU extensions that conflict with ISO C++.
982
983 This turns off certain features of GCC that are incompatible with ISO
984 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
985 such as the @code{asm} and @code{typeof} keywords, and
986 predefined macros such as @code{unix} and @code{vax} that identify the
987 type of system you are using.  It also enables the undesirable and
988 rarely used ISO trigraph feature.  For the C compiler,
989 it disables recognition of C++ style @samp{//} comments as well as
990 the @code{inline} keyword.
991
992 The alternate keywords @code{__asm__}, @code{__extension__},
993 @code{__inline__} and @code{__typeof__} continue to work despite
994 @option{-ansi}.  You would not want to use them in an ISO C program, of
995 course, but it is useful to put them in header files that might be included
996 in compilations done with @option{-ansi}.  Alternate predefined macros
997 such as @code{__unix__} and @code{__vax__} are also available, with or
998 without @option{-ansi}.
999
1000 The @option{-ansi} option does not cause non-ISO programs to be
1001 rejected gratuitously.  For that, @option{-pedantic} is required in
1002 addition to @option{-ansi}.  @xref{Warning Options}.
1003
1004 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1005 option is used.  Some header files may notice this macro and refrain
1006 from declaring certain functions or defining certain macros that the
1007 ISO standard doesn't call for; this is to avoid interfering with any
1008 programs that might use these names for other things.
1009
1010 Functions which would normally be built in but do not have semantics
1011 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1012 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1013 built-in functions provided by GCC}, for details of the functions
1014 affected.
1015
1016 @item -std=
1017 @opindex std
1018 Determine the language standard.  This option is currently only
1019 supported when compiling C or C++.  A value for this option must be
1020 provided; possible values are
1021
1022 @table @samp
1023 @item c89
1024 @itemx iso9899:1990
1025 ISO C90 (same as @option{-ansi}).
1026
1027 @item iso9899:199409
1028 ISO C90 as modified in amendment 1.
1029
1030 @item c99
1031 @itemx c9x
1032 @itemx iso9899:1999
1033 @itemx iso9899:199x
1034 ISO C99.  Note that this standard is not yet fully supported; see
1035 @w{@uref{http://gcc.gnu.org/gcc-3.4/c99status.html}} for more information.  The
1036 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1037
1038 @item gnu89
1039 Default, ISO C90 plus GNU extensions (including some C99 features).
1040
1041 @item gnu99
1042 @itemx gnu9x
1043 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1044 this will become the default.  The name @samp{gnu9x} is deprecated.
1045
1046 @item c++98
1047 The 1998 ISO C++ standard plus amendments.
1048
1049 @item gnu++98
1050 The same as @option{-std=c++98} plus GNU extensions.  This is the
1051 default for C++ code.
1052 @end table
1053
1054 Even when this option is not specified, you can still use some of the
1055 features of newer standards in so far as they do not conflict with
1056 previous C standards.  For example, you may use @code{__restrict__} even
1057 when @option{-std=c99} is not specified.
1058
1059 The @option{-std} options specifying some version of ISO C have the same
1060 effects as @option{-ansi}, except that features that were not in ISO C90
1061 but are in the specified version (for example, @samp{//} comments and
1062 the @code{inline} keyword in ISO C99) are not disabled.
1063
1064 @xref{Standards,,Language Standards Supported by GCC}, for details of
1065 these standard versions.
1066
1067 @item -aux-info @var{filename}
1068 @opindex aux-info
1069 Output to the given filename prototyped declarations for all functions
1070 declared and/or defined in a translation unit, including those in header
1071 files.  This option is silently ignored in any language other than C@.
1072
1073 Besides declarations, the file indicates, in comments, the origin of
1074 each declaration (source file and line), whether the declaration was
1075 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1076 @samp{O} for old, respectively, in the first character after the line
1077 number and the colon), and whether it came from a declaration or a
1078 definition (@samp{C} or @samp{F}, respectively, in the following
1079 character).  In the case of function definitions, a K&R-style list of
1080 arguments followed by their declarations is also provided, inside
1081 comments, after the declaration.
1082
1083 @item -fno-asm
1084 @opindex fno-asm
1085 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1086 keyword, so that code can use these words as identifiers.  You can use
1087 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1088 instead.  @option{-ansi} implies @option{-fno-asm}.
1089
1090 In C++, this switch only affects the @code{typeof} keyword, since
1091 @code{asm} and @code{inline} are standard keywords.  You may want to
1092 use the @option{-fno-gnu-keywords} flag instead, which has the same
1093 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1094 switch only affects the @code{asm} and @code{typeof} keywords, since
1095 @code{inline} is a standard keyword in ISO C99.
1096
1097 @item -fno-builtin
1098 @itemx -fno-builtin-@var{function}
1099 @opindex fno-builtin
1100 @cindex built-in functions
1101 Don't recognize built-in functions that do not begin with
1102 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1103 functions provided by GCC}, for details of the functions affected,
1104 including those which are not built-in functions when @option{-ansi} or
1105 @option{-std} options for strict ISO C conformance are used because they
1106 do not have an ISO standard meaning.
1107
1108 GCC normally generates special code to handle certain built-in functions
1109 more efficiently; for instance, calls to @code{alloca} may become single
1110 instructions that adjust the stack directly, and calls to @code{memcpy}
1111 may become inline copy loops.  The resulting code is often both smaller
1112 and faster, but since the function calls no longer appear as such, you
1113 cannot set a breakpoint on those calls, nor can you change the behavior
1114 of the functions by linking with a different library.
1115
1116 With the @option{-fno-builtin-@var{function}} option
1117 only the built-in function @var{function} is
1118 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1119 function is named this is not built-in in this version of GCC, this
1120 option is ignored.  There is no corresponding
1121 @option{-fbuiltin-@var{function}} option; if you wish to enable
1122 built-in functions selectively when using @option{-fno-builtin} or
1123 @option{-ffreestanding}, you may define macros such as:
1124
1125 @smallexample
1126 #define abs(n)          __builtin_abs ((n))
1127 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1128 @end smallexample
1129
1130 @item -fhosted
1131 @opindex fhosted
1132 @cindex hosted environment
1133
1134 Assert that compilation takes place in a hosted environment.  This implies
1135 @option{-fbuiltin}.  A hosted environment is one in which the
1136 entire standard library is available, and in which @code{main} has a return
1137 type of @code{int}.  Examples are nearly everything except a kernel.
1138 This is equivalent to @option{-fno-freestanding}.
1139
1140 @item -ffreestanding
1141 @opindex ffreestanding
1142 @cindex hosted environment
1143
1144 Assert that compilation takes place in a freestanding environment.  This
1145 implies @option{-fno-builtin}.  A freestanding environment
1146 is one in which the standard library may not exist, and program startup may
1147 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1148 This is equivalent to @option{-fno-hosted}.
1149
1150 @xref{Standards,,Language Standards Supported by GCC}, for details of
1151 freestanding and hosted environments.
1152
1153 @item -fms-extensions
1154 @opindex fms-extensions
1155 Accept some non-standard constructs used in Microsoft header files.
1156
1157 @item -trigraphs
1158 @opindex trigraphs
1159 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1160 options for strict ISO C conformance) implies @option{-trigraphs}.
1161
1162 @item -no-integrated-cpp
1163 @opindex no-integrated-cpp
1164 Performs a compilation in two passes: preprocessing and compiling.  This
1165 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1166 @option{-B} option. The user supplied compilation step can then add in
1167 an additional preprocessing step after normal preprocessing but before
1168 compiling. The default is to use the integrated cpp (internal cpp)
1169
1170 The semantics of this option will change if "cc1", "cc1plus", and
1171 "cc1obj" are merged.
1172
1173 @cindex traditional C language
1174 @cindex C language, traditional
1175 @item -traditional
1176 @itemx -traditional-cpp
1177 @opindex traditional-cpp
1178 @opindex traditional
1179 Formerly, these options caused GCC to attempt to emulate a pre-standard
1180 C compiler.  They are now only supported with the @option{-E} switch.
1181 The preprocessor continues to support a pre-standard mode.  See the GNU
1182 CPP manual for details.
1183
1184 @item -fcond-mismatch
1185 @opindex fcond-mismatch
1186 Allow conditional expressions with mismatched types in the second and
1187 third arguments.  The value of such an expression is void.  This option
1188 is not supported for C++.
1189
1190 @item -funsigned-char
1191 @opindex funsigned-char
1192 Let the type @code{char} be unsigned, like @code{unsigned char}.
1193
1194 Each kind of machine has a default for what @code{char} should
1195 be.  It is either like @code{unsigned char} by default or like
1196 @code{signed char} by default.
1197
1198 Ideally, a portable program should always use @code{signed char} or
1199 @code{unsigned char} when it depends on the signedness of an object.
1200 But many programs have been written to use plain @code{char} and
1201 expect it to be signed, or expect it to be unsigned, depending on the
1202 machines they were written for.  This option, and its inverse, let you
1203 make such a program work with the opposite default.
1204
1205 The type @code{char} is always a distinct type from each of
1206 @code{signed char} or @code{unsigned char}, even though its behavior
1207 is always just like one of those two.
1208
1209 @item -fsigned-char
1210 @opindex fsigned-char
1211 Let the type @code{char} be signed, like @code{signed char}.
1212
1213 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1214 the negative form of @option{-funsigned-char}.  Likewise, the option
1215 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1216
1217 @item -fsigned-bitfields
1218 @itemx -funsigned-bitfields
1219 @itemx -fno-signed-bitfields
1220 @itemx -fno-unsigned-bitfields
1221 @opindex fsigned-bitfields
1222 @opindex funsigned-bitfields
1223 @opindex fno-signed-bitfields
1224 @opindex fno-unsigned-bitfields
1225 These options control whether a bit-field is signed or unsigned, when the
1226 declaration does not use either @code{signed} or @code{unsigned}.  By
1227 default, such a bit-field is signed, because this is consistent: the
1228 basic integer types such as @code{int} are signed types.
1229
1230 @item -fwritable-strings
1231 @opindex fwritable-strings
1232 Store string constants in the writable data segment and don't uniquize
1233 them.  This is for compatibility with old programs which assume they can
1234 write into string constants.
1235
1236 Writing into string constants is a very bad idea; ``constants'' should
1237 be constant.
1238
1239 This option is deprecated.
1240 @end table
1241
1242 @node C++ Dialect Options
1243 @section Options Controlling C++ Dialect
1244
1245 @cindex compiler options, C++
1246 @cindex C++ options, command line
1247 @cindex options, C++
1248 This section describes the command-line options that are only meaningful
1249 for C++ programs; but you can also use most of the GNU compiler options
1250 regardless of what language your program is in.  For example, you
1251 might compile a file @code{firstClass.C} like this:
1252
1253 @smallexample
1254 g++ -g -frepo -O -c firstClass.C
1255 @end smallexample
1256
1257 @noindent
1258 In this example, only @option{-frepo} is an option meant
1259 only for C++ programs; you can use the other options with any
1260 language supported by GCC@.
1261
1262 Here is a list of options that are @emph{only} for compiling C++ programs:
1263
1264 @table @gcctabopt
1265
1266 @item -fabi-version=@var{n}
1267 @opindex fabi-version
1268 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1269 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1270 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1271 the version that conforms most closely to the C++ ABI specification.
1272 Therefore, the ABI obtained using version 0 will change as ABI bugs
1273 are fixed.
1274
1275 The default is version 2.
1276
1277 @item -fno-access-control
1278 @opindex fno-access-control
1279 Turn off all access checking.  This switch is mainly useful for working
1280 around bugs in the access control code.
1281
1282 @item -fcheck-new
1283 @opindex fcheck-new
1284 Check that the pointer returned by @code{operator new} is non-null
1285 before attempting to modify the storage allocated.  This check is
1286 normally unnecessary because the C++ standard specifies that
1287 @code{operator new} will only return @code{0} if it is declared
1288 @samp{throw()}, in which case the compiler will always check the
1289 return value even without this option.  In all other cases, when
1290 @code{operator new} has a non-empty exception specification, memory
1291 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1292 @samp{new (nothrow)}.
1293
1294 @item -fconserve-space
1295 @opindex fconserve-space
1296 Put uninitialized or runtime-initialized global variables into the
1297 common segment, as C does.  This saves space in the executable at the
1298 cost of not diagnosing duplicate definitions.  If you compile with this
1299 flag and your program mysteriously crashes after @code{main()} has
1300 completed, you may have an object that is being destroyed twice because
1301 two definitions were merged.
1302
1303 This option is no longer useful on most targets, now that support has
1304 been added for putting variables into BSS without making them common.
1305
1306 @item -fno-const-strings
1307 @opindex fno-const-strings
1308 Give string constants type @code{char *} instead of type @code{const
1309 char *}.  By default, G++ uses type @code{const char *} as required by
1310 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1311 actually modify the value of a string constant, unless you also use
1312 @option{-fwritable-strings}.
1313
1314 This option might be removed in a future release of G++.  For maximum
1315 portability, you should structure your code so that it works with
1316 string constants that have type @code{const char *}.
1317
1318 @item -fno-elide-constructors
1319 @opindex fno-elide-constructors
1320 The C++ standard allows an implementation to omit creating a temporary
1321 which is only used to initialize another object of the same type.
1322 Specifying this option disables that optimization, and forces G++ to
1323 call the copy constructor in all cases.
1324
1325 @item -fno-enforce-eh-specs
1326 @opindex fno-enforce-eh-specs
1327 Don't check for violation of exception specifications at runtime.  This
1328 option violates the C++ standard, but may be useful for reducing code
1329 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1330 will still optimize based on the exception specifications.
1331
1332 @item -ffor-scope
1333 @itemx -fno-for-scope
1334 @opindex ffor-scope
1335 @opindex fno-for-scope
1336 If @option{-ffor-scope} is specified, the scope of variables declared in
1337 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1338 as specified by the C++ standard.
1339 If @option{-fno-for-scope} is specified, the scope of variables declared in
1340 a @i{for-init-statement} extends to the end of the enclosing scope,
1341 as was the case in old versions of G++, and other (traditional)
1342 implementations of C++.
1343
1344 The default if neither flag is given to follow the standard,
1345 but to allow and give a warning for old-style code that would
1346 otherwise be invalid, or have different behavior.
1347
1348 @item -fno-gnu-keywords
1349 @opindex fno-gnu-keywords
1350 Do not recognize @code{typeof} as a keyword, so that code can use this
1351 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1352 @option{-ansi} implies @option{-fno-gnu-keywords}.
1353
1354 @item -fno-implicit-templates
1355 @opindex fno-implicit-templates
1356 Never emit code for non-inline templates which are instantiated
1357 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1358 @xref{Template Instantiation}, for more information.
1359
1360 @item -fno-implicit-inline-templates
1361 @opindex fno-implicit-inline-templates
1362 Don't emit code for implicit instantiations of inline templates, either.
1363 The default is to handle inlines differently so that compiles with and
1364 without optimization will need the same set of explicit instantiations.
1365
1366 @item -fno-implement-inlines
1367 @opindex fno-implement-inlines
1368 To save space, do not emit out-of-line copies of inline functions
1369 controlled by @samp{#pragma implementation}.  This will cause linker
1370 errors if these functions are not inlined everywhere they are called.
1371
1372 @item -fms-extensions
1373 @opindex fms-extensions
1374 Disable pedantic warnings about constructs used in MFC, such as implicit
1375 int and getting a pointer to member function via non-standard syntax.
1376
1377 @item -fno-nonansi-builtins
1378 @opindex fno-nonansi-builtins
1379 Disable built-in declarations of functions that are not mandated by
1380 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1381 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1382
1383 @item -fno-operator-names
1384 @opindex fno-operator-names
1385 Do not treat the operator name keywords @code{and}, @code{bitand},
1386 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1387 synonyms as keywords.
1388
1389 @item -fno-optional-diags
1390 @opindex fno-optional-diags
1391 Disable diagnostics that the standard says a compiler does not need to
1392 issue.  Currently, the only such diagnostic issued by G++ is the one for
1393 a name having multiple meanings within a class.
1394
1395 @item -fpermissive
1396 @opindex fpermissive
1397 Downgrade some diagnostics about nonconformant code from errors to
1398 warnings.  Thus, using @option{-fpermissive} will allow some
1399 nonconforming code to compile.
1400
1401 @item -frepo
1402 @opindex frepo
1403 Enable automatic template instantiation at link time.  This option also
1404 implies @option{-fno-implicit-templates}.  @xref{Template
1405 Instantiation}, for more information.
1406
1407 @item -fno-rtti
1408 @opindex fno-rtti
1409 Disable generation of information about every class with virtual
1410 functions for use by the C++ runtime type identification features
1411 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1412 of the language, you can save some space by using this flag.  Note that
1413 exception handling uses the same information, but it will generate it as
1414 needed.
1415
1416 @item -fstats
1417 @opindex fstats
1418 Emit statistics about front-end processing at the end of the compilation.
1419 This information is generally only useful to the G++ development team.
1420
1421 @item -ftemplate-depth-@var{n}
1422 @opindex ftemplate-depth
1423 Set the maximum instantiation depth for template classes to @var{n}.
1424 A limit on the template instantiation depth is needed to detect
1425 endless recursions during template class instantiation.  ANSI/ISO C++
1426 conforming programs must not rely on a maximum depth greater than 17.
1427
1428 @item -fuse-cxa-atexit
1429 @opindex fuse-cxa-atexit
1430 Register destructors for objects with static storage duration with the
1431 @code{__cxa_atexit} function rather than the @code{atexit} function.
1432 This option is required for fully standards-compliant handling of static
1433 destructors, but will only work if your C library supports
1434 @code{__cxa_atexit}.
1435
1436 @item -fno-weak
1437 @opindex fno-weak
1438 Do not use weak symbol support, even if it is provided by the linker.
1439 By default, G++ will use weak symbols if they are available.  This
1440 option exists only for testing, and should not be used by end-users;
1441 it will result in inferior code and has no benefits.  This option may
1442 be removed in a future release of G++.
1443
1444 @item -nostdinc++
1445 @opindex nostdinc++
1446 Do not search for header files in the standard directories specific to
1447 C++, but do still search the other standard directories.  (This option
1448 is used when building the C++ library.)
1449 @end table
1450
1451 In addition, these optimization, warning, and code generation options
1452 have meanings only for C++ programs:
1453
1454 @table @gcctabopt
1455 @item -fno-default-inline
1456 @opindex fno-default-inline
1457 Do not assume @samp{inline} for functions defined inside a class scope.
1458 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1459 functions will have linkage like inline functions; they just won't be
1460 inlined by default.
1461
1462 @item -Wabi @r{(C++ only)}
1463 @opindex Wabi
1464 Warn when G++ generates code that is probably not compatible with the
1465 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1466 all such cases, there are probably some cases that are not warned about,
1467 even though G++ is generating incompatible code.  There may also be
1468 cases where warnings are emitted even though the code that is generated
1469 will be compatible.
1470
1471 You should rewrite your code to avoid these warnings if you are
1472 concerned about the fact that code generated by G++ may not be binary
1473 compatible with code generated by other compilers.
1474
1475 The known incompatibilities at this point include:
1476
1477 @itemize @bullet
1478
1479 @item
1480 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1481 pack data into the same byte as a base class.  For example:
1482
1483 @smallexample
1484 struct A @{ virtual void f(); int f1 : 1; @};
1485 struct B : public A @{ int f2 : 1; @};
1486 @end smallexample
1487
1488 @noindent
1489 In this case, G++ will place @code{B::f2} into the same byte
1490 as@code{A::f1}; other compilers will not.  You can avoid this problem
1491 by explicitly padding @code{A} so that its size is a multiple of the
1492 byte size on your platform; that will cause G++ and other compilers to
1493 layout @code{B} identically.
1494
1495 @item
1496 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1497 tail padding when laying out virtual bases.  For example:
1498
1499 @smallexample
1500 struct A @{ virtual void f(); char c1; @};
1501 struct B @{ B(); char c2; @};
1502 struct C : public A, public virtual B @{@};
1503 @end smallexample
1504
1505 @noindent
1506 In this case, G++ will not place @code{B} into the tail-padding for
1507 @code{A}; other compilers will.  You can avoid this problem by
1508 explicitly padding @code{A} so that its size is a multiple of its
1509 alignment (ignoring virtual base classes); that will cause G++ and other
1510 compilers to layout @code{C} identically.
1511
1512 @item
1513 Incorrect handling of bit-fields with declared widths greater than that
1514 of their underlying types, when the bit-fields appear in a union.  For
1515 example:
1516
1517 @smallexample
1518 union U @{ int i : 4096; @};
1519 @end smallexample
1520
1521 @noindent
1522 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1523 union too small by the number of bits in an @code{int}.
1524
1525 @item
1526 Empty classes can be placed at incorrect offsets.  For example:
1527
1528 @smallexample
1529 struct A @{@};
1530
1531 struct B @{
1532   A a;
1533   virtual void f ();
1534 @};
1535
1536 struct C : public B, public A @{@};
1537 @end smallexample
1538
1539 @noindent
1540 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1541 it should be placed at offset zero.  G++ mistakenly believes that the
1542 @code{A} data member of @code{B} is already at offset zero.
1543
1544 @item
1545 Names of template functions whose types involve @code{typename} or
1546 template template parameters can be mangled incorrectly.
1547
1548 @smallexample
1549 template <typename Q>
1550 void f(typename Q::X) @{@}
1551
1552 template <template <typename> class Q>
1553 void f(typename Q<int>::X) @{@}
1554 @end smallexample
1555
1556 @noindent
1557 Instantiations of these templates may be mangled incorrectly.
1558
1559 @end itemize
1560
1561 @item -Wctor-dtor-privacy @r{(C++ only)}
1562 @opindex Wctor-dtor-privacy
1563 Warn when a class seems unusable because all the constructors or
1564 destructors in that class are private, and it has neither friends nor
1565 public static member functions.
1566
1567 @item -Wnon-virtual-dtor @r{(C++ only)}
1568 @opindex Wnon-virtual-dtor
1569 Warn when a class appears to be polymorphic, thereby requiring a virtual
1570 destructor, yet it declares a non-virtual one.
1571 This warning is enabled by @option{-Wall}.
1572
1573 @item -Wreorder @r{(C++ only)}
1574 @opindex Wreorder
1575 @cindex reordering, warning
1576 @cindex warning for reordering of member initializers
1577 Warn when the order of member initializers given in the code does not
1578 match the order in which they must be executed.  For instance:
1579
1580 @smallexample
1581 struct A @{
1582   int i;
1583   int j;
1584   A(): j (0), i (1) @{ @}
1585 @};
1586 @end smallexample
1587
1588 The compiler will rearrange the member initializers for @samp{i}
1589 and @samp{j} to match the declaration order of the members, emitting
1590 a warning to that effect.  This warning is enabled by @option{-Wall}.
1591 @end table
1592
1593 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1594
1595 @table @gcctabopt
1596 @item -Weffc++ @r{(C++ only)}
1597 @opindex Weffc++
1598 Warn about violations of the following style guidelines from Scott Meyers'
1599 @cite{Effective C++} book:
1600
1601 @itemize @bullet
1602 @item
1603 Item 11:  Define a copy constructor and an assignment operator for classes
1604 with dynamically allocated memory.
1605
1606 @item
1607 Item 12:  Prefer initialization to assignment in constructors.
1608
1609 @item
1610 Item 14:  Make destructors virtual in base classes.
1611
1612 @item
1613 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1614
1615 @item
1616 Item 23:  Don't try to return a reference when you must return an object.
1617
1618 @end itemize
1619
1620 Also warn about violations of the following style guidelines from
1621 Scott Meyers' @cite{More Effective C++} book:
1622
1623 @itemize @bullet
1624 @item
1625 Item 6:  Distinguish between prefix and postfix forms of increment and
1626 decrement operators.
1627
1628 @item
1629 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1630
1631 @end itemize
1632
1633 When selecting this option, be aware that the standard library
1634 headers do not obey all of these guidelines; use @samp{grep -v}
1635 to filter out those warnings.
1636
1637 @item -Wno-deprecated @r{(C++ only)}
1638 @opindex Wno-deprecated
1639 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1640
1641 @item -Wno-non-template-friend @r{(C++ only)}
1642 @opindex Wno-non-template-friend
1643 Disable warnings when non-templatized friend functions are declared
1644 within a template.  Since the advent of explicit template specification
1645 support in G++, if the name of the friend is an unqualified-id (i.e.,
1646 @samp{friend foo(int)}), the C++ language specification demands that the
1647 friend declare or define an ordinary, nontemplate function.  (Section
1648 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1649 could be interpreted as a particular specialization of a templatized
1650 function.  Because this non-conforming behavior is no longer the default
1651 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1652 check existing code for potential trouble spots and is on by default.
1653 This new compiler behavior can be turned off with
1654 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1655 but disables the helpful warning.
1656
1657 @item -Wold-style-cast @r{(C++ only)}
1658 @opindex Wold-style-cast
1659 Warn if an old-style (C-style) cast to a non-void type is used within
1660 a C++ program.  The new-style casts (@samp{static_cast},
1661 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1662 unintended effects and much easier to search for.
1663
1664 @item -Woverloaded-virtual @r{(C++ only)}
1665 @opindex Woverloaded-virtual
1666 @cindex overloaded virtual fn, warning
1667 @cindex warning for overloaded virtual fn
1668 Warn when a function declaration hides virtual functions from a
1669 base class.  For example, in:
1670
1671 @smallexample
1672 struct A @{
1673   virtual void f();
1674 @};
1675
1676 struct B: public A @{
1677   void f(int);
1678 @};
1679 @end smallexample
1680
1681 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1682 like:
1683
1684 @smallexample
1685 B* b;
1686 b->f();
1687 @end smallexample
1688
1689 will fail to compile.
1690
1691 @item -Wno-pmf-conversions @r{(C++ only)}
1692 @opindex Wno-pmf-conversions
1693 Disable the diagnostic for converting a bound pointer to member function
1694 to a plain pointer.
1695
1696 @item -Wsign-promo @r{(C++ only)}
1697 @opindex Wsign-promo
1698 Warn when overload resolution chooses a promotion from unsigned or
1699 enumeral type to a signed type, over a conversion to an unsigned type of
1700 the same size.  Previous versions of G++ would try to preserve
1701 unsignedness, but the standard mandates the current behavior.
1702
1703 @item -Wsynth @r{(C++ only)}
1704 @opindex Wsynth
1705 @cindex warning for synthesized methods
1706 @cindex synthesized methods, warning
1707 Warn when G++'s synthesis behavior does not match that of cfront.  For
1708 instance:
1709
1710 @smallexample
1711 struct A @{
1712   operator int ();
1713   A& operator = (int);
1714 @};
1715
1716 main ()
1717 @{
1718   A a,b;
1719   a = b;
1720 @}
1721 @end smallexample
1722
1723 In this example, G++ will synthesize a default @samp{A& operator =
1724 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1725 @end table
1726
1727 @node Objective-C Dialect Options
1728 @section Options Controlling Objective-C Dialect
1729
1730 @cindex compiler options, Objective-C
1731 @cindex Objective-C options, command line
1732 @cindex options, Objective-C
1733 (NOTE: This manual does not describe the Objective-C language itself.  See
1734 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1735
1736 This section describes the command-line options that are only meaningful
1737 for Objective-C programs, but you can also use most of the GNU compiler
1738 options regardless of what language your program is in.  For example,
1739 you might compile a file @code{some_class.m} like this:
1740
1741 @smallexample
1742 gcc -g -fgnu-runtime -O -c some_class.m
1743 @end smallexample
1744
1745 @noindent
1746 In this example, @option{-fgnu-runtime} is an option meant only for
1747 Objective-C programs; you can use the other options with any language
1748 supported by GCC@.
1749
1750 Here is a list of options that are @emph{only} for compiling Objective-C
1751 programs:
1752
1753 @table @gcctabopt
1754 @item -fconstant-string-class=@var{class-name}
1755 @opindex fconstant-string-class
1756 Use @var{class-name} as the name of the class to instantiate for each
1757 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1758 class name is @code{NXConstantString} if the GNU runtime is being used, and
1759 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1760 @option{-fconstant-cfstrings} option, if also present, will override the
1761 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1762 to be laid out as constant CoreFoundation strings.
1763
1764 @item -fgnu-runtime
1765 @opindex fgnu-runtime
1766 Generate object code compatible with the standard GNU Objective-C
1767 runtime.  This is the default for most types of systems.
1768
1769 @item -fnext-runtime
1770 @opindex fnext-runtime
1771 Generate output compatible with the NeXT runtime.  This is the default
1772 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1773 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1774 used.
1775
1776 @item -fno-nil-receivers
1777 @opindex fno-nil-receivers
1778 Assume that all Objective-C message dispatches (e.g.,
1779 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1780 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1781 used.  Currently, this option is only available in conjunction with
1782 the NeXT runtime on Mac OS X 10.3 and later.
1783
1784 @item -fobjc-exceptions
1785 @opindex fobjc-exceptions
1786 Enable syntactic support for structured exception handling in Objective-C,
1787 similar to what is offered by C++ and Java.  Currently, this option is only
1788 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1789
1790 @smallexample
1791   @@try @{
1792     @dots{}
1793        @@throw expr;
1794     @dots{}
1795   @}
1796   @@catch (AnObjCClass *exc) @{
1797     @dots{}
1798       @@throw expr;
1799     @dots{}
1800       @@throw;
1801     @dots{}
1802   @}
1803   @@catch (AnotherClass *exc) @{
1804     @dots{}
1805   @}
1806   @@catch (id allOthers) @{
1807     @dots{}
1808   @}
1809   @@finally @{
1810     @dots{}
1811       @@throw expr;
1812     @dots{}
1813   @}
1814 @end smallexample
1815
1816 The @code{@@throw} statement may appear anywhere in an Objective-C or
1817 Objective-C++ program; when used inside of a @code{@@catch} block, the
1818 @code{@@throw} may appear without an argument (as shown above), in which case
1819 the object caught by the @code{@@catch} will be rethrown.
1820
1821 Note that only (pointers to) Objective-C objects may be thrown and
1822 caught using this scheme.  When an object is thrown, it will be caught
1823 by the nearest @code{@@catch} clause capable of handling objects of that type,
1824 analogously to how @code{catch} blocks work in C++ and Java.  A
1825 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1826 any and all Objective-C exceptions not caught by previous @code{@@catch}
1827 clauses (if any).
1828
1829 The @code{@@finally} clause, if present, will be executed upon exit from the
1830 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1831 regardless of whether any exceptions are thrown, caught or rethrown
1832 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1833 of the @code{finally} clause in Java.
1834
1835 There are several caveats to using the new exception mechanism:
1836
1837 @itemize @bullet
1838 @item
1839 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1840 idioms provided by the @code{NSException} class, the new
1841 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1842 systems, due to additional functionality needed in the (NeXT) Objective-C
1843 runtime.
1844
1845 @item
1846 As mentioned above, the new exceptions do not support handling
1847 types other than Objective-C objects.   Furthermore, when used from
1848 Objective-C++, the Objective-C exception model does not interoperate with C++
1849 exceptions at this time.  This means you cannot @code{@@throw} an exception
1850 from Objective-C and @code{catch} it in C++, or vice versa
1851 (i.e., @code{throw @dots{} @@catch}).
1852 @end itemize
1853
1854 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1855 blocks for thread-safe execution:
1856
1857 @smallexample
1858   @@synchronized (ObjCClass *guard) @{
1859     @dots{}
1860   @}
1861 @end smallexample
1862
1863 Upon entering the @code{@@synchronized} block, a thread of execution shall
1864 first check whether a lock has been placed on the corresponding @code{guard}
1865 object by another thread.  If it has, the current thread shall wait until
1866 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1867 the current thread will place its own lock on it, execute the code contained in
1868 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1869 making @code{guard} available to other threads).
1870
1871 Unlike Java, Objective-C does not allow for entire methods to be marked
1872 @code{@@synchronized}.  Note that throwing exceptions out of
1873 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1874 to be unlocked properly.
1875
1876 @item -freplace-objc-classes
1877 @opindex freplace-objc-classes
1878 Emit a special marker instructing @command{ld(1)} not to statically link in
1879 the resulting object file, and allow @command{dyld(1)} to load it in at
1880 run time instead.  This is used in conjunction with the Fix-and-Continue
1881 debugging mode, where the object file in question may be recompiled and
1882 dynamically reloaded in the course of program execution, without the need
1883 to restart the program itself.  Currently, Fix-and-Continue functionality
1884 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1885 and later.
1886
1887 @item -fzero-link
1888 @opindex fzero-link
1889 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1890 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1891 compile time) with static class references that get initialized at load time,
1892 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1893 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1894 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1895 for individual class implementations to be modified during program execution.
1896
1897 @item -gen-decls
1898 @opindex gen-decls
1899 Dump interface declarations for all classes seen in the source file to a
1900 file named @file{@var{sourcename}.decl}.
1901
1902 @item -Wno-protocol
1903 @opindex Wno-protocol
1904 If a class is declared to implement a protocol, a warning is issued for
1905 every method in the protocol that is not implemented by the class.  The
1906 default behavior is to issue a warning for every method not explicitly
1907 implemented in the class, even if a method implementation is inherited
1908 from the superclass.  If you use the @code{-Wno-protocol} option, then
1909 methods inherited from the superclass are considered to be implemented,
1910 and no warning is issued for them.
1911
1912 @item -Wselector
1913 @opindex Wselector
1914 Warn if multiple methods of different types for the same selector are
1915 found during compilation.  The check is performed on the list of methods
1916 in the final stage of compilation.  Additionally, a check is performed
1917 for each selector appearing in a @code{@@selector(@dots{})}
1918 expression, and a corresponding method for that selector has been found
1919 during compilation.  Because these checks scan the method table only at
1920 the end of compilation, these warnings are not produced if the final
1921 stage of compilation is not reached, for example because an error is
1922 found during compilation, or because the @code{-fsyntax-only} option is
1923 being used.
1924
1925 @item -Wundeclared-selector
1926 @opindex Wundeclared-selector
1927 Warn if a @code{@@selector(@dots{})} expression referring to an
1928 undeclared selector is found.  A selector is considered undeclared if no
1929 method with that name has been declared before the
1930 @code{@@selector(@dots{})} expression, either explicitly in an
1931 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1932 an @code{@@implementation} section.  This option always performs its
1933 checks as soon as a @code{@@selector(@dots{})} expression is found,
1934 while @code{-Wselector} only performs its checks in the final stage of
1935 compilation.  This also enforces the coding style convention
1936 that methods and selectors must be declared before being used.
1937
1938 @item -print-objc-runtime-info
1939 @opindex print-objc-runtime-info
1940 Generate C header describing the largest structure that is passed by
1941 value, if any.
1942
1943 @end table
1944
1945 @node Language Independent Options
1946 @section Options to Control Diagnostic Messages Formatting
1947 @cindex options to control diagnostics formatting
1948 @cindex diagnostic messages
1949 @cindex message formatting
1950
1951 Traditionally, diagnostic messages have been formatted irrespective of
1952 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1953 below can be used to control the diagnostic messages formatting
1954 algorithm, e.g.@: how many characters per line, how often source location
1955 information should be reported.  Right now, only the C++ front end can
1956 honor these options.  However it is expected, in the near future, that
1957 the remaining front ends would be able to digest them correctly.
1958
1959 @table @gcctabopt
1960 @item -fmessage-length=@var{n}
1961 @opindex fmessage-length
1962 Try to format error messages so that they fit on lines of about @var{n}
1963 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1964 the front ends supported by GCC@.  If @var{n} is zero, then no
1965 line-wrapping will be done; each error message will appear on a single
1966 line.
1967
1968 @opindex fdiagnostics-show-location
1969 @item -fdiagnostics-show-location=once
1970 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1971 reporter to emit @emph{once} source location information; that is, in
1972 case the message is too long to fit on a single physical line and has to
1973 be wrapped, the source location won't be emitted (as prefix) again,
1974 over and over, in subsequent continuation lines.  This is the default
1975 behavior.
1976
1977 @item -fdiagnostics-show-location=every-line
1978 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1979 messages reporter to emit the same source location information (as
1980 prefix) for physical lines that result from the process of breaking
1981 a message which is too long to fit on a single line.
1982
1983 @end table
1984
1985 @node Warning Options
1986 @section Options to Request or Suppress Warnings
1987 @cindex options to control warnings
1988 @cindex warning messages
1989 @cindex messages, warning
1990 @cindex suppressing warnings
1991
1992 Warnings are diagnostic messages that report constructions which
1993 are not inherently erroneous but which are risky or suggest there
1994 may have been an error.
1995
1996 You can request many specific warnings with options beginning @samp{-W},
1997 for example @option{-Wimplicit} to request warnings on implicit
1998 declarations.  Each of these specific warning options also has a
1999 negative form beginning @samp{-Wno-} to turn off warnings;
2000 for example, @option{-Wno-implicit}.  This manual lists only one of the
2001 two forms, whichever is not the default.
2002
2003 The following options control the amount and kinds of warnings produced
2004 by GCC; for further, language-specific options also refer to
2005 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2006
2007 @table @gcctabopt
2008 @cindex syntax checking
2009 @item -fsyntax-only
2010 @opindex fsyntax-only
2011 Check the code for syntax errors, but don't do anything beyond that.
2012
2013 @item -pedantic
2014 @opindex pedantic
2015 Issue all the warnings demanded by strict ISO C and ISO C++;
2016 reject all programs that use forbidden extensions, and some other
2017 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2018 version of the ISO C standard specified by any @option{-std} option used.
2019
2020 Valid ISO C and ISO C++ programs should compile properly with or without
2021 this option (though a rare few will require @option{-ansi} or a
2022 @option{-std} option specifying the required version of ISO C)@.  However,
2023 without this option, certain GNU extensions and traditional C and C++
2024 features are supported as well.  With this option, they are rejected.
2025
2026 @option{-pedantic} does not cause warning messages for use of the
2027 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2028 warnings are also disabled in the expression that follows
2029 @code{__extension__}.  However, only system header files should use
2030 these escape routes; application programs should avoid them.
2031 @xref{Alternate Keywords}.
2032
2033 Some users try to use @option{-pedantic} to check programs for strict ISO
2034 C conformance.  They soon find that it does not do quite what they want:
2035 it finds some non-ISO practices, but not all---only those for which
2036 ISO C @emph{requires} a diagnostic, and some others for which
2037 diagnostics have been added.
2038
2039 A feature to report any failure to conform to ISO C might be useful in
2040 some instances, but would require considerable additional work and would
2041 be quite different from @option{-pedantic}.  We don't have plans to
2042 support such a feature in the near future.
2043
2044 Where the standard specified with @option{-std} represents a GNU
2045 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2046 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2047 extended dialect is based.  Warnings from @option{-pedantic} are given
2048 where they are required by the base standard.  (It would not make sense
2049 for such warnings to be given only for features not in the specified GNU
2050 C dialect, since by definition the GNU dialects of C include all
2051 features the compiler supports with the given option, and there would be
2052 nothing to warn about.)
2053
2054 @item -pedantic-errors
2055 @opindex pedantic-errors
2056 Like @option{-pedantic}, except that errors are produced rather than
2057 warnings.
2058
2059 @item -w
2060 @opindex w
2061 Inhibit all warning messages.
2062
2063 @item -Wno-import
2064 @opindex Wno-import
2065 Inhibit warning messages about the use of @samp{#import}.
2066
2067 @item -Wchar-subscripts
2068 @opindex Wchar-subscripts
2069 Warn if an array subscript has type @code{char}.  This is a common cause
2070 of error, as programmers often forget that this type is signed on some
2071 machines.
2072
2073 @item -Wcomment
2074 @opindex Wcomment
2075 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2076 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2077
2078 @item -Wformat
2079 @opindex Wformat
2080 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2081 the arguments supplied have types appropriate to the format string
2082 specified, and that the conversions specified in the format string make
2083 sense.  This includes standard functions, and others specified by format
2084 attributes (@pxref{Function Attributes}), in the @code{printf},
2085 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2086 not in the C standard) families.
2087
2088 The formats are checked against the format features supported by GNU
2089 libc version 2.2.  These include all ISO C90 and C99 features, as well
2090 as features from the Single Unix Specification and some BSD and GNU
2091 extensions.  Other library implementations may not support all these
2092 features; GCC does not support warning about features that go beyond a
2093 particular library's limitations.  However, if @option{-pedantic} is used
2094 with @option{-Wformat}, warnings will be given about format features not
2095 in the selected standard version (but not for @code{strfmon} formats,
2096 since those are not in any version of the C standard).  @xref{C Dialect
2097 Options,,Options Controlling C Dialect}.
2098
2099 Since @option{-Wformat} also checks for null format arguments for
2100 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2101
2102 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2103 aspects of format checking, the options @option{-Wformat-y2k},
2104 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2105 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2106 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2107
2108 @item -Wformat-y2k
2109 @opindex Wformat-y2k
2110 If @option{-Wformat} is specified, also warn about @code{strftime}
2111 formats which may yield only a two-digit year.
2112
2113 @item -Wno-format-extra-args
2114 @opindex Wno-format-extra-args
2115 If @option{-Wformat} is specified, do not warn about excess arguments to a
2116 @code{printf} or @code{scanf} format function.  The C standard specifies
2117 that such arguments are ignored.
2118
2119 Where the unused arguments lie between used arguments that are
2120 specified with @samp{$} operand number specifications, normally
2121 warnings are still given, since the implementation could not know what
2122 type to pass to @code{va_arg} to skip the unused arguments.  However,
2123 in the case of @code{scanf} formats, this option will suppress the
2124 warning if the unused arguments are all pointers, since the Single
2125 Unix Specification says that such unused arguments are allowed.
2126
2127 @item -Wno-format-zero-length
2128 @opindex Wno-format-zero-length
2129 If @option{-Wformat} is specified, do not warn about zero-length formats.
2130 The C standard specifies that zero-length formats are allowed.
2131
2132 @item -Wformat-nonliteral
2133 @opindex Wformat-nonliteral
2134 If @option{-Wformat} is specified, also warn if the format string is not a
2135 string literal and so cannot be checked, unless the format function
2136 takes its format arguments as a @code{va_list}.
2137
2138 @item -Wformat-security
2139 @opindex Wformat-security
2140 If @option{-Wformat} is specified, also warn about uses of format
2141 functions that represent possible security problems.  At present, this
2142 warns about calls to @code{printf} and @code{scanf} functions where the
2143 format string is not a string literal and there are no format arguments,
2144 as in @code{printf (foo);}.  This may be a security hole if the format
2145 string came from untrusted input and contains @samp{%n}.  (This is
2146 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2147 in future warnings may be added to @option{-Wformat-security} that are not
2148 included in @option{-Wformat-nonliteral}.)
2149
2150 @item -Wformat=2
2151 @opindex Wformat=2
2152 Enable @option{-Wformat} plus format checks not included in
2153 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2154 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2155
2156 @item -Wnonnull
2157 @opindex Wnonnull
2158 Warn about passing a null pointer for arguments marked as
2159 requiring a non-null value by the @code{nonnull} function attribute.
2160
2161 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2162 can be disabled with the @option{-Wno-nonnull} option.
2163
2164 @item -Winit-self @r{(C, C++, and Objective-C only)}
2165 @opindex Winit-self
2166 Warn about uninitialized variables which are initialized with themselves.
2167 Note this option can only be used with the @option{-Wuninitialized} option,
2168 which in turn only works with @option{-O1} and above.
2169
2170 For example, GCC will warn about @code{i} being uninitialized in the
2171 following snippet only when @option{-Winit-self} has been specified:
2172 @smallexample
2173 @group
2174 int f()
2175 @{
2176   int i = i;
2177   return i;
2178 @}
2179 @end group
2180 @end smallexample
2181
2182 @item -Wimplicit-int
2183 @opindex Wimplicit-int
2184 Warn when a declaration does not specify a type.
2185
2186 @item -Wimplicit-function-declaration
2187 @itemx -Werror-implicit-function-declaration
2188 @opindex Wimplicit-function-declaration
2189 @opindex Werror-implicit-function-declaration
2190 Give a warning (or error) whenever a function is used before being
2191 declared.
2192
2193 @item -Wimplicit
2194 @opindex Wimplicit
2195 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2196
2197 @item -Wmain
2198 @opindex Wmain
2199 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2200 function with external linkage, returning int, taking either zero
2201 arguments, two, or three arguments of appropriate types.
2202
2203 @item -Wmissing-braces
2204 @opindex Wmissing-braces
2205 Warn if an aggregate or union initializer is not fully bracketed.  In
2206 the following example, the initializer for @samp{a} is not fully
2207 bracketed, but that for @samp{b} is fully bracketed.
2208
2209 @smallexample
2210 int a[2][2] = @{ 0, 1, 2, 3 @};
2211 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2212 @end smallexample
2213
2214 @item -Wparentheses
2215 @opindex Wparentheses
2216 Warn if parentheses are omitted in certain contexts, such
2217 as when there is an assignment in a context where a truth value
2218 is expected, or when operators are nested whose precedence people
2219 often get confused about.
2220
2221 Also warn about constructions where there may be confusion to which
2222 @code{if} statement an @code{else} branch belongs.  Here is an example of
2223 such a case:
2224
2225 @smallexample
2226 @group
2227 @{
2228   if (a)
2229     if (b)
2230       foo ();
2231   else
2232     bar ();
2233 @}
2234 @end group
2235 @end smallexample
2236
2237 In C, every @code{else} branch belongs to the innermost possible @code{if}
2238 statement, which in this example is @code{if (b)}.  This is often not
2239 what the programmer expected, as illustrated in the above example by
2240 indentation the programmer chose.  When there is the potential for this
2241 confusion, GCC will issue a warning when this flag is specified.
2242 To eliminate the warning, add explicit braces around the innermost
2243 @code{if} statement so there is no way the @code{else} could belong to
2244 the enclosing @code{if}.  The resulting code would look like this:
2245
2246 @smallexample
2247 @group
2248 @{
2249   if (a)
2250     @{
2251       if (b)
2252         foo ();
2253       else
2254         bar ();
2255     @}
2256 @}
2257 @end group
2258 @end smallexample
2259
2260 @item -Wsequence-point
2261 @opindex Wsequence-point
2262 Warn about code that may have undefined semantics because of violations
2263 of sequence point rules in the C standard.
2264
2265 The C standard defines the order in which expressions in a C program are
2266 evaluated in terms of @dfn{sequence points}, which represent a partial
2267 ordering between the execution of parts of the program: those executed
2268 before the sequence point, and those executed after it.  These occur
2269 after the evaluation of a full expression (one which is not part of a
2270 larger expression), after the evaluation of the first operand of a
2271 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2272 function is called (but after the evaluation of its arguments and the
2273 expression denoting the called function), and in certain other places.
2274 Other than as expressed by the sequence point rules, the order of
2275 evaluation of subexpressions of an expression is not specified.  All
2276 these rules describe only a partial order rather than a total order,
2277 since, for example, if two functions are called within one expression
2278 with no sequence point between them, the order in which the functions
2279 are called is not specified.  However, the standards committee have
2280 ruled that function calls do not overlap.
2281
2282 It is not specified when between sequence points modifications to the
2283 values of objects take effect.  Programs whose behavior depends on this
2284 have undefined behavior; the C standard specifies that ``Between the
2285 previous and next sequence point an object shall have its stored value
2286 modified at most once by the evaluation of an expression.  Furthermore,
2287 the prior value shall be read only to determine the value to be
2288 stored.''.  If a program breaks these rules, the results on any
2289 particular implementation are entirely unpredictable.
2290
2291 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2292 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2293 diagnosed by this option, and it may give an occasional false positive
2294 result, but in general it has been found fairly effective at detecting
2295 this sort of problem in programs.
2296
2297 The present implementation of this option only works for C programs.  A
2298 future implementation may also work for C++ programs.
2299
2300 The C standard is worded confusingly, therefore there is some debate
2301 over the precise meaning of the sequence point rules in subtle cases.
2302 Links to discussions of the problem, including proposed formal
2303 definitions, may be found on our readings page, at
2304 @w{@uref{http://gcc.gnu.org/readings.html}}.
2305
2306 @item -Wreturn-type
2307 @opindex Wreturn-type
2308 Warn whenever a function is defined with a return-type that defaults to
2309 @code{int}.  Also warn about any @code{return} statement with no
2310 return-value in a function whose return-type is not @code{void}.
2311
2312 For C++, a function without return type always produces a diagnostic
2313 message, even when @option{-Wno-return-type} is specified.  The only
2314 exceptions are @samp{main} and functions defined in system headers.
2315
2316 @item -Wswitch
2317 @opindex Wswitch
2318 Warn whenever a @code{switch} statement has an index of enumeral type
2319 and lacks a @code{case} for one or more of the named codes of that
2320 enumeration.  (The presence of a @code{default} label prevents this
2321 warning.)  @code{case} labels outside the enumeration range also
2322 provoke warnings when this option is used.
2323
2324 @item -Wswitch-default
2325 @opindex Wswitch-switch
2326 Warn whenever a @code{switch} statement does not have a @code{default}
2327 case.
2328
2329 @item -Wswitch-enum
2330 @opindex Wswitch-enum
2331 Warn whenever a @code{switch} statement has an index of enumeral type
2332 and lacks a @code{case} for one or more of the named codes of that
2333 enumeration.  @code{case} labels outside the enumeration range also
2334 provoke warnings when this option is used.
2335
2336 @item -Wtrigraphs
2337 @opindex Wtrigraphs
2338 Warn if any trigraphs are encountered that might change the meaning of
2339 the program (trigraphs within comments are not warned about).
2340
2341 @item -Wunused-function
2342 @opindex Wunused-function
2343 Warn whenever a static function is declared but not defined or a
2344 non\-inline static function is unused.
2345
2346 @item -Wunused-label
2347 @opindex Wunused-label
2348 Warn whenever a label is declared but not used.
2349
2350 To suppress this warning use the @samp{unused} attribute
2351 (@pxref{Variable Attributes}).
2352
2353 @item -Wunused-parameter
2354 @opindex Wunused-parameter
2355 Warn whenever a function parameter is unused aside from its declaration.
2356
2357 To suppress this warning use the @samp{unused} attribute
2358 (@pxref{Variable Attributes}).
2359
2360 @item -Wunused-variable
2361 @opindex Wunused-variable
2362 Warn whenever a local variable or non-constant static variable is unused
2363 aside from its declaration
2364
2365 To suppress this warning use the @samp{unused} attribute
2366 (@pxref{Variable Attributes}).
2367
2368 @item -Wunused-value
2369 @opindex Wunused-value
2370 Warn whenever a statement computes a result that is explicitly not used.
2371
2372 To suppress this warning cast the expression to @samp{void}.
2373
2374 @item -Wunused
2375 @opindex Wunused
2376 All the above @option{-Wunused} options combined.
2377
2378 In order to get a warning about an unused function parameter, you must
2379 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2380 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2381
2382 @item -Wuninitialized
2383 @opindex Wuninitialized
2384 Warn if an automatic variable is used without first being initialized or
2385 if a variable may be clobbered by a @code{setjmp} call.
2386
2387 These warnings are possible only in optimizing compilation,
2388 because they require data flow information that is computed only
2389 when optimizing.  If you don't specify @option{-O}, you simply won't
2390 get these warnings.
2391
2392 If you want to warn about code which uses the uninitialized value of the
2393 variable in its own initializer, use the @option{-Winit-self} option.
2394
2395 These warnings occur only for variables that are candidates for
2396 register allocation.  Therefore, they do not occur for a variable that
2397 is declared @code{volatile}, or whose address is taken, or whose size
2398 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2399 structures, unions or arrays, even when they are in registers.
2400
2401 Note that there may be no warning about a variable that is used only
2402 to compute a value that itself is never used, because such
2403 computations may be deleted by data flow analysis before the warnings
2404 are printed.
2405
2406 These warnings are made optional because GCC is not smart
2407 enough to see all the reasons why the code might be correct
2408 despite appearing to have an error.  Here is one example of how
2409 this can happen:
2410
2411 @smallexample
2412 @group
2413 @{
2414   int x;
2415   switch (y)
2416     @{
2417     case 1: x = 1;
2418       break;
2419     case 2: x = 4;
2420       break;
2421     case 3: x = 5;
2422     @}
2423   foo (x);
2424 @}
2425 @end group
2426 @end smallexample
2427
2428 @noindent
2429 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2430 always initialized, but GCC doesn't know this.  Here is
2431 another common case:
2432
2433 @smallexample
2434 @{
2435   int save_y;
2436   if (change_y) save_y = y, y = new_y;
2437   @dots{}
2438   if (change_y) y = save_y;
2439 @}
2440 @end smallexample
2441
2442 @noindent
2443 This has no bug because @code{save_y} is used only if it is set.
2444
2445 @cindex @code{longjmp} warnings
2446 This option also warns when a non-volatile automatic variable might be
2447 changed by a call to @code{longjmp}.  These warnings as well are possible
2448 only in optimizing compilation.
2449
2450 The compiler sees only the calls to @code{setjmp}.  It cannot know
2451 where @code{longjmp} will be called; in fact, a signal handler could
2452 call it at any point in the code.  As a result, you may get a warning
2453 even when there is in fact no problem because @code{longjmp} cannot
2454 in fact be called at the place which would cause a problem.
2455
2456 Some spurious warnings can be avoided if you declare all the functions
2457 you use that never return as @code{noreturn}.  @xref{Function
2458 Attributes}.
2459
2460 @item -Wunknown-pragmas
2461 @opindex Wunknown-pragmas
2462 @cindex warning for unknown pragmas
2463 @cindex unknown pragmas, warning
2464 @cindex pragmas, warning of unknown
2465 Warn when a #pragma directive is encountered which is not understood by
2466 GCC@.  If this command line option is used, warnings will even be issued
2467 for unknown pragmas in system header files.  This is not the case if
2468 the warnings were only enabled by the @option{-Wall} command line option.
2469
2470 @item -Wstrict-aliasing
2471 @opindex Wstrict-aliasing
2472 This option is only active when @option{-fstrict-aliasing} is active.
2473 It warns about code which might break the strict aliasing rules that the
2474 compiler is using for optimization. The warning does not catch all
2475 cases, but does attempt to catch the more common pitfalls. It is
2476 included in @option{-Wall}.
2477
2478 @item -Wall
2479 @opindex Wall
2480 All of the above @samp{-W} options combined.  This enables all the
2481 warnings about constructions that some users consider questionable, and
2482 that are easy to avoid (or modify to prevent the warning), even in
2483 conjunction with macros.  This also enables some language-specific
2484 warnings described in @ref{C++ Dialect Options} and
2485 @ref{Objective-C Dialect Options}.
2486 @end table
2487
2488 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2489 Some of them warn about constructions that users generally do not
2490 consider questionable, but which occasionally you might wish to check
2491 for; others warn about constructions that are necessary or hard to avoid
2492 in some cases, and there is no simple way to modify the code to suppress
2493 the warning.
2494
2495 @table @gcctabopt
2496 @item -Wextra
2497 @opindex W
2498 @opindex Wextra
2499 (This option used to be called @option{-W}.  The older name is still
2500 supported, but the newer name is more descriptive.)  Print extra warning
2501 messages for these events:
2502
2503 @itemize @bullet
2504 @item
2505 A function can return either with or without a value.  (Falling
2506 off the end of the function body is considered returning without
2507 a value.)  For example, this function would evoke such a
2508 warning:
2509
2510 @smallexample
2511 @group
2512 foo (a)
2513 @{
2514   if (a > 0)
2515     return a;
2516 @}
2517 @end group
2518 @end smallexample
2519
2520 @item
2521 An expression-statement or the left-hand side of a comma expression
2522 contains no side effects.
2523 To suppress the warning, cast the unused expression to void.
2524 For example, an expression such as @samp{x[i,j]} will cause a warning,
2525 but @samp{x[(void)i,j]} will not.
2526
2527 @item
2528 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2529
2530 @item
2531 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2532 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2533 that of ordinary mathematical notation.
2534
2535 @item
2536 Storage-class specifiers like @code{static} are not the first things in
2537 a declaration.  According to the C Standard, this usage is obsolescent.
2538
2539 @item
2540 The return type of a function has a type qualifier such as @code{const}.
2541 Such a type qualifier has no effect, since the value returned by a
2542 function is not an lvalue.  (But don't warn about the GNU extension of
2543 @code{volatile void} return types.  That extension will be warned about
2544 if @option{-pedantic} is specified.)
2545
2546 @item
2547 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2548 arguments.
2549
2550 @item
2551 A comparison between signed and unsigned values could produce an
2552 incorrect result when the signed value is converted to unsigned.
2553 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2554
2555 @item
2556 An aggregate has an initializer which does not initialize all members.
2557 For example, the following code would cause such a warning, because
2558 @code{x.h} would be implicitly initialized to zero:
2559
2560 @smallexample
2561 struct s @{ int f, g, h; @};
2562 struct s x = @{ 3, 4 @};
2563 @end smallexample
2564
2565 @item
2566 A function parameter is declared without a type specifier in K&R-style
2567 functions:
2568
2569 @smallexample
2570 void foo(bar) @{ @}
2571 @end smallexample
2572
2573 @item
2574 An empty body occurs in an @samp{if} or @samp{else} statement.
2575
2576 @item
2577 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2578 @samp{>}, or @samp{>=}.
2579
2580 @item
2581 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2582
2583 @item
2584 Any of several floating-point events that often indicate errors, such as
2585 overflow, underflow, loss of precision, etc.
2586
2587 @item @r{(C++ only)}
2588 An enumerator and a non-enumerator both appear in a conditional expression.
2589
2590 @item @r{(C++ only)}
2591 A non-static reference or non-static @samp{const} member appears in a
2592 class without constructors.
2593
2594 @item @r{(C++ only)}
2595 Ambiguous virtual bases.
2596
2597 @item @r{(C++ only)}
2598 Subscripting an array which has been declared @samp{register}.
2599
2600 @item @r{(C++ only)}
2601 Taking the address of a variable which has been declared @samp{register}.
2602
2603 @item @r{(C++ only)}
2604 A base class is not initialized in a derived class' copy constructor.
2605 @end itemize
2606
2607 @item -Wno-div-by-zero
2608 @opindex Wno-div-by-zero
2609 @opindex Wdiv-by-zero
2610 Do not warn about compile-time integer division by zero.  Floating point
2611 division by zero is not warned about, as it can be a legitimate way of
2612 obtaining infinities and NaNs.
2613
2614 @item -Wsystem-headers
2615 @opindex Wsystem-headers
2616 @cindex warnings from system headers
2617 @cindex system headers, warnings from
2618 Print warning messages for constructs found in system header files.
2619 Warnings from system headers are normally suppressed, on the assumption
2620 that they usually do not indicate real problems and would only make the
2621 compiler output harder to read.  Using this command line option tells
2622 GCC to emit warnings from system headers as if they occurred in user
2623 code.  However, note that using @option{-Wall} in conjunction with this
2624 option will @emph{not} warn about unknown pragmas in system
2625 headers---for that, @option{-Wunknown-pragmas} must also be used.
2626
2627 @item -Wfloat-equal
2628 @opindex Wfloat-equal
2629 Warn if floating point values are used in equality comparisons.
2630
2631 The idea behind this is that sometimes it is convenient (for the
2632 programmer) to consider floating-point values as approximations to
2633 infinitely precise real numbers.  If you are doing this, then you need
2634 to compute (by analyzing the code, or in some other way) the maximum or
2635 likely maximum error that the computation introduces, and allow for it
2636 when performing comparisons (and when producing output, but that's a
2637 different problem).  In particular, instead of testing for equality, you
2638 would check to see whether the two values have ranges that overlap; and
2639 this is done with the relational operators, so equality comparisons are
2640 probably mistaken.
2641
2642 @item -Wtraditional @r{(C only)}
2643 @opindex Wtraditional
2644 Warn about certain constructs that behave differently in traditional and
2645 ISO C@.  Also warn about ISO C constructs that have no traditional C
2646 equivalent, and/or problematic constructs which should be avoided.
2647
2648 @itemize @bullet
2649 @item
2650 Macro parameters that appear within string literals in the macro body.
2651 In traditional C macro replacement takes place within string literals,
2652 but does not in ISO C@.
2653
2654 @item
2655 In traditional C, some preprocessor directives did not exist.
2656 Traditional preprocessors would only consider a line to be a directive
2657 if the @samp{#} appeared in column 1 on the line.  Therefore
2658 @option{-Wtraditional} warns about directives that traditional C
2659 understands but would ignore because the @samp{#} does not appear as the
2660 first character on the line.  It also suggests you hide directives like
2661 @samp{#pragma} not understood by traditional C by indenting them.  Some
2662 traditional implementations would not recognize @samp{#elif}, so it
2663 suggests avoiding it altogether.
2664
2665 @item
2666 A function-like macro that appears without arguments.
2667
2668 @item
2669 The unary plus operator.
2670
2671 @item
2672 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2673 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2674 constants.)  Note, these suffixes appear in macros defined in the system
2675 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2676 Use of these macros in user code might normally lead to spurious
2677 warnings, however GCC's integrated preprocessor has enough context to
2678 avoid warning in these cases.
2679
2680 @item
2681 A function declared external in one block and then used after the end of
2682 the block.
2683
2684 @item
2685 A @code{switch} statement has an operand of type @code{long}.
2686
2687 @item
2688 A non-@code{static} function declaration follows a @code{static} one.
2689 This construct is not accepted by some traditional C compilers.
2690
2691 @item
2692 The ISO type of an integer constant has a different width or
2693 signedness from its traditional type.  This warning is only issued if
2694 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2695 typically represent bit patterns, are not warned about.
2696
2697 @item
2698 Usage of ISO string concatenation is detected.
2699
2700 @item
2701 Initialization of automatic aggregates.
2702
2703 @item
2704 Identifier conflicts with labels.  Traditional C lacks a separate
2705 namespace for labels.
2706
2707 @item
2708 Initialization of unions.  If the initializer is zero, the warning is
2709 omitted.  This is done under the assumption that the zero initializer in
2710 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2711 initializer warnings and relies on default initialization to zero in the
2712 traditional C case.
2713
2714 @item
2715 Conversions by prototypes between fixed/floating point values and vice
2716 versa.  The absence of these prototypes when compiling with traditional
2717 C would cause serious problems.  This is a subset of the possible
2718 conversion warnings, for the full set use @option{-Wconversion}.
2719
2720 @item
2721 Use of ISO C style function definitions.  This warning intentionally is
2722 @emph{not} issued for prototype declarations or variadic functions
2723 because these ISO C features will appear in your code when using
2724 libiberty's traditional C compatibility macros, @code{PARAMS} and
2725 @code{VPARAMS}.  This warning is also bypassed for nested functions
2726 because that feature is already a GCC extension and thus not relevant to
2727 traditional C compatibility.
2728 @end itemize
2729
2730 @item -Wdeclaration-after-statement @r{(C only)}
2731 @opindex Wdeclaration-after-statement
2732 Warn when a declaration is found after a statement in a block.  This
2733 construct, known from C++, was introduced with ISO C99 and is by default
2734 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2735 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2736
2737 @item -Wundef
2738 @opindex Wundef
2739 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2740
2741 @item -Wendif-labels
2742 @opindex Wendif-labels
2743 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2744
2745 @item -Wshadow
2746 @opindex Wshadow
2747 Warn whenever a local variable shadows another local variable, parameter or
2748 global variable or whenever a built-in function is shadowed.
2749
2750 @item -Wlarger-than-@var{len}
2751 @opindex Wlarger-than
2752 Warn whenever an object of larger than @var{len} bytes is defined.
2753
2754 @item -Wpointer-arith
2755 @opindex Wpointer-arith
2756 Warn about anything that depends on the ``size of'' a function type or
2757 of @code{void}.  GNU C assigns these types a size of 1, for
2758 convenience in calculations with @code{void *} pointers and pointers
2759 to functions.
2760
2761 @item -Wbad-function-cast @r{(C only)}
2762 @opindex Wbad-function-cast
2763 Warn whenever a function call is cast to a non-matching type.
2764 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2765
2766 @item -Wcast-qual
2767 @opindex Wcast-qual
2768 Warn whenever a pointer is cast so as to remove a type qualifier from
2769 the target type.  For example, warn if a @code{const char *} is cast
2770 to an ordinary @code{char *}.
2771
2772 @item -Wcast-align
2773 @opindex Wcast-align
2774 Warn whenever a pointer is cast such that the required alignment of the
2775 target is increased.  For example, warn if a @code{char *} is cast to
2776 an @code{int *} on machines where integers can only be accessed at
2777 two- or four-byte boundaries.
2778
2779 @item -Wwrite-strings
2780 @opindex Wwrite-strings
2781 When compiling C, give string constants the type @code{const
2782 char[@var{length}]} so that
2783 copying the address of one into a non-@code{const} @code{char *}
2784 pointer will get a warning; when compiling C++, warn about the
2785 deprecated conversion from string constants to @code{char *}.
2786 These warnings will help you find at
2787 compile time code that can try to write into a string constant, but
2788 only if you have been very careful about using @code{const} in
2789 declarations and prototypes.  Otherwise, it will just be a nuisance;
2790 this is why we did not make @option{-Wall} request these warnings.
2791
2792 @item -Wconversion
2793 @opindex Wconversion
2794 Warn if a prototype causes a type conversion that is different from what
2795 would happen to the same argument in the absence of a prototype.  This
2796 includes conversions of fixed point to floating and vice versa, and
2797 conversions changing the width or signedness of a fixed point argument
2798 except when the same as the default promotion.
2799
2800 Also, warn if a negative integer constant expression is implicitly
2801 converted to an unsigned type.  For example, warn about the assignment
2802 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2803 casts like @code{(unsigned) -1}.
2804
2805 @item -Wsign-compare
2806 @opindex Wsign-compare
2807 @cindex warning for comparison of signed and unsigned values
2808 @cindex comparison of signed and unsigned values, warning
2809 @cindex signed and unsigned values, comparison warning
2810 Warn when a comparison between signed and unsigned values could produce
2811 an incorrect result when the signed value is converted to unsigned.
2812 This warning is also enabled by @option{-Wextra}; to get the other warnings
2813 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2814
2815 @item -Waggregate-return
2816 @opindex Waggregate-return
2817 Warn if any functions that return structures or unions are defined or
2818 called.  (In languages where you can return an array, this also elicits
2819 a warning.)
2820
2821 @item -Wstrict-prototypes @r{(C only)}
2822 @opindex Wstrict-prototypes
2823 Warn if a function is declared or defined without specifying the
2824 argument types.  (An old-style function definition is permitted without
2825 a warning if preceded by a declaration which specifies the argument
2826 types.)
2827
2828 @item -Wold-style-definition @r{(C only)}
2829 @opindex Wold-style-definition
2830 Warn if an old-style function definition is used.  A warning is given
2831 even if there is a previous prototype.
2832
2833 @item -Wmissing-prototypes @r{(C only)}
2834 @opindex Wmissing-prototypes
2835 Warn if a global function is defined without a previous prototype
2836 declaration.  This warning is issued even if the definition itself
2837 provides a prototype.  The aim is to detect global functions that fail
2838 to be declared in header files.
2839
2840 @item -Wmissing-declarations @r{(C only)}
2841 @opindex Wmissing-declarations
2842 Warn if a global function is defined without a previous declaration.
2843 Do so even if the definition itself provides a prototype.
2844 Use this option to detect global functions that are not declared in
2845 header files.
2846
2847 @item -Wmissing-noreturn
2848 @opindex Wmissing-noreturn
2849 Warn about functions which might be candidates for attribute @code{noreturn}.
2850 Note these are only possible candidates, not absolute ones.  Care should
2851 be taken to manually verify functions actually do not ever return before
2852 adding the @code{noreturn} attribute, otherwise subtle code generation
2853 bugs could be introduced.  You will not get a warning for @code{main} in
2854 hosted C environments.
2855
2856 @item -Wmissing-format-attribute
2857 @opindex Wmissing-format-attribute
2858 @opindex Wformat
2859 If @option{-Wformat} is enabled, also warn about functions which might be
2860 candidates for @code{format} attributes.  Note these are only possible
2861 candidates, not absolute ones.  GCC will guess that @code{format}
2862 attributes might be appropriate for any function that calls a function
2863 like @code{vprintf} or @code{vscanf}, but this might not always be the
2864 case, and some functions for which @code{format} attributes are
2865 appropriate may not be detected.  This option has no effect unless
2866 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2867
2868 @item -Wno-multichar
2869 @opindex Wno-multichar
2870 @opindex Wmultichar
2871 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2872 Usually they indicate a typo in the user's code, as they have
2873 implementation-defined values, and should not be used in portable code.
2874
2875 @item -Wno-deprecated-declarations
2876 @opindex Wno-deprecated-declarations
2877 Do not warn about uses of functions, variables, and types marked as
2878 deprecated by using the @code{deprecated} attribute.
2879 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2880 @pxref{Type Attributes}.)
2881
2882 @item -Wpacked
2883 @opindex Wpacked
2884 Warn if a structure is given the packed attribute, but the packed
2885 attribute has no effect on the layout or size of the structure.
2886 Such structures may be mis-aligned for little benefit.  For
2887 instance, in this code, the variable @code{f.x} in @code{struct bar}
2888 will be misaligned even though @code{struct bar} does not itself
2889 have the packed attribute:
2890
2891 @smallexample
2892 @group
2893 struct foo @{
2894   int x;
2895   char a, b, c, d;
2896 @} __attribute__((packed));
2897 struct bar @{
2898   char z;
2899   struct foo f;
2900 @};
2901 @end group
2902 @end smallexample
2903
2904 @item -Wpadded
2905 @opindex Wpadded
2906 Warn if padding is included in a structure, either to align an element
2907 of the structure or to align the whole structure.  Sometimes when this
2908 happens it is possible to rearrange the fields of the structure to
2909 reduce the padding and so make the structure smaller.
2910
2911 @item -Wredundant-decls
2912 @opindex Wredundant-decls
2913 Warn if anything is declared more than once in the same scope, even in
2914 cases where multiple declaration is valid and changes nothing.
2915
2916 @item -Wnested-externs @r{(C only)}
2917 @opindex Wnested-externs
2918 Warn if an @code{extern} declaration is encountered within a function.
2919
2920 @item -Wunreachable-code
2921 @opindex Wunreachable-code
2922 Warn if the compiler detects that code will never be executed.
2923
2924 This option is intended to warn when the compiler detects that at
2925 least a whole line of source code will never be executed, because
2926 some condition is never satisfied or because it is after a
2927 procedure that never returns.
2928
2929 It is possible for this option to produce a warning even though there
2930 are circumstances under which part of the affected line can be executed,
2931 so care should be taken when removing apparently-unreachable code.
2932
2933 For instance, when a function is inlined, a warning may mean that the
2934 line is unreachable in only one inlined copy of the function.
2935
2936 This option is not made part of @option{-Wall} because in a debugging
2937 version of a program there is often substantial code which checks
2938 correct functioning of the program and is, hopefully, unreachable
2939 because the program does work.  Another common use of unreachable
2940 code is to provide behavior which is selectable at compile-time.
2941
2942 @item -Winline
2943 @opindex Winline
2944 Warn if a function can not be inlined and it was declared as inline.
2945 Even with this option, the compiler will not warn about failures to
2946 inline functions declared in system headers.
2947
2948 The compiler uses a variety of heuristics to determine whether or not
2949 to inline a function.  For example, the compiler takes into account
2950 the size of the function being inlined and the the amount of inlining
2951 that has already been done in the current function.  Therefore,
2952 seemingly insignificant changes in the source program can cause the
2953 warnings produced by @option{-Winline} to appear or disappear.
2954
2955 @item -Wno-invalid-offsetof @r{(C++ only)}
2956 @opindex Wno-invalid-offsetof
2957 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2958 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2959 to a non-POD type is undefined.  In existing C++ implementations,
2960 however, @samp{offsetof} typically gives meaningful results even when
2961 applied to certain kinds of non-POD types. (Such as a simple
2962 @samp{struct} that fails to be a POD type only by virtue of having a
2963 constructor.)  This flag is for users who are aware that they are
2964 writing nonportable code and who have deliberately chosen to ignore the
2965 warning about it.
2966
2967 The restrictions on @samp{offsetof} may be relaxed in a future version
2968 of the C++ standard.
2969
2970 @item -Winvalid-pch
2971 @opindex Winvalid-pch
2972 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2973 the search path but can't be used.
2974
2975 @item -Wlong-long
2976 @opindex Wlong-long
2977 @opindex Wno-long-long
2978 Warn if @samp{long long} type is used.  This is default.  To inhibit
2979 the warning messages, use @option{-Wno-long-long}.  Flags
2980 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2981 only when @option{-pedantic} flag is used.
2982
2983 @item -Wdisabled-optimization
2984 @opindex Wdisabled-optimization
2985 Warn if a requested optimization pass is disabled.  This warning does
2986 not generally indicate that there is anything wrong with your code; it
2987 merely indicates that GCC's optimizers were unable to handle the code
2988 effectively.  Often, the problem is that your code is too big or too
2989 complex; GCC will refuse to optimize programs when the optimization
2990 itself is likely to take inordinate amounts of time.
2991
2992 @item -Werror
2993 @opindex Werror
2994 Make all warnings into errors.
2995 @end table
2996
2997 @node Debugging Options
2998 @section Options for Debugging Your Program or GCC
2999 @cindex options, debugging
3000 @cindex debugging information options
3001
3002 GCC has various special options that are used for debugging
3003 either your program or GCC:
3004
3005 @table @gcctabopt
3006 @item -g
3007 @opindex g
3008 Produce debugging information in the operating system's native format
3009 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3010 information.
3011
3012 On most systems that use stabs format, @option{-g} enables use of extra
3013 debugging information that only GDB can use; this extra information
3014 makes debugging work better in GDB but will probably make other debuggers
3015 crash or
3016 refuse to read the program.  If you want to control for certain whether
3017 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3018 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3019
3020 Unlike most other C compilers, GCC allows you to use @option{-g} with
3021 @option{-O}.  The shortcuts taken by optimized code may occasionally
3022 produce surprising results: some variables you declared may not exist
3023 at all; flow of control may briefly move where you did not expect it;
3024 some statements may not be executed because they compute constant
3025 results or their values were already at hand; some statements may
3026 execute in different places because they were moved out of loops.
3027
3028 Nevertheless it proves possible to debug optimized output.  This makes
3029 it reasonable to use the optimizer for programs that might have bugs.
3030
3031 The following options are useful when GCC is generated with the
3032 capability for more than one debugging format.
3033
3034 @item -ggdb
3035 @opindex ggdb
3036 Produce debugging information for use by GDB@.  This means to use the
3037 most expressive format available (DWARF 2, stabs, or the native format
3038 if neither of those are supported), including GDB extensions if at all
3039 possible.
3040
3041 @item -gstabs
3042 @opindex gstabs
3043 Produce debugging information in stabs format (if that is supported),
3044 without GDB extensions.  This is the format used by DBX on most BSD
3045 systems.  On MIPS, Alpha and System V Release 4 systems this option
3046 produces stabs debugging output which is not understood by DBX or SDB@.
3047 On System V Release 4 systems this option requires the GNU assembler.
3048
3049 @item -feliminate-unused-debug-symbols
3050 @opindex feliminate-unused-debug-symbols
3051 Produce debugging information in stabs format (if that is supported),
3052 for only symbols that are actually used.
3053
3054 @item -gstabs+
3055 @opindex gstabs+
3056 Produce debugging information in stabs format (if that is supported),
3057 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3058 use of these extensions is likely to make other debuggers crash or
3059 refuse to read the program.
3060
3061 @item -gcoff
3062 @opindex gcoff
3063 Produce debugging information in COFF format (if that is supported).
3064 This is the format used by SDB on most System V systems prior to
3065 System V Release 4.
3066
3067 @item -gxcoff
3068 @opindex gxcoff
3069 Produce debugging information in XCOFF format (if that is supported).
3070 This is the format used by the DBX debugger on IBM RS/6000 systems.
3071
3072 @item -gxcoff+
3073 @opindex gxcoff+
3074 Produce debugging information in XCOFF format (if that is supported),
3075 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3076 use of these extensions is likely to make other debuggers crash or
3077 refuse to read the program, and may cause assemblers other than the GNU
3078 assembler (GAS) to fail with an error.
3079
3080 @item -gdwarf-2
3081 @opindex gdwarf-2
3082 Produce debugging information in DWARF version 2 format (if that is
3083 supported).  This is the format used by DBX on IRIX 6.
3084
3085 @item -gvms
3086 @opindex gvms
3087 Produce debugging information in VMS debug format (if that is
3088 supported).  This is the format used by DEBUG on VMS systems.
3089
3090 @item -g@var{level}
3091 @itemx -ggdb@var{level}
3092 @itemx -gstabs@var{level}
3093 @itemx -gcoff@var{level}
3094 @itemx -gxcoff@var{level}
3095 @itemx -gvms@var{level}
3096 Request debugging information and also use @var{level} to specify how
3097 much information.  The default level is 2.
3098
3099 Level 1 produces minimal information, enough for making backtraces in
3100 parts of the program that you don't plan to debug.  This includes
3101 descriptions of functions and external variables, but no information
3102 about local variables and no line numbers.
3103
3104 Level 3 includes extra information, such as all the macro definitions
3105 present in the program.  Some debuggers support macro expansion when
3106 you use @option{-g3}.
3107
3108 Note that in order to avoid confusion between DWARF1 debug level 2,
3109 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3110 level.  Instead use an additional @option{-g@var{level}} option to
3111 change the debug level for DWARF2.
3112
3113 @item -feliminate-dwarf2-dups
3114 @opindex feliminate-dwarf2-dups
3115 Compress DWARF2 debugging information by eliminating duplicated
3116 information about each symbol.  This option only makes sense when
3117 generating DWARF2 debugging information with @option{-gdwarf-2}.
3118
3119 @cindex @command{prof}
3120 @item -p
3121 @opindex p
3122 Generate extra code to write profile information suitable for the
3123 analysis program @command{prof}.  You must use this option when compiling
3124 the source files you want data about, and you must also use it when
3125 linking.
3126
3127 @cindex @command{gprof}
3128 @item -pg
3129 @opindex pg
3130 Generate extra code to write profile information suitable for the
3131 analysis program @command{gprof}.  You must use this option when compiling
3132 the source files you want data about, and you must also use it when
3133 linking.
3134
3135 @item -Q
3136 @opindex Q
3137 Makes the compiler print out each function name as it is compiled, and
3138 print some statistics about each pass when it finishes.
3139
3140 @item -ftime-report
3141 @opindex ftime-report
3142 Makes the compiler print some statistics about the time consumed by each
3143 pass when it finishes.
3144
3145 @item -fmem-report
3146 @opindex fmem-report
3147 Makes the compiler print some statistics about permanent memory
3148 allocation when it finishes.
3149
3150 @item -fprofile-arcs
3151 @opindex fprofile-arcs
3152 Add code so that program flow @dfn{arcs} are instrumented.  During
3153 execution the program records how many times each branch and call is
3154 executed and how many times it is taken or returns.  When the compiled
3155 program exits it saves this data to a file called
3156 @file{@var{auxname}.gcda} for each source file. The data may be used for
3157 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3158 test coverage analysis (@option{-ftest-coverage}). Each object file's
3159 @var{auxname} is generated from the name of the output file, if
3160 explicitly specified and it is not the final executable, otherwise it is
3161 the basename of the source file. In both cases any suffix is removed
3162 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3163 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3164
3165 @itemize
3166
3167 @item
3168 Compile the source files with @option{-fprofile-arcs} plus optimization
3169 and code generation options. For test coverage analysis, use the
3170 additional @option{-ftest-coverage} option. You do not need to profile
3171 every source file in a program.
3172
3173 @item
3174 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3175 (the latter implies the former).
3176
3177 @item
3178 Run the program on a representative workload to generate the arc profile
3179 information. This may be repeated any number of times. You can run
3180 concurrent instances of your program, and provided that the file system
3181 supports locking, the data files will be correctly updated. Also
3182 @code{fork} calls are detected and correctly handled (double counting
3183 will not happen).
3184
3185 @item
3186 For profile-directed optimizations, compile the source files again with
3187 the same optimization and code generation options plus
3188 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3189 Control Optimization}).
3190
3191 @item
3192 For test coverage analysis, use @command{gcov} to produce human readable
3193 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3194 @command{gcov} documentation for further information.
3195
3196 @end itemize
3197
3198 With @option{-fprofile-arcs}, for each function of your program GCC
3199 creates a program flow graph, then finds a spanning tree for the graph.
3200 Only arcs that are not on the spanning tree have to be instrumented: the
3201 compiler adds code to count the number of times that these arcs are
3202 executed.  When an arc is the only exit or only entrance to a block, the
3203 instrumentation code can be added to the block; otherwise, a new basic
3204 block must be created to hold the instrumentation code.
3205
3206 @need 2000
3207 @item -ftest-coverage
3208 @opindex ftest-coverage
3209 Produce a notes file that the @command{gcov} code-coverage utility
3210 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3211 show program coverage. Each source file's note file is called
3212 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3213 above for a description of @var{auxname} and instructions on how to
3214 generate test coverage data. Coverage data will match the source files
3215 more closely, if you do not optimize.
3216
3217 @item -d@var{letters}
3218 @opindex d
3219 Says to make debugging dumps during compilation at times specified by
3220 @var{letters}.  This is used for debugging the compiler.  The file names
3221 for most of the dumps are made by appending a pass number and a word to
3222 the @var{dumpname}. @var{dumpname} is generated from the name of the
3223 output file, if explicitly specified and it is not an executable,
3224 otherwise it is the basename of the source file. In both cases any
3225 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3226 Here are the possible letters for use in @var{letters}, and their
3227 meanings:
3228
3229 @table @samp
3230 @item A
3231 @opindex dA
3232 Annotate the assembler output with miscellaneous debugging information.
3233 @item b
3234 @opindex db
3235 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3236 @item B
3237 @opindex dB
3238 Dump after block reordering, to @file{@var{file}.31.bbro}.
3239 @item c
3240 @opindex dc
3241 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3242 @item C
3243 @opindex dC
3244 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3245 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3246 @item d
3247 @opindex dd
3248 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3249 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3250 @item D
3251 @opindex dD
3252 Dump all macro definitions, at the end of preprocessing, in addition to
3253 normal output.
3254 @item E
3255 @opindex dE
3256 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3257 @item f
3258 @opindex df
3259 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3260 Also dump after life analysis, to @file{@var{file}.19.life}.
3261 @item F
3262 @opindex dF
3263 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3264 @item g
3265 @opindex dg
3266 Dump after global register allocation, to @file{@var{file}.25.greg}.
3267 @item G
3268 @opindex dG
3269 Dump after GCSE, to @file{@var{file}.08.gcse}.
3270 Also dump after jump bypassing and control flow optimizations, to
3271 @file{@var{file}.10.bypass}.
3272 @item h
3273 @opindex dh
3274 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3275 @item i
3276 @opindex di
3277 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3278 @item j
3279 @opindex dj
3280 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3281 @item k
3282 @opindex dk
3283 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3284 @item l
3285 @opindex dl
3286 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3287 @item L
3288 @opindex dL
3289 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3290 @file{@var{file}.16.loop2}.
3291 @item M
3292 @opindex dM
3293 Dump after performing the machine dependent reorganization pass, to
3294 @file{@var{file}.35.mach}.
3295 @item n
3296 @opindex dn
3297 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3298 @item N
3299 @opindex dN
3300 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3301 @item o
3302 @opindex do
3303 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3304 @item r
3305 @opindex dr
3306 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3307 @item R
3308 @opindex dR
3309 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3310 @item s
3311 @opindex ds
3312 Dump after CSE (including the jump optimization that sometimes follows
3313 CSE), to @file{@var{file}.06.cse}.
3314 @item S
3315 @opindex dS
3316 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3317 @item t
3318 @opindex dt
3319 Dump after the second CSE pass (including the jump optimization that
3320 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3321 @item T
3322 @opindex dT
3323 Dump after running tracer, to @file{@var{file}.15.tracer}.
3324 @item u
3325 @opindex du
3326 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3327 @item U
3328 @opindex dU
3329 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3330 @item V
3331 @opindex dV
3332 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3333 @item w
3334 @opindex dw
3335 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3336 @item z
3337 @opindex dz
3338 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3339 @item Z
3340 @opindex dZ
3341 Dump after constructing the web, to @file{@var{file}.17.web}.
3342 @item a
3343 @opindex da
3344 Produce all the dumps listed above.
3345 @item H
3346 @opindex dH
3347 Produce a core dump whenever an error occurs.
3348 @item m
3349 @opindex dm
3350 Print statistics on memory usage, at the end of the run, to
3351 standard error.
3352 @item p
3353 @opindex dp
3354 Annotate the assembler output with a comment indicating which
3355 pattern and alternative was used.  The length of each instruction is
3356 also printed.
3357 @item P
3358 @opindex dP
3359 Dump the RTL in the assembler output as a comment before each instruction.
3360 Also turns on @option{-dp} annotation.
3361 @item v
3362 @opindex dv
3363 For each of the other indicated dump files (except for
3364 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3365 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3366 @item x
3367 @opindex dx
3368 Just generate RTL for a function instead of compiling it.  Usually used
3369 with @samp{r}.
3370 @item y
3371 @opindex dy
3372 Dump debugging information during parsing, to standard error.
3373 @end table
3374
3375 @item -fdump-unnumbered
3376 @opindex fdump-unnumbered
3377 When doing debugging dumps (see @option{-d} option above), suppress instruction
3378 numbers and line number note output.  This makes it more feasible to
3379 use diff on debugging dumps for compiler invocations with different
3380 options, in particular with and without @option{-g}.
3381
3382 @item -fdump-translation-unit @r{(C and C++ only)}
3383 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3384 @opindex fdump-translation-unit
3385 Dump a representation of the tree structure for the entire translation
3386 unit to a file.  The file name is made by appending @file{.tu} to the
3387 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3388 controls the details of the dump as described for the
3389 @option{-fdump-tree} options.
3390
3391 @item -fdump-class-hierarchy @r{(C++ only)}
3392 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3393 @opindex fdump-class-hierarchy
3394 Dump a representation of each class's hierarchy and virtual function
3395 table layout to a file.  The file name is made by appending @file{.class}
3396 to the source file name.  If the @samp{-@var{options}} form is used,
3397 @var{options} controls the details of the dump as described for the
3398 @option{-fdump-tree} options.
3399
3400 @item -fdump-tree-@var{switch} @r{(C++ only)}
3401 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3402 @opindex fdump-tree
3403 Control the dumping at various stages of processing the intermediate
3404 language tree to a file.  The file name is generated by appending a switch
3405 specific suffix to the source file name.  If the @samp{-@var{options}}
3406 form is used, @var{options} is a list of @samp{-} separated options that
3407 control the details of the dump. Not all options are applicable to all
3408 dumps, those which are not meaningful will be ignored. The following
3409 options are available
3410
3411 @table @samp
3412 @item address
3413 Print the address of each node.  Usually this is not meaningful as it
3414 changes according to the environment and source file. Its primary use
3415 is for tying up a dump file with a debug environment.
3416 @item slim
3417 Inhibit dumping of members of a scope or body of a function merely
3418 because that scope has been reached. Only dump such items when they
3419 are directly reachable by some other path.
3420 @item all
3421 Turn on all options.
3422 @end table
3423
3424 The following tree dumps are possible:
3425 @table @samp
3426 @item original
3427 Dump before any tree based optimization, to @file{@var{file}.original}.
3428 @item optimized
3429 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3430 @item inlined
3431 Dump after function inlining, to @file{@var{file}.inlined}.
3432 @end table
3433
3434 @item -frandom-seed=@var{string}
3435 @opindex frandom-string
3436 This option provides a seed that GCC uses when it would otherwise use
3437 random numbers.  It is used to generate certain symbol names
3438 that have to be different in every compiled file. It is also used to
3439 place unique stamps in coverage data files and the object files that
3440 produce them. You can use the @option{-frandom-seed} option to produce
3441 reproducibly identical object files.
3442
3443 The @var{string} should be different for every file you compile.
3444
3445 @item -fsched-verbose=@var{n}
3446 @opindex fsched-verbose
3447 On targets that use instruction scheduling, this option controls the
3448 amount of debugging output the scheduler prints.  This information is
3449 written to standard error, unless @option{-dS} or @option{-dR} is
3450 specified, in which case it is output to the usual dump
3451 listing file, @file{.sched} or @file{.sched2} respectively.  However
3452 for @var{n} greater than nine, the output is always printed to standard
3453 error.
3454
3455 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3456 same information as @option{-dRS}.  For @var{n} greater than one, it
3457 also output basic block probabilities, detailed ready list information
3458 and unit/insn info.  For @var{n} greater than two, it includes RTL
3459 at abort point, control-flow and regions info.  And for @var{n} over
3460 four, @option{-fsched-verbose} also includes dependence info.
3461
3462 @item -save-temps
3463 @opindex save-temps
3464 Store the usual ``temporary'' intermediate files permanently; place them
3465 in the current directory and name them based on the source file.  Thus,
3466 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3467 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3468 preprocessed @file{foo.i} output file even though the compiler now
3469 normally uses an integrated preprocessor.
3470
3471 @item -time
3472 @opindex time
3473 Report the CPU time taken by each subprocess in the compilation
3474 sequence.  For C source files, this is the compiler proper and assembler
3475 (plus the linker if linking is done).  The output looks like this:
3476
3477 @smallexample
3478 # cc1 0.12 0.01
3479 # as 0.00 0.01
3480 @end smallexample
3481
3482 The first number on each line is the ``user time,'' that is time spent
3483 executing the program itself.  The second number is ``system time,''
3484 time spent executing operating system routines on behalf of the program.
3485 Both numbers are in seconds.
3486
3487 @item -print-file-name=@var{library}
3488 @opindex print-file-name
3489 Print the full absolute name of the library file @var{library} that
3490 would be used when linking---and don't do anything else.  With this
3491 option, GCC does not compile or link anything; it just prints the
3492 file name.
3493
3494 @item -print-multi-directory
3495 @opindex print-multi-directory
3496 Print the directory name corresponding to the multilib selected by any
3497 other switches present in the command line.  This directory is supposed
3498 to exist in @env{GCC_EXEC_PREFIX}.
3499
3500 @item -print-multi-lib
3501 @opindex print-multi-lib
3502 Print the mapping from multilib directory names to compiler switches
3503 that enable them.  The directory name is separated from the switches by
3504 @samp{;}, and each switch starts with an @samp{@@} instead of the
3505 @samp{-}, without spaces between multiple switches.  This is supposed to
3506 ease shell-processing.
3507
3508 @item -print-prog-name=@var{program}
3509 @opindex print-prog-name
3510 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3511
3512 @item -print-libgcc-file-name
3513 @opindex print-libgcc-file-name
3514 Same as @option{-print-file-name=libgcc.a}.
3515
3516 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3517 but you do want to link with @file{libgcc.a}.  You can do
3518
3519 @smallexample
3520 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3521 @end smallexample
3522
3523 @item -print-search-dirs
3524 @opindex print-search-dirs
3525 Print the name of the configured installation directory and a list of
3526 program and library directories @command{gcc} will search---and don't do anything else.
3527
3528 This is useful when @command{gcc} prints the error message
3529 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3530 To resolve this you either need to put @file{cpp0} and the other compiler
3531 components where @command{gcc} expects to find them, or you can set the environment
3532 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3533 Don't forget the trailing '/'.
3534 @xref{Environment Variables}.
3535
3536 @item -dumpmachine
3537 @opindex dumpmachine
3538 Print the compiler's target machine (for example,
3539 @samp{i686-pc-linux-gnu})---and don't do anything else.
3540
3541 @item -dumpversion
3542 @opindex dumpversion
3543 Print the compiler version (for example, @samp{3.0})---and don't do
3544 anything else.
3545
3546 @item -dumpspecs
3547 @opindex dumpspecs
3548 Print the compiler's built-in specs---and don't do anything else.  (This
3549 is used when GCC itself is being built.)  @xref{Spec Files}.
3550
3551 @item -feliminate-unused-debug-types
3552 @opindex feliminate-unused-debug-types
3553 Normally, when producing DWARF2 output, GCC will emit debugging
3554 information for all types declared in a compilation
3555 unit, regardless of whether or not they are actually used
3556 in that compilation unit.  Sometimes this is useful, such as
3557 if, in the debugger, you want to cast a value to a type that is
3558 not actually used in your program (but is declared).  More often,
3559 however, this results in a significant amount of wasted space.
3560 With this option, GCC will avoid producing debug symbol output
3561 for types that are nowhere used in the source file being compiled.
3562 @end table
3563
3564 @node Optimize Options
3565 @section Options That Control Optimization
3566 @cindex optimize options
3567 @cindex options, optimization
3568
3569 These options control various sorts of optimizations.
3570
3571 Without any optimization option, the compiler's goal is to reduce the
3572 cost of compilation and to make debugging produce the expected
3573 results.  Statements are independent: if you stop the program with a
3574 breakpoint between statements, you can then assign a new value to any
3575 variable or change the program counter to any other statement in the
3576 function and get exactly the results you would expect from the source
3577 code.
3578
3579 Turning on optimization flags makes the compiler attempt to improve
3580 the performance and/or code size at the expense of compilation time
3581 and possibly the ability to debug the program.
3582
3583 The compiler performs optimization based on the knowledge it has of
3584 the program.  Using the @option{-funit-at-a-time} flag will allow the
3585 compiler to consider information gained from later functions in the
3586 file when compiling a function.  Compiling multiple files at once to a
3587 single output file (and using @option{-funit-at-a-time}) will allow
3588 the compiler to use information gained from all of the files when
3589 compiling each of them.
3590
3591 Not all optimizations are controlled directly by a flag.  Only
3592 optimizations that have a flag are listed.
3593
3594 @table @gcctabopt
3595 @item -O
3596 @itemx -O1
3597 @opindex O
3598 @opindex O1
3599 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3600 more memory for a large function.
3601
3602 With @option{-O}, the compiler tries to reduce code size and execution
3603 time, without performing any optimizations that take a great deal of
3604 compilation time.
3605
3606 @option{-O} turns on the following optimization flags:
3607 @gccoptlist{-fdefer-pop @gol
3608 -fmerge-constants @gol
3609 -fthread-jumps @gol
3610 -floop-optimize @gol
3611 -fif-conversion @gol
3612 -fif-conversion2 @gol
3613 -fdelayed-branch @gol
3614 -fguess-branch-probability @gol
3615 -fcprop-registers}
3616
3617 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3618 where doing so does not interfere with debugging.
3619
3620 @item -O2
3621 @opindex O2
3622 Optimize even more.  GCC performs nearly all supported optimizations
3623 that do not involve a space-speed tradeoff.  The compiler does not
3624 perform loop unrolling or function inlining when you specify @option{-O2}.
3625 As compared to @option{-O}, this option increases both compilation time
3626 and the performance of the generated code.
3627
3628 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3629 also turns on the following optimization flags:
3630 @gccoptlist{-fforce-mem @gol
3631 -foptimize-sibling-calls @gol
3632 -fstrength-reduce @gol
3633 -fcse-follow-jumps  -fcse-skip-blocks @gol
3634 -frerun-cse-after-loop  -frerun-loop-opt @gol
3635 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3636 -fdelete-null-pointer-checks @gol
3637 -fexpensive-optimizations @gol
3638 -fregmove @gol
3639 -fschedule-insns  -fschedule-insns2 @gol
3640 -fsched-interblock  -fsched-spec @gol
3641 -fcaller-saves @gol
3642 -fpeephole2 @gol
3643 -freorder-blocks  -freorder-functions @gol
3644 -fstrict-aliasing @gol
3645 -funit-at-a-time @gol
3646 -falign-functions  -falign-jumps @gol
3647 -falign-loops  -falign-labels @gol
3648 -fcrossjumping}
3649
3650 Please note the warning under @option{-fgcse} about
3651 invoking @option{-O2} on programs that use computed gotos.
3652
3653 @item -O3
3654 @opindex O3
3655 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3656 @option{-O2} and also turns on the @option{-finline-functions},
3657 @option{-fweb} and @option{-frename-registers} options.
3658
3659 @item -O0
3660 @opindex O0
3661 Do not optimize.  This is the default.
3662
3663 @item -Os
3664 @opindex Os
3665 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3666 do not typically increase code size.  It also performs further
3667 optimizations designed to reduce code size.
3668
3669 @option{-Os} disables the following optimization flags:
3670 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3671 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3672
3673 If you use multiple @option{-O} options, with or without level numbers,
3674 the last such option is the one that is effective.
3675 @end table
3676
3677 Options of the form @option{-f@var{flag}} specify machine-independent
3678 flags.  Most flags have both positive and negative forms; the negative
3679 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3680 below, only one of the forms is listed---the one you typically will
3681 use.  You can figure out the other form by either removing @samp{no-}
3682 or adding it.
3683
3684 The following options control specific optimizations.  They are either
3685 activated by @option{-O} options or are related to ones that are.  You
3686 can use the following flags in the rare cases when ``fine-tuning'' of
3687 optimizations to be performed is desired.
3688
3689 @table @gcctabopt
3690 @item -fno-default-inline
3691 @opindex fno-default-inline
3692 Do not make member functions inline by default merely because they are
3693 defined inside the class scope (C++ only).  Otherwise, when you specify
3694 @w{@option{-O}}, member functions defined inside class scope are compiled
3695 inline by default; i.e., you don't need to add @samp{inline} in front of
3696 the member function name.
3697
3698 @item -fno-defer-pop
3699 @opindex fno-defer-pop
3700 Always pop the arguments to each function call as soon as that function
3701 returns.  For machines which must pop arguments after a function call,
3702 the compiler normally lets arguments accumulate on the stack for several
3703 function calls and pops them all at once.
3704
3705 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3706
3707 @item -fforce-mem
3708 @opindex fforce-mem
3709 Force memory operands to be copied into registers before doing
3710 arithmetic on them.  This produces better code by making all memory
3711 references potential common subexpressions.  When they are not common
3712 subexpressions, instruction combination should eliminate the separate
3713 register-load.
3714
3715 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3716
3717 @item -fforce-addr
3718 @opindex fforce-addr
3719 Force memory address constants to be copied into registers before
3720 doing arithmetic on them.  This may produce better code just as
3721 @option{-fforce-mem} may.
3722
3723 @item -fomit-frame-pointer
3724 @opindex fomit-frame-pointer
3725 Don't keep the frame pointer in a register for functions that
3726 don't need one.  This avoids the instructions to save, set up and
3727 restore frame pointers; it also makes an extra register available
3728 in many functions.  @strong{It also makes debugging impossible on
3729 some machines.}
3730
3731 On some machines, such as the VAX, this flag has no effect, because
3732 the standard calling sequence automatically handles the frame pointer
3733 and nothing is saved by pretending it doesn't exist.  The
3734 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3735 whether a target machine supports this flag.  @xref{Registers,,Register
3736 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3737
3738 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3739
3740 @item -foptimize-sibling-calls
3741 @opindex foptimize-sibling-calls
3742 Optimize sibling and tail recursive calls.
3743
3744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3745
3746 @item -fno-inline
3747 @opindex fno-inline
3748 Don't pay attention to the @code{inline} keyword.  Normally this option
3749 is used to keep the compiler from expanding any functions inline.
3750 Note that if you are not optimizing, no functions can be expanded inline.
3751
3752 @item -finline-functions
3753 @opindex finline-functions
3754 Integrate all simple functions into their callers.  The compiler
3755 heuristically decides which functions are simple enough to be worth
3756 integrating in this way.
3757
3758 If all calls to a given function are integrated, and the function is
3759 declared @code{static}, then the function is normally not output as
3760 assembler code in its own right.
3761
3762 Enabled at level @option{-O3}.
3763
3764 @item -finline-limit=@var{n}
3765 @opindex finline-limit
3766 By default, GCC limits the size of functions that can be inlined.  This flag
3767 allows the control of this limit for functions that are explicitly marked as
3768 inline (i.e., marked with the inline keyword or defined within the class
3769 definition in c++).  @var{n} is the size of functions that can be inlined in
3770 number of pseudo instructions (not counting parameter handling).  The default
3771 value of @var{n} is 600.
3772 Increasing this value can result in more inlined code at
3773 the cost of compilation time and memory consumption.  Decreasing usually makes
3774 the compilation faster and less code will be inlined (which presumably
3775 means slower programs).  This option is particularly useful for programs that
3776 use inlining heavily such as those based on recursive templates with C++.
3777
3778 Inlining is actually controlled by a number of parameters, which may be
3779 specified individually by using @option{--param @var{name}=@var{value}}.
3780 The @option{-finline-limit=@var{n}} option sets some of these parameters
3781 as follows:
3782
3783 @table @gcctabopt
3784  @item max-inline-insns-single
3785   is set to @var{n}/2.
3786  @item max-inline-insns-auto
3787   is set to @var{n}/2.
3788  @item min-inline-insns
3789   is set to 130 or @var{n}/4, whichever is smaller.
3790  @item max-inline-insns-rtl
3791   is set to @var{n}.
3792 @end table
3793
3794 See below for a documentation of the individual
3795 parameters controlling inlining.
3796
3797 @emph{Note:} pseudo instruction represents, in this particular context, an
3798 abstract measurement of function's size.  In no way, it represents a count
3799 of assembly instructions and as such its exact meaning might change from one
3800 release to an another.
3801
3802 @item -fkeep-inline-functions
3803 @opindex fkeep-inline-functions
3804 Even if all calls to a given function are integrated, and the function
3805 is declared @code{static}, nevertheless output a separate run-time
3806 callable version of the function.  This switch does not affect
3807 @code{extern inline} functions.
3808
3809 @item -fkeep-static-consts
3810 @opindex fkeep-static-consts
3811 Emit variables declared @code{static const} when optimization isn't turned
3812 on, even if the variables aren't referenced.
3813
3814 GCC enables this option by default.  If you want to force the compiler to
3815 check if the variable was referenced, regardless of whether or not
3816 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3817
3818 @item -fmerge-constants
3819 Attempt to merge identical constants (string constants and floating point
3820 constants) across compilation units.
3821
3822 This option is the default for optimized compilation if the assembler and
3823 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3824 behavior.
3825
3826 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3827
3828 @item -fmerge-all-constants
3829 Attempt to merge identical constants and identical variables.
3830
3831 This option implies @option{-fmerge-constants}.  In addition to
3832 @option{-fmerge-constants} this considers e.g. even constant initialized
3833 arrays or initialized constant variables with integral or floating point
3834 types.  Languages like C or C++ require each non-automatic variable to
3835 have distinct location, so using this option will result in non-conforming
3836 behavior.
3837
3838 @item -fnew-ra
3839 @opindex fnew-ra
3840 Use a graph coloring register allocator.  Currently this option is meant
3841 only for testing.  Users should not specify this option, since it is not
3842 yet ready for production use.
3843
3844 @item -fno-branch-count-reg
3845 @opindex fno-branch-count-reg
3846 Do not use ``decrement and branch'' instructions on a count register,
3847 but instead generate a sequence of instructions that decrement a
3848 register, compare it against zero, then branch based upon the result.
3849 This option is only meaningful on architectures that support such
3850 instructions, which include x86, PowerPC, IA-64 and S/390.
3851
3852 The default is @option{-fbranch-count-reg}, enabled when
3853 @option{-fstrength-reduce} is enabled.
3854
3855 @item -fno-function-cse
3856 @opindex fno-function-cse
3857 Do not put function addresses in registers; make each instruction that
3858 calls a constant function contain the function's address explicitly.
3859
3860 This option results in less efficient code, but some strange hacks
3861 that alter the assembler output may be confused by the optimizations
3862 performed when this option is not used.
3863
3864 The default is @option{-ffunction-cse}
3865
3866 @item -fno-zero-initialized-in-bss
3867 @opindex fno-zero-initialized-in-bss
3868 If the target supports a BSS section, GCC by default puts variables that
3869 are initialized to zero into BSS@.  This can save space in the resulting
3870 code.
3871
3872 This option turns off this behavior because some programs explicitly
3873 rely on variables going to the data section.  E.g., so that the
3874 resulting executable can find the beginning of that section and/or make
3875 assumptions based on that.
3876
3877 The default is @option{-fzero-initialized-in-bss}.
3878
3879 @item -fstrength-reduce
3880 @opindex fstrength-reduce
3881 Perform the optimizations of loop strength reduction and
3882 elimination of iteration variables.
3883
3884 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3885
3886 @item -fthread-jumps
3887 @opindex fthread-jumps
3888 Perform optimizations where we check to see if a jump branches to a
3889 location where another comparison subsumed by the first is found.  If
3890 so, the first branch is redirected to either the destination of the
3891 second branch or a point immediately following it, depending on whether
3892 the condition is known to be true or false.
3893
3894 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3895
3896 @item -fcse-follow-jumps
3897 @opindex fcse-follow-jumps
3898 In common subexpression elimination, scan through jump instructions
3899 when the target of the jump is not reached by any other path.  For
3900 example, when CSE encounters an @code{if} statement with an
3901 @code{else} clause, CSE will follow the jump when the condition
3902 tested is false.
3903
3904 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3905
3906 @item -fcse-skip-blocks
3907 @opindex fcse-skip-blocks
3908 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3909 follow jumps which conditionally skip over blocks.  When CSE
3910 encounters a simple @code{if} statement with no else clause,
3911 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3912 body of the @code{if}.
3913
3914 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3915
3916 @item -frerun-cse-after-loop
3917 @opindex frerun-cse-after-loop
3918 Re-run common subexpression elimination after loop optimizations has been
3919 performed.
3920
3921 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3922
3923 @item -frerun-loop-opt
3924 @opindex frerun-loop-opt
3925 Run the loop optimizer twice.
3926
3927 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3928
3929 @item -fgcse
3930 @opindex fgcse
3931 Perform a global common subexpression elimination pass.
3932 This pass also performs global constant and copy propagation.
3933
3934 @emph{Note:} When compiling a program using computed gotos, a GCC
3935 extension, you may get better runtime performance if you disable
3936 the global common subexpression elimination pass by adding
3937 @option{-fno-gcse} to the command line.
3938
3939 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3940
3941 @item -fgcse-lm
3942 @opindex fgcse-lm
3943 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3944 attempt to move loads which are only killed by stores into themselves.  This
3945 allows a loop containing a load/store sequence to be changed to a load outside
3946 the loop, and a copy/store within the loop.
3947
3948 Enabled by default when gcse is enabled.
3949
3950 @item -fgcse-sm
3951 @opindex fgcse-sm
3952 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3953 global common subexpression elimination.  This pass will attempt to move
3954 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3955 loops containing a load/store sequence can be changed to a load before
3956 the loop and a store after the loop.
3957
3958 Enabled by default when gcse is enabled.
3959
3960 @item -fgcse-las
3961 @opindex fgcse-las
3962 When @option{-fgcse-las} is enabled, the global common subexpression
3963 elimination pass eliminates redundant loads that come after stores to the
3964 same memory location (both partial and full redundancies).
3965
3966 Enabled by default when gcse is enabled.
3967
3968 @item -floop-optimize
3969 @opindex floop-optimize
3970 Perform loop optimizations: move constant expressions out of loops, simplify
3971 exit test conditions and optionally do strength-reduction and loop unrolling as
3972 well.
3973
3974 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3975
3976 @item -fcrossjumping
3977 @opindex crossjumping
3978 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3979 resulting code may or may not perform better than without cross-jumping.
3980
3981 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3982
3983 @item -fif-conversion
3984 @opindex if-conversion
3985 Attempt to transform conditional jumps into branch-less equivalents.  This
3986 include use of conditional moves, min, max, set flags and abs instructions, and
3987 some tricks doable by standard arithmetics.  The use of conditional execution
3988 on chips where it is available is controlled by @code{if-conversion2}.
3989
3990 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3991
3992 @item -fif-conversion2
3993 @opindex if-conversion2
3994 Use conditional execution (where available) to transform conditional jumps into
3995 branch-less equivalents.
3996
3997 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3998
3999 @item -fdelete-null-pointer-checks
4000 @opindex fdelete-null-pointer-checks
4001 Use global dataflow analysis to identify and eliminate useless checks
4002 for null pointers.  The compiler assumes that dereferencing a null
4003 pointer would have halted the program.  If a pointer is checked after
4004 it has already been dereferenced, it cannot be null.
4005
4006 In some environments, this assumption is not true, and programs can
4007 safely dereference null pointers.  Use
4008 @option{-fno-delete-null-pointer-checks} to disable this optimization
4009 for programs which depend on that behavior.
4010
4011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4012
4013 @item -fexpensive-optimizations
4014 @opindex fexpensive-optimizations
4015 Perform a number of minor optimizations that are relatively expensive.
4016
4017 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4018
4019 @item -foptimize-register-move
4020 @itemx -fregmove
4021 @opindex foptimize-register-move
4022 @opindex fregmove
4023 Attempt to reassign register numbers in move instructions and as
4024 operands of other simple instructions in order to maximize the amount of
4025 register tying.  This is especially helpful on machines with two-operand
4026 instructions.
4027
4028 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4029 optimization.
4030
4031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4032
4033 @item -fdelayed-branch
4034 @opindex fdelayed-branch
4035 If supported for the target machine, attempt to reorder instructions
4036 to exploit instruction slots available after delayed branch
4037 instructions.
4038
4039 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4040
4041 @item -fschedule-insns
4042 @opindex fschedule-insns
4043 If supported for the target machine, attempt to reorder instructions to
4044 eliminate execution stalls due to required data being unavailable.  This
4045 helps machines that have slow floating point or memory load instructions
4046 by allowing other instructions to be issued until the result of the load
4047 or floating point instruction is required.
4048
4049 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4050
4051 @item -fschedule-insns2
4052 @opindex fschedule-insns2
4053 Similar to @option{-fschedule-insns}, but requests an additional pass of
4054 instruction scheduling after register allocation has been done.  This is
4055 especially useful on machines with a relatively small number of
4056 registers and where memory load instructions take more than one cycle.
4057
4058 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4059
4060 @item -fno-sched-interblock
4061 @opindex fno-sched-interblock
4062 Don't schedule instructions across basic blocks.  This is normally
4063 enabled by default when scheduling before register allocation, i.e.@:
4064 with @option{-fschedule-insns} or at @option{-O2} or higher.
4065
4066 @item -fno-sched-spec
4067 @opindex fno-sched-spec
4068 Don't allow speculative motion of non-load instructions.  This is normally
4069 enabled by default when scheduling before register allocation, i.e.@:
4070 with @option{-fschedule-insns} or at @option{-O2} or higher.
4071
4072 @item -fsched-spec-load
4073 @opindex fsched-spec-load
4074 Allow speculative motion of some load instructions.  This only makes
4075 sense when scheduling before register allocation, i.e.@: with
4076 @option{-fschedule-insns} or at @option{-O2} or higher.
4077
4078 @item -fsched-spec-load-dangerous
4079 @opindex fsched-spec-load-dangerous
4080 Allow speculative motion of more load instructions.  This only makes
4081 sense when scheduling before register allocation, i.e.@: with
4082 @option{-fschedule-insns} or at @option{-O2} or higher.
4083
4084 @item -fsched-stalled-insns=@var{n}
4085 @opindex fsched-stalled-insns
4086 Define how many insns (if any) can be moved prematurely from the queue
4087 of stalled insns into the ready list, during the second scheduling pass.
4088
4089 @item -fsched-stalled-insns-dep=@var{n}
4090 @opindex fsched-stalled-insns-dep
4091 Define how many insn groups (cycles) will be examined for a dependency
4092 on a stalled insn that is candidate for premature removal from the queue
4093 of stalled insns.  Has an effect only during the second scheduling pass,
4094 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4095
4096 @item -fsched2-use-superblocks
4097 @opindex fsched2-use-superblocks
4098 When scheduling after register allocation, do use superblock scheduling
4099 algorithm.  Superblock scheduling allows motion across basic block boundaries
4100 resulting on faster schedules.  This option is experimental, as not all machine
4101 descriptions used by GCC model the CPU closely enough to avoid unreliable
4102 results from the algorithm.
4103
4104 This only makes sense when scheduling after register allocation, i.e.@: with
4105 @option{-fschedule-insns2} or at @option{-O2} or higher.
4106
4107 @item -fsched2-use-traces
4108 @opindex fsched2-use-traces
4109 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4110 allocation and additionally perform code duplication in order to increase the
4111 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4112 trace formation.
4113
4114 This mode should produce faster but significantly longer programs.  Also
4115 without @code{-fbranch-probabilities} the traces constructed may not match the
4116 reality and hurt the performance.  This only makes
4117 sense when scheduling after register allocation, i.e.@: with
4118 @option{-fschedule-insns2} or at @option{-O2} or higher.
4119
4120 @item -fcaller-saves
4121 @opindex fcaller-saves
4122 Enable values to be allocated in registers that will be clobbered by
4123 function calls, by emitting extra instructions to save and restore the
4124 registers around such calls.  Such allocation is done only when it
4125 seems to result in better code than would otherwise be produced.
4126
4127 This option is always enabled by default on certain machines, usually
4128 those which have no call-preserved registers to use instead.
4129
4130 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4131
4132 @item -fmove-all-movables
4133 @opindex fmove-all-movables
4134 Forces all invariant computations in loops to be moved
4135 outside the loop.
4136
4137 @item -freduce-all-givs
4138 @opindex freduce-all-givs
4139 Forces all general-induction variables in loops to be
4140 strength-reduced.
4141
4142 @emph{Note:} When compiling programs written in Fortran,
4143 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4144 by default when you use the optimizer.
4145
4146 These options may generate better or worse code; results are highly
4147 dependent on the structure of loops within the source code.
4148
4149 These two options are intended to be removed someday, once
4150 they have helped determine the efficacy of various
4151 approaches to improving loop optimizations.
4152
4153 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4154 know how use of these options affects
4155 the performance of your production code.
4156 We're very interested in code that runs @emph{slower}
4157 when these options are @emph{enabled}.
4158
4159 @item -fno-peephole
4160 @itemx -fno-peephole2
4161 @opindex fno-peephole
4162 @opindex fno-peephole2
4163 Disable any machine-specific peephole optimizations.  The difference
4164 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4165 are implemented in the compiler; some targets use one, some use the
4166 other, a few use both.
4167
4168 @option{-fpeephole} is enabled by default.
4169 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4170
4171 @item -fno-guess-branch-probability
4172 @opindex fno-guess-branch-probability
4173 Do not guess branch probabilities using a randomized model.
4174
4175 Sometimes GCC will opt to use a randomized model to guess branch
4176 probabilities, when none are available from either profiling feedback
4177 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4178 different runs of the compiler on the same program may produce different
4179 object code.
4180
4181 In a hard real-time system, people don't want different runs of the
4182 compiler to produce code that has different behavior; minimizing
4183 non-determinism is of paramount import.  This switch allows users to
4184 reduce non-determinism, possibly at the expense of inferior
4185 optimization.
4186
4187 The default is @option{-fguess-branch-probability} at levels
4188 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4189
4190 @item -freorder-blocks
4191 @opindex freorder-blocks
4192 Reorder basic blocks in the compiled function in order to reduce number of
4193 taken branches and improve code locality.
4194
4195 Enabled at levels @option{-O2}, @option{-O3}.
4196
4197 @item -freorder-functions
4198 @opindex freorder-functions
4199 Reorder basic blocks in the compiled function in order to reduce number of
4200 taken branches and improve code locality. This is implemented by using special
4201 subsections @code{text.hot} for most frequently executed functions and
4202 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4203 the linker so object file format must support named sections and linker must
4204 place them in a reasonable way.
4205
4206 Also profile feedback must be available in to make this option effective.  See
4207 @option{-fprofile-arcs} for details.
4208
4209 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4210
4211 @item -fstrict-aliasing
4212 @opindex fstrict-aliasing
4213 Allows the compiler to assume the strictest aliasing rules applicable to
4214 the language being compiled.  For C (and C++), this activates
4215 optimizations based on the type of expressions.  In particular, an
4216 object of one type is assumed never to reside at the same address as an
4217 object of a different type, unless the types are almost the same.  For
4218 example, an @code{unsigned int} can alias an @code{int}, but not a
4219 @code{void*} or a @code{double}.  A character type may alias any other
4220 type.
4221
4222 Pay special attention to code like this:
4223 @smallexample
4224 union a_union @{
4225   int i;
4226   double d;
4227 @};
4228
4229 int f() @{
4230   a_union t;
4231   t.d = 3.0;
4232   return t.i;
4233 @}
4234 @end smallexample
4235 The practice of reading from a different union member than the one most
4236 recently written to (called ``type-punning'') is common.  Even with
4237 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4238 is accessed through the union type.  So, the code above will work as
4239 expected.  However, this code might not:
4240 @smallexample
4241 int f() @{
4242   a_union t;
4243   int* ip;
4244   t.d = 3.0;
4245   ip = &t.i;
4246   return *ip;
4247 @}
4248 @end smallexample
4249
4250 Every language that wishes to perform language-specific alias analysis
4251 should define a function that computes, given an @code{tree}
4252 node, an alias set for the node.  Nodes in different alias sets are not
4253 allowed to alias.  For an example, see the C front-end function
4254 @code{c_get_alias_set}.
4255
4256 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4257
4258 @item -falign-functions
4259 @itemx -falign-functions=@var{n}
4260 @opindex falign-functions
4261 Align the start of functions to the next power-of-two greater than
4262 @var{n}, skipping up to @var{n} bytes.  For instance,
4263 @option{-falign-functions=32} aligns functions to the next 32-byte
4264 boundary, but @option{-falign-functions=24} would align to the next
4265 32-byte boundary only if this can be done by skipping 23 bytes or less.
4266
4267 @option{-fno-align-functions} and @option{-falign-functions=1} are
4268 equivalent and mean that functions will not be aligned.
4269
4270 Some assemblers only support this flag when @var{n} is a power of two;
4271 in that case, it is rounded up.
4272
4273 If @var{n} is not specified or is zero, use a machine-dependent default.
4274
4275 Enabled at levels @option{-O2}, @option{-O3}.
4276
4277 @item -falign-labels
4278 @itemx -falign-labels=@var{n}
4279 @opindex falign-labels
4280 Align all branch targets to a power-of-two boundary, skipping up to
4281 @var{n} bytes like @option{-falign-functions}.  This option can easily
4282 make code slower, because it must insert dummy operations for when the
4283 branch target is reached in the usual flow of the code.
4284
4285 @option{-fno-align-labels} and @option{-falign-labels=1} are
4286 equivalent and mean that labels will not be aligned.
4287
4288 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4289 are greater than this value, then their values are used instead.
4290
4291 If @var{n} is not specified or is zero, use a machine-dependent default
4292 which is very likely to be @samp{1}, meaning no alignment.
4293
4294 Enabled at levels @option{-O2}, @option{-O3}.
4295
4296 @item -falign-loops
4297 @itemx -falign-loops=@var{n}
4298 @opindex falign-loops
4299 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4300 like @option{-falign-functions}.  The hope is that the loop will be
4301 executed many times, which will make up for any execution of the dummy
4302 operations.
4303
4304 @option{-fno-align-loops} and @option{-falign-loops=1} are
4305 equivalent and mean that loops will not be aligned.
4306
4307 If @var{n} is not specified or is zero, use a machine-dependent default.
4308
4309 Enabled at levels @option{-O2}, @option{-O3}.
4310
4311 @item -falign-jumps
4312 @itemx -falign-jumps=@var{n}
4313 @opindex falign-jumps
4314 Align branch targets to a power-of-two boundary, for branch targets
4315 where the targets can only be reached by jumping, skipping up to @var{n}
4316 bytes like @option{-falign-functions}.  In this case, no dummy operations
4317 need be executed.
4318
4319 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4320 equivalent and mean that loops will not be aligned.
4321
4322 If @var{n} is not specified or is zero, use a machine-dependent default.
4323
4324 Enabled at levels @option{-O2}, @option{-O3}.
4325
4326 @item -frename-registers
4327 @opindex frename-registers
4328 Attempt to avoid false dependencies in scheduled code by making use
4329 of registers left over after register allocation.  This optimization
4330 will most benefit processors with lots of registers.  It can, however,
4331 make debugging impossible, since variables will no longer stay in
4332 a ``home register''.
4333
4334 @item -fweb
4335 @opindex fweb
4336 Constructs webs as commonly used for register allocation purposes and assign
4337 each web individual pseudo register.  This allows our register allocation pass
4338 to operate on pseudos directly, but also strengthens several other optimization
4339 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4340 however, make debugging impossible, since variables will no longer stay in a
4341 ``home register''.
4342
4343 Enabled at levels @option{-O3}.
4344
4345 @item -fno-cprop-registers
4346 @opindex fno-cprop-registers
4347 After register allocation and post-register allocation instruction splitting,
4348 we perform a copy-propagation pass to try to reduce scheduling dependencies
4349 and occasionally eliminate the copy.
4350
4351 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4352
4353 @item -fprofile-generate
4354 @opindex fprofile-generate
4355
4356 Enable options usually used for instrumenting application to produce
4357 profile useful for later recompilation with profile feedback based
4358 optimization.  You must use @code{-fprofile-generate} both when
4359 compiling and when linking your program.
4360
4361 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4362
4363 @item -fprofile-use
4364 @opindex fprofile-use
4365 Enable profile feedback directed optimizations, and optimizations
4366 generally profitable only with profile feedback available.
4367
4368 The following options are enabled: @code{-fbranch-probabilities},
4369 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4370
4371 @end table
4372
4373 The following options control compiler behavior regarding floating
4374 point arithmetic.  These options trade off between speed and
4375 correctness.  All must be specifically enabled.
4376
4377 @table @gcctabopt
4378 @item -ffloat-store
4379 @opindex ffloat-store
4380 Do not store floating point variables in registers, and inhibit other
4381 options that might change whether a floating point value is taken from a
4382 register or memory.
4383
4384 @cindex floating point precision
4385 This option prevents undesirable excess precision on machines such as
4386 the 68000 where the floating registers (of the 68881) keep more
4387 precision than a @code{double} is supposed to have.  Similarly for the
4388 x86 architecture.  For most programs, the excess precision does only
4389 good, but a few programs rely on the precise definition of IEEE floating
4390 point.  Use @option{-ffloat-store} for such programs, after modifying
4391 them to store all pertinent intermediate computations into variables.
4392
4393 @item -ffast-math
4394 @opindex ffast-math
4395 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4396 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4397 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4398
4399 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4400
4401 This option should never be turned on by any @option{-O} option since
4402 it can result in incorrect output for programs which depend on
4403 an exact implementation of IEEE or ISO rules/specifications for
4404 math functions.
4405
4406 @item -fno-math-errno
4407 @opindex fno-math-errno
4408 Do not set ERRNO after calling math functions that are executed
4409 with a single instruction, e.g., sqrt.  A program that relies on
4410 IEEE exceptions for math error handling may want to use this flag
4411 for speed while maintaining IEEE arithmetic compatibility.
4412
4413 This option should never be turned on by any @option{-O} option since
4414 it can result in incorrect output for programs which depend on
4415 an exact implementation of IEEE or ISO rules/specifications for
4416 math functions.
4417
4418 The default is @option{-fmath-errno}.
4419
4420 @item -funsafe-math-optimizations
4421 @opindex funsafe-math-optimizations
4422 Allow optimizations for floating-point arithmetic that (a) assume
4423 that arguments and results are valid and (b) may violate IEEE or
4424 ANSI standards.  When used at link-time, it may include libraries
4425 or startup files that change the default FPU control word or other
4426 similar optimizations.
4427
4428 This option should never be turned on by any @option{-O} option since
4429 it can result in incorrect output for programs which depend on
4430 an exact implementation of IEEE or ISO rules/specifications for
4431 math functions.
4432
4433 The default is @option{-fno-unsafe-math-optimizations}.
4434
4435 @item -ffinite-math-only
4436 @opindex ffinite-math-only
4437 Allow optimizations for floating-point arithmetic that assume
4438 that arguments and results are not NaNs or +-Infs.
4439
4440 This option should never be turned on by any @option{-O} option since
4441 it can result in incorrect output for programs which depend on
4442 an exact implementation of IEEE or ISO rules/specifications.
4443
4444 The default is @option{-fno-finite-math-only}.
4445
4446 @item -fno-trapping-math
4447 @opindex fno-trapping-math
4448 Compile code assuming that floating-point operations cannot generate
4449 user-visible traps.  These traps include division by zero, overflow,
4450 underflow, inexact result and invalid operation.  This option implies
4451 @option{-fno-signaling-nans}.  Setting this option may allow faster
4452 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4453
4454 This option should never be turned on by any @option{-O} option since
4455 it can result in incorrect output for programs which depend on
4456 an exact implementation of IEEE or ISO rules/specifications for
4457 math functions.
4458
4459 The default is @option{-ftrapping-math}.
4460
4461 @item -frounding-math
4462 @opindex frounding-math
4463 Disable transformations and optimizations that assume default floating
4464 point rounding behavior.  This is round-to-zero for all floating point
4465 to integer conversions, and round-to-nearest for all other arithmetic
4466 truncations.  This option should be specified for programs that change
4467 the FP rounding mode dynamically, or that may be executed with a
4468 non-default rounding mode.  This option disables constant folding of
4469 floating point expressions at compile-time (which may be affected by
4470 rounding mode) and arithmetic transformations that are unsafe in the
4471 presence of sign-dependent rounding modes.
4472
4473 The default is @option{-fno-rounding-math}.
4474
4475 This option is experimental and does not currently guarantee to
4476 disable all GCC optimizations that are affected by rounding mode.
4477 Future versions of GCC may provide finer control of this setting
4478 using C99's @code{FENV_ACCESS} pragma.  This command line option
4479 will be used to specify the default state for @code{FENV_ACCESS}.
4480
4481 @item -fsignaling-nans
4482 @opindex fsignaling-nans
4483 Compile code assuming that IEEE signaling NaNs may generate user-visible
4484 traps during floating-point operations.  Setting this option disables
4485 optimizations that may change the number of exceptions visible with
4486 signaling NaNs.  This option implies @option{-ftrapping-math}.
4487
4488 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4489 be defined.
4490
4491 The default is @option{-fno-signaling-nans}.
4492
4493 This option is experimental and does not currently guarantee to
4494 disable all GCC optimizations that affect signaling NaN behavior.
4495
4496 @item -fsingle-precision-constant
4497 @opindex fsingle-precision-constant
4498 Treat floating point constant as single precision constant instead of
4499 implicitly converting it to double precision constant.
4500
4501
4502 @end table
4503
4504 The following options control optimizations that may improve
4505 performance, but are not enabled by any @option{-O} options.  This
4506 section includes experimental options that may produce broken code.
4507
4508 @table @gcctabopt
4509 @item -fbranch-probabilities
4510 @opindex fbranch-probabilities
4511 After running a program compiled with @option{-fprofile-arcs}
4512 (@pxref{Debugging Options,, Options for Debugging Your Program or
4513 @command{gcc}}), you can compile it a second time using
4514 @option{-fbranch-probabilities}, to improve optimizations based on
4515 the number of times each branch was taken.  When the program
4516 compiled with @option{-fprofile-arcs} exits it saves arc execution
4517 counts to a file called @file{@var{sourcename}.gcda} for each source
4518 file  The information in this data file is very dependent on the
4519 structure of the generated code, so you must use the same source code
4520 and the same optimization options for both compilations.
4521
4522 With @option{-fbranch-probabilities}, GCC puts a
4523 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4524 These can be used to improve optimization.  Currently, they are only
4525 used in one place: in @file{reorg.c}, instead of guessing which path a
4526 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4527 exactly determine which path is taken more often.
4528
4529 @item -fprofile-values
4530 @opindex fprofile-values
4531 If combined with @option{-fprofile-arcs}, it adds code so that some
4532 data about values of expressions in the program is gathered.
4533
4534 With @option{-fbranch-probabilities}, it reads back the data gathered
4535 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4536 notes to instructions for their later usage in optimizations.
4537
4538 @item -fvpt
4539 @opindex fvpt
4540 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4541 a code to gather information about values of expressions.
4542
4543 With @option{-fbranch-probabilities}, it reads back the data gathered
4544 and actually performs the optimizations based on them.
4545 Currently the optimizations include specialization of division operation
4546 using the knowledge about the value of the denominator.
4547
4548 @item -fnew-ra
4549 @opindex fnew-ra
4550 Use a graph coloring register allocator.  Currently this option is meant
4551 for testing, so we are interested to hear about miscompilations with
4552 @option{-fnew-ra}.
4553
4554 @item -ftracer
4555 @opindex ftracer
4556 Perform tail duplication to enlarge superblock size. This transformation
4557 simplifies the control flow of the function allowing other optimizations to do
4558 better job.
4559
4560 @item -funit-at-a-time
4561 @opindex funit-at-a-time
4562 Parse the whole compilation unit before starting to produce code.
4563 This allows some extra optimizations to take place but consumes more
4564 memory.
4565
4566 @item -funroll-loops
4567 @opindex funroll-loops
4568 Unroll loops whose number of iterations can be determined at compile time or
4569 upon entry to the loop.  @option{-funroll-loops} implies
4570 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4571 (i.e. complete removal of loops with small constant number of iterations).
4572 This option makes code larger, and may or may not make it run faster.
4573
4574 @item -funroll-all-loops
4575 @opindex funroll-all-loops
4576 Unroll all loops, even if their number of iterations is uncertain when
4577 the loop is entered.  This usually makes programs run more slowly.
4578 @option{-funroll-all-loops} implies the same options as
4579 @option{-funroll-loops}.
4580
4581 @item -fpeel-loops
4582 @opindex fpeel-loops
4583 Peels the loops for that there is enough information that they do not
4584 roll much (from profile feedback).  It also turns on complete loop peeling
4585 (i.e. complete removal of loops with small constant number of iterations).
4586
4587 @item -funswitch-loops
4588 @opindex funswitch-loops
4589 Move branches with loop invariant conditions out of the loop, with duplicates
4590 of the loop on both branches (modified according to result of the condition).
4591
4592 @item -fold-unroll-loops
4593 @opindex fold-unroll-loops
4594 Unroll loops whose number of iterations can be determined at compile
4595 time or upon entry to the loop, using the old loop unroller whose loop
4596 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4597 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4598 option makes code larger, and may or may not make it run faster.
4599
4600 @item -fold-unroll-all-loops
4601 @opindex fold-unroll-all-loops
4602 Unroll all loops, even if their number of iterations is uncertain when
4603 the loop is entered. This is done using the old loop unroller whose loop
4604 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4605 @option{-fold-unroll-all-loops} implies the same options as
4606 @option{-fold-unroll-loops}.
4607
4608 @item -funswitch-loops
4609 @opindex funswitch-loops
4610 Move branches with loop invariant conditions out of the loop, with duplicates
4611 of the loop on both branches (modified according to result of the condition).
4612
4613 @item -funswitch-loops
4614 @opindex funswitch-loops
4615 Move branches with loop invariant conditions out of the loop, with duplicates
4616 of the loop on both branches (modified according to result of the condition).
4617
4618 @item -fprefetch-loop-arrays
4619 @opindex fprefetch-loop-arrays
4620 If supported by the target machine, generate instructions to prefetch
4621 memory to improve the performance of loops that access large arrays.
4622
4623 Disabled at level @option{-Os}.
4624
4625 @item -ffunction-sections
4626 @itemx -fdata-sections
4627 @opindex ffunction-sections
4628 @opindex fdata-sections
4629 Place each function or data item into its own section in the output
4630 file if the target supports arbitrary sections.  The name of the
4631 function or the name of the data item determines the section's name
4632 in the output file.
4633
4634 Use these options on systems where the linker can perform optimizations
4635 to improve locality of reference in the instruction space.  Most systems
4636 using the ELF object format and SPARC processors running Solaris 2 have
4637 linkers with such optimizations.  AIX may have these optimizations in
4638 the future.
4639
4640 Only use these options when there are significant benefits from doing
4641 so.  When you specify these options, the assembler and linker will
4642 create larger object and executable files and will also be slower.
4643 You will not be able to use @code{gprof} on all systems if you
4644 specify this option and you may have problems with debugging if
4645 you specify both this option and @option{-g}.
4646
4647 @item -fbranch-target-load-optimize
4648 @opindex fbranch-target-load-optimize
4649 Perform branch target register load optimization before prologue / epilogue
4650 threading.
4651 The use of target registers can typically be exposed only during reload,
4652 thus hoisting loads out of loops and doing inter-block scheduling needs
4653 a separate optimization pass.
4654
4655 @item -fbranch-target-load-optimize2
4656 @opindex fbranch-target-load-optimize2
4657 Perform branch target register load optimization after prologue / epilogue
4658 threading.
4659
4660 @item --param @var{name}=@var{value}
4661 @opindex param
4662 In some places, GCC uses various constants to control the amount of
4663 optimization that is done.  For example, GCC will not inline functions
4664 that contain more that a certain number of instructions.  You can
4665 control some of these constants on the command-line using the
4666 @option{--param} option.
4667
4668 The names of specific parameters, and the meaning of the values, are
4669 tied to the internals of the compiler, and are subject to change
4670 without notice in future releases.
4671
4672 In each case, the @var{value} is an integer.  The allowable choices for
4673 @var{name} are given in the following table:
4674
4675 @table @gcctabopt
4676 @item max-crossjump-edges
4677 The maximum number of incoming edges to consider for crossjumping.
4678 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4679 the number of edges incoming to each block.  Increasing values mean
4680 more aggressive optimization, making the compile time increase with
4681 probably small improvement in executable size.
4682
4683 @item max-delay-slot-insn-search
4684 The maximum number of instructions to consider when looking for an
4685 instruction to fill a delay slot.  If more than this arbitrary number of
4686 instructions is searched, the time savings from filling the delay slot
4687 will be minimal so stop searching.  Increasing values mean more
4688 aggressive optimization, making the compile time increase with probably
4689 small improvement in executable run time.
4690
4691 @item max-delay-slot-live-search
4692 When trying to fill delay slots, the maximum number of instructions to
4693 consider when searching for a block with valid live register
4694 information.  Increasing this arbitrarily chosen value means more
4695 aggressive optimization, increasing the compile time.  This parameter
4696 should be removed when the delay slot code is rewritten to maintain the
4697 control-flow graph.
4698
4699 @item max-gcse-memory
4700 The approximate maximum amount of memory that will be allocated in
4701 order to perform the global common subexpression elimination
4702 optimization.  If more memory than specified is required, the
4703 optimization will not be done.
4704
4705 @item max-gcse-passes
4706 The maximum number of passes of GCSE to run.
4707
4708 @item max-pending-list-length
4709 The maximum number of pending dependencies scheduling will allow
4710 before flushing the current state and starting over.  Large functions
4711 with few branches or calls can create excessively large lists which
4712 needlessly consume memory and resources.
4713
4714 @item max-inline-insns-single
4715 Several parameters control the tree inliner used in gcc.
4716 This number sets the maximum number of instructions (counted in GCC's
4717 internal representation) in a single function that the tree inliner
4718 will consider for inlining.  This only affects functions declared
4719 inline and methods implemented in a class declaration (C++).
4720 The default value is 500.
4721
4722 @item max-inline-insns-auto
4723 When you use @option{-finline-functions} (included in @option{-O3}),
4724 a lot of functions that would otherwise not be considered for inlining
4725 by the compiler will be investigated.  To those functions, a different
4726 (more restrictive) limit compared to functions declared inline can
4727 be applied.
4728 The default value is 100.
4729
4730 @item large-function-insns
4731 The limit specifying really large functions.  For functions greater than this
4732 limit inlining is constrained by @option{--param large-function-growth}.
4733 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4734 algorithms used by the backend.
4735 This parameter is ignored when @option{-funit-at-a-time} is not used.
4736 The default value is 3000.
4737
4738 @item large-function-growth
4739 Specifies maximal growth of large function caused by inlining in percents.
4740 This parameter is ignored when @option{-funit-at-a-time} is not used.
4741 The default value is 200.
4742
4743 @item inline-unit-growth
4744 Specifies maximal overall growth of the compilation unit caused by inlining.
4745 This parameter is ignored when @option{-funit-at-a-time} is not used.
4746 The default value is 150.
4747
4748 @item max-inline-insns-rtl
4749 For languages that use the RTL inliner (this happens at a later stage
4750 than tree inlining), you can set the maximum allowable size (counted
4751 in RTL instructions) for the RTL inliner with this parameter.
4752 The default value is 600.
4753
4754 @item max-unrolled-insns
4755 The maximum number of instructions that a loop should have if that loop
4756 is unrolled, and if the loop is unrolled, it determines how many times
4757 the loop code is unrolled.
4758
4759 @item max-average-unrolled-insns
4760 The maximum number of instructions biased by probabilities of their execution
4761 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4762 it determines how many times the loop code is unrolled.
4763
4764 @item max-unroll-times
4765 The maximum number of unrollings of a single loop.
4766
4767 @item max-peeled-insns
4768 The maximum number of instructions that a loop should have if that loop
4769 is peeled, and if the loop is peeled, it determines how many times
4770 the loop code is peeled.
4771
4772 @item max-peel-times
4773 The maximum number of peelings of a single loop.
4774
4775 @item max-completely-peeled-insns
4776 The maximum number of insns of a completely peeled loop.
4777
4778 @item max-completely-peel-times
4779 The maximum number of iterations of a loop to be suitable for complete peeling.
4780
4781 @item max-unswitch-insns
4782 The maximum number of insns of an unswitched loop.
4783
4784 @item max-unswitch-level
4785 The maximum number of branches unswitched in a single loop.
4786
4787 @item hot-bb-count-fraction
4788 Select fraction of the maximal count of repetitions of basic block in program
4789 given basic block needs to have to be considered hot.
4790
4791 @item hot-bb-frequency-fraction
4792 Select fraction of the maximal frequency of executions of basic block in
4793 function given basic block needs to have to be considered hot
4794
4795 @item tracer-dynamic-coverage
4796 @itemx tracer-dynamic-coverage-feedback
4797
4798 This value is used to limit superblock formation once the given percentage of
4799 executed instructions is covered.  This limits unnecessary code size
4800 expansion.
4801
4802 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4803 feedback is available.  The real profiles (as opposed to statically estimated
4804 ones) are much less balanced allowing the threshold to be larger value.
4805
4806 @item tracer-max-code-growth
4807 Stop tail duplication once code growth has reached given percentage.  This is
4808 rather hokey argument, as most of the duplicates will be eliminated later in
4809 cross jumping, so it may be set to much higher values than is the desired code
4810 growth.
4811
4812 @item tracer-min-branch-ratio
4813
4814 Stop reverse growth when the reverse probability of best edge is less than this
4815 threshold (in percent).
4816
4817 @item tracer-min-branch-ratio
4818 @itemx tracer-min-branch-ratio-feedback
4819
4820 Stop forward growth if the best edge do have probability lower than this
4821 threshold.
4822
4823 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4824 compilation for profile feedback and one for compilation without.  The value
4825 for compilation with profile feedback needs to be more conservative (higher) in
4826 order to make tracer effective.
4827
4828 @item max-cse-path-length
4829
4830 Maximum number of basic blocks on path that cse considers.
4831
4832 @item ggc-min-expand
4833
4834 GCC uses a garbage collector to manage its own memory allocation.  This
4835 parameter specifies the minimum percentage by which the garbage
4836 collector's heap should be allowed to expand between collections.
4837 Tuning this may improve compilation speed; it has no effect on code
4838 generation.
4839
4840 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4841 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4842 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4843 GCC is not able to calculate RAM on a particular platform, the lower
4844 bound of 30% is used.  Setting this parameter and
4845 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4846 every opportunity.  This is extremely slow, but can be useful for
4847 debugging.
4848
4849 @item ggc-min-heapsize
4850
4851 Minimum size of the garbage collector's heap before it begins bothering
4852 to collect garbage.  The first collection occurs after the heap expands
4853 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4854 tuning this may improve compilation speed, and has no effect on code
4855 generation.
4856
4857 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4858 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4859 available, the notion of "RAM" is the smallest of actual RAM,
4860 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4861 RAM on a particular platform, the lower bound is used.  Setting this
4862 parameter very large effectively disables garbage collection.  Setting
4863 this parameter and @option{ggc-min-expand} to zero causes a full
4864 collection to occur at every opportunity.
4865
4866 @item max-reload-search-insns
4867 The maximum number of instruction reload should look backward for equivalent
4868 register.  Increasing values mean more aggressive optimization, making the
4869 compile time increase with probably slightly better performance.  The default
4870 value is 100.
4871
4872 @item max-cselib-memory-location
4873 The maximum number of memory locations cselib should take into acount.
4874 Increasing values mean more aggressive optimization, making the compile time
4875 increase with probably slightly better performance.  The default value is 500.
4876
4877 @item reorder-blocks-duplicate
4878 @itemx reorder-blocks-duplicate-feedback
4879
4880 Used by basic block reordering pass to decide whether to use unconditional
4881 branch or duplicate the code on its destination.  Code is duplicated when its
4882 estimated size is smaller than this value multiplied by the estimated size of
4883 unconditional jump in the hot spots of the program.
4884
4885 The @option{reorder-block-duplicate-feedback} is used only when profile
4886 feedback is available and may be set to higher values than
4887 @option{reorder-block-duplicate} since information about the hot spots is more
4888 accurate.
4889 @end table
4890 @end table
4891
4892 @node Preprocessor Options
4893 @section Options Controlling the Preprocessor
4894 @cindex preprocessor options
4895 @cindex options, preprocessor
4896
4897 These options control the C preprocessor, which is run on each C source
4898 file before actual compilation.
4899
4900 If you use the @option{-E} option, nothing is done except preprocessing.
4901 Some of these options make sense only together with @option{-E} because
4902 they cause the preprocessor output to be unsuitable for actual
4903 compilation.
4904
4905 @table @gcctabopt
4906 @opindex Wp
4907 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4908 and pass @var{option} directly through to the preprocessor.  If
4909 @var{option} contains commas, it is split into multiple options at the
4910 commas.  However, many options are modified, translated or interpreted
4911 by the compiler driver before being passed to the preprocessor, and
4912 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4913 interface is undocumented and subject to change, so whenever possible
4914 you should avoid using @option{-Wp} and let the driver handle the
4915 options instead.
4916
4917 @item -Xpreprocessor @var{option}
4918 @opindex preprocessor
4919 Pass @var{option} as an option to the preprocessor.  You can use this to
4920 supply system-specific preprocessor options which GCC does not know how to
4921 recognize.
4922
4923 If you want to pass an option that takes an argument, you must use
4924 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4925 @end table
4926
4927 @include cppopts.texi
4928
4929 @node Assembler Options
4930 @section Passing Options to the Assembler
4931
4932 @c prevent bad page break with this line
4933 You can pass options to the assembler.
4934
4935 @table @gcctabopt
4936 @item -Wa,@var{option}
4937 @opindex Wa
4938 Pass @var{option} as an option to the assembler.  If @var{option}
4939 contains commas, it is split into multiple options at the commas.
4940
4941 @item -Xassembler @var{option}
4942 @opindex Xassembler
4943 Pass @var{option} as an option to the assembler.  You can use this to
4944 supply system-specific assembler options which GCC does not know how to
4945 recognize.
4946
4947 If you want to pass an option that takes an argument, you must use
4948 @option{-Xassembler} twice, once for the option and once for the argument.
4949
4950 @end table
4951
4952 @node Link Options
4953 @section Options for Linking
4954 @cindex link options
4955 @cindex options, linking
4956
4957 These options come into play when the compiler links object files into
4958 an executable output file.  They are meaningless if the compiler is
4959 not doing a link step.
4960
4961 @table @gcctabopt
4962 @cindex file names
4963 @item @var{object-file-name}
4964 A file name that does not end in a special recognized suffix is
4965 considered to name an object file or library.  (Object files are
4966 distinguished from libraries by the linker according to the file
4967 contents.)  If linking is done, these object files are used as input
4968 to the linker.
4969
4970 @item -c
4971 @itemx -S
4972 @itemx -E
4973 @opindex c
4974 @opindex S
4975 @opindex E
4976 If any of these options is used, then the linker is not run, and
4977 object file names should not be used as arguments.  @xref{Overall
4978 Options}.
4979
4980 @cindex Libraries
4981 @item -l@var{library}
4982 @itemx -l @var{library}
4983 @opindex l
4984 Search the library named @var{library} when linking.  (The second
4985 alternative with the library as a separate argument is only for
4986 POSIX compliance and is not recommended.)
4987
4988 It makes a difference where in the command you write this option; the
4989 linker searches and processes libraries and object files in the order they
4990 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4991 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4992 to functions in @samp{z}, those functions may not be loaded.
4993
4994 The linker searches a standard list of directories for the library,
4995 which is actually a file named @file{lib@var{library}.a}.  The linker
4996 then uses this file as if it had been specified precisely by name.
4997
4998 The directories searched include several standard system directories
4999 plus any that you specify with @option{-L}.
5000
5001 Normally the files found this way are library files---archive files
5002 whose members are object files.  The linker handles an archive file by
5003 scanning through it for members which define symbols that have so far
5004 been referenced but not defined.  But if the file that is found is an
5005 ordinary object file, it is linked in the usual fashion.  The only
5006 difference between using an @option{-l} option and specifying a file name
5007 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5008 and searches several directories.
5009
5010 @item -lobjc
5011 @opindex lobjc
5012 You need this special case of the @option{-l} option in order to
5013 link an Objective-C program.
5014
5015 @item -nostartfiles
5016 @opindex nostartfiles
5017 Do not use the standard system startup files when linking.
5018 The standard system libraries are used normally, unless @option{-nostdlib}
5019 or @option{-nodefaultlibs} is used.
5020
5021 @item -nodefaultlibs
5022 @opindex nodefaultlibs
5023 Do not use the standard system libraries when linking.
5024 Only the libraries you specify will be passed to the linker.
5025 The standard startup files are used normally, unless @option{-nostartfiles}
5026 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5027 for System V (and ISO C) environments or to bcopy and bzero for
5028 BSD environments.  These entries are usually resolved by entries in
5029 libc.  These entry points should be supplied through some other
5030 mechanism when this option is specified.
5031
5032 @item -nostdlib
5033 @opindex nostdlib
5034 Do not use the standard system startup files or libraries when linking.
5035 No startup files and only the libraries you specify will be passed to
5036 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5037 for System V (and ISO C) environments or to bcopy and bzero for
5038 BSD environments.  These entries are usually resolved by entries in
5039 libc.  These entry points should be supplied through some other
5040 mechanism when this option is specified.
5041
5042 @cindex @option{-lgcc}, use with @option{-nostdlib}
5043 @cindex @option{-nostdlib} and unresolved references
5044 @cindex unresolved references and @option{-nostdlib}
5045 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5046 @cindex @option{-nodefaultlibs} and unresolved references
5047 @cindex unresolved references and @option{-nodefaultlibs}
5048 One of the standard libraries bypassed by @option{-nostdlib} and
5049 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5050 that GCC uses to overcome shortcomings of particular machines, or special
5051 needs for some languages.
5052 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5053 Collection (GCC) Internals},
5054 for more discussion of @file{libgcc.a}.)
5055 In most cases, you need @file{libgcc.a} even when you want to avoid
5056 other standard libraries.  In other words, when you specify @option{-nostdlib}
5057 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5058 This ensures that you have no unresolved references to internal GCC
5059 library subroutines.  (For example, @samp{__main}, used to ensure C++
5060 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5061 GNU Compiler Collection (GCC) Internals}.)
5062
5063 @item -pie
5064 @opindex pie
5065 Produce a position independent executable on targets which support it.
5066 For predictable results, you must also specify the same set of options
5067 that were used to generate code (@option{-fpie}, @option{-fPIE},
5068 or model suboptions) when you specify this option.
5069
5070 @item -s
5071 @opindex s
5072 Remove all symbol table and relocation information from the executable.
5073
5074 @item -static
5075 @opindex static
5076 On systems that support dynamic linking, this prevents linking with the shared
5077 libraries.  On other systems, this option has no effect.
5078
5079 @item -shared
5080 @opindex shared
5081 Produce a shared object which can then be linked with other objects to
5082 form an executable.  Not all systems support this option.  For predictable
5083 results, you must also specify the same set of options that were used to
5084 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5085 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5086 needs to build supplementary stub code for constructors to work.  On
5087 multi-libbed systems, @samp{gcc -shared} must select the correct support
5088 libraries to link against.  Failing to supply the correct flags may lead
5089 to subtle defects.  Supplying them in cases where they are not necessary
5090 is innocuous.}
5091
5092 @item -shared-libgcc
5093 @itemx -static-libgcc
5094 @opindex shared-libgcc
5095 @opindex static-libgcc
5096 On systems that provide @file{libgcc} as a shared library, these options
5097 force the use of either the shared or static version respectively.
5098 If no shared version of @file{libgcc} was built when the compiler was
5099 configured, these options have no effect.
5100
5101 There are several situations in which an application should use the
5102 shared @file{libgcc} instead of the static version.  The most common
5103 of these is when the application wishes to throw and catch exceptions
5104 across different shared libraries.  In that case, each of the libraries
5105 as well as the application itself should use the shared @file{libgcc}.
5106
5107 Therefore, the G++ and GCJ drivers automatically add
5108 @option{-shared-libgcc} whenever you build a shared library or a main
5109 executable, because C++ and Java programs typically use exceptions, so
5110 this is the right thing to do.
5111
5112 If, instead, you use the GCC driver to create shared libraries, you may
5113 find that they will not always be linked with the shared @file{libgcc}.
5114 If GCC finds, at its configuration time, that you have a non-GNU linker
5115 or a GNU linker that does not support option @option{--eh-frame-hdr},
5116 it will link the shared version of @file{libgcc} into shared libraries
5117 by default.  Otherwise, it will take advantage of the linker and optimize
5118 away the linking with the shared version of @file{libgcc}, linking with
5119 the static version of libgcc by default.  This allows exceptions to
5120 propagate through such shared libraries, without incurring relocation
5121 costs at library load time.
5122
5123 However, if a library or main executable is supposed to throw or catch
5124 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5125 for the languages used in the program, or using the option
5126 @option{-shared-libgcc}, such that it is linked with the shared
5127 @file{libgcc}.
5128
5129 @item -symbolic
5130 @opindex symbolic
5131 Bind references to global symbols when building a shared object.  Warn
5132 about any unresolved references (unless overridden by the link editor
5133 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5134 this option.
5135
5136 @item -Xlinker @var{option}
5137 @opindex Xlinker
5138 Pass @var{option} as an option to the linker.  You can use this to
5139 supply system-specific linker options which GCC does not know how to
5140 recognize.
5141
5142 If you want to pass an option that takes an argument, you must use
5143 @option{-Xlinker} twice, once for the option and once for the argument.
5144 For example, to pass @option{-assert definitions}, you must write
5145 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5146 @option{-Xlinker "-assert definitions"}, because this passes the entire
5147 string as a single argument, which is not what the linker expects.
5148
5149 @item -Wl,@var{option}
5150 @opindex Wl
5151 Pass @var{option} as an option to the linker.  If @var{option} contains
5152 commas, it is split into multiple options at the commas.
5153
5154 @item -u @var{symbol}
5155 @opindex u
5156 Pretend the symbol @var{symbol} is undefined, to force linking of
5157 library modules to define it.  You can use @option{-u} multiple times with
5158 different symbols to force loading of additional library modules.
5159 @end table
5160
5161 @node Directory Options
5162 @section Options for Directory Search
5163 @cindex directory options
5164 @cindex options, directory search
5165 @cindex search path
5166
5167 These options specify directories to search for header files, for
5168 libraries and for parts of the compiler:
5169
5170 @table @gcctabopt
5171 @item -I@var{dir}
5172 @opindex I
5173 Add the directory @var{dir} to the head of the list of directories to be
5174 searched for header files.  This can be used to override a system header
5175 file, substituting your own version, since these directories are
5176 searched before the system header file directories.  However, you should
5177 not use this option to add directories that contain vendor-supplied
5178 system header files (use @option{-isystem} for that).  If you use more than
5179 one @option{-I} option, the directories are scanned in left-to-right
5180 order; the standard system directories come after.
5181
5182 If a standard system include directory, or a directory specified with
5183 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5184 option will be ignored.  The directory will still be searched but as a
5185 system directory at its normal position in the system include chain.
5186 This is to ensure that GCC's procedure to fix buggy system headers and
5187 the ordering for the include_next directive are not inadvertently changed.
5188 If you really need to change the search order for system directories,
5189 use the @option{-nostdinc} and/or @option{-isystem} options.
5190
5191 @item -I-
5192 @opindex I-
5193 Any directories you specify with @option{-I} options before the @option{-I-}
5194 option are searched only for the case of @samp{#include "@var{file}"};
5195 they are not searched for @samp{#include <@var{file}>}.
5196
5197 If additional directories are specified with @option{-I} options after
5198 the @option{-I-}, these directories are searched for all @samp{#include}
5199 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5200 this way.)
5201
5202 In addition, the @option{-I-} option inhibits the use of the current
5203 directory (where the current input file came from) as the first search
5204 directory for @samp{#include "@var{file}"}.  There is no way to
5205 override this effect of @option{-I-}.  With @option{-I.} you can specify
5206 searching the directory which was current when the compiler was
5207 invoked.  That is not exactly the same as what the preprocessor does
5208 by default, but it is often satisfactory.
5209
5210 @option{-I-} does not inhibit the use of the standard system directories
5211 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5212 independent.
5213
5214 @item -L@var{dir}
5215 @opindex L
5216 Add directory @var{dir} to the list of directories to be searched
5217 for @option{-l}.
5218
5219 @item -B@var{prefix}
5220 @opindex B
5221 This option specifies where to find the executables, libraries,
5222 include files, and data files of the compiler itself.
5223
5224 The compiler driver program runs one or more of the subprograms
5225 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5226 @var{prefix} as a prefix for each program it tries to run, both with and
5227 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5228
5229 For each subprogram to be run, the compiler driver first tries the
5230 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5231 was not specified, the driver tries two standard prefixes, which are
5232 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5233 those results in a file name that is found, the unmodified program
5234 name is searched for using the directories specified in your
5235 @env{PATH} environment variable.
5236
5237 The compiler will check to see if the path provided by the @option{-B}
5238 refers to a directory, and if necessary it will add a directory
5239 separator character at the end of the path.
5240
5241 @option{-B} prefixes that effectively specify directory names also apply
5242 to libraries in the linker, because the compiler translates these
5243 options into @option{-L} options for the linker.  They also apply to
5244 includes files in the preprocessor, because the compiler translates these
5245 options into @option{-isystem} options for the preprocessor.  In this case,
5246 the compiler appends @samp{include} to the prefix.
5247
5248 The run-time support file @file{libgcc.a} can also be searched for using
5249 the @option{-B} prefix, if needed.  If it is not found there, the two
5250 standard prefixes above are tried, and that is all.  The file is left
5251 out of the link if it is not found by those means.
5252
5253 Another way to specify a prefix much like the @option{-B} prefix is to use
5254 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5255 Variables}.
5256
5257 As a special kludge, if the path provided by @option{-B} is
5258 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5259 9, then it will be replaced by @file{[dir/]include}.  This is to help
5260 with boot-strapping the compiler.
5261
5262 @item -specs=@var{file}
5263 @opindex specs
5264 Process @var{file} after the compiler reads in the standard @file{specs}
5265 file, in order to override the defaults that the @file{gcc} driver
5266 program uses when determining what switches to pass to @file{cc1},
5267 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5268 @option{-specs=@var{file}} can be specified on the command line, and they
5269 are processed in order, from left to right.
5270 @end table
5271
5272 @c man end
5273
5274 @node Spec Files
5275 @section Specifying subprocesses and the switches to pass to them
5276 @cindex Spec Files
5277
5278 @command{gcc} is a driver program.  It performs its job by invoking a
5279 sequence of other programs to do the work of compiling, assembling and
5280 linking.  GCC interprets its command-line parameters and uses these to
5281 deduce which programs it should invoke, and which command-line options
5282 it ought to place on their command lines.  This behavior is controlled
5283 by @dfn{spec strings}.  In most cases there is one spec string for each
5284 program that GCC can invoke, but a few programs have multiple spec
5285 strings to control their behavior.  The spec strings built into GCC can
5286 be overridden by using the @option{-specs=} command-line switch to specify
5287 a spec file.
5288
5289 @dfn{Spec files} are plaintext files that are used to construct spec
5290 strings.  They consist of a sequence of directives separated by blank
5291 lines.  The type of directive is determined by the first non-whitespace
5292 character on the line and it can be one of the following:
5293
5294 @table @code
5295 @item %@var{command}
5296 Issues a @var{command} to the spec file processor.  The commands that can
5297 appear here are:
5298
5299 @table @code
5300 @item %include <@var{file}>
5301 @cindex %include
5302 Search for @var{file} and insert its text at the current point in the
5303 specs file.
5304
5305 @item %include_noerr <@var{file}>
5306 @cindex %include_noerr
5307 Just like @samp{%include}, but do not generate an error message if the include
5308 file cannot be found.
5309
5310 @item %rename @var{old_name} @var{new_name}
5311 @cindex %rename
5312 Rename the spec string @var{old_name} to @var{new_name}.
5313
5314 @end table
5315
5316 @item *[@var{spec_name}]:
5317 This tells the compiler to create, override or delete the named spec
5318 string.  All lines after this directive up to the next directive or
5319 blank line are considered to be the text for the spec string.  If this
5320 results in an empty string then the spec will be deleted.  (Or, if the
5321 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5322 does not currently exist a new spec will be created.  If the spec does
5323 exist then its contents will be overridden by the text of this
5324 directive, unless the first character of that text is the @samp{+}
5325 character, in which case the text will be appended to the spec.
5326
5327 @item [@var{suffix}]:
5328 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5329 and up to the next directive or blank line are considered to make up the
5330 spec string for the indicated suffix.  When the compiler encounters an
5331 input file with the named suffix, it will processes the spec string in
5332 order to work out how to compile that file.  For example:
5333
5334 @smallexample
5335 .ZZ:
5336 z-compile -input %i
5337 @end smallexample
5338
5339 This says that any input file whose name ends in @samp{.ZZ} should be
5340 passed to the program @samp{z-compile}, which should be invoked with the
5341 command-line switch @option{-input} and with the result of performing the
5342 @samp{%i} substitution.  (See below.)
5343
5344 As an alternative to providing a spec string, the text that follows a
5345 suffix directive can be one of the following:
5346
5347 @table @code
5348 @item @@@var{language}
5349 This says that the suffix is an alias for a known @var{language}.  This is
5350 similar to using the @option{-x} command-line switch to GCC to specify a
5351 language explicitly.  For example:
5352
5353 @smallexample
5354 .ZZ:
5355 @@c++
5356 @end smallexample
5357
5358 Says that .ZZ files are, in fact, C++ source files.
5359
5360 @item #@var{name}
5361 This causes an error messages saying:
5362
5363 @smallexample
5364 @var{name} compiler not installed on this system.
5365 @end smallexample
5366 @end table
5367
5368 GCC already has an extensive list of suffixes built into it.
5369 This directive will add an entry to the end of the list of suffixes, but
5370 since the list is searched from the end backwards, it is effectively
5371 possible to override earlier entries using this technique.
5372
5373 @end table
5374
5375 GCC has the following spec strings built into it.  Spec files can
5376 override these strings or create their own.  Note that individual
5377 targets can also add their own spec strings to this list.
5378
5379 @smallexample
5380 asm          Options to pass to the assembler
5381 asm_final    Options to pass to the assembler post-processor
5382 cpp          Options to pass to the C preprocessor
5383 cc1          Options to pass to the C compiler
5384 cc1plus      Options to pass to the C++ compiler
5385 endfile      Object files to include at the end of the link
5386 link         Options to pass to the linker
5387 lib          Libraries to include on the command line to the linker
5388 libgcc       Decides which GCC support library to pass to the linker
5389 linker       Sets the name of the linker
5390 predefines   Defines to be passed to the C preprocessor
5391 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5392              by default
5393 startfile    Object files to include at the start of the link
5394 @end smallexample
5395
5396 Here is a small example of a spec file:
5397
5398 @smallexample
5399 %rename lib                 old_lib
5400
5401 *lib:
5402 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5403 @end smallexample
5404
5405 This example renames the spec called @samp{lib} to @samp{old_lib} and
5406 then overrides the previous definition of @samp{lib} with a new one.
5407 The new definition adds in some extra command-line options before
5408 including the text of the old definition.
5409
5410 @dfn{Spec strings} are a list of command-line options to be passed to their
5411 corresponding program.  In addition, the spec strings can contain
5412 @samp{%}-prefixed sequences to substitute variable text or to
5413 conditionally insert text into the command line.  Using these constructs
5414 it is possible to generate quite complex command lines.
5415
5416 Here is a table of all defined @samp{%}-sequences for spec
5417 strings.  Note that spaces are not generated automatically around the
5418 results of expanding these sequences.  Therefore you can concatenate them
5419 together or combine them with constant text in a single argument.
5420
5421 @table @code
5422 @item %%
5423 Substitute one @samp{%} into the program name or argument.
5424
5425 @item %i
5426 Substitute the name of the input file being processed.
5427
5428 @item %b
5429 Substitute the basename of the input file being processed.
5430 This is the substring up to (and not including) the last period
5431 and not including the directory.
5432
5433 @item %B
5434 This is the same as @samp{%b}, but include the file suffix (text after
5435 the last period).
5436
5437 @item %d
5438 Marks the argument containing or following the @samp{%d} as a
5439 temporary file name, so that that file will be deleted if GCC exits
5440 successfully.  Unlike @samp{%g}, this contributes no text to the
5441 argument.
5442
5443 @item %g@var{suffix}
5444 Substitute a file name that has suffix @var{suffix} and is chosen
5445 once per compilation, and mark the argument in the same way as
5446 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5447 name is now chosen in a way that is hard to predict even when previously
5448 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5449 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5450 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5451 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5452 was simply substituted with a file name chosen once per compilation,
5453 without regard to any appended suffix (which was therefore treated
5454 just like ordinary text), making such attacks more likely to succeed.
5455
5456 @item %u@var{suffix}
5457 Like @samp{%g}, but generates a new temporary file name even if
5458 @samp{%u@var{suffix}} was already seen.
5459
5460 @item %U@var{suffix}
5461 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5462 new one if there is no such last file name.  In the absence of any
5463 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5464 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5465 would involve the generation of two distinct file names, one
5466 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5467 simply substituted with a file name chosen for the previous @samp{%u},
5468 without regard to any appended suffix.
5469
5470 @item %j@var{suffix}
5471 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5472 writable, and if save-temps is off; otherwise, substitute the name
5473 of a temporary file, just like @samp{%u}.  This temporary file is not
5474 meant for communication between processes, but rather as a junk
5475 disposal mechanism.
5476
5477 @item %|@var{suffix}
5478 @itemx %m@var{suffix}
5479 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5480 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5481 all.  These are the two most common ways to instruct a program that it
5482 should read from standard input or write to standard output.  If you
5483 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5484 construct: see for example @file{f/lang-specs.h}.
5485
5486 @item %.@var{SUFFIX}
5487 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5488 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5489 terminated by the next space or %.
5490
5491 @item %w
5492 Marks the argument containing or following the @samp{%w} as the
5493 designated output file of this compilation.  This puts the argument
5494 into the sequence of arguments that @samp{%o} will substitute later.
5495
5496 @item %o
5497 Substitutes the names of all the output files, with spaces
5498 automatically placed around them.  You should write spaces
5499 around the @samp{%o} as well or the results are undefined.
5500 @samp{%o} is for use in the specs for running the linker.
5501 Input files whose names have no recognized suffix are not compiled
5502 at all, but they are included among the output files, so they will
5503 be linked.
5504
5505 @item %O
5506 Substitutes the suffix for object files.  Note that this is
5507 handled specially when it immediately follows @samp{%g, %u, or %U},
5508 because of the need for those to form complete file names.  The
5509 handling is such that @samp{%O} is treated exactly as if it had already
5510 been substituted, except that @samp{%g, %u, and %U} do not currently
5511 support additional @var{suffix} characters following @samp{%O} as they would
5512 following, for example, @samp{.o}.
5513
5514 @item %p
5515 Substitutes the standard macro predefinitions for the
5516 current target machine.  Use this when running @code{cpp}.
5517
5518 @item %P
5519 Like @samp{%p}, but puts @samp{__} before and after the name of each
5520 predefined macro, except for macros that start with @samp{__} or with
5521 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5522 C@.
5523
5524 @item %I
5525 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5526 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5527 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5528 as necessary.
5529
5530 @item %s
5531 Current argument is the name of a library or startup file of some sort.
5532 Search for that file in a standard list of directories and substitute
5533 the full name found.
5534
5535 @item %e@var{str}
5536 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5537 Use this when inconsistent options are detected.
5538
5539 @item %(@var{name})
5540 Substitute the contents of spec string @var{name} at this point.
5541
5542 @item %[@var{name}]
5543 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5544
5545 @item %x@{@var{option}@}
5546 Accumulate an option for @samp{%X}.
5547
5548 @item %X
5549 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5550 spec string.
5551
5552 @item %Y
5553 Output the accumulated assembler options specified by @option{-Wa}.
5554
5555 @item %Z
5556 Output the accumulated preprocessor options specified by @option{-Wp}.
5557
5558 @item %a
5559 Process the @code{asm} spec.  This is used to compute the
5560 switches to be passed to the assembler.
5561
5562 @item %A
5563 Process the @code{asm_final} spec.  This is a spec string for
5564 passing switches to an assembler post-processor, if such a program is
5565 needed.
5566
5567 @item %l
5568 Process the @code{link} spec.  This is the spec for computing the
5569 command line passed to the linker.  Typically it will make use of the
5570 @samp{%L %G %S %D and %E} sequences.
5571
5572 @item %D
5573 Dump out a @option{-L} option for each directory that GCC believes might
5574 contain startup files.  If the target supports multilibs then the
5575 current multilib directory will be prepended to each of these paths.
5576
5577 @item %M
5578 Output the multilib directory with directory separators replaced with
5579 @samp{_}.  If multilib directories are not set, or the multilib directory is
5580 @file{.} then this option emits nothing.
5581
5582 @item %L
5583 Process the @code{lib} spec.  This is a spec string for deciding which
5584 libraries should be included on the command line to the linker.
5585
5586 @item %G
5587 Process the @code{libgcc} spec.  This is a spec string for deciding
5588 which GCC support library should be included on the command line to the linker.
5589
5590 @item %S
5591 Process the @code{startfile} spec.  This is a spec for deciding which
5592 object files should be the first ones passed to the linker.  Typically
5593 this might be a file named @file{crt0.o}.
5594
5595 @item %E
5596 Process the @code{endfile} spec.  This is a spec string that specifies
5597 the last object files that will be passed to the linker.
5598
5599 @item %C
5600 Process the @code{cpp} spec.  This is used to construct the arguments
5601 to be passed to the C preprocessor.
5602
5603 @item %c
5604 Process the @code{signed_char} spec.  This is intended to be used
5605 to tell cpp whether a char is signed.  It typically has the definition:
5606 @smallexample
5607 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5608 @end smallexample
5609
5610 @item %1
5611 Process the @code{cc1} spec.  This is used to construct the options to be
5612 passed to the actual C compiler (@samp{cc1}).
5613
5614 @item %2
5615 Process the @code{cc1plus} spec.  This is used to construct the options to be
5616 passed to the actual C++ compiler (@samp{cc1plus}).
5617
5618 @item %*
5619 Substitute the variable part of a matched option.  See below.
5620 Note that each comma in the substituted string is replaced by
5621 a single space.
5622
5623 @item %<@code{S}
5624 Remove all occurrences of @code{-S} from the command line.  Note---this
5625 command is position dependent.  @samp{%} commands in the spec string
5626 before this one will see @code{-S}, @samp{%} commands in the spec string
5627 after this one will not.
5628
5629 @item %:@var{function}(@var{args})
5630 Call the named function @var{function}, passing it @var{args}.
5631 @var{args} is first processed as a nested spec string, then split
5632 into an argument vector in the usual fashion.  The function returns
5633 a string which is processed as if it had appeared literally as part
5634 of the current spec.
5635
5636 The following built-in spec functions are provided:
5637
5638 @table @code
5639 @item @code{if-exists}
5640 The @code{if-exists} spec function takes one argument, an absolute
5641 pathname to a file.  If the file exists, @code{if-exists} returns the
5642 pathname.  Here is a small example of its usage:
5643
5644 @smallexample
5645 *startfile:
5646 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5647 @end smallexample
5648
5649 @item @code{if-exists-else}
5650 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5651 spec function, except that it takes two arguments.  The first argument is
5652 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5653 returns the pathname.  If it does not exist, it returns the second argument.
5654 This way, @code{if-exists-else} can be used to select one file or another,
5655 based on the existence of the first.  Here is a small example of its usage:
5656
5657 @smallexample
5658 *startfile:
5659 crt0%O%s %:if-exists(crti%O%s) \
5660 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5661 @end smallexample
5662 @end table
5663
5664 @item %@{@code{S}@}
5665 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5666 If that switch was not specified, this substitutes nothing.  Note that
5667 the leading dash is omitted when specifying this option, and it is
5668 automatically inserted if the substitution is performed.  Thus the spec
5669 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5670 and would output the command line option @option{-foo}.
5671
5672 @item %W@{@code{S}@}
5673 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5674 deleted on failure.
5675
5676 @item %@{@code{S}*@}
5677 Substitutes all the switches specified to GCC whose names start
5678 with @code{-S}, but which also take an argument.  This is used for
5679 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5680 GCC considers @option{-o foo} as being
5681 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5682 text, including the space.  Thus two arguments would be generated.
5683
5684 @item %@{@code{S}*&@code{T}*@}
5685 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5686 (the order of @code{S} and @code{T} in the spec is not significant).
5687 There can be any number of ampersand-separated variables; for each the
5688 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5689
5690 @item %@{@code{S}:@code{X}@}
5691 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5692
5693 @item %@{!@code{S}:@code{X}@}
5694 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5695
5696 @item %@{@code{S}*:@code{X}@}
5697 Substitutes @code{X} if one or more switches whose names start with
5698 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5699 once, no matter how many such switches appeared.  However, if @code{%*}
5700 appears somewhere in @code{X}, then @code{X} will be substituted once
5701 for each matching switch, with the @code{%*} replaced by the part of
5702 that switch that matched the @code{*}.
5703
5704 @item %@{.@code{S}:@code{X}@}
5705 Substitutes @code{X}, if processing a file with suffix @code{S}.
5706
5707 @item %@{!.@code{S}:@code{X}@}
5708 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5709
5710 @item %@{@code{S}|@code{P}:@code{X}@}
5711 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5712 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5713 although they have a stronger binding than the @samp{|}.  If @code{%*}
5714 appears in @code{X}, all of the alternatives must be starred, and only
5715 the first matching alternative is substituted.
5716
5717 For example, a spec string like this:
5718
5719 @smallexample
5720 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5721 @end smallexample
5722
5723 will output the following command-line options from the following input
5724 command-line options:
5725
5726 @smallexample
5727 fred.c        -foo -baz
5728 jim.d         -bar -boggle
5729 -d fred.c     -foo -baz -boggle
5730 -d jim.d      -bar -baz -boggle
5731 @end smallexample
5732
5733 @item %@{S:X; T:Y; :D@}
5734
5735 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5736 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5737 be as many clauses as you need.  This may be combined with @code{.},
5738 @code{!}, @code{|}, and @code{*} as needed.
5739
5740
5741 @end table
5742
5743 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5744 construct may contain other nested @samp{%} constructs or spaces, or
5745 even newlines.  They are processed as usual, as described above.
5746 Trailing white space in @code{X} is ignored.  White space may also
5747 appear anywhere on the left side of the colon in these constructs,
5748 except between @code{.} or @code{*} and the corresponding word.
5749
5750 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5751 handled specifically in these constructs.  If another value of
5752 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5753 @option{-W} switch is found later in the command line, the earlier
5754 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5755 just one letter, which passes all matching options.
5756
5757 The character @samp{|} at the beginning of the predicate text is used to
5758 indicate that a command should be piped to the following command, but
5759 only if @option{-pipe} is specified.
5760
5761 It is built into GCC which switches take arguments and which do not.
5762 (You might think it would be useful to generalize this to allow each
5763 compiler's spec to say which switches take arguments.  But this cannot
5764 be done in a consistent fashion.  GCC cannot even decide which input
5765 files have been specified without knowing which switches take arguments,
5766 and it must know which input files to compile in order to tell which
5767 compilers to run).
5768
5769 GCC also knows implicitly that arguments starting in @option{-l} are to be
5770 treated as compiler output files, and passed to the linker in their
5771 proper position among the other output files.
5772
5773 @c man begin OPTIONS
5774
5775 @node Target Options
5776 @section Specifying Target Machine and Compiler Version
5777 @cindex target options
5778 @cindex cross compiling
5779 @cindex specifying machine version
5780 @cindex specifying compiler version and target machine
5781 @cindex compiler version, specifying
5782 @cindex target machine, specifying
5783
5784 The usual way to run GCC is to run the executable called @file{gcc}, or
5785 @file{<machine>-gcc} when cross-compiling, or
5786 @file{<machine>-gcc-<version>} to run a version other than the one that
5787 was installed last.  Sometimes this is inconvenient, so GCC provides
5788 options that will switch to another cross-compiler or version.
5789
5790 @table @gcctabopt
5791 @item -b @var{machine}
5792 @opindex b
5793 The argument @var{machine} specifies the target machine for compilation.
5794
5795 The value to use for @var{machine} is the same as was specified as the
5796 machine type when configuring GCC as a cross-compiler.  For
5797 example, if a cross-compiler was configured with @samp{configure
5798 i386v}, meaning to compile for an 80386 running System V, then you
5799 would specify @option{-b i386v} to run that cross compiler.
5800
5801 @item -V @var{version}
5802 @opindex V
5803 The argument @var{version} specifies which version of GCC to run.
5804 This is useful when multiple versions are installed.  For example,
5805 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5806 @end table
5807
5808 The @option{-V} and @option{-b} options work by running the
5809 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5810 use them if you can just run that directly.
5811
5812 @node Submodel Options
5813 @section Hardware Models and Configurations
5814 @cindex submodel options
5815 @cindex specifying hardware config
5816 @cindex hardware models and configurations, specifying
5817 @cindex machine dependent options
5818
5819 Earlier we discussed the standard option @option{-b} which chooses among
5820 different installed compilers for completely different target
5821 machines, such as VAX vs.@: 68000 vs.@: 80386.
5822
5823 In addition, each of these target machine types can have its own
5824 special options, starting with @samp{-m}, to choose among various
5825 hardware models or configurations---for example, 68010 vs 68020,
5826 floating coprocessor or none.  A single installed version of the
5827 compiler can compile for any model or configuration, according to the
5828 options specified.
5829
5830 Some configurations of the compiler also support additional special
5831 options, usually for compatibility with other compilers on the same
5832 platform.
5833
5834 These options are defined by the macro @code{TARGET_SWITCHES} in the
5835 machine description.  The default for the options is also defined by
5836 that macro, which enables you to change the defaults.
5837
5838 @menu
5839 * M680x0 Options::
5840 * M68hc1x Options::
5841 * VAX Options::
5842 * SPARC Options::
5843 * ARM Options::
5844 * MN10300 Options::
5845 * M32R/D Options::
5846 * RS/6000 and PowerPC Options::
5847 * Darwin Options::
5848 * MIPS Options::
5849 * i386 and x86-64 Options::
5850 * HPPA Options::
5851 * Intel 960 Options::
5852 * DEC Alpha Options::
5853 * DEC Alpha/VMS Options::
5854 * H8/300 Options::
5855 * SH Options::
5856 * System V Options::
5857 * TMS320C3x/C4x Options::
5858 * V850 Options::
5859 * ARC Options::
5860 * NS32K Options::
5861 * AVR Options::
5862 * MCore Options::
5863 * IA-64 Options::
5864 * D30V Options::
5865 * S/390 and zSeries Options::
5866 * CRIS Options::
5867 * MMIX Options::
5868 * PDP-11 Options::
5869 * Xstormy16 Options::
5870 * Xtensa Options::
5871 * FRV Options::
5872 @end menu
5873
5874 @node M680x0 Options
5875 @subsection M680x0 Options
5876 @cindex M680x0 options
5877
5878 These are the @samp{-m} options defined for the 68000 series.  The default
5879 values for these options depends on which style of 68000 was selected when
5880 the compiler was configured; the defaults for the most common choices are
5881 given below.
5882
5883 @table @gcctabopt
5884 @item -m68000
5885 @itemx -mc68000
5886 @opindex m68000
5887 @opindex mc68000
5888 Generate output for a 68000.  This is the default
5889 when the compiler is configured for 68000-based systems.
5890
5891 Use this option for microcontrollers with a 68000 or EC000 core,
5892 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5893
5894 @item -m68020
5895 @itemx -mc68020
5896 @opindex m68020
5897 @opindex mc68020
5898 Generate output for a 68020.  This is the default
5899 when the compiler is configured for 68020-based systems.
5900
5901 @item -m68881
5902 @opindex m68881
5903 Generate output containing 68881 instructions for floating point.
5904 This is the default for most 68020 systems unless @option{--nfp} was
5905 specified when the compiler was configured.
5906
5907 @item -m68030
5908 @opindex m68030
5909 Generate output for a 68030.  This is the default when the compiler is
5910 configured for 68030-based systems.
5911
5912 @item -m68040
5913 @opindex m68040
5914 Generate output for a 68040.  This is the default when the compiler is
5915 configured for 68040-based systems.
5916
5917 This option inhibits the use of 68881/68882 instructions that have to be
5918 emulated by software on the 68040.  Use this option if your 68040 does not
5919 have code to emulate those instructions.
5920
5921 @item -m68060
5922 @opindex m68060
5923 Generate output for a 68060.  This is the default when the compiler is
5924 configured for 68060-based systems.
5925
5926 This option inhibits the use of 68020 and 68881/68882 instructions that
5927 have to be emulated by software on the 68060.  Use this option if your 68060
5928 does not have code to emulate those instructions.
5929
5930 @item -mcpu32
5931 @opindex mcpu32
5932 Generate output for a CPU32.  This is the default
5933 when the compiler is configured for CPU32-based systems.
5934
5935 Use this option for microcontrollers with a
5936 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5937 68336, 68340, 68341, 68349 and 68360.
5938
5939 @item -m5200
5940 @opindex m5200
5941 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5942 when the compiler is configured for 520X-based systems.
5943
5944 Use this option for microcontroller with a 5200 core, including
5945 the MCF5202, MCF5203, MCF5204 and MCF5202.
5946
5947
5948 @item -m68020-40
5949 @opindex m68020-40
5950 Generate output for a 68040, without using any of the new instructions.
5951 This results in code which can run relatively efficiently on either a
5952 68020/68881 or a 68030 or a 68040.  The generated code does use the
5953 68881 instructions that are emulated on the 68040.
5954
5955 @item -m68020-60
5956 @opindex m68020-60
5957 Generate output for a 68060, without using any of the new instructions.
5958 This results in code which can run relatively efficiently on either a
5959 68020/68881 or a 68030 or a 68040.  The generated code does use the
5960 68881 instructions that are emulated on the 68060.
5961
5962 @item -msoft-float
5963 @opindex msoft-float
5964 Generate output containing library calls for floating point.
5965 @strong{Warning:} the requisite libraries are not available for all m68k
5966 targets.  Normally the facilities of the machine's usual C compiler are
5967 used, but this can't be done directly in cross-compilation.  You must
5968 make your own arrangements to provide suitable library functions for
5969 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5970 @samp{m68k-*-coff} do provide software floating point support.
5971
5972 @item -mshort
5973 @opindex mshort
5974 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5975
5976 @item -mnobitfield
5977 @opindex mnobitfield
5978 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5979 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5980
5981 @item -mbitfield
5982 @opindex mbitfield
5983 Do use the bit-field instructions.  The @option{-m68020} option implies
5984 @option{-mbitfield}.  This is the default if you use a configuration
5985 designed for a 68020.
5986
5987 @item -mrtd
5988 @opindex mrtd
5989 Use a different function-calling convention, in which functions
5990 that take a fixed number of arguments return with the @code{rtd}
5991 instruction, which pops their arguments while returning.  This
5992 saves one instruction in the caller since there is no need to pop
5993 the arguments there.
5994
5995 This calling convention is incompatible with the one normally
5996 used on Unix, so you cannot use it if you need to call libraries
5997 compiled with the Unix compiler.
5998
5999 Also, you must provide function prototypes for all functions that
6000 take variable numbers of arguments (including @code{printf});
6001 otherwise incorrect code will be generated for calls to those
6002 functions.
6003
6004 In addition, seriously incorrect code will result if you call a
6005 function with too many arguments.  (Normally, extra arguments are
6006 harmlessly ignored.)
6007
6008 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6009 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6010
6011 @item -malign-int
6012 @itemx -mno-align-int
6013 @opindex malign-int
6014 @opindex mno-align-int
6015 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6016 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6017 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6018 Aligning variables on 32-bit boundaries produces code that runs somewhat
6019 faster on processors with 32-bit busses at the expense of more memory.
6020
6021 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6022 align structures containing the above types  differently than
6023 most published application binary interface specifications for the m68k.
6024
6025 @item -mpcrel
6026 @opindex mpcrel
6027 Use the pc-relative addressing mode of the 68000 directly, instead of
6028 using a global offset table.  At present, this option implies @option{-fpic},
6029 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6030 not presently supported with @option{-mpcrel}, though this could be supported for
6031 68020 and higher processors.
6032
6033 @item -mno-strict-align
6034 @itemx -mstrict-align
6035 @opindex mno-strict-align
6036 @opindex mstrict-align
6037 Do not (do) assume that unaligned memory references will be handled by
6038 the system.
6039
6040 @item -msep-data
6041 Generate code that allows the data segment to be located in a different
6042 area of memory from the text segment.  This allows for execute in place in
6043 an environment without virtual memory management.  This option implies -fPIC.
6044
6045 @item -mno-sep-data
6046 Generate code that assumes that the data segment follows the text segment.
6047 This is the default.
6048
6049 @item -mid-shared-library
6050 Generate code that supports shared libraries via the library ID method.
6051 This allows for execute in place and shared libraries in an environment
6052 without virtual memory management.  This option implies -fPIC.
6053
6054 @item -mno-id-shared-library
6055 Generate code that doesn't assume ID based shared libraries are being used.
6056 This is the default.
6057
6058 @item -mshared-library-id=n
6059 Specified the identification number of the ID based shared library being
6060 compiled.  Specifying a value of 0 will generate more compact code, specifying
6061 other values will force the allocation of that number to the current
6062 library but is no more space or time efficient than omitting this option.
6063
6064 @end table
6065
6066 @node M68hc1x Options
6067 @subsection M68hc1x Options
6068 @cindex M68hc1x options
6069
6070 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6071 microcontrollers.  The default values for these options depends on
6072 which style of microcontroller was selected when the compiler was configured;
6073 the defaults for the most common choices are given below.
6074
6075 @table @gcctabopt
6076 @item -m6811
6077 @itemx -m68hc11
6078 @opindex m6811
6079 @opindex m68hc11
6080 Generate output for a 68HC11.  This is the default
6081 when the compiler is configured for 68HC11-based systems.
6082
6083 @item -m6812
6084 @itemx -m68hc12
6085 @opindex m6812
6086 @opindex m68hc12
6087 Generate output for a 68HC12.  This is the default
6088 when the compiler is configured for 68HC12-based systems.
6089
6090 @item -m68S12
6091 @itemx -m68hcs12
6092 @opindex m68S12
6093 @opindex m68hcs12
6094 Generate output for a 68HCS12.
6095
6096 @item -mauto-incdec
6097 @opindex mauto-incdec
6098 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6099 addressing modes.
6100
6101 @item -minmax
6102 @itemx -nominmax
6103 @opindex minmax
6104 @opindex mnominmax
6105 Enable the use of 68HC12 min and max instructions.
6106
6107 @item -mlong-calls
6108 @itemx -mno-long-calls
6109 @opindex mlong-calls
6110 @opindex mno-long-calls
6111 Treat all calls as being far away (near).  If calls are assumed to be
6112 far away, the compiler will use the @code{call} instruction to
6113 call a function and the @code{rtc} instruction for returning.
6114
6115 @item -mshort
6116 @opindex mshort
6117 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6118
6119 @item -msoft-reg-count=@var{count}
6120 @opindex msoft-reg-count
6121 Specify the number of pseudo-soft registers which are used for the
6122 code generation.  The maximum number is 32.  Using more pseudo-soft
6123 register may or may not result in better code depending on the program.
6124 The default is 4 for 68HC11 and 2 for 68HC12.
6125
6126 @end table
6127
6128 @node VAX Options
6129 @subsection VAX Options
6130 @cindex VAX options
6131
6132 These @samp{-m} options are defined for the VAX:
6133
6134 @table @gcctabopt
6135 @item -munix
6136 @opindex munix
6137 Do not output certain jump instructions (@code{aobleq} and so on)
6138 that the Unix assembler for the VAX cannot handle across long
6139 ranges.
6140
6141 @item -mgnu
6142 @opindex mgnu
6143 Do output those jump instructions, on the assumption that you
6144 will assemble with the GNU assembler.
6145
6146 @item -mg
6147 @opindex mg
6148 Output code for g-format floating point numbers instead of d-format.
6149 @end table
6150
6151 @node SPARC Options
6152 @subsection SPARC Options
6153 @cindex SPARC options
6154
6155 These @samp{-m} options are supported on the SPARC:
6156
6157 @table @gcctabopt
6158 @item -mno-app-regs
6159 @itemx -mapp-regs
6160 @opindex mno-app-regs
6161 @opindex mapp-regs
6162 Specify @option{-mapp-regs} to generate output using the global registers
6163 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6164 is the default.
6165
6166 To be fully SVR4 ABI compliant at the cost of some performance loss,
6167 specify @option{-mno-app-regs}.  You should compile libraries and system
6168 software with this option.
6169
6170 @item -mfpu
6171 @itemx -mhard-float
6172 @opindex mfpu
6173 @opindex mhard-float
6174 Generate output containing floating point instructions.  This is the
6175 default.
6176
6177 @item -mno-fpu
6178 @itemx -msoft-float
6179 @opindex mno-fpu
6180 @opindex msoft-float
6181 Generate output containing library calls for floating point.
6182 @strong{Warning:} the requisite libraries are not available for all SPARC
6183 targets.  Normally the facilities of the machine's usual C compiler are
6184 used, but this cannot be done directly in cross-compilation.  You must make
6185 your own arrangements to provide suitable library functions for
6186 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6187 @samp{sparclite-*-*} do provide software floating point support.
6188
6189 @option{-msoft-float} changes the calling convention in the output file;
6190 therefore, it is only useful if you compile @emph{all} of a program with
6191 this option.  In particular, you need to compile @file{libgcc.a}, the
6192 library that comes with GCC, with @option{-msoft-float} in order for
6193 this to work.
6194
6195 @item -mhard-quad-float
6196 @opindex mhard-quad-float
6197 Generate output containing quad-word (long double) floating point
6198 instructions.
6199
6200 @item -msoft-quad-float
6201 @opindex msoft-quad-float
6202 Generate output containing library calls for quad-word (long double)
6203 floating point instructions.  The functions called are those specified
6204 in the SPARC ABI@.  This is the default.
6205
6206 As of this writing, there are no SPARC implementations that have hardware
6207 support for the quad-word floating point instructions.  They all invoke
6208 a trap handler for one of these instructions, and then the trap handler
6209 emulates the effect of the instruction.  Because of the trap handler overhead,
6210 this is much slower than calling the ABI library routines.  Thus the
6211 @option{-msoft-quad-float} option is the default.
6212
6213 @item -mno-flat
6214 @itemx -mflat
6215 @opindex mno-flat
6216 @opindex mflat
6217 With @option{-mflat}, the compiler does not generate save/restore instructions
6218 and will use a ``flat'' or single register window calling convention.
6219 This model uses %i7 as the frame pointer and is compatible with the normal
6220 register window model.  Code from either may be intermixed.
6221 The local registers and the input registers (0--5) are still treated as
6222 ``call saved'' registers and will be saved on the stack as necessary.
6223
6224 With @option{-mno-flat} (the default), the compiler emits save/restore
6225 instructions (except for leaf functions) and is the normal mode of operation.
6226
6227 These options are deprecated and will be deleted in a future GCC release.
6228
6229 @item -mno-unaligned-doubles
6230 @itemx -munaligned-doubles
6231 @opindex mno-unaligned-doubles
6232 @opindex munaligned-doubles
6233 Assume that doubles have 8 byte alignment.  This is the default.
6234
6235 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6236 alignment only if they are contained in another type, or if they have an
6237 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6238 Specifying this option avoids some rare compatibility problems with code
6239 generated by other compilers.  It is not the default because it results
6240 in a performance loss, especially for floating point code.
6241
6242 @item -mno-faster-structs
6243 @itemx -mfaster-structs
6244 @opindex mno-faster-structs
6245 @opindex mfaster-structs
6246 With @option{-mfaster-structs}, the compiler assumes that structures
6247 should have 8 byte alignment.  This enables the use of pairs of
6248 @code{ldd} and @code{std} instructions for copies in structure
6249 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6250 However, the use of this changed alignment directly violates the SPARC
6251 ABI@.  Thus, it's intended only for use on targets where the developer
6252 acknowledges that their resulting code will not be directly in line with
6253 the rules of the ABI@.
6254
6255 @item -mimpure-text
6256 @opindex mimpure-text
6257 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6258 the compiler to not pass @option{-z text} to the linker when linking a
6259 shared object.  Using this option, you can link position-dependent
6260 code into a shared object.
6261
6262 @option{-mimpure-text} suppresses the ``relocations remain against
6263 allocatable but non-writable sections'' linker error message.
6264 However, the necessary relocations will trigger copy-on-write, and the
6265 shared object is not actually shared across processes.  Instead of
6266 using @option{-mimpure-text}, you should compile all source code with
6267 @option{-fpic} or @option{-fPIC}.
6268
6269 This option is only available on SunOS and Solaris.
6270
6271 @item -mv8
6272 @itemx -msparclite
6273 @opindex mv8
6274 @opindex msparclite
6275 These two options select variations on the SPARC architecture.
6276 These options are deprecated and will be deleted in a future GCC release.
6277 They have been replaced with @option{-mcpu=xxx}.
6278
6279 @item -mcypress
6280 @itemx -msupersparc
6281 @itemx -mf930
6282 @itemx -mf934
6283 @opindex mcypress
6284 @opindex msupersparc
6285 @opindex -mf930
6286 @opindex -mf934
6287 These four options select the processor for which the code is optimized.
6288 These options are deprecated and will be deleted in a future GCC release.
6289 They have been replaced with @option{-mcpu=xxx}.
6290
6291 @item -mcpu=@var{cpu_type}
6292 @opindex mcpu
6293 Set the instruction set, register set, and instruction scheduling parameters
6294 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6295 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6296 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
6297 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6298 @samp{ultrasparc3}.
6299
6300 Default instruction scheduling parameters are used for values that select
6301 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6302 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6303
6304 Here is a list of each supported architecture and their supported
6305 implementations.
6306
6307 @smallexample
6308     v7:             cypress
6309     v8:             supersparc, hypersparc
6310     sparclite:      f930, f934, sparclite86x
6311     sparclet:       tsc701
6312     v9:             ultrasparc, ultrasparc3
6313 @end smallexample
6314
6315 By default (unless configured otherwise), GCC generates code for the V7
6316 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
6317 additionally optimizes it for the Cypress CY7C602 chip, as used in the
6318 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
6319 SPARCStation 1, 2, IPX etc.
6320
6321 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
6322 architecture.  The only difference from V7 code is that the compiler emits
6323 the integer multiply and integer divide instructions which exist in SPARC-V8
6324 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
6325 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
6326 2000 series.
6327
6328 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
6329 the SPARC architecture.  This adds the integer multiply, integer divide step
6330 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
6331 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
6332 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
6333 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
6334 MB86934 chip, which is the more recent SPARClite with FPU.
6335
6336 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
6337 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
6338 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
6339 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
6340 optimizes it for the TEMIC SPARClet chip.
6341
6342 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
6343 architecture.  This adds 64-bit integer and floating-point move instructions,
6344 3 additional floating-point condition code registers and conditional move
6345 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
6346 optimizes it for the Sun UltraSPARC I/II chips.  With
6347 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
6348 Sun UltraSPARC III chip.
6349
6350 @item -mtune=@var{cpu_type}
6351 @opindex mtune
6352 Set the instruction scheduling parameters for machine type
6353 @var{cpu_type}, but do not set the instruction set or register set that the
6354 option @option{-mcpu=@var{cpu_type}} would.
6355
6356 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6357 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6358 that select a particular cpu implementation.  Those are @samp{cypress},
6359 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6360 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6361 @samp{ultrasparc3}.
6362
6363 @item -mv8plus
6364 @itemx -mno-v8plus
6365 @opindex mv8plus
6366 @opindex mno-v8plus
6367 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
6368 difference from the V8 ABI is that the global and out registers are
6369 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
6370 mode for all SPARC-V9 processors.
6371
6372 @item -mvis
6373 @itemx -mno-vis
6374 @opindex mvis
6375 @opindex mno-vis
6376 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
6377 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
6378 @end table
6379
6380 These @samp{-m} options are supported in addition to the above
6381 on SPARC-V9 processors in 64-bit environments:
6382
6383 @table @gcctabopt
6384 @item -mlittle-endian
6385 @opindex mlittle-endian
6386 Generate code for a processor running in little-endian mode. It is only
6387 available for a few configurations and most notably not on Solaris.
6388
6389 @item -m32
6390 @itemx -m64
6391 @opindex m32
6392 @opindex m64
6393 Generate code for a 32-bit or 64-bit environment.
6394 The 32-bit environment sets int, long and pointer to 32 bits.
6395 The 64-bit environment sets int to 32 bits and long and pointer
6396 to 64 bits.
6397
6398 @item -mcmodel=medlow
6399 @opindex mcmodel=medlow
6400 Generate code for the Medium/Low code model: 64-bit addresses, programs
6401 must be linked in the low 32 bits of memory.  Programs can be statically
6402 or dynamically linked.
6403
6404 @item -mcmodel=medmid
6405 @opindex mcmodel=medmid
6406 Generate code for the Medium/Middle code model: 64-bit addresses, programs
6407 must be linked in the low 44 bits of memory, the text and data segments must
6408 be less than 2GB in size and the data segment must be located within 2GB of
6409 the text segment.
6410
6411 @item -mcmodel=medany
6412 @opindex mcmodel=medany
6413 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
6414 may be linked anywhere in memory, the text and data segments must be less
6415 than 2GB in size and the data segment must be located within 2GB of the
6416 text segment.
6417
6418 @item -mcmodel=embmedany
6419 @opindex mcmodel=embmedany
6420 Generate code for the Medium/Anywhere code model for embedded systems:
6421 64-bit addresses, the text and data segments must be less than 2GB in
6422 size, both starting anywhere in memory (determined at link time).  The
6423 global register %g4 points to the base of the data segment.  Programs
6424 are statically linked and PIC is not supported.
6425
6426 @item -mstack-bias
6427 @itemx -mno-stack-bias
6428 @opindex mstack-bias
6429 @opindex mno-stack-bias
6430 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6431 frame pointer if present, are offset by @minus{}2047 which must be added back
6432 when making stack frame references.  This is the default in 64-bit mode.
6433 Otherwise, assume no such offset is present.
6434 @end table
6435
6436 @node ARM Options
6437 @subsection ARM Options
6438 @cindex ARM options
6439
6440 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6441 architectures:
6442
6443 @table @gcctabopt
6444 @item -mapcs-frame
6445 @opindex mapcs-frame
6446 Generate a stack frame that is compliant with the ARM Procedure Call
6447 Standard for all functions, even if this is not strictly necessary for
6448 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6449 with this option will cause the stack frames not to be generated for
6450 leaf functions.  The default is @option{-mno-apcs-frame}.
6451
6452 @item -mapcs
6453 @opindex mapcs
6454 This is a synonym for @option{-mapcs-frame}.
6455
6456 @item -mapcs-26
6457 @opindex mapcs-26
6458 Generate code for a processor running with a 26-bit program counter,
6459 and conforming to the function calling standards for the APCS 26-bit
6460 option.
6461
6462 This option is deprecated.  Future releases of the GCC will only support
6463 generating code that runs in apcs-32 mode.
6464
6465 @item -mapcs-32
6466 @opindex mapcs-32
6467 Generate code for a processor running with a 32-bit program counter,
6468 and conforming to the function calling standards for the APCS 32-bit
6469 option.
6470
6471 This flag is deprecated.  Future releases of GCC will make this flag
6472 unconditional.
6473
6474 @ignore
6475 @c not currently implemented
6476 @item -mapcs-stack-check
6477 @opindex mapcs-stack-check
6478 Generate code to check the amount of stack space available upon entry to
6479 every function (that actually uses some stack space).  If there is
6480 insufficient space available then either the function
6481 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6482 called, depending upon the amount of stack space required.  The run time
6483 system is required to provide these functions.  The default is
6484 @option{-mno-apcs-stack-check}, since this produces smaller code.
6485
6486 @c not currently implemented
6487 @item -mapcs-float
6488 @opindex mapcs-float
6489 Pass floating point arguments using the float point registers.  This is
6490 one of the variants of the APCS@.  This option is recommended if the
6491 target hardware has a floating point unit or if a lot of floating point
6492 arithmetic is going to be performed by the code.  The default is
6493 @option{-mno-apcs-float}, since integer only code is slightly increased in
6494 size if @option{-mapcs-float} is used.
6495
6496 @c not currently implemented
6497 @item -mapcs-reentrant
6498 @opindex mapcs-reentrant
6499 Generate reentrant, position independent code.  The default is
6500 @option{-mno-apcs-reentrant}.
6501 @end ignore
6502
6503 @item -mthumb-interwork
6504 @opindex mthumb-interwork
6505 Generate code which supports calling between the ARM and Thumb
6506 instruction sets.  Without this option the two instruction sets cannot
6507 be reliably used inside one program.  The default is
6508 @option{-mno-thumb-interwork}, since slightly larger code is generated
6509 when @option{-mthumb-interwork} is specified.
6510
6511 @item -mno-sched-prolog
6512 @opindex mno-sched-prolog
6513 Prevent the reordering of instructions in the function prolog, or the
6514 merging of those instruction with the instructions in the function's
6515 body.  This means that all functions will start with a recognizable set
6516 of instructions (or in fact one of a choice from a small set of
6517 different function prologues), and this information can be used to
6518 locate the start if functions inside an executable piece of code.  The
6519 default is @option{-msched-prolog}.
6520
6521 @item -mhard-float
6522 @opindex mhard-float
6523 Generate output containing floating point instructions.  This is the
6524 default.
6525
6526 @item -msoft-float
6527 @opindex msoft-float
6528 Generate output containing library calls for floating point.
6529 @strong{Warning:} the requisite libraries are not available for all ARM
6530 targets.  Normally the facilities of the machine's usual C compiler are
6531 used, but this cannot be done directly in cross-compilation.  You must make
6532 your own arrangements to provide suitable library functions for
6533 cross-compilation.
6534
6535 @option{-msoft-float} changes the calling convention in the output file;
6536 therefore, it is only useful if you compile @emph{all} of a program with
6537 this option.  In particular, you need to compile @file{libgcc.a}, the
6538 library that comes with GCC, with @option{-msoft-float} in order for
6539 this to work.
6540
6541 @item -mlittle-endian
6542 @opindex mlittle-endian
6543 Generate code for a processor running in little-endian mode.  This is
6544 the default for all standard configurations.
6545
6546 @item -mbig-endian
6547 @opindex mbig-endian
6548 Generate code for a processor running in big-endian mode; the default is
6549 to compile code for a little-endian processor.
6550
6551 @item -mwords-little-endian
6552 @opindex mwords-little-endian
6553 This option only applies when generating code for big-endian processors.
6554 Generate code for a little-endian word order but a big-endian byte
6555 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6556 option should only be used if you require compatibility with code for
6557 big-endian ARM processors generated by versions of the compiler prior to
6558 2.8.
6559
6560 @item -malignment-traps
6561 @opindex malignment-traps
6562 Generate code that will not trap if the MMU has alignment traps enabled.
6563 On ARM architectures prior to ARMv4, there were no instructions to
6564 access half-word objects stored in memory.  However, when reading from
6565 memory a feature of the ARM architecture allows a word load to be used,
6566 even if the address is unaligned, and the processor core will rotate the
6567 data as it is being loaded.  This option tells the compiler that such
6568 misaligned accesses will cause a MMU trap and that it should instead
6569 synthesize the access as a series of byte accesses.  The compiler can
6570 still use word accesses to load half-word data if it knows that the
6571 address is aligned to a word boundary.
6572
6573 This option has no effect when compiling for ARM architecture 4 or later,
6574 since these processors have instructions to directly access half-word
6575 objects in memory.
6576
6577 @item -mno-alignment-traps
6578 @opindex mno-alignment-traps
6579 Generate code that assumes that the MMU will not trap unaligned
6580 accesses.  This produces better code when the target instruction set
6581 does not have half-word memory operations (i.e.@: implementations prior to
6582 ARMv4).
6583
6584 Note that you cannot use this option to access unaligned word objects,
6585 since the processor will only fetch one 32-bit aligned object from
6586 memory.
6587
6588 The default setting is @option{-malignment-traps}, since this produces
6589 code that will also run on processors implementing ARM architecture
6590 version 6 or later.
6591
6592 This option is deprecated and will be removed in the next release of GCC.
6593
6594 @item -mcpu=@var{name}
6595 @opindex mcpu
6596 This specifies the name of the target ARM processor.  GCC uses this name
6597 to determine what kind of instructions it can emit when generating
6598 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6599 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6600 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6601 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6602 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6603 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6604 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6605 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6606 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6607 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6608 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6609 @samp{ep9312}.
6610
6611 @itemx -mtune=@var{name}
6612 @opindex mtune
6613 This option is very similar to the @option{-mcpu=} option, except that
6614 instead of specifying the actual target processor type, and hence
6615 restricting which instructions can be used, it specifies that GCC should
6616 tune the performance of the code as if the target were of the type
6617 specified in this option, but still choosing the instructions that it
6618 will generate based on the cpu specified by a @option{-mcpu=} option.
6619 For some ARM implementations better performance can be obtained by using
6620 this option.
6621
6622 @item -march=@var{name}
6623 @opindex march
6624 This specifies the name of the target ARM architecture.  GCC uses this
6625 name to determine what kind of instructions it can emit when generating
6626 assembly code.  This option can be used in conjunction with or instead
6627 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6628 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6629 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6630 @samp{iwmmxt}, @samp{ep9312}.
6631
6632 @item -mfpe=@var{number}
6633 @itemx -mfp=@var{number}
6634 @opindex mfpe
6635 @opindex mfp
6636 This specifies the version of the floating point emulation available on
6637 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6638 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6639
6640 @item -mstructure-size-boundary=@var{n}
6641 @opindex mstructure-size-boundary
6642 The size of all structures and unions will be rounded up to a multiple
6643 of the number of bits set by this option.  Permissible values are 8 and
6644 32.  The default value varies for different toolchains.  For the COFF
6645 targeted toolchain the default value is 8.  Specifying the larger number
6646 can produce faster, more efficient code, but can also increase the size
6647 of the program.  The two values are potentially incompatible.  Code
6648 compiled with one value cannot necessarily expect to work with code or
6649 libraries compiled with the other value, if they exchange information
6650 using structures or unions.
6651
6652 @item -mabort-on-noreturn
6653 @opindex mabort-on-noreturn
6654 Generate a call to the function @code{abort} at the end of a
6655 @code{noreturn} function.  It will be executed if the function tries to
6656 return.
6657
6658 @item -mlong-calls
6659 @itemx -mno-long-calls
6660 @opindex mlong-calls
6661 @opindex mno-long-calls
6662 Tells the compiler to perform function calls by first loading the
6663 address of the function into a register and then performing a subroutine
6664 call on this register.  This switch is needed if the target function
6665 will lie outside of the 64 megabyte addressing range of the offset based
6666 version of subroutine call instruction.
6667
6668 Even if this switch is enabled, not all function calls will be turned
6669 into long calls.  The heuristic is that static functions, functions
6670 which have the @samp{short-call} attribute, functions that are inside
6671 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6672 definitions have already been compiled within the current compilation
6673 unit, will not be turned into long calls.  The exception to this rule is
6674 that weak function definitions, functions with the @samp{long-call}
6675 attribute or the @samp{section} attribute, and functions that are within
6676 the scope of a @samp{#pragma long_calls} directive, will always be
6677 turned into long calls.
6678
6679 This feature is not enabled by default.  Specifying
6680 @option{-mno-long-calls} will restore the default behavior, as will
6681 placing the function calls within the scope of a @samp{#pragma
6682 long_calls_off} directive.  Note these switches have no effect on how
6683 the compiler generates code to handle function calls via function
6684 pointers.
6685
6686 @item -mnop-fun-dllimport
6687 @opindex mnop-fun-dllimport
6688 Disable support for the @code{dllimport} attribute.
6689
6690 @item -msingle-pic-base
6691 @opindex msingle-pic-base
6692 Treat the register used for PIC addressing as read-only, rather than
6693 loading it in the prologue for each function.  The run-time system is
6694 responsible for initializing this register with an appropriate value
6695 before execution begins.
6696
6697 @item -mpic-register=@var{reg}
6698 @opindex mpic-register
6699 Specify the register to be used for PIC addressing.  The default is R10
6700 unless stack-checking is enabled, when R9 is used.
6701
6702 @item -mcirrus-fix-invalid-insns
6703 @opindex mcirrus-fix-invalid-insns
6704 @opindex mno-cirrus-fix-invalid-insns
6705 Insert NOPs into the instruction stream to in order to work around
6706 problems with invalid Maverick instruction combinations.  This option
6707 is only valid if the @option{-mcpu=ep9312} option has been used to
6708 enable generation of instructions for the Cirrus Maverick floating
6709 point co-processor.  This option is not enabled by default, since the
6710 problem is only present in older Maverick implementations.  The default
6711 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6712 switch.
6713
6714 @item -mpoke-function-name
6715 @opindex mpoke-function-name
6716 Write the name of each function into the text section, directly
6717 preceding the function prologue.  The generated code is similar to this:
6718
6719 @smallexample
6720      t0
6721          .ascii "arm_poke_function_name", 0
6722          .align
6723      t1
6724          .word 0xff000000 + (t1 - t0)
6725      arm_poke_function_name
6726          mov     ip, sp
6727          stmfd   sp!, @{fp, ip, lr, pc@}
6728          sub     fp, ip, #4
6729 @end smallexample
6730
6731 When performing a stack backtrace, code can inspect the value of
6732 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6733 location @code{pc - 12} and the top 8 bits are set, then we know that
6734 there is a function name embedded immediately preceding this location
6735 and has length @code{((pc[-3]) & 0xff000000)}.
6736
6737 @item -mthumb
6738 @opindex mthumb
6739 Generate code for the 16-bit Thumb instruction set.  The default is to
6740 use the 32-bit ARM instruction set.
6741
6742 @item -mtpcs-frame
6743 @opindex mtpcs-frame
6744 Generate a stack frame that is compliant with the Thumb Procedure Call
6745 Standard for all non-leaf functions.  (A leaf function is one that does
6746 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6747
6748 @item -mtpcs-leaf-frame
6749 @opindex mtpcs-leaf-frame
6750 Generate a stack frame that is compliant with the Thumb Procedure Call
6751 Standard for all leaf functions.  (A leaf function is one that does
6752 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6753
6754 @item -mcallee-super-interworking
6755 @opindex mcallee-super-interworking
6756 Gives all externally visible functions in the file being compiled an ARM
6757 instruction set header which switches to Thumb mode before executing the
6758 rest of the function.  This allows these functions to be called from
6759 non-interworking code.
6760
6761 @item -mcaller-super-interworking
6762 @opindex mcaller-super-interworking
6763 Allows calls via function pointers (including virtual functions) to
6764 execute correctly regardless of whether the target code has been
6765 compiled for interworking or not.  There is a small overhead in the cost
6766 of executing a function pointer if this option is enabled.
6767
6768 @end table
6769
6770 @node MN10300 Options
6771 @subsection MN10300 Options
6772 @cindex MN10300 options
6773
6774 These @option{-m} options are defined for Matsushita MN10300 architectures:
6775
6776 @table @gcctabopt
6777 @item -mmult-bug
6778 @opindex mmult-bug
6779 Generate code to avoid bugs in the multiply instructions for the MN10300
6780 processors.  This is the default.
6781
6782 @item -mno-mult-bug
6783 @opindex mno-mult-bug
6784 Do not generate code to avoid bugs in the multiply instructions for the
6785 MN10300 processors.
6786
6787 @item -mam33
6788 @opindex mam33
6789 Generate code which uses features specific to the AM33 processor.
6790
6791 @item -mno-am33
6792 @opindex mno-am33
6793 Do not generate code which uses features specific to the AM33 processor.  This
6794 is the default.
6795
6796 @item -mno-crt0
6797 @opindex mno-crt0
6798 Do not link in the C run-time initialization object file.
6799
6800 @item -mrelax
6801 @opindex mrelax
6802 Indicate to the linker that it should perform a relaxation optimization pass
6803 to shorten branches, calls and absolute memory addresses.  This option only
6804 has an effect when used on the command line for the final link step.
6805
6806 This option makes symbolic debugging impossible.
6807 @end table
6808
6809
6810 @node M32R/D Options
6811 @subsection M32R/D Options
6812 @cindex M32R/D options
6813
6814 These @option{-m} options are defined for Renesas M32R/D architectures:
6815
6816 @table @gcctabopt
6817 @item -m32r2
6818 @opindex m32r2
6819 Generate code for the M32R/2@.
6820
6821 @item -m32rx
6822 @opindex m32rx
6823 Generate code for the M32R/X@.
6824
6825 @item -m32r
6826 @opindex m32r
6827 Generate code for the M32R@.  This is the default.
6828
6829 @item -mmodel=small
6830 @opindex mmodel=small
6831 Assume all objects live in the lower 16MB of memory (so that their addresses
6832 can be loaded with the @code{ld24} instruction), and assume all subroutines
6833 are reachable with the @code{bl} instruction.
6834 This is the default.
6835
6836 The addressability of a particular object can be set with the
6837 @code{model} attribute.
6838
6839 @item -mmodel=medium
6840 @opindex mmodel=medium
6841 Assume objects may be anywhere in the 32-bit address space (the compiler
6842 will generate @code{seth/add3} instructions to load their addresses), and
6843 assume all subroutines are reachable with the @code{bl} instruction.
6844
6845 @item -mmodel=large
6846 @opindex mmodel=large
6847 Assume objects may be anywhere in the 32-bit address space (the compiler
6848 will generate @code{seth/add3} instructions to load their addresses), and
6849 assume subroutines may not be reachable with the @code{bl} instruction
6850 (the compiler will generate the much slower @code{seth/add3/jl}
6851 instruction sequence).
6852
6853 @item -msdata=none
6854 @opindex msdata=none
6855 Disable use of the small data area.  Variables will be put into
6856 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6857 @code{section} attribute has been specified).
6858 This is the default.
6859
6860 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6861 Objects may be explicitly put in the small data area with the
6862 @code{section} attribute using one of these sections.
6863
6864 @item -msdata=sdata
6865 @opindex msdata=sdata
6866 Put small global and static data in the small data area, but do not
6867 generate special code to reference them.
6868
6869 @item -msdata=use
6870 @opindex msdata=use
6871 Put small global and static data in the small data area, and generate
6872 special instructions to reference them.
6873
6874 @item -G @var{num}
6875 @opindex G
6876 @cindex smaller data references
6877 Put global and static objects less than or equal to @var{num} bytes
6878 into the small data or bss sections instead of the normal data or bss
6879 sections.  The default value of @var{num} is 8.
6880 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6881 for this option to have any effect.
6882
6883 All modules should be compiled with the same @option{-G @var{num}} value.
6884 Compiling with different values of @var{num} may or may not work; if it
6885 doesn't the linker will give an error message---incorrect code will not be
6886 generated.
6887
6888 @item -mdebug
6889 @opindex mdebug
6890 Makes the M32R specific code in the compiler display some statistics
6891 that might help in debugging programs.
6892
6893 @item -malign-loops
6894 @opindex malign-loops
6895 Align all loops to a 32-byte boundary.
6896
6897 @item -mno-align-loops
6898 @opindex mno-align-loops
6899 Do not enforce a 32-byte alignment for loops.  This is the default.
6900
6901 @item -missue-rate=@var{number}
6902 @opindex missue-rate=@var{number}
6903 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6904 or 2.
6905
6906 @item -mbranch-cost=@var{number}
6907 @opindex mbranch-cost=@var{number}
6908 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6909 preferred over conditional code, if it is 2, then the opposite will
6910 apply.
6911
6912 @item -mflush-trap=@var{number}
6913 @opindex mflush-trap=@var{number}
6914 Specifies the trap number to use to flush the cache.  The default is
6915 12.  Valid numbers are between 0 and 15 inclusive.
6916
6917 @item -mno-flush-trap
6918 @opindex mno-flush-trap
6919 Specifies that the cache cannot be flushed by using a trap.
6920
6921 @item -mflush-func=@var{name}
6922 @opindex mflush-func=@var{name}
6923 Specifies the name of the operating system function to call to flush
6924 the cache.  The default is @emph{_flush_cache}, but a function call
6925 will only be used if a trap is not available.
6926
6927 @item -mno-flush-func
6928 @opindex mno-flush-func
6929 Indicates that there is no OS function for flushing the cache.
6930
6931 @end table
6932
6933 @node RS/6000 and PowerPC Options
6934 @subsection IBM RS/6000 and PowerPC Options
6935 @cindex RS/6000 and PowerPC Options
6936 @cindex IBM RS/6000 and PowerPC Options
6937
6938 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6939 @table @gcctabopt
6940 @item -mpower
6941 @itemx -mno-power
6942 @itemx -mpower2
6943 @itemx -mno-power2
6944 @itemx -mpowerpc
6945 @itemx -mno-powerpc
6946 @itemx -mpowerpc-gpopt
6947 @itemx -mno-powerpc-gpopt
6948 @itemx -mpowerpc-gfxopt
6949 @itemx -mno-powerpc-gfxopt
6950 @itemx -mpowerpc64
6951 @itemx -mno-powerpc64
6952 @opindex mpower
6953 @opindex mno-power
6954 @opindex mpower2
6955 @opindex mno-power2
6956 @opindex mpowerpc
6957 @opindex mno-powerpc
6958 @opindex mpowerpc-gpopt
6959 @opindex mno-powerpc-gpopt
6960 @opindex mpowerpc-gfxopt
6961 @opindex mno-powerpc-gfxopt
6962 @opindex mpowerpc64
6963 @opindex mno-powerpc64
6964 GCC supports two related instruction set architectures for the
6965 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6966 instructions supported by the @samp{rios} chip set used in the original
6967 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6968 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6969 the IBM 4xx microprocessors.
6970
6971 Neither architecture is a subset of the other.  However there is a
6972 large common subset of instructions supported by both.  An MQ
6973 register is included in processors supporting the POWER architecture.
6974
6975 You use these options to specify which instructions are available on the
6976 processor you are using.  The default value of these options is
6977 determined when configuring GCC@.  Specifying the
6978 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6979 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6980 rather than the options listed above.
6981
6982 The @option{-mpower} option allows GCC to generate instructions that
6983 are found only in the POWER architecture and to use the MQ register.
6984 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6985 to generate instructions that are present in the POWER2 architecture but
6986 not the original POWER architecture.
6987
6988 The @option{-mpowerpc} option allows GCC to generate instructions that
6989 are found only in the 32-bit subset of the PowerPC architecture.
6990 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6991 GCC to use the optional PowerPC architecture instructions in the
6992 General Purpose group, including floating-point square root.  Specifying
6993 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6994 use the optional PowerPC architecture instructions in the Graphics
6995 group, including floating-point select.
6996
6997 The @option{-mpowerpc64} option allows GCC to generate the additional
6998 64-bit instructions that are found in the full PowerPC64 architecture
6999 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7000 @option{-mno-powerpc64}.
7001
7002 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7003 will use only the instructions in the common subset of both
7004 architectures plus some special AIX common-mode calls, and will not use
7005 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7006 permits GCC to use any instruction from either architecture and to
7007 allow use of the MQ register; specify this for the Motorola MPC601.
7008
7009 @item -mnew-mnemonics
7010 @itemx -mold-mnemonics
7011 @opindex mnew-mnemonics
7012 @opindex mold-mnemonics
7013 Select which mnemonics to use in the generated assembler code.  With
7014 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7015 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7016 assembler mnemonics defined for the POWER architecture.  Instructions
7017 defined in only one architecture have only one mnemonic; GCC uses that
7018 mnemonic irrespective of which of these options is specified.
7019
7020 GCC defaults to the mnemonics appropriate for the architecture in
7021 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7022 value of these option.  Unless you are building a cross-compiler, you
7023 should normally not specify either @option{-mnew-mnemonics} or
7024 @option{-mold-mnemonics}, but should instead accept the default.
7025
7026 @item -mcpu=@var{cpu_type}
7027 @opindex mcpu
7028 Set architecture type, register usage, choice of mnemonics, and
7029 instruction scheduling parameters for machine type @var{cpu_type}.
7030 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7031 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7032 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7033 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7034 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7035 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7036 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7037 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
7038 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7039
7040 @option{-mcpu=common} selects a completely generic processor.  Code
7041 generated under this option will run on any POWER or PowerPC processor.
7042 GCC will use only the instructions in the common subset of both
7043 architectures, and will not use the MQ register.  GCC assumes a generic
7044 processor model for scheduling purposes.
7045
7046 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7047 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7048 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7049 types, with an appropriate, generic processor model assumed for
7050 scheduling purposes.
7051
7052 The other options specify a specific processor.  Code generated under
7053 those options will run best on that processor, and may not run at all on
7054 others.
7055
7056 The @option{-mcpu} options automatically enable or disable the
7057 following options: @option{-maltivec}, @option{-mhard-float},
7058 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7059 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7060 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7061 @option{-mstring}.  The particular options set for any particular CPU
7062 will vary between compiler versions, depending on what setting seems
7063 to produce optimal code for that CPU; it doesn't necessarily reflect
7064 the actual hardware's capabilities.  If you wish to set an individual
7065 option to a particular value, you may specify it after the
7066 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7067
7068 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7069 not enabled or disabled by the @option{-mcpu} option at present, since
7070 AIX does not have full support for these options.  You may still
7071 enable or disable them individually if you're sure it'll work in your
7072 environment.
7073
7074 @item -mtune=@var{cpu_type}
7075 @opindex mtune
7076 Set the instruction scheduling parameters for machine type
7077 @var{cpu_type}, but do not set the architecture type, register usage, or
7078 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7079 values for @var{cpu_type} are used for @option{-mtune} as for
7080 @option{-mcpu}.  If both are specified, the code generated will use the
7081 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7082 scheduling parameters set by @option{-mtune}.
7083
7084 @item -maltivec
7085 @itemx -mno-altivec
7086 @opindex maltivec
7087 @opindex mno-altivec
7088 These switches enable or disable the use of built-in functions that
7089 allow access to the AltiVec instruction set.  You may also need to set
7090 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7091 enhancements.
7092
7093 @item -mabi=spe
7094 @opindex mabi=spe
7095 Extend the current ABI with SPE ABI extensions.  This does not change
7096 the default ABI, instead it adds the SPE ABI extensions to the current
7097 ABI@.
7098
7099 @item -mabi=no-spe
7100 @opindex mabi=no-spe
7101 Disable Booke SPE ABI extensions for the current ABI.
7102
7103 @item -misel=@var{yes/no}
7104 @itemx -misel
7105 @opindex misel
7106 This switch enables or disables the generation of ISEL instructions.
7107
7108 @item -mspe=@var{yes/no}
7109 @itemx -mspe
7110 @opindex mspe
7111 This switch enables or disables the generation of SPE simd
7112 instructions.
7113
7114 @item -mfloat-gprs=@var{yes/no}
7115 @itemx -mfloat-gprs
7116 @opindex mfloat-gprs
7117 This switch enables or disables the generation of floating point
7118 operations on the general purpose registers for architectures that
7119 support it.  This option is currently only available on the MPC8540.
7120
7121 @item -mfull-toc
7122 @itemx -mno-fp-in-toc
7123 @itemx -mno-sum-in-toc
7124 @itemx -mminimal-toc
7125 @opindex mfull-toc
7126 @opindex mno-fp-in-toc
7127 @opindex mno-sum-in-toc
7128 @opindex mminimal-toc
7129 Modify generation of the TOC (Table Of Contents), which is created for
7130 every executable file.  The @option{-mfull-toc} option is selected by
7131 default.  In that case, GCC will allocate at least one TOC entry for
7132 each unique non-automatic variable reference in your program.  GCC
7133 will also place floating-point constants in the TOC@.  However, only
7134 16,384 entries are available in the TOC@.
7135
7136 If you receive a linker error message that saying you have overflowed
7137 the available TOC space, you can reduce the amount of TOC space used
7138 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7139 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7140 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7141 generate code to calculate the sum of an address and a constant at
7142 run-time instead of putting that sum into the TOC@.  You may specify one
7143 or both of these options.  Each causes GCC to produce very slightly
7144 slower and larger code at the expense of conserving TOC space.
7145
7146 If you still run out of space in the TOC even when you specify both of
7147 these options, specify @option{-mminimal-toc} instead.  This option causes
7148 GCC to make only one TOC entry for every file.  When you specify this
7149 option, GCC will produce code that is slower and larger but which
7150 uses extremely little TOC space.  You may wish to use this option
7151 only on files that contain less frequently executed code.
7152
7153 @item -maix64
7154 @itemx -maix32
7155 @opindex maix64
7156 @opindex maix32
7157 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7158 @code{long} type, and the infrastructure needed to support them.
7159 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7160 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7161 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7162
7163 @item -mxl-call
7164 @itemx -mno-xl-call
7165 @opindex mxl-call
7166 @opindex mno-xl-call
7167 On AIX, pass floating-point arguments to prototyped functions beyond the
7168 register save area (RSA) on the stack in addition to argument FPRs.  The
7169 AIX calling convention was extended but not initially documented to
7170 handle an obscure K&R C case of calling a function that takes the
7171 address of its arguments with fewer arguments than declared.  AIX XL
7172 compilers access floating point arguments which do not fit in the
7173 RSA from the stack when a subroutine is compiled without
7174 optimization.  Because always storing floating-point arguments on the
7175 stack is inefficient and rarely needed, this option is not enabled by
7176 default and only is necessary when calling subroutines compiled by AIX
7177 XL compilers without optimization.
7178
7179 @item -mpe
7180 @opindex mpe
7181 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7182 application written to use message passing with special startup code to
7183 enable the application to run.  The system must have PE installed in the
7184 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7185 must be overridden with the @option{-specs=} option to specify the
7186 appropriate directory location.  The Parallel Environment does not
7187 support threads, so the @option{-mpe} option and the @option{-pthread}
7188 option are incompatible.
7189
7190 @item -malign-natural
7191 @itemx -malign-power
7192 @opindex malign-natural
7193 @opindex malign-power
7194 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
7195 @option{-malign-natural} overrides the ABI-defined alignment of larger
7196 types, such as floating-point doubles, on their natural size-based boundary.
7197 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7198 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7199
7200 @item -msoft-float
7201 @itemx -mhard-float
7202 @opindex msoft-float
7203 @opindex mhard-float
7204 Generate code that does not use (uses) the floating-point register set.
7205 Software floating point emulation is provided if you use the
7206 @option{-msoft-float} option, and pass the option to GCC when linking.
7207
7208 @item -mmultiple
7209 @itemx -mno-multiple
7210 @opindex mmultiple
7211 @opindex mno-multiple
7212 Generate code that uses (does not use) the load multiple word
7213 instructions and the store multiple word instructions.  These
7214 instructions are generated by default on POWER systems, and not
7215 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7216 endian PowerPC systems, since those instructions do not work when the
7217 processor is in little endian mode.  The exceptions are PPC740 and
7218 PPC750 which permit the instructions usage in little endian mode.
7219
7220 @item -mstring
7221 @itemx -mno-string
7222 @opindex mstring
7223 @opindex mno-string
7224 Generate code that uses (does not use) the load string instructions
7225 and the store string word instructions to save multiple registers and
7226 do small block moves.  These instructions are generated by default on
7227 POWER systems, and not generated on PowerPC systems.  Do not use
7228 @option{-mstring} on little endian PowerPC systems, since those
7229 instructions do not work when the processor is in little endian mode.
7230 The exceptions are PPC740 and PPC750 which permit the instructions
7231 usage in little endian mode.
7232
7233 @item -mupdate
7234 @itemx -mno-update
7235 @opindex mupdate
7236 @opindex mno-update
7237 Generate code that uses (does not use) the load or store instructions
7238 that update the base register to the address of the calculated memory
7239 location.  These instructions are generated by default.  If you use
7240 @option{-mno-update}, there is a small window between the time that the
7241 stack pointer is updated and the address of the previous frame is
7242 stored, which means code that walks the stack frame across interrupts or
7243 signals may get corrupted data.
7244
7245 @item -mfused-madd
7246 @itemx -mno-fused-madd
7247 @opindex mfused-madd
7248 @opindex mno-fused-madd
7249 Generate code that uses (does not use) the floating point multiply and
7250 accumulate instructions.  These instructions are generated by default if
7251 hardware floating is used.
7252
7253 @item -mno-bit-align
7254 @itemx -mbit-align
7255 @opindex mno-bit-align
7256 @opindex mbit-align
7257 On System V.4 and embedded PowerPC systems do not (do) force structures
7258 and unions that contain bit-fields to be aligned to the base type of the
7259 bit-field.
7260
7261 For example, by default a structure containing nothing but 8
7262 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7263 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7264 the structure would be aligned to a 1 byte boundary and be one byte in
7265 size.
7266
7267 @item -mno-strict-align
7268 @itemx -mstrict-align
7269 @opindex mno-strict-align
7270 @opindex mstrict-align
7271 On System V.4 and embedded PowerPC systems do not (do) assume that
7272 unaligned memory references will be handled by the system.
7273
7274 @item -mrelocatable
7275 @itemx -mno-relocatable
7276 @opindex mrelocatable
7277 @opindex mno-relocatable
7278 On embedded PowerPC systems generate code that allows (does not allow)
7279 the program to be relocated to a different address at runtime.  If you
7280 use @option{-mrelocatable} on any module, all objects linked together must
7281 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7282
7283 @item -mrelocatable-lib
7284 @itemx -mno-relocatable-lib
7285 @opindex mrelocatable-lib
7286 @opindex mno-relocatable-lib
7287 On embedded PowerPC systems generate code that allows (does not allow)
7288 the program to be relocated to a different address at runtime.  Modules
7289 compiled with @option{-mrelocatable-lib} can be linked with either modules
7290 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7291 with modules compiled with the @option{-mrelocatable} options.
7292
7293 @item -mno-toc
7294 @itemx -mtoc
7295 @opindex mno-toc
7296 @opindex mtoc
7297 On System V.4 and embedded PowerPC systems do not (do) assume that
7298 register 2 contains a pointer to a global area pointing to the addresses
7299 used in the program.
7300
7301 @item -mlittle
7302 @itemx -mlittle-endian
7303 @opindex mlittle
7304 @opindex mlittle-endian
7305 On System V.4 and embedded PowerPC systems compile code for the
7306 processor in little endian mode.  The @option{-mlittle-endian} option is
7307 the same as @option{-mlittle}.
7308
7309 @item -mbig
7310 @itemx -mbig-endian
7311 @opindex mbig
7312 @opindex mbig-endian
7313 On System V.4 and embedded PowerPC systems compile code for the
7314 processor in big endian mode.  The @option{-mbig-endian} option is
7315 the same as @option{-mbig}.
7316
7317 @item -mdynamic-no-pic
7318 @opindex mdynamic-no-pic
7319 On Darwin and Mac OS X systems, compile code so that it is not
7320 relocatable, but that its external references are relocatable.  The
7321 resulting code is suitable for applications, but not shared
7322 libraries.
7323
7324 @item -mprioritize-restricted-insns=@var{priority}
7325 @opindex mprioritize-restricted-insns
7326 This option controls the priority that is assigned to
7327 dispatch-slot restricted instructions during the second scheduling
7328 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
7329 @var{no/highest/second-highest} priority to dispatch slot restricted
7330 instructions.
7331
7332 @item -msched-costly-dep=@var{dependence_type}
7333 @opindex msched-costly-dep
7334 This option controls which dependences are considered costly
7335 by the target during instruction scheduling.  The argument
7336 @var{dependence_type} takes one of the following values:
7337 @var{no}: no dependence is costly,
7338 @var{all}: all dependences are costly,
7339 @var{true_store_to_load}: a true dependence from store to load is costly,
7340 @var{store_to_load}: any dependence from store to load is costly,
7341 @var{number}: any dependence which latency >= @var{number} is costly.
7342
7343 @item -minsert-sched-nops=@var{scheme}
7344 @opindex minsert-sched-nops
7345 This option controls which nop insertion scheme will be used during
7346 the second scheduling pass. The argument @var{scheme} takes one of the
7347 following values:
7348 @var{no}: Don't insert nops.
7349 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7350 according to the scheduler's grouping.
7351 @var{regroup_exact}: Insert nops to force costly dependent insns into
7352 separate groups.  Insert exactly as many nops as needed to force an insn
7353 to a new group, according to the estimated processor grouping.
7354 @var{number}: Insert nops to force costly dependent insns into
7355 separate groups.  Insert @var{number} nops to force an insn to a new group.
7356
7357 @item -mcall-sysv
7358 @opindex mcall-sysv
7359 On System V.4 and embedded PowerPC systems compile code using calling
7360 conventions that adheres to the March 1995 draft of the System V
7361 Application Binary Interface, PowerPC processor supplement.  This is the
7362 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7363
7364 @item -mcall-sysv-eabi
7365 @opindex mcall-sysv-eabi
7366 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7367
7368 @item -mcall-sysv-noeabi
7369 @opindex mcall-sysv-noeabi
7370 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7371
7372 @item -mcall-solaris
7373 @opindex mcall-solaris
7374 On System V.4 and embedded PowerPC systems compile code for the Solaris
7375 operating system.
7376
7377 @item -mcall-linux
7378 @opindex mcall-linux
7379 On System V.4 and embedded PowerPC systems compile code for the
7380 Linux-based GNU system.
7381
7382 @item -mcall-gnu
7383 @opindex mcall-gnu
7384 On System V.4 and embedded PowerPC systems compile code for the
7385 Hurd-based GNU system.
7386
7387 @item -mcall-netbsd
7388 @opindex mcall-netbsd
7389 On System V.4 and embedded PowerPC systems compile code for the
7390 NetBSD operating system.
7391
7392 @item -maix-struct-return
7393 @opindex maix-struct-return
7394 Return all structures in memory (as specified by the AIX ABI)@.
7395
7396 @item -msvr4-struct-return
7397 @opindex msvr4-struct-return
7398 Return structures smaller than 8 bytes in registers (as specified by the
7399 SVR4 ABI)@.
7400
7401 @item -mabi=altivec
7402 @opindex mabi=altivec
7403 Extend the current ABI with AltiVec ABI extensions.  This does not
7404 change the default ABI, instead it adds the AltiVec ABI extensions to
7405 the current ABI@.
7406
7407 @item -mabi=no-altivec
7408 @opindex mabi=no-altivec
7409 Disable AltiVec ABI extensions for the current ABI.
7410
7411 @item -mprototype
7412 @itemx -mno-prototype
7413 @opindex mprototype
7414 @opindex mno-prototype
7415 On System V.4 and embedded PowerPC systems assume that all calls to
7416 variable argument functions are properly prototyped.  Otherwise, the
7417 compiler must insert an instruction before every non prototyped call to
7418 set or clear bit 6 of the condition code register (@var{CR}) to
7419 indicate whether floating point values were passed in the floating point
7420 registers in case the function takes a variable arguments.  With
7421 @option{-mprototype}, only calls to prototyped variable argument functions
7422 will set or clear the bit.
7423
7424 @item -msim
7425 @opindex msim
7426 On embedded PowerPC systems, assume that the startup module is called
7427 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7428 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7429 configurations.
7430
7431 @item -mmvme
7432 @opindex mmvme
7433 On embedded PowerPC systems, assume that the startup module is called
7434 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7435 @file{libc.a}.
7436
7437 @item -mads
7438 @opindex mads
7439 On embedded PowerPC systems, assume that the startup module is called
7440 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7441 @file{libc.a}.
7442
7443 @item -myellowknife
7444 @opindex myellowknife
7445 On embedded PowerPC systems, assume that the startup module is called
7446 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7447 @file{libc.a}.
7448
7449 @item -mvxworks
7450 @opindex mvxworks
7451 On System V.4 and embedded PowerPC systems, specify that you are
7452 compiling for a VxWorks system.
7453
7454 @item -mwindiss
7455 @opindex mwindiss
7456 Specify that you are compiling for the WindISS simulation environment.
7457
7458 @item -memb
7459 @opindex memb
7460 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7461 header to indicate that @samp{eabi} extended relocations are used.
7462
7463 @item -meabi
7464 @itemx -mno-eabi
7465 @opindex meabi
7466 @opindex mno-eabi
7467 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7468 Embedded Applications Binary Interface (eabi) which is a set of
7469 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7470 means that the stack is aligned to an 8 byte boundary, a function
7471 @code{__eabi} is called to from @code{main} to set up the eabi
7472 environment, and the @option{-msdata} option can use both @code{r2} and
7473 @code{r13} to point to two separate small data areas.  Selecting
7474 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7475 do not call an initialization function from @code{main}, and the
7476 @option{-msdata} option will only use @code{r13} to point to a single
7477 small data area.  The @option{-meabi} option is on by default if you
7478 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7479
7480 @item -msdata=eabi
7481 @opindex msdata=eabi
7482 On System V.4 and embedded PowerPC systems, put small initialized
7483 @code{const} global and static data in the @samp{.sdata2} section, which
7484 is pointed to by register @code{r2}.  Put small initialized
7485 non-@code{const} global and static data in the @samp{.sdata} section,
7486 which is pointed to by register @code{r13}.  Put small uninitialized
7487 global and static data in the @samp{.sbss} section, which is adjacent to
7488 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7489 incompatible with the @option{-mrelocatable} option.  The
7490 @option{-msdata=eabi} option also sets the @option{-memb} option.
7491
7492 @item -msdata=sysv
7493 @opindex msdata=sysv
7494 On System V.4 and embedded PowerPC systems, put small global and static
7495 data in the @samp{.sdata} section, which is pointed to by register
7496 @code{r13}.  Put small uninitialized global and static data in the
7497 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7498 The @option{-msdata=sysv} option is incompatible with the
7499 @option{-mrelocatable} option.
7500
7501 @item -msdata=default
7502 @itemx -msdata
7503 @opindex msdata=default
7504 @opindex msdata
7505 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7506 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7507 same as @option{-msdata=sysv}.
7508
7509 @item -msdata-data
7510 @opindex msdata-data
7511 On System V.4 and embedded PowerPC systems, put small global and static
7512 data in the @samp{.sdata} section.  Put small uninitialized global and
7513 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7514 to address small data however.  This is the default behavior unless
7515 other @option{-msdata} options are used.
7516
7517 @item -msdata=none
7518 @itemx -mno-sdata
7519 @opindex msdata=none
7520 @opindex mno-sdata
7521 On embedded PowerPC systems, put all initialized global and static data
7522 in the @samp{.data} section, and all uninitialized data in the
7523 @samp{.bss} section.
7524
7525 @item -G @var{num}
7526 @opindex G
7527 @cindex smaller data references (PowerPC)
7528 @cindex .sdata/.sdata2 references (PowerPC)
7529 On embedded PowerPC systems, put global and static items less than or
7530 equal to @var{num} bytes into the small data or bss sections instead of
7531 the normal data or bss section.  By default, @var{num} is 8.  The
7532 @option{-G @var{num}} switch is also passed to the linker.
7533 All modules should be compiled with the same @option{-G @var{num}} value.
7534
7535 @item -mregnames
7536 @itemx -mno-regnames
7537 @opindex mregnames
7538 @opindex mno-regnames
7539 On System V.4 and embedded PowerPC systems do (do not) emit register
7540 names in the assembly language output using symbolic forms.
7541
7542 @item -mlongcall
7543 @itemx -mno-longcall
7544 @opindex mlongcall
7545 @opindex mno-longcall
7546 Default to making all function calls via pointers, so that functions
7547 which reside further than 64 megabytes (67,108,864 bytes) from the
7548 current location can be called.  This setting can be overridden by the
7549 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7550
7551 Some linkers are capable of detecting out-of-range calls and generating
7552 glue code on the fly.  On these systems, long calls are unnecessary and
7553 generate slower code.  As of this writing, the AIX linker can do this,
7554 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7555 to the GNU linker for 32-bit PowerPC systems as well.
7556
7557 On Mach-O (Darwin) systems, this option directs the compiler emit to
7558 the glue for every direct call, and the Darwin linker decides whether
7559 to use or discard it.
7560
7561 In the future, we may cause GCC to ignore all longcall specifications
7562 when the linker is known to generate glue.
7563
7564 @item -pthread
7565 @opindex pthread
7566 Adds support for multithreading with the @dfn{pthreads} library.
7567 This option sets flags for both the preprocessor and linker.
7568
7569 @end table
7570
7571 @node Darwin Options
7572 @subsection Darwin Options
7573 @cindex Darwin options
7574
7575 These options are defined for all architectures running the Darwin operating
7576 system.  They are useful for compatibility with other Mac OS compilers.
7577
7578 @table @gcctabopt
7579 @item -all_load
7580 @opindex all_load
7581 Loads all members of static archive libraries.
7582 See man ld(1) for more information.
7583
7584 @item -arch_errors_fatal
7585 @opindex arch_errors_fatal
7586 Cause the errors having to do with files that have the wrong architecture
7587 to be fatal.
7588
7589 @item -bind_at_load
7590 @opindex bind_at_load
7591 Causes the output file to be marked such that the dynamic linker will
7592 bind all undefined references when the file is loaded or launched.
7593
7594 @item -bundle
7595 @opindex bundle
7596 Produce a Mach-o bundle format file.
7597 See man ld(1) for more information.
7598
7599 @item -bundle_loader @var{executable}
7600 @opindex bundle_loader
7601 This specifies the @var{executable} that will be loading the build
7602 output file being linked. See man ld(1) for more information.
7603
7604 @item -allowable_client  @var{client_name}
7605 @itemx -arch_only
7606
7607 @itemx -client_name
7608 @itemx -compatibility_version
7609 @itemx -current_version
7610 @itemx -dependency-file
7611 @itemx -dylib_file
7612 @itemx -dylinker_install_name
7613 @itemx -dynamic
7614 @itemx -dynamiclib
7615 @itemx -exported_symbols_list
7616 @itemx -filelist
7617 @itemx -flat_namespace
7618 @itemx -force_cpusubtype_ALL
7619 @itemx -force_flat_namespace
7620 @itemx -headerpad_max_install_names
7621 @itemx -image_base
7622 @itemx -init
7623 @itemx -install_name
7624 @itemx -keep_private_externs
7625 @itemx -multi_module
7626 @itemx -multiply_defined
7627 @itemx -multiply_defined_unused
7628 @itemx -noall_load
7629 @itemx -nofixprebinding
7630 @itemx -nomultidefs
7631 @itemx -noprebind
7632 @itemx -noseglinkedit
7633 @itemx -pagezero_size
7634 @itemx -prebind
7635 @itemx -prebind_all_twolevel_modules
7636 @itemx -private_bundle
7637 @itemx -read_only_relocs
7638 @itemx -sectalign
7639 @itemx -sectobjectsymbols
7640 @itemx -whyload
7641 @itemx -seg1addr
7642 @itemx -sectcreate
7643 @itemx -sectobjectsymbols
7644 @itemx -sectorder
7645 @itemx -seg_addr_table
7646 @itemx -seg_addr_table_filename
7647 @itemx -seglinkedit
7648 @itemx -segprot
7649 @itemx -segs_read_only_addr
7650 @itemx -segs_read_write_addr
7651 @itemx -single_module
7652 @itemx -static
7653 @itemx -sub_library
7654 @itemx -sub_umbrella
7655 @itemx -twolevel_namespace
7656 @itemx -umbrella
7657 @itemx -undefined
7658 @itemx -unexported_symbols_list
7659 @itemx -weak_reference_mismatches
7660 @itemx -whatsloaded
7661
7662 @opindex allowable_client
7663 @opindex arch_only
7664 @opindex client_name
7665 @opindex compatibility_version
7666 @opindex current_version
7667 @opindex dependency-file
7668 @opindex dylib_file
7669 @opindex dylinker_install_name
7670 @opindex dynamic
7671 @opindex dynamiclib
7672 @opindex exported_symbols_list
7673 @opindex filelist
7674 @opindex flat_namespace
7675 @opindex force_cpusubtype_ALL
7676 @opindex force_flat_namespace
7677 @opindex headerpad_max_install_names
7678 @opindex image_base
7679 @opindex init
7680 @opindex install_name
7681 @opindex keep_private_externs
7682 @opindex multi_module
7683 @opindex multiply_defined
7684 @opindex multiply_defined_unused
7685 @opindex noall_load
7686 @opindex nofixprebinding
7687 @opindex nomultidefs
7688 @opindex noprebind
7689 @opindex noseglinkedit
7690 @opindex pagezero_size
7691 @opindex prebind
7692 @opindex prebind_all_twolevel_modules
7693 @opindex private_bundle
7694 @opindex read_only_relocs
7695 @opindex sectalign
7696 @opindex sectobjectsymbols
7697 @opindex whyload
7698 @opindex seg1addr
7699 @opindex sectcreate
7700 @opindex sectobjectsymbols
7701 @opindex sectorder
7702 @opindex seg_addr_table
7703 @opindex seg_addr_table_filename
7704 @opindex seglinkedit
7705 @opindex segprot
7706 @opindex segs_read_only_addr
7707 @opindex segs_read_write_addr
7708 @opindex single_module
7709 @opindex static
7710 @opindex sub_library
7711 @opindex sub_umbrella
7712 @opindex twolevel_namespace
7713 @opindex umbrella
7714 @opindex undefined
7715 @opindex unexported_symbols_list
7716 @opindex weak_reference_mismatches
7717 @opindex whatsloaded
7718
7719 These options are available for Darwin linker. Darwin linker man page
7720 describes them in detail.
7721 @end table
7722
7723
7724 @node MIPS Options
7725 @subsection MIPS Options
7726 @cindex MIPS options
7727
7728 @table @gcctabopt
7729
7730 @item -EB
7731 @opindex EB
7732 Generate big-endian code.
7733
7734 @item -EL
7735 @opindex EL
7736 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
7737 configurations.
7738
7739 @item -march=@var{arch}
7740 @opindex march
7741 Generate code that will run on @var{arch}, which can be the name of a
7742 generic MIPS ISA, or the name of a particular processor.
7743 The ISA names are:
7744 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7745 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7746 The processor names are:
7747 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7748 @samp{m4k},
7749 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7750 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7751 @samp{rm9000},
7752 @samp{orion},
7753 @samp{sb1},
7754 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7755 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7756 The special value @samp{from-abi} selects the
7757 most compatible architecture for the selected ABI (that is,
7758 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7759
7760 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7761 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7762 @samp{vr} may be written @samp{r}.
7763
7764 GCC defines two macros based on the value of this option.  The first
7765 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7766 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7767 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7768 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7769 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7770
7771 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7772 above.  In other words, it will have the full prefix and will not
7773 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7774 the macro names the resolved architecture (either @samp{"mips1"} or
7775 @samp{"mips3"}).  It names the default architecture when no
7776 @option{-march} option is given.
7777
7778 @item -mtune=@var{arch}
7779 @opindex mtune
7780 Optimize for @var{arch}.  Among other things, this option controls
7781 the way instructions are scheduled, and the perceived cost of arithmetic
7782 operations.  The list of @var{arch} values is the same as for
7783 @option{-march}.
7784
7785 When this option is not used, GCC will optimize for the processor
7786 specified by @option{-march}.  By using @option{-march} and
7787 @option{-mtune} together, it is possible to generate code that will
7788 run on a family of processors, but optimize the code for one
7789 particular member of that family.
7790
7791 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7792 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7793 @samp{-march} ones described above.
7794
7795 @item -mips1
7796 @opindex mips1
7797 Equivalent to @samp{-march=mips1}.
7798
7799 @item -mips2
7800 @opindex mips2
7801 Equivalent to @samp{-march=mips2}.
7802
7803 @item -mips3
7804 @opindex mips3
7805 Equivalent to @samp{-march=mips3}.
7806
7807 @item -mips4
7808 @opindex mips4
7809 Equivalent to @samp{-march=mips4}.
7810
7811 @item -mips32
7812 @opindex mips32
7813 Equivalent to @samp{-march=mips32}.
7814
7815 @item -mips32r2
7816 @opindex mips32r2
7817 Equivalent to @samp{-march=mips32r2}.
7818
7819 @item -mips64
7820 @opindex mips64
7821 Equivalent to @samp{-march=mips64}.
7822
7823 @item -mips16
7824 @itemx -mno-mips16
7825 @opindex mips16
7826 @opindex mno-mips16
7827 Use (do not use) the MIPS16 ISA.
7828
7829 @item -mabi=32
7830 @itemx -mabi=o64
7831 @itemx -mabi=n32
7832 @itemx -mabi=64
7833 @itemx -mabi=eabi
7834 @opindex mabi=32
7835 @opindex mabi=o64
7836 @opindex mabi=n32
7837 @opindex mabi=64
7838 @opindex mabi=eabi
7839 Generate code for the given ABI@.
7840
7841 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
7842 generates 64-bit code when you select a 64-bit architecture, but you
7843 can use @option{-mgp32} to get 32-bit code instead.
7844
7845 @item -mabicalls
7846 @itemx -mno-abicalls
7847 @opindex mabicalls
7848 @opindex mno-abicalls
7849 Generate (do not generate) SVR4-style position-independent code.
7850 @option{-mabicalls} is the default for SVR4-based systems.
7851
7852 @item -mxgot
7853 @itemx -mno-xgot
7854 @opindex mxgot
7855 @opindex mno-xgot
7856 Lift (do not lift) the usual restrictions on the size of the global
7857 offset table.
7858
7859 GCC normally uses a single instruction to load values from the GOT.
7860 While this is relatively efficient, it will only work if the GOT
7861 is smaller than about 64k.  Anything larger will cause the linker
7862 to report an error such as:
7863
7864 @cindex relocation truncated to fit (MIPS)
7865 @smallexample
7866 relocation truncated to fit: R_MIPS_GOT16 foobar
7867 @end smallexample
7868
7869 If this happens, you should recompile your code with @option{-mxgot}.
7870 It should then work with very large GOTs, although it will also be
7871 less efficient, since it will take three instructions to fetch the
7872 value of a global symbol.
7873
7874 Note that some linkers can create multiple GOTs.  If you have such a
7875 linker, you should only need to use @option{-mxgot} when a single object
7876 file accesses more than 64k's worth of GOT entries.  Very few do.
7877
7878 These options have no effect unless GCC is generating position
7879 independent code.
7880
7881 @item -membedded-pic
7882 @itemx -mno-embedded-pic
7883 @opindex membedded-pic
7884 @opindex mno-embedded-pic
7885 Generate (do not generate) position-independent code suitable for some
7886 embedded systems.  All calls are made using PC relative addresses, and
7887 all data is addressed using the $gp register.  No more than 65536
7888 bytes of global data may be used.  This requires GNU as and GNU ld,
7889 which do most of the work.
7890
7891 @item -mgp32
7892 @opindex mgp32
7893 Assume that general-purpose registers are 32 bits wide.
7894
7895 @item -mgp64
7896 @opindex mgp64
7897 Assume that general-purpose registers are 64 bits wide.
7898
7899 @item -mfp32
7900 @opindex mfp32
7901 Assume that floating-point registers are 32 bits wide.
7902
7903 @item -mfp64
7904 @opindex mfp64
7905 Assume that floating-point registers are 64 bits wide.
7906
7907 @item -mhard-float
7908 @opindex mhard-float
7909 Use floating-point coprocessor instructions.
7910
7911 @item -msoft-float
7912 @opindex msoft-float
7913 Do not use floating-point coprocessor instructions.  Implement
7914 floating-point calculations using library calls instead.
7915
7916 @item -msingle-float
7917 @opindex msingle-float
7918 Assume that the floating-point coprocessor only supports single-precision
7919 operations.
7920
7921 @itemx -mdouble-float
7922 @opindex mdouble-float
7923 Assume that the floating-point coprocessor supports double-precision
7924 operations.  This is the default.
7925
7926 @item -mint64
7927 @opindex mint64
7928 Force @code{int} and @code{long} types to be 64 bits wide.  See
7929 @option{-mlong32} for an explanation of the default and the way
7930 that the pointer size is determined.
7931
7932 @item -mlong64
7933 @opindex mlong64
7934 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
7935 an explanation of the default and the way that the pointer size is
7936 determined.
7937
7938 @item -mlong32
7939 @opindex mlong32
7940 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7941
7942 The default size of @code{int}s, @code{long}s and pointers depends on
7943 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
7944 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7945 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
7946 or the same size as integer registers, whichever is smaller.
7947
7948 @item -G @var{num}
7949 @opindex G
7950 @cindex smaller data references (MIPS)
7951 @cindex gp-relative references (MIPS)
7952 Put global and static items less than or equal to @var{num} bytes into
7953 the small data or bss section instead of the normal data or bss section.
7954 This allows the data to be accessed using a single instruction.
7955
7956 All modules should be compiled with the same @option{-G @var{num}}
7957 value.
7958
7959 @item -membedded-data
7960 @itemx -mno-embedded-data
7961 @opindex membedded-data
7962 @opindex mno-embedded-data
7963 Allocate variables to the read-only data section first if possible, then
7964 next in the small data section if possible, otherwise in data.  This gives
7965 slightly slower code than the default, but reduces the amount of RAM required
7966 when executing, and thus may be preferred for some embedded systems.
7967
7968 @item -muninit-const-in-rodata
7969 @itemx -mno-uninit-const-in-rodata
7970 @opindex muninit-const-in-rodata
7971 @opindex mno-uninit-const-in-rodata
7972 Put uninitialized @code{const} variables in the read-only data section.
7973 This option is only meaningful in conjunction with @option{-membedded-data}.
7974
7975 @item -msplit-addresses
7976 @itemx -mno-split-addresses
7977 @opindex msplit-addresses
7978 @opindex mno-split-addresses
7979 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
7980 relocation operators.  This option has been superceded by
7981 @option{-mexplicit-relocs} but is retained for backwards compatibility.
7982
7983 @item -mexplicit-relocs
7984 @itemx -mno-explicit-relocs
7985 @opindex mexplicit-relocs
7986 @opindex mno-explicit-relocs
7987 Use (do not use) assembler relocation operators when dealing with symbolic
7988 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
7989 is to use assembler macros instead.
7990
7991 @option{-mexplicit-relocs} is usually the default if GCC was
7992 configured to use an assembler that supports relocation operators.
7993 However, there are two exceptions:
7994
7995 @itemize @bullet
7996 @item
7997 GCC is not yet able to generate explicit relocations for the combination
7998 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
7999 in a future release.
8000
8001 @item
8002 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
8003 implies @option{-mno-explicit-relocs} unless explicitly overridden.
8004 This is because, when generating abicalls, the choice of relocation
8005 depends on whether a symbol is local or global.  In some rare cases,
8006 GCC will not be able to decide this until the whole compilation unit
8007 has been read.
8008 @end itemize
8009
8010 @item -mrnames
8011 @itemx -mno-rnames
8012 @opindex mrnames
8013 @opindex mno-rnames
8014 Generate (do not generate) code that refers to registers using their
8015 software names.  The default is @option{-mno-rnames}, which tells GCC
8016 to use hardware names like @samp{$4} instead of software names like
8017 @samp{a0}.  The only assembler known to support @option{-rnames} is
8018 the Algorithmics assembler.
8019
8020 @item -mcheck-zero-division
8021 @itemx -mno-check-zero-division
8022 @opindex mcheck-zero-division
8023 @opindex mno-check-zero-division
8024 Trap (do not trap) on integer division by zero.  The default is
8025 @option{-mcheck-zero-division}.
8026
8027 @item -mmemcpy
8028 @itemx -mno-memcpy
8029 @opindex mmemcpy
8030 @opindex mno-memcpy
8031 Force (do not force) the use of @code{memcpy()} for non-trivial block
8032 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8033 most constant-sized copies.
8034
8035 @item -mlong-calls
8036 @itemx -mno-long-calls
8037 @opindex mlong-calls
8038 @opindex mno-long-calls
8039 Disable (do not disable) use of the @code{jal} instruction.  Calling
8040 functions using @code{jal} is more efficient but requires the caller
8041 and callee to be in the same 256 megabyte segment.
8042
8043 This option has no effect on abicalls code.  The default is
8044 @option{-mno-long-calls}.
8045
8046 @item -mmad
8047 @itemx -mno-mad
8048 @opindex mmad
8049 @opindex mno-mad
8050 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8051 instructions, as provided by the R4650 ISA.
8052
8053 @item -mfused-madd
8054 @itemx -mno-fused-madd
8055 @opindex mfused-madd
8056 @opindex mno-fused-madd
8057 Enable (disable) use of the floating point multiply-accumulate
8058 instructions, when they are available.  The default is
8059 @option{-mfused-madd}.
8060
8061 When multiply-accumulate instructions are used, the intermediate
8062 product is calculated to infinite precision and is not subject to
8063 the FCSR Flush to Zero bit.  This may be undesirable in some
8064 circumstances.
8065
8066 @item -nocpp
8067 @opindex nocpp
8068 Tell the MIPS assembler to not run its preprocessor over user
8069 assembler files (with a @samp{.s} suffix) when assembling them.
8070
8071 @item -mfix-sb1
8072 @itemx -mno-fix-sb1
8073 @opindex mfix-sb1
8074 Work around certain SB-1 CPU core errata.
8075 (This flag currently works around the SB-1 revision 2
8076 ``F1'' and ``F2'' floating point errata.)
8077
8078 @item -mflush-func=@var{func}
8079 @itemx -mno-flush-func
8080 @opindex mflush-func
8081 Specifies the function to call to flush the I and D caches, or to not
8082 call any such function.  If called, the function must take the same
8083 arguments as the common @code{_flush_func()}, that is, the address of the
8084 memory range for which the cache is being flushed, the size of the
8085 memory range, and the number 3 (to flush both caches).  The default
8086 depends on the target GCC was configured for, but commonly is either
8087 @samp{_flush_func} or @samp{__cpu_flush}.
8088
8089 @item -mbranch-likely
8090 @itemx -mno-branch-likely
8091 @opindex mbranch-likely
8092 @opindex mno-branch-likely
8093 Enable or disable use of Branch Likely instructions, regardless of the
8094 default for the selected architecture.  By default, Branch Likely
8095 instructions may be generated if they are supported by the selected
8096 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8097 and processors which implement those architectures; for those, Branch
8098 Likely instructions will not be generated by default because the MIPS32
8099 and MIPS64 architectures specifically deprecate their use.
8100 @end table
8101
8102 @node i386 and x86-64 Options
8103 @subsection Intel 386 and AMD x86-64 Options
8104 @cindex i386 Options
8105 @cindex x86-64 Options
8106 @cindex Intel 386 Options
8107 @cindex AMD x86-64 Options
8108
8109 These @samp{-m} options are defined for the i386 and x86-64 family of
8110 computers:
8111
8112 @table @gcctabopt
8113 @item -mtune=@var{cpu-type}
8114 @opindex mtune
8115 Tune to @var{cpu-type} everything applicable about the generated code, except
8116 for the ABI and the set of available instructions.  The choices for
8117 @var{cpu-type} are:
8118 @table @emph
8119 @item i386
8120 Original Intel's i386 CPU.
8121 @item i486
8122 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8123 @item i586, pentium
8124 Intel Pentium CPU with no MMX support.
8125 @item pentium-mmx
8126 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8127 @item i686, pentiumpro
8128 Intel PentiumPro CPU.
8129 @item pentium2
8130 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8131 @item pentium3, pentium3m
8132 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8133 support.
8134 @item pentium-m
8135 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8136 support.  Used by Centrino notebooks.
8137 @item pentium4, pentium4m
8138 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8139 @item prescott
8140 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8141 set support.
8142 @item nocona
8143 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8144 SSE2 and SSE3 instruction set support.
8145 @item k6
8146 AMD K6 CPU with MMX instruction set support.
8147 @item k6-2, k6-3
8148 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8149 @item athlon, athlon-tbird
8150 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8151 support.
8152 @item athlon-4, athlon-xp, athlon-mp
8153 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8154 instruction set support.
8155 @item k8, opteron, athlon64, athlon-fx
8156 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8157 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8158 @item winchip-c6
8159 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8160 set support.
8161 @item winchip2
8162 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8163 instruction set support.
8164 @item c3
8165 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8166 implemented for this chip.)
8167 @item c3-2
8168 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8169 implemented for this chip.)
8170 @end table
8171
8172 While picking a specific @var{cpu-type} will schedule things appropriately
8173 for that particular chip, the compiler will not generate any code that
8174 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8175 being used.
8176
8177 @item -march=@var{cpu-type}
8178 @opindex march
8179 Generate instructions for the machine type @var{cpu-type}.  The choices
8180 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8181 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8182
8183 @item -mcpu=@var{cpu-type}
8184 @opindex mcpu
8185 A deprecated synonym for @option{-mtune}.
8186
8187 @item -m386
8188 @itemx -m486
8189 @itemx -mpentium
8190 @itemx -mpentiumpro
8191 @opindex m386
8192 @opindex m486
8193 @opindex mpentium
8194 @opindex mpentiumpro
8195 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8196 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8197 These synonyms are deprecated.
8198
8199 @item -mfpmath=@var{unit}
8200 @opindex march
8201 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8202 for @var{unit} are:
8203
8204 @table @samp
8205 @item 387
8206 Use the standard 387 floating point coprocessor present majority of chips and
8207 emulated otherwise.  Code compiled with this option will run almost everywhere.
8208 The temporary results are computed in 80bit precision instead of precision
8209 specified by the type resulting in slightly different results compared to most
8210 of other chips. See @option{-ffloat-store} for more detailed description.
8211
8212 This is the default choice for i386 compiler.
8213
8214 @item sse
8215 Use scalar floating point instructions present in the SSE instruction set.
8216 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8217 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8218 instruction set supports only single precision arithmetics, thus the double and
8219 extended precision arithmetics is still done using 387.  Later version, present
8220 only in Pentium4 and the future AMD x86-64 chips supports double precision
8221 arithmetics too.
8222
8223 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8224 @option{-msse2} switches to enable SSE extensions and make this option
8225 effective.  For x86-64 compiler, these extensions are enabled by default.
8226
8227 The resulting code should be considerably faster in the majority of cases and avoid
8228 the numerical instability problems of 387 code, but may break some existing
8229 code that expects temporaries to be 80bit.
8230
8231 This is the default choice for the x86-64 compiler.
8232
8233 @item sse,387
8234 Attempt to utilize both instruction sets at once.  This effectively double the
8235 amount of available registers and on chips with separate execution units for
8236 387 and SSE the execution resources too.  Use this option with care, as it is
8237 still experimental, because the GCC register allocator does not model separate
8238 functional units well resulting in instable performance.
8239 @end table
8240
8241 @item -masm=@var{dialect}
8242 @opindex masm=@var{dialect}
8243 Output asm instructions using selected @var{dialect}. Supported choices are
8244 @samp{intel} or @samp{att} (the default one).
8245
8246 @item -mieee-fp
8247 @itemx -mno-ieee-fp
8248 @opindex mieee-fp
8249 @opindex mno-ieee-fp
8250 Control whether or not the compiler uses IEEE floating point
8251 comparisons.  These handle correctly the case where the result of a
8252 comparison is unordered.
8253
8254 @item -msoft-float
8255 @opindex msoft-float
8256 Generate output containing library calls for floating point.
8257 @strong{Warning:} the requisite libraries are not part of GCC@.
8258 Normally the facilities of the machine's usual C compiler are used, but
8259 this can't be done directly in cross-compilation.  You must make your
8260 own arrangements to provide suitable library functions for
8261 cross-compilation.
8262
8263 On machines where a function returns floating point results in the 80387
8264 register stack, some floating point opcodes may be emitted even if
8265 @option{-msoft-float} is used.
8266
8267 @item -mno-fp-ret-in-387
8268 @opindex mno-fp-ret-in-387
8269 Do not use the FPU registers for return values of functions.
8270
8271 The usual calling convention has functions return values of types
8272 @code{float} and @code{double} in an FPU register, even if there
8273 is no FPU@.  The idea is that the operating system should emulate
8274 an FPU@.
8275
8276 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8277 in ordinary CPU registers instead.
8278
8279 @item -mno-fancy-math-387
8280 @opindex mno-fancy-math-387
8281 Some 387 emulators do not support the @code{sin}, @code{cos} and
8282 @code{sqrt} instructions for the 387.  Specify this option to avoid
8283 generating those instructions.  This option is the default on FreeBSD,
8284 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8285 indicates that the target cpu will always have an FPU and so the
8286 instruction will not need emulation.  As of revision 2.6.1, these
8287 instructions are not generated unless you also use the
8288 @option{-funsafe-math-optimizations} switch.
8289
8290 @item -malign-double
8291 @itemx -mno-align-double
8292 @opindex malign-double
8293 @opindex mno-align-double
8294 Control whether GCC aligns @code{double}, @code{long double}, and
8295 @code{long long} variables on a two word boundary or a one word
8296 boundary.  Aligning @code{double} variables on a two word boundary will
8297 produce code that runs somewhat faster on a @samp{Pentium} at the
8298 expense of more memory.
8299
8300 @strong{Warning:} if you use the @option{-malign-double} switch,
8301 structures containing the above types will be aligned differently than
8302 the published application binary interface specifications for the 386
8303 and will not be binary compatible with structures in code compiled
8304 without that switch.
8305
8306 @item -m96bit-long-double
8307 @itemx -m128bit-long-double
8308 @opindex m96bit-long-double
8309 @opindex m128bit-long-double
8310 These switches control the size of @code{long double} type. The i386
8311 application binary interface specifies the size to be 96 bits,
8312 so @option{-m96bit-long-double} is the default in 32 bit mode.
8313
8314 Modern architectures (Pentium and newer) would prefer @code{long double}
8315 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8316 conforming to the ABI, this would not be possible.  So specifying a
8317 @option{-m128bit-long-double} will align @code{long double}
8318 to a 16 byte boundary by padding the @code{long double} with an additional
8319 32 bit zero.
8320
8321 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8322 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8323
8324 Notice that neither of these options enable any extra precision over the x87
8325 standard of 80 bits for a @code{long double}.
8326
8327 @strong{Warning:} if you override the default value for your target ABI, the
8328 structures and arrays containing @code{long double} variables will change
8329 their size as well as function calling convention for function taking
8330 @code{long double} will be modified.  Hence they will not be binary
8331 compatible with arrays or structures in code compiled without that switch.
8332
8333
8334 @item -msvr3-shlib
8335 @itemx -mno-svr3-shlib
8336 @opindex msvr3-shlib
8337 @opindex mno-svr3-shlib
8338 Control whether GCC places uninitialized local variables into the
8339 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8340 into @code{bss}.  These options are meaningful only on System V Release 3.
8341
8342 @item -mrtd
8343 @opindex mrtd
8344 Use a different function-calling convention, in which functions that
8345 take a fixed number of arguments return with the @code{ret} @var{num}
8346 instruction, which pops their arguments while returning.  This saves one
8347 instruction in the caller since there is no need to pop the arguments
8348 there.
8349
8350 You can specify that an individual function is called with this calling
8351 sequence with the function attribute @samp{stdcall}.  You can also
8352 override the @option{-mrtd} option by using the function attribute
8353 @samp{cdecl}.  @xref{Function Attributes}.
8354
8355 @strong{Warning:} this calling convention is incompatible with the one
8356 normally used on Unix, so you cannot use it if you need to call
8357 libraries compiled with the Unix compiler.
8358
8359 Also, you must provide function prototypes for all functions that
8360 take variable numbers of arguments (including @code{printf});
8361 otherwise incorrect code will be generated for calls to those
8362 functions.
8363
8364 In addition, seriously incorrect code will result if you call a
8365 function with too many arguments.  (Normally, extra arguments are
8366 harmlessly ignored.)
8367
8368 @item -mregparm=@var{num}
8369 @opindex mregparm
8370 Control how many registers are used to pass integer arguments.  By
8371 default, no registers are used to pass arguments, and at most 3
8372 registers can be used.  You can control this behavior for a specific
8373 function by using the function attribute @samp{regparm}.
8374 @xref{Function Attributes}.
8375
8376 @strong{Warning:} if you use this switch, and
8377 @var{num} is nonzero, then you must build all modules with the same
8378 value, including any libraries.  This includes the system libraries and
8379 startup modules.
8380
8381 @item -mpreferred-stack-boundary=@var{num}
8382 @opindex mpreferred-stack-boundary
8383 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8384 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8385 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8386 size (@option{-Os}), in which case the default is the minimum correct
8387 alignment (4 bytes for x86, and 8 bytes for x86-64).
8388
8389 On Pentium and PentiumPro, @code{double} and @code{long double} values
8390 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8391 suffer significant run time performance penalties.  On Pentium III, the
8392 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8393 penalties if it is not 16 byte aligned.
8394
8395 To ensure proper alignment of this values on the stack, the stack boundary
8396 must be as aligned as that required by any value stored on the stack.
8397 Further, every function must be generated such that it keeps the stack
8398 aligned.  Thus calling a function compiled with a higher preferred
8399 stack boundary from a function compiled with a lower preferred stack
8400 boundary will most likely misalign the stack.  It is recommended that
8401 libraries that use callbacks always use the default setting.
8402
8403 This extra alignment does consume extra stack space, and generally
8404 increases code size.  Code that is sensitive to stack space usage, such
8405 as embedded systems and operating system kernels, may want to reduce the
8406 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8407
8408 @item -mmmx
8409 @itemx -mno-mmx
8410 @item -msse
8411 @itemx -mno-sse
8412 @item -msse2
8413 @itemx -mno-sse2
8414 @item -msse3
8415 @itemx -mno-sse3
8416 @item -m3dnow
8417 @itemx -mno-3dnow
8418 @opindex mmmx
8419 @opindex mno-mmx
8420 @opindex msse
8421 @opindex mno-sse
8422 @opindex m3dnow
8423 @opindex mno-3dnow
8424 These switches enable or disable the use of built-in functions that allow
8425 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8426 instruction set.
8427
8428 @xref{X86 Built-in Functions}, for details of the functions enabled
8429 and disabled by these switches.
8430
8431 To have SSE/SSE2 instructions generated automatically from floating-point
8432 code, see @option{-mfpmath=sse}.
8433
8434 @item -mpush-args
8435 @itemx -mno-push-args
8436 @opindex mpush-args
8437 @opindex mno-push-args
8438 Use PUSH operations to store outgoing parameters.  This method is shorter
8439 and usually equally fast as method using SUB/MOV operations and is enabled
8440 by default.  In some cases disabling it may improve performance because of
8441 improved scheduling and reduced dependencies.
8442
8443 @item -maccumulate-outgoing-args
8444 @opindex maccumulate-outgoing-args
8445 If enabled, the maximum amount of space required for outgoing arguments will be
8446 computed in the function prologue.  This is faster on most modern CPUs
8447 because of reduced dependencies, improved scheduling and reduced stack usage
8448 when preferred stack boundary is not equal to 2.  The drawback is a notable
8449 increase in code size.  This switch implies @option{-mno-push-args}.
8450
8451 @item -mthreads
8452 @opindex mthreads
8453 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8454 on thread-safe exception handling must compile and link all code with the
8455 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8456 @option{-D_MT}; when linking, it links in a special thread helper library
8457 @option{-lmingwthrd} which cleans up per thread exception handling data.
8458
8459 @item -mno-align-stringops
8460 @opindex mno-align-stringops
8461 Do not align destination of inlined string operations.  This switch reduces
8462 code size and improves performance in case the destination is already aligned,
8463 but GCC doesn't know about it.
8464
8465 @item -minline-all-stringops
8466 @opindex minline-all-stringops
8467 By default GCC inlines string operations only when destination is known to be
8468 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8469 size, but may improve performance of code that depends on fast memcpy, strlen
8470 and memset for short lengths.
8471
8472 @item -momit-leaf-frame-pointer
8473 @opindex momit-leaf-frame-pointer
8474 Don't keep the frame pointer in a register for leaf functions.  This
8475 avoids the instructions to save, set up and restore frame pointers and
8476 makes an extra register available in leaf functions.  The option
8477 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8478 which might make debugging harder.
8479
8480 @item -mtls-direct-seg-refs
8481 @itemx -mno-tls-direct-seg-refs
8482 @opindex mtls-direct-seg-refs
8483 Controls whether TLS variables may be accessed with offsets from the
8484 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8485 or whether the thread base pointer must be added.  Whether or not this
8486 is legal depends on the operating system, and whether it maps the
8487 segment to cover the entire TLS area.
8488
8489 For systems that use GNU libc, the default is on.
8490 @end table
8491
8492 These @samp{-m} switches are supported in addition to the above
8493 on AMD x86-64 processors in 64-bit environments.
8494
8495 @table @gcctabopt
8496 @item -m32
8497 @itemx -m64
8498 @opindex m32
8499 @opindex m64
8500 Generate code for a 32-bit or 64-bit environment.
8501 The 32-bit environment sets int, long and pointer to 32 bits and
8502 generates code that runs on any i386 system.
8503 The 64-bit environment sets int to 32 bits and long and pointer
8504 to 64 bits and generates code for AMD's x86-64 architecture.
8505
8506 @item -mno-red-zone
8507 @opindex no-red-zone
8508 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8509 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8510 stack pointer that will not be modified by signal or interrupt handlers
8511 and therefore can be used for temporary data without adjusting the stack
8512 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8513
8514 @item -mcmodel=small
8515 @opindex mcmodel=small
8516 Generate code for the small code model: the program and its symbols must
8517 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8518 Programs can be statically or dynamically linked.  This is the default
8519 code model.
8520
8521 @item -mcmodel=kernel
8522 @opindex mcmodel=kernel
8523 Generate code for the kernel code model.  The kernel runs in the
8524 negative 2 GB of the address space.
8525 This model has to be used for Linux kernel code.
8526
8527 @item -mcmodel=medium
8528 @opindex mcmodel=medium
8529 Generate code for the medium model: The program is linked in the lower 2
8530 GB of the address space but symbols can be located anywhere in the
8531 address space.  Programs can be statically or dynamically linked, but
8532 building of shared libraries are not supported with the medium model.
8533
8534 @item -mcmodel=large
8535 @opindex mcmodel=large
8536 Generate code for the large model: This model makes no assumptions
8537 about addresses and sizes of sections.  Currently GCC does not implement
8538 this model.
8539 @end table
8540
8541 @node HPPA Options
8542 @subsection HPPA Options
8543 @cindex HPPA Options
8544
8545 These @samp{-m} options are defined for the HPPA family of computers:
8546
8547 @table @gcctabopt
8548 @item -march=@var{architecture-type}
8549 @opindex march
8550 Generate code for the specified architecture.  The choices for
8551 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8552 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8553 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8554 architecture option for your machine.  Code compiled for lower numbered
8555 architectures will run on higher numbered architectures, but not the
8556 other way around.
8557
8558 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8559 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8560 support.
8561
8562 @item -mpa-risc-1-0
8563 @itemx -mpa-risc-1-1
8564 @itemx -mpa-risc-2-0
8565 @opindex mpa-risc-1-0
8566 @opindex mpa-risc-1-1
8567 @opindex mpa-risc-2-0
8568 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8569
8570 @item -mbig-switch
8571 @opindex mbig-switch
8572 Generate code suitable for big switch tables.  Use this option only if
8573 the assembler/linker complain about out of range branches within a switch
8574 table.
8575
8576 @item -mjump-in-delay
8577 @opindex mjump-in-delay
8578 Fill delay slots of function calls with unconditional jump instructions
8579 by modifying the return pointer for the function call to be the target
8580 of the conditional jump.
8581
8582 @item -mdisable-fpregs
8583 @opindex mdisable-fpregs
8584 Prevent floating point registers from being used in any manner.  This is
8585 necessary for compiling kernels which perform lazy context switching of
8586 floating point registers.  If you use this option and attempt to perform
8587 floating point operations, the compiler will abort.
8588
8589 @item -mdisable-indexing
8590 @opindex mdisable-indexing
8591 Prevent the compiler from using indexing address modes.  This avoids some
8592 rather obscure problems when compiling MIG generated code under MACH@.
8593
8594 @item -mno-space-regs
8595 @opindex mno-space-regs
8596 Generate code that assumes the target has no space registers.  This allows
8597 GCC to generate faster indirect calls and use unscaled index address modes.
8598
8599 Such code is suitable for level 0 PA systems and kernels.
8600
8601 @item -mfast-indirect-calls
8602 @opindex mfast-indirect-calls
8603 Generate code that assumes calls never cross space boundaries.  This
8604 allows GCC to emit code which performs faster indirect calls.
8605
8606 This option will not work in the presence of shared libraries or nested
8607 functions.
8608
8609 @item -mlong-load-store
8610 @opindex mlong-load-store
8611 Generate 3-instruction load and store sequences as sometimes required by
8612 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8613 the HP compilers.
8614
8615 @item -mportable-runtime
8616 @opindex mportable-runtime
8617 Use the portable calling conventions proposed by HP for ELF systems.
8618
8619 @item -mgas
8620 @opindex mgas
8621 Enable the use of assembler directives only GAS understands.
8622
8623 @item -mschedule=@var{cpu-type}
8624 @opindex mschedule
8625 Schedule code according to the constraints for the machine type
8626 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8627 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8628 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8629 proper scheduling option for your machine.  The default scheduling is
8630 @samp{8000}.
8631
8632 @item -mlinker-opt
8633 @opindex mlinker-opt
8634 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8635 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8636 linkers in which they give bogus error messages when linking some programs.
8637
8638 @item -msoft-float
8639 @opindex msoft-float
8640 Generate output containing library calls for floating point.
8641 @strong{Warning:} the requisite libraries are not available for all HPPA
8642 targets.  Normally the facilities of the machine's usual C compiler are
8643 used, but this cannot be done directly in cross-compilation.  You must make
8644 your own arrangements to provide suitable library functions for
8645 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8646 does provide software floating point support.
8647
8648 @option{-msoft-float} changes the calling convention in the output file;
8649 therefore, it is only useful if you compile @emph{all} of a program with
8650 this option.  In particular, you need to compile @file{libgcc.a}, the
8651 library that comes with GCC, with @option{-msoft-float} in order for
8652 this to work.
8653
8654 @item -msio
8655 @opindex msio
8656 Generate the predefine, @code{_SIO}, for server IO.  The default is
8657 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8658 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8659 options are available under HP-UX and HI-UX.
8660
8661 @item -mgnu-ld
8662 @opindex gnu-ld
8663 Use GNU ld specific options.  This passes @option{-shared} to ld when
8664 building a shared library.  It is the default when GCC is configured,
8665 explicitly or implicitly, with the GNU linker.  This option does not
8666 have any affect on which ld is called, it only changes what parameters
8667 are passed to that ld.  The ld that is called is determined by the
8668 @option{--with-ld} configure option, GCC's program search path, and
8669 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8670 using @samp{which `gcc -print-prog-name=ld`}.
8671
8672 @item -mhp-ld
8673 @opindex hp-ld
8674 Use HP ld specific options.  This passes @option{-b} to ld when building
8675 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8676 links.  It is the default when GCC is configured, explicitly or
8677 implicitly, with the HP linker.  This option does not have any affect on
8678 which ld is called, it only changes what parameters are passed to that
8679 ld.  The ld that is called is determined by the @option{--with-ld}
8680 configure option, GCC's program search path, and finally by the user's
8681 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8682 `gcc -print-prog-name=ld`}.
8683
8684 @item -mlong-calls
8685 @opindex mno-long-calls
8686 Generate code that uses long call sequences.  This ensures that a call
8687 is always able to reach linker generated stubs.  The default is to generate
8688 long calls only when the distance from the call site to the beginning
8689 of the function or translation unit, as the case may be, exceeds a
8690 predefined limit set by the branch type being used.  The limits for
8691 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8692 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8693 240,000 bytes.
8694
8695 Distances are measured from the beginning of functions when using the
8696 @option{-ffunction-sections} option, or when using the @option{-mgas}
8697 and @option{-mno-portable-runtime} options together under HP-UX with
8698 the SOM linker.
8699
8700 It is normally not desirable to use this option as it will degrade
8701 performance.  However, it may be useful in large applications,
8702 particularly when partial linking is used to build the application.
8703
8704 The types of long calls used depends on the capabilities of the
8705 assembler and linker, and the type of code being generated.  The
8706 impact on systems that support long absolute calls, and long pic
8707 symbol-difference or pc-relative calls should be relatively small.
8708 However, an indirect call is used on 32-bit ELF systems in pic code
8709 and it is quite long.
8710
8711 @item -nolibdld
8712 @opindex nolibdld
8713 Suppress the generation of link options to search libdld.sl when the
8714 @option{-static} option is specified on HP-UX 10 and later.
8715
8716 @item -static
8717 @opindex static
8718 The HP-UX implementation of setlocale in libc has a dependency on
8719 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8720 when the @option{-static} option is specified, special link options
8721 are needed to resolve this dependency.
8722
8723 On HP-UX 10 and later, the GCC driver adds the necessary options to
8724 link with libdld.sl when the @option{-static} option is specified.
8725 This causes the resulting binary to be dynamic.  On the 64-bit port,
8726 the linkers generate dynamic binaries by default in any case.  The
8727 @option{-nolibdld} option can be used to prevent the GCC driver from
8728 adding these link options.
8729
8730 @item -threads
8731 @opindex threads
8732 Add support for multithreading with the @dfn{dce thread} library
8733 under HP-UX.  This option sets flags for both the preprocessor and
8734 linker.
8735 @end table
8736
8737 @node Intel 960 Options
8738 @subsection Intel 960 Options
8739
8740 These @samp{-m} options are defined for the Intel 960 implementations:
8741
8742 @table @gcctabopt
8743 @item -m@var{cpu-type}
8744 @opindex mka
8745 @opindex mkb
8746 @opindex mmc
8747 @opindex mca
8748 @opindex mcf
8749 @opindex msa
8750 @opindex msb
8751 Assume the defaults for the machine type @var{cpu-type} for some of
8752 the other options, including instruction scheduling, floating point
8753 support, and addressing modes.  The choices for @var{cpu-type} are
8754 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8755 @samp{sa}, and @samp{sb}.
8756 The default is
8757 @samp{kb}.
8758
8759 @item -mnumerics
8760 @itemx -msoft-float
8761 @opindex mnumerics
8762 @opindex msoft-float
8763 The @option{-mnumerics} option indicates that the processor does support
8764 floating-point instructions.  The @option{-msoft-float} option indicates
8765 that floating-point support should not be assumed.
8766
8767 @item -mleaf-procedures
8768 @itemx -mno-leaf-procedures
8769 @opindex mleaf-procedures
8770 @opindex mno-leaf-procedures
8771 Do (or do not) attempt to alter leaf procedures to be callable with the
8772 @code{bal} instruction as well as @code{call}.  This will result in more
8773 efficient code for explicit calls when the @code{bal} instruction can be
8774 substituted by the assembler or linker, but less efficient code in other
8775 cases, such as calls via function pointers, or using a linker that doesn't
8776 support this optimization.
8777
8778 @item -mtail-call
8779 @itemx -mno-tail-call
8780 @opindex mtail-call
8781 @opindex mno-tail-call
8782 Do (or do not) make additional attempts (beyond those of the
8783 machine-independent portions of the compiler) to optimize tail-recursive
8784 calls into branches.  You may not want to do this because the detection of
8785 cases where this is not valid is not totally complete.  The default is
8786 @option{-mno-tail-call}.
8787
8788 @item -mcomplex-addr
8789 @itemx -mno-complex-addr
8790 @opindex mcomplex-addr
8791 @opindex mno-complex-addr
8792 Assume (or do not assume) that the use of a complex addressing mode is a
8793 win on this implementation of the i960.  Complex addressing modes may not
8794 be worthwhile on the K-series, but they definitely are on the C-series.
8795 The default is currently @option{-mcomplex-addr} for all processors except
8796 the CB and CC@.
8797
8798 @item -mcode-align
8799 @itemx -mno-code-align
8800 @opindex mcode-align
8801 @opindex mno-code-align
8802 Align code to 8-byte boundaries for faster fetching (or don't bother).
8803 Currently turned on by default for C-series implementations only.
8804
8805 @ignore
8806 @item -mclean-linkage
8807 @itemx -mno-clean-linkage
8808 @opindex mclean-linkage
8809 @opindex mno-clean-linkage
8810 These options are not fully implemented.
8811 @end ignore
8812
8813 @item -mic-compat
8814 @itemx -mic2.0-compat
8815 @itemx -mic3.0-compat
8816 @opindex mic-compat
8817 @opindex mic2.0-compat
8818 @opindex mic3.0-compat
8819 Enable compatibility with iC960 v2.0 or v3.0.
8820
8821 @item -masm-compat
8822 @itemx -mintel-asm
8823 @opindex masm-compat
8824 @opindex mintel-asm
8825 Enable compatibility with the iC960 assembler.
8826
8827 @item -mstrict-align
8828 @itemx -mno-strict-align
8829 @opindex mstrict-align
8830 @opindex mno-strict-align
8831 Do not permit (do permit) unaligned accesses.
8832
8833 @item -mold-align
8834 @opindex mold-align
8835 Enable structure-alignment compatibility with Intel's gcc release version
8836 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8837
8838 @item -mlong-double-64
8839 @opindex mlong-double-64
8840 Implement type @samp{long double} as 64-bit floating point numbers.
8841 Without the option @samp{long double} is implemented by 80-bit
8842 floating point numbers.  The only reason we have it because there is
8843 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8844 is only useful for people using soft-float targets.  Otherwise, we
8845 should recommend against use of it.
8846
8847 @end table
8848
8849 @node DEC Alpha Options
8850 @subsection DEC Alpha Options
8851
8852 These @samp{-m} options are defined for the DEC Alpha implementations:
8853
8854 @table @gcctabopt
8855 @item -mno-soft-float
8856 @itemx -msoft-float
8857 @opindex mno-soft-float
8858 @opindex msoft-float
8859 Use (do not use) the hardware floating-point instructions for
8860 floating-point operations.  When @option{-msoft-float} is specified,
8861 functions in @file{libgcc.a} will be used to perform floating-point
8862 operations.  Unless they are replaced by routines that emulate the
8863 floating-point operations, or compiled in such a way as to call such
8864 emulations routines, these routines will issue floating-point
8865 operations.   If you are compiling for an Alpha without floating-point
8866 operations, you must ensure that the library is built so as not to call
8867 them.
8868
8869 Note that Alpha implementations without floating-point operations are
8870 required to have floating-point registers.
8871
8872 @item -mfp-reg
8873 @itemx -mno-fp-regs
8874 @opindex mfp-reg
8875 @opindex mno-fp-regs
8876 Generate code that uses (does not use) the floating-point register set.
8877 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8878 register set is not used, floating point operands are passed in integer
8879 registers as if they were integers and floating-point results are passed
8880 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8881 so any function with a floating-point argument or return value called by code
8882 compiled with @option{-mno-fp-regs} must also be compiled with that
8883 option.
8884
8885 A typical use of this option is building a kernel that does not use,
8886 and hence need not save and restore, any floating-point registers.
8887
8888 @item -mieee
8889 @opindex mieee
8890 The Alpha architecture implements floating-point hardware optimized for
8891 maximum performance.  It is mostly compliant with the IEEE floating
8892 point standard.  However, for full compliance, software assistance is
8893 required.  This option generates code fully IEEE compliant code
8894 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8895 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8896 defined during compilation.  The resulting code is less efficient but is
8897 able to correctly support denormalized numbers and exceptional IEEE
8898 values such as not-a-number and plus/minus infinity.  Other Alpha
8899 compilers call this option @option{-ieee_with_no_inexact}.
8900
8901 @item -mieee-with-inexact
8902 @opindex mieee-with-inexact
8903 This is like @option{-mieee} except the generated code also maintains
8904 the IEEE @var{inexact-flag}.  Turning on this option causes the
8905 generated code to implement fully-compliant IEEE math.  In addition to
8906 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8907 macro.  On some Alpha implementations the resulting code may execute
8908 significantly slower than the code generated by default.  Since there is
8909 very little code that depends on the @var{inexact-flag}, you should
8910 normally not specify this option.  Other Alpha compilers call this
8911 option @option{-ieee_with_inexact}.
8912
8913 @item -mfp-trap-mode=@var{trap-mode}
8914 @opindex mfp-trap-mode
8915 This option controls what floating-point related traps are enabled.
8916 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8917 The trap mode can be set to one of four values:
8918
8919 @table @samp
8920 @item n
8921 This is the default (normal) setting.  The only traps that are enabled
8922 are the ones that cannot be disabled in software (e.g., division by zero
8923 trap).
8924
8925 @item u
8926 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8927 as well.
8928
8929 @item su
8930 Like @samp{su}, but the instructions are marked to be safe for software
8931 completion (see Alpha architecture manual for details).
8932
8933 @item sui
8934 Like @samp{su}, but inexact traps are enabled as well.
8935 @end table
8936
8937 @item -mfp-rounding-mode=@var{rounding-mode}
8938 @opindex mfp-rounding-mode
8939 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8940 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8941 of:
8942
8943 @table @samp
8944 @item n
8945 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8946 the nearest machine number or towards the even machine number in case
8947 of a tie.
8948
8949 @item m
8950 Round towards minus infinity.
8951
8952 @item c
8953 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8954
8955 @item d
8956 Dynamic rounding mode.  A field in the floating point control register
8957 (@var{fpcr}, see Alpha architecture reference manual) controls the
8958 rounding mode in effect.  The C library initializes this register for
8959 rounding towards plus infinity.  Thus, unless your program modifies the
8960 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8961 @end table
8962
8963 @item -mtrap-precision=@var{trap-precision}
8964 @opindex mtrap-precision
8965 In the Alpha architecture, floating point traps are imprecise.  This
8966 means without software assistance it is impossible to recover from a
8967 floating trap and program execution normally needs to be terminated.
8968 GCC can generate code that can assist operating system trap handlers
8969 in determining the exact location that caused a floating point trap.
8970 Depending on the requirements of an application, different levels of
8971 precisions can be selected:
8972
8973 @table @samp
8974 @item p
8975 Program precision.  This option is the default and means a trap handler
8976 can only identify which program caused a floating point exception.
8977
8978 @item f
8979 Function precision.  The trap handler can determine the function that
8980 caused a floating point exception.
8981
8982 @item i
8983 Instruction precision.  The trap handler can determine the exact
8984 instruction that caused a floating point exception.
8985 @end table
8986
8987 Other Alpha compilers provide the equivalent options called
8988 @option{-scope_safe} and @option{-resumption_safe}.
8989
8990 @item -mieee-conformant
8991 @opindex mieee-conformant
8992 This option marks the generated code as IEEE conformant.  You must not
8993 use this option unless you also specify @option{-mtrap-precision=i} and either
8994 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8995 is to emit the line @samp{.eflag 48} in the function prologue of the
8996 generated assembly file.  Under DEC Unix, this has the effect that
8997 IEEE-conformant math library routines will be linked in.
8998
8999 @item -mbuild-constants
9000 @opindex mbuild-constants
9001 Normally GCC examines a 32- or 64-bit integer constant to
9002 see if it can construct it from smaller constants in two or three
9003 instructions.  If it cannot, it will output the constant as a literal and
9004 generate code to load it from the data segment at runtime.
9005
9006 Use this option to require GCC to construct @emph{all} integer constants
9007 using code, even if it takes more instructions (the maximum is six).
9008
9009 You would typically use this option to build a shared library dynamic
9010 loader.  Itself a shared library, it must relocate itself in memory
9011 before it can find the variables and constants in its own data segment.
9012
9013 @item -malpha-as
9014 @itemx -mgas
9015 @opindex malpha-as
9016 @opindex mgas
9017 Select whether to generate code to be assembled by the vendor-supplied
9018 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9019
9020 @item -mbwx
9021 @itemx -mno-bwx
9022 @itemx -mcix
9023 @itemx -mno-cix
9024 @itemx -mfix
9025 @itemx -mno-fix
9026 @itemx -mmax
9027 @itemx -mno-max
9028 @opindex mbwx
9029 @opindex mno-bwx
9030 @opindex mcix
9031 @opindex mno-cix
9032 @opindex mfix
9033 @opindex mno-fix
9034 @opindex mmax
9035 @opindex mno-max
9036 Indicate whether GCC should generate code to use the optional BWX,
9037 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9038 sets supported by the CPU type specified via @option{-mcpu=} option or that
9039 of the CPU on which GCC was built if none was specified.
9040
9041 @item -mfloat-vax
9042 @itemx -mfloat-ieee
9043 @opindex mfloat-vax
9044 @opindex mfloat-ieee
9045 Generate code that uses (does not use) VAX F and G floating point
9046 arithmetic instead of IEEE single and double precision.
9047
9048 @item -mexplicit-relocs
9049 @itemx -mno-explicit-relocs
9050 @opindex mexplicit-relocs
9051 @opindex mno-explicit-relocs
9052 Older Alpha assemblers provided no way to generate symbol relocations
9053 except via assembler macros.  Use of these macros does not allow
9054 optimal instruction scheduling.  GNU binutils as of version 2.12
9055 supports a new syntax that allows the compiler to explicitly mark
9056 which relocations should apply to which instructions.  This option
9057 is mostly useful for debugging, as GCC detects the capabilities of
9058 the assembler when it is built and sets the default accordingly.
9059
9060 @item -msmall-data
9061 @itemx -mlarge-data
9062 @opindex msmall-data
9063 @opindex mlarge-data
9064 When @option{-mexplicit-relocs} is in effect, static data is
9065 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9066 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9067 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9068 16-bit relocations off of the @code{$gp} register.  This limits the
9069 size of the small data area to 64KB, but allows the variables to be
9070 directly accessed via a single instruction.
9071
9072 The default is @option{-mlarge-data}.  With this option the data area
9073 is limited to just below 2GB.  Programs that require more than 2GB of
9074 data must use @code{malloc} or @code{mmap} to allocate the data in the
9075 heap instead of in the program's data segment.
9076
9077 When generating code for shared libraries, @option{-fpic} implies
9078 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9079
9080 @item -msmall-text
9081 @itemx -mlarge-text
9082 @opindex msmall-text
9083 @opindex mlarge-text
9084 When @option{-msmall-text} is used, the compiler assumes that the
9085 code of the entire program (or shared library) fits in 4MB, and is
9086 thus reachable with a branch instruction.  When @option{-msmall-data}
9087 is used, the compiler can assume that all local symbols share the
9088 same @code{$gp} value, and thus reduce the number of instructions
9089 required for a function call from 4 to 1.
9090
9091 The default is @option{-mlarge-text}.
9092
9093 @item -mcpu=@var{cpu_type}
9094 @opindex mcpu
9095 Set the instruction set and instruction scheduling parameters for
9096 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9097 style name or the corresponding chip number.  GCC supports scheduling
9098 parameters for the EV4, EV5 and EV6 family of processors and will
9099 choose the default values for the instruction set from the processor
9100 you specify.  If you do not specify a processor type, GCC will default
9101 to the processor on which the compiler was built.
9102
9103 Supported values for @var{cpu_type} are
9104
9105 @table @samp
9106 @item ev4
9107 @itemx ev45
9108 @itemx 21064
9109 Schedules as an EV4 and has no instruction set extensions.
9110
9111 @item ev5
9112 @itemx 21164
9113 Schedules as an EV5 and has no instruction set extensions.
9114
9115 @item ev56
9116 @itemx 21164a
9117 Schedules as an EV5 and supports the BWX extension.
9118
9119 @item pca56
9120 @itemx 21164pc
9121 @itemx 21164PC
9122 Schedules as an EV5 and supports the BWX and MAX extensions.
9123
9124 @item ev6
9125 @itemx 21264
9126 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9127
9128 @item ev67
9129 @itemx 21264a
9130 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9131 @end table
9132
9133 @item -mtune=@var{cpu_type}
9134 @opindex mtune
9135 Set only the instruction scheduling parameters for machine type
9136 @var{cpu_type}.  The instruction set is not changed.
9137
9138 @item -mmemory-latency=@var{time}
9139 @opindex mmemory-latency
9140 Sets the latency the scheduler should assume for typical memory
9141 references as seen by the application.  This number is highly
9142 dependent on the memory access patterns used by the application
9143 and the size of the external cache on the machine.
9144
9145 Valid options for @var{time} are
9146
9147 @table @samp
9148 @item @var{number}
9149 A decimal number representing clock cycles.
9150
9151 @item L1
9152 @itemx L2
9153 @itemx L3
9154 @itemx main
9155 The compiler contains estimates of the number of clock cycles for
9156 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9157 (also called Dcache, Scache, and Bcache), as well as to main memory.
9158 Note that L3 is only valid for EV5.
9159
9160 @end table
9161 @end table
9162
9163 @node DEC Alpha/VMS Options
9164 @subsection DEC Alpha/VMS Options
9165
9166 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9167
9168 @table @gcctabopt
9169 @item -mvms-return-codes
9170 @opindex mvms-return-codes
9171 Return VMS condition codes from main.  The default is to return POSIX
9172 style condition (e.g.@ error) codes.
9173 @end table
9174
9175 @node H8/300 Options
9176 @subsection H8/300 Options
9177
9178 These @samp{-m} options are defined for the H8/300 implementations:
9179
9180 @table @gcctabopt
9181 @item -mrelax
9182 @opindex mrelax
9183 Shorten some address references at link time, when possible; uses the
9184 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9185 ld, Using ld}, for a fuller description.
9186
9187 @item -mh
9188 @opindex mh
9189 Generate code for the H8/300H@.
9190
9191 @item -ms
9192 @opindex ms
9193 Generate code for the H8S@.
9194
9195 @item -mn
9196 @opindex mn
9197 Generate code for the H8S and H8/300H in the normal mode.  This switch
9198 must be used either with -mh or -ms.
9199
9200 @item -ms2600
9201 @opindex ms2600
9202 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9203
9204 @item -mint32
9205 @opindex mint32
9206 Make @code{int} data 32 bits by default.
9207
9208 @item -malign-300
9209 @opindex malign-300
9210 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9211 The default for the H8/300H and H8S is to align longs and floats on 4
9212 byte boundaries.
9213 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9214 This option has no effect on the H8/300.
9215 @end table
9216
9217 @node SH Options
9218 @subsection SH Options
9219
9220 These @samp{-m} options are defined for the SH implementations:
9221
9222 @table @gcctabopt
9223 @item -m1
9224 @opindex m1
9225 Generate code for the SH1.
9226
9227 @item -m2
9228 @opindex m2
9229 Generate code for the SH2.
9230
9231 @item -m2e
9232 Generate code for the SH2e.
9233
9234 @item -m3
9235 @opindex m3
9236 Generate code for the SH3.
9237
9238 @item -m3e
9239 @opindex m3e
9240 Generate code for the SH3e.
9241
9242 @item -m4-nofpu
9243 @opindex m4-nofpu
9244 Generate code for the SH4 without a floating-point unit.
9245
9246 @item -m4-single-only
9247 @opindex m4-single-only
9248 Generate code for the SH4 with a floating-point unit that only
9249 supports single-precision arithmetic.
9250
9251 @item -m4-single
9252 @opindex m4-single
9253 Generate code for the SH4 assuming the floating-point unit is in
9254 single-precision mode by default.
9255
9256 @item -m4
9257 @opindex m4
9258 Generate code for the SH4.
9259
9260 @item -mb
9261 @opindex mb
9262 Compile code for the processor in big endian mode.
9263
9264 @item -ml
9265 @opindex ml
9266 Compile code for the processor in little endian mode.
9267
9268 @item -mdalign
9269 @opindex mdalign
9270 Align doubles at 64-bit boundaries.  Note that this changes the calling
9271 conventions, and thus some functions from the standard C library will
9272 not work unless you recompile it first with @option{-mdalign}.
9273
9274 @item -mrelax
9275 @opindex mrelax
9276 Shorten some address references at link time, when possible; uses the
9277 linker option @option{-relax}.
9278
9279 @item -mbigtable
9280 @opindex mbigtable
9281 Use 32-bit offsets in @code{switch} tables.  The default is to use
9282 16-bit offsets.
9283
9284 @item -mfmovd
9285 @opindex mfmovd
9286 Enable the use of the instruction @code{fmovd}.
9287
9288 @item -mhitachi
9289 @opindex mhitachi
9290 Comply with the calling conventions defined by Renesas.
9291
9292 @item -mnomacsave
9293 @opindex mnomacsave
9294 Mark the @code{MAC} register as call-clobbered, even if
9295 @option{-mhitachi} is given.
9296
9297 @item -mieee
9298 @opindex mieee
9299 Increase IEEE-compliance of floating-point code.
9300
9301 @item -misize
9302 @opindex misize
9303 Dump instruction size and location in the assembly code.
9304
9305 @item -mpadstruct
9306 @opindex mpadstruct
9307 This option is deprecated.  It pads structures to multiple of 4 bytes,
9308 which is incompatible with the SH ABI@.
9309
9310 @item -mspace
9311 @opindex mspace
9312 Optimize for space instead of speed.  Implied by @option{-Os}.
9313
9314 @item -mprefergot
9315 @opindex mprefergot
9316 When generating position-independent code, emit function calls using
9317 the Global Offset Table instead of the Procedure Linkage Table.
9318
9319 @item -musermode
9320 @opindex musermode
9321 Generate a library function call to invalidate instruction cache
9322 entries, after fixing up a trampoline.  This library function call
9323 doesn't assume it can write to the whole memory address space.  This
9324 is the default when the target is @code{sh-*-linux*}.
9325 @end table
9326
9327 @node System V Options
9328 @subsection Options for System V
9329
9330 These additional options are available on System V Release 4 for
9331 compatibility with other compilers on those systems:
9332
9333 @table @gcctabopt
9334 @item -G
9335 @opindex G
9336 Create a shared object.
9337 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9338
9339 @item -Qy
9340 @opindex Qy
9341 Identify the versions of each tool used by the compiler, in a
9342 @code{.ident} assembler directive in the output.
9343
9344 @item -Qn
9345 @opindex Qn
9346 Refrain from adding @code{.ident} directives to the output file (this is
9347 the default).
9348
9349 @item -YP,@var{dirs}
9350 @opindex YP
9351 Search the directories @var{dirs}, and no others, for libraries
9352 specified with @option{-l}.
9353
9354 @item -Ym,@var{dir}
9355 @opindex Ym
9356 Look in the directory @var{dir} to find the M4 preprocessor.
9357 The assembler uses this option.
9358 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9359 @c the generic assembler that comes with Solaris takes just -Ym.
9360 @end table
9361
9362 @node TMS320C3x/C4x Options
9363 @subsection TMS320C3x/C4x Options
9364 @cindex TMS320C3x/C4x Options
9365
9366 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9367
9368 @table @gcctabopt
9369
9370 @item -mcpu=@var{cpu_type}
9371 @opindex mcpu
9372 Set the instruction set, register set, and instruction scheduling
9373 parameters for machine type @var{cpu_type}.  Supported values for
9374 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9375 @samp{c44}.  The default is @samp{c40} to generate code for the
9376 TMS320C40.
9377
9378 @item -mbig-memory
9379 @itemx -mbig
9380 @itemx -msmall-memory
9381 @itemx -msmall
9382 @opindex mbig-memory
9383 @opindex mbig
9384 @opindex msmall-memory
9385 @opindex msmall
9386 Generates code for the big or small memory model.  The small memory
9387 model assumed that all data fits into one 64K word page.  At run-time
9388 the data page (DP) register must be set to point to the 64K page
9389 containing the .bss and .data program sections.  The big memory model is
9390 the default and requires reloading of the DP register for every direct
9391 memory access.
9392
9393 @item -mbk
9394 @itemx -mno-bk
9395 @opindex mbk
9396 @opindex mno-bk
9397 Allow (disallow) allocation of general integer operands into the block
9398 count register BK@.
9399
9400 @item -mdb
9401 @itemx -mno-db
9402 @opindex mdb
9403 @opindex mno-db
9404 Enable (disable) generation of code using decrement and branch,
9405 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9406 on the safe side, this is disabled for the C3x, since the maximum
9407 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9408 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9409 that it can utilize the decrement and branch instruction, but will give
9410 up if there is more than one memory reference in the loop.  Thus a loop
9411 where the loop counter is decremented can generate slightly more
9412 efficient code, in cases where the RPTB instruction cannot be utilized.
9413
9414 @item -mdp-isr-reload
9415 @itemx -mparanoid
9416 @opindex mdp-isr-reload
9417 @opindex mparanoid
9418 Force the DP register to be saved on entry to an interrupt service
9419 routine (ISR), reloaded to point to the data section, and restored on
9420 exit from the ISR@.  This should not be required unless someone has
9421 violated the small memory model by modifying the DP register, say within
9422 an object library.
9423
9424 @item -mmpyi
9425 @itemx -mno-mpyi
9426 @opindex mmpyi
9427 @opindex mno-mpyi
9428 For the C3x use the 24-bit MPYI instruction for integer multiplies
9429 instead of a library call to guarantee 32-bit results.  Note that if one
9430 of the operands is a constant, then the multiplication will be performed
9431 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9432 then squaring operations are performed inline instead of a library call.
9433
9434 @item -mfast-fix
9435 @itemx -mno-fast-fix
9436 @opindex mfast-fix
9437 @opindex mno-fast-fix
9438 The C3x/C4x FIX instruction to convert a floating point value to an
9439 integer value chooses the nearest integer less than or equal to the
9440 floating point value rather than to the nearest integer.  Thus if the
9441 floating point number is negative, the result will be incorrectly
9442 truncated an additional code is necessary to detect and correct this
9443 case.  This option can be used to disable generation of the additional
9444 code required to correct the result.
9445
9446 @item -mrptb
9447 @itemx -mno-rptb
9448 @opindex mrptb
9449 @opindex mno-rptb
9450 Enable (disable) generation of repeat block sequences using the RPTB
9451 instruction for zero overhead looping.  The RPTB construct is only used
9452 for innermost loops that do not call functions or jump across the loop
9453 boundaries.  There is no advantage having nested RPTB loops due to the
9454 overhead required to save and restore the RC, RS, and RE registers.
9455 This is enabled by default with @option{-O2}.
9456
9457 @item -mrpts=@var{count}
9458 @itemx -mno-rpts
9459 @opindex mrpts
9460 @opindex mno-rpts
9461 Enable (disable) the use of the single instruction repeat instruction
9462 RPTS@.  If a repeat block contains a single instruction, and the loop
9463 count can be guaranteed to be less than the value @var{count}, GCC will
9464 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9465 then a RPTS will be emitted even if the loop count cannot be determined
9466 at compile time.  Note that the repeated instruction following RPTS does
9467 not have to be reloaded from memory each iteration, thus freeing up the
9468 CPU buses for operands.  However, since interrupts are blocked by this
9469 instruction, it is disabled by default.
9470
9471 @item -mloop-unsigned
9472 @itemx -mno-loop-unsigned
9473 @opindex mloop-unsigned
9474 @opindex mno-loop-unsigned
9475 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9476 is @math{2^{31} + 1} since these instructions test if the iteration count is
9477 negative to terminate the loop.  If the iteration count is unsigned
9478 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9479 exceeded.  This switch allows an unsigned iteration count.
9480
9481 @item -mti
9482 @opindex mti
9483 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9484 with.  This also enforces compatibility with the API employed by the TI
9485 C3x C compiler.  For example, long doubles are passed as structures
9486 rather than in floating point registers.
9487
9488 @item -mregparm
9489 @itemx -mmemparm
9490 @opindex mregparm
9491 @opindex mmemparm
9492 Generate code that uses registers (stack) for passing arguments to functions.
9493 By default, arguments are passed in registers where possible rather
9494 than by pushing arguments on to the stack.
9495
9496 @item -mparallel-insns
9497 @itemx -mno-parallel-insns
9498 @opindex mparallel-insns
9499 @opindex mno-parallel-insns
9500 Allow the generation of parallel instructions.  This is enabled by
9501 default with @option{-O2}.
9502
9503 @item -mparallel-mpy
9504 @itemx -mno-parallel-mpy
9505 @opindex mparallel-mpy
9506 @opindex mno-parallel-mpy
9507 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9508 provided @option{-mparallel-insns} is also specified.  These instructions have
9509 tight register constraints which can pessimize the code generation
9510 of large functions.
9511
9512 @end table
9513
9514 @node V850 Options
9515 @subsection V850 Options
9516 @cindex V850 Options
9517
9518 These @samp{-m} options are defined for V850 implementations:
9519
9520 @table @gcctabopt
9521 @item -mlong-calls
9522 @itemx -mno-long-calls
9523 @opindex mlong-calls
9524 @opindex mno-long-calls
9525 Treat all calls as being far away (near).  If calls are assumed to be
9526 far away, the compiler will always load the functions address up into a
9527 register, and call indirect through the pointer.
9528
9529 @item -mno-ep
9530 @itemx -mep
9531 @opindex mno-ep
9532 @opindex mep
9533 Do not optimize (do optimize) basic blocks that use the same index
9534 pointer 4 or more times to copy pointer into the @code{ep} register, and
9535 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9536 option is on by default if you optimize.
9537
9538 @item -mno-prolog-function
9539 @itemx -mprolog-function
9540 @opindex mno-prolog-function
9541 @opindex mprolog-function
9542 Do not use (do use) external functions to save and restore registers
9543 at the prologue and epilogue of a function.  The external functions
9544 are slower, but use less code space if more than one function saves
9545 the same number of registers.  The @option{-mprolog-function} option
9546 is on by default if you optimize.
9547
9548 @item -mspace
9549 @opindex mspace
9550 Try to make the code as small as possible.  At present, this just turns
9551 on the @option{-mep} and @option{-mprolog-function} options.
9552
9553 @item -mtda=@var{n}
9554 @opindex mtda
9555 Put static or global variables whose size is @var{n} bytes or less into
9556 the tiny data area that register @code{ep} points to.  The tiny data
9557 area can hold up to 256 bytes in total (128 bytes for byte references).
9558
9559 @item -msda=@var{n}
9560 @opindex msda
9561 Put static or global variables whose size is @var{n} bytes or less into
9562 the small data area that register @code{gp} points to.  The small data
9563 area can hold up to 64 kilobytes.
9564
9565 @item -mzda=@var{n}
9566 @opindex mzda
9567 Put static or global variables whose size is @var{n} bytes or less into
9568 the first 32 kilobytes of memory.
9569
9570 @item -mv850
9571 @opindex mv850
9572 Specify that the target processor is the V850.
9573
9574 @item -mbig-switch
9575 @opindex mbig-switch
9576 Generate code suitable for big switch tables.  Use this option only if
9577 the assembler/linker complain about out of range branches within a switch
9578 table.
9579
9580 @item -mapp-regs
9581 @opindex mapp-regs
9582 This option will cause r2 and r5 to be used in the code generated by
9583 the compiler.  This setting is the default.
9584
9585 @item -mno-app-regs
9586 @opindex mno-app-regs
9587 This option will cause r2 and r5 to be treated as fixed registers.
9588
9589 @item -mv850e1
9590 @opindex mv850e1
9591 Specify that the target processor is the V850E1.  The preprocessor
9592 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9593 this option is used.
9594
9595 @item -mv850e
9596 @opindex mv850e
9597 Specify that the target processor is the V850E.  The preprocessor
9598 constant @samp{__v850e__} will be defined if this option is used.
9599
9600 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9601 are defined then a default target processor will be chosen and the
9602 relevant @samp{__v850*__} preprocessor constant will be defined.
9603
9604 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9605 defined, regardless of which processor variant is the target.
9606
9607 @item -mdisable-callt
9608 @opindex mdisable-callt
9609 This option will suppress generation of the CALLT instruction for the
9610 v850e and v850e1 flavors of the v850 architecture.  The default is
9611 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9612
9613 @end table
9614
9615 @node ARC Options
9616 @subsection ARC Options
9617 @cindex ARC Options
9618
9619 These options are defined for ARC implementations:
9620
9621 @table @gcctabopt
9622 @item -EL
9623 @opindex EL
9624 Compile code for little endian mode.  This is the default.
9625
9626 @item -EB
9627 @opindex EB
9628 Compile code for big endian mode.
9629
9630 @item -mmangle-cpu
9631 @opindex mmangle-cpu
9632 Prepend the name of the cpu to all public symbol names.
9633 In multiple-processor systems, there are many ARC variants with different
9634 instruction and register set characteristics.  This flag prevents code
9635 compiled for one cpu to be linked with code compiled for another.
9636 No facility exists for handling variants that are ``almost identical''.
9637 This is an all or nothing option.
9638
9639 @item -mcpu=@var{cpu}
9640 @opindex mcpu
9641 Compile code for ARC variant @var{cpu}.
9642 Which variants are supported depend on the configuration.
9643 All variants support @option{-mcpu=base}, this is the default.
9644
9645 @item -mtext=@var{text-section}
9646 @itemx -mdata=@var{data-section}
9647 @itemx -mrodata=@var{readonly-data-section}
9648 @opindex mtext
9649 @opindex mdata
9650 @opindex mrodata
9651 Put functions, data, and readonly data in @var{text-section},
9652 @var{data-section}, and @var{readonly-data-section} respectively
9653 by default.  This can be overridden with the @code{section} attribute.
9654 @xref{Variable Attributes}.
9655
9656 @end table
9657
9658 @node NS32K Options
9659 @subsection NS32K Options
9660 @cindex NS32K options
9661
9662 These are the @samp{-m} options defined for the 32000 series.  The default
9663 values for these options depends on which style of 32000 was selected when
9664 the compiler was configured; the defaults for the most common choices are
9665 given below.
9666
9667 @table @gcctabopt
9668 @item -m32032
9669 @itemx -m32032
9670 @opindex m32032
9671 @opindex m32032
9672 Generate output for a 32032.  This is the default
9673 when the compiler is configured for 32032 and 32016 based systems.
9674
9675 @item -m32332
9676 @itemx -m32332
9677 @opindex m32332
9678 @opindex m32332
9679 Generate output for a 32332.  This is the default
9680 when the compiler is configured for 32332-based systems.
9681
9682 @item -m32532
9683 @itemx -m32532
9684 @opindex m32532
9685 @opindex m32532
9686 Generate output for a 32532.  This is the default
9687 when the compiler is configured for 32532-based systems.
9688
9689 @item -m32081
9690 @opindex m32081
9691 Generate output containing 32081 instructions for floating point.
9692 This is the default for all systems.
9693
9694 @item -m32381
9695 @opindex m32381
9696 Generate output containing 32381 instructions for floating point.  This
9697 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9698 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9699
9700 @item -mmulti-add
9701 @opindex mmulti-add
9702 Try and generate multiply-add floating point instructions @code{polyF}
9703 and @code{dotF}.  This option is only available if the @option{-m32381}
9704 option is in effect.  Using these instructions requires changes to
9705 register allocation which generally has a negative impact on
9706 performance.  This option should only be enabled when compiling code
9707 particularly likely to make heavy use of multiply-add instructions.
9708
9709 @item -mnomulti-add
9710 @opindex mnomulti-add
9711 Do not try and generate multiply-add floating point instructions
9712 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9713
9714 @item -msoft-float
9715 @opindex msoft-float
9716 Generate output containing library calls for floating point.
9717 @strong{Warning:} the requisite libraries may not be available.
9718
9719 @item -mieee-compare
9720 @itemx -mno-ieee-compare
9721 @opindex mieee-compare
9722 @opindex mno-ieee-compare
9723 Control whether or not the compiler uses IEEE floating point
9724 comparisons.  These handle correctly the case where the result of a
9725 comparison is unordered.
9726 @strong{Warning:} the requisite kernel support may not be available.
9727
9728 @item -mnobitfield
9729 @opindex mnobitfield
9730 Do not use the bit-field instructions.  On some machines it is faster to
9731 use shifting and masking operations.  This is the default for the pc532.
9732
9733 @item -mbitfield
9734 @opindex mbitfield
9735 Do use the bit-field instructions.  This is the default for all platforms
9736 except the pc532.
9737
9738 @item -mrtd
9739 @opindex mrtd
9740 Use a different function-calling convention, in which functions
9741 that take a fixed number of arguments return pop their
9742 arguments on return with the @code{ret} instruction.
9743
9744 This calling convention is incompatible with the one normally
9745 used on Unix, so you cannot use it if you need to call libraries
9746 compiled with the Unix compiler.
9747
9748 Also, you must provide function prototypes for all functions that
9749 take variable numbers of arguments (including @code{printf});
9750 otherwise incorrect code will be generated for calls to those
9751 functions.
9752
9753 In addition, seriously incorrect code will result if you call a
9754 function with too many arguments.  (Normally, extra arguments are
9755 harmlessly ignored.)
9756
9757 This option takes its name from the 680x0 @code{rtd} instruction.
9758
9759
9760 @item -mregparam
9761 @opindex mregparam
9762 Use a different function-calling convention where the first two arguments
9763 are passed in registers.
9764
9765 This calling convention is incompatible with the one normally
9766 used on Unix, so you cannot use it if you need to call libraries
9767 compiled with the Unix compiler.
9768
9769 @item -mnoregparam
9770 @opindex mnoregparam
9771 Do not pass any arguments in registers.  This is the default for all
9772 targets.
9773
9774 @item -msb
9775 @opindex msb
9776 It is OK to use the sb as an index register which is always loaded with
9777 zero.  This is the default for the pc532-netbsd target.
9778
9779 @item -mnosb
9780 @opindex mnosb
9781 The sb register is not available for use or has not been initialized to
9782 zero by the run time system.  This is the default for all targets except
9783 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9784 @option{-fpic} is set.
9785
9786 @item -mhimem
9787 @opindex mhimem
9788 Many ns32000 series addressing modes use displacements of up to 512MB@.
9789 If an address is above 512MB then displacements from zero can not be used.
9790 This option causes code to be generated which can be loaded above 512MB@.
9791 This may be useful for operating systems or ROM code.
9792
9793 @item -mnohimem
9794 @opindex mnohimem
9795 Assume code will be loaded in the first 512MB of virtual address space.
9796 This is the default for all platforms.
9797
9798
9799 @end table
9800
9801 @node AVR Options
9802 @subsection AVR Options
9803 @cindex AVR Options
9804
9805 These options are defined for AVR implementations:
9806
9807 @table @gcctabopt
9808 @item -mmcu=@var{mcu}
9809 @opindex mmcu
9810 Specify ATMEL AVR instruction set or MCU type.
9811
9812 Instruction set avr1 is for the minimal AVR core, not supported by the C
9813 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9814 attiny11, attiny12, attiny15, attiny28).
9815
9816 Instruction set avr2 (default) is for the classic AVR core with up to
9817 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9818 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9819 at90c8534, at90s8535).
9820
9821 Instruction set avr3 is for the classic AVR core with up to 128K program
9822 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9823
9824 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9825 memory space (MCU types: atmega8, atmega83, atmega85).
9826
9827 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9828 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9829 atmega64, atmega128, at43usb355, at94k).
9830
9831 @item -msize
9832 @opindex msize
9833 Output instruction sizes to the asm file.
9834
9835 @item -minit-stack=@var{N}
9836 @opindex minit-stack
9837 Specify the initial stack address, which may be a symbol or numeric value,
9838 @samp{__stack} is the default.
9839
9840 @item -mno-interrupts
9841 @opindex mno-interrupts
9842 Generated code is not compatible with hardware interrupts.
9843 Code size will be smaller.
9844
9845 @item -mcall-prologues
9846 @opindex mcall-prologues
9847 Functions prologues/epilogues expanded as call to appropriate
9848 subroutines.  Code size will be smaller.
9849
9850 @item -mno-tablejump
9851 @opindex mno-tablejump
9852 Do not generate tablejump insns which sometimes increase code size.
9853
9854 @item -mtiny-stack
9855 @opindex mtiny-stack
9856 Change only the low 8 bits of the stack pointer.
9857 @end table
9858
9859 @node MCore Options
9860 @subsection MCore Options
9861 @cindex MCore options
9862
9863 These are the @samp{-m} options defined for the Motorola M*Core
9864 processors.
9865
9866 @table @gcctabopt
9867
9868 @item -mhardlit
9869 @itemx -mno-hardlit
9870 @opindex mhardlit
9871 @opindex mno-hardlit
9872 Inline constants into the code stream if it can be done in two
9873 instructions or less.
9874
9875 @item -mdiv
9876 @itemx -mno-div
9877 @opindex mdiv
9878 @opindex mno-div
9879 Use the divide instruction.  (Enabled by default).
9880
9881 @item -mrelax-immediate
9882 @itemx -mno-relax-immediate
9883 @opindex mrelax-immediate
9884 @opindex mno-relax-immediate
9885 Allow arbitrary sized immediates in bit operations.
9886
9887 @item -mwide-bitfields
9888 @itemx -mno-wide-bitfields
9889 @opindex mwide-bitfields
9890 @opindex mno-wide-bitfields
9891 Always treat bit-fields as int-sized.
9892
9893 @item -m4byte-functions
9894 @itemx -mno-4byte-functions
9895 @opindex m4byte-functions
9896 @opindex mno-4byte-functions
9897 Force all functions to be aligned to a four byte boundary.
9898
9899 @item -mcallgraph-data
9900 @itemx -mno-callgraph-data
9901 @opindex mcallgraph-data
9902 @opindex mno-callgraph-data
9903 Emit callgraph information.
9904
9905 @item -mslow-bytes
9906 @itemx -mno-slow-bytes
9907 @opindex mslow-bytes
9908 @opindex mno-slow-bytes
9909 Prefer word access when reading byte quantities.
9910
9911 @item -mlittle-endian
9912 @itemx -mbig-endian
9913 @opindex mlittle-endian
9914 @opindex mbig-endian
9915 Generate code for a little endian target.
9916
9917 @item -m210
9918 @itemx -m340
9919 @opindex m210
9920 @opindex m340
9921 Generate code for the 210 processor.
9922 @end table
9923
9924 @node IA-64 Options
9925 @subsection IA-64 Options
9926 @cindex IA-64 Options
9927
9928 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9929
9930 @table @gcctabopt
9931 @item -mbig-endian
9932 @opindex mbig-endian
9933 Generate code for a big endian target.  This is the default for HP-UX@.
9934
9935 @item -mlittle-endian
9936 @opindex mlittle-endian
9937 Generate code for a little endian target.  This is the default for AIX5
9938 and GNU/Linux.
9939
9940 @item -mgnu-as
9941 @itemx -mno-gnu-as
9942 @opindex mgnu-as
9943 @opindex mno-gnu-as
9944 Generate (or don't) code for the GNU assembler.  This is the default.
9945 @c Also, this is the default if the configure option @option{--with-gnu-as}
9946 @c is used.
9947
9948 @item -mgnu-ld
9949 @itemx -mno-gnu-ld
9950 @opindex mgnu-ld
9951 @opindex mno-gnu-ld
9952 Generate (or don't) code for the GNU linker.  This is the default.
9953 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9954 @c is used.
9955
9956 @item -mno-pic
9957 @opindex mno-pic
9958 Generate code that does not use a global pointer register.  The result
9959 is not position independent code, and violates the IA-64 ABI@.
9960
9961 @item -mvolatile-asm-stop
9962 @itemx -mno-volatile-asm-stop
9963 @opindex mvolatile-asm-stop
9964 @opindex mno-volatile-asm-stop
9965 Generate (or don't) a stop bit immediately before and after volatile asm
9966 statements.
9967
9968 @item -mb-step
9969 @opindex mb-step
9970 Generate code that works around Itanium B step errata.
9971
9972 @item -mregister-names
9973 @itemx -mno-register-names
9974 @opindex mregister-names
9975 @opindex mno-register-names
9976 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9977 the stacked registers.  This may make assembler output more readable.
9978
9979 @item -mno-sdata
9980 @itemx -msdata
9981 @opindex mno-sdata
9982 @opindex msdata
9983 Disable (or enable) optimizations that use the small data section.  This may
9984 be useful for working around optimizer bugs.
9985
9986 @item -mconstant-gp
9987 @opindex mconstant-gp
9988 Generate code that uses a single constant global pointer value.  This is
9989 useful when compiling kernel code.
9990
9991 @item -mauto-pic
9992 @opindex mauto-pic
9993 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9994 This is useful when compiling firmware code.
9995
9996 @item -minline-float-divide-min-latency
9997 @opindex minline-float-divide-min-latency
9998 Generate code for inline divides of floating point values
9999 using the minimum latency algorithm.
10000
10001 @item -minline-float-divide-max-throughput
10002 @opindex minline-float-divide-max-throughput
10003 Generate code for inline divides of floating point values
10004 using the maximum throughput algorithm.
10005
10006 @item -minline-int-divide-min-latency
10007 @opindex minline-int-divide-min-latency
10008 Generate code for inline divides of integer values
10009 using the minimum latency algorithm.
10010
10011 @item -minline-int-divide-max-throughput
10012 @opindex minline-int-divide-max-throughput
10013 Generate code for inline divides of integer values
10014 using the maximum throughput algorithm.
10015
10016 @item -mno-dwarf2-asm
10017 @itemx -mdwarf2-asm
10018 @opindex mno-dwarf2-asm
10019 @opindex mdwarf2-asm
10020 Don't (or do) generate assembler code for the DWARF2 line number debugging
10021 info.  This may be useful when not using the GNU assembler.
10022
10023 @item -mfixed-range=@var{register-range}
10024 @opindex mfixed-range
10025 Generate code treating the given register range as fixed registers.
10026 A fixed register is one that the register allocator can not use.  This is
10027 useful when compiling kernel code.  A register range is specified as
10028 two registers separated by a dash.  Multiple register ranges can be
10029 specified separated by a comma.
10030
10031 @item -mearly-stop-bits
10032 @itemx -mno-early-stop-bits
10033 @opindex mearly-stop-bits
10034 @opindex mno-early-stop-bits
10035 Allow stop bits to be placed earlier than immediately preceding the
10036 instruction that triggered the stop bit.  This can improve instruction
10037 scheduling, but does not always do so.
10038 @end table
10039
10040 @node D30V Options
10041 @subsection D30V Options
10042 @cindex D30V Options
10043
10044 These @samp{-m} options are defined for D30V implementations:
10045
10046 @table @gcctabopt
10047 @item -mextmem
10048 @opindex mextmem
10049 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10050 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10051 memory, which starts at location @code{0x80000000}.
10052
10053 @item -mextmemory
10054 @opindex mextmemory
10055 Same as the @option{-mextmem} switch.
10056
10057 @item -monchip
10058 @opindex monchip
10059 Link the @samp{.text} section into onchip text memory, which starts at
10060 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10061 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10062 into onchip data memory, which starts at location @code{0x20000000}.
10063
10064 @item -mno-asm-optimize
10065 @itemx -masm-optimize
10066 @opindex mno-asm-optimize
10067 @opindex masm-optimize
10068 Disable (enable) passing @option{-O} to the assembler when optimizing.
10069 The assembler uses the @option{-O} option to automatically parallelize
10070 adjacent short instructions where possible.
10071
10072 @item -mbranch-cost=@var{n}
10073 @opindex mbranch-cost
10074 Increase the internal costs of branches to @var{n}.  Higher costs means
10075 that the compiler will issue more instructions to avoid doing a branch.
10076 The default is 2.
10077
10078 @item -mcond-exec=@var{n}
10079 @opindex mcond-exec
10080 Specify the maximum number of conditionally executed instructions that
10081 replace a branch.  The default is 4.
10082 @end table
10083
10084 @node S/390 and zSeries Options
10085 @subsection S/390 and zSeries Options
10086 @cindex S/390 and zSeries Options
10087
10088 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10089
10090 @table @gcctabopt
10091 @item -mhard-float
10092 @itemx -msoft-float
10093 @opindex mhard-float
10094 @opindex msoft-float
10095 Use (do not use) the hardware floating-point instructions and registers
10096 for floating-point operations.  When @option{-msoft-float} is specified,
10097 functions in @file{libgcc.a} will be used to perform floating-point
10098 operations.  When @option{-mhard-float} is specified, the compiler
10099 generates IEEE floating-point instructions.  This is the default.
10100
10101 @item -mbackchain
10102 @itemx -mno-backchain
10103 @opindex mbackchain
10104 @opindex mno-backchain
10105 Generate (or do not generate) code which maintains an explicit
10106 backchain within the stack frame that points to the caller's frame.
10107 This may be needed to allow debugging using tools that do not understand
10108 DWARF-2 call frame information.  The default is not to generate the
10109 backchain.
10110
10111 @item -msmall-exec
10112 @itemx -mno-small-exec
10113 @opindex msmall-exec
10114 @opindex mno-small-exec
10115 Generate (or do not generate) code using the @code{bras} instruction
10116 to do subroutine calls.
10117 This only works reliably if the total executable size does not
10118 exceed 64k.  The default is to use the @code{basr} instruction instead,
10119 which does not have this limitation.
10120
10121 @item -m64
10122 @itemx -m31
10123 @opindex m64
10124 @opindex m31
10125 When @option{-m31} is specified, generate code compliant to the
10126 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10127 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10128 particular to generate 64-bit instructions.  For the @samp{s390}
10129 targets, the default is @option{-m31}, while the @samp{s390x}
10130 targets default to @option{-m64}.
10131
10132 @item -mzarch
10133 @itemx -mesa
10134 @opindex mzarch
10135 @opindex mesa
10136 When @option{-mzarch} is specified, generate code using the
10137 instructions available on z/Architecture.
10138 When @option{-mesa} is specified, generate code using the
10139 instructions available on ESA/390. Note that @option{-mesa} is
10140 not possible with @option{-m64}.
10141 When generating code compliant to the GNU/Linux for S/390 ABI,
10142 the default is @option{-mesa}.  When generating code compliant
10143 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10144
10145 @item -mmvcle
10146 @itemx -mno-mvcle
10147 @opindex mmvcle
10148 @opindex mno-mvcle
10149 Generate (or do not generate) code using the @code{mvcle} instruction
10150 to perform block moves.  When @option{-mno-mvcle} is specified,
10151 use a @code{mvc} loop instead.  This is the default.
10152
10153 @item -mdebug
10154 @itemx -mno-debug
10155 @opindex mdebug
10156 @opindex mno-debug
10157 Print (or do not print) additional debug information when compiling.
10158 The default is to not print debug information.
10159
10160 @item -march=@var{cpu-type}
10161 @opindex march
10162 Generate code that will run on @var{cpu-type}, which is the name of a system
10163 representing a certain processor type. Possible values for
10164 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10165 When generating code using the instructions available on z/Architecture,
10166 the default is @option{-march=z900}.  Otherwise, the default is
10167 @option{-march=g5}.
10168
10169 @item -mtune=@var{cpu-type}
10170 @opindex mtune
10171 Tune to @var{cpu-type} everything applicable about the generated code,
10172 except for the ABI and the set of available instructions.
10173 The list of @var{cpu-type} values is the same as for @option{-march}.
10174 The default is the value used for @option{-march}.
10175
10176 @item -mfused-madd
10177 @itemx -mno-fused-madd
10178 @opindex mfused-madd
10179 @opindex mno-fused-madd
10180 Generate code that uses (does not use) the floating point multiply and
10181 accumulate instructions.  These instructions are generated by default if
10182 hardware floating point is used.
10183 @end table
10184
10185 @node CRIS Options
10186 @subsection CRIS Options
10187 @cindex CRIS Options
10188
10189 These options are defined specifically for the CRIS ports.
10190
10191 @table @gcctabopt
10192 @item -march=@var{architecture-type}
10193 @itemx -mcpu=@var{architecture-type}
10194 @opindex march
10195 @opindex mcpu
10196 Generate code for the specified architecture.  The choices for
10197 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10198 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10199 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10200 @samp{v10}.
10201
10202 @item -mtune=@var{architecture-type}
10203 @opindex mtune
10204 Tune to @var{architecture-type} everything applicable about the generated
10205 code, except for the ABI and the set of available instructions.  The
10206 choices for @var{architecture-type} are the same as for
10207 @option{-march=@var{architecture-type}}.
10208
10209 @item -mmax-stack-frame=@var{n}
10210 @opindex mmax-stack-frame
10211 Warn when the stack frame of a function exceeds @var{n} bytes.
10212
10213 @item -melinux-stacksize=@var{n}
10214 @opindex melinux-stacksize
10215 Only available with the @samp{cris-axis-aout} target.  Arranges for
10216 indications in the program to the kernel loader that the stack of the
10217 program should be set to @var{n} bytes.
10218
10219 @item -metrax4
10220 @itemx -metrax100
10221 @opindex metrax4
10222 @opindex metrax100
10223 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10224 @option{-march=v3} and @option{-march=v8} respectively.
10225
10226 @item -mmul-bug-workaround
10227 @itemx -mno-mul-bug-workaround
10228 @opindex mmul-bug-workaround
10229 @opindex mno-mul-bug-workaround
10230 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10231 models where it applies.  This option is active by default.
10232
10233 @item -mpdebug
10234 @opindex mpdebug
10235 Enable CRIS-specific verbose debug-related information in the assembly
10236 code.  This option also has the effect to turn off the @samp{#NO_APP}
10237 formatted-code indicator to the assembler at the beginning of the
10238 assembly file.
10239
10240 @item -mcc-init
10241 @opindex mcc-init
10242 Do not use condition-code results from previous instruction; always emit
10243 compare and test instructions before use of condition codes.
10244
10245 @item -mno-side-effects
10246 @opindex mno-side-effects
10247 Do not emit instructions with side-effects in addressing modes other than
10248 post-increment.
10249
10250 @item -mstack-align
10251 @itemx -mno-stack-align
10252 @itemx -mdata-align
10253 @itemx -mno-data-align
10254 @itemx -mconst-align
10255 @itemx -mno-const-align
10256 @opindex mstack-align
10257 @opindex mno-stack-align
10258 @opindex mdata-align
10259 @opindex mno-data-align
10260 @opindex mconst-align
10261 @opindex mno-const-align
10262 These options (no-options) arranges (eliminate arrangements) for the
10263 stack-frame, individual data and constants to be aligned for the maximum
10264 single data access size for the chosen CPU model.  The default is to
10265 arrange for 32-bit alignment.  ABI details such as structure layout are
10266 not affected by these options.
10267
10268 @item -m32-bit
10269 @itemx -m16-bit
10270 @itemx -m8-bit
10271 @opindex m32-bit
10272 @opindex m16-bit
10273 @opindex m8-bit
10274 Similar to the stack- data- and const-align options above, these options
10275 arrange for stack-frame, writable data and constants to all be 32-bit,
10276 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10277
10278 @item -mno-prologue-epilogue
10279 @itemx -mprologue-epilogue
10280 @opindex mno-prologue-epilogue
10281 @opindex mprologue-epilogue
10282 With @option{-mno-prologue-epilogue}, the normal function prologue and
10283 epilogue that sets up the stack-frame are omitted and no return
10284 instructions or return sequences are generated in the code.  Use this
10285 option only together with visual inspection of the compiled code: no
10286 warnings or errors are generated when call-saved registers must be saved,
10287 or storage for local variable needs to be allocated.
10288
10289 @item -mno-gotplt
10290 @itemx -mgotplt
10291 @opindex mno-gotplt
10292 @opindex mgotplt
10293 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10294 instruction sequences that load addresses for functions from the PLT part
10295 of the GOT rather than (traditional on other architectures) calls to the
10296 PLT.  The default is @option{-mgotplt}.
10297
10298 @item -maout
10299 @opindex maout
10300 Legacy no-op option only recognized with the cris-axis-aout target.
10301
10302 @item -melf
10303 @opindex melf
10304 Legacy no-op option only recognized with the cris-axis-elf and
10305 cris-axis-linux-gnu targets.
10306
10307 @item -melinux
10308 @opindex melinux
10309 Only recognized with the cris-axis-aout target, where it selects a
10310 GNU/linux-like multilib, include files and instruction set for
10311 @option{-march=v8}.
10312
10313 @item -mlinux
10314 @opindex mlinux
10315 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10316
10317 @item -sim
10318 @opindex sim
10319 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10320 to link with input-output functions from a simulator library.  Code,
10321 initialized data and zero-initialized data are allocated consecutively.
10322
10323 @item -sim2
10324 @opindex sim2
10325 Like @option{-sim}, but pass linker options to locate initialized data at
10326 0x40000000 and zero-initialized data at 0x80000000.
10327 @end table
10328
10329 @node MMIX Options
10330 @subsection MMIX Options
10331 @cindex MMIX Options
10332
10333 These options are defined for the MMIX:
10334
10335 @table @gcctabopt
10336 @item -mlibfuncs
10337 @itemx -mno-libfuncs
10338 @opindex mlibfuncs
10339 @opindex mno-libfuncs
10340 Specify that intrinsic library functions are being compiled, passing all
10341 values in registers, no matter the size.
10342
10343 @item -mepsilon
10344 @itemx -mno-epsilon
10345 @opindex mepsilon
10346 @opindex mno-epsilon
10347 Generate floating-point comparison instructions that compare with respect
10348 to the @code{rE} epsilon register.
10349
10350 @item -mabi=mmixware
10351 @itemx -mabi=gnu
10352 @opindex mabi-mmixware
10353 @opindex mabi=gnu
10354 Generate code that passes function parameters and return values that (in
10355 the called function) are seen as registers @code{$0} and up, as opposed to
10356 the GNU ABI which uses global registers @code{$231} and up.
10357
10358 @item -mzero-extend
10359 @itemx -mno-zero-extend
10360 @opindex mzero-extend
10361 @opindex mno-zero-extend
10362 When reading data from memory in sizes shorter than 64 bits, use (do not
10363 use) zero-extending load instructions by default, rather than
10364 sign-extending ones.
10365
10366 @item -mknuthdiv
10367 @itemx -mno-knuthdiv
10368 @opindex mknuthdiv
10369 @opindex mno-knuthdiv
10370 Make the result of a division yielding a remainder have the same sign as
10371 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10372 remainder follows the sign of the dividend.  Both methods are
10373 arithmetically valid, the latter being almost exclusively used.
10374
10375 @item -mtoplevel-symbols
10376 @itemx -mno-toplevel-symbols
10377 @opindex mtoplevel-symbols
10378 @opindex mno-toplevel-symbols
10379 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10380 code can be used with the @code{PREFIX} assembly directive.
10381
10382 @item -melf
10383 @opindex melf
10384 Generate an executable in the ELF format, rather than the default
10385 @samp{mmo} format used by the @command{mmix} simulator.
10386
10387 @item -mbranch-predict
10388 @itemx -mno-branch-predict
10389 @opindex mbranch-predict
10390 @opindex mno-branch-predict
10391 Use (do not use) the probable-branch instructions, when static branch
10392 prediction indicates a probable branch.
10393
10394 @item -mbase-addresses
10395 @itemx -mno-base-addresses
10396 @opindex mbase-addresses
10397 @opindex mno-base-addresses
10398 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10399 base address automatically generates a request (handled by the assembler
10400 and the linker) for a constant to be set up in a global register.  The
10401 register is used for one or more base address requests within the range 0
10402 to 255 from the value held in the register.  The generally leads to short
10403 and fast code, but the number of different data items that can be
10404 addressed is limited.  This means that a program that uses lots of static
10405 data may require @option{-mno-base-addresses}.
10406
10407 @item -msingle-exit
10408 @itemx -mno-single-exit
10409 @opindex msingle-exit
10410 @opindex mno-single-exit
10411 Force (do not force) generated code to have a single exit point in each
10412 function.
10413 @end table
10414
10415 @node PDP-11 Options
10416 @subsection PDP-11 Options
10417 @cindex PDP-11 Options
10418
10419 These options are defined for the PDP-11:
10420
10421 @table @gcctabopt
10422 @item -mfpu
10423 @opindex mfpu
10424 Use hardware FPP floating point.  This is the default.  (FIS floating
10425 point on the PDP-11/40 is not supported.)
10426
10427 @item -msoft-float
10428 @opindex msoft-float
10429 Do not use hardware floating point.
10430
10431 @item -mac0
10432 @opindex mac0
10433 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10434
10435 @item -mno-ac0
10436 @opindex mno-ac0
10437 Return floating-point results in memory.  This is the default.
10438
10439 @item -m40
10440 @opindex m40
10441 Generate code for a PDP-11/40.
10442
10443 @item -m45
10444 @opindex m45
10445 Generate code for a PDP-11/45.  This is the default.
10446
10447 @item -m10
10448 @opindex m10
10449 Generate code for a PDP-11/10.
10450
10451 @item -mbcopy-builtin
10452 @opindex bcopy-builtin
10453 Use inline @code{movstrhi} patterns for copying memory.  This is the
10454 default.
10455
10456 @item -mbcopy
10457 @opindex mbcopy
10458 Do not use inline @code{movstrhi} patterns for copying memory.
10459
10460 @item -mint16
10461 @itemx -mno-int32
10462 @opindex mint16
10463 @opindex mno-int32
10464 Use 16-bit @code{int}.  This is the default.
10465
10466 @item -mint32
10467 @itemx -mno-int16
10468 @opindex mint32
10469 @opindex mno-int16
10470 Use 32-bit @code{int}.
10471
10472 @item -mfloat64
10473 @itemx -mno-float32
10474 @opindex mfloat64
10475 @opindex mno-float32
10476 Use 64-bit @code{float}.  This is the default.
10477
10478 @item -mfloat32
10479 @itemx -mno-float64
10480 @opindex mfloat32
10481 @opindex mno-float64
10482 Use 32-bit @code{float}.
10483
10484 @item -mabshi
10485 @opindex mabshi
10486 Use @code{abshi2} pattern.  This is the default.
10487
10488 @item -mno-abshi
10489 @opindex mno-abshi
10490 Do not use @code{abshi2} pattern.
10491
10492 @item -mbranch-expensive
10493 @opindex mbranch-expensive
10494 Pretend that branches are expensive.  This is for experimenting with
10495 code generation only.
10496
10497 @item -mbranch-cheap
10498 @opindex mbranch-cheap
10499 Do not pretend that branches are expensive.  This is the default.
10500
10501 @item -msplit
10502 @opindex msplit
10503 Generate code for a system with split I&D.
10504
10505 @item -mno-split
10506 @opindex mno-split
10507 Generate code for a system without split I&D.  This is the default.
10508
10509 @item -munix-asm
10510 @opindex munix-asm
10511 Use Unix assembler syntax.  This is the default when configured for
10512 @samp{pdp11-*-bsd}.
10513
10514 @item -mdec-asm
10515 @opindex mdec-asm
10516 Use DEC assembler syntax.  This is the default when configured for any
10517 PDP-11 target other than @samp{pdp11-*-bsd}.
10518 @end table
10519
10520 @node Xstormy16 Options
10521 @subsection Xstormy16 Options
10522 @cindex Xstormy16 Options
10523
10524 These options are defined for Xstormy16:
10525
10526 @table @gcctabopt
10527 @item -msim
10528 @opindex msim
10529 Choose startup files and linker script suitable for the simulator.
10530 @end table
10531
10532 @node FRV Options
10533 @subsection FRV Options
10534 @cindex FRV Options
10535
10536 @table @gcctabopt
10537 @item -mgpr-32
10538 @opindex mgpr-32
10539
10540 Only use the first 32 general purpose registers.
10541
10542 @item -mgpr-64
10543 @opindex mgpr-64
10544
10545 Use all 64 general purpose registers.
10546
10547 @item -mfpr-32
10548 @opindex mfpr-32
10549
10550 Use only the first 32 floating point registers.
10551
10552 @item -mfpr-64
10553 @opindex mfpr-64
10554
10555 Use all 64 floating point registers
10556
10557 @item -mhard-float
10558 @opindex mhard-float
10559
10560 Use hardware instructions for floating point operations.
10561
10562 @item -msoft-float
10563 @opindex msoft-float
10564
10565 Use library routines for floating point operations.
10566
10567 @item -malloc-cc
10568 @opindex malloc-cc
10569
10570 Dynamically allocate condition code registers.
10571
10572 @item -mfixed-cc
10573 @opindex mfixed-cc
10574
10575 Do not try to dynamically allocate condition code registers, only
10576 use @code{icc0} and @code{fcc0}.
10577
10578 @item -mdword
10579 @opindex mdword
10580
10581 Change ABI to use double word insns.
10582
10583 @item -mno-dword
10584 @opindex mno-dword
10585
10586 Do not use double word instructions.
10587
10588 @item -mdouble
10589 @opindex mdouble
10590
10591 Use floating point double instructions.
10592
10593 @item -mno-double
10594 @opindex mno-double
10595
10596 Do not use floating point double instructions.
10597
10598 @item -mmedia
10599 @opindex mmedia
10600
10601 Use media instructions.
10602
10603 @item -mno-media
10604 @opindex mno-media
10605
10606 Do not use media instructions.
10607
10608 @item -mmuladd
10609 @opindex mmuladd
10610
10611 Use multiply and add/subtract instructions.
10612
10613 @item -mno-muladd
10614 @opindex mno-muladd
10615
10616 Do not use multiply and add/subtract instructions.
10617
10618 @item -mlibrary-pic
10619 @opindex mlibrary-pic
10620
10621 Enable PIC support for building libraries
10622
10623 @item -macc-4
10624 @opindex macc-4
10625
10626 Use only the first four media accumulator registers.
10627
10628 @item -macc-8
10629 @opindex macc-8
10630
10631 Use all eight media accumulator registers.
10632
10633 @item -mpack
10634 @opindex mpack
10635
10636 Pack VLIW instructions.
10637
10638 @item -mno-pack
10639 @opindex mno-pack
10640
10641 Do not pack VLIW instructions.
10642
10643 @item -mno-eflags
10644 @opindex mno-eflags
10645
10646 Do not mark ABI switches in e_flags.
10647
10648 @item -mcond-move
10649 @opindex mcond-move
10650
10651 Enable the use of conditional-move instructions (default).
10652
10653 This switch is mainly for debugging the compiler and will likely be removed
10654 in a future version.
10655
10656 @item -mno-cond-move
10657 @opindex mno-cond-move
10658
10659 Disable the use of conditional-move instructions.
10660
10661 This switch is mainly for debugging the compiler and will likely be removed
10662 in a future version.
10663
10664 @item -mscc
10665 @opindex mscc
10666
10667 Enable the use of conditional set instructions (default).
10668
10669 This switch is mainly for debugging the compiler and will likely be removed
10670 in a future version.
10671
10672 @item -mno-scc
10673 @opindex mno-scc
10674
10675 Disable the use of conditional set instructions.
10676
10677 This switch is mainly for debugging the compiler and will likely be removed
10678 in a future version.
10679
10680 @item -mcond-exec
10681 @opindex mcond-exec
10682
10683 Enable the use of conditional execution (default).
10684
10685 This switch is mainly for debugging the compiler and will likely be removed
10686 in a future version.
10687
10688 @item -mno-cond-exec
10689 @opindex mno-cond-exec
10690
10691 Disable the use of conditional execution.
10692
10693 This switch is mainly for debugging the compiler and will likely be removed
10694 in a future version.
10695
10696 @item -mvliw-branch
10697 @opindex mvliw-branch
10698
10699 Run a pass to pack branches into VLIW instructions (default).
10700
10701 This switch is mainly for debugging the compiler and will likely be removed
10702 in a future version.
10703
10704 @item -mno-vliw-branch
10705 @opindex mno-vliw-branch
10706
10707 Do not run a pass to pack branches into VLIW instructions.
10708
10709 This switch is mainly for debugging the compiler and will likely be removed
10710 in a future version.
10711
10712 @item -mmulti-cond-exec
10713 @opindex mmulti-cond-exec
10714
10715 Enable optimization of @code{&&} and @code{||} in conditional execution
10716 (default).
10717
10718 This switch is mainly for debugging the compiler and will likely be removed
10719 in a future version.
10720
10721 @item -mno-multi-cond-exec
10722 @opindex mno-multi-cond-exec
10723
10724 Disable optimization of @code{&&} and @code{||} in conditional execution.
10725
10726 This switch is mainly for debugging the compiler and will likely be removed
10727 in a future version.
10728
10729 @item -mnested-cond-exec
10730 @opindex mnested-cond-exec
10731
10732 Enable nested conditional execution optimizations (default).
10733
10734 This switch is mainly for debugging the compiler and will likely be removed
10735 in a future version.
10736
10737 @item -mno-nested-cond-exec
10738 @opindex mno-nested-cond-exec
10739
10740 Disable nested conditional execution optimizations.
10741
10742 This switch is mainly for debugging the compiler and will likely be removed
10743 in a future version.
10744
10745 @item -mtomcat-stats
10746 @opindex mtomcat-stats
10747
10748 Cause gas to print out tomcat statistics.
10749
10750 @item -mcpu=@var{cpu}
10751 @opindex mcpu
10752
10753 Select the processor type for which to generate code.  Possible values are
10754 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10755 @samp{frv}.
10756
10757 @end table
10758
10759 @node Xtensa Options
10760 @subsection Xtensa Options
10761 @cindex Xtensa Options
10762
10763 These options are supported for Xtensa targets:
10764
10765 @table @gcctabopt
10766 @item -mconst16
10767 @itemx -mno-const16
10768 @opindex mconst16
10769 @opindex mno-const16
10770 Enable or disable use of @code{CONST16} instructions for loading
10771 constant values.  The @code{CONST16} instruction is currently not a
10772 standard option from Tensilica.  When enabled, @code{CONST16}
10773 instructions are always used in place of the standard @code{L32R}
10774 instructions.  The use of @code{CONST16} is enabled by default only if
10775 the @code{L32R} instruction is not available.
10776
10777 @item -mfused-madd
10778 @itemx -mno-fused-madd
10779 @opindex mfused-madd
10780 @opindex mno-fused-madd
10781 Enable or disable use of fused multiply/add and multiply/subtract
10782 instructions in the floating-point option.  This has no effect if the
10783 floating-point option is not also enabled.  Disabling fused multiply/add
10784 and multiply/subtract instructions forces the compiler to use separate
10785 instructions for the multiply and add/subtract operations.  This may be
10786 desirable in some cases where strict IEEE 754-compliant results are
10787 required: the fused multiply add/subtract instructions do not round the
10788 intermediate result, thereby producing results with @emph{more} bits of
10789 precision than specified by the IEEE standard.  Disabling fused multiply
10790 add/subtract instructions also ensures that the program output is not
10791 sensitive to the compiler's ability to combine multiply and add/subtract
10792 operations.
10793
10794 @item -mtext-section-literals
10795 @itemx -mno-text-section-literals
10796 @opindex mtext-section-literals
10797 @opindex mno-text-section-literals
10798 Control the treatment of literal pools.  The default is
10799 @option{-mno-text-section-literals}, which places literals in a separate
10800 section in the output file.  This allows the literal pool to be placed
10801 in a data RAM/ROM, and it also allows the linker to combine literal
10802 pools from separate object files to remove redundant literals and
10803 improve code size.  With @option{-mtext-section-literals}, the literals
10804 are interspersed in the text section in order to keep them as close as
10805 possible to their references.  This may be necessary for large assembly
10806 files.
10807
10808 @item -mtarget-align
10809 @itemx -mno-target-align
10810 @opindex mtarget-align
10811 @opindex mno-target-align
10812 When this option is enabled, GCC instructs the assembler to
10813 automatically align instructions to reduce branch penalties at the
10814 expense of some code density.  The assembler attempts to widen density
10815 instructions to align branch targets and the instructions following call
10816 instructions.  If there are not enough preceding safe density
10817 instructions to align a target, no widening will be performed.  The
10818 default is @option{-mtarget-align}.  These options do not affect the
10819 treatment of auto-aligned instructions like @code{LOOP}, which the
10820 assembler will always align, either by widening density instructions or
10821 by inserting no-op instructions.
10822
10823 @item -mlongcalls
10824 @itemx -mno-longcalls
10825 @opindex mlongcalls
10826 @opindex mno-longcalls
10827 When this option is enabled, GCC instructs the assembler to translate
10828 direct calls to indirect calls unless it can determine that the target
10829 of a direct call is in the range allowed by the call instruction.  This
10830 translation typically occurs for calls to functions in other source
10831 files.  Specifically, the assembler translates a direct @code{CALL}
10832 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10833 The default is @option{-mno-longcalls}.  This option should be used in
10834 programs where the call target can potentially be out of range.  This
10835 option is implemented in the assembler, not the compiler, so the
10836 assembly code generated by GCC will still show direct call
10837 instructions---look at the disassembled object code to see the actual
10838 instructions.  Note that the assembler will use an indirect call for
10839 every cross-file call, not just those that really will be out of range.
10840 @end table
10841
10842 @node Code Gen Options
10843 @section Options for Code Generation Conventions
10844 @cindex code generation conventions
10845 @cindex options, code generation
10846 @cindex run-time options
10847
10848 These machine-independent options control the interface conventions
10849 used in code generation.
10850
10851 Most of them have both positive and negative forms; the negative form
10852 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10853 one of the forms is listed---the one which is not the default.  You
10854 can figure out the other form by either removing @samp{no-} or adding
10855 it.
10856
10857 @table @gcctabopt
10858 @item -fbounds-check
10859 @opindex fbounds-check
10860 For front-ends that support it, generate additional code to check that
10861 indices used to access arrays are within the declared range.  This is
10862 currently only supported by the Java and Fortran 77 front-ends, where
10863 this option defaults to true and false respectively.
10864
10865 @item -ftrapv
10866 @opindex ftrapv
10867 This option generates traps for signed overflow on addition, subtraction,
10868 multiplication operations.
10869
10870 @item -fwrapv
10871 @opindex fwrapv
10872 This option instructs the compiler to assume that signed arithmetic
10873 overflow of addition, subtraction and multiplication wraps around
10874 using twos-complement representation.  This flag enables some optimizations
10875 and disables other.  This option is enabled by default for the Java
10876 front-end, as required by the Java language specification.
10877
10878 @item -fexceptions
10879 @opindex fexceptions
10880 Enable exception handling.  Generates extra code needed to propagate
10881 exceptions.  For some targets, this implies GCC will generate frame
10882 unwind information for all functions, which can produce significant data
10883 size overhead, although it does not affect execution.  If you do not
10884 specify this option, GCC will enable it by default for languages like
10885 C++ which normally require exception handling, and disable it for
10886 languages like C that do not normally require it.  However, you may need
10887 to enable this option when compiling C code that needs to interoperate
10888 properly with exception handlers written in C++.  You may also wish to
10889 disable this option if you are compiling older C++ programs that don't
10890 use exception handling.
10891
10892 @item -fnon-call-exceptions
10893 @opindex fnon-call-exceptions
10894 Generate code that allows trapping instructions to throw exceptions.
10895 Note that this requires platform-specific runtime support that does
10896 not exist everywhere.  Moreover, it only allows @emph{trapping}
10897 instructions to throw exceptions, i.e.@: memory references or floating
10898 point instructions.  It does not allow exceptions to be thrown from
10899 arbitrary signal handlers such as @code{SIGALRM}.
10900
10901 @item -funwind-tables
10902 @opindex funwind-tables
10903 Similar to @option{-fexceptions}, except that it will just generate any needed
10904 static data, but will not affect the generated code in any other way.
10905 You will normally not enable this option; instead, a language processor
10906 that needs this handling would enable it on your behalf.
10907
10908 @item -fasynchronous-unwind-tables
10909 @opindex funwind-tables
10910 Generate unwind table in dwarf2 format, if supported by target machine.  The
10911 table is exact at each instruction boundary, so it can be used for stack
10912 unwinding from asynchronous events (such as debugger or garbage collector).
10913
10914 @item -fpcc-struct-return
10915 @opindex fpcc-struct-return
10916 Return ``short'' @code{struct} and @code{union} values in memory like
10917 longer ones, rather than in registers.  This convention is less
10918 efficient, but it has the advantage of allowing intercallability between
10919 GCC-compiled files and files compiled with other compilers, particularly
10920 the Portable C Compiler (pcc).
10921
10922 The precise convention for returning structures in memory depends
10923 on the target configuration macros.
10924
10925 Short structures and unions are those whose size and alignment match
10926 that of some integer type.
10927
10928 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10929 switch is not binary compatible with code compiled with the
10930 @option{-freg-struct-return} switch.
10931 Use it to conform to a non-default application binary interface.
10932
10933 @item -freg-struct-return
10934 @opindex freg-struct-return
10935 Return @code{struct} and @code{union} values in registers when possible.
10936 This is more efficient for small structures than
10937 @option{-fpcc-struct-return}.
10938
10939 If you specify neither @option{-fpcc-struct-return} nor
10940 @option{-freg-struct-return}, GCC defaults to whichever convention is
10941 standard for the target.  If there is no standard convention, GCC
10942 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10943 the principal compiler.  In those cases, we can choose the standard, and
10944 we chose the more efficient register return alternative.
10945
10946 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10947 switch is not binary compatible with code compiled with the
10948 @option{-fpcc-struct-return} switch.
10949 Use it to conform to a non-default application binary interface.
10950
10951 @item -fshort-enums
10952 @opindex fshort-enums
10953 Allocate to an @code{enum} type only as many bytes as it needs for the
10954 declared range of possible values.  Specifically, the @code{enum} type
10955 will be equivalent to the smallest integer type which has enough room.
10956
10957 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10958 code that is not binary compatible with code generated without that switch.
10959 Use it to conform to a non-default application binary interface.
10960
10961 @item -fshort-double
10962 @opindex fshort-double
10963 Use the same size for @code{double} as for @code{float}.
10964
10965 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10966 code that is not binary compatible with code generated without that switch.
10967 Use it to conform to a non-default application binary interface.
10968
10969 @item -fshort-wchar
10970 @opindex fshort-wchar
10971 Override the underlying type for @samp{wchar_t} to be @samp{short
10972 unsigned int} instead of the default for the target.  This option is
10973 useful for building programs to run under WINE@.
10974
10975 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10976 code that is not binary compatible with code generated without that switch.
10977 Use it to conform to a non-default application binary interface.
10978
10979 @item -fshared-data
10980 @opindex fshared-data
10981 Requests that the data and non-@code{const} variables of this
10982 compilation be shared data rather than private data.  The distinction
10983 makes sense only on certain operating systems, where shared data is
10984 shared between processes running the same program, while private data
10985 exists in one copy per process.
10986
10987 @item -fno-common
10988 @opindex fno-common
10989 In C, allocate even uninitialized global variables in the data section of the
10990 object file, rather than generating them as common blocks.  This has the
10991 effect that if the same variable is declared (without @code{extern}) in
10992 two different compilations, you will get an error when you link them.
10993 The only reason this might be useful is if you wish to verify that the
10994 program will work on other systems which always work this way.
10995
10996 @item -fno-ident
10997 @opindex fno-ident
10998 Ignore the @samp{#ident} directive.
10999
11000 @item -finhibit-size-directive
11001 @opindex finhibit-size-directive
11002 Don't output a @code{.size} assembler directive, or anything else that
11003 would cause trouble if the function is split in the middle, and the
11004 two halves are placed at locations far apart in memory.  This option is
11005 used when compiling @file{crtstuff.c}; you should not need to use it
11006 for anything else.
11007
11008 @item -fverbose-asm
11009 @opindex fverbose-asm
11010 Put extra commentary information in the generated assembly code to
11011 make it more readable.  This option is generally only of use to those
11012 who actually need to read the generated assembly code (perhaps while
11013 debugging the compiler itself).
11014
11015 @option{-fno-verbose-asm}, the default, causes the
11016 extra information to be omitted and is useful when comparing two assembler
11017 files.
11018
11019 @item -fpic
11020 @opindex fpic
11021 @cindex global offset table
11022 @cindex PIC
11023 Generate position-independent code (PIC) suitable for use in a shared
11024 library, if supported for the target machine.  Such code accesses all
11025 constant addresses through a global offset table (GOT)@.  The dynamic
11026 loader resolves the GOT entries when the program starts (the dynamic
11027 loader is not part of GCC; it is part of the operating system).  If
11028 the GOT size for the linked executable exceeds a machine-specific
11029 maximum size, you get an error message from the linker indicating that
11030 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11031 instead.  (These maximums are 8k on the SPARC and 32k
11032 on the m68k and RS/6000.  The 386 has no such limit.)
11033
11034 Position-independent code requires special support, and therefore works
11035 only on certain machines.  For the 386, GCC supports PIC for System V
11036 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11037 position-independent.
11038
11039 @item -fPIC
11040 @opindex fPIC
11041 If supported for the target machine, emit position-independent code,
11042 suitable for dynamic linking and avoiding any limit on the size of the
11043 global offset table.  This option makes a difference on the m68k
11044 and the SPARC.
11045
11046 Position-independent code requires special support, and therefore works
11047 only on certain machines.
11048
11049 @item -fpie
11050 @itemx -fPIE
11051 @opindex fpie
11052 @opindex fPIE
11053 These options are similar to @option{-fpic} and @option{-fPIC}, but
11054 generated position independent code can be only linked into executables.
11055 Usually these options are used when @option{-pie} GCC option will be
11056 used during linking.
11057
11058 @item -ffixed-@var{reg}
11059 @opindex ffixed
11060 Treat the register named @var{reg} as a fixed register; generated code
11061 should never refer to it (except perhaps as a stack pointer, frame
11062 pointer or in some other fixed role).
11063
11064 @var{reg} must be the name of a register.  The register names accepted
11065 are machine-specific and are defined in the @code{REGISTER_NAMES}
11066 macro in the machine description macro file.
11067
11068 This flag does not have a negative form, because it specifies a
11069 three-way choice.
11070
11071 @item -fcall-used-@var{reg}
11072 @opindex fcall-used
11073 Treat the register named @var{reg} as an allocable register that is
11074 clobbered by function calls.  It may be allocated for temporaries or
11075 variables that do not live across a call.  Functions compiled this way
11076 will not save and restore the register @var{reg}.
11077
11078 It is an error to used this flag with the frame pointer or stack pointer.
11079 Use of this flag for other registers that have fixed pervasive roles in
11080 the machine's execution model will produce disastrous results.
11081
11082 This flag does not have a negative form, because it specifies a
11083 three-way choice.
11084
11085 @item -fcall-saved-@var{reg}
11086 @opindex fcall-saved
11087 Treat the register named @var{reg} as an allocable register saved by
11088 functions.  It may be allocated even for temporaries or variables that
11089 live across a call.  Functions compiled this way will save and restore
11090 the register @var{reg} if they use it.
11091
11092 It is an error to used this flag with the frame pointer or stack pointer.
11093 Use of this flag for other registers that have fixed pervasive roles in
11094 the machine's execution model will produce disastrous results.
11095
11096 A different sort of disaster will result from the use of this flag for
11097 a register in which function values may be returned.
11098
11099 This flag does not have a negative form, because it specifies a
11100 three-way choice.
11101
11102 @item -fpack-struct
11103 @opindex fpack-struct
11104 Pack all structure members together without holes.
11105
11106 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11107 code that is not binary compatible with code generated without that switch.
11108 Additionally, it makes the code suboptimal.
11109 Use it to conform to a non-default application binary interface.
11110
11111 @item -finstrument-functions
11112 @opindex finstrument-functions
11113 Generate instrumentation calls for entry and exit to functions.  Just
11114 after function entry and just before function exit, the following
11115 profiling functions will be called with the address of the current
11116 function and its call site.  (On some platforms,
11117 @code{__builtin_return_address} does not work beyond the current
11118 function, so the call site information may not be available to the
11119 profiling functions otherwise.)
11120
11121 @smallexample
11122 void __cyg_profile_func_enter (void *this_fn,
11123                                void *call_site);
11124 void __cyg_profile_func_exit  (void *this_fn,
11125                                void *call_site);
11126 @end smallexample
11127
11128 The first argument is the address of the start of the current function,
11129 which may be looked up exactly in the symbol table.
11130
11131 This currently disables function inlining.  This restriction is
11132 expected to be removed in future releases.
11133
11134 A function may be given the attribute @code{no_instrument_function}, in
11135 which case this instrumentation will not be done.  This can be used, for
11136 example, for the profiling functions listed above, high-priority
11137 interrupt routines, and any functions from which the profiling functions
11138 cannot safely be called (perhaps signal handlers, if the profiling
11139 routines generate output or allocate memory).
11140
11141 @item -fstack-check
11142 @opindex fstack-check
11143 Generate code to verify that you do not go beyond the boundary of the
11144 stack.  You should specify this flag if you are running in an
11145 environment with multiple threads, but only rarely need to specify it in
11146 a single-threaded environment since stack overflow is automatically
11147 detected on nearly all systems if there is only one stack.
11148
11149 Note that this switch does not actually cause checking to be done; the
11150 operating system must do that.  The switch causes generation of code
11151 to ensure that the operating system sees the stack being extended.
11152
11153 @item -fstack-limit-register=@var{reg}
11154 @itemx -fstack-limit-symbol=@var{sym}
11155 @itemx -fno-stack-limit
11156 @opindex fstack-limit-register
11157 @opindex fstack-limit-symbol
11158 @opindex fno-stack-limit
11159 Generate code to ensure that the stack does not grow beyond a certain value,
11160 either the value of a register or the address of a symbol.  If the stack
11161 would grow beyond the value, a signal is raised.  For most targets,
11162 the signal is raised before the stack overruns the boundary, so
11163 it is possible to catch the signal without taking special precautions.
11164
11165 For instance, if the stack starts at absolute address @samp{0x80000000}
11166 and grows downwards, you can use the flags
11167 @option{-fstack-limit-symbol=__stack_limit} and
11168 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11169 of 128KB@.  Note that this may only work with the GNU linker.
11170
11171 @cindex aliasing of parameters
11172 @cindex parameters, aliased
11173 @item -fargument-alias
11174 @itemx -fargument-noalias
11175 @itemx -fargument-noalias-global
11176 @opindex fargument-alias
11177 @opindex fargument-noalias
11178 @opindex fargument-noalias-global
11179 Specify the possible relationships among parameters and between
11180 parameters and global data.
11181
11182 @option{-fargument-alias} specifies that arguments (parameters) may
11183 alias each other and may alias global storage.@*
11184 @option{-fargument-noalias} specifies that arguments do not alias
11185 each other, but may alias global storage.@*
11186 @option{-fargument-noalias-global} specifies that arguments do not
11187 alias each other and do not alias global storage.
11188
11189 Each language will automatically use whatever option is required by
11190 the language standard.  You should not need to use these options yourself.
11191
11192 @item -fleading-underscore
11193 @opindex fleading-underscore
11194 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11195 change the way C symbols are represented in the object file.  One use
11196 is to help link with legacy assembly code.
11197
11198 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11199 generate code that is not binary compatible with code generated without that
11200 switch.  Use it to conform to a non-default application binary interface.
11201 Not all targets provide complete support for this switch.
11202
11203 @item -ftls-model=@var{model}
11204 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11205 The @var{model} argument should be one of @code{global-dynamic},
11206 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11207
11208 The default without @option{-fpic} is @code{initial-exec}; with
11209 @option{-fpic} the default is @code{global-dynamic}.
11210 @end table
11211
11212 @c man end
11213
11214 @node Environment Variables
11215 @section Environment Variables Affecting GCC
11216 @cindex environment variables
11217
11218 @c man begin ENVIRONMENT
11219 This section describes several environment variables that affect how GCC
11220 operates.  Some of them work by specifying directories or prefixes to use
11221 when searching for various kinds of files.  Some are used to specify other
11222 aspects of the compilation environment.
11223
11224 Note that you can also specify places to search using options such as
11225 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11226 take precedence over places specified using environment variables, which
11227 in turn take precedence over those specified by the configuration of GCC@.
11228 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11229 GNU Compiler Collection (GCC) Internals}.
11230
11231 @table @env
11232 @item LANG
11233 @itemx LC_CTYPE
11234 @c @itemx LC_COLLATE
11235 @itemx LC_MESSAGES
11236 @c @itemx LC_MONETARY
11237 @c @itemx LC_NUMERIC
11238 @c @itemx LC_TIME
11239 @itemx LC_ALL
11240 @findex LANG
11241 @findex LC_CTYPE
11242 @c @findex LC_COLLATE
11243 @findex LC_MESSAGES
11244 @c @findex LC_MONETARY
11245 @c @findex LC_NUMERIC
11246 @c @findex LC_TIME
11247 @findex LC_ALL
11248 @cindex locale
11249 These environment variables control the way that GCC uses
11250 localization information that allow GCC to work with different
11251 national conventions.  GCC inspects the locale categories
11252 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11253 so.  These locale categories can be set to any value supported by your
11254 installation.  A typical value is @samp{en_UK} for English in the United
11255 Kingdom.
11256
11257 The @env{LC_CTYPE} environment variable specifies character
11258 classification.  GCC uses it to determine the character boundaries in
11259 a string; this is needed for some multibyte encodings that contain quote
11260 and escape characters that would otherwise be interpreted as a string
11261 end or escape.
11262
11263 The @env{LC_MESSAGES} environment variable specifies the language to
11264 use in diagnostic messages.
11265
11266 If the @env{LC_ALL} environment variable is set, it overrides the value
11267 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11268 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11269 environment variable.  If none of these variables are set, GCC
11270 defaults to traditional C English behavior.
11271
11272 @item TMPDIR
11273 @findex TMPDIR
11274 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11275 files.  GCC uses temporary files to hold the output of one stage of
11276 compilation which is to be used as input to the next stage: for example,
11277 the output of the preprocessor, which is the input to the compiler
11278 proper.
11279
11280 @item GCC_EXEC_PREFIX
11281 @findex GCC_EXEC_PREFIX
11282 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11283 names of the subprograms executed by the compiler.  No slash is added
11284 when this prefix is combined with the name of a subprogram, but you can
11285 specify a prefix that ends with a slash if you wish.
11286
11287 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11288 an appropriate prefix to use based on the pathname it was invoked with.
11289
11290 If GCC cannot find the subprogram using the specified prefix, it
11291 tries looking in the usual places for the subprogram.
11292
11293 The default value of @env{GCC_EXEC_PREFIX} is
11294 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11295 of @code{prefix} when you ran the @file{configure} script.
11296
11297 Other prefixes specified with @option{-B} take precedence over this prefix.
11298
11299 This prefix is also used for finding files such as @file{crt0.o} that are
11300 used for linking.
11301
11302 In addition, the prefix is used in an unusual way in finding the
11303 directories to search for header files.  For each of the standard
11304 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11305 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11306 replacing that beginning with the specified prefix to produce an
11307 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11308 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11309 These alternate directories are searched first; the standard directories
11310 come next.
11311
11312 @item COMPILER_PATH
11313 @findex COMPILER_PATH
11314 The value of @env{COMPILER_PATH} is a colon-separated list of
11315 directories, much like @env{PATH}.  GCC tries the directories thus
11316 specified when searching for subprograms, if it can't find the
11317 subprograms using @env{GCC_EXEC_PREFIX}.
11318
11319 @item LIBRARY_PATH
11320 @findex LIBRARY_PATH
11321 The value of @env{LIBRARY_PATH} is a colon-separated list of
11322 directories, much like @env{PATH}.  When configured as a native compiler,
11323 GCC tries the directories thus specified when searching for special
11324 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11325 using GCC also uses these directories when searching for ordinary
11326 libraries for the @option{-l} option (but directories specified with
11327 @option{-L} come first).
11328
11329 @item LANG
11330 @findex LANG
11331 @cindex locale definition
11332 This variable is used to pass locale information to the compiler.  One way in
11333 which this information is used is to determine the character set to be used
11334 when character literals, string literals and comments are parsed in C and C++.
11335 When the compiler is configured to allow multibyte characters,
11336 the following values for @env{LANG} are recognized:
11337
11338 @table @samp
11339 @item C-JIS
11340 Recognize JIS characters.
11341 @item C-SJIS
11342 Recognize SJIS characters.
11343 @item C-EUCJP
11344 Recognize EUCJP characters.
11345 @end table
11346
11347 If @env{LANG} is not defined, or if it has some other value, then the
11348 compiler will use mblen and mbtowc as defined by the default locale to
11349 recognize and translate multibyte characters.
11350 @end table
11351
11352 @noindent
11353 Some additional environments variables affect the behavior of the
11354 preprocessor.
11355
11356 @include cppenv.texi
11357
11358 @c man end
11359
11360 @node Precompiled Headers
11361 @section Using Precompiled Headers
11362 @cindex precompiled headers
11363 @cindex speed of compilation
11364
11365 Often large projects have many header files that are included in every
11366 source file.  The time the compiler takes to process these header files
11367 over and over again can account for nearly all of the time required to
11368 build the project.  To make builds faster, GCC allows users to
11369 `precompile' a header file; then, if builds can use the precompiled
11370 header file they will be much faster.
11371
11372 @strong{Caution:} There are a few known situations where GCC will
11373 crash when trying to use a precompiled header.  If you have trouble
11374 with a precompiled header, you should remove the precompiled header
11375 and compile without it.  In addition, please use GCC's on-line
11376 defect-tracking system to report any problems you encounter with
11377 precompiled headers.  @xref{Bugs}.
11378
11379 To create a precompiled header file, simply compile it as you would any
11380 other file, if necessary using the @option{-x} option to make the driver
11381 treat it as a C or C++ header file.  You will probably want to use a
11382 tool like @command{make} to keep the precompiled header up-to-date when
11383 the headers it contains change.
11384
11385 A precompiled header file will be searched for when @code{#include} is
11386 seen in the compilation.  As it searches for the included file
11387 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11388 compiler looks for a precompiled header in each directory just before it
11389 looks for the include file in that directory.  The name searched for is
11390 the name specified in the @code{#include} with @samp{.gch} appended.  If
11391 the precompiled header file can't be used, it is ignored.
11392
11393 For instance, if you have @code{#include "all.h"}, and you have
11394 @file{all.h.gch} in the same directory as @file{all.h}, then the
11395 precompiled header file will be used if possible, and the original
11396 header will be used otherwise.
11397
11398 Alternatively, you might decide to put the precompiled header file in a
11399 directory and use @option{-I} to ensure that directory is searched
11400 before (or instead of) the directory containing the original header.
11401 Then, if you want to check that the precompiled header file is always
11402 used, you can put a file of the same name as the original header in this
11403 directory containing an @code{#error} command.
11404
11405 This also works with @option{-include}.  So yet another way to use
11406 precompiled headers, good for projects not designed with precompiled
11407 header files in mind, is to simply take most of the header files used by
11408 a project, include them from another header file, precompile that header
11409 file, and @option{-include} the precompiled header.  If the header files
11410 have guards against multiple inclusion, they will be skipped because
11411 they've already been included (in the precompiled header).
11412
11413 If you need to precompile the same header file for different
11414 languages, targets, or compiler options, you can instead make a
11415 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11416 header in the directory.  (It doesn't matter what you call the files
11417 in the directory, every precompiled header in the directory will be
11418 considered.)  The first precompiled header encountered in the
11419 directory that is valid for this compilation will be used; they're
11420 searched in no particular order.
11421
11422 There are many other possibilities, limited only by your imagination,
11423 good sense, and the constraints of your build system.
11424
11425 A precompiled header file can be used only when these conditions apply:
11426
11427 @itemize
11428 @item
11429 Only one precompiled header can be used in a particular compilation.
11430 @item
11431 A precompiled header can't be used once the first C token is seen.  You
11432 can have preprocessor directives before a precompiled header; you can
11433 even include a precompiled header from inside another header, so long as
11434 there are no C tokens before the @code{#include}.
11435 @item
11436 The precompiled header file must be produced for the same language as
11437 the current compilation.  You can't use a C precompiled header for a C++
11438 compilation.
11439 @item
11440 The precompiled header file must be produced by the same compiler
11441 version and configuration as the current compilation is using.
11442 The easiest way to guarantee this is to use the same compiler binary
11443 for creating and using precompiled headers.
11444 @item
11445 Any macros defined before the precompiled header (including with
11446 @option{-D}) must either be defined in the same way as when the
11447 precompiled header was generated, or must not affect the precompiled
11448 header, which usually means that the they don't appear in the
11449 precompiled header at all.
11450 @item
11451 Certain command-line options must be defined in the same way as when the
11452 precompiled header was generated.  At present, it's not clear which
11453 options are safe to change and which are not; the safest choice is to
11454 use exactly the same options when generating and using the precompiled
11455 header.
11456 @end itemize
11457
11458 For all of these but the last, the compiler will automatically ignore
11459 the precompiled header if the conditions aren't met.  For the last item,
11460 some option changes will cause the precompiled header to be rejected,
11461 but not all incompatible option combinations have yet been found.  If
11462 you find a new incompatible combination, please consider filing a bug
11463 report, see @ref{Bugs}.
11464
11465 @node Running Protoize
11466 @section Running Protoize
11467
11468 The program @code{protoize} is an optional part of GCC@.  You can use
11469 it to add prototypes to a program, thus converting the program to ISO
11470 C in one respect.  The companion program @code{unprotoize} does the
11471 reverse: it removes argument types from any prototypes that are found.
11472
11473 When you run these programs, you must specify a set of source files as
11474 command line arguments.  The conversion programs start out by compiling
11475 these files to see what functions they define.  The information gathered
11476 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11477
11478 After scanning comes actual conversion.  The specified files are all
11479 eligible to be converted; any files they include (whether sources or
11480 just headers) are eligible as well.
11481
11482 But not all the eligible files are converted.  By default,
11483 @code{protoize} and @code{unprotoize} convert only source and header
11484 files in the current directory.  You can specify additional directories
11485 whose files should be converted with the @option{-d @var{directory}}
11486 option.  You can also specify particular files to exclude with the
11487 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11488 directory name matches one of the specified directory names, and its
11489 name within the directory has not been excluded.
11490
11491 Basic conversion with @code{protoize} consists of rewriting most
11492 function definitions and function declarations to specify the types of
11493 the arguments.  The only ones not rewritten are those for varargs
11494 functions.
11495
11496 @code{protoize} optionally inserts prototype declarations at the
11497 beginning of the source file, to make them available for any calls that
11498 precede the function's definition.  Or it can insert prototype
11499 declarations with block scope in the blocks where undeclared functions
11500 are called.
11501
11502 Basic conversion with @code{unprotoize} consists of rewriting most
11503 function declarations to remove any argument types, and rewriting
11504 function definitions to the old-style pre-ISO form.
11505
11506 Both conversion programs print a warning for any function declaration or
11507 definition that they can't convert.  You can suppress these warnings
11508 with @option{-q}.
11509
11510 The output from @code{protoize} or @code{unprotoize} replaces the
11511 original source file.  The original file is renamed to a name ending
11512 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11513 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11514 for DOS) file already exists, then the source file is simply discarded.
11515
11516 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11517 scan the program and collect information about the functions it uses.
11518 So neither of these programs will work until GCC is installed.
11519
11520 Here is a table of the options you can use with @code{protoize} and
11521 @code{unprotoize}.  Each option works with both programs unless
11522 otherwise stated.
11523
11524 @table @code
11525 @item -B @var{directory}
11526 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11527 usual directory (normally @file{/usr/local/lib}).  This file contains
11528 prototype information about standard system functions.  This option
11529 applies only to @code{protoize}.
11530
11531 @item -c @var{compilation-options}
11532 Use @var{compilation-options} as the options when running @command{gcc} to
11533 produce the @samp{.X} files.  The special option @option{-aux-info} is
11534 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11535
11536 Note that the compilation options must be given as a single argument to
11537 @code{protoize} or @code{unprotoize}.  If you want to specify several
11538 @command{gcc} options, you must quote the entire set of compilation options
11539 to make them a single word in the shell.
11540
11541 There are certain @command{gcc} arguments that you cannot use, because they
11542 would produce the wrong kind of output.  These include @option{-g},
11543 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11544 the @var{compilation-options}, they are ignored.
11545
11546 @item -C
11547 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11548 systems) instead of @samp{.c}.  This is convenient if you are converting
11549 a C program to C++.  This option applies only to @code{protoize}.
11550
11551 @item -g
11552 Add explicit global declarations.  This means inserting explicit
11553 declarations at the beginning of each source file for each function
11554 that is called in the file and was not declared.  These declarations
11555 precede the first function definition that contains a call to an
11556 undeclared function.  This option applies only to @code{protoize}.
11557
11558 @item -i @var{string}
11559 Indent old-style parameter declarations with the string @var{string}.
11560 This option applies only to @code{protoize}.
11561
11562 @code{unprotoize} converts prototyped function definitions to old-style
11563 function definitions, where the arguments are declared between the
11564 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11565 uses five spaces as the indentation.  If you want to indent with just
11566 one space instead, use @option{-i " "}.
11567
11568 @item -k
11569 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11570 is finished.
11571
11572 @item -l
11573 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11574 a prototype declaration for each function in each block which calls the
11575 function without any declaration.  This option applies only to
11576 @code{protoize}.
11577
11578 @item -n
11579 Make no real changes.  This mode just prints information about the conversions
11580 that would have been done without @option{-n}.
11581
11582 @item -N
11583 Make no @samp{.save} files.  The original files are simply deleted.
11584 Use this option with caution.
11585
11586 @item -p @var{program}
11587 Use the program @var{program} as the compiler.  Normally, the name
11588 @file{gcc} is used.
11589
11590 @item -q
11591 Work quietly.  Most warnings are suppressed.
11592
11593 @item -v
11594 Print the version number, just like @option{-v} for @command{gcc}.
11595 @end table
11596
11597 If you need special compiler options to compile one of your program's
11598 source files, then you should generate that file's @samp{.X} file
11599 specially, by running @command{gcc} on that source file with the
11600 appropriate options and the option @option{-aux-info}.  Then run
11601 @code{protoize} on the entire set of files.  @code{protoize} will use
11602 the existing @samp{.X} file because it is newer than the source file.
11603 For example:
11604
11605 @smallexample
11606 gcc -Dfoo=bar file1.c -aux-info file1.X
11607 protoize *.c
11608 @end smallexample
11609
11610 @noindent
11611 You need to include the special files along with the rest in the
11612 @code{protoize} command, even though their @samp{.X} files already
11613 exist, because otherwise they won't get converted.
11614
11615 @xref{Protoize Caveats}, for more information on how to use
11616 @code{protoize} successfully.